build(echo): Use tsup for building distributable (#5658)

* refactor(build): migrate to tsup and update configs

* refactor: Rename config files to .mjs format

* fix: correct type entry in package.json

* chore: remove redundant npm scripts

* refactor(echo): Remove unnecessary splitting option

* chore: Update package paths and dependencies

apps/api/e2e/echo.server.ts

@@ -1,7 +1,7 @@
 import * as http from 'http';
 import * as express from 'express';
 // FIXME: subpath import not working with `workspace:` protocol. Currently we need to drill into the module instead of using the ES export.
-import { serve } from '../../../packages/echo/dist/src/express';
+import { serve } from '../../../packages/echo/dist/express';
 import { Echo } from '@novu/echo';
 
 class EchoServer {

apps/api/package.json

@@ -94,6 +94,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@faker-js/faker": "^6.0.0",
     "@nestjs/cli": "^10.1.16",
     "@nestjs/schematics": "^10.0.2",
     "@nestjs/testing": "^10.2.2",

packages/echo/.eslintrc.js → packages/echo/.eslintrc.mjs

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   extends: ['../../.eslintrc.js'],
   parserOptions: {
     project: './tsconfig.json',

packages/echo/jest.config.js → packages/echo/jest.config.mjs

@@ -4,7 +4,7 @@
  * https://jestjs.io/docs/configuration
  */
 
-module.exports = {
+export default {
   /*
    * All imported modules in your tests should be mocked automatically
    * automock: false,

packages/echo/package.json

@@ -2,8 +2,8 @@
   "name": "@novu/echo",
   "version": "0.24.3-alpha.0",
   "description": "The Code-First Notifications Workflow SDK.",
-  "main": "./dist/src/index.js",
-  "types": "./dist/src/index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"
@@ -17,10 +17,8 @@
     "lint:fix": "eslint src --ext .ts --fix",
     "format": "prettier --check --ignore-path .gitignore .",
     "format:fix": "prettier --write --ignore-path .gitignore .",
-    "clean": "rm -rf ./dist",
-    "prebuild": "rimraf dist",
-    "build": "pnpm run clean && tsc --build",
-    "build:watch": "tsc --build --watch",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
     "$comment:bump:prerelease": "This is a workaround to support `npm version prerelease` with lerna",
     "bump:prerelease": "npm version prerelease --preid=alpha & PID=$!; (sleep 1 && kill -9 $PID) & wait $PID",
     "release:alpha": "pnpm bump:prerelease || pnpm build && npm publish"
@@ -45,29 +43,29 @@
   "license": "MIT",
   "exports": {
     ".": {
-      "require": "./dist/src/index.js",
-      "import": "./dist/src/index.js",
-      "types": "./dist/src/index.d.ts"
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
     },
     "./express": {
-      "require": "./dist/src/express.js",
-      "import": "./dist/src/express.js",
-      "types": "./dist/src/express.d.ts"
+      "require": "./dist/express.js",
+      "import": "./dist/express.mjs",
+      "types": "./dist/express.d.ts"
     },
     "./next": {
-      "require": "./dist/src/next.js",
-      "import": "./dist/src/next.js",
-      "types": "./dist/src/next.d.ts"
+      "require": "./dist/next.js",
+      "import": "./dist/next.mjs",
+      "types": "./dist/next.d.ts"
     },
     "./nuxt": {
-      "require": "./dist/src/nuxt.js",
-      "import": "./dist/src/nuxt.js",
-      "types": "./dist/src/nuxt.d.ts"
+      "require": "./dist/nuxt.js",
+      "import": "./dist/nuxt.mjs",
+      "types": "./dist/nuxt.d.ts"
     },
     "./h3": {
-      "require": "./dist/src/h3.js",
-      "import": "./dist/src/h3.js",
-      "types": "./dist/src/h3.d.ts"
+      "require": "./dist/h3.js",
+      "import": "./dist/h3.mjs",
+      "types": "./dist/h3.d.ts"
     }
   },
   "devDependencies": {
@@ -84,6 +82,7 @@
     "prettier": "^3.2.5",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
+    "tsup": "^8.0.2",
     "typescript": "^5.3.3"
   },
   "dependencies": {

packages/echo/src/next.ts

@@ -6,7 +6,7 @@ import { Either } from './types';
 import { type SupportedFrameworkName } from './types';
 import { getResponse } from './utils';
 
-export const frameworkName: SupportedFrameworkName = 'nextjs';
+export const frameworkName: SupportedFrameworkName = 'next';
 
 /**
  * In Next.js, serve and register any declared workflows with Echo, making

packages/echo/src/types/framework.types.ts

@@ -1 +1 @@
-export type SupportedFrameworkName = 'nextjs' | 'express' | 'nuxt' | 'h3';
+export type SupportedFrameworkName = 'next' | 'express' | 'nuxt' | 'h3';

packages/echo/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
-    "target": "ES2019",
-    "module": "CommonJS",
+    "target": "ESNext",
+    "module": "ESNext",
     "moduleResolution": "node",
     "skipLibCheck": true,
     "resolveJsonModule": true,

packages/echo/tsup.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'tsup';
+import { type SupportedFrameworkName } from './src';
+
+const frameworks: SupportedFrameworkName[] = ['h3', 'express', 'next', 'nuxt'];
+
+export default defineConfig({
+  entry: ['src/index.ts', ...frameworks.map((framework) => `src/${framework}.ts`)],
+  sourcemap: false,
+  clean: true,
+  treeshake: true,
+  dts: true,
+  format: ['cjs', 'esm'],
+  minify: true,
+  minifyWhitespace: true,
+  minifyIdentifiers: true,
+  minifySyntax: true,
+});