@novu/framework 0.24.3-alpha.13 → 0.24.3-alpha.14

package/dist/index.d.ts

@@ -1,10 +1,99 @@
-import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, D as DiscoverWorkflowOutput } from './handler-PIXNhv7t.js';
-export { A as ActionStep, Y as ActionStepEnum, R as Awaitable, p as ChannelStep, X as ChannelStepEnum, v as ChatOutput, w as ChatResult, C as Client, c as ClientOptions, b as CodeResult, o as CustomStep, y as DelayOutput, z as DelayResult, K as DigestOutput, L as DigestResult, g as DiscoverOutput, e as DiscoverProviderOutput, f as DiscoverStepOutput, Q as Either, q as EmailOutput, r as EmailResult, h as Event, U as ExecuteInput, k as ExecuteOutput, j as ExecuteOutputMetadata, H as HealthCheck, I as InAppOutput, x as InAppResult, n as JobStatusEnum, N as NovuRequestHandler, P as PushOutput, u as PushResult, a as ServeHandlerOptions, V as Skip, s as SmsOutput, t as SmsResult, i as State, M as Step, m as StepOptions, d as StepType, O as Subscriber, l as SupportedFrameworkName, T as TriggerEvent, B as digestRegularOutput, G as digestTimedOutput } from './handler-PIXNhv7t.js';
+import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, a as Workflow } from './handler-mDmSI-cG.js';
+export { A as ActionStep, a1 as ActionStepEnum, Z as Awaitable, l as CancelEventTriggerResponse, v as ChannelStep, a0 as ChannelStepEnum, G as ChatOutput, I as ChatResult, C as Client, d as ClientOptions, c as CodeResult, u as CustomStep, M as DelayOutput, O as DelayResult, T as DigestOutput, U as DigestResult, h as DiscoverOutput, D as DiscoverProviderOutput, f as DiscoverStepOutput, g as DiscoverWorkflowOutput, Y as Either, w as EmailOutput, x as EmailResult, m as Event, j as EventTriggerParams, k as EventTriggerResponse, i as EventTriggerResult, $ as ExecuteInput, p as ExecuteOutput, o as ExecuteOutputMetadata, H as HealthCheck, K as InAppOutput, L as InAppResult, t as JobStatusEnum, N as NovuRequestHandler, _ as Prettify, P as PushOutput, B as PushResult, b as ServeHandlerOptions, r as Skip, y as SmsOutput, z as SmsResult, n as State, V as Step, s as StepOptions, e as StepType, X as Subscriber, q as SupportedFrameworkName, Q as digestRegularOutput, R as digestTimedOutput } from './handler-mDmSI-cG.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import 'json-schema-to-ts';
 import '@novu/shared';
 
+/**
+ * Cron expression helper.
+ */
+declare enum CronExpression {
+    EVERY_SECOND = "* * * * * *",
+    EVERY_5_SECONDS = "*/5 * * * * *",
+    EVERY_10_SECONDS = "*/10 * * * * *",
+    EVERY_30_SECONDS = "*/30 * * * * *",
+    EVERY_MINUTE = "*/1 * * * *",
+    EVERY_5_MINUTES = "0 */5 * * * *",
+    EVERY_10_MINUTES = "0 */10 * * * *",
+    EVERY_30_MINUTES = "0 */30 * * * *",
+    EVERY_HOUR = "0 0-23/1 * * *",
+    EVERY_2_HOURS = "0 0-23/2 * * *",
+    EVERY_3_HOURS = "0 0-23/3 * * *",
+    EVERY_4_HOURS = "0 0-23/4 * * *",
+    EVERY_5_HOURS = "0 0-23/5 * * *",
+    EVERY_6_HOURS = "0 0-23/6 * * *",
+    EVERY_7_HOURS = "0 0-23/7 * * *",
+    EVERY_8_HOURS = "0 0-23/8 * * *",
+    EVERY_9_HOURS = "0 0-23/9 * * *",
+    EVERY_10_HOURS = "0 0-23/10 * * *",
+    EVERY_11_HOURS = "0 0-23/11 * * *",
+    EVERY_12_HOURS = "0 0-23/12 * * *",
+    EVERY_DAY_AT_1AM = "0 01 * * *",
+    EVERY_DAY_AT_2AM = "0 02 * * *",
+    EVERY_DAY_AT_3AM = "0 03 * * *",
+    EVERY_DAY_AT_4AM = "0 04 * * *",
+    EVERY_DAY_AT_5AM = "0 05 * * *",
+    EVERY_DAY_AT_6AM = "0 06 * * *",
+    EVERY_DAY_AT_7AM = "0 07 * * *",
+    EVERY_DAY_AT_8AM = "0 08 * * *",
+    EVERY_DAY_AT_9AM = "0 09 * * *",
+    EVERY_DAY_AT_10AM = "0 10 * * *",
+    EVERY_DAY_AT_11AM = "0 11 * * *",
+    EVERY_DAY_AT_NOON = "0 12 * * *",
+    EVERY_DAY_AT_1PM = "0 13 * * *",
+    EVERY_DAY_AT_2PM = "0 14 * * *",
+    EVERY_DAY_AT_3PM = "0 15 * * *",
+    EVERY_DAY_AT_4PM = "0 16 * * *",
+    EVERY_DAY_AT_5PM = "0 17 * * *",
+    EVERY_DAY_AT_6PM = "0 18 * * *",
+    EVERY_DAY_AT_7PM = "0 19 * * *",
+    EVERY_DAY_AT_8PM = "0 20 * * *",
+    EVERY_DAY_AT_9PM = "0 21 * * *",
+    EVERY_DAY_AT_10PM = "0 22 * * *",
+    EVERY_DAY_AT_11PM = "0 23 * * *",
+    EVERY_DAY_AT_MIDNIGHT = "0 0 * * *",
+    EVERY_WEEK = "0 0 * * 0",
+    EVERY_WEEKDAY = "0 0 * * 1-5",
+    EVERY_WEEKEND = "0 0 * * 6,0",
+    EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = "0 0 1 * *",
+    EVERY_1ST_DAY_OF_MONTH_AT_NOON = "0 12 1 * *",
+    EVERY_2ND_HOUR = "0 */2 * * *",
+    EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = "0 1-23/2 * * *",
+    EVERY_2ND_MONTH = "0 0 1 */2 *",
+    EVERY_QUARTER = "0 0 1 */3 *",
+    EVERY_6_MONTHS = "0 0 1 */6 *",
+    EVERY_YEAR = "0 0 1 0 *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = "0 */30 9-17 * * *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = "0 */30 9-18 * * *",
+    EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = "0 */30 10-19 * * *",
+    MONDAY_TO_FRIDAY_AT_1AM = "0 0 01 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2AM = "0 0 02 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3AM = "0 0 03 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4AM = "0 0 04 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5AM = "0 0 05 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6AM = "0 0 06 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7AM = "0 0 07 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8AM = "0 0 08 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9AM = "0 0 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_09_30AM = "0 30 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10AM = "0 0 10 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11AM = "0 0 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11_30AM = "0 30 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_12PM = "0 0 12 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_1PM = "0 0 13 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2PM = "0 0 14 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3PM = "0 0 15 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4PM = "0 0 16 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5PM = "0 0 17 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6PM = "0 0 18 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7PM = "0 0 19 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8PM = "0 0 20 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9PM = "0 0 21 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10PM = "0 0 22 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
+}
+
 declare enum PostActionEnum {
     TRIGGER = "trigger",
     EXECUTE = "execute",
@@ -48,7 +137,8 @@ declare enum ErrorCodeEnum {
     SIGNATURE_EXPIRED_ERROR = "SignatureExpiredError",
     SIGNING_KEY_NOT_FOUND_ERROR = "SigningKeyNotFoundError",
     PLATFORM_ERROR = "PlatformError",
-    SIGNATURE_VERSION_INVALID_ERROR = "SignatureVersionInvalidError"
+    SIGNATURE_VERSION_INVALID_ERROR = "SignatureVersionInvalidError",
+    WORKFLOW_PAYLOAD_INVALID_ERROR = "WorkflowPayloadInvalidError"
 }
 
 declare enum HttpHeaderKeysEnum {
@@ -138,95 +228,6 @@ declare enum ResourceEnum {
     STEP = "step"
 }
 
-/**
- * Cron expression helper.
- */
-declare enum CronExpression {
-    EVERY_SECOND = "* * * * * *",
-    EVERY_5_SECONDS = "*/5 * * * * *",
-    EVERY_10_SECONDS = "*/10 * * * * *",
-    EVERY_30_SECONDS = "*/30 * * * * *",
-    EVERY_MINUTE = "*/1 * * * *",
-    EVERY_5_MINUTES = "0 */5 * * * *",
-    EVERY_10_MINUTES = "0 */10 * * * *",
-    EVERY_30_MINUTES = "0 */30 * * * *",
-    EVERY_HOUR = "0 0-23/1 * * *",
-    EVERY_2_HOURS = "0 0-23/2 * * *",
-    EVERY_3_HOURS = "0 0-23/3 * * *",
-    EVERY_4_HOURS = "0 0-23/4 * * *",
-    EVERY_5_HOURS = "0 0-23/5 * * *",
-    EVERY_6_HOURS = "0 0-23/6 * * *",
-    EVERY_7_HOURS = "0 0-23/7 * * *",
-    EVERY_8_HOURS = "0 0-23/8 * * *",
-    EVERY_9_HOURS = "0 0-23/9 * * *",
-    EVERY_10_HOURS = "0 0-23/10 * * *",
-    EVERY_11_HOURS = "0 0-23/11 * * *",
-    EVERY_12_HOURS = "0 0-23/12 * * *",
-    EVERY_DAY_AT_1AM = "0 01 * * *",
-    EVERY_DAY_AT_2AM = "0 02 * * *",
-    EVERY_DAY_AT_3AM = "0 03 * * *",
-    EVERY_DAY_AT_4AM = "0 04 * * *",
-    EVERY_DAY_AT_5AM = "0 05 * * *",
-    EVERY_DAY_AT_6AM = "0 06 * * *",
-    EVERY_DAY_AT_7AM = "0 07 * * *",
-    EVERY_DAY_AT_8AM = "0 08 * * *",
-    EVERY_DAY_AT_9AM = "0 09 * * *",
-    EVERY_DAY_AT_10AM = "0 10 * * *",
-    EVERY_DAY_AT_11AM = "0 11 * * *",
-    EVERY_DAY_AT_NOON = "0 12 * * *",
-    EVERY_DAY_AT_1PM = "0 13 * * *",
-    EVERY_DAY_AT_2PM = "0 14 * * *",
-    EVERY_DAY_AT_3PM = "0 15 * * *",
-    EVERY_DAY_AT_4PM = "0 16 * * *",
-    EVERY_DAY_AT_5PM = "0 17 * * *",
-    EVERY_DAY_AT_6PM = "0 18 * * *",
-    EVERY_DAY_AT_7PM = "0 19 * * *",
-    EVERY_DAY_AT_8PM = "0 20 * * *",
-    EVERY_DAY_AT_9PM = "0 21 * * *",
-    EVERY_DAY_AT_10PM = "0 22 * * *",
-    EVERY_DAY_AT_11PM = "0 23 * * *",
-    EVERY_DAY_AT_MIDNIGHT = "0 0 * * *",
-    EVERY_WEEK = "0 0 * * 0",
-    EVERY_WEEKDAY = "0 0 * * 1-5",
-    EVERY_WEEKEND = "0 0 * * 6,0",
-    EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = "0 0 1 * *",
-    EVERY_1ST_DAY_OF_MONTH_AT_NOON = "0 12 1 * *",
-    EVERY_2ND_HOUR = "0 */2 * * *",
-    EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = "0 1-23/2 * * *",
-    EVERY_2ND_MONTH = "0 0 1 */2 *",
-    EVERY_QUARTER = "0 0 1 */3 *",
-    EVERY_6_MONTHS = "0 0 1 */6 *",
-    EVERY_YEAR = "0 0 1 0 *",
-    EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = "0 */30 9-17 * * *",
-    EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = "0 */30 9-18 * * *",
-    EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = "0 */30 10-19 * * *",
-    MONDAY_TO_FRIDAY_AT_1AM = "0 0 01 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_2AM = "0 0 02 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_3AM = "0 0 03 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_4AM = "0 0 04 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_5AM = "0 0 05 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_6AM = "0 0 06 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_7AM = "0 0 07 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_8AM = "0 0 08 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_9AM = "0 0 09 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_09_30AM = "0 30 09 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_10AM = "0 0 10 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11AM = "0 0 11 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11_30AM = "0 30 11 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_12PM = "0 0 12 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_1PM = "0 0 13 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_2PM = "0 0 14 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_3PM = "0 0 15 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_4PM = "0 0 16 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_5PM = "0 0 17 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_6PM = "0 0 18 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_7PM = "0 0 19 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_8PM = "0 0 20 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_9PM = "0 0 21 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_10PM = "0 0 22 * * 1-5",
-    MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
-}
-
 type ValidateFunction<T = unknown> = ValidateFunction$1<T> | ((data: T) => ParseReturnType<T>);
 type ValidationError = {
     path: string;
@@ -248,6 +249,6 @@ interface Validator<T_Schema extends Schema> {
 /**
  * Define a new notification workflow.
  */
-declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_Payload = FromSchema<T_PayloadSchema>, T_Control = FromSchema<T_ControlSchema>>(workflowId: string, execute: Execute<T_Payload, T_Control>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema>): DiscoverWorkflowOutput;
+declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_Payload = FromSchema<T_PayloadSchema>, T_Control = FromSchema<T_ControlSchema>>(workflowId: string, execute: Execute<T_Payload, T_Control>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema>): Workflow<T_Payload>;
 
-export { CronExpression, DiscoverWorkflowOutput, ErrorCodeEnum, Execute, FromSchema, GetActionEnum, HttpHeaderKeysEnum, HttpMethodEnum, HttpQueryKeysEnum, HttpStatusEnum, JsonSchema, NovuApiEndpointsEnum, PostActionEnum, RETRYABLE_ERROR_STATUS_CODES, ResourceEnum, SIGNATURE_TIMESTAMP_TOLERANCE, SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES, Schema, type ValidateFunction, type ValidateResult, type ValidationError, type Validator, WorkflowOptions, workflow };
+export { CronExpression, ErrorCodeEnum, Execute, FromSchema, GetActionEnum, HttpHeaderKeysEnum, HttpMethodEnum, HttpQueryKeysEnum, HttpStatusEnum, JsonSchema, NovuApiEndpointsEnum, PostActionEnum, RETRYABLE_ERROR_STATUS_CODES, ResourceEnum, SIGNATURE_TIMESTAMP_TOLERANCE, SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES, Schema, type ValidateFunction, type ValidateResult, type ValidationError, type Validator, Workflow, WorkflowOptions, workflow };