fix(framework): Resolve CJS issues this time with json-schema-faker (#…

…6766)

.cspell.json

@@ -788,6 +788,7 @@
     "apps/web/src/studio/components/workflows/step-editor/editor/files.ts",
     "apps/web/src/pages/playground/web-container-configuration/sandbox-vite/*.ts",
     "apps/api/src/app/analytics/usecases/hubspot-identify-form/hubspot-identify-form.usecase.ts",
-    "apps/dashboard/eslint.config.js"
+    "apps/dashboard/eslint.config.js",
+    "packages/framework/src/jsonSchemaFaker.js"
   ]
 }

packages/framework/express/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/express.cjs",
-  "module": "../dist/esm/servers/express.js",
-  "types": "../dist/esm/servers/express.d.ts"
+  "main": "../dist/cjs/servers/express.cjs"
 }

packages/framework/h3/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/h3.cjs",
-  "module": "../dist/esm/servers/h3.js",
-  "types": "../dist/esm/servers/h3.d.ts"
+  "main": "../dist/cjs/servers/h3.cjs"
 }

packages/framework/internal/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/internal/index.cjs",
-  "module": "../dist/esm/internal/index.js",
-  "types": "../dist/esm/internal/index.d.ts"
+  "main": "../dist/cjs/internal/index.cjs"
 }

packages/framework/lambda/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/lambda.cjs",
-  "module": "../dist/esm/servers/lambda.js",
-  "types": "../dist/esm/servers/lambda.d.ts"
+  "main": "../dist/cjs/servers/lambda.cjs"
 }

packages/framework/nest/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/nest.cjs",
-  "module": "../dist/esm/servers/nest.js",
-  "types": "../dist/esm/servers/nest.d.ts"
+  "main": "../dist/cjs/servers/nest.cjs"
 }

packages/framework/next/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/next.cjs",
-  "module": "../dist/esm/servers/next.js",
-  "types": "../dist/esm/servers/next.d.ts"
+  "main": "../dist/cjs/servers/next.cjs"
 }

packages/framework/nuxt/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/nuxt.cjs",
-  "module": "../dist/esm/servers/nuxt.js",
-  "types": "../dist/esm/servers/nuxt.d.ts"
+  "main": "../dist/cjs/servers/nuxt.cjs"
 }

packages/framework/package.json

@@ -37,7 +37,7 @@
     "format:fix": "prettier --write --ignore-path .gitignore .",
     "build": "NODE_ENV=production tsup",
     "build:watch": "tsup --watch",
-    "postbuild": "./scripts/copy-package-json.sh && pnpm run check:exports && pnpm check:circulars",
+    "postbuild": "pnpm run check:exports && pnpm check:circulars",
     "check:exports": "attw --pack .",
     "check:circulars": "madge --circular --extensions ts --exclude ../../shared ./src",
     "$comment:bump:prerelease": "This is a workaround to support `npm version prerelease` with lerna",
@@ -239,7 +239,6 @@
     "better-ajv-errors": "^1.2.0",
     "chalk": "^4.1.2",
     "cross-fetch": "^4.0.0",
-    "json-schema-faker": "^0.5.6",
     "json-schema-to-ts": "^3.0.0",
     "liquidjs": "^10.13.1",
     "ora": "^5.4.1",

packages/framework/remix/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/remix.cjs",
-  "module": "../dist/esm/servers/remix.js",
-  "types": "../dist/esm/servers/remix.d.ts"
+  "main": "../dist/cjs/servers/remix.cjs"
 }

packages/framework/src/client.test.ts

@@ -11,7 +11,7 @@ import {
 } from './errors';
 import { workflow } from './resources';
 import { Event, Step } from './types';
-import { FRAMEWORK_VERSION, SDK_VERSION, PostActionEnum } from './constants';
+import { PostActionEnum } from './constants';
 
 describe('Novu Client', () => {
   let client: Client;

packages/framework/src/client.ts

@@ -1,7 +1,7 @@
 import { Liquid } from 'liquidjs';
 import ora from 'ora';
 
-import { ChannelStepEnum, FRAMEWORK_VERSION, PostActionEnum, SDK_VERSION } from './constants';
+import { ChannelStepEnum, PostActionEnum } from './constants';
 import {
   ExecutionEventControlsInvalidError,
   ExecutionEventPayloadInvalidError,
@@ -37,25 +37,9 @@ import type {
 } from './types';
 import { WithPassthrough } from './types/provider.types';
 import { EMOJI, log, sanitizeHtmlInObject, stringifyDataStructureWithSingleQuotes } from './utils';
-import { transformSchema, validateData } from './validators';
-
-/*
- * JSONSchemaFaker needs to be imported as CJS to avoid HMR and Webpack issues when importing @novu/framework
- * in Next.js. See https://github.com/json-schema-faker/json-schema-faker/issues/796#issuecomment-2433335751
- */
-const { JSONSchemaFaker } = require('json-schema-faker');
-
-/**
- * We want to respond with a consistent string value for preview
- */
-JSONSchemaFaker.random.shuffle = function shuffle() {
-  return ['[placeholder]'];
-};
-
-JSONSchemaFaker.option({
-  useDefaultValue: true,
-  alwaysFakeOptionals: true,
-});
+import { validateData } from './validators';
+
+import { mockSchema } from './jsonSchemaFaker';
 
 function isRuntimeInDevelopment() {
   return ['development', undefined].includes(process.env.NODE_ENV);
@@ -169,8 +153,7 @@ export class Client {
    * @returns mocked data
    */
   private mock(schema: Schema): Record<string, unknown> {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return JSONSchemaFaker.generate(transformSchema(schema) as any) as Record<string, unknown>;
+    return mockSchema(schema) as Record<string, unknown>;
   }
 
   private async validate<T extends Record<string, unknown>>(

packages/framework/src/constants/index.ts

@@ -8,5 +8,4 @@ export * from './http-query.constants';
 export * from './http-status.constants';
 export * from './resource.constants';
 export * from './step.constants';
-export * from './version.constants';
 export * from './workflow.constants';

packages/framework/src/globals.d.ts

@@ -0,0 +1,6 @@
+export {};
+
+declare global {
+  const SDK_VERSION: string;
+  const FRAMEWORK_VERSION: string;
+}

packages/framework/src/handler.ts

@@ -2,14 +2,12 @@ import { createHmac } from 'node:crypto';
 
 import { Client } from './client';
 import {
-  FRAMEWORK_VERSION,
   GetActionEnum,
   HttpHeaderKeysEnum,
   HttpMethodEnum,
   HttpQueryKeysEnum,
   HttpStatusEnum,
   PostActionEnum,
-  SDK_VERSION,
   SIGNATURE_TIMESTAMP_TOLERANCE,
 } from './constants';
 import {