@novu/framework 2.0.0-canary.6 → 2.0.0

package/dist/{handler-908yagvL.d.ts → handler-oPkwX3nf.d.ts}

@@ -1,6 +1,6 @@
 import { JSONSchema, FromSchema as FromSchema$1 } from 'json-schema-to-ts';
 import zod from 'zod';
-import { TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, ITenantDefine, TriggerRecipientsPayload } from '@novu/shared';
+import { ChannelTypeEnum, TriggerEventStatusEnum, ITriggerPayload, TriggerRecipientSubscriber, TriggerRecipientsPayload } from '@novu/shared';
 
 type CodeResult = {
     code: string;
@@ -56,7 +56,41 @@ declare enum ActionStepEnum {
 }
 
 type JsonSchema = JSONSchema;
+/**
+ * A schema used to validate a JSON object.
+ *
+ * Supported schemas:
+ * - JSONSchema
+ * - ZodSchema
+ */
 type Schema = JsonSchema | zod.ZodSchema;
+/**
+ * Infer the type of a Schema for unvalidated data.
+ *
+ * The resulting type has default properties set to optional,
+ * reflecting the fact that the data is unvalidated and has
+ * not had default properties set.
+ *
+ * @example
+ * ```ts
+ * type MySchema = FromSchemaUnvalidated<typeof mySchema>;
+ * ```
+ */
+type FromSchemaUnvalidated<T extends Schema> = T extends JSONSchema ? FromSchema$1<T, {
+    keepDefaultedPropertiesOptional: true;
+}> : T extends zod.ZodSchema ? zod.input<T> : never;
+/**
+ * Infer the type of a Schema for validated data.
+ *
+ * The resulting type has default properties set to required,
+ * reflecting the fact that the data has been validated and
+ * default properties have been set.
+ *
+ * @example
+ * ```ts
+ * type MySchema = FromSchema<typeof mySchema>;
+ * ```
+ */
 type FromSchema<T extends Schema> = T extends JSONSchema ? FromSchema$1<T> : T extends zod.ZodSchema ? zod.infer<T> : never;
 
 declare const providerSchemas: {
@@ -3683,8 +3717,21 @@ declare const channelStepSchemas: {
                         readonly label: {
                             readonly type: "string";
                         };
-                        readonly url: {
-                            readonly type: "string";
+                        readonly redirect: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly target: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["_self", "_blank", "_parent", "_top", "_unfencedTop"];
+                                    readonly default: "_blank";
+                                };
+                            };
+                            readonly required: readonly ["url"];
+                            readonly additionalProperties: false;
                         };
                     };
                     readonly required: readonly ["label"];
@@ -3696,11 +3743,44 @@ declare const channelStepSchemas: {
                         readonly label: {
                             readonly type: "string";
                         };
+                        readonly redirect: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly url: {
+                                    readonly type: "string";
+                                    readonly format: "uri";
+                                };
+                                readonly target: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["_self", "_blank", "_parent", "_top", "_unfencedTop"];
+                                    readonly default: "_blank";
+                                };
+                            };
+                            readonly required: readonly ["url"];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly required: readonly ["label"];
+                    readonly additionalProperties: false;
+                };
+                readonly data: {
+                    readonly type: "object";
+                    readonly additionalProperties: true;
+                };
+                readonly redirect: {
+                    readonly type: "object";
+                    readonly properties: {
                         readonly url: {
                             readonly type: "string";
+                            readonly format: "uri";
+                        };
+                        readonly target: {
+                            readonly type: "string";
+                            readonly enum: readonly ["_self", "_blank", "_parent", "_top", "_unfencedTop"];
+                            readonly default: "_blank";
                         };
                     };
-                    readonly required: readonly ["label"];
+                    readonly required: readonly ["url"];
                     readonly additionalProperties: false;
                 };
             };
@@ -3855,6 +3935,54 @@ type Awaitable<T> = T | Promise<T>;
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
+/**
+ * Mark properties of T as optional if Condition is true
+ */
+type ConditionalPartial<T extends Obj, Condition extends boolean> = Condition extends true ? Partial<T> : T;
+/**
+ * Same as Nullable except without `null`.
+ */
+type Optional<T> = T | undefined;
+/**
+ * Types that can be used to index native JavaScript types, (Object, Array, etc.).
+ */
+type IndexSignature = string | number | symbol;
+/**
+ * An object of any index-able type to avoid conflicts between `{}`, `Record`, `object`, etc.
+ */
+type Obj<O extends Record<IndexSignature, unknown> | object = Record<IndexSignature, unknown> | object> = {
+    [K in keyof O as K extends never ? never : K]: K extends never ? never : O[K] extends never ? never : O[K];
+} & Omit<O, never>;
+/**
+ * Any type that is indexable using `string`, `number`, or `symbol`.
+ */
+type Indexable<ValueTypes = unknown> = {
+    [K: IndexSignature]: ValueTypes;
+} | Obj;
+/**
+ * Picks only the optional properties from a type, removing the required ones.
+ * Optionally, recurses through nested objects if `DEEP` is true.
+ */
+type PickOptional<T, DEEP extends boolean = true> = {
+    [K in keyof T as undefined extends T[K] ? K : never]: DEEP extends false ? T[K] : T[K] extends Optional<Indexable> ? PickOptional<T[K], DEEP> : T[K];
+};
+/**
+ * Picks only the required fields out of a type, removing the optional ones.
+ * Optionally, recurses through nested objects if `DEEP` is true.
+ */
+type PickRequired<T, DEEP extends boolean = true> = {
+    [K in keyof T as K extends keyof PickOptional<T, DEEP> ? never : K]: T[K] extends Indexable ? PickRequired<T[K], DEEP> : T[K];
+};
+/**
+ * Picks only the required keys out of a type, removing the optional ones.
+ * Optionally, recurses through nested objects if `DEEP` is true.
+ */
+type PickRequiredKeys<T, DEEP extends boolean = true> = keyof PickRequired<T, DEEP>;
+/**
+ * Picks only the optional keys out of a type, removing the required ones.
+ * Optionally, recurses through nested objects if `DEEP` is true.
+ */
+type PickOptionalKeys<T, DEEP extends boolean = true> = keyof PickOptional<T, DEEP>;
 
 type Passthrough = {
     body?: Record<string, unknown>;
@@ -3880,7 +4008,7 @@ type Providers<T_StepType extends keyof typeof providerSchemas, T_Controls, T_Ou
          * The outputs of the step.
          */
         outputs: T_Output;
-    }) => Awaitable<WithPassthrough<FromSchema<(typeof providerSchemas)[T_StepType][K]['output']>>>;
+    }) => Awaitable<WithPassthrough<FromSchemaUnvalidated<(typeof providerSchemas)[T_StepType][K]['output']>>>;
 };
 
 type Skip<T> = (controls: T) => Awaitable<boolean>;
@@ -3964,17 +4092,21 @@ T_OutputsSchema extends Schema = Schema,
 /**
  * The controls for the step.
  */
-T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>, 
+T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>, T_IntermediaryResult extends Record<string, unknown> = FromSchema<T_OutputsSchema>, T_IntermediaryOutput extends Record<string, unknown> = FromSchemaUnvalidated<T_OutputsSchema>, 
+/**
+ * The output for the step.
+ */
+T_Outputs extends T_IntermediaryOutput = T_IntermediaryOutput, 
 /**
  * The result for the step.
  */
-T_Intermediary extends Record<string, unknown> = FromSchema<T_OutputsSchema>, T_Outputs extends T_Intermediary = T_Intermediary, T_Result extends T_Intermediary = T_Intermediary>(
+T_Result extends T_IntermediaryResult = T_IntermediaryResult>(
 /**
  * The name of the step. This is used to identify the step in the workflow.
  */
 name: string, 
 /**
- * The function to resolve the step notification content for the step.
+ * The function to resolve the custom data for the step.
  *
  * @param controls The controls for the step.
  */
@@ -4029,39 +4161,48 @@ options?: StepOptions<T_ControlSchema, T_Controls> & {
     providers?: Prettify<Providers<T_StepType, T_Controls, T_Outputs>>;
 }) => StepOutput<T_Result>;
 type EmailOutput = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.EMAIL]['output']>;
+type EmailOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)[ChannelStepEnum.EMAIL]['output']>;
 type EmailResult = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.EMAIL]['result']>;
 type SmsOutput = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.SMS]['output']>;
+type SmsOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)[ChannelStepEnum.SMS]['output']>;
 type SmsResult = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.SMS]['result']>;
 type PushOutput = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.PUSH]['output']>;
+type PushOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)[ChannelStepEnum.PUSH]['output']>;
 type PushResult = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.PUSH]['result']>;
 type ChatOutput = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.CHAT]['output']>;
+type ChatOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)[ChannelStepEnum.CHAT]['output']>;
 type ChatResult = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.CHAT]['result']>;
 type InAppOutput = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.IN_APP]['output']>;
+type InAppOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)[ChannelStepEnum.IN_APP]['output']>;
 type InAppResult = FromSchema<(typeof channelStepSchemas)[ChannelStepEnum.IN_APP]['result']>;
 type DelayOutput = FromSchema<(typeof actionStepSchemas)[ActionStepEnum.DELAY]['output']>;
+type DelayOutputUnvalidated = FromSchemaUnvalidated<(typeof actionStepSchemas)[ActionStepEnum.DELAY]['output']>;
 type DelayResult = FromSchema<(typeof actionStepSchemas)[ActionStepEnum.DELAY]['result']>;
-type digestRegularOutput = FromSchema<typeof digestRegularOutputSchema>;
-type digestTimedOutput = FromSchema<typeof digestTimedOutputSchema>;
+type DigestRegularOutput = FromSchema<typeof digestRegularOutputSchema>;
+type DigestRegularOutputUnvalidated = FromSchemaUnvalidated<typeof digestRegularOutputSchema>;
+type DigestTimedOutput = FromSchema<typeof digestTimedOutputSchema>;
+type DigestTimedOutputUnvalidated = FromSchemaUnvalidated<typeof digestTimedOutputSchema>;
 type DigestOutput = FromSchema<(typeof actionStepSchemas)[ActionStepEnum.DIGEST]['output']>;
+type DigestOutputUnvalidated = FromSchemaUnvalidated<(typeof actionStepSchemas)[ActionStepEnum.DIGEST]['output']>;
 type DigestResult = FromSchema<(typeof actionStepSchemas)[ActionStepEnum.DIGEST]['result']>;
 /**
  * The step type.
  */
 type Step = {
     /** Send an email. */
-    email: ChannelStep<ChannelStepEnum.EMAIL, EmailOutput, EmailResult>;
+    email: ChannelStep<ChannelStepEnum.EMAIL, EmailOutputUnvalidated, EmailResult>;
     /** Send an SMS. */
-    sms: ChannelStep<ChannelStepEnum.SMS, SmsOutput, SmsResult>;
+    sms: ChannelStep<ChannelStepEnum.SMS, SmsOutputUnvalidated, SmsResult>;
     /** Send a push notification. */
-    push: ChannelStep<ChannelStepEnum.PUSH, PushOutput, PushResult>;
+    push: ChannelStep<ChannelStepEnum.PUSH, PushOutputUnvalidated, PushResult>;
     /** Send a chat message. */
-    chat: ChannelStep<ChannelStepEnum.CHAT, ChatOutput, ChatResult>;
+    chat: ChannelStep<ChannelStepEnum.CHAT, ChatOutputUnvalidated, ChatResult>;
     /** Send an in-app notification. */
-    inApp: ChannelStep<ChannelStepEnum.IN_APP, InAppOutput, InAppResult>;
+    inApp: ChannelStep<ChannelStepEnum.IN_APP, InAppOutputUnvalidated, InAppResult>;
     /** Aggregate events for a period of time. */
-    digest: ActionStep<DigestOutput, DigestResult>;
+    digest: ActionStep<DigestOutputUnvalidated, DigestResult>;
     /** Delay the workflow for a period of time. */
-    delay: ActionStep<DelayOutput, DelayResult>;
+    delay: ActionStep<DelayOutputUnvalidated, DelayResult>;
     /** Execute custom code */
     custom: CustomStep;
 };
@@ -4101,6 +4242,16 @@ 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?: {
+        [key in (typeof ChannelTypeEnum)[keyof typeof ChannelTypeEnum]]?: WorkflowOptionChannelPreference;
+    };
+};
 /**
  * The options for the workflow.
  */
@@ -4114,12 +4265,12 @@ type WorkflowOptions<T_PayloadSchema extends Schema, T_ControlSchema extends Sch
      */
     inputSchema?: T_ControlSchema;
     controlSchema?: T_ControlSchema;
+    preferences?: WorkflowOptionsPreferences;
     tags?: string[];
 };
 
 type EventPayload = ITriggerPayload & {};
 type Actor = TriggerRecipientSubscriber & {};
-type Tenant = ITenantDefine & Record<string, never>;
 type Recipients = TriggerRecipientsPayload & {};
 type EventTriggerResult = {
     /**
@@ -4148,14 +4299,6 @@ type EventTriggerParams<T_Payload = EventPayload> = {
      * Bridge url to trigger the workflow to
      */
     bridgeUrl?: string;
-    /**
-     * Payload to trigger the workflow with
-     */
-    payload: T_Payload;
-    /**
-     * Tenant to trigger the workflow with
-     */
-    tenant?: Tenant;
     /**
      * Transaction id for trigger
      */
@@ -4172,7 +4315,12 @@ type EventTriggerParams<T_Payload = EventPayload> = {
             [stepId: string]: Record<string, unknown>;
         };
     };
-};
+} & ConditionalPartial<{
+    /**
+     * Payload to trigger the workflow with
+     */
+    payload: T_Payload;
+}, PickRequiredKeys<T_Payload> extends never ? true : false>;
 type EventTriggerResponse = {
     /**
      * If trigger was acknowledged or not
@@ -4235,6 +4383,16 @@ 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>>;
@@ -4259,6 +4417,7 @@ type DiscoverWorkflowOutput = {
         schema: JsonSchema;
         unknownSchema: Schema;
     };
+    preferences: DiscoverWorkflowOutputPreferences;
     tags: string[];
 };
 type Workflow<T_Payload = any> = {
@@ -4419,4 +4578,4 @@ declare class NovuRequestHandler<Input extends any[] = any[], Output = any> {
     private hashHmac;
 }
 
-export { type DigestOutput as $, ActionStepEnum as A, type ChannelStep as B, Client as C, type DiscoverProviderOutput as D, type Execute as E, type FromSchema as F, GetActionEnum as G, type HealthCheck as H, type EmailOutput as I, type JsonSchema as J, type EmailResult as K, type SmsOutput as L, type SmsResult as M, NovuRequestHandler as N, type PushOutput as O, PostActionEnum as P, type PushResult as Q, type ChatOutput as R, type Schema as S, type ChatResult as T, type InAppOutput as U, type InAppResult as V, type WorkflowOptions as W, type DelayOutput as X, type DelayResult as Y, type digestRegularOutput as Z, type digestTimedOutput as _, type Workflow as a, type DigestResult as a0, type Step as a1, type Subscriber as a2, type Either as a3, type Awaitable as a4, type Prettify as a5, type ExecuteInput as a6, type ServeHandlerOptions as b, ChannelStepEnum as c, type CodeResult as d, type ClientOptions as e, type StepType as f, type DiscoverStepOutput as g, type DiscoverWorkflowOutput as h, type DiscoverOutput as i, type EventTriggerResult as j, type EventTriggerParams as k, type EventTriggerResponse as l, type CancelEventTriggerResponse as m, type Event as n, type State as o, type ExecuteOutputMetadata as p, type ExecuteOutputOptions as q, type ExecuteOutput as r, type SupportedFrameworkName as s, type Skip as t, type StepOptions as u, JobStatusEnum as v, type StepContext as w, type StepOutput as x, type ActionStep as y, type CustomStep as z };
+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 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, a as Workflow } from './handler-908yagvL.js';
-export { y as ActionStep, A as ActionStepEnum, a4 as Awaitable, m as CancelEventTriggerResponse, B as ChannelStep, c as ChannelStepEnum, R as ChatOutput, T as ChatResult, C as Client, e as ClientOptions, d as CodeResult, z as CustomStep, X as DelayOutput, Y as DelayResult, $ as DigestOutput, a0 as DigestResult, i as DiscoverOutput, D as DiscoverProviderOutput, g as DiscoverStepOutput, h as DiscoverWorkflowOutput, a3 as Either, I as EmailOutput, K as EmailResult, n as Event, k as EventTriggerParams, l as EventTriggerResponse, j as EventTriggerResult, a6 as ExecuteInput, r as ExecuteOutput, p as ExecuteOutputMetadata, q as ExecuteOutputOptions, G as GetActionEnum, H as HealthCheck, U as InAppOutput, V as InAppResult, v as JobStatusEnum, N as NovuRequestHandler, P as PostActionEnum, a5 as Prettify, O as PushOutput, Q as PushResult, b as ServeHandlerOptions, t as Skip, L as SmsOutput, M as SmsResult, o as State, a1 as Step, w as StepContext, u as StepOptions, x as StepOutput, f as StepType, a2 as Subscriber, s as SupportedFrameworkName, Z as digestRegularOutput, _ as digestTimedOutput } from './handler-908yagvL.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-oPkwX3nf.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-oPkwX3nf.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import 'json-schema-to-ts';
@@ -117,6 +117,7 @@ declare enum ErrorCodeEnum {
     EXECUTION_EVENT_PAYLOAD_INVALID_ERROR = "ExecutionEventPayloadInvalidError",
     EXECUTION_EVENT_CONTROL_INVALID_ERROR = "ExecutionEventControlInvalidError",
     EXECUTION_STATE_CONTROL_INVALID_ERROR = "ExecutionStateControlInvalidError",
+    STEP_CONTROL_COMPILATION_FAILED_ERROR = "StepControlCompilationFailedError",
     METHOD_NOT_ALLOWED_ERROR = "MethodNotAllowedError",
     INVALID_ACTION_ERROR = "InvalidActionError",
     MISSING_SECRET_KEY_ERROR = "MissingSecretKeyError",
@@ -232,15 +233,15 @@ type ValidateResult<T> = {
     success: true;
     data: T;
 };
-interface Validator<T_Schema extends Schema> {
-    validate: <T_Data extends Record<string, unknown>>(data: T_Data, schema: T_Schema) => Promise<ValidateResult<T_Data>>;
-    isSchema: (schema: Schema) => schema is T_Schema;
+interface Validator<T_Schema extends Schema = Schema> {
+    validate: <T_Unvalidated extends Record<string, unknown> = FromSchemaUnvalidated<T_Schema>, T_Validated extends Record<string, unknown> = FromSchema<T_Schema>>(data: T_Unvalidated, schema: T_Schema) => Promise<ValidateResult<T_Validated>>;
+    canHandle: (schema: Schema) => schema is T_Schema;
     transformToJsonSchema: (schema: T_Schema) => JsonSchema;
 }
 
 /**
  * Define a new notification workflow.
  */
-declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_Payload extends Record<string, unknown> = FromSchema<T_PayloadSchema>, T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>>(workflowId: string, execute: Execute<T_Payload, T_Controls>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema>): Workflow<T_Payload>;
+declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_PayloadValidated extends Record<string, unknown> = FromSchema<T_PayloadSchema>, T_PayloadUnvalidated extends Record<string, unknown> = FromSchemaUnvalidated<T_PayloadSchema>, T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>>(workflowId: string, execute: Execute<T_PayloadValidated, T_Controls>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema>): Workflow<T_PayloadUnvalidated>;
 
-export { CronExpression, ErrorCodeEnum, Execute, FRAMEWORK_VERSION, FromSchema, HttpHeaderKeysEnum, HttpMethodEnum, HttpQueryKeysEnum, HttpStatusEnum, JsonSchema, NovuApiEndpointsEnum, RETRYABLE_ERROR_STATUS_CODES, ResourceEnum, SDK_VERSION, SIGNATURE_TIMESTAMP_TOLERANCE, SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES, Schema, type ValidateFunction, type ValidateResult, type ValidationError, type Validator, Workflow, WorkflowOptions, workflow };
+export { CronExpression, ErrorCodeEnum, Execute, FRAMEWORK_VERSION, FromSchema, FromSchemaUnvalidated, HttpHeaderKeysEnum, HttpMethodEnum, HttpQueryKeysEnum, HttpStatusEnum, JsonSchema, NovuApiEndpointsEnum, RETRYABLE_ERROR_STATUS_CODES, ResourceEnum, SDK_VERSION, SIGNATURE_TIMESTAMP_TOLERANCE, SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES, Schema, type ValidateFunction, type ValidateResult, type ValidationError, type Validator, Workflow, WorkflowOptions, workflow };