@novu/framework 2.0.0-canary.3 → 2.0.0-canary.5

package/dist/index.d.ts

@@ -1,10 +1,17 @@
-import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, a as Workflow } from './handler-3oTUJvk2.js';
-export { A as ActionStep, a3 as ActionStepEnum, Z as Awaitable, l as CancelEventTriggerResponse, v as ChannelStep, a2 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, a1 as GetActionEnum, H as HealthCheck, K as InAppOutput, L as InAppResult, t as JobStatusEnum, N as NovuRequestHandler, a0 as PostActionEnum, _ 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-3oTUJvk2.js';
+import { S as Schema, J as JsonSchema, F as FromSchema, E as Execute, W as WorkflowOptions, a as Workflow } from './handler-kv_Ed8ly.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-kv_Ed8ly.js';
 import { ValidateFunction as ValidateFunction$1 } from 'ajv';
 import { ParseReturnType } from 'zod';
 import 'json-schema-to-ts';
 import '@novu/shared';
 
+declare enum NovuApiEndpointsEnum {
+    SYNC = "/v1/bridge/sync",
+    DIFF = "/v1/bridge/diff"
+}
+declare const SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES = 5;
+declare const SIGNATURE_TIMESTAMP_TOLERANCE: number;
+
 /**
  * Cron expression helper.
  */
@@ -94,13 +101,6 @@ declare enum CronExpression {
     MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
 }
 
-declare enum NovuApiEndpointsEnum {
-    SYNC = "/v1/bridge/sync",
-    DIFF = "/v1/bridge/diff"
-}
-declare const SIGNATURE_TIMESTAMP_TOLERANCE_MINUTES = 5;
-declare const SIGNATURE_TIMESTAMP_TOLERANCE: number;
-
 declare enum ErrorCodeEnum {
     WORKFLOW_NOT_FOUND_ERROR = "WorkflowNotFoundError",
     WORKFLOW_ALREADY_EXISTS_ERROR = "WorkflowAlreadyExistsError",
@@ -136,7 +136,7 @@ declare enum HttpHeaderKeysEnum {
     NOVU_SIGNATURE_DEPRECATED = "x-novu-signature",
     NOVU_ANONYMOUS_DEPRECATED = "x-novu-anonymous",
     NOVU_FRAMEWORK_SDK = "novu-framework-sdk",
-    NOVU_FRAMEWORK_API = "novu-framework-api",
+    NOVU_FRAMEWORK_SERVER = "novu-framework-server",
     NOVU_FRAMEWORK_VERSION = "novu-framework-version",
     USER_AGENT = "user-agent",
     CONTENT_TYPE = "content-type",
@@ -217,6 +217,9 @@ declare enum ResourceEnum {
     STEP = "step"
 }
 
+declare const SDK_VERSION: string;
+declare const FRAMEWORK_VERSION = "2024-06-26";
+
 type ValidateFunction<T = unknown> = ValidateFunction$1<T> | ((data: T) => ParseReturnType<T>);
 type ValidationError = {
     path: string;
@@ -230,7 +233,7 @@ type ValidateResult<T> = {
     data: T;
 };
 interface Validator<T_Schema extends Schema> {
-    validate: <T_Data>(data: T_Data, schema: T_Schema) => Promise<ValidateResult<T_Data>>;
+    validate: <T_Data extends Record<string, unknown>>(data: T_Data, schema: T_Schema) => Promise<ValidateResult<T_Data>>;
     isSchema: (schema: Schema) => schema is T_Schema;
     transformToJsonSchema: (schema: T_Schema) => JsonSchema;
 }
@@ -238,6 +241,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>): Workflow<T_Payload>;
+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>;
 
-export { CronExpression, ErrorCodeEnum, Execute, FromSchema, HttpHeaderKeysEnum, HttpMethodEnum, HttpQueryKeysEnum, HttpStatusEnum, JsonSchema, NovuApiEndpointsEnum, RETRYABLE_ERROR_STATUS_CODES, ResourceEnum, 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, 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 };