@novu/framework 2.0.1 → 2.0.3

package/dist/{handler-gB0GtvM6.d.ts → handler-WKKD7ESp.d.ts}

@@ -1,4 +1,4 @@
-import { ChannelTypeEnum, TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, TriggerRecipientsPayload } from '@novu/shared';
+import { TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, TriggerRecipientsPayload, ChannelTypeEnum } from '@novu/shared';
 import { JSONSchema, FromSchema as FromSchema$1 } from 'json-schema-to-ts';
 import zod from 'zod';
 
@@ -55,6 +55,15 @@ declare enum ActionStepEnum {
     CUSTOM = "custom"
 }
 
+declare enum WorkflowChannelEnum {
+    EMAIL = "email",
+    SMS = "sms",
+    PUSH = "push",
+    CHAT = "chat",
+    /** Differs from ChannelTypeEnum in capitalization / snake_case */
+    IN_APP = "inApp"
+}
+
 type JsonSchema = JSONSchema;
 /**
  * A schema used to validate a JSON object.
@@ -3722,7 +3731,7 @@ declare const channelStepSchemas: {
                             readonly properties: {
                                 readonly url: {
                                     readonly type: "string";
-                                    readonly format: "uri";
+                                    readonly pattern: "^(?!mailto:)(?:(https?):\\/\\/[^\\s/$.?#].[^\\s]*)|^(\\/[^\\s]*)$";
                                 };
                                 readonly target: {
                                     readonly type: "string";
@@ -3730,6 +3739,28 @@ declare const channelStepSchemas: {
                                     readonly default: "_blank";
                                 };
                             };
+                            readonly if: {
+                                readonly properties: {
+                                    readonly url: {
+                                        readonly type: "string";
+                                        readonly pattern: "^/";
+                                    };
+                                };
+                            };
+                            readonly then: {
+                                readonly properties: {
+                                    readonly target: {
+                                        readonly default: "_self";
+                                    };
+                                };
+                            };
+                            readonly else: {
+                                readonly properties: {
+                                    readonly target: {
+                                        readonly default: "_blank";
+                                    };
+                                };
+                            };
                             readonly required: readonly ["url"];
                             readonly additionalProperties: false;
                         };
@@ -3748,7 +3779,7 @@ declare const channelStepSchemas: {
                             readonly properties: {
                                 readonly url: {
                                     readonly type: "string";
-                                    readonly format: "uri";
+                                    readonly pattern: "^(?!mailto:)(?:(https?):\\/\\/[^\\s/$.?#].[^\\s]*)|^(\\/[^\\s]*)$";
                                 };
                                 readonly target: {
                                     readonly type: "string";
@@ -3756,6 +3787,28 @@ declare const channelStepSchemas: {
                                     readonly default: "_blank";
                                 };
                             };
+                            readonly if: {
+                                readonly properties: {
+                                    readonly url: {
+                                        readonly type: "string";
+                                        readonly pattern: "^/";
+                                    };
+                                };
+                            };
+                            readonly then: {
+                                readonly properties: {
+                                    readonly target: {
+                                        readonly default: "_self";
+                                    };
+                                };
+                            };
+                            readonly else: {
+                                readonly properties: {
+                                    readonly target: {
+                                        readonly default: "_blank";
+                                    };
+                                };
+                            };
                             readonly required: readonly ["url"];
                             readonly additionalProperties: false;
                         };
@@ -3772,7 +3825,7 @@ declare const channelStepSchemas: {
                     readonly properties: {
                         readonly url: {
                             readonly type: "string";
-                            readonly format: "uri";
+                            readonly pattern: "^(?!mailto:)(?:(https?):\\/\\/[^\\s/$.?#].[^\\s]*)|^(\\/[^\\s]*)$";
                         };
                         readonly target: {
                             readonly type: "string";
@@ -3780,6 +3833,28 @@ declare const channelStepSchemas: {
                             readonly default: "_blank";
                         };
                     };
+                    readonly if: {
+                        readonly properties: {
+                            readonly url: {
+                                readonly type: "string";
+                                readonly pattern: "^/";
+                            };
+                        };
+                    };
+                    readonly then: {
+                        readonly properties: {
+                            readonly target: {
+                                readonly default: "_self";
+                            };
+                        };
+                    };
+                    readonly else: {
+                        readonly properties: {
+                            readonly target: {
+                                readonly default: "_blank";
+                            };
+                        };
+                    };
                     readonly required: readonly ["url"];
                     readonly additionalProperties: false;
                 };
@@ -4190,15 +4265,15 @@ type DigestResult = FromSchema<(typeof actionStepSchemas)[ActionStepEnum.DIGEST]
  */
 type Step = {
     /** Send an email. */
-    email: ChannelStep<ChannelStepEnum.EMAIL, EmailOutputUnvalidated, EmailResult>;
+    [WorkflowChannelEnum.EMAIL]: ChannelStep<ChannelStepEnum.EMAIL, EmailOutputUnvalidated, EmailResult>;
     /** Send an SMS. */
-    sms: ChannelStep<ChannelStepEnum.SMS, SmsOutputUnvalidated, SmsResult>;
+    [WorkflowChannelEnum.SMS]: ChannelStep<ChannelStepEnum.SMS, SmsOutputUnvalidated, SmsResult>;
     /** Send a push notification. */
-    push: ChannelStep<ChannelStepEnum.PUSH, PushOutputUnvalidated, PushResult>;
+    [WorkflowChannelEnum.PUSH]: ChannelStep<ChannelStepEnum.PUSH, PushOutputUnvalidated, PushResult>;
     /** Send a chat message. */
-    chat: ChannelStep<ChannelStepEnum.CHAT, ChatOutputUnvalidated, ChatResult>;
+    [WorkflowChannelEnum.CHAT]: ChannelStep<ChannelStepEnum.CHAT, ChatOutputUnvalidated, ChatResult>;
     /** Send an in-app notification. */
-    inApp: ChannelStep<ChannelStepEnum.IN_APP, InAppOutputUnvalidated, InAppResult>;
+    [WorkflowChannelEnum.IN_APP]: ChannelStep<ChannelStepEnum.IN_APP, InAppOutputUnvalidated, InAppResult>;
     /** Aggregate events for a period of time. */
     digest: ActionStep<DigestOutputUnvalidated, DigestResult>;
     /** Delay the workflow for a period of time. */
@@ -4248,9 +4323,7 @@ type WorkflowOptionChannelPreference = {
 };
 type WorkflowOptionsPreferences = {
     workflow?: WorkflowOptionChannelPreference;
-    channels?: {
-        [key in (typeof ChannelTypeEnum)[keyof typeof ChannelTypeEnum]]?: WorkflowOptionChannelPreference;
-    };
+    channels?: Partial<Record<WorkflowChannelEnum, WorkflowOptionChannelPreference>>;
 };
 /**
  * The options for the workflow.
@@ -4578,4 +4651,4 @@ declare class NovuRequestHandler<Input extends any[] = any[], Output = any> {
     private hashHmac;
 }
 
-export { type ChatResult as $, ActionStepEnum as A, type StepOutput as B, Client as C, type DiscoverProviderOutput as D, type Execute as E, type FromSchemaUnvalidated as F, GetActionEnum as G, type HealthCheck as H, type ActionStep as I, type JsonSchema as J, type CustomStep as K, type ChannelStep as L, type EmailOutput as M, NovuRequestHandler as N, type EmailOutputUnvalidated as O, PostActionEnum as P, type EmailResult as Q, type SmsOutput as R, type Schema as S, type SmsOutputUnvalidated as T, type SmsResult as U, type PushOutput as V, type WorkflowOptions as W, type PushOutputUnvalidated as X, type PushResult as Y, type ChatOutput as Z, type ChatOutputUnvalidated as _, type FromSchema as a, type InAppOutput as a0, type InAppOutputUnvalidated as a1, type InAppResult as a2, type DelayOutput as a3, type DelayOutputUnvalidated as a4, type DelayResult as a5, type DigestRegularOutput as a6, type DigestRegularOutputUnvalidated as a7, type DigestTimedOutput as a8, type DigestTimedOutputUnvalidated as a9, type DigestOutput as aa, type DigestOutputUnvalidated as ab, type DigestResult as ac, type Step as ad, type Subscriber as ae, type Either as af, type Awaitable as ag, type Prettify as ah, type ConditionalPartial as ai, type Indexable as aj, type PickOptional as ak, type PickRequired as al, type PickRequiredKeys as am, type PickOptionalKeys as an, type ExecuteInput as ao, type WorkflowOptionChannelPreference as ap, type WorkflowOptionsPreferences as aq, type Workflow as b, type ServeHandlerOptions as c, ChannelStepEnum as d, type CodeResult as e, type ClientOptions as f, type StepType as g, type DiscoverStepOutput as h, type ChannelPreference as i, type DiscoverWorkflowOutputPreferences as j, type DiscoverWorkflowOutput as k, type DiscoverOutput as l, type EventTriggerResult as m, type EventTriggerParams as n, type EventTriggerResponse as o, type CancelEventTriggerResponse as p, type Event as q, type State as r, type ExecuteOutputMetadata as s, type ExecuteOutputOptions as t, type ExecuteOutput as u, type SupportedFrameworkName as v, type Skip as w, type StepOptions as x, JobStatusEnum as y, type StepContext as z };
+export { type ChatOutputUnvalidated as $, ActionStepEnum as A, type StepContext as B, Client as C, type DiscoverProviderOutput as D, type Execute as E, type FromSchemaUnvalidated as F, GetActionEnum as G, type HealthCheck as H, type StepOutput as I, type JsonSchema as J, type ActionStep as K, type CustomStep as L, type ChannelStep as M, NovuRequestHandler as N, type EmailOutput as O, PostActionEnum as P, type EmailOutputUnvalidated as Q, type EmailResult as R, type Schema as S, type SmsOutput as T, type SmsOutputUnvalidated as U, type SmsResult as V, type WorkflowOptions as W, type PushOutput as X, type PushOutputUnvalidated as Y, type PushResult as Z, type ChatOutput as _, type FromSchema as a, type ChatResult as a0, type InAppOutput as a1, type InAppOutputUnvalidated as a2, type InAppResult as a3, type DelayOutput as a4, type DelayOutputUnvalidated as a5, type DelayResult as a6, type DigestRegularOutput as a7, type DigestRegularOutputUnvalidated as a8, type DigestTimedOutput as a9, type DigestTimedOutputUnvalidated as aa, type DigestOutput as ab, type DigestOutputUnvalidated as ac, type DigestResult as ad, type Step as ae, type Subscriber as af, type Either as ag, type Awaitable as ah, type Prettify as ai, type ConditionalPartial as aj, type Indexable as ak, type PickOptional as al, type PickRequired as am, type PickRequiredKeys as an, type PickOptionalKeys as ao, type ExecuteInput as ap, type WorkflowOptionChannelPreference as aq, type WorkflowOptionsPreferences as ar, type Workflow as b, type ServeHandlerOptions as c, ChannelStepEnum as d, WorkflowChannelEnum as e, type CodeResult as f, type ClientOptions as g, type StepType as h, type DiscoverStepOutput as i, type ChannelPreference as j, type DiscoverWorkflowOutputPreferences as k, type DiscoverWorkflowOutput as l, type DiscoverOutput as m, type EventTriggerResult as n, type EventTriggerParams as o, type EventTriggerResponse as p, type CancelEventTriggerResponse as q, type Event as r, type State as s, type ExecuteOutputMetadata as t, type ExecuteOutputOptions as u, type ExecuteOutput as v, type SupportedFrameworkName as w, type Skip as x, type StepOptions as y, JobStatusEnum as z };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as Schema, F as FromSchemaUnvalidated, a as FromSchema, J as JsonSchema, E as Execute, W as WorkflowOptions, b as Workflow } from './handler-gB0GtvM6.js';
-export { I as ActionStep, A as ActionStepEnum, ag as Awaitable, p as CancelEventTriggerResponse, i as ChannelPreference, L as ChannelStep, d as ChannelStepEnum, Z as ChatOutput, _ as ChatOutputUnvalidated, $ as ChatResult, C as Client, f as ClientOptions, e as CodeResult, ai as ConditionalPartial, K as CustomStep, a3 as DelayOutput, a4 as DelayOutputUnvalidated, a5 as DelayResult, aa as DigestOutput, ab as DigestOutputUnvalidated, a6 as DigestRegularOutput, a7 as DigestRegularOutputUnvalidated, ac as DigestResult, a8 as DigestTimedOutput, a9 as DigestTimedOutputUnvalidated, l as DiscoverOutput, D as DiscoverProviderOutput, h as DiscoverStepOutput, k as DiscoverWorkflowOutput, j as DiscoverWorkflowOutputPreferences, af as Either, M as EmailOutput, O as EmailOutputUnvalidated, Q as EmailResult, q as Event, n as EventTriggerParams, o as EventTriggerResponse, m as EventTriggerResult, ao as ExecuteInput, u as ExecuteOutput, s as ExecuteOutputMetadata, t as ExecuteOutputOptions, G as GetActionEnum, H as HealthCheck, a0 as InAppOutput, a1 as InAppOutputUnvalidated, a2 as InAppResult, aj as Indexable, y as JobStatusEnum, N as NovuRequestHandler, ak as PickOptional, an as PickOptionalKeys, al as PickRequired, am as PickRequiredKeys, P as PostActionEnum, ah as Prettify, V as PushOutput, X as PushOutputUnvalidated, Y as PushResult, c as ServeHandlerOptions, w as Skip, R as SmsOutput, T as SmsOutputUnvalidated, U as SmsResult, r as State, ad as Step, z as StepContext, x as StepOptions, B as StepOutput, g as StepType, ae as Subscriber, v as SupportedFrameworkName, ap as WorkflowOptionChannelPreference, aq as WorkflowOptionsPreferences } from './handler-gB0GtvM6.js';
+import { S as Schema, F as FromSchemaUnvalidated, a as FromSchema, J as JsonSchema, E as Execute, W as WorkflowOptions, b as Workflow } from './handler-WKKD7ESp.js';
+export { K as ActionStep, A as ActionStepEnum, ah as Awaitable, q as CancelEventTriggerResponse, j as ChannelPreference, M as ChannelStep, d as ChannelStepEnum, _ as ChatOutput, $ as ChatOutputUnvalidated, a0 as ChatResult, C as Client, g as ClientOptions, f as CodeResult, aj as ConditionalPartial, L as CustomStep, a4 as DelayOutput, a5 as DelayOutputUnvalidated, a6 as DelayResult, ab as DigestOutput, ac as DigestOutputUnvalidated, a7 as DigestRegularOutput, a8 as DigestRegularOutputUnvalidated, ad as DigestResult, a9 as DigestTimedOutput, aa as DigestTimedOutputUnvalidated, m as DiscoverOutput, D as DiscoverProviderOutput, i as DiscoverStepOutput, l as DiscoverWorkflowOutput, k as DiscoverWorkflowOutputPreferences, ag as Either, O as EmailOutput, Q as EmailOutputUnvalidated, R as EmailResult, r as Event, o as EventTriggerParams, p as EventTriggerResponse, n as EventTriggerResult, ap as ExecuteInput, v as ExecuteOutput, t as ExecuteOutputMetadata, u as ExecuteOutputOptions, G as GetActionEnum, H as HealthCheck, a1 as InAppOutput, a2 as InAppOutputUnvalidated, a3 as InAppResult, ak as Indexable, z as JobStatusEnum, N as NovuRequestHandler, al as PickOptional, ao as PickOptionalKeys, am as PickRequired, an as PickRequiredKeys, P as PostActionEnum, ai as Prettify, X as PushOutput, Y as PushOutputUnvalidated, Z as PushResult, c as ServeHandlerOptions, x as Skip, T as SmsOutput, U as SmsOutputUnvalidated, V as SmsResult, s as State, ae as Step, B as StepContext, y as StepOptions, I as StepOutput, h as StepType, af as Subscriber, w as SupportedFrameworkName, e as WorkflowChannelEnum, aq as WorkflowOptionChannelPreference, ar as WorkflowOptionsPreferences } from './handler-WKKD7ESp.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import '@novu/shared';