@novu/framework 2.10.1-alpha.3 → 2.10.1-alpha.5

package/dist/cjs/{index-C5CigDlK.d.cts → index-B4t9LyOV.d.cts}

@@ -68,23 +68,29 @@ interface AgentPlatformContext {
 interface FileRef {
     filename: string;
     mimeType?: string;
-    /** Base64-encoded file data (< 1 MB decoded) */
-    data?: string;
-    /** Publicly-accessible HTTPS URL */
+    /**
+     * Inline file data. Binary values are encoded to base64 before being sent to Novu.
+     * Node Buffers are supported because Buffer extends Uint8Array.
+     *
+     * Limit: <= 5 MB decoded. Use `url` for larger files.
+     */
+    data?: string | Uint8Array | ArrayBuffer | Blob;
+    /**
+     * Publicly-accessible HTTP(S) URL. Recommended for larger files.
+     *
+     * Server-side limits: 25 MB per file, 15 files per message, 50 MB aggregate.
+     */
     url?: string;
 }
 /**
  * Content accepted by ctx.reply() and handle.edit().
  *
  * - `string` — plain text or markdown; converted to platform format by the chat SDK
- * - `{ markdown, files? }` — markdown with optional file attachments
  * - `ChatElement` — interactive card built with Card(), Button(), etc.
- *   (must be a CardElement at runtime; validated by serializeContent)
+ *
+ * For file attachments, pass a `files` array as the second argument to reply()/edit().
  */
-type MessageContent = string | {
-    markdown: string;
-    files?: FileRef[];
-} | ChatElement;
+type MessageContent = string | ChatElement;
 /** Normalized content shape sent over HTTP to the reply endpoint. */
 interface ReplyContent {
     markdown?: string;
@@ -114,7 +120,9 @@ interface ReplyHandle {
     /** 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>;
+    edit(content: MessageContent, options?: {
+        files?: FileRef[];
+    }): Promise<ReplyHandle>;
 }
 interface AgentContext {
     readonly event: string;
@@ -132,10 +140,16 @@ interface AgentContext {
      *
      * @example
      *   const msg = await ctx.reply('Thinking…');
-     *   // ... do work ...
      *   await msg.edit('Here is the answer');
+     *
+     * @example with file attachment
+     *   await ctx.reply('Here is your report', {
+     *     files: [{ filename: 'report.pdf', url: 'https://...' }],
+     *   });
      */
-    reply(content: MessageContent): Promise<ReplyHandle>;
+    reply(content: MessageContent, options?: {
+        files?: FileRef[];
+    }): Promise<ReplyHandle>;
     resolve(summary?: string): void;
     metadata: {
         set(key: string, value: unknown): void;
@@ -259,7 +273,8 @@ interface SentMessageInfo {
  * fails — e.g. the configured email provider returns 401, Slack rejects the token,
  * or Teams rejects the request.
  *
- * The `message` property contains the original provider error text
+ * `message` is always a short, human-readable summary.
+ * `responseBody` preserves the raw upstream body for debugging.
  *
  * @example
  * ```ts
@@ -269,7 +284,6 @@ interface SentMessageInfo {
  *   await ctx.reply('Hello!');
  * } catch (err) {
  *   if (err instanceof AgentDeliveryError) {
- *     // Delivery failed (misconfigured provider, rate limit, etc.)
  *     console.error('Delivery failed:', err.message);
  *     return;
  *   }
@@ -279,7 +293,8 @@ interface SentMessageInfo {
  */
 declare class AgentDeliveryError extends Error {
     readonly statusCode: number;
-    constructor(statusCode: number, message: string);
+    readonly responseBody: string;
+    constructor(statusCode: number, responseBody: string);
 }
 
 /**