@novu/framework 2.7.1 → 2.8.0

package/dist/cjs/{health-check.types-D6N1lsYH.d.cts → health-check.types-D_KcRiM_.d.cts}

@@ -30,6 +30,103 @@ type ClientOptions = {
     strictAuthentication?: boolean;
 };
 
+type ContextType = string;
+type ContextId = string;
+type ContextData = Record<string, unknown>;
+/**
+ * Context value can be either a simple string identifier or a rich object with additional data
+ *
+ * @example
+ * // Simple string value
+ * "org-acme"
+ *
+ * @example
+ * // Rich object with optional data
+ * {
+ *   id: "org-acme",
+ *   data: { name: "Acme Corp", plan: "enterprise" }
+ * }
+ */
+type ContextValue = string | {
+    id: ContextId;
+    data?: ContextData;
+};
+/**
+ * Context payload represents the raw context data provided by users when triggering workflows.
+ * It's a flexible structure that maps context types to their values.
+ *
+ * This is the input format that gets processed and resolved into ContextResolved.
+ *
+ * @example
+ * // Single context with string value
+ * { tenant: "org-acme" }
+ *
+ * @example
+ * // Multiple contexts with string values
+ * { tenant: "org-acme", app: "jira", user: "john-doe" }
+ *
+ * @example
+ * // Context with rich object containing additional data
+ * {
+ *   tenant: {
+ *     id: "org-acme",
+ *     data: { name: "Acme Corp", plan: "enterprise" }
+ *   }
+ * }
+ *
+ * @example
+ * // Mixed context values (string and object)
+ * {
+ *   tenant: { id: "org-acme", data: { name: "Acme Corp" } },
+ *   app: "jira",
+ *   user: "john-doe"
+ * }
+ */
+type ContextPayload = Partial<Record<ContextType, ContextValue>>;
+/**
+ * Resolved contexts represent the normalized, fully-processed context data used internally
+ * throughout the application and framework. This ensures consistent structure regardless
+ * of the input format in ContextPayload.
+ *
+ * All contexts are normalized to have both an `id` and `data` field, even if the original
+ * payload only provided a string value (in which case `data` will be an empty object).
+ *
+ * This type is used to:
+ * - Pass context data between services without exposing full entity details
+ * - Ensure consistent context structure in workflow execution
+ * - Provide type safety for context access in templates and conditions
+ *
+ * @example
+ * // Resolved from payload: { tenant: "org-acme", app: "jira" }
+ * {
+ *   tenant: {
+ *     id: "org-acme",
+ *     data: {} // Empty data since only ID was provided
+ *   },
+ *   app: {
+ *     id: "jira",
+ *     data: {} // Empty data since only ID was provided
+ *   }
+ * }
+ *
+ * @example
+ * // Resolved from payload with rich data
+ * {
+ *   tenant: {
+ *     id: "org-acme",
+ *     data: { name: "Acme Corp", plan: "enterprise", region: "us-east" }
+ *   },
+ *   app: {
+ *     id: "jira",
+ *     data: { version: "8.0", environment: "production" }
+ *   }
+ * }
+ */
+type ContextResolved = Record<ContextType, {
+    id: ContextId;
+    data: ContextData;
+}>;
+
 declare enum PostActionEnum {
     TRIGGER = "trigger",
     EXECUTE = "execute",
@@ -140,6 +237,7 @@ declare enum ChannelStepEnum {
 declare enum ActionStepEnum {
     DIGEST = "digest",
     DELAY = "delay",
+    THROTTLE = "throttle",
     CUSTOM = "custom"
 }
 
@@ -198,6 +296,7 @@ interface IChannelCredentials {
 interface ITopic {
     type: 'Topic';
     topicKey: string;
+    exclude?: string[];
 }
 type TriggerRecipientsPayload = string | ISubscriberPayload | ITopic | ISubscriberPayload[] | ITopic[];
 declare enum TriggerEventStatusEnum {
@@ -229,7 +328,8 @@ declare enum PushProviderIdEnum {
     OneSignal = "one-signal",
     Pushpad = "pushpad",
     PushWebhook = "push-webhook",
-    PusherBeams = "pusher-beams"
+    PusherBeams = "pusher-beams",
+    AppIO = "appio"
 }
 /**
  * A preference for a notification delivery workflow.
@@ -393,6 +493,10 @@ type EventTriggerParams<T_Payload = EventPayload> = {
      * Actor to trigger the workflow from
      */
     actor?: Actor;
+    /**
+     * Context to trigger the workflow with
+     */
+    context?: ContextPayload;
     /**
      * Bridge url to trigger the workflow to
      */
@@ -961,6 +1065,22 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly sinch: {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
+        readonly 'isendpro-sms': {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
     };
     readonly email: {
         readonly braze: {
@@ -3959,6 +4079,14 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly appio: {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
     };
     readonly in_app: {
         readonly novu: {
@@ -4124,25 +4252,56 @@ type Providers<T_StepType extends keyof typeof providerSchemas, T_Controls, T_Ou
 declare const actionStepSchemas: {
     delay: {
         output: {
-            readonly type: "object";
-            readonly properties: {
-                readonly type: {
-                    readonly enum: readonly ["regular"];
-                    readonly default: "regular";
-                };
-                readonly amount: {
-                    readonly type: "number";
+            readonly oneOf: [{
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["regular"];
+                    };
+                    readonly amount: {
+                        readonly type: "number";
+                    };
+                    readonly unit: {
+                        readonly type: "string";
+                        readonly enum: readonly ["seconds", "minutes", "hours", "days", "weeks", "months"];
+                    };
+                    readonly extendToSchedule: {
+                        readonly type: "boolean";
+                    };
                 };
-                readonly unit: {
-                    readonly type: "string";
-                    readonly enum: readonly ["seconds", "minutes", "hours", "days", "weeks", "months"];
+                readonly required: readonly ["amount", "unit"];
+                readonly additionalProperties: false;
+            }, {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["timed"];
+                    };
+                    readonly cron: {
+                        readonly type: "string";
+                    };
+                    readonly extendToSchedule: {
+                        readonly type: "boolean";
+                    };
                 };
-                readonly extendToSchedule: {
-                    readonly type: "boolean";
+                readonly required: readonly ["cron"];
+                readonly additionalProperties: false;
+            }, {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["dynamic"];
+                    };
+                    readonly dynamicKey: {
+                        readonly type: "string";
+                    };
+                    readonly extendToSchedule: {
+                        readonly type: "boolean";
+                    };
                 };
-            };
-            readonly required: readonly ["amount", "unit"];
-            readonly additionalProperties: false;
+                readonly required: readonly ["dynamicKey"];
+                readonly additionalProperties: false;
+            }];
         };
         result: {
             readonly type: "object";
@@ -4160,6 +4319,9 @@ declare const actionStepSchemas: {
             readonly oneOf: [{
                 readonly type: "object";
                 readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["regular"];
+                    };
                     readonly amount: {
                         readonly type: "number";
                     };
@@ -4193,6 +4355,9 @@ declare const actionStepSchemas: {
             }, {
                 readonly type: "object";
                 readonly properties: {
+                    readonly type: {
+                        readonly enum: readonly ["timed"];
+                    };
                     readonly cron: {
                         readonly type: "string";
                     };
@@ -4237,11 +4402,120 @@ declare const actionStepSchemas: {
             readonly additionalProperties: false;
         };
     };
+    throttle: {
+        output: {
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["fixed", "dynamic"];
+                };
+                readonly amount: {
+                    readonly type: "number";
+                };
+                readonly unit: {
+                    readonly type: "string";
+                    readonly enum: readonly ["minutes", "hours", "days"];
+                };
+                readonly dynamicKey: {
+                    readonly type: "string";
+                };
+                readonly threshold: {
+                    readonly type: "number";
+                };
+                readonly throttleKey: {
+                    readonly type: "string";
+                };
+            };
+            readonly required: readonly ["type"];
+            readonly additionalProperties: false;
+        };
+        result: {
+            readonly type: "object";
+            readonly properties: {
+                readonly throttled: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the workflow execution was throttled";
+                };
+                readonly executionCount: {
+                    readonly type: "number";
+                    readonly description: "Number of executions within the throttle window";
+                };
+                readonly threshold: {
+                    readonly type: "number";
+                    readonly description: "The throttle threshold that was applied";
+                };
+                readonly windowStart: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Start time of the throttle window";
+                };
+            };
+            readonly required: readonly ["throttled"];
+            readonly additionalProperties: false;
+        };
+    };
+};
+
+declare const delayRegularOutputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly enum: readonly ["regular"];
+        };
+        readonly amount: {
+            readonly type: "number";
+        };
+        readonly unit: {
+            readonly type: "string";
+            readonly enum: readonly ["seconds", "minutes", "hours", "days", "weeks", "months"];
+        };
+        readonly extendToSchedule: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["amount", "unit"];
+    readonly additionalProperties: false;
+};
+declare const delayTimedOutputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly enum: readonly ["timed"];
+        };
+        readonly cron: {
+            readonly type: "string";
+        };
+        readonly extendToSchedule: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["cron"];
+    readonly additionalProperties: false;
+};
+declare const delayDynamicOutputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly enum: readonly ["dynamic"];
+        };
+        readonly dynamicKey: {
+            readonly type: "string";
+        };
+        readonly extendToSchedule: {
+            readonly type: "boolean";
+        };
+    };
+    readonly required: readonly ["dynamicKey"];
+    readonly additionalProperties: false;
 };
 
 declare const digestRegularOutputSchema: {
     readonly type: "object";
     readonly properties: {
+        readonly type: {
+            readonly enum: readonly ["regular"];
+        };
         readonly amount: {
             readonly type: "number";
         };
@@ -4276,6 +4550,9 @@ declare const digestRegularOutputSchema: {
 declare const digestTimedOutputSchema: {
     readonly type: "object";
     readonly properties: {
+        readonly type: {
+            readonly enum: readonly ["timed"];
+        };
         readonly cron: {
             readonly type: "string";
         };
@@ -4722,6 +4999,12 @@ type ChatResult = FromSchema<(typeof channelStepSchemas)['chat']['result']>;
 type InAppOutput = FromSchema<(typeof channelStepSchemas)['in_app']['output']>;
 type InAppOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)['in_app']['output']>;
 type InAppResult = FromSchema<(typeof channelStepSchemas)['in_app']['result']>;
+type DelayRegularOutput = FromSchema<typeof delayRegularOutputSchema>;
+type DelayRegularOutputUnvalidated = FromSchemaUnvalidated<typeof delayRegularOutputSchema>;
+type DelayTimedOutput = FromSchema<typeof delayTimedOutputSchema>;
+type DelayTimedOutputUnvalidated = FromSchemaUnvalidated<typeof delayTimedOutputSchema>;
+type DelayDynamicOutput = FromSchema<typeof delayDynamicOutputSchema>;
+type DelayDynamicOutputUnvalidated = FromSchemaUnvalidated<typeof delayDynamicOutputSchema>;
 type DelayOutput = FromSchema<(typeof actionStepSchemas)['delay']['output']>;
 type DelayOutputUnvalidated = FromSchemaUnvalidated<(typeof actionStepSchemas)['delay']['output']>;
 type DelayResult = FromSchema<(typeof actionStepSchemas)['delay']['result']>;
@@ -4732,6 +5015,9 @@ type DigestTimedOutputUnvalidated = FromSchemaUnvalidated<typeof digestTimedOutp
 type DigestOutput = FromSchema<(typeof actionStepSchemas)['digest']['output']>;
 type DigestOutputUnvalidated = FromSchemaUnvalidated<(typeof actionStepSchemas)['digest']['output']>;
 type DigestResult = FromSchema<(typeof actionStepSchemas)['digest']['result']>;
+type ThrottleOutput = FromSchema<(typeof actionStepSchemas)['throttle']['output']>;
+type ThrottleOutputUnvalidated = FromSchemaUnvalidated<(typeof actionStepSchemas)['throttle']['output']>;
+type ThrottleResult = FromSchema<(typeof actionStepSchemas)['throttle']['result']>;
 /**
  * The step type.
  */
@@ -4750,6 +5036,8 @@ type Step = {
     digest: ActionStep<DigestOutputUnvalidated, DigestResult>;
     /** Delay the workflow for a period of time. */
     delay: ActionStep<DelayOutputUnvalidated, DelayResult>;
+    /** Throttle workflow executions within a time window. */
+    throttle: ActionStep<ThrottleOutputUnvalidated, ThrottleResult>;
     /** Execute custom code */
     custom: CustomStep;
 };
@@ -4762,6 +5050,7 @@ type Subscriber = {
     phone?: string | null;
     avatar?: string | null;
     locale?: string | null;
+    data?: Record<string, unknown> | null;
 };
 
 /**
@@ -4787,6 +5076,8 @@ type ExecuteInput<T_Payload extends Record<string, unknown>, T_Controls extends
     environment: Record<string, unknown>;
     /** The controls for the event. Provided via the Dashboard. */
     controls: T_Controls;
+    /** The resolved context for the event. */
+    context: ContextResolved;
 };
 /**
  * The function to execute the workflow.
@@ -5028,6 +5319,7 @@ type Event = {
     state: State[];
     action: Exclude<PostActionEnum, PostActionEnum.TRIGGER>;
     subscriber: Subscriber;
+    context: ContextResolved;
 };
 type State = {
     stepId: string;
@@ -5065,4 +5357,4 @@ type HealthCheck = {
     };
 };
 
-export { type ChatOutputUnvalidated as $, ActionStepEnum as A, type StepContext as B, CronExpression as C, type DiscoverProviderOutput as D, type Either 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, type EmailOutput as N, type EmailOutputUnvalidated as O, PostActionEnum as P, type EmailResult as Q, type SmsOutput as R, SeverityLevelEnum as S, type SmsOutputUnvalidated as T, type SmsResult as U, type PushOutput as V, type Workflow as W, type PushOutputUnvalidated as X, type PushResult as Y, type ZodSchema as Z, type ChatOutput as _, type Schema 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 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 DeepPartial as ao, type DeepRequired as ap, type ExecuteInput as aq, type Execute as ar, type WorkflowPreference as as, type ChannelPreference as at, type WorkflowPreferences as au, type WorkflowOptions as av, type FromSchema as b, actionStepSchemas as c, channelStepSchemas as d, ChannelStepEnum as e, WorkflowChannelEnum as f, type CodeResult as g, type ClientOptions as h, type StepType as i, type DiscoverStepOutput as j, type DiscoverWorkflowOutput as k, type DiscoverOutput as l, type EventTriggerResult as m, type EventTriggerParams as n, type EventTriggerResponse as o, providerSchemas 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 ZodSchemaMinimal as w, type Skip as x, type StepOptions as y, JobStatusEnum as z };
+export { type PushOutputUnvalidated as $, ActionStepEnum as A, type Skip as B, CronExpression as C, type DiscoverProviderOutput as D, type Either as E, type FromSchemaUnvalidated as F, GetActionEnum as G, type HealthCheck as H, type StepOptions as I, type JsonSchema as J, JobStatusEnum as K, type StepContext as L, type StepOutput as M, type ActionStep as N, type CustomStep as O, PostActionEnum as P, type ChannelStep as Q, type EmailOutput as R, SeverityLevelEnum as S, type EmailOutputUnvalidated as T, type EmailResult as U, type SmsOutput as V, type Workflow as W, type SmsOutputUnvalidated as X, type SmsResult as Y, type ZodSchema as Z, type PushOutput as _, type Schema as a, type PushResult as a0, type ChatOutput as a1, type ChatOutputUnvalidated as a2, type ChatResult as a3, type InAppOutput as a4, type InAppOutputUnvalidated as a5, type InAppResult as a6, type DelayRegularOutput as a7, type DelayRegularOutputUnvalidated as a8, type DelayTimedOutput as a9, type DeepPartial as aA, type DeepRequired as aB, type ExecuteInput as aC, type Execute as aD, type WorkflowPreference as aE, type ChannelPreference as aF, type WorkflowPreferences as aG, type WorkflowOptions as aH, type DelayTimedOutputUnvalidated as aa, type DelayDynamicOutput as ab, type DelayDynamicOutputUnvalidated as ac, type DelayOutput as ad, type DelayOutputUnvalidated as ae, type DelayResult as af, type DigestRegularOutput as ag, type DigestRegularOutputUnvalidated as ah, type DigestTimedOutput as ai, type DigestTimedOutputUnvalidated as aj, type DigestOutput as ak, type DigestOutputUnvalidated as al, type DigestResult as am, type ThrottleOutput as an, type ThrottleOutputUnvalidated as ao, type ThrottleResult as ap, type Step as aq, type Subscriber as ar, type Awaitable as as, type Prettify as at, type ConditionalPartial as au, type Indexable as av, type PickOptional as aw, type PickRequired as ax, type PickRequiredKeys as ay, type PickOptionalKeys as az, type FromSchema as b, actionStepSchemas as c, channelStepSchemas as d, ChannelStepEnum as e, WorkflowChannelEnum as f, type CodeResult as g, type ClientOptions as h, type ContextValue as i, type ContextPayload as j, type ContextResolved as k, type StepType as l, type DiscoverStepOutput as m, type DiscoverWorkflowOutput as n, type DiscoverOutput as o, providerSchemas as p, type EventTriggerResult as q, type EventTriggerParams as r, type EventTriggerResponse as s, type CancelEventTriggerResponse as t, type Event as u, type State as v, type ExecuteOutputMetadata as w, type ExecuteOutputOptions as x, type ExecuteOutput as y, type ZodSchemaMinimal as z };

package/dist/cjs/{index-UaShSD2O.d.cts → index-DMh2JJ5c.d.cts}

@@ -1,4 +1,4 @@
-import { h as ClientOptions, W as Workflow, H as HealthCheck, l as DiscoverOutput, r as Event, v as ExecuteOutput, g as CodeResult, n as EventTriggerParams, ag as Awaitable, a as Schema, b as FromSchema, F as FromSchemaUnvalidated, ar as Execute, av as WorkflowOptions } from './health-check.types-D6N1lsYH.cjs';
+import { h as ClientOptions, W as Workflow, H as HealthCheck, o as DiscoverOutput, u as Event, y as ExecuteOutput, g as CodeResult, r as EventTriggerParams, as as Awaitable, a as Schema, b as FromSchema, F as FromSchemaUnvalidated, aD as Execute, aH as WorkflowOptions } from './health-check.types-D_KcRiM_.cjs';
 
 declare class Client {
     private discoveredWorkflows;