@microsoft/omnichannel-chat-sdk 2.0.2-main.07ad838 → 2.0.2-main.355218f

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

@@ -58,6 +58,7 @@ declare class OmnichannelChatSDK {
     private dynamicsLocationCode;
     private chatToken;
     private chatTokenUnauthorizedRecovery;
+    private chatTokenRenewedListeners;
     private liveChatConfig;
     private widgetSnippetBaseUrl;
     private liveChatVersion;
@@ -157,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>;
     /**
@@ -173,6 +183,7 @@ declare class OmnichannelChatSDK {
      * 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

package/lib/OmnichannelChatSDK.js

@@ -128,6 +128,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.coreServicesOrgUrl = null;
         this.dynamicsLocationCode = null;
         this.chatTokenUnauthorizedRecovery = null;
+        this.chatTokenRenewedListeners = new Set();
         this.widgetSnippetBaseUrl = '';
         this.dataMaskingRules = { rules: [] };
         this.authSettings = null;
@@ -1567,6 +1568,20 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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.
+     */
+    OmnichannelChatSDK.prototype.onChatTokenRenewed = function (listener) {
+        var _this = this;
+        var subscription = function () { return listener(); };
+        this.chatTokenRenewedListeners.add(subscription);
+        return function () { _this.chatTokenRenewedListeners.delete(subscription); };
+    };
     OmnichannelChatSDK.prototype.getCurrentLiveChatContext = function () {
         return __awaiter(this, void 0, void 0, function () {
             var chatToken, requestId, chatSession;
@@ -1865,6 +1880,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                     var _a;
                     _this.chatToken = __assign(__assign({}, _this.chatToken), { token: renewed.Token, expiresIn: renewed.ExpiresIn !== undefined && renewed.ExpiresIn !== null ? String(renewed.ExpiresIn) : _this.chatToken.expiresIn, voiceVideoCallToken: (_a = renewed.VoiceVideoCallToken) !== null && _a !== void 0 ? _a : _this.chatToken.voiceVideoCallToken });
                     _this.refreshAttachmentClientToken(chatId_1);
+                    _this.notifyChatTokenRenewed(requestId_1, chatId_1);
                 },
                 onStart: function () { return _this.scenarioMarker.startScenario(TelemetryEvent_1.default.RenewChatToken, telemetryData_1); },
                 onSuccess: function () { return _this.scenarioMarker.completeScenario(TelemetryEvent_1.default.RenewChatToken, telemetryData_1); },
@@ -1881,6 +1897,32 @@ var OmnichannelChatSDK = /** @class */ (function () {
             return undefined;
         }
     };
+    OmnichannelChatSDK.prototype.notifyChatTokenRenewed = function (requestId, chatId) {
+        var _this = this;
+        var reportFailure = function (response) {
+            try {
+                var telemetryData = { RequestId: requestId, ChatId: chatId };
+                _this.scenarioMarker.startScenario(TelemetryEvent_1.default.ChatTokenRenewedListener, telemetryData);
+                _this.scenarioMarker.failScenario(TelemetryEvent_1.default.ChatTokenRenewedListener, __assign(__assign({}, telemetryData), { ExceptionDetails: JSON.stringify({ response: response }) }));
+            }
+            catch (_a) {
+                // Subscriber telemetry must not affect renewal or become an unhandled rejection.
+            }
+        };
+        Array.from(this.chatTokenRenewedListeners).forEach(function (listener) {
+            var _a;
+            if (_this.isEndingChat || _this.requestId !== requestId || ((_a = _this.chatToken) === null || _a === void 0 ? void 0 : _a.chatId) !== chatId
+                || !_this.chatTokenRenewedListeners.has(listener)) {
+                return;
+            }
+            try {
+                Promise.resolve(listener()).catch(function () { return reportFailure("ListenerRejected"); });
+            }
+            catch (_b) {
+                reportFailure("ListenerThrew");
+            }
+        });
+    };
     /**
      * 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