@novu/framework 2.10.1-alpha.6 → 2.11.0

package/dist/cjs/{health-check.types-S8oS3AQZ.d.cts → health-check.types-uaDLF5bo.d.cts}

@@ -1,4 +1,4 @@
-import { b as ContextPayload, c as ConditionalPartial, P as PickRequiredKeys, d as Step, e as Prettify, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, D as DeepPartial$1, f as ChannelStepEnum, A as ActionStepEnum, g as Awaitable, W as WithPassthrough, h as StepOptions } from './subscriber.types-DgRgSKMw.cjs';
+import { b as ContextPayload, c as ConditionalPartial, P as PickRequiredKeys, d as Step, e as Prettify, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, D as DeepPartial$1, f as ChannelStepEnum, A as ActionStepEnum, g as Awaitable, W as WithPassthrough, h as StepOptions } from './subscriber.types-PRaHFLJu.cjs';
 import { S as Schema, J as JsonSchema } from './base.schema.types-BApIn9jr.cjs';
 
 declare enum ChannelTypeEnum {
@@ -66,7 +66,8 @@ declare enum ChatProviderIdEnum {
     GetStream = "getstream",
     RocketChat = "rocket-chat",
     WhatsAppBusiness = "whatsapp-business",
-    ChatWebhook = "chat-webhook"
+    ChatWebhook = "chat-webhook",
+    Telegram = "telegram"
 }
 declare enum PushProviderIdEnum {
     FCM = "fcm",

package/dist/cjs/{index-BAY1Gj4h.d.cts → index-D-SLxj--.d.cts}

@@ -1,6 +1,6 @@
 import { ChatElement, Emoji, CardElement } from 'chat';
-import { T as TriggerRecipientsPayload, C as ClientOptions, W as Workflow, H as HealthCheck, e as DiscoverOutput, i as Event, n as ExecuteOutput, d as CodeResult, j as EventTriggerParams, m as Execute, t as WorkflowOptions } from './health-check.types-S8oS3AQZ.cjs';
-import { g as Awaitable } from './subscriber.types-DgRgSKMw.cjs';
+import { T as TriggerRecipientsPayload, C as ClientOptions, W as Workflow, H as HealthCheck, e as DiscoverOutput, i as Event, n as ExecuteOutput, d as CodeResult, j as EventTriggerParams, m as Execute, t as WorkflowOptions } from './health-check.types-uaDLF5bo.cjs';
+import { g as Awaitable } from './subscriber.types-PRaHFLJu.cjs';
 import { S as Schema, a as FromSchema, F as FromSchemaUnvalidated } from './base.schema.types-BApIn9jr.cjs';
 import './step-resolver.cjs';
 
@@ -85,6 +85,27 @@ interface AgentHistoryEntry {
     };
     createdAt: string;
 }
+/** Resolved inbound email domain metadata (present when `platform === 'email'`). */
+interface AgentEmailDomainContext {
+    id: string;
+    name: string;
+    data?: Record<string, string>;
+}
+/** Resolved inbound email route metadata (present when `platform === 'email'`). */
+interface AgentEmailRouteContext {
+    address: string;
+    data?: Record<string, string>;
+}
+/** Resolved inbound email envelope (present when `platform === 'email'`). */
+interface AgentEmailContext {
+    domain?: AgentEmailDomainContext;
+    route?: AgentEmailRouteContext;
+    /**
+     * Platform-native Message-ID of the message that started this email thread.
+     * Equals the current message ID on the first message of a thread.
+     */
+    rootMessageId?: string;
+}
 /** Platform-specific identifiers for the thread and channel. */
 interface AgentPlatformContext {
     /** Platform-native thread ID (e.g. Slack thread `ts`, Teams conversation ID). */
@@ -93,6 +114,10 @@ interface AgentPlatformContext {
     channelId: string;
     /** Whether the message arrived in a direct message rather than a shared channel. */
     isDM: boolean;
+    /** Platform-native raw message payload from the chat SDK adapter (e.g. email `NovuEmailRawMessage`). */
+    message?: unknown;
+    /** Resolved inbound email routing metadata extracted from the raw payload. */
+    email?: AgentEmailContext;
 }
 interface FileRef {
     filename: string;
@@ -118,6 +143,7 @@ interface FileRef {
  * - `ChatElement` — interactive card built with Card(), Button(), etc.
  *
  * For file attachments, pass a `files` array as the second argument to reply()/edit().
+ * Cards and files can be combined on platforms that support it (e.g. WhatsApp sends media then the card).
  */
 type MessageContent = string | ChatElement;
 /** Normalized content shape sent over HTTP to the reply endpoint. */
@@ -126,10 +152,15 @@ interface ReplyContent {
     card?: CardElement;
     files?: FileRef[];
 }
-/** Data carried by a button click or other interactive action. */
+/**
+ * Data carried by a button click or other interactive action.
+ *
+ * Used both on the bridge wire (`AgentBridgeRequest.action`) and as the
+ * handler-facing argument passed to `onAction(action, ctx)`.
+ */
 interface AgentAction {
     /** The `id` prop of the clicked `<Button>` or action element. */
-    actionId: string;
+    id: string;
     /** The `value` prop of the clicked element, if set. */
     value?: string;
     /** Platform-native message ID of the message containing the clicked button/action. */
@@ -258,8 +289,6 @@ interface AgentContextBase {
 /** Context passed to the `onMessage` handler. */
 interface AgentMessageContext extends AgentContextBase {
     readonly event: 'onMessage';
-    /** The incoming message that triggered this handler. */
-    readonly message: AgentMessage;
 }
 /** Context passed to the `onAction` handler. */
 interface AgentActionContext extends AgentContextBase {
@@ -282,42 +311,41 @@ type AgentContext = AgentMessageContext | AgentActionContext | AgentReactionCont
 interface AgentHandlers {
     /**
      * Fires on every text message the user sends.
-     * `message` is the incoming message. `ctx` provides conversation history, subscriber,
-     * metadata, and reply/trigger methods.
+     *
+     * @param message - The incoming message that triggered this handler.
+     * @param ctx - Conversation history, subscriber, metadata, and reply/trigger methods.
+     *
      * Return a string or JSX card to reply, or call `ctx.reply()` directly
      * for more control (e.g. editing a message in place).
      */
-    onMessage: (payload: {
-        message: AgentMessage;
-        ctx: AgentMessageContext;
-    }) => Awaitable<MessageContent | void>;
+    onMessage: (message: AgentMessage, ctx: AgentMessageContext) => Awaitable<MessageContent | void>;
     /**
      * Fires when the user adds or removes an emoji reaction to a message.
-     * `reaction` carries the emoji and whether it was added or removed.
+     *
+     * @param reaction - The emoji reaction (carries the emoji and whether it was added or removed).
+     * @param ctx - Conversation context (history, subscriber, metadata, reply/trigger methods).
+     *
      * Return a string or card to post a reply, or return nothing to silently acknowledge.
      */
-    onReaction?: (payload: {
-        reaction: AgentReaction;
-        ctx: AgentReactionContext;
-    }) => Awaitable<MessageContent | void>;
+    onReaction?: (reaction: AgentReaction, ctx: AgentReactionContext) => Awaitable<MessageContent | void>;
     /**
      * Fires when the user clicks a `<Button>` or other interactive element.
-     * `actionId` is the `id` prop of the clicked element; `value` is its `value` prop.
+     *
+     * @param action - The interactive action that triggered this handler.
+     *   `action.id` is the `id` prop of the clicked element; `action.value` is its `value` prop.
+     * @param ctx - Conversation context (history, subscriber, metadata, reply/trigger methods).
+     *
      * Return a string or card to reply, or return nothing to silently acknowledge the click.
      */
-    onAction?: (payload: {
-        actionId: string;
-        value?: string;
-        ctx: AgentActionContext;
-    }) => Awaitable<MessageContent | void>;
+    onAction?: (action: AgentAction, ctx: AgentActionContext) => Awaitable<MessageContent | void>;
     /**
      * Fires after `ctx.resolve()` is called and the conversation is marked resolved.
      * Use for post-resolution side-effects (e.g. triggering a follow-up workflow).
-     * Access subscriber and conversation via `ctx.subscriber` and `ctx.conversation`.
+     *
+     * @param ctx - Conversation context. Access subscriber and conversation via
+     *   `ctx.subscriber` and `ctx.conversation`.
      */
-    onResolve?: (payload: {
-        ctx: AgentResolveContext;
-    }) => Awaitable<MessageContent | void>;
+    onResolve?: (ctx: AgentResolveContext) => Awaitable<MessageContent | void>;
 }
 interface Agent {
     id: string;