@novu/framework 2.13.1-rc.852194fa77 → 2.13.1

package/dist/cjs/{agent.types-CQKSD7NC.d.cts → agent.types-crcJBtCy.d.cts}

@@ -114,7 +114,7 @@ declare enum ChatProviderIdEnum {
     Novu = "novu-slack",
     Telegram = "telegram",
     Sendblue = "sendblue",
-    NovuAgentChat = "novu-agent-chat"
+    NovuWebChat = "novu-web-chat"
 }
 declare enum PushProviderIdEnum {
     FCM = "fcm",
@@ -205,6 +205,51 @@ declare enum AgentEventEnum {
     ON_RESOLVE = "onResolve",
     ON_REACTION = "onReaction"
 }
+type HumanInteractionKind = 'ask' | 'approve' | 'choose' | 'tell';
+type HumanAskApproveOptions = {
+    /** Attribution label shown to the human (e.g. `"deploy-bot"`). */
+    from?: string;
+    /** Time until the request expires, in seconds (max 72h; default 24h). */
+    ttlSeconds?: number;
+    /**
+     * Novu `subscriberId`(s) allowed to settle this request. First valid answer
+     * wins. When omitted, the conversation's first subscriber participant is used.
+     * The maximum number of subscribers is 50.
+     */
+    to?: string | string[];
+};
+type HumanChooseOptions = HumanAskApproveOptions;
+type HumanTellOptions = {
+    /** Attribution label shown to the human (e.g. `"deploy-bot"`). */
+    from?: string;
+    /**
+     * Novu `subscriberId`(s) this notice is addressed to. In-thread delivery
+     * still posts one card on the current conversation.
+     */
+    to?: string | string[];
+};
+/**
+ * Outcome of a `ctx.ask` / `ctx.approve` / `ctx.choose` request, attached to
+ * the later `onMessage` (ask) or `onAction` (approve / choose) turn.
+ */
+type AgentHumanResponse = {
+    /** Client-minted id returned by `ctx.ask` / `ctx.approve` / `ctx.choose`. */
+    requestId: string;
+    /** Public interaction identifier (`hi_...`). */
+    interactionId: string;
+    kind: HumanInteractionKind;
+    /** Terminal status: `answered` | `approved` | `denied` | `expired` | `canceled` | `delivered`. */
+    status: string;
+    /** True when the TTL elapsed before a valid answer. Do not treat `text` / `optionId` as a verdict. */
+    expired: boolean;
+    /** Freeform reply text for `ask`. */
+    text?: string;
+    /** `approve`: `'approve'` | `'deny'`; `choose`: the picked option id. */
+    optionId?: string;
+    respondedBy?: string;
+    /** Stable Novu subscriberId of whoever settled the interaction. */
+    respondedBySubscriberId?: string;
+};
 /** Identity of the user or bot that authored a message. */
 interface AgentMessageAuthor {
     userId: string;
@@ -553,6 +598,12 @@ interface AgentHandlerContext {
      * conversation was not opened from a workflow send.
      */
     readonly notification: AgentNotification | null;
+    /**
+     * Settled `ctx.ask` / `ctx.approve` / `ctx.choose` payload when this
+     * `onMessage` or `onAction` turn answered (or expired) a human interaction.
+     * `null` on ordinary chat and button clicks.
+     */
+    readonly humanResponse: AgentHumanResponse | null;
     /**
      * Full conversation history as an ordered array of entries.
      * Map to your LLM's message format before making a model call:
@@ -633,6 +684,50 @@ interface AgentHandlerContext {
         to?: TriggerRecipientsPayload;
         payload?: Record<string, unknown>;
     }): void;
+    /**
+     * Ask the conversation subscriber a freeform question. Queued and flushed
+     * with the next `ctx.reply()`, or automatically when the handler completes.
+     * The answer arrives later on `onMessage` with `ctx.humanResponse` set.
+     * Pass `to` to let any listed subscriber settle (first valid answer wins).
+     *
+     * @returns A `requestId` you can match against `ctx.humanResponse.requestId`.
+     *
+     * @example
+     *   ctx.ask('What environment should we deploy to?');
+     *   ctx.ask('Which environment?', { to: 'alice' });
+     */
+    ask(question: string, opts?: HumanAskApproveOptions): string;
+    /**
+     * Ask the conversation subscriber to approve or deny an action.
+     * The verdict arrives later on `onAction` with `ctx.humanResponse` set.
+     * Pass `to` to let any listed subscriber settle (first valid answer wins).
+     *
+     * @returns A `requestId` you can match against `ctx.humanResponse.requestId`.
+     *
+     * @example
+     *   ctx.approve('Deploy v2.4.1 to production?');
+     *   ctx.approve('Deploy v2.4.1?', { to: ['alice', 'bob'] });
+     */
+    approve(action: string, opts?: HumanAskApproveOptions): string;
+    /**
+     * Ask the conversation subscriber to pick one of several options (2–10).
+     * The pick arrives later on `onAction` with `ctx.humanResponse` set.
+     * Pass `to` to let any listed subscriber settle (first valid answer wins).
+     *
+     * @returns A `requestId` you can match against `ctx.humanResponse.requestId`.
+     *
+     * @example
+     *   ctx.choose('Which region?', ['us-east', 'eu-west', 'ap-south']);
+     */
+    choose(question: string, options: string[], opts?: HumanChooseOptions): string;
+    /**
+     * Send a one-way notification to the conversation subscriber. Nothing to wait
+     * on — `tell` never sets `ctx.humanResponse`.
+     *
+     * @example
+     *   ctx.tell('Deploy finished. v2.4.1 is live.');
+     */
+    tell(message: string, opts?: HumanTellOptions): string;
     /**
      * Add an emoji reaction to any platform message.
      * Reactions are queued and sent with the next `ctx.reply()`, or flushed automatically
@@ -809,6 +904,12 @@ interface AgentBridgeRequest {
      * absent → `ctx.notification` is `null`.
      */
     notification?: AgentNotification | null;
+    /**
+     * Settled human-interaction payload when this `onMessage` / `onAction` turn
+     * answered or expired a `ctx.ask` / `ctx.approve` / `ctx.choose`. Optional on
+     * the wire for backward compatibility; absent → `ctx.humanResponse` is `null`.
+     */
+    humanResponse?: AgentHumanResponse | null;
     history: AgentHistoryEntry[];
     platform: string;
     platformContext: AgentPlatformContext;
@@ -841,7 +942,22 @@ type TriggerSignal = {
     to?: TriggerRecipientsPayload;
     payload?: Record<string, unknown>;
 };
-type Signal = MetadataSignal | TriggerSignal;
+/**
+ * Queued by `ctx.ask` / `ctx.approve` / `ctx.choose` / `ctx.tell` — instructs
+ * Novu to create a human interaction in the current conversation thread.
+ */
+type HumanSignal = {
+    type: 'human';
+    kind: HumanInteractionKind;
+    prompt: string;
+    requestId: string;
+    options?: string[];
+    from?: string;
+    ttlSeconds?: number;
+    /** Novu subscriberId(s) allowed to settle. Omitted = conversation subscriber. */
+    to?: string | string[];
+};
+type Signal = MetadataSignal | TriggerSignal | HumanSignal;
 /** The outcome of a tool call, reported back so it's saved in the conversation history. */
 type ToolResult = {
     /** Id of the tool call this result belongs to. */
@@ -904,4 +1020,4 @@ interface SentMessageInfo {
     platformThreadId: string;
 }
 
-export { buildApprovalActionId as $, type Agent as A, type TriggerRecipientsPayload as B, type ISubscriberPayload as C, TriggerEventStatusEnum as D, type ToolResult as E, type FileRef as F, type ToolApprovalRequestPayload as G, AgentEventEnum as H, type ITriggerPayload as I, type TypingControl as J, type ToolApprovalControl as K, type AgentBridgeRequest as L, type MessageContent as M, type ReplyContent as N, type AddReactionPayload as O, type DeleteMessagePayload as P, type SentMessageInfo as Q, type ReplyHandle as R, type Signal as S, type ToolApprovalCard as T, type TypingOp as U, type AgentReplyPayload as V, type WorkflowPreferencesPartial as W, type EditPayload as X, type MetadataSignal as Y, type ParsedApprovalAction as Z, type TriggerSignal as _, type AgentAction as a, parseApprovalActionId as a0, type AgentActionContext as b, type AgentAttachment as c, type AgentContext as d, type AgentContextPayload as e, type AgentContextValue as f, type AgentConversation as g, AgentDeliveryError as h, AgentError as i, type AgentHandlerContext as j, type AgentHandlers as k, type AgentHistoryEntry as l, type AgentMessage as m, type AgentMessageAuthor as n, type AgentMessageContext as o, type AgentNotification as p, type AgentPlatformContext as q, type AgentReaction as r, type AgentReactionContext as s, type AgentResolveContext as t, type AgentSubscriber as u, type AgentSubscriberAccess as v, type AgentToolCall as w, type ToolApprovalConfig as x, type ToolApprovalDecision as y, toAgentError as z };
+export { type AgentReplyPayload as $, type Agent as A, type HumanTellOptions as B, type ToolApprovalConfig as C, type ToolApprovalDecision as D, toAgentError as E, type FileRef as F, type TriggerRecipientsPayload as G, type HumanAskApproveOptions as H, type ITriggerPayload as I, type ISubscriberPayload as J, TriggerEventStatusEnum as K, type ToolResult as L, type MessageContent as M, type ToolApprovalRequestPayload as N, AgentEventEnum as O, type TypingControl as P, type ToolApprovalControl as Q, type ReplyHandle as R, type AgentBridgeRequest as S, type ToolApprovalCard as T, type ReplyContent as U, type Signal as V, type WorkflowPreferencesPartial as W, type AddReactionPayload as X, type DeleteMessagePayload as Y, type SentMessageInfo as Z, type TypingOp as _, type AgentAction as a, type EditPayload as a0, type HumanSignal as a1, type MetadataSignal as a2, type ParsedApprovalAction as a3, type TriggerSignal as a4, buildApprovalActionId as a5, parseApprovalActionId as a6, type AgentActionContext as b, type AgentAttachment as c, type AgentContext as d, type AgentContextPayload as e, type AgentContextValue as f, type AgentConversation as g, AgentDeliveryError as h, AgentError as i, type AgentHandlerContext as j, type AgentHandlers as k, type AgentHistoryEntry as l, type AgentHumanResponse as m, type AgentMessage as n, type AgentMessageAuthor as o, type AgentMessageContext as p, type AgentNotification as q, type AgentPlatformContext as r, type AgentReaction as s, type AgentReactionContext as t, type AgentResolveContext as u, type AgentSubscriber as v, type AgentSubscriberAccess as w, type AgentToolCall as x, type HumanChooseOptions as y, type HumanInteractionKind as z };

package/dist/cjs/ai-sdk/index.d.cts

@@ -1,4 +1,4 @@
-import { k as AgentHandlers, m as AgentMessage, o as AgentMessageContext, M as MessageContent, y as ToolApprovalDecision, b as AgentActionContext, R as ReplyHandle, A as Agent, l as AgentHistoryEntry, j as AgentHandlerContext } from '../agent.types-CQKSD7NC.cjs';
+import { k as AgentHandlers, n as AgentMessage, p as AgentMessageContext, M as MessageContent, D as ToolApprovalDecision, b as AgentActionContext, R as ReplyHandle, A as Agent, l as AgentHistoryEntry, j as AgentHandlerContext } from '../agent.types-crcJBtCy.cjs';
 import { streamText, generateText, ModelMessage } from 'ai';
 import { A as Awaitable } from '../util.types-DaFfsxgy.cjs';
 import 'chat';

package/dist/cjs/{health-check.types-B6RuXNc8.d.cts → health-check.types-C2XZ-Tpt.d.cts}

@@ -1,5 +1,5 @@
-import { a as ContextPayload, b as Step, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, c as ChannelStepEnum, A as ActionStepEnum, W as WithPassthrough, d as StepOptions } from './subscriber.types-_eHz1E0m.cjs';
-import { I as ITriggerPayload, B as TriggerRecipientsPayload, C as ISubscriberPayload, D as TriggerEventStatusEnum, W as WorkflowPreferencesPartial } from './agent.types-CQKSD7NC.cjs';
+import { a as ContextPayload, b as Step, S as Subscriber, E as EnvironmentSystemVariables, C as ContextResolved, c as ChannelStepEnum, A as ActionStepEnum, W as WithPassthrough, d as StepOptions } from './subscriber.types-BanvmGul.cjs';
+import { I as ITriggerPayload, G as TriggerRecipientsPayload, J as ISubscriberPayload, K as TriggerEventStatusEnum, W as WorkflowPreferencesPartial } from './agent.types-crcJBtCy.cjs';
 import { C as ConditionalPartial, P as PickRequiredKeys, a as Prettify, D as DeepPartial, A as Awaitable } from './util.types-DaFfsxgy.cjs';
 import { S as Schema, J as JsonSchema } from './base.schema.types-BApIn9jr.cjs';
 

package/dist/cjs/{index-phn3kJ9H.d.cts → index-DVSB455a.d.cts}

@@ -1,10 +1,10 @@
-import { k as AgentHandlers, A as Agent, p as AgentNotification } from './agent.types-CQKSD7NC.cjs';
-import { W as Workflow, L as Logger, C as ClientOptions, 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-B6RuXNc8.cjs';
+import { k as AgentHandlers, A as Agent, q as AgentNotification } from './agent.types-crcJBtCy.cjs';
+import { W as Workflow, L as Logger, C as ClientOptions, 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-C2XZ-Tpt.cjs';
 import { A as Awaitable } from './util.types-DaFfsxgy.cjs';
 import 'chat';
 import { S as Schema, a as FromSchema, F as FromSchemaUnvalidated } from './base.schema.types-BApIn9jr.cjs';
 import './step-resolver.cjs';
-import './subscriber.types-_eHz1E0m.cjs';
+import './subscriber.types-BanvmGul.cjs';
 
 /**
  * Define a new conversational agent.