Robust and flexible notification building blocks

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: {    userName: string;    ...  };  step: Step;  subscriber: {    firstName: string;    ...  };}The event that triggered the workflow.) => {
6  await event.step.inAppchatdelaydigestemailinApppushsms(method) email: ChannelStep<{ body: string }, { seen: boolean; ... }>Send an email.('inbox-notification', async () => ({
7    subject: `**${event.payloadpayload: {  userName: string;  comment: string;};The data passed during the trigger, typesare generated from `payloadSchema`.userName}** commented in project`,
8    body: event.payload.comment,
9  }));
10
11  const digest = await event.step.digest('digest-comments', (controls) => ({
12    cron: controls.schedule
13  }), { controlSchema: z.object({ schedule: z.nativeEnum(CronExpression) }) });
14
15  await event.step.email('digest-email', async (controls) => ({
16    subject: controls.subject,
17    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} />)
18  }), {
19    skip(property) skip: (controls: Controls) => booleanSkip the step. If true is returned, the step will be skipped.: () => !digest.events.length,
20    controlSchema: z.object({
21      subject: z.string().default('Hi {{subscriber.firstName}} - Acme Comments'),
22      openAiModel: z.enum(['gpt-3.5-turbo', 'gpt-4o']).default('gpt-4o'),
23      aiPrompt: z.string().default('Produce a concise comment digest'),
24    })
25  });
26}, { payloadSchema: z.object({ userName: z.string(), comment: z.string() }) });
27
28await weeklyComments.trigger(property) trigger: (event: {  payload: {    userName: string;    comment: string;  };  to: Recipients;  actor?: Actor | undefined;  tenant?: Tenant | undefined;}) => Promise<...>Trigger a notification workflow.({
29  payload: { userName: 'John Doe', comment: 'Are you free to give me a call?' },
30  to: 'jane@acme.com'
31});