From aeae66dd2896253fe594a0a0bff585279cffc608 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 00:51:32 +0100
Subject: [PATCH 01/12] refactor(client): make addWorkflows async

---
 packages/framework/src/client.test.ts         |  76 ++++-----
 packages/framework/src/client.ts              |   9 +-
 .../framework/src/client.validation.test.ts   |   8 +-
 packages/framework/src/handler.ts             |   4 +-
 .../workflow/discover-action-step-factory.ts  |  12 +-
 .../workflow/discover-channel-step-factory.ts |  12 +-
 .../workflow/discover-custom-step-factory.ts  |  13 +-
 .../resources/workflow/discover-providers.ts  |   8 +-
 .../src/resources/workflow/discover-step.ts   |   6 +-
 .../resources/workflow/workflow.resource.ts   | 146 +++++++++---------
 .../src/resources/workflow/workflow.test.ts   |  12 +-
 .../framework/src/types/discover.types.ts     |   2 +-
 .../framework/src/types/validator.types.ts    |   2 +-
 .../src/validators/base.validator.ts          |   2 +-
 .../src/validators/json-schema.validator.ts   |   2 +-
 .../src/validators/validator.test.ts          |   8 +-
 .../framework/src/validators/zod.validator.ts |   5 +-
 17 files changed, 173 insertions(+), 154 deletions(-)

diff --git a/packages/framework/src/client.test.ts b/packages/framework/src/client.test.ts
index cb7a7fa78e4..45c380b0d16 100644
--- a/packages/framework/src/client.test.ts
+++ b/packages/framework/src/client.test.ts
@@ -25,7 +25,7 @@ describe('Novu Client', () => {
     });
 
     client = new Client({ secretKey: 'some-secret-key' });
-    client.addWorkflows([newWorkflow]);
+    await client.addWorkflows([newWorkflow]);
   });
 
   describe('client constructor', () => {
@@ -184,7 +184,7 @@ describe('Novu Client', () => {
         }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       // wait for discovery to finish
       await new Promise((resolve) => {
@@ -300,7 +300,7 @@ describe('Novu Client', () => {
         );
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const discovery = client.discover();
       expect(discovery.workflows).toHaveLength(2);
@@ -354,7 +354,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const emailEvent: Event = {
         action: PostActionEnum.PREVIEW,
@@ -380,7 +380,7 @@ describe('Novu Client', () => {
     it('should sanitize the step result of all delivery channel step types', async () => {
       const script = `<script>alert('Hello there')</script>`;
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.email('send-email', async () => ({
             body: `Start of body. ${script}`,
@@ -408,7 +408,7 @@ describe('Novu Client', () => {
     it('should not sanitize the step result of custom step type', async () => {
       const script = `<script>alert('Hello there')</script>`;
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.custom(
             'send-email',
@@ -467,7 +467,7 @@ describe('Novu Client', () => {
         controls: {},
       };
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const emailExecutionResult = await client.executeWorkflow(emailEvent);
 
@@ -563,7 +563,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const emailEvent: Event = {
         action: PostActionEnum.EXECUTE,
@@ -632,7 +632,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -698,7 +698,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -761,7 +761,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -824,7 +824,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -887,7 +887,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -934,7 +934,7 @@ describe('Novu Client', () => {
         );
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -980,7 +980,7 @@ describe('Novu Client', () => {
         );
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const emailEvent: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1029,7 +1029,7 @@ describe('Novu Client', () => {
         );
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const emailEvent: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1060,7 +1060,7 @@ describe('Novu Client', () => {
         await step.email('send-email', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1099,7 +1099,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1152,7 +1152,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1206,7 +1206,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1248,7 +1248,7 @@ describe('Novu Client', () => {
         await step.email('inactive-step-id', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1276,7 +1276,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1305,7 +1305,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1343,7 +1343,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1377,7 +1377,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([workflowMock]);
+      await client.addWorkflows([workflowMock]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,
@@ -1401,7 +1401,7 @@ describe('Novu Client', () => {
         await step.email('send-email', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,
@@ -1440,7 +1440,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,
@@ -1490,7 +1490,7 @@ describe('Novu Client', () => {
         await step.email('send-email', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       // @ts-expect-error - no workflow id
       const event2: Event = {
@@ -1507,7 +1507,7 @@ describe('Novu Client', () => {
         await step.email('send-email', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1527,7 +1527,7 @@ describe('Novu Client', () => {
         await step.email('send-email', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       // @ts-expect-error - no action
       const event: Event = {
@@ -1548,7 +1548,7 @@ describe('Novu Client', () => {
         });
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1585,7 +1585,7 @@ describe('Novu Client', () => {
         );
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.EXECUTE,
@@ -1605,7 +1605,7 @@ describe('Novu Client', () => {
     it('should sanitize the step output of all channel step types by default', async () => {
       const script = `<script>alert('Hello there')</script>`;
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.email('send-email', async () => ({
             body: `Start of body. ${script}`,
@@ -1633,7 +1633,7 @@ describe('Novu Client', () => {
     it('should sanitize the step output of channel step types when `disableOutputSanitization: false`', async () => {
       const script = `<script>alert('Hello there')</script>`;
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.email(
             'send-email',
@@ -1668,7 +1668,7 @@ describe('Novu Client', () => {
       const link =
         '/pipeline/Oee4d54-ca52-4d70-86b3-cd10a67b6810/requirements?requirementId=dc25a578-ecf1-4835-9310-2236f8244bd&commentId=e259b16b-68f9-43af-b252-fce68bc7cb2f';
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.inApp(
             'send-inapp',
@@ -1704,7 +1704,7 @@ describe('Novu Client', () => {
     it('should not sanitize the step result of custom step type', async () => {
       const script = `<script>alert('Hello there')</a>`;
 
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('test-workflow', async ({ step }) => {
           await step.custom(
             'send-email',
@@ -1758,7 +1758,7 @@ describe('Novu Client', () => {
 
       const newWorkflow = workflow('setup-workflow', workflowExecuteFunc);
 
-      getCodeClientInstance.addWorkflows([newWorkflow]);
+      await getCodeClientInstance.addWorkflows([newWorkflow]);
     });
 
     it('should throw an error when workflow ID is not found', () => {
@@ -1768,7 +1768,7 @@ describe('Novu Client', () => {
     it('should throw an error when step ID is provided but not found in the workflow', async () => {
       const newWorkflow = workflow('test-workflow', workflowExecuteFunc);
 
-      getCodeClientInstance.addWorkflows([newWorkflow]);
+      await getCodeClientInstance.addWorkflows([newWorkflow]);
 
       expect(() => getCodeClientInstance.getCode('test-workflow', 'non-existent-step')).toThrow(StepNotFoundError);
     });
diff --git a/packages/framework/src/client.ts b/packages/framework/src/client.ts
index 2643ab14903..5fa59ccccd9 100644
--- a/packages/framework/src/client.ts
+++ b/packages/framework/src/client.ts
@@ -94,12 +94,13 @@ export class Client {
     return builtConfiguration;
   }
 
-  public addWorkflows(workflows: Array<Workflow>) {
+  public async addWorkflows(workflows: Array<Workflow>) {
     for (const workflow of workflows) {
-      if (this.discoveredWorkflows.some((existing) => existing.workflowId === workflow.definition.workflowId)) {
-        throw new WorkflowAlreadyExistsError(workflow.definition.workflowId);
+      const definition = await workflow.discover();
+      if (this.discoveredWorkflows.some((existing) => existing.workflowId === definition.workflowId)) {
+        throw new WorkflowAlreadyExistsError(definition.workflowId);
       } else {
-        this.discoveredWorkflows.push(workflow.definition);
+        this.discoveredWorkflows.push(definition);
       }
     }
   }
diff --git a/packages/framework/src/client.validation.test.ts b/packages/framework/src/client.validation.test.ts
index 141e1234a62..b3444d0c7c5 100644
--- a/packages/framework/src/client.validation.test.ts
+++ b/packages/framework/src/client.validation.test.ts
@@ -111,7 +111,7 @@ describe('validation', () => {
     });
 
     it('should transform a zod schema to a json schema during discovery', async () => {
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('zod-validation', async ({ step }) => {
           await step.email(
             'zod-validation',
@@ -145,7 +145,7 @@ describe('validation', () => {
     });
 
     it('should throw an error if a property is missing', async () => {
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('zod-validation', async ({ step }) => {
           await step.email(
             'test-email',
@@ -290,7 +290,7 @@ describe('validation', () => {
     });
 
     it('should transform a JSON schema to a valid schema during discovery', async () => {
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('json-schema-validation', async ({ step }) => {
           await step.email(
             'json-schema-validation',
@@ -324,7 +324,7 @@ describe('validation', () => {
     });
 
     it('should throw an error if a property is missing', async () => {
-      client.addWorkflows([
+      await client.addWorkflows([
         workflow('json-schema-validation', async ({ step }) => {
           await step.email(
             'test-email',
diff --git a/packages/framework/src/handler.ts b/packages/framework/src/handler.ts
index 63ee99e3afa..2e71b85d822 100644
--- a/packages/framework/src/handler.ts
+++ b/packages/framework/src/handler.ts
@@ -68,11 +68,12 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
   public readonly client: Client;
   private readonly hmacEnabled: boolean;
   private readonly http;
+  private readonly workflows: Array<Workflow>;
 
   constructor(options: INovuRequestHandlerOptions<Input, Output>) {
     this.handler = options.handler;
     this.client = options.client ? options.client : new Client();
-    this.client.addWorkflows(options.workflows);
+    this.workflows = options.workflows;
     this.http = initApiClient(this.client.secretKey, this.client.apiUrl);
     this.frameworkName = options.frameworkName;
     this.hmacEnabled = this.client.strictAuthentication;
@@ -80,6 +81,7 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
 
   public createHandler(): (...args: Input) => Promise<Output> {
     return async (...args: Input) => {
+      await this.client.addWorkflows(this.workflows);
       const actions = await this.handler(...args);
       const actionResponse = await this.handleAction({
         actions,
diff --git a/packages/framework/src/resources/workflow/discover-action-step-factory.ts b/packages/framework/src/resources/workflow/discover-action-step-factory.ts
index 50ccce64748..8b7d7d4fcca 100644
--- a/packages/framework/src/resources/workflow/discover-action-step-factory.ts
+++ b/packages/framework/src/resources/workflow/discover-action-step-factory.ts
@@ -4,30 +4,30 @@ import type { Awaitable, DiscoverWorkflowOutput, Schema, ActionStep } from '../.
 import { transformSchema } from '../../validators';
 import { discoverStep } from './discover-step';
 
-export function discoverActionStepFactory(
+export async function discoverActionStepFactory(
   targetWorkflow: DiscoverWorkflowOutput,
   type: ActionStepEnum,
   outputSchema: Schema,
   resultSchema: Schema
   // TODO: fix typing for `resolve` to use generic typings
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ActionStep<any, any> {
+): Promise<ActionStep<any, any>> {
   return async (stepId, resolve, options = {}) => {
     const controlSchema = options?.controlSchema || emptySchema;
 
-    discoverStep(targetWorkflow, stepId, {
+    await discoverStep(targetWorkflow, stepId, {
       stepId,
       type,
       controls: {
-        schema: transformSchema(controlSchema),
+        schema: await transformSchema(controlSchema),
         unknownSchema: controlSchema,
       },
       outputs: {
-        schema: transformSchema(outputSchema),
+        schema: await transformSchema(outputSchema),
         unknownSchema: outputSchema,
       },
       results: {
-        schema: transformSchema(resultSchema),
+        schema: await transformSchema(resultSchema),
         unknownSchema: resultSchema,
       },
       resolve: resolve as (controls: Record<string, unknown>) => Awaitable<Record<string, unknown>>,
diff --git a/packages/framework/src/resources/workflow/discover-channel-step-factory.ts b/packages/framework/src/resources/workflow/discover-channel-step-factory.ts
index b1718a93996..6b3fb0e5656 100644
--- a/packages/framework/src/resources/workflow/discover-channel-step-factory.ts
+++ b/packages/framework/src/resources/workflow/discover-channel-step-factory.ts
@@ -5,13 +5,13 @@ import { transformSchema } from '../../validators';
 import { discoverProviders } from './discover-providers';
 import { discoverStep } from './discover-step';
 
-export function discoverChannelStepFactory(
+export async function discoverChannelStepFactory(
   targetWorkflow: DiscoverWorkflowOutput,
   type: ChannelStepEnum,
   outputSchema: Schema,
   resultSchema: Schema
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ChannelStep<ChannelStepEnum, any, any> {
+): Promise<ChannelStep<ChannelStepEnum, any, any>> {
   return async (stepId, resolve, options = {}) => {
     const controlSchema = options?.controlSchema || emptySchema;
 
@@ -19,15 +19,15 @@ export function discoverChannelStepFactory(
       stepId,
       type,
       controls: {
-        schema: transformSchema(controlSchema),
+        schema: await transformSchema(controlSchema),
         unknownSchema: controlSchema,
       },
       outputs: {
-        schema: transformSchema(outputSchema),
+        schema: await transformSchema(outputSchema),
         unknownSchema: outputSchema,
       },
       results: {
-        schema: transformSchema(resultSchema),
+        schema: await transformSchema(resultSchema),
         unknownSchema: resultSchema,
       },
       resolve: resolve as (controls: Record<string, unknown>) => Awaitable<Record<string, unknown>>,
@@ -36,7 +36,7 @@ export function discoverChannelStepFactory(
       providers: [],
     };
 
-    discoverStep(targetWorkflow, stepId, step);
+    await discoverStep(targetWorkflow, stepId, step);
 
     if (Object.keys(options.providers || {}).length > 0) {
       discoverProviders(step, type as ChannelStepEnum, options.providers || {});
diff --git a/packages/framework/src/resources/workflow/discover-custom-step-factory.ts b/packages/framework/src/resources/workflow/discover-custom-step-factory.ts
index faa8201a95d..66a6d5ebf36 100644
--- a/packages/framework/src/resources/workflow/discover-custom-step-factory.ts
+++ b/packages/framework/src/resources/workflow/discover-custom-step-factory.ts
@@ -3,24 +3,27 @@ import type { Awaitable, CustomStep, DiscoverWorkflowOutput, StepType, StepOutpu
 import { transformSchema } from '../../validators';
 import { discoverStep } from './discover-step';
 
-export function discoverCustomStepFactory(targetWorkflow: DiscoverWorkflowOutput, type: StepType): CustomStep {
+export async function discoverCustomStepFactory(
+  targetWorkflow: DiscoverWorkflowOutput,
+  type: StepType
+): Promise<CustomStep> {
   return async (stepId, resolve, options = {}) => {
     const controlSchema = options?.controlSchema || emptySchema;
     const outputSchema = options?.outputSchema || emptySchema;
 
-    discoverStep(targetWorkflow, stepId, {
+    await discoverStep(targetWorkflow, stepId, {
       stepId,
       type,
       controls: {
-        schema: transformSchema(controlSchema),
+        schema: await transformSchema(controlSchema),
         unknownSchema: controlSchema,
       },
       outputs: {
-        schema: transformSchema(outputSchema),
+        schema: await transformSchema(outputSchema),
         unknownSchema: outputSchema,
       },
       results: {
-        schema: transformSchema(outputSchema),
+        schema: await transformSchema(outputSchema),
         unknownSchema: outputSchema,
       },
       resolve: resolve as (controls: Record<string, unknown>) => Awaitable<Record<string, unknown>>,
diff --git a/packages/framework/src/resources/workflow/discover-providers.ts b/packages/framework/src/resources/workflow/discover-providers.ts
index 14fd45cf66e..672c0766474 100644
--- a/packages/framework/src/resources/workflow/discover-providers.ts
+++ b/packages/framework/src/resources/workflow/discover-providers.ts
@@ -4,7 +4,7 @@ import type { Awaitable, DiscoverStepOutput } from '../../types';
 import { WithPassthrough } from '../../types/provider.types';
 import { transformSchema } from '../../validators';
 
-export function discoverProviders(
+export async function discoverProviders(
   step: DiscoverStepOutput,
   channelType: ChannelStepEnum,
   providers: Record<
@@ -17,10 +17,10 @@ export function discoverProviders(
       outputs: Record<string, unknown>;
     }) => Awaitable<WithPassthrough<Record<string, unknown>>>
   >
-): void {
+): Promise<void> {
   const channelSchemas = providerSchemas[channelType];
 
-  Object.entries(providers).forEach(([type, resolve]) => {
+  Object.entries(providers).forEach(async ([type, resolve]) => {
     // eslint-disable-next-line multiline-comment-style
     // TODO: fix the typing for `type` to use the keyof providerSchema[channelType]
     // @ts-expect-error - Element implicitly has an 'any' type because expression of type 'string' can't be used to index type
@@ -30,7 +30,7 @@ export function discoverProviders(
       code: resolve.toString(),
       resolve,
       outputs: {
-        schema: transformSchema(schemas.output),
+        schema: await transformSchema(schemas.output),
         unknownSchema: schemas.output,
       },
     });
diff --git a/packages/framework/src/resources/workflow/discover-step.ts b/packages/framework/src/resources/workflow/discover-step.ts
index 161a61b25d1..032a755ee61 100644
--- a/packages/framework/src/resources/workflow/discover-step.ts
+++ b/packages/framework/src/resources/workflow/discover-step.ts
@@ -1,7 +1,11 @@
 import { StepAlreadyExistsError } from '../../errors';
 import type { DiscoverStepOutput, DiscoverWorkflowOutput } from '../../types';
 
-export function discoverStep(targetWorkflow: DiscoverWorkflowOutput, stepId: string, step: DiscoverStepOutput): void {
+export async function discoverStep(
+  targetWorkflow: DiscoverWorkflowOutput,
+  stepId: string,
+  step: DiscoverStepOutput
+): Promise<void> {
   if (targetWorkflow.steps.some((workflowStep) => workflowStep.stepId === stepId)) {
     throw new StepAlreadyExistsError(stepId);
   } else {
diff --git a/packages/framework/src/resources/workflow/workflow.resource.ts b/packages/framework/src/resources/workflow/workflow.resource.ts
index 51dce4d6171..7de9023d20f 100644
--- a/packages/framework/src/resources/workflow/workflow.resource.ts
+++ b/packages/framework/src/resources/workflow/workflow.resource.ts
@@ -77,81 +77,85 @@ export function workflow<
     };
   };
 
-  const newWorkflow: DiscoverWorkflowOutput = {
-    workflowId,
-    steps: [],
-    code: execute.toString(),
-    payload: {
-      schema: transformSchema(options.payloadSchema || emptySchema),
-      unknownSchema: options.payloadSchema || emptySchema,
-    },
-    controls: {
-      schema: transformSchema(options.controlSchema || emptySchema),
-      unknownSchema: options.controlSchema || emptySchema,
-    },
-    tags: options.tags || [],
-    preferences: mapPreferences(options.preferences),
-    name: options.name,
-    description: options.description,
-    execute: execute as Execute<Record<string, unknown>, Record<string, unknown>>,
-  };
+  const discover = async (): Promise<DiscoverWorkflowOutput> => {
+    const newWorkflow: DiscoverWorkflowOutput = {
+      workflowId,
+      steps: [],
+      code: execute.toString(),
+      payload: {
+        schema: await transformSchema(options.payloadSchema || emptySchema),
+        unknownSchema: options.payloadSchema || emptySchema,
+      },
+      controls: {
+        schema: await transformSchema(options.controlSchema || emptySchema),
+        unknownSchema: options.controlSchema || emptySchema,
+      },
+      tags: options.tags || [],
+      preferences: mapPreferences(options.preferences),
+      name: options.name,
+      description: options.description,
+      execute: execute as Execute<Record<string, unknown>, Record<string, unknown>>,
+    };
+
+    await execute({
+      payload: {} as T_PayloadValidated,
+      subscriber: {},
+      environment: {},
+      controls: {} as T_Controls,
+      step: {
+        push: await discoverChannelStepFactory(
+          newWorkflow,
+          ChannelStepEnum.PUSH,
+          channelStepSchemas.push.output,
+          channelStepSchemas.push.result
+        ),
+        chat: await discoverChannelStepFactory(
+          newWorkflow,
+          ChannelStepEnum.CHAT,
+          channelStepSchemas.chat.output,
+          channelStepSchemas.chat.result
+        ),
+        email: await discoverChannelStepFactory(
+          newWorkflow,
+          ChannelStepEnum.EMAIL,
+          channelStepSchemas.email.output,
+          channelStepSchemas.email.result
+        ),
+        sms: await discoverChannelStepFactory(
+          newWorkflow,
+          ChannelStepEnum.SMS,
+          channelStepSchemas.sms.output,
+          channelStepSchemas.sms.result
+        ),
+        inApp: await discoverChannelStepFactory(
+          newWorkflow,
+          ChannelStepEnum.IN_APP,
+          channelStepSchemas.in_app.output,
+          channelStepSchemas.in_app.result
+        ),
+        digest: await discoverActionStepFactory(
+          newWorkflow,
+          ActionStepEnum.DIGEST,
+          digestActionSchemas.output,
+          digestActionSchemas.result
+        ),
+        delay: await discoverActionStepFactory(
+          newWorkflow,
+          ActionStepEnum.DELAY,
+          delayActionSchemas.output,
+          delayActionSchemas.result
+        ),
+        custom: await discoverCustomStepFactory(newWorkflow, ActionStepEnum.CUSTOM),
+      } as never,
+    });
 
-  execute({
-    payload: {} as T_PayloadValidated,
-    subscriber: {},
-    environment: {},
-    controls: {} as T_Controls,
-    step: {
-      push: discoverChannelStepFactory(
-        newWorkflow,
-        ChannelStepEnum.PUSH,
-        channelStepSchemas.push.output,
-        channelStepSchemas.push.result
-      ),
-      chat: discoverChannelStepFactory(
-        newWorkflow,
-        ChannelStepEnum.CHAT,
-        channelStepSchemas.chat.output,
-        channelStepSchemas.chat.result
-      ),
-      email: discoverChannelStepFactory(
-        newWorkflow,
-        ChannelStepEnum.EMAIL,
-        channelStepSchemas.email.output,
-        channelStepSchemas.email.result
-      ),
-      sms: discoverChannelStepFactory(
-        newWorkflow,
-        ChannelStepEnum.SMS,
-        channelStepSchemas.sms.output,
-        channelStepSchemas.sms.result
-      ),
-      inApp: discoverChannelStepFactory(
-        newWorkflow,
-        ChannelStepEnum.IN_APP,
-        channelStepSchemas.in_app.output,
-        channelStepSchemas.in_app.result
-      ),
-      digest: discoverActionStepFactory(
-        newWorkflow,
-        ActionStepEnum.DIGEST,
-        digestActionSchemas.output,
-        digestActionSchemas.result
-      ),
-      delay: discoverActionStepFactory(
-        newWorkflow,
-        ActionStepEnum.DELAY,
-        delayActionSchemas.output,
-        delayActionSchemas.result
-      ),
-      custom: discoverCustomStepFactory(newWorkflow, ActionStepEnum.CUSTOM),
-    } as never,
-  }).then(() => {
     prettyPrintDiscovery(newWorkflow);
-  });
+
+    return newWorkflow;
+  };
 
   return {
     trigger,
-    definition: newWorkflow,
+    discover,
   };
 }
diff --git a/packages/framework/src/resources/workflow/workflow.test.ts b/packages/framework/src/resources/workflow/workflow.test.ts
index 396e2977bcf..cf6b947c848 100644
--- a/packages/framework/src/resources/workflow/workflow.test.ts
+++ b/packages/framework/src/resources/workflow/workflow.test.ts
@@ -99,7 +99,7 @@ describe('workflow function', () => {
   });
 
   it('should include the defined preferences', async () => {
-    const { definition } = workflow(
+    const { discover } = workflow(
       'setup-workflow',
       async ({ step }) => {
         await step.email('send-email', async () => ({
@@ -116,6 +116,8 @@ describe('workflow function', () => {
       }
     );
 
+    const definition = await discover();
+
     expect(definition.preferences).to.deep.equal({
       channels: {
         email: { enabled: true },
@@ -124,7 +126,7 @@ describe('workflow function', () => {
   });
 
   it('should include the defined name', async () => {
-    const { definition } = workflow(
+    const { discover } = workflow(
       'workflow-with-name',
       async ({ step }) => {
         await step.email('send-email', async () => ({
@@ -137,11 +139,13 @@ describe('workflow function', () => {
       }
     );
 
+    const definition = await discover();
+
     expect(definition.name).to.equal('My Workflow');
   });
 
   it('should include the defined description', async () => {
-    const { definition } = workflow(
+    const { discover } = workflow(
       'workflow-with-description',
       async ({ step }) => {
         await step.email('send-email', async () => ({
@@ -154,6 +158,8 @@ describe('workflow function', () => {
       }
     );
 
+    const definition = await discover();
+
     expect(definition.description).to.equal('My Workflow Description');
   });
 
diff --git a/packages/framework/src/types/discover.types.ts b/packages/framework/src/types/discover.types.ts
index dae568a7cfa..b97078a0eef 100644
--- a/packages/framework/src/types/discover.types.ts
+++ b/packages/framework/src/types/discover.types.ts
@@ -70,7 +70,7 @@ export type Workflow<T_Payload = any> = {
   trigger: (
     event: Prettify<Omit<EventTriggerParams<T_Payload>, 'workflowId' | 'bridgeUrl' | 'controls'>>
   ) => Promise<EventTriggerResult>;
-  definition: DiscoverWorkflowOutput;
+  discover: () => Promise<DiscoverWorkflowOutput>;
 };
 
 export type DiscoverOutput = {
diff --git a/packages/framework/src/types/validator.types.ts b/packages/framework/src/types/validator.types.ts
index 1f9225645b2..36826f8bf2b 100644
--- a/packages/framework/src/types/validator.types.ts
+++ b/packages/framework/src/types/validator.types.ts
@@ -29,5 +29,5 @@ export interface Validator<T_Schema extends Schema = Schema> {
     schema: T_Schema
   ) => Promise<ValidateResult<T_Validated>>;
   canHandle: (schema: Schema) => schema is T_Schema;
-  transformToJsonSchema: (schema: T_Schema) => JsonSchema;
+  transformToJsonSchema: (schema: T_Schema) => Promise<JsonSchema>;
 }
diff --git a/packages/framework/src/validators/base.validator.ts b/packages/framework/src/validators/base.validator.ts
index 4ac5e959e60..3a7f170a634 100644
--- a/packages/framework/src/validators/base.validator.ts
+++ b/packages/framework/src/validators/base.validator.ts
@@ -23,7 +23,7 @@ export const validateData = async <
   throw new Error('Invalid schema');
 };
 
-export const transformSchema = (schema: Schema): JsonSchema => {
+export const transformSchema = async (schema: Schema): Promise<JsonSchema> => {
   if (zodValidator.canHandle(schema)) {
     return zodValidator.transformToJsonSchema(schema);
   } else if (jsonSchemaValidator.canHandle(schema)) {
diff --git a/packages/framework/src/validators/json-schema.validator.ts b/packages/framework/src/validators/json-schema.validator.ts
index 51bf08234c2..2a5446d7a9a 100644
--- a/packages/framework/src/validators/json-schema.validator.ts
+++ b/packages/framework/src/validators/json-schema.validator.ts
@@ -68,7 +68,7 @@ export class JsonSchemaValidator implements Validator<JsonSchema> {
     }
   }
 
-  transformToJsonSchema(schema: JsonSchema): JsonSchema {
+  async transformToJsonSchema(schema: JsonSchema): Promise<JsonSchema> {
     return schema;
   }
 }
diff --git a/packages/framework/src/validators/validator.test.ts b/packages/framework/src/validators/validator.test.ts
index 62ae56876e7..c52531a19e1 100644
--- a/packages/framework/src/validators/validator.test.ts
+++ b/packages/framework/src/validators/validator.test.ts
@@ -520,19 +520,19 @@ describe('validators', () => {
         testCases
           .filter((testCase) => testCase.schemas[schema] !== null)
           .forEach((testCase) => {
-            it(testCase.title, () => {
-              const result = transformSchema(testCase.schemas[schema] as Schema);
+            it(testCase.title, async () => {
+              const result = await transformSchema(testCase.schemas[schema] as Schema);
               expect(result).deep.contain(testCase.result);
             });
           });
       });
     });
 
-    it('should throw an error for invalid schema', () => {
+    it('should throw an error for invalid schema', async () => {
       const schema = { invalidKey: 'test' } as const;
 
       // @ts-expect-error - we are testing the type guard
-      expect(() => transformSchema(schema)).toThrow('Invalid schema');
+      await expect(transformSchema(schema)).rejects.toThrow('Invalid schema');
     });
   });
 });
diff --git a/packages/framework/src/validators/zod.validator.ts b/packages/framework/src/validators/zod.validator.ts
index e6eb413a372..5d383111cb0 100644
--- a/packages/framework/src/validators/zod.validator.ts
+++ b/packages/framework/src/validators/zod.validator.ts
@@ -27,10 +27,9 @@ export class ZodValidator implements Validator<ZodSchema> {
     }
   }
 
-  transformToJsonSchema(schema: ZodSchema): JsonSchema {
+  async transformToJsonSchema(schema: ZodSchema): Promise<JsonSchema> {
     try {
-      // eslint-disable-next-line global-require
-      const { zodToJsonSchema } = require('zod-to-json-schema') as typeof import('zod-to-json-schema');
+      const { zodToJsonSchema } = await import('zod-to-json-schema');
 
       // @ts-expect-error - zod-to-json-schema is not using JSONSchema7
       return zodToJsonSchema(schema);

From b351651fb188e91cecca11a182a3b677598d9e8d Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 01:19:38 +0100
Subject: [PATCH 02/12] docs(types): add comments for Workflow methods

---
 packages/framework/src/types/discover.types.ts | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/packages/framework/src/types/discover.types.ts b/packages/framework/src/types/discover.types.ts
index b97078a0eef..a8e711ea107 100644
--- a/packages/framework/src/types/discover.types.ts
+++ b/packages/framework/src/types/discover.types.ts
@@ -67,9 +67,20 @@ export type DiscoverWorkflowOutput = {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Workflow<T_Payload = any> = {
+  /**
+   * Trigger an event for this workflow with a strongly typed and validated `payload`, derived from the `payloadSchema`.
+   *
+   * @param event - The event to trigger
+   * @returns `EventTriggerResult` - The result of the event trigger
+   */
   trigger: (
     event: Prettify<Omit<EventTriggerParams<T_Payload>, 'workflowId' | 'bridgeUrl' | 'controls'>>
   ) => Promise<EventTriggerResult>;
+  /**
+   * Discover the workflow definition.
+   *
+   * @returns `DiscoverWorkflowOutput` - The workflow definition
+   */
   discover: () => Promise<DiscoverWorkflowOutput>;
 };
 

From 3b616913c4b7480beb359e6123ef328cf5fd57bd Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 01:32:10 +0100
Subject: [PATCH 03/12] refactor(client): improve workflow handling logic

---
 packages/framework/src/client.ts                      | 11 ++++++-----
 .../src/resources/workflow/workflow.resource.ts       |  4 +---
 packages/framework/src/types/discover.types.ts        |  4 ++++
 3 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/packages/framework/src/client.ts b/packages/framework/src/client.ts
index 5fa59ccccd9..b90fd7d9585 100644
--- a/packages/framework/src/client.ts
+++ b/packages/framework/src/client.ts
@@ -13,7 +13,6 @@ import {
   ProviderNotFoundError,
   StepControlCompilationFailedError,
   StepNotFoundError,
-  WorkflowAlreadyExistsError,
   WorkflowNotFoundError,
   StepExecutionFailedError,
   isFrameworkError,
@@ -46,6 +45,7 @@ import {
 import { validateData } from './validators';
 
 import { mockSchema } from './jsonSchemaFaker';
+import { prettyPrintDiscovery } from './resources/workflow/pretty-print-discovery';
 
 function isRuntimeInDevelopment() {
   return ['development', undefined].includes(process.env.NODE_ENV);
@@ -94,12 +94,13 @@ export class Client {
     return builtConfiguration;
   }
 
-  public async addWorkflows(workflows: Array<Workflow>) {
+  public async addWorkflows(workflows: Array<Workflow>): Promise<void> {
     for (const workflow of workflows) {
-      const definition = await workflow.discover();
-      if (this.discoveredWorkflows.some((existing) => existing.workflowId === definition.workflowId)) {
-        throw new WorkflowAlreadyExistsError(definition.workflowId);
+      if (this.discoveredWorkflows.some((existing) => existing.workflowId === workflow.id)) {
+        return;
       } else {
+        const definition = await workflow.discover();
+        prettyPrintDiscovery(definition);
         this.discoveredWorkflows.push(definition);
       }
     }
diff --git a/packages/framework/src/resources/workflow/workflow.resource.ts b/packages/framework/src/resources/workflow/workflow.resource.ts
index 7de9023d20f..c6d868d6558 100644
--- a/packages/framework/src/resources/workflow/workflow.resource.ts
+++ b/packages/framework/src/resources/workflow/workflow.resource.ts
@@ -18,7 +18,6 @@ import { discoverActionStepFactory } from './discover-action-step-factory';
 import { discoverChannelStepFactory } from './discover-channel-step-factory';
 import { discoverCustomStepFactory } from './discover-custom-step-factory';
 import { mapPreferences } from './map-preferences';
-import { prettyPrintDiscovery } from './pretty-print-discovery';
 
 /**
  * Define a new notification workflow.
@@ -149,12 +148,11 @@ export function workflow<
       } as never,
     });
 
-    prettyPrintDiscovery(newWorkflow);
-
     return newWorkflow;
   };
 
   return {
+    id: workflowId,
     trigger,
     discover,
   };
diff --git a/packages/framework/src/types/discover.types.ts b/packages/framework/src/types/discover.types.ts
index a8e711ea107..0af4e50ee0c 100644
--- a/packages/framework/src/types/discover.types.ts
+++ b/packages/framework/src/types/discover.types.ts
@@ -67,6 +67,10 @@ export type DiscoverWorkflowOutput = {
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Workflow<T_Payload = any> = {
+  /**
+   * The unique identifier of the workflow.
+   */
+  id: string;
   /**
    * Trigger an event for this workflow with a strongly typed and validated `payload`, derived from the `payloadSchema`.
    *

From 330f7294bdea9fa5119cb65c729f3a4cc08c644c Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 22:29:03 +0100
Subject: [PATCH 04/12] test: Mock preferences in bridge-trigger e2e test

---
 apps/api/src/app/events/e2e/bridge-trigger.e2e.ts | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts b/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts
index ed9ef43261e..e92e1ccdc98 100644
--- a/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts
+++ b/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts
@@ -1,6 +1,7 @@
 import axios from 'axios';
 import { expect } from 'chai';
 import { v4 as uuidv4 } from 'uuid';
+import sinon from 'sinon';
 
 import { SubscribersService, UserSession } from '@novu/testing';
 import {
@@ -724,8 +725,9 @@ contexts.forEach((context: Context) => {
        * Delete `preferences` from the Workflow Definition to simulate an old
        * Workflow Definition (i.e. from old Framework version) that doesn't have the `preferences` property.
        */
-      // @ts-ignore - The operand of a 'delete' operator must be optional.
-      delete newWorkflow.definition.preferences;
+      const { preferences, ...rest } = await newWorkflow.discover();
+      // @ts-expect-error - preferences is not part of the resolved object
+      sinon.stub(newWorkflow, 'discover').resolves(rest);
 
       await bridgeServer.start({ workflows: [newWorkflow] });
 

From 51200c6638646f4ce4a1631c2d247cbb1e7ca2e0 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 23:27:54 +0100
Subject: [PATCH 05/12] test(client): add missing awaits in addWorkflows

---
 packages/framework/src/client.test.ts | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/packages/framework/src/client.test.ts b/packages/framework/src/client.test.ts
index 2a3d39bb3a0..a80064e2359 100644
--- a/packages/framework/src/client.test.ts
+++ b/packages/framework/src/client.test.ts
@@ -1469,7 +1469,7 @@ describe('Novu Client', () => {
         await step.inApp('send-in-app', async () => ({ body: 'Test Body', subject: 'Subject' }));
       });
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,
@@ -1571,7 +1571,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,
@@ -1656,7 +1656,7 @@ describe('Novu Client', () => {
         }
       );
 
-      client.addWorkflows([newWorkflow]);
+      await client.addWorkflows([newWorkflow]);
 
       const event: Event = {
         action: PostActionEnum.PREVIEW,

From ff2b943ca6e8d64029e0d2745b3a73342a0ed3cb Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 7 Nov 2024 23:30:35 +0100
Subject: [PATCH 06/12] feat(handler): add async HMAC validation with subtle
 API

---
 packages/framework/src/handler.ts             | 14 +++-----
 .../framework/src/utils/crypto.utils.test.ts  | 16 ++++++++++
 packages/framework/src/utils/crypto.utils.ts  | 32 +++++++++++++++++++
 packages/framework/src/utils/index.ts         |  1 +
 4 files changed, 53 insertions(+), 10 deletions(-)
 create mode 100644 packages/framework/src/utils/crypto.utils.test.ts
 create mode 100644 packages/framework/src/utils/crypto.utils.ts

diff --git a/packages/framework/src/handler.ts b/packages/framework/src/handler.ts
index 2e71b85d822..90bec00c5c9 100644
--- a/packages/framework/src/handler.ts
+++ b/packages/framework/src/handler.ts
@@ -1,5 +1,3 @@
-import { createHmac } from 'node:crypto';
-
 import { Client } from './client';
 import {
   GetActionEnum,
@@ -23,7 +21,7 @@ import {
   SigningKeyNotFoundError,
 } from './errors';
 import type { Awaitable, EventTriggerParams, Workflow } from './types';
-import { initApiClient } from './utils';
+import { initApiClient, createHmacSubtle } from './utils';
 import { isPlatformError } from './errors/guard.errors';
 
 export type ServeHandlerOptions = {
@@ -148,7 +146,7 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
 
     try {
       if (action !== GetActionEnum.HEALTH_CHECK) {
-        this.validateHmac(body, signatureHeader);
+        await this.validateHmac(body, signatureHeader);
       }
 
       const postActionMap = this.getPostActionMap(body, workflowId, stepId, action);
@@ -293,7 +291,7 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
     }
   }
 
-  private validateHmac(payload: unknown, hmacHeader: string | null): void {
+  private async validateHmac(payload: unknown, hmacHeader: string | null): Promise<void> {
     if (!this.hmacEnabled) return;
     if (!hmacHeader) {
       throw new SignatureNotFoundError();
@@ -316,7 +314,7 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
       throw new SignatureExpiredError();
     }
 
-    const localHash = this.hashHmac(this.client.secretKey as string, `${timestampPayload}.${JSON.stringify(payload)}`);
+    const localHash = await createHmacSubtle(this.client.secretKey, `${timestampPayload}.${JSON.stringify(payload)}`);
 
     const isMatching = localHash === signaturePayload;
 
@@ -324,8 +322,4 @@ export class NovuRequestHandler<Input extends any[] = any[], Output = any> {
       throw new SignatureMismatchError();
     }
   }
-
-  private hashHmac(secretKey: string, data: string): string {
-    return createHmac('sha256', secretKey).update(data).digest('hex');
-  }
 }
diff --git a/packages/framework/src/utils/crypto.utils.test.ts b/packages/framework/src/utils/crypto.utils.test.ts
new file mode 100644
index 00000000000..35183e292ee
--- /dev/null
+++ b/packages/framework/src/utils/crypto.utils.test.ts
@@ -0,0 +1,16 @@
+import { createHmac } from 'node:crypto';
+import { describe, expect, it } from 'vitest';
+import { createHmacSubtle } from './crypto.utils';
+
+const createHmacNode = (secretKey: string, data: string): string => {
+  return createHmac('sha256', secretKey).update(data).digest('hex');
+};
+
+describe('createHmacSubtle', () => {
+  it('should create an HMAC equivalent to node crypto createHmac', async () => {
+    const hmacSubtle = await createHmacSubtle('secret', 'data');
+    const hmacNode = createHmacNode('secret', 'data');
+
+    expect(hmacSubtle).toEqual(hmacNode);
+  });
+});
diff --git a/packages/framework/src/utils/crypto.utils.ts b/packages/framework/src/utils/crypto.utils.ts
new file mode 100644
index 00000000000..fe08c9a282c
--- /dev/null
+++ b/packages/framework/src/utils/crypto.utils.ts
@@ -0,0 +1,32 @@
+/**
+ * Create HMAC using subtle crypto.
+ *
+ * `crypto.subtle` is a Web Crypto API this is available in browsers,
+ * Node.js, and most edge runtimes, such as Cloudflare Workers.
+ *
+ * @param secretKey - The secret key.
+ * @param data - The data to hash.
+ * @returns The HMAC.
+ */
+export const createHmacSubtle = async (secretKey: string, data: string): Promise<string> => {
+  const encoder = new TextEncoder();
+  const keyData = encoder.encode(secretKey);
+  const dataBuffer = encoder.encode(data);
+
+  const cryptoKey = await crypto.subtle.importKey(
+    'raw',
+    keyData,
+    {
+      name: 'HMAC',
+      hash: { name: 'SHA-256' },
+    },
+    false,
+    ['sign']
+  );
+
+  const signature = await crypto.subtle.sign('HMAC', cryptoKey, dataBuffer);
+
+  return Array.from(new Uint8Array(signature))
+    .map((byte) => byte.toString(16).padStart(2, '0'))
+    .join('');
+};
diff --git a/packages/framework/src/utils/index.ts b/packages/framework/src/utils/index.ts
index 266a16d37fe..573e95c9f48 100644
--- a/packages/framework/src/utils/index.ts
+++ b/packages/framework/src/utils/index.ts
@@ -1,3 +1,4 @@
+export * from './crypto.utils';
 export * from './env.utils';
 export * from './http.utils';
 export * from './log.utils';

From 924248075f06da6dcd7aece1860a7e0a3fbce9a0 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 00:51:33 +0100
Subject: [PATCH 07/12] test: organize crypto utils test structure

---
 .../framework/src/utils/crypto.utils.test.ts   | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/packages/framework/src/utils/crypto.utils.test.ts b/packages/framework/src/utils/crypto.utils.test.ts
index 35183e292ee..a8f9e0930b6 100644
--- a/packages/framework/src/utils/crypto.utils.test.ts
+++ b/packages/framework/src/utils/crypto.utils.test.ts
@@ -2,15 +2,17 @@ import { createHmac } from 'node:crypto';
 import { describe, expect, it } from 'vitest';
 import { createHmacSubtle } from './crypto.utils';
 
-const createHmacNode = (secretKey: string, data: string): string => {
-  return createHmac('sha256', secretKey).update(data).digest('hex');
-};
+describe('crypto utils', () => {
+  describe('createHmacSubtle', () => {
+    const createHmacNode = (secretKey: string, data: string): string => {
+      return createHmac('sha256', secretKey).update(data).digest('hex');
+    };
 
-describe('createHmacSubtle', () => {
-  it('should create an HMAC equivalent to node crypto createHmac', async () => {
-    const hmacSubtle = await createHmacSubtle('secret', 'data');
-    const hmacNode = createHmacNode('secret', 'data');
+    it('should create an HMAC equivalent to node crypto createHmac', async () => {
+      const hmacSubtle = await createHmacSubtle('secret', 'data');
+      const hmacNode = createHmacNode('secret', 'data');
 
-    expect(hmacSubtle).toEqual(hmacNode);
+      expect(hmacSubtle).toEqual(hmacNode);
+    });
   });
 });

From 71c9c31d06f73ea2a55960316f30408b1f337273 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 00:51:39 +0100
Subject: [PATCH 08/12] refactor(next): abstract response type check logic

---
 packages/framework/src/servers/next.ts | 35 ++++++++++++++++++++------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/packages/framework/src/servers/next.ts b/packages/framework/src/servers/next.ts
index 249e6c193c2..80c967e68d3 100644
--- a/packages/framework/src/servers/next.ts
+++ b/packages/framework/src/servers/next.ts
@@ -21,6 +21,27 @@ import { getResponse } from '../utils';
 export * from '../index';
 export const frameworkName: SupportedFrameworkName = 'next';
 
+/**
+ * Defines a request handler for Next.js 12+.
+ *
+ * The argument types are kept abstract due to varying type checks across
+ * Next.js versions. Next.js 15 uses `RouteContext` for the second argument,
+ * while versions 13 and 14 omit it, and version 12 uses `NextApiResponse`,
+ * which varies by environment (edge vs serverless).
+ */
+export type RequestHandler = (expectedReq: NextRequest, res: unknown) => Promise<Response>;
+
+// Helper function to check if the response is a Next.js 12 API response
+const isNext12ApiResponse = (val: unknown): val is NextApiResponse => {
+  return (
+    typeof val === 'object' &&
+    val !== null &&
+    typeof (val as NextApiResponse).setHeader === 'function' &&
+    typeof (val as NextApiResponse).status === 'function' &&
+    typeof (val as NextApiResponse).send === 'function'
+  );
+};
+
 /**
  * In Next.js, serve and register any declared workflows with Novu, making
  * them available to be triggered by events.
@@ -45,10 +66,10 @@ export const frameworkName: SupportedFrameworkName = 'next';
  */
 export const serve = (
   options: ServeHandlerOptions
-): ((expectedReq: NextRequest, res: NextApiResponse) => Promise<Response>) & {
-  GET: (expectedReq: NextRequest, res: NextApiResponse) => Promise<Response>;
-  POST: (expectedReq: NextRequest, res: NextApiResponse) => Promise<Response>;
-  OPTIONS: (expectedReq: NextRequest, res: NextApiResponse) => Promise<Response>;
+): RequestHandler & {
+  GET: RequestHandler;
+  POST: RequestHandler;
+  OPTIONS: RequestHandler;
 } => {
   const novuHandler = new NovuRequestHandler({
     frameworkName,
@@ -56,7 +77,7 @@ export const serve = (
     handler: (
       requestMethod: 'GET' | 'POST' | 'OPTIONS' | undefined,
       incomingRequest: NextRequest,
-      response: NextApiResponse
+      response: unknown
     ) => {
       const request = incomingRequest as Either<NextApiRequest, NextRequest>;
 
@@ -138,13 +159,11 @@ export const serve = (
            * Carefully attempt to set headers and data on the response object
            * for Next.js 12 support.
            */
-          if (typeof response?.setHeader === 'function') {
+          if (isNext12ApiResponse(response)) {
             Object.entries(headers).forEach(([headerName, headerValue]) => {
               response.setHeader(headerName, headerValue);
             });
-          }
 
-          if (typeof response?.status === 'function' && typeof response?.send === 'function') {
             response.status(status).send(body);
 
             /**

From 82d980e651ceea2e1ea41c66dbd3577fd09e709b Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 00:58:20 +0100
Subject: [PATCH 09/12] test(errors): add tests for isNativeError function

---
 packages/framework/src/errors/base.errors.ts  |  3 +--
 .../framework/src/errors/guard.errors.test.ts | 20 ++++++++++++++++++-
 packages/framework/src/errors/guard.errors.ts | 19 ++++++++++++++++++
 3 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/packages/framework/src/errors/base.errors.ts b/packages/framework/src/errors/base.errors.ts
index 27a79915482..262c45077fb 100644
--- a/packages/framework/src/errors/base.errors.ts
+++ b/packages/framework/src/errors/base.errors.ts
@@ -1,7 +1,6 @@
-import { isNativeError } from 'node:util/types';
-
 import { HttpStatusEnum } from '../constants';
 import { ErrorCodeEnum } from '../constants/error.constants';
+import { isNativeError } from './guard.errors';
 
 /**
  * Base error class.
diff --git a/packages/framework/src/errors/guard.errors.test.ts b/packages/framework/src/errors/guard.errors.test.ts
index 9e5b3069320..6017f1db9dc 100644
--- a/packages/framework/src/errors/guard.errors.test.ts
+++ b/packages/framework/src/errors/guard.errors.test.ts
@@ -1,5 +1,5 @@
 import { expect, it, describe } from 'vitest';
-import { isFrameworkError, isPlatformError } from './guard.errors';
+import { isFrameworkError, isNativeError, isPlatformError } from './guard.errors';
 import { PlatformError } from './platform.errors';
 import { ErrorCodeEnum, HttpStatusEnum } from '../constants';
 import { FrameworkError } from './base.errors';
@@ -11,6 +11,24 @@ class TestFrameworkError extends FrameworkError {
 }
 
 describe('error utils', () => {
+  describe('isNativeError', () => {
+    it('should return true for native errors', () => {
+      expect(isNativeError(new Error('Test error'))).toBe(true);
+    });
+
+    it('should return true for framework errors', () => {
+      expect(isNativeError(new TestFrameworkError('Unable to find the workflow'))).toBe(true);
+    });
+
+    const falseCases = [{}, null, undefined, 'Test error', 123, true, [], () => {}, Symbol('test')];
+
+    falseCases.forEach((value) => {
+      it(`should return false for ${typeof value}`, () => {
+        expect(isNativeError(value)).toBe(false);
+      });
+    });
+  });
+
   describe('isFrameworkError', () => {
     it('should return true for framework errors', () => {
       expect(isFrameworkError(new TestFrameworkError('Unable to find the workflow'))).toBe(true);
diff --git a/packages/framework/src/errors/guard.errors.ts b/packages/framework/src/errors/guard.errors.ts
index c2c7d5a56ab..4938ec442c4 100644
--- a/packages/framework/src/errors/guard.errors.ts
+++ b/packages/framework/src/errors/guard.errors.ts
@@ -2,6 +2,25 @@ import { ErrorCodeEnum } from '../constants';
 import { FrameworkError } from './base.errors';
 import { PlatformError } from './platform.errors';
 
+/**
+ * Check if the object is a native error.
+ *
+ * This method relies on `Object.prototype.toString()` behavior. It is possible to obtain
+ * an incorrect result when the object argument manipulates the `@@toStringTag` property.
+ *
+ * @param object - The object to check.
+ * @returns `true` if the object is a native error, `false` otherwise.
+ */
+export const isNativeError = (object: unknown): object is Error => {
+  if (typeof object !== 'object' || object === null) {
+    return false;
+  }
+
+  const proto = Object.getPrototypeOf(object);
+
+  return proto?.constructor?.name.endsWith('Error') ?? false;
+};
+
 /**
  * Check if the error is a `FrameworkError`.
  *

From a6b606000b42af59c25ffe0694a81b2b0478af67 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 01:30:37 +0100
Subject: [PATCH 10/12] refactor(errors): move isNativeError function

---
 packages/framework/src/errors/base.errors.ts  | 20 ++++++++++++++++++-
 .../framework/src/errors/guard.errors.test.ts |  4 ++--
 packages/framework/src/errors/guard.errors.ts | 19 ------------------
 3 files changed, 21 insertions(+), 22 deletions(-)

diff --git a/packages/framework/src/errors/base.errors.ts b/packages/framework/src/errors/base.errors.ts
index 262c45077fb..ecab83f2b21 100644
--- a/packages/framework/src/errors/base.errors.ts
+++ b/packages/framework/src/errors/base.errors.ts
@@ -1,6 +1,24 @@
 import { HttpStatusEnum } from '../constants';
 import { ErrorCodeEnum } from '../constants/error.constants';
-import { isNativeError } from './guard.errors';
+
+/**
+ * Check if the object is a native error.
+ *
+ * This method relies on `Object.prototype.toString()` behavior. It is possible to obtain
+ * an incorrect result when the object argument manipulates the `@@toStringTag` property.
+ *
+ * @param object - The object to check.
+ * @returns `true` if the object is a native error, `false` otherwise.
+ */
+export const isNativeError = (object: unknown): object is Error => {
+  if (typeof object !== 'object' || object === null) {
+    return false;
+  }
+
+  const proto = Object.getPrototypeOf(object);
+
+  return proto?.constructor?.name.endsWith('Error') ?? false;
+};
 
 /**
  * Base error class.
diff --git a/packages/framework/src/errors/guard.errors.test.ts b/packages/framework/src/errors/guard.errors.test.ts
index 6017f1db9dc..464fc7ec5e0 100644
--- a/packages/framework/src/errors/guard.errors.test.ts
+++ b/packages/framework/src/errors/guard.errors.test.ts
@@ -1,8 +1,8 @@
 import { expect, it, describe } from 'vitest';
-import { isFrameworkError, isNativeError, isPlatformError } from './guard.errors';
+import { isFrameworkError, isPlatformError } from './guard.errors';
+import { isNativeError, FrameworkError } from './base.errors';
 import { PlatformError } from './platform.errors';
 import { ErrorCodeEnum, HttpStatusEnum } from '../constants';
-import { FrameworkError } from './base.errors';
 import { BridgeError } from './bridge.errors';
 
 class TestFrameworkError extends FrameworkError {
diff --git a/packages/framework/src/errors/guard.errors.ts b/packages/framework/src/errors/guard.errors.ts
index 4938ec442c4..c2c7d5a56ab 100644
--- a/packages/framework/src/errors/guard.errors.ts
+++ b/packages/framework/src/errors/guard.errors.ts
@@ -2,25 +2,6 @@ import { ErrorCodeEnum } from '../constants';
 import { FrameworkError } from './base.errors';
 import { PlatformError } from './platform.errors';
 
-/**
- * Check if the object is a native error.
- *
- * This method relies on `Object.prototype.toString()` behavior. It is possible to obtain
- * an incorrect result when the object argument manipulates the `@@toStringTag` property.
- *
- * @param object - The object to check.
- * @returns `true` if the object is a native error, `false` otherwise.
- */
-export const isNativeError = (object: unknown): object is Error => {
-  if (typeof object !== 'object' || object === null) {
-    return false;
-  }
-
-  const proto = Object.getPrototypeOf(object);
-
-  return proto?.constructor?.name.endsWith('Error') ?? false;
-};
-
 /**
  * Check if the error is a `FrameworkError`.
  *

From c9b795dcdc61d9f14ead02dadbaf1967cdb4cc58 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 01:39:25 +0100
Subject: [PATCH 11/12] Update packages/framework/src/errors/base.errors.ts

---
 packages/framework/src/errors/base.errors.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/framework/src/errors/base.errors.ts b/packages/framework/src/errors/base.errors.ts
index ecab83f2b21..9f0cb581833 100644
--- a/packages/framework/src/errors/base.errors.ts
+++ b/packages/framework/src/errors/base.errors.ts
@@ -5,7 +5,7 @@ import { ErrorCodeEnum } from '../constants/error.constants';
  * Check if the object is a native error.
  *
  * This method relies on `Object.prototype.toString()` behavior. It is possible to obtain
- * an incorrect result when the object argument manipulates the `@@toStringTag` property.
+ * an incorrect result when the object argument has a non `Error`-suffixed `name` property.
  *
  * @param object - The object to check.
  * @returns `true` if the object is a native error, `false` otherwise.

From db82a4cd08dfe33cc24cde464b565a0921d16a0d Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Fri, 8 Nov 2024 01:49:12 +0100
Subject: [PATCH 12/12] style: Update comment and type assertion

---
 packages/framework/src/validators/zod.validator.ts | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/framework/src/validators/zod.validator.ts b/packages/framework/src/validators/zod.validator.ts
index 5d383111cb0..e428b9bf82e 100644
--- a/packages/framework/src/validators/zod.validator.ts
+++ b/packages/framework/src/validators/zod.validator.ts
@@ -31,8 +31,8 @@ export class ZodValidator implements Validator<ZodSchema> {
     try {
       const { zodToJsonSchema } = await import('zod-to-json-schema');
 
-      // @ts-expect-error - zod-to-json-schema is not using JSONSchema7
-      return zodToJsonSchema(schema);
+      // TODO: zod-to-json-schema is not using JSONSchema7
+      return zodToJsonSchema(schema) as JsonSchema;
     } catch (error) {
       if ((error as Error)?.message?.includes('Cannot find module')) {
         // eslint-disable-next-line no-console