@microsoft/omnichannel-chat-sdk 2.0.2 → 2.1.0-main.8f375cf

package/README.md

@@ -35,6 +35,7 @@ Please make sure you have a chat widget configured before using this package or
   - [Send Messages](#send-messages)
   - [On New Message](#on-new-message)
   - [On Streaming Message](#on-streaming-message)
+  - [On Chat Token Renewed](#on-chat-token-renewed)
   - [On Typing Event](#on-typing-event)
   - [On Agent End Session](#on-agent-end-session)
   - [Send Typing Event](#send-typing-event)
@@ -516,6 +517,26 @@ await chatSDK.onStreamingMessage((message) => {
 
 Calling this method before `startChat()` throws `UninitializedConversation`. If the conversation does not use ACS, this method throws `UnsupportedLiveChatVersion`.
 
+### On Chat Token Renewed
+
+Subscribes to notifications after the SDK renews the chat token and updates the current live chat context.
+If your application caches this context for page refresh or reconnect, save the updated context in the callback
+so subsequent restores use the renewed credentials.
+
+Register before `startChat()` to capture renewals during startup, including when restoring a saved chat.
+
+```ts
+const unsubscribe = chatSDK.onChatTokenRenewed(async () => {
+    const liveChatContext = await chatSDK.getCurrentLiveChatContext();
+    cache.saveChatContext(liveChatContext); // Custom logic to save chat context to cache
+});
+
+await chatSDK.startChat();
+```
+
+The listener remains registered across chats on the same SDK instance; call `unsubscribe()` during cleanup.
+Token renewal works without a subscription.
+
 ### On Typing Event
 
 It subscribes to an agent typing event.

package/lib/OmnichannelChatSDK.d.ts

@@ -57,6 +57,8 @@ declare class OmnichannelChatSDK {
     private coreServicesOrgUrl;
     private dynamicsLocationCode;
     private chatToken;
+    private chatTokenUnauthorizedRecovery;
+    private chatTokenRenewedListeners;
     private liveChatConfig;
     private widgetSnippetBaseUrl;
     private liveChatVersion;
@@ -77,6 +79,7 @@ declare class OmnichannelChatSDK {
     private isPersistentChat;
     private isChatReconnect;
     private reconnectId;
+    private endedChatSessionKey;
     private refreshTokenTimer;
     private AMSClientLoadCurrentState;
     private isMaskingDisabled;
@@ -155,6 +158,15 @@ declare class OmnichannelChatSDK {
     private waitForMessageTags;
     private waitForSurveyStart;
     private waitForConversationalSurveyEnd;
+    /**
+     * Subscribes to usable chat token renewals after the current SDK context has been updated.
+     * No token or other payload is passed. Read getCurrentLiveChatContext() to persist the updated context.
+     * Returns an idempotent unsubscribe function. Listener failures never affect renewal.
+     * Subscriptions belong to this SDK instance and survive endChat()/startChat().
+     * Subscribe before startChat() to observe restoration renewals; past notifications are not replayed.
+     * Unsubscribe on host teardown or before replacing a per-chat subscription.
+     */
+    onChatTokenRenewed(listener: () => void): () => void;
     getCurrentLiveChatContext(): Promise<GetCurrentLiveChatContextResponse>;
     getConversationDetails(optionalParams?: GetConversationDetailsOptionalParams): Promise<LiveWorkItemDetails>;
     /**
@@ -165,6 +177,31 @@ declare class OmnichannelChatSDK {
     getLiveChatConfig(optionalParams?: GetLiveChatConfigOptionalParams): Promise<ChatConfig>;
     getChatToken(cached?: boolean, optionalParams?: GetChatTokenOptionalParams): Promise<IChatToken>;
     setChatToken(chatToken: FetchChatTokenResponse): void;
+    /**
+     * Creates the ACS token refresher used to renew the chat token before it expires. Returns undefined, which keeps
+     * the existing behavior, unless renewal is enabled in the chat config, not disabled in the SDK config and
+     * supported by the installed OCSDK. The refresher never throws and falls back to the current token on failure.
+     */
+    private createChatTokenRefresher;
+    private notifyChatTokenRenewed;
+    /**
+     * Gives the renewed chat token to the attachment client, which keeps the token it was initialized with and uses
+     * it for every upload and download. Runs in the background and never throws: on failure, attachments keep using
+     * the previous token as they did before renewal existed.
+     */
+    private refreshAttachmentClientToken;
+    /**
+     * Creates the recovery for chat requests that fail with 401 while the chat token has not
+     * expired. Returns null, which keeps the existing behavior, unless chat token renewal is enabled and recovery is
+     * not disabled in the SDK config.
+     */
+    private createChatTokenUnauthorizedRecovery;
+    /**
+     * Returns the token of the authenticated user to renew the chat token with, refreshed from the auth token
+     * provider when possible because the token used to start the chat may have expired. Returns undefined for
+     * unauthenticated chats.
+     */
+    private getAuthenticatedUserTokenForChatTokenRenewal;
     getCallingToken(): Promise<string>;
     private recordMessages;
     getMessages(): Promise<GetMessagesResponse>;
@@ -208,6 +245,15 @@ declare class OmnichannelChatSDK {
     downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
     emailLiveChatTranscript(body: ChatTranscriptBody, optionalParams?: EmailLiveChatTranscriptOptionaParams): Promise<void>;
     getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<GetLiveChatTranscriptResponse>;
+    /**
+     * Returns the ended chat's session key when the call targets that chat, or null.
+     */
+    private getEndedChatSessionKey;
+    /**
+     * Sends the session key on one OCSDK request without leaving it on the shared client. OCSDK copies the
+     * key into the request headers before its first await, so the previous key is restored before the HTTP wait.
+     */
+    private withRequestSessionKey;
     createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<ChatAdapter>;
     isVoiceVideoCallingEnabled(): boolean;
     getVoiceVideoCalling(voiceVideoCallingOptionalParams?: VoiceVideoCallingOptionalParams): Promise<GetVoiceVideoCallingResponse>;