@ada-cx/messaging-bridge 1.0.0 → 1.1.0

package/dist-npm/contract/state-keys.d.ts

@@ -31,6 +31,9 @@ export declare const STATE: {
     readonly CHAT_IS_SENDING: "chat.isSending";
     readonly CHAT_MESSAGES: "chat.messages";
     readonly CHAT_COMPOSER_TEXT: "chat.composerText";
+    readonly CHAT_STAGED_ATTACHMENT: "chat.stagedAttachment";
+    readonly CHAT_ATTACHMENT_REJECTION: "chat.attachmentRejection";
+    readonly CHAT_IMAGE_UPLOAD_VISIBLE: "chat.imageUploadVisible";
     readonly CHAT_ANSWERED_INTERACTIVE_IDS: "chat.answeredInteractiveIds";
     readonly CHAT_PLAYBOOK_STEP_EXECUTING: "chat.playbookStepExecuting";
     readonly CHATTER_ALERT_SOUND_ENABLED: "chatter.alertSoundEnabled";

package/dist-npm/contract/types.d.ts

@@ -168,11 +168,30 @@ export interface VideoMessage extends BaseMessage {
     vidUrl: string;
     altText: string;
 }
+/** An image picked in the composer, awaiting the send that carries it. */
+export interface StagedAttachment {
+    /** Client-minted per pick; a result for a replaced or removed pick is dropped. */
+    id: string;
+    name: string;
+    mimeType: string;
+    size: number;
+    status: "uploading" | "ready";
+    /** Hosted URL, present once `status` is `ready`. */
+    url?: string;
+}
+/** A pick the composer could not stage, kept apart from `chat.stagedAttachment`
+ * so it never displaces a staged image. Replaced by the next pick. */
+export interface StagedAttachmentRejection {
+    id: string;
+    error: "unsupported_type" | "too_large" | "unavailable" | "upload_failed";
+}
 export interface DownloadableMessage extends BaseMessage {
     type: "downloadable";
     url: string;
     name: string;
     mimeType: string | null;
+    /** Text sent with the file, when the chatter typed a message alongside it. */
+    caption?: string;
 }
 export interface AgentInfo {
     name: string;
@@ -462,6 +481,16 @@ export interface AppDisplayState {
         text: string;
         revision: number;
     } | null;
+    /** The image the chatter picked for the next bot send. Hosted as soon as it is
+     * picked; the composer shows it as a chip until the send consumes it. Absent on
+     * a core document that predates image attachments. Core keeps the storage key
+     * to itself. */
+    "chat.stagedAttachment"?: StagedAttachment | null;
+    /** The most recent pick that could not be staged, beside whatever is staged. */
+    "chat.attachmentRejection"?: StagedAttachmentRejection | null;
+    /** The composer may offer the image attach control (flag, customer setting,
+     * bot conversation with a known id). Absent on an older core document. */
+    "chat.imageUploadVisible"?: boolean;
     /** Interactive blocks (quick replies, options) the chatter has already
      * answered. Includes blocks a later same-conversation user message
      * superseded, so the set survives a reload. Filter interactive rows on
@@ -732,6 +761,14 @@ export interface AppEvents {
     };
     "file.upload.cancel": undefined;
     "file.upload.errorDismiss": undefined;
+    /** Host the picked image for the next bot send. */
+    "chat.attachment.stage": {
+        file: File;
+    };
+    /** Drop the staged image named by `id`; ignored once another pick replaced it. */
+    "chat.attachment.remove": {
+        id: string;
+    };
     "file.upload.retry": {
         file: File;
         uploadId?: string;

package/dist-npm/npm/index.d.ts

@@ -11,6 +11,6 @@ export type { BridgeClient } from "../contract/bridge-client.js";
 export type { MessageGroupingEntry, UnreadSelection } from "../contract/derive.js";
 export type { BridgeClientDestroyedError, BridgeOperations, BridgeOperationsHost, CaptureHandle, CsatSubmitHandle, EndChatEligibilityResult, FileUploadHandle, ObserveOptions, OperationResult, SendHandle, SettleOptions, } from "../contract/operations.js";
 export type { StateKey } from "../contract/state-keys.js";
-export type { AppDisplayState, AppEvents, CaptureData, CsatMessage, CsatScaleType, DownloadableMessage, FallbackUiConfig, LinkMessage, ListSelectionData, LiveChatStateData, Message, NotificationPermissionMessage, OptionItem, OptionsMessage, PictureMessage, PresenceMessage, QueueBotBlockMessage, QuickRepliesMessage, QuickReply, SdkPlatform, SeamlessOAuthMessage, SelectableListItem, SelectableListMessage, SignInMessage, TextMessage, VideoMessage, WidgetMessage, } from "../contract/types.js";
+export type { AppDisplayState, AppEvents, CaptureData, CsatMessage, CsatScaleType, DownloadableMessage, FallbackUiConfig, LinkMessage, ListSelectionData, LiveChatStateData, Message, NotificationPermissionMessage, OptionItem, OptionsMessage, PictureMessage, PresenceMessage, QueueBotBlockMessage, QuickRepliesMessage, QuickReply, SdkPlatform, SeamlessOAuthMessage, SelectableListItem, SelectableListMessage, SignInMessage, StagedAttachment, StagedAttachmentRejection, TextMessage, VideoMessage, WidgetMessage, } from "../contract/types.js";
 export type { LoadMessagingBridgeOptions, MessagingBridgeLoadErrorCode, MessagingBridgeModule, } from "./loader.js";
 export { loadMessagingBridge, MessagingBridgeLoadError, resolveBridgeCdnUrl, } from "./loader.js";

package/dist-npm/shared-utils/file-upload.d.ts

@@ -21,6 +21,11 @@ export type FileUploadErrorReason =
 	| "timeout"
 	| "unsupported_platform"
 	| "upload_not_enabled";
+/** Size cap of the bot image attachment: api's `MAX_FILE_SIZE_BYTES_FOR_STORAGE_UPLOAD`. */
+export declare const IMAGE_ATTACHMENT_MAX_MB = 50;
+export declare const IMAGE_ATTACHMENT_MAX_BYTES: number;
+/** The image types api's attachments route accepts. */
+export declare const IMAGE_ATTACHMENT_MIME_TYPES: readonly string[];
 /** Typed bridge contract for file-upload failures shown to the chatter. */
 export interface FileUploadErrorData {
 	reason?: FileUploadErrorReason;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ada-cx/messaging-bridge",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"description": "Types, test mocks, and a thin CDN loader for building a custom app UI on Ada Messaging's bridge contract. The bridge runtime always loads from Ada's CDN.",
 	"type": "module",
 	"license": "ISC",