The JavaScript-native Notification Framework for Developers

1import { workflow, CronExpression } from '@novu/framework';
2import { z } from 'zod';
3import { render } from '@react-email/components';
4
5const weeklyComments = workflow(alias) workflow(  id: string,  execute: Execute<...>,  options?: WorkflowOptions<...>,): Workflow<...>Define a notification workflow.('weekly-comments', async (event(parameter) event: {  payload: {    name: string;    comment: string;  };  step: Step;  subscriber: {    firstName: string;    ...  };}The event that triggered the workflow.) => {
6  const digest = await event.step.digest('digest-comments', (controls) => ({
7    cron: controls.schedule
8  }), { controlSchema: z.object({ schedule: z.nativeEnum(CronExpression) }) });
9
10  await event.step.emailchatdelaydigestemailinApppushsms(method) email: ChannelStep<{ body: string }, { seen: boolean; ... }>Send an email.('digest-email', async (controls) => ({
11    subject: controls.subject,
12    body: render(<WeeklyDigestEmail {...controls(parameter) controls: {  subject: string;  openAiModel: "gpt-3.5-turbo" | "gpt-4o";  aiPrompt: string;}The controls for the workflow step.} events={digest.events} />)
13  }), {
14    skip(property) skip: (controls: Controls) => booleanSkip the step. If true is returned, the step will be skipped.: () => !digest.events.length,
15    controlSchema: z.object({
16      subject: z.string().default('Hi {{subscriber.firstName}} - Acme Comments'),
17      openAiModel: z.enum(['gpt-3.5-turbo', 'gpt-4o']).default('gpt-4o'),
18      aiPrompt: z.string().default('Produce a concise comment digest'),
19    })
20  });
21}, { payloadSchema: z.object({ name: z.string(), comment: z.string() }) });
22
23await weeklyComments.trigger(property) trigger: (event: {  payload: {    name: string;    comment: string;  };  to: Recipients;  actor?: Actor | undefined;  tenant?: Tenant | undefined;}) => Promise<...>Trigger a notification workflow.({
24  payload: { name: 'John', comment: 'Are you free to give me a call?' },
25  to: 'jane@acme.com'
26});