@microsoft/omnichannel-chat-sdk 1.11.9-main.e5288e0 → 2.0.0-main.b82e941

package/README.md

@@ -5,9 +5,9 @@
 ![Release CI](https://github.com/microsoft/omnichannel-chat-sdk/workflows/Release%20CI/badge.svg)
 ![npm](https://img.shields.io/npm/dm/@microsoft/omnichannel-chat-sdk)
 
-> ❗ We recommend using official release versions in production as listed [here](#releases). Support will be provided only on official versions.
-
-> 📢 Try out our new React component library [omnichannel-chat-widget](https://github.com/microsoft/omnichannel-chat-widget) with Chat SDK
+> [!IMPORTANT]
+> * We recommend using official release versions in production as listed [here](#releases). Support will be provided only on official versions.
+> * Microsoft provides this SDK to ensure a scaleable and secure use of our platform. Do not directly access the APIs used in this repository — you may experience breaking changes, and we will not be able to provide support for any issues.
 
 Headless Chat SDK to build your own chat widget against Dynamics 365 Omnichannel Services.
 
@@ -45,6 +45,8 @@ Please make sure you have a chat widget configured before using this package or
   - [Get Voice & Video Calling](#get-voice--video-calling)
   - [Get Post Chat Survey Context](#get-post-chat-survey-context)
   - [Get Persistent Chat History](#get-persistent-chat-history)
+  - [Send Read Receipt](#send-read-receipt)
+  - [Get Unread Message Count](#get-unread-message-count)
 - [Common Scenarios](#common-scenarios)
   - [Using BotFramework-WebChat](#using-botframework-webchat)
   - [Escalation to Voice & Video](#escalation-to-voice--video)
@@ -56,7 +58,7 @@ Please make sure you have a chat widget configured before using this package or
   - [Persistent Chat History](#persistent-chat-history)
   - [Chat Reconnect with Authenticated User](#chat-reconnect-with-authenticated-user)
   - [Chat Reconnect with Unauthenticated User](#chat-reconnect-with-unauthenticated-user)
-  - [Best Practices for Chat Session Management: Handling Disconnections and Network Instabilit(#best-practices-for-chat-session-management:-handling-disconnections-and-network-instability)
+  - [Best Practices for Chat Session Management: Handling Disconnections and Network Instability](#best-practices-for-chat-session-management-handling-disconnections-and-network-instability)
   - [Operating Hours](#operating-hours)
   - [Single Sign-on for Bots](/docs/scenarios/SINGLE_SIGN_ON_FOR_BOTS.md)
 - [Sample Apps](https://github.com/microsoft/omnichannel-chat-sdk-samples)
@@ -106,9 +108,9 @@ Omnichannel offers a live chat widget (LCW) by default. You can use the Chat SDK
 
 New releases are published on a regular basis to ensure the product quality.
 
-for a detailed tracking of the releases, please refer to the [Changelog document](https://github.com/microsoft/omnichannel-chat-sdk/blob/main/CHANGELOG.md)
+For a detailed tracking of the releases, please refer to the [Changelog document](https://github.com/microsoft/omnichannel-chat-sdk/blob/main/CHANGELOG.md)
 
-_**Important Note:**_ Versions below 1.11.0 will not be supported after November 1st, 2025. Please update to recent versions to ensure you have the latest features and bug fixes.
+_**Important Note:**_ Versions below 1.11.0 are no longer supported after November 1st, 2025. Please update to recent versions to ensure you have the latest features and bug fixes.
 
 
 | Version | Docs | Release Date | End of Support | Deprecated |
@@ -607,6 +609,25 @@ It gets information on whether a queue is available, and whether there are agent
 const agentAvailability = await chatSDK.getAgentAvailability();
 ```
 
+### Send Read Receipt
+
+Logs a particular message (and all previous messages) as read by the user. Read indicators will appear for Contact Center Representatives and Admins in the Admin Center.
+
+```ts
+await chatSDK.sendReadReceipt(messageId: string);
+```
+
+### Get Unread Message Count
+
+Returns the number of unread messages in an authenticated persistent conversation. This call is **authenticated-only** — the user must be authenticated, otherwise an `UndefinedAuthToken` error is thrown.
+
+```ts
+const response = await chatSDK.getUnreadMessageCount();
+
+// response.unreadMessageCount: number — Number of unread messages in the conversation
+// response.mostRecentUnreadMessage: object | null — The most recent unread message, or null if there are none
+```
+
 ## Common Scenarios
 
 ### Pre-Chat Survey

package/lib/OmnichannelChatSDK.d.ts

@@ -30,7 +30,9 @@ import InitializeOptionalParams from "./core/InitializeOptionalParams";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
 import OmnichannelConfig from "./core/OmnichannelConfig";
 import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
+import OmnichannelStreamingMessage from "./core/messaging/OmnichannelStreamingMessage";
 import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
+import OnStreamingMessageOptionalParams from "./core/messaging/OnStreamingMessageOptionalParams";
 import PostChatContext from "./core/PostChatContext";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
 declare class OmnichannelChatSDK {
@@ -171,7 +173,36 @@ declare class OmnichannelChatSDK {
     sendMessage(message: ChatSDKMessage): Promise<OmnichannelMessage | void>;
     onNewMessage(onNewMessageCallback: CallableFunction, optionalParams?: OnNewMessageOptionalParams): Promise<void>;
     sendTypingEvent(): Promise<void>;
+    /**
+     * Fetches unread message count for the authenticated user.
+     * Auth-only — does not require an active chat session.
+     */
+    getUnreadMessageCount(): Promise<object>;
+    /**
+     * Sends a read receipt for a specific message.
+     * Authenticated: calls MRT (updates NRD + forwards to ACS).
+     * Unauthenticated: calls ACS directly.
+     */
+    sendReadReceipt(messageId: string): Promise<void>;
     onTypingEvent(onTypingEventCallback: CallableFunction): Promise<void>;
+    /**
+     * Subscribes to ACS-driven streaming message chunks for progressive bot message rendering.
+     * Each chunk contains the full assembled text so far (not just the delta).
+     * Existing onNewMessage consumers continue receiving final messages without changes.
+     *
+     * Available only in LiveChatVersion.V2. Must call startChat() before registering.
+     *
+     * @param onStreamingMessageCallback - Called for each streaming chunk
+     * @param optionalParams - Reserved for future configuration
+     * @example
+     * chatSDK.onStreamingMessage((message) => {
+     *     switch (message.streamingMetadata.streamingMessageType) {
+     *         case "streaming": // Update bubble with message.content
+     *         case "final":     // Stream complete
+     *     }
+     * });
+     */
+    onStreamingMessage(onStreamingMessageCallback: (message: OmnichannelStreamingMessage) => void, optionalParams?: OnStreamingMessageOptionalParams): Promise<void>;
     onAgentEndSession(onAgentEndSessionCallback: (message: IRawThread | ParticipantsRemovedEvent) => void): Promise<void>;
     uploadFileAttachment(fileInfo: IFileInfo | File): Promise<UploadFileAttachmentResponse>;
     downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
@@ -198,6 +229,13 @@ declare class OmnichannelChatSDK {
     private setCallingOptionConfiguration;
     private setLiveChatVersionConfiguration;
     private setWidgetSnippetBaseUrl;
+    /**
+     * Creates diagnostic data for getChatConfig errors using the error classifier
+     * @param e The error object
+     * @param clientElapsedMs Optional elapsed time in milliseconds from client's perspective
+     * @returns Diagnostic data with clientElapsedMs, online status, and cancellation reason
+     */
+    private createGetChatConfigDiagnosticData;
     private getChatConfig;
     private buildConfigurations;
     private resolveIC3ClientUrl;