@ada-cx/messaging-bridge 1.12.0 → 1.13.0

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

@@ -109,13 +109,35 @@ export declare const STATE: {
     readonly SAML_LOCKED: "saml.locked";
     readonly SAML_URL: "saml.url";
     readonly SAML_LOGIN_BUTTON: "saml.loginButton";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_AUDIO_LEVEL: "voice.audioLevel";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_CURRENT_TRANSCRIPT: "voice.currentTranscript";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_ENABLED: "voice.enabled";
-    readonly VOICE_ERROR: "voice.error";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_IS_FINAL: "voice.isFinal";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_IS_RECORDING: "voice.isRecording";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_MODE: "voice.mode";
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     readonly VOICE_TTS_ENABLED: "voice.ttsEnabled";
+    readonly VOICE_AVAILABILITY: "voice.availability";
+    readonly VOICE_UNAVAILABLE_REASON: "voice.unavailableReason";
+    readonly VOICE_CONSENT_REQUIRED: "voice.consentRequired";
+    readonly VOICE_CALL_STATE: "voice.callState";
+    readonly VOICE_TURN: "voice.turn";
+    readonly VOICE_TURN_ID: "voice.turnId";
+    readonly VOICE_PENDING_REPLY_TURN_ID: "voice.pendingReplyTurnId";
+    readonly VOICE_SPOKEN_CHARS: "voice.spokenChars";
+    readonly VOICE_MUTED: "voice.muted";
+    readonly VOICE_INPUT_LEVEL: "voice.inputLevel";
+    readonly VOICE_CALL_STARTED_AT: "voice.callStartedAt";
+    readonly VOICE_AGENT_CAPTION: "voice.agentCaption";
+    readonly VOICE_USER_CAPTION: "voice.userCaption";
+    readonly VOICE_REJECTED_CAPTIONS: "voice.rejectedCaptions";
+    readonly VOICE_ERROR: "voice.error";
+    readonly VOICE_ENDED_REASON: "voice.endedReason";
 };
 export type StateKey = (typeof STATE)[keyof typeof STATE];

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

@@ -6,6 +6,32 @@ import type { CsatFeedbackOption, CsatSurveySettings, CustomAppFrameStyles, File
  * These types are the source of truth for the `@ada-cx/messaging-bridge`
  * package and must stay in sync with the AsyncAPI spec at asyncapi.yml.
  */
+export type VoiceAvailability = "unavailable" | "available";
+export type VoiceUnavailableReason = "not_enabled" | "delegation_missing" | "host_unsupported" | "mic_policy_blocked" | "unsupported" | "language_unsupported";
+export type VoiceCallState = "idle" | "requesting_permission" | "connecting" | "in_call" | "reconnecting" | "ended" | "error";
+export type VoiceTurn = "quiet" | "agent_speaking" | "user_speaking";
+export type VoiceErrorCode = "permission_denied" | "mic_policy_blocked" | "session_refused" | "connect_failed" | "disconnected" | "audio_blocked" | "unsupported" | "capture_failed" | (string & {});
+export type VoiceEndedReason = "client_end" | "idle_timeout" | "max_duration" | "grace_expired" | "handoff" | "voice_box_draining" | "resume_unavailable" | "error" | "voice_disabled" | "conversation_reset" | (string & {});
+export interface VoiceSpokenChars {
+    turnId: number;
+    chars: number;
+    playedMs: number;
+    scheduledMs: number;
+    finalReceived: boolean;
+    revision: number;
+}
+export interface VoiceCaption {
+    accepted?: boolean;
+    turnId?: number;
+    utteranceId?: string;
+    text: string;
+    final: boolean;
+}
+export interface VoiceError {
+    code: VoiceErrorCode;
+    message: string;
+    refusalCode?: string;
+}
 export interface FallbackUiLink {
     label: string;
     url: string;
@@ -84,6 +110,7 @@ export interface LiveChatStateData {
     timeoutAfterMs: string;
 }
 interface BaseMessage {
+    turnId?: number;
     id: string;
     sender: "user" | "bot" | "agent";
     timestamp: number;
@@ -348,7 +375,7 @@ export type SdkPlatform = "IOS" | "ANDROID" | "REACTNATIVE" | null;
  * - `error.*` — fatal error surface.
  * - `chatter.*` — end-user preferences: language, notifications, translations.
  * - `ui.*` — transient UI signals (typing indicators, dialogs, toasts).
- * - `voice.*` — Web Speech voice input/TTS state.
+ * - `voice.*` — Voice call state.
  * - `csat.*` / `endChat.*` — survey settings, eligibility, and End Chat gates.
  * - `security.*` — Turnstile challenge state.
  * - `featureFlags` — allowlisted LaunchDarkly values exposed to the app.
@@ -671,14 +698,36 @@ export interface AppDisplayState {
     "ui.botTyping.visible": boolean;
     "ui.showRetryDialog"?: boolean;
     "ui.retryDialog.pending"?: boolean;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
+    "voice.audioLevel"?: number;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
+    "voice.currentTranscript"?: string;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     "voice.enabled"?: boolean;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
+    "voice.isFinal"?: boolean;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     "voice.isRecording"?: boolean;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     "voice.mode"?: "toggle" | "push-to-talk";
-    "voice.currentTranscript"?: string;
-    "voice.isFinal"?: boolean;
-    "voice.audioLevel"?: number;
-    "voice.error"?: string | null;
+    /** @deprecated No-op alias retained for one release. Use the voice.callState contract. */
     "voice.ttsEnabled"?: boolean;
+    "voice.consentRequired"?: boolean;
+    "voice.availability"?: VoiceAvailability;
+    "voice.unavailableReason"?: VoiceUnavailableReason;
+    "voice.callState"?: VoiceCallState;
+    "voice.turn"?: VoiceTurn;
+    "voice.turnId"?: number | null;
+    "voice.pendingReplyTurnId"?: number | null;
+    "voice.spokenChars"?: VoiceSpokenChars | null;
+    "voice.muted"?: boolean;
+    "voice.inputLevel"?: number;
+    "voice.callStartedAt"?: number | null;
+    "voice.agentCaption"?: VoiceCaption | null;
+    "voice.userCaption"?: VoiceCaption | null;
+    "voice.rejectedCaptions"?: Record<string, VoiceCaption>;
+    "voice.error"?: string | VoiceError | null;
+    "voice.endedReason"?: VoiceEndedReason | null;
     "csat.autoTrigger"?: boolean;
     "csat.autoTriggerConversationId"?: string | null;
     "csat.showAfterEndChat"?: boolean;
@@ -746,7 +795,7 @@ export interface AppDisplayState {
  *   typing edges, visitor info.
  * - `zendesk.*` / `zendeskMessaging.*` — Zendesk handoff SDK control.
  * - `file.*` — handoff file-upload start/cancel/retry/error-dismiss.
- * - `voice.*` — voice recording, mode, transcript, and TTS control.
+ * - `voice.*` — Voice call controls.
  * - `ui.*` — widget chrome interactions (close, minimize, dialogs, toasts,
  *   viewport, composer-changed edge).
  * - `settings.*` / `appearance.*` — end-user preference changes.
@@ -888,17 +937,35 @@ export interface AppEvents {
         file: File;
         uploadId?: string;
     };
+    /** @deprecated No-op alias retained for one release. Use voice.call.* events. */
     "voice.recording.start": undefined;
+    /** @deprecated No-op alias retained for one release. Use voice.call.* events. */
     "voice.recording.stop": undefined;
+    /** @deprecated No-op alias retained for one release. Use voice.call.* events. */
     "voice.mode.set": {
         mode: "toggle" | "push-to-talk";
     };
+    /** @deprecated No-op alias retained for one release. Use voice.call.* events. */
     "voice.transcript.apply": {
         transcript: string;
     };
+    /** @deprecated No-op alias retained for one release. Use voice.call.* events. */
     "voice.tts.toggle": {
         enabled: boolean;
     };
+    "voice.consent.accept": undefined;
+    "voice.consent.decline": undefined;
+    "voice.call.start": undefined;
+    "voice.call.end": undefined;
+    "voice.call.mute": {
+        muted: boolean;
+    };
+    "voice.call.audio.start": undefined;
+    "voice.call.interrupt": undefined;
+    "voice.text.rendered": {
+        turnId: number;
+        length: number;
+    };
     "ui.closeButton.click": undefined;
     "ui.minimizeButton.click": undefined;
     "ui.drawer.dismiss": undefined;

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

@@ -27,17 +27,11 @@ export declare const IMAGE_ATTACHMENT_MAX_BYTES: number;
 /**
  * How many images one send may carry.
  *
- * Not an api limit on this path. `MAX_DESCRIBED_IMAGE_ATTACHMENTS` is read in
- * one api runtime site, `resolve_email_image_attachments_suffix`, which is the
- * email channel; the bot path posts one `downloadable` per image and describes
- * each through `resolve_uploaded_file_message_body`, which caps nothing. api
- * also never reads `attachment_group_id` outside analytics, so it cannot batch
- * a group into one describe budget. A fourth image would be hosted, rendered
- * *and* described — in its own reasoner turn.
- *
- * So the cap is a product decision about that cost, not a ceiling api imposes:
- * each extra image buys another bot turn and another describe call. Match it to
- * `MAX_DESCRIBED_IMAGE_ATTACHMENTS` by coincidence of value only.
+ * api answers one send in one reasoner turn and describes at most
+ * `MAX_DESCRIBED_IMAGE_ATTACHMENTS` of its images there. It holds at most
+ * `MAX_HELD_ROWS` rows besides the final row, so a fourth image would start
+ * a turn of its own. Keep this value equal to `MAX_DESCRIBED_IMAGE_ATTACHMENTS`
+ * (3) and to `MAX_HELD_ROWS` plus the final row (2 + 1).
  */
 export declare const IMAGE_ATTACHMENT_MAX_COUNT = 3;
 /** The image types api's attachments route accepts; HEIC/HEIF are transcoded to JPEG there. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ada-cx/messaging-bridge",
-	"version": "1.12.0",
+	"version": "1.13.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",