@novu/framework 2.0.3 → 2.1.0

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

@@ -1,4 +1,4 @@
-import { TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, TriggerRecipientsPayload, ChannelTypeEnum } from '@novu/shared';
+import { TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, TriggerRecipientsPayload, WorkflowPreferencesPartial } from '@novu/shared';
 import { JSONSchema, FromSchema as FromSchema$1 } from 'json-schema-to-ts';
 import zod from 'zod';
 
@@ -55,6 +55,10 @@ declare enum ActionStepEnum {
     CUSTOM = "custom"
 }
 
+/**
+ * A developer-friendly variant of ChannelTypeEnum, utilizing camelCase instead of snake_case
+ * to use consistent casing throughout the Framework.
+ */
 declare enum WorkflowChannelEnum {
     EMAIL = "email",
     SMS = "sms",
@@ -4058,6 +4062,12 @@ type PickRequiredKeys<T, DEEP extends boolean = true> = keyof PickRequired<T, DE
  * Optionally, recurses through nested objects if `DEEP` is true.
  */
 type PickOptionalKeys<T, DEEP extends boolean = true> = keyof PickOptional<T, DEEP>;
+/**
+ * Recursively make all properties of type `T` optional.
+ */
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
 
 type Passthrough = {
     body?: Record<string, unknown>;
@@ -4317,14 +4327,42 @@ type ExecuteInput<T_Payload extends Record<string, unknown>, T_Controls extends
  * The function to execute the workflow.
  */
 type Execute<T_Payload extends Record<string, unknown>, T_Controls extends Record<string, unknown>> = (event: ExecuteInput<T_Payload, T_Controls>) => Promise<void>;
-type WorkflowOptionChannelPreference = {
-    defaultValue?: boolean;
-    readOnly?: boolean;
-};
-type WorkflowOptionsPreferences = {
-    workflow?: WorkflowOptionChannelPreference;
-    channels?: Partial<Record<WorkflowChannelEnum, WorkflowOptionChannelPreference>>;
+/** A preference for a notification delivery channel. */
+type ChannelPreference = {
+    /**
+     * A flag specifying if notification delivery is enabled for the channel.
+     *
+     * If `true`, notification delivery is enabled.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * A flag specifying if the preference is read-only.
+     *
+     * If `true`, the preference cannot be changed by the Subscriber.
+     *
+     * @default false
+     */
+    readOnly: boolean;
 };
+/**
+ * A partial set of workflow preferences.
+ */
+type WorkflowPreferences = DeepPartial<{
+    /**
+     * A preference for the workflow.
+     *
+     * The values specified here will be used if no preference is specified for a channel.
+     */
+    workflow: ChannelPreference;
+    /**
+     * A preference for each notification delivery channel.
+     *
+     * If no preference is specified for a channel, the `workflow` preference will be used.
+     */
+    channels: Record<WorkflowChannelEnum, ChannelPreference>;
+}>;
 /**
  * The options for the workflow.
  */
@@ -4337,8 +4375,63 @@ type WorkflowOptions<T_PayloadSchema extends Schema, T_ControlSchema extends Sch
      * @deprecated Use `controlSchema` instead
      */
     inputSchema?: T_ControlSchema;
+    /** The schema for the controls. */
     controlSchema?: T_ControlSchema;
-    preferences?: WorkflowOptionsPreferences;
+    /**
+     * The preferences for the notification workflow.
+     *
+     * If no preference is specified for a channel, the `workflow` preference will be used.
+     *
+     * @example
+     * ```ts
+     * // Enable notification delivery for only the in-app channel by default.
+     * {
+     *   workflow: { enabled: false },
+     *   channels: {
+     *     inApp: { enabled: true },
+     *   },
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Enable notification delivery for all channels by default.
+     * {
+     *   workflow: { enabled: true }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Enable notification delivery for all channels by default,
+     * // disallowing the Subscriber to change the preference.
+     * {
+     *   workflow: { enabled: true, readOnly: true },
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Disable notification delivery for all channels by default,
+     * // allowing the Subscriber to change the preference.
+     * {
+     *   workflow: { enabled: false, readOnly: false },
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Disable notification delivery for only the in-app channel by default,
+     * // allowing the Subscriber to change the preference.
+     * {
+     *   channels: {
+     *     inApp: { enabled: false, readOnly: false },
+     *   },
+     * }
+     * ```
+     */
+    preferences?: WorkflowPreferences;
+    /** The tags for the workflow. */
     tags?: string[];
 };
 
@@ -4456,16 +4549,6 @@ type DiscoverStepOutput = {
     providers: Array<DiscoverProviderOutput>;
     options: StepOptions;
 };
-type ChannelPreference = {
-    defaultValue: boolean;
-    readOnly: boolean;
-};
-type DiscoverWorkflowOutputPreferences = {
-    workflow: ChannelPreference;
-    channels: {
-        [key in (typeof ChannelTypeEnum)[keyof typeof ChannelTypeEnum]]: ChannelPreference;
-    };
-};
 type DiscoverWorkflowOutput = {
     workflowId: string;
     execute: Execute<Record<string, unknown>, Record<string, unknown>>;
@@ -4490,7 +4573,7 @@ type DiscoverWorkflowOutput = {
         schema: JsonSchema;
         unknownSchema: Schema;
     };
-    preferences: DiscoverWorkflowOutputPreferences;
+    preferences: WorkflowPreferencesPartial;
     tags: string[];
 };
 type Workflow<T_Payload = any> = {
@@ -4651,4 +4734,4 @@ declare class NovuRequestHandler<Input extends any[] = any[], Output = any> {
     private hashHmac;
 }
 
-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 };
+export { type InAppOutput as $, ActionStepEnum as A, type ActionStep 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 CustomStep as I, type JsonSchema as J, type ChannelStep as K, type EmailOutput as L, type EmailOutputUnvalidated as M, NovuRequestHandler as N, type EmailResult as O, PostActionEnum as P, type SmsOutput as Q, type SmsOutputUnvalidated as R, type Schema as S, type SmsResult as T, type PushOutput as U, type PushOutputUnvalidated as V, type WorkflowOptions as W, type PushResult as X, type ChatOutput as Y, type ChatOutputUnvalidated as Z, type ChatResult as _, type FromSchema as a, type InAppOutputUnvalidated as a0, type InAppResult as a1, type DelayOutput as a2, type DelayOutputUnvalidated as a3, type DelayResult as a4, type DigestRegularOutput as a5, type DigestRegularOutputUnvalidated as a6, type DigestTimedOutput as a7, type DigestTimedOutputUnvalidated as a8, type DigestOutput as a9, type DigestOutputUnvalidated as aa, type DigestResult as ab, type Step as ac, type Subscriber as ad, type Either as ae, type Awaitable as af, type Prettify as ag, type ConditionalPartial as ah, type Indexable as ai, type PickOptional as aj, type PickRequired as ak, type PickRequiredKeys as al, type PickOptionalKeys as am, type DeepPartial as an, type ExecuteInput as ao, type ChannelPreference as ap, type WorkflowPreferences as aq, 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 DiscoverWorkflowOutput as j, type DiscoverOutput as k, type EventTriggerResult as l, type EventTriggerParams as m, type EventTriggerResponse as n, type CancelEventTriggerResponse as o, type Event as p, type State as q, type ExecuteOutputMetadata as r, type ExecuteOutputOptions as s, type ExecuteOutput as t, type SupportedFrameworkName as u, type Skip as v, type StepOptions as w, JobStatusEnum as x, type StepContext as y, type StepOutput 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-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 { S as Schema, F as FromSchemaUnvalidated, a as FromSchema, J as JsonSchema, E as Execute, W as WorkflowOptions, b as Workflow } from './handler-8vDLpUDh.js';
+export { B as ActionStep, A as ActionStepEnum, af as Awaitable, o as CancelEventTriggerResponse, ap as ChannelPreference, K as ChannelStep, d as ChannelStepEnum, Y as ChatOutput, Z as ChatOutputUnvalidated, _ as ChatResult, C as Client, g as ClientOptions, f as CodeResult, ah as ConditionalPartial, I as CustomStep, an as DeepPartial, a2 as DelayOutput, a3 as DelayOutputUnvalidated, a4 as DelayResult, a9 as DigestOutput, aa as DigestOutputUnvalidated, a5 as DigestRegularOutput, a6 as DigestRegularOutputUnvalidated, ab as DigestResult, a7 as DigestTimedOutput, a8 as DigestTimedOutputUnvalidated, k as DiscoverOutput, D as DiscoverProviderOutput, i as DiscoverStepOutput, j as DiscoverWorkflowOutput, ae as Either, L as EmailOutput, M as EmailOutputUnvalidated, O as EmailResult, p as Event, m as EventTriggerParams, n as EventTriggerResponse, l as EventTriggerResult, ao as ExecuteInput, t as ExecuteOutput, r as ExecuteOutputMetadata, s as ExecuteOutputOptions, G as GetActionEnum, H as HealthCheck, $ as InAppOutput, a0 as InAppOutputUnvalidated, a1 as InAppResult, ai as Indexable, x as JobStatusEnum, N as NovuRequestHandler, aj as PickOptional, am as PickOptionalKeys, ak as PickRequired, al as PickRequiredKeys, P as PostActionEnum, ag as Prettify, U as PushOutput, V as PushOutputUnvalidated, X as PushResult, c as ServeHandlerOptions, v as Skip, Q as SmsOutput, R as SmsOutputUnvalidated, T as SmsResult, q as State, ac as Step, y as StepContext, w as StepOptions, z as StepOutput, h as StepType, ad as Subscriber, u as SupportedFrameworkName, e as WorkflowChannelEnum, aq as WorkflowPreferences } from './handler-8vDLpUDh.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import '@novu/shared';