@origonai/web-sdk 0.1.1 → 0.1.3

package/README.md

@@ -41,7 +41,7 @@ client.setCallbacks({
 
 const { sessionId } = await client.startSession({ channel: 'chat' })
 
-await client.sendMessage(sessionId, { text: 'Hello!' }) // audience defaults to all
+await client.sendMessage(sessionId, { text: 'Hello!' }) // participant server defaults audience to all
 
 client.notifyTyping(sessionId)   // call on each keystroke; SDK debounces
 
@@ -68,8 +68,8 @@ await client.endSession(sessionId)
 - `getSession(sessionId)` — GET `/session/{id}` (transcript + control)
 
 ### Chat
-- `sendMessage(sessionId, payload)` — post a message with optional `metadata: {audience}`; ordinary sends default to `all`. The SDK fires `onMessageAdded` immediately with `status: 'sending'`, then `onMessageUpdated` with `'delivered'` or `'failed'` after the server acks
-- `notifyTyping(sessionId, metadata?)` — call on each keystroke; ordinary typing defaults to `all`, and the SDK debounces (3s window) and emits typing on/off automatically
+- `sendMessage(sessionId, payload)` — post a message with optional `metadata: {audience}`; ordinary participant sends omit it and the server resolves the audience to `all`. The SDK fires `onMessageAdded` immediately with `status: 'sending'`, then `onMessageUpdated` with `'delivered'` or `'failed'` after the server acks
+- `notifyTyping(sessionId, metadata?)` — call on each keystroke; ordinary participant typing omits metadata, and the SDK debounces (3s window) and emits typing on/off automatically
 - `stopTyping(sessionId)` — flush typing-off immediately
 
 ### Attachments
@@ -130,10 +130,13 @@ consumer can host multiple sessions.
 The outbound `payload.role` is a local-only hint for the provisional
 `onMessageAdded` row; it's stripped before POST.
 
-Every message has required `metadata: { audience: 'internal' | 'all' }`.
-Missing or unknown wire metadata is a protocol failure, not a compatibility
-default. Typing callbacks carry the same required audience plus participant
-identity; watchdogs are isolated by `participantId`.
+Message metadata is optional at both levels:
+`metadata?: { audience?: 'internal' | 'all' }`. Missing/null containers remain
+absent, while an explicitly present empty object remains `{}`; unknown
+non-empty audiences are protocol failures. A
+monitor client must always send an explicit known audience even though the
+shared SDK type is optional. Typing callbacks retain required audience plus
+participant identity; watchdogs are isolated by `participantId`.
 
 ## Errors
 
@@ -172,6 +175,7 @@ client.initialize({
 
 const { sessionId } = await client.startSession({ channel: 'voice' })
 await client.setMute(sessionId, 'uplink')   // 'uplink' | 'downlink' | 'both' | 'none'
+await client.sendDtmf(sessionId, '5')       // one of 0-9, *, #, A-D
 
 const off = client.subscribeAudioStats(sessionId, ({ outboundLevel, inboundLevel }) => {
   // VU meters at ~5 Hz
@@ -189,6 +193,11 @@ Voice requires:
 
 The browser opens a single WebTransport to `<media-server>/web`, sends a B2BUA `Connect` over the control sub-stream, and pumps 20 ms Opus frames as `ObjectDatagram`s with `group_id = floor(Date.now()/1000) - serverEpochUnix`. Reconnect is Tier-3 only (`Resume` verb) with `[100, 250, 500, 1000]` ms backoff.
 
+`sendDtmf` resolves when Media acknowledges publication to the active CX flow.
+It rejects while the voice transport is reconnecting and is never queued or
+replayed after `Resume`. The SDK does not play a local tone or expose a peer
+DTMF callback.
+
 ## Joining a provisioned session
 
 `startSession` originates a session by calling `POST /session/start` itself.

package/dist/index.d.ts

@@ -39,7 +39,7 @@ export declare interface AudioWorkletStats {
 
 export declare type Channel = 'chat' | 'voice';
 
-/** Audience carried explicitly on every live-monitoring message/typing frame. */
+/** Closed audience vocabulary; the field holding it may be absent. */
 export declare type ChatAudience = 'internal' | 'all';
 
 export declare class ClientError extends Error {
@@ -150,6 +150,9 @@ export declare type DisconnectReason = {
     detail: string;
 };
 
+/** Complete programmatic DTMF alphabet; lowercase is intentionally invalid. */
+export declare type DtmfDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '*' | '#' | 'A' | 'B' | 'C' | 'D';
+
 export declare function getSessionManager(): SessionManager;
 
 /**
@@ -189,7 +192,7 @@ export declare interface Message {
     errorText?: string;
     status: MessageStatus;
     state: MessageState;
-    metadata: MessageMetadata;
+    metadata?: MessageMetadata;
     /**
      * Lifecycle action for a `role:'system'` message — `'queued' | 'joined' |
      * 'ended'` (kept an open `string`: the server may add more; a distinct
@@ -244,7 +247,7 @@ export declare interface MessageCard {
 }
 
 export declare interface MessageMetadata {
-    audience: ChatAudience;
+    audience?: ChatAudience;
 }
 
 export declare type MessageRole = 'ai' | 'external' | 'user' | 'system';
@@ -358,7 +361,7 @@ export declare interface SendMessagePayload {
     text?: string;
     html?: string;
     attachments?: Attachment[];
-    /** Defaults to `{ audience: 'all' }` for ordinary visitor compatibility. */
+    /** Optional for participant callers; monitor callers must supply an audience. */
     metadata?: MessageMetadata;
     /**
      * Local-only hint for the provisional `onMessageAdded` role. Defaults to
@@ -457,6 +460,8 @@ export declare class SessionManager {
     notifyTyping(sessionId: string, metadata?: TypingMetadata): void;
     stopTyping(sessionId: string): void;
     setMute(sessionId: string, scope: MuteScope): Promise<void>;
+    /** Send one DTMF symbol to the active CX flow for a voice session. */
+    sendDtmf(sessionId: string, digit: DtmfDigit): Promise<void>;
     /** Enable microphone coaching on a receive-only voice join. */
     enableCapture(sessionId: string): Promise<void>;
     /** Return a coaching voice join to Listen and release its microphone. */