@microsoft/omnichannel-chat-sdk 2.0.1 → 2.0.2-main.c0f210d

package/README.md

@@ -113,10 +113,14 @@ For a detailed tracking of the releases, please refer to the [Changelog document
 
 _**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.
 
+_**Known issue:**_ Versions earlier than 1.11.6 can start duplicate conversations when an application calls `startChat()` again before the previous call is complete. Upgrade to 1.11.8 or later. See [Concurrent `startChat()` calls in versions before 1.11.6](docs/KNOWN_ISSUE_CONCURRENT_STARTCHAT.md).
+
 | Version | Docs | Release Date | End of Support | Deprecated |
 | -- | -- | -- | -- | -- |
+| 2.0.2 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v2.0.2) | Oct 20th 2026 | Oct 20th 2027 | |
 | 2.0.1 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v2.0.1) | Oct 1st 2026 | Oct 1st 2027 | |
 | 2.0.0 | [Migration Guide](docs/MIGRATION_2.0.md) / [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v2.0.0) | Aug 13th 2026 | Aug 13th 2027 | |
+| 1.11.8 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v1.11.8) | Feb 2nd 2026 | Feb 2nd 2027 | |
 | 1.11.4 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v1.11.4) | Jul 17th 2025 | Jul 17th 2026 | |
 | 1.11.3 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v1.11.3) | Jul 14th 2025 | Jul 14th 2026 | |
 | 1.11.2 | [Release Notes](https://github.com/microsoft/omnichannel-chat-sdk/releases/tag/v1.11.2) | Jun 24th 2025 | Jun 24th 2026 | |

package/lib/OmnichannelChatSDK.d.ts

@@ -165,6 +165,24 @@ 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;
+    /**
+     * 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;
+    /**
+     * 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>;

package/lib/OmnichannelChatSDK.js

@@ -103,6 +103,7 @@ var location_1 = require("./utils/location");
 var internalUtils_1 = require("./utils/internalUtils");
 var loggerUtils_1 = require("./utils/loggerUtils");
 var parsers_1 = require("./utils/parsers");
+var chatTokenRenewal_1 = require("./utils/chatTokenRenewal");
 var platform_1 = require("./utils/platform");
 var retrieveCollectorUri_1 = require("./telemetry/retrieveCollectorUri");
 var startPolling_1 = require("./commands/startPolling");
@@ -1116,6 +1117,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                         return [4 /*yield*/, ((_c = this.ACSClient) === null || _c === void 0 ? void 0 : _c.initialize({
                                                 token: chatAdapterConfig.token,
                                                 environmentUrl: chatAdapterConfig.environmentUrl,
+                                                tokenRefresher: this.createChatTokenRefresher(chatAdapterConfig.token)
                                             }))];
                                     case 2:
                                         _e.sent();
@@ -1790,6 +1792,145 @@ var OmnichannelChatSDK = /** @class */ (function () {
             this.sessionId = this.OCClient.sessionId;
         }
     };
+    /**
+     * 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.
+     */
+    OmnichannelChatSDK.prototype.createChatTokenRefresher = function (initialToken) {
+        var _this = this;
+        var _a, _b, _c, _d, _e, _f;
+        try {
+            if (this.liveChatVersion !== LiveChatVersion_1.default.V2
+                || ((_b = (_a = this.chatSDKConfig) === null || _a === void 0 ? void 0 : _a.chatTokenRenewal) === null || _b === void 0 ? void 0 : _b.disable) === true
+                || (0, parsers_1.parseLowerCaseString)((_d = (_c = this.liveChatConfig) === null || _c === void 0 ? void 0 : _c.LcwFcbConfiguration) === null || _d === void 0 ? void 0 : _d.lcwChatTokenRenewalEnabled) !== "true"
+                || typeof ((_e = this.OCClient) === null || _e === void 0 ? void 0 : _e.renewChatToken) !== "function"
+                || !initialToken
+                || !((_f = this.chatToken) === null || _f === void 0 ? void 0 : _f.chatId)
+                || !this.requestId) {
+                return undefined;
+            }
+            var chatId_1 = this.chatToken.chatId;
+            var requestId_1 = this.requestId;
+            // A reconnected chat is found by its reconnect id, not by the new request id
+            var renewalId_1 = this.reconnectId || requestId_1;
+            var telemetryData_1 = {
+                RequestId: requestId_1,
+                ChatId: chatId_1
+            };
+            return (0, chatTokenRenewal_1.createChatTokenRefresher)({
+                initialToken: initialToken,
+                chatId: chatId_1,
+                isChatActive: function () { var _a; return !_this.isEndingChat && _this.requestId === requestId_1 && ((_a = _this.chatToken) === null || _a === void 0 ? void 0 : _a.chatId) === chatId_1; },
+                renewChatToken: function () { return __awaiter(_this, void 0, void 0, function () {
+                    var renewChatTokenOptionalParams, authenticatedUserToken;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                renewChatTokenOptionalParams = {};
+                                return [4 /*yield*/, this.getAuthenticatedUserTokenForChatTokenRenewal()];
+                            case 1:
+                                authenticatedUserToken = _a.sent();
+                                if (authenticatedUserToken) {
+                                    renewChatTokenOptionalParams.authenticatedUserToken = authenticatedUserToken;
+                                }
+                                return [2 /*return*/, this.OCClient.renewChatToken(renewalId_1, renewChatTokenOptionalParams)];
+                        }
+                    });
+                }); },
+                isNonRetriableStatus: function (statusCode) { return (_this.authenticatedUserToken ? chatTokenRenewal_1.authenticatedNonRetriableStatusCodes : chatTokenRenewal_1.defaultNonRetriableStatusCodes).includes(statusCode); },
+                onRenewed: function (renewed) {
+                    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);
+                },
+                onStart: function () { return _this.scenarioMarker.startScenario(TelemetryEvent_1.default.RenewChatToken, telemetryData_1); },
+                onSuccess: function () { return _this.scenarioMarker.completeScenario(TelemetryEvent_1.default.RenewChatToken, telemetryData_1); },
+                onFailure: function (reason, error) {
+                    var exceptionDetails = {
+                        response: reason,
+                        errorObject: error !== undefined ? "".concat(error) : undefined
+                    };
+                    _this.scenarioMarker.failScenario(TelemetryEvent_1.default.RenewChatToken, __assign(__assign({}, telemetryData_1), { ExceptionDetails: JSON.stringify(exceptionDetails) }));
+                }
+            });
+        }
+        catch (_g) {
+            return undefined;
+        }
+    };
+    /**
+     * 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.
+     */
+    OmnichannelChatSDK.prototype.refreshAttachmentClientToken = function (chatId) {
+        var _this = this;
+        try {
+            var amsClient_1 = this.AMSClient;
+            var chatToken_1 = this.chatToken;
+            if (!this.isAMSClientAllowed
+                || this.AMSClientLoadCurrentState !== AMSClientLoadStates_1.AMSClientLoadStates.LOADED
+                || !amsClient_1
+                || typeof amsClient_1.initialize !== "function"
+                || (chatToken_1 === null || chatToken_1 === void 0 ? void 0 : chatToken_1.chatId) !== chatId
+                || !chatToken_1.token) {
+                return;
+            }
+            var telemetryData_2 = {
+                RequestId: this.requestId,
+                ChatId: chatId
+            };
+            this.scenarioMarker.startScenario(TelemetryEvent_1.default.RefreshAttachmentClientToken, telemetryData_2);
+            Promise.resolve()
+                .then(function () { return amsClient_1.initialize({ chatToken: chatToken_1 }); })
+                .then(function () {
+                _this.scenarioMarker.completeScenario(TelemetryEvent_1.default.RefreshAttachmentClientToken, telemetryData_2);
+            }, function (error) {
+                _this.scenarioMarker.failScenario(TelemetryEvent_1.default.RefreshAttachmentClientToken, __assign(__assign({}, telemetryData_2), { ExceptionDetails: JSON.stringify({ errorObject: "".concat(error) }) }));
+            })
+                .catch(function () {
+                // Telemetry failures must not surface
+            });
+        }
+        catch (_a) {
+            // Attachments keep using the previous token
+        }
+    };
+    /**
+     * 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.
+     */
+    OmnichannelChatSDK.prototype.getAuthenticatedUserTokenForChatTokenRenewal = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var token, _a;
+            var _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!this.authenticatedUserToken) {
+                            return [2 /*return*/, undefined];
+                        }
+                        if (!(typeof ((_b = this.chatSDKConfig) === null || _b === void 0 ? void 0 : _b.getAuthToken) === "function")) return [3 /*break*/, 4];
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.chatSDKConfig.getAuthToken()];
+                    case 2:
+                        token = _c.sent();
+                        if (typeof token === "string" && token.trim().length > 0) {
+                            return [2 /*return*/, token];
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        _a = _c.sent();
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/, this.authenticatedUserToken];
+                }
+            });
+        });
+    };
     OmnichannelChatSDK.prototype.getCallingToken = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {