@novu/framework 2.13.1-rc.72c80d5b17 → 2.13.1

package/dist/cjs/{subscriber.types-CyNKT0nZ.d.cts → subscriber.types-BanvmGul.d.cts}

@@ -1,6 +1,23 @@
+import { CardElement } from 'chat';
 import { F as FromSchemaUnvalidated, S as Schema, a as FromSchema } from './base.schema.types-BApIn9jr.cjs';
 import { a as Prettify, A as Awaitable } from './util.types-DaFfsxgy.cjs';
 
+declare enum ChannelStepEnum {
+    EMAIL = "email",
+    SMS = "sms",
+    PUSH = "push",
+    CHAT = "chat",
+    IN_APP = "in_app",
+    TOOL = "tool"
+}
+declare enum ActionStepEnum {
+    DIGEST = "digest",
+    DELAY = "delay",
+    THROTTLE = "throttle",
+    CUSTOM = "custom",
+    HTTP_REQUEST = "http_request"
+}
+
 type ContextType = string;
 type ContextId = string;
 type ContextData = Record<string, unknown>;
@@ -98,22 +115,6 @@ type ContextResolved = Record<ContextType, {
     data: ContextData;
 }>;
 
-declare enum ChannelStepEnum {
-    EMAIL = "email",
-    SMS = "sms",
-    PUSH = "push",
-    CHAT = "chat",
-    IN_APP = "in_app",
-    TOOL = "tool"
-}
-declare enum ActionStepEnum {
-    DIGEST = "digest",
-    DELAY = "delay",
-    THROTTLE = "throttle",
-    CUSTOM = "custom",
-    HTTP_REQUEST = "http_request"
-}
-
 declare const providerSchemas: {
     readonly chat: {
         readonly 'chat-webhook': {
@@ -148,6 +149,14 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly line: {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
         readonly mattermost: {
             output: {
                 readonly type: "object";
@@ -164,6 +173,22 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly 'novu-slack': {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
+        readonly 'novu-web-chat': {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
         readonly 'rocket-chat': {
             output: {
                 readonly type: "object";
@@ -205,7 +230,7 @@ declare const providerSchemas: {
                             readonly type: "object";
                             readonly properties: {
                                 readonly type: {
-                                    readonly enum: readonly ["image", "context", "actions", "divider", "section", "input", "file", "header", "video", "rich_text"];
+                                    readonly type: "string";
                                 };
                             };
                             readonly required: readonly ["type"];
@@ -216,6 +241,14 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly 'webex-messaging': {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
         readonly 'whatsapp-business': {
             output: {
                 readonly type: "object";
@@ -3705,6 +3738,14 @@ declare const providerSchemas: {
                 readonly additionalProperties: true;
             };
         };
+        readonly grafana: {
+            output: {
+                readonly type: "object";
+                readonly properties: {};
+                readonly required: readonly [];
+                readonly additionalProperties: true;
+            };
+        };
         readonly 'tool-webhook': {
             output: {
                 readonly type: "object";
@@ -4063,8 +4104,596 @@ declare const channelStepSchemas: {
                 readonly body: {
                     readonly type: "string";
                 };
+                readonly card: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly type: {
+                            readonly type: "string";
+                            readonly const: "card";
+                        };
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly subtitle: {
+                            readonly type: "string";
+                        };
+                        readonly imageUrl: {
+                            readonly type: "string";
+                        };
+                        readonly children: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly anyOf: readonly [{
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "text";
+                                        };
+                                        readonly content: {
+                                            readonly type: "string";
+                                        };
+                                        readonly style: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["plain", "bold", "muted"];
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "content"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "image";
+                                        };
+                                        readonly url: {
+                                            readonly type: "string";
+                                        };
+                                        readonly alt: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "url"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "divider";
+                                        };
+                                    };
+                                    readonly required: readonly ["type"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "link";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly url: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "label", "url"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "actions";
+                                        };
+                                        readonly children: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly anyOf: readonly [{
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "link-button";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly url: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly style: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["primary", "danger", "default"];
+                                                        };
+                                                        readonly id: {
+                                                            readonly type: "string";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "label", "url"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "button";
+                                                        };
+                                                        readonly id: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly style: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["primary", "danger", "default"];
+                                                        };
+                                                        readonly actionType: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["action", "modal"];
+                                                        };
+                                                        readonly callbackUrl: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly value: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly disabled: {
+                                                            readonly type: "boolean";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "id", "label"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "select";
+                                                        };
+                                                        readonly id: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly options: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "object";
+                                                                readonly properties: {
+                                                                    readonly label: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                    readonly value: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                    readonly description: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                };
+                                                                readonly required: readonly ["label", "value"];
+                                                            };
+                                                        };
+                                                        readonly initialOption: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly optional: {
+                                                            readonly type: "boolean";
+                                                        };
+                                                        readonly placeholder: {
+                                                            readonly type: "string";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "id", "label", "options"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "radio_select";
+                                                        };
+                                                        readonly id: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly options: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "object";
+                                                                readonly properties: {
+                                                                    readonly label: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                    readonly value: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                    readonly description: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                };
+                                                                readonly required: readonly ["label", "value"];
+                                                            };
+                                                        };
+                                                        readonly initialOption: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly optional: {
+                                                            readonly type: "boolean";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "id", "label", "options"];
+                                                }];
+                                            };
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "children"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "fields";
+                                        };
+                                        readonly children: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "object";
+                                                readonly properties: {
+                                                    readonly type: {
+                                                        readonly type: "string";
+                                                        readonly const: "field";
+                                                    };
+                                                    readonly label: {
+                                                        readonly type: "string";
+                                                    };
+                                                    readonly value: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                                readonly required: readonly ["type", "label", "value"];
+                                            };
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "children"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "table";
+                                        };
+                                        readonly headers: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                        readonly rows: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                            };
+                                        };
+                                        readonly align: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                                readonly enum: readonly ["left", "center", "right"];
+                                            };
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "headers", "rows"];
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly const: "section";
+                                        };
+                                        readonly children: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly anyOf: readonly [{
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "text";
+                                                        };
+                                                        readonly content: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly style: {
+                                                            readonly type: "string";
+                                                            readonly enum: readonly ["plain", "bold", "muted"];
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "content"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "image";
+                                                        };
+                                                        readonly url: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly alt: {
+                                                            readonly type: "string";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "url"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "divider";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "link";
+                                                        };
+                                                        readonly label: {
+                                                            readonly type: "string";
+                                                        };
+                                                        readonly url: {
+                                                            readonly type: "string";
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "label", "url"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "actions";
+                                                        };
+                                                        readonly children: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly anyOf: readonly [{
+                                                                    readonly type: "object";
+                                                                    readonly properties: {
+                                                                        readonly type: {
+                                                                            readonly type: "string";
+                                                                            readonly const: "link-button";
+                                                                        };
+                                                                        readonly label: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly url: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly style: {
+                                                                            readonly type: "string";
+                                                                            readonly enum: readonly ["primary", "danger", "default"];
+                                                                        };
+                                                                        readonly id: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                    };
+                                                                    readonly required: readonly ["type", "label", "url"];
+                                                                }, {
+                                                                    readonly type: "object";
+                                                                    readonly properties: {
+                                                                        readonly type: {
+                                                                            readonly type: "string";
+                                                                            readonly const: "button";
+                                                                        };
+                                                                        readonly id: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly label: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly style: {
+                                                                            readonly type: "string";
+                                                                            readonly enum: readonly ["primary", "danger", "default"];
+                                                                        };
+                                                                        readonly actionType: {
+                                                                            readonly type: "string";
+                                                                            readonly enum: readonly ["action", "modal"];
+                                                                        };
+                                                                        readonly callbackUrl: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly value: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly disabled: {
+                                                                            readonly type: "boolean";
+                                                                        };
+                                                                    };
+                                                                    readonly required: readonly ["type", "id", "label"];
+                                                                }, {
+                                                                    readonly type: "object";
+                                                                    readonly properties: {
+                                                                        readonly type: {
+                                                                            readonly type: "string";
+                                                                            readonly const: "select";
+                                                                        };
+                                                                        readonly id: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly label: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly options: {
+                                                                            readonly type: "array";
+                                                                            readonly items: {
+                                                                                readonly type: "object";
+                                                                                readonly properties: {
+                                                                                    readonly label: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                    readonly value: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                    readonly description: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                };
+                                                                                readonly required: readonly ["label", "value"];
+                                                                            };
+                                                                        };
+                                                                        readonly initialOption: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly optional: {
+                                                                            readonly type: "boolean";
+                                                                        };
+                                                                        readonly placeholder: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                    };
+                                                                    readonly required: readonly ["type", "id", "label", "options"];
+                                                                }, {
+                                                                    readonly type: "object";
+                                                                    readonly properties: {
+                                                                        readonly type: {
+                                                                            readonly type: "string";
+                                                                            readonly const: "radio_select";
+                                                                        };
+                                                                        readonly id: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly label: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly options: {
+                                                                            readonly type: "array";
+                                                                            readonly items: {
+                                                                                readonly type: "object";
+                                                                                readonly properties: {
+                                                                                    readonly label: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                    readonly value: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                    readonly description: {
+                                                                                        readonly type: "string";
+                                                                                    };
+                                                                                };
+                                                                                readonly required: readonly ["label", "value"];
+                                                                            };
+                                                                        };
+                                                                        readonly initialOption: {
+                                                                            readonly type: "string";
+                                                                        };
+                                                                        readonly optional: {
+                                                                            readonly type: "boolean";
+                                                                        };
+                                                                    };
+                                                                    readonly required: readonly ["type", "id", "label", "options"];
+                                                                }];
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "children"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "fields";
+                                                        };
+                                                        readonly children: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "object";
+                                                                readonly properties: {
+                                                                    readonly type: {
+                                                                        readonly type: "string";
+                                                                        readonly const: "field";
+                                                                    };
+                                                                    readonly label: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                    readonly value: {
+                                                                        readonly type: "string";
+                                                                    };
+                                                                };
+                                                                readonly required: readonly ["type", "label", "value"];
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "children"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "table";
+                                                        };
+                                                        readonly headers: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                            };
+                                                        };
+                                                        readonly rows: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "array";
+                                                                readonly items: {
+                                                                    readonly type: "string";
+                                                                };
+                                                            };
+                                                        };
+                                                        readonly align: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "string";
+                                                                readonly enum: readonly ["left", "center", "right"];
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "headers", "rows"];
+                                                }, {
+                                                    readonly type: "object";
+                                                    readonly properties: {
+                                                        readonly type: {
+                                                            readonly type: "string";
+                                                            readonly const: "section";
+                                                        };
+                                                        readonly children: {
+                                                            readonly type: "array";
+                                                            readonly items: {
+                                                                readonly type: "object";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly required: readonly ["type", "children"];
+                                                }];
+                                            };
+                                        };
+                                    };
+                                    readonly required: readonly ["type", "children"];
+                                }];
+                            };
+                        };
+                    };
+                    readonly required: readonly ["type", "children"];
+                    readonly additionalProperties: false;
+                };
             };
-            readonly required: readonly ["body"];
+            readonly anyOf: [{
+                readonly required: readonly ["body"];
+            }, {
+                readonly required: readonly ["card"];
+            }];
             readonly additionalProperties: false;
         };
         result: {
@@ -4136,6 +4765,15 @@ declare const channelStepSchemas: {
                     };
                     readonly additionalProperties: false;
                 };
+                readonly replyTo: {
+                    readonly type: "string";
+                };
+                readonly preheader: {
+                    readonly type: "string";
+                };
+                readonly useProviderDefaults: {
+                    readonly type: "boolean";
+                };
             };
             readonly required: readonly ["subject", "body"];
             readonly additionalProperties: false;
@@ -4340,13 +4978,6 @@ declare const channelStepSchemas: {
                 readonly body: {
                     readonly type: "string";
                 };
-                readonly providerOverrides: {
-                    readonly type: "object";
-                    readonly additionalProperties: {
-                        readonly type: "object";
-                        readonly additionalProperties: true;
-                    };
-                };
             };
             readonly required: readonly ["body"];
             readonly additionalProperties: false;
@@ -4518,8 +5149,30 @@ type SmsResult = FromSchema<(typeof channelStepSchemas)['sms']['result']>;
 type PushOutput = FromSchema<(typeof channelStepSchemas)['push']['output']>;
 type PushOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)['push']['output']>;
 type PushResult = FromSchema<(typeof channelStepSchemas)['push']['result']>;
-type ChatOutput = FromSchema<(typeof channelStepSchemas)['chat']['output']>;
-type ChatOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)['chat']['output']>;
+/**
+ * Re-maps the `card` field to the Chat SDK `CardElement`.
+ *
+ * The chat step's `card` schema (see `chat.schema.ts`) intentionally omits
+ * `additionalProperties: false` on its child-element variants, so `json-schema-to-ts`
+ * adds `[x: string]: unknown` index signatures. The Chat SDK models cards as
+ * `interface`s (no implicit index signature), so `Card()` isn't assignable to the
+ * inferred type. Swapping `card` for the SDK `CardElement` lets `Card` / `Actions`
+ * / etc. be used on `step.chat` without changing those builders (agents keep the
+ * unmodified Chat SDK types). The runtime schema accepts the Chat SDK card kit
+ * (section/fields/table + interactive button/select/radio_select); interactive
+ * elements render on Slack/Teams but have no callback wiring on classic `step.chat`.
+ */
+type WithChatCard<T_Output> = T_Output extends {
+    card: unknown;
+} ? Prettify<Omit<T_Output, 'card'> & {
+    card: CardElement;
+}> : T_Output extends {
+    card?: unknown;
+} ? Prettify<Omit<T_Output, 'card'> & {
+    card?: CardElement;
+}> : T_Output;
+type ChatOutput = WithChatCard<FromSchema<(typeof channelStepSchemas)['chat']['output']>>;
+type ChatOutputUnvalidated = WithChatCard<FromSchemaUnvalidated<(typeof channelStepSchemas)['chat']['output']>>;
 type ChatResult = FromSchema<(typeof channelStepSchemas)['chat']['result']>;
 type InAppOutput = FromSchema<(typeof channelStepSchemas)['in_app']['output']>;
 type InAppOutputUnvalidated = FromSchemaUnvalidated<(typeof channelStepSchemas)['in_app']['output']>;