@novu/framework 2.10.1-alpha.1 → 2.10.1-alpha.2

package/dist/cjs/{index-naFCU9MB.d.cts → index-gi0_Wcu3.d.cts}

@@ -1,20 +1,34 @@
-import { ChatElement } from 'chat';
+import { ChatElement, CardElement } from 'chat';
 import { 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-Nhsa_lGZ.cjs';
 import { g as Awaitable } from './subscriber.types-CNLicO8m.cjs';
 import { S as Schema, a as FromSchema, F as FromSchemaUnvalidated } from './base.schema.types-BApIn9jr.cjs';
 import './step-resolver.cjs';
 
+declare enum AgentEventEnum {
+    ON_MESSAGE = "onMessage",
+    ON_ACTION = "onAction",
+    ON_RESOLVE = "onResolve",
+    ON_REACTION = "onReaction"
+}
 interface AgentMessageAuthor {
     userId: string;
     fullName: string;
     userName: string;
     isBot: boolean | 'unknown';
 }
+interface AgentAttachment {
+    type: string;
+    url?: string;
+    name?: string;
+    mimeType?: string;
+    size?: number;
+}
 interface AgentMessage {
     text: string;
     platformMessageId: string;
     author: AgentMessageAuthor;
     timestamp: string;
+    attachments?: AgentAttachment[];
 }
 interface AgentConversation {
     identifier: string;
@@ -38,6 +52,7 @@ interface AgentHistoryEntry {
     role: string;
     type: string;
     content: string;
+    richContent?: Record<string, unknown>;
     senderName?: string;
     signalData?: {
         type: string;
@@ -59,7 +74,7 @@ interface FileRef {
     url?: string;
 }
 /**
- * Content accepted by ctx.reply() and ctx.update().
+ * Content accepted by ctx.reply() and handle.edit().
  *
  * - `string` — plain text
  * - `{ markdown, files? }` — markdown-formatted text, optionally with file attachments
@@ -70,6 +85,13 @@ type MessageContent = string | {
     markdown: string;
     files?: FileRef[];
 } | ChatElement;
+/** Normalized content shape sent over HTTP to the reply endpoint. */
+interface ReplyContent {
+    text?: string;
+    markdown?: string;
+    card?: CardElement;
+    files?: FileRef[];
+}
 interface AgentAction {
     actionId: string;
     value?: string;
@@ -82,6 +104,19 @@ interface AgentReaction {
     added: boolean;
     message: AgentMessage | null;
 }
+/**
+ * Handle to a message posted via ctx.reply(). Mirrors the chat SDK's `SentMessage`
+ * primitive: edits apply in-place on the platform (same platform message, content changes)
+ * and never post a new message.
+ */
+interface ReplyHandle {
+    /** Platform-native message id (e.g. Slack ts, Teams activityId). */
+    readonly messageId: string;
+    /** Platform-native thread id this message lives in. */
+    readonly platformThreadId: string;
+    /** Edit this message in place with new content. Returns the same handle for chaining. */
+    edit(content: MessageContent): Promise<ReplyHandle>;
+}
 interface AgentContext {
     readonly event: string;
     readonly action: AgentAction | null;
@@ -92,8 +127,16 @@ interface AgentContext {
     readonly history: AgentHistoryEntry[];
     readonly platform: string;
     readonly platformContext: AgentPlatformContext;
-    reply(content: MessageContent): Promise<void>;
-    update(content: MessageContent): Promise<void>;
+    /**
+     * Post a message to the conversation and return a handle to it.
+     * Use the handle to edit the message in place later — no second post.
+     *
+     * @example
+     *   const msg = await ctx.reply('Thinking…');
+     *   // ... do work ...
+     *   await msg.edit('Here is the answer');
+     */
+    reply(content: MessageContent): Promise<ReplyHandle>;
     resolve(summary?: string): void;
     metadata: {
         set(key: string, value: unknown): void;
@@ -113,6 +156,56 @@ interface Agent {
     id: string;
     handlers: AgentHandlers;
 }
+interface AgentBridgeRequest {
+    version: number;
+    timestamp: string;
+    deliveryId: string;
+    event: string;
+    agentId: string;
+    replyUrl: string;
+    conversationId: string;
+    integrationIdentifier: string;
+    action: AgentAction | null;
+    message: AgentMessage | null;
+    reaction: AgentReaction | null;
+    conversation: AgentConversation;
+    subscriber: AgentSubscriber | null;
+    history: AgentHistoryEntry[];
+    platform: string;
+    platformContext: AgentPlatformContext;
+}
+type MetadataSignal = {
+    type: 'metadata';
+    key: string;
+    value: unknown;
+};
+type TriggerSignal = {
+    type: 'trigger';
+    workflowId: string;
+    to?: string;
+    payload?: Record<string, unknown>;
+};
+type Signal = MetadataSignal | TriggerSignal;
+/** In-place edit of a previously posted agent message. Identified by platform message id. */
+interface EditPayload {
+    messageId: string;
+    content: ReplyContent;
+}
+interface AgentReplyPayload {
+    conversationId: string;
+    integrationIdentifier: string;
+    reply?: ReplyContent;
+    edit?: EditPayload;
+    resolve?: {
+        summary?: string;
+    };
+    signals?: Signal[];
+}
+/** Shape returned by /agents/:id/reply when a reply or edit was delivered. */
+interface SentMessageInfo {
+    messageId: string;
+    platformThreadId: string;
+}
 
 /**
  * Define a new conversational agent.
@@ -265,4 +358,4 @@ declare class NovuRequestHandler<Input extends any[] = any[], Output = any> {
  */
 declare function workflow<T_PayloadSchema extends Schema, T_ControlSchema extends Schema, T_EnvSchema extends Schema, T_PayloadValidated extends Record<string, unknown> = FromSchema<T_PayloadSchema>, T_PayloadUnvalidated extends Record<string, unknown> = FromSchemaUnvalidated<T_PayloadSchema>, T_Controls extends Record<string, unknown> = FromSchema<T_ControlSchema>, T_Env extends Record<string, unknown> = FromSchema<T_EnvSchema>>(workflowId: string, execute: Execute<T_PayloadValidated, T_Controls, T_Env>, workflowOptions?: WorkflowOptions<T_PayloadSchema, T_ControlSchema, T_EnvSchema>): Workflow<T_PayloadUnvalidated>;
 
-export { type Agent as A, Client as C, type FileRef as F, type INovuRequestHandlerOptions as I, type MessageContent as M, NovuRequestHandler as N, type ServeHandlerOptions as S, type AgentContext as a, type AgentHandlers as b, type AgentReaction as c, agent as d, workflow as w };
+export { type Agent as A, Client as C, type EditPayload as E, type FileRef as F, type INovuRequestHandlerOptions as I, type MessageContent as M, NovuRequestHandler as N, type ReplyContent as R, type ServeHandlerOptions as S, type TriggerSignal as T, type AgentAction as a, type AgentAttachment as b, type AgentBridgeRequest as c, type AgentContext as d, type AgentConversation as e, AgentEventEnum as f, type AgentHandlers as g, type AgentHistoryEntry as h, type AgentMessage as i, type AgentMessageAuthor as j, type AgentPlatformContext as k, type AgentReaction as l, type AgentReplyPayload as m, type AgentSubscriber as n, type MetadataSignal as o, type ReplyHandle as p, type SentMessageInfo as q, type Signal as r, agent as s, workflow as w };