@microsoft/omnichannel-chat-sdk 2.0.2-main.6b3547d → 2.0.2-main.a1ba517

package/lib/OmnichannelChatSDK.d.ts

@@ -57,6 +57,7 @@ declare class OmnichannelChatSDK {
     private coreServicesOrgUrl;
     private dynamicsLocationCode;
     private chatToken;
+    private chatTokenUnauthorizedRecovery;
     private liveChatConfig;
     private widgetSnippetBaseUrl;
     private liveChatVersion;
@@ -165,6 +166,30 @@ 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;
+    /**
+     * 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>;

package/lib/OmnichannelChatSDK.js

@@ -103,6 +103,8 @@ 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 chatTokenUnauthorizedRecovery_1 = require("./utils/chatTokenUnauthorizedRecovery");
+var chatTokenRenewal_1 = require("./utils/chatTokenRenewal");
 var platform_1 = require("./utils/platform");
 var retrieveCollectorUri_1 = require("./telemetry/retrieveCollectorUri");
 var startPolling_1 = require("./commands/startPolling");
@@ -125,6 +127,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.unqServicesOrgUrl = null;
         this.coreServicesOrgUrl = null;
         this.dynamicsLocationCode = null;
+        this.chatTokenUnauthorizedRecovery = null;
         this.widgetSnippetBaseUrl = '';
         this.dataMaskingRules = { rules: [] };
         this.authSettings = null;
@@ -1097,10 +1100,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             });
                         }); };
                         messagingClientPromise = function () { return __awaiter(_this, void 0, void 0, function () {
-                            var chatAdapterConfig, error_8, telemetryData, _a, error_9, telemetryData, error_10, telemetryData, _b, error_11, telemetryData;
-                            var _c, _d;
-                            return __generator(this, function (_e) {
-                                switch (_e.label) {
+                            var chatAdapterConfig, tokenRefresher, error_8, telemetryData, _a, error_9, telemetryData, error_10, telemetryData, _b, error_11, telemetryData;
+                            var _c, _d, _e;
+                            return __generator(this, function (_f) {
+                                switch (_f.label) {
                                     case 0:
                                         if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 8];
                                         chatAdapterConfig = {
@@ -1110,18 +1113,22 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                             environmentUrl: this.chatToken.acsEndpoint,
                                             pollingInterval: 30000
                                         };
-                                        _e.label = 1;
+                                        _f.label = 1;
                                     case 1:
-                                        _e.trys.push([1, 3, , 4]);
+                                        _f.trys.push([1, 3, , 4]);
+                                        tokenRefresher = this.createChatTokenRefresher(chatAdapterConfig.token);
+                                        this.chatTokenUnauthorizedRecovery = this.createChatTokenUnauthorizedRecovery(chatAdapterConfig.token, tokenRefresher);
                                         return [4 /*yield*/, ((_c = this.ACSClient) === null || _c === void 0 ? void 0 : _c.initialize({
                                                 token: chatAdapterConfig.token,
                                                 environmentUrl: chatAdapterConfig.environmentUrl,
+                                                tokenRefresher: tokenRefresher,
+                                                unauthorizedRecovery: (_d = this.chatTokenUnauthorizedRecovery) !== null && _d !== void 0 ? _d : undefined
                                             }))];
                                     case 2:
-                                        _e.sent();
+                                        _f.sent();
                                         return [3 /*break*/, 4];
                                     case 3:
-                                        error_8 = _e.sent();
+                                        error_8 = _f.sent();
                                         telemetryData = {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId,
@@ -1129,22 +1136,22 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                         exceptionThrowers_1.default.throwMessagingClientInitializationFailure(error_8, this.scenarioMarker, TelemetryEvent_1.default.StartChat, telemetryData);
                                         return [3 /*break*/, 4];
                                     case 4:
-                                        _e.trys.push([4, 6, , 7]);
+                                        _f.trys.push([4, 6, , 7]);
                                         _a = this;
-                                        return [4 /*yield*/, ((_d = this.ACSClient) === null || _d === void 0 ? void 0 : _d.joinConversation({
+                                        return [4 /*yield*/, ((_e = this.ACSClient) === null || _e === void 0 ? void 0 : _e.joinConversation({
                                                 id: chatAdapterConfig.id,
                                                 threadId: chatAdapterConfig.threadId,
                                                 pollingInterval: chatAdapterConfig.pollingInterval
                                             }))];
                                     case 5:
-                                        _a.conversation = (_e.sent());
+                                        _a.conversation = (_f.sent());
                                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId
                                         });
                                         return [3 /*break*/, 7];
                                     case 6:
-                                        error_9 = _e.sent();
+                                        error_9 = _f.sent();
                                         telemetryData = {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId,
@@ -1153,17 +1160,17 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                         return [3 /*break*/, 7];
                                     case 7: return [3 /*break*/, 14];
                                     case 8:
-                                        _e.trys.push([8, 10, , 11]);
+                                        _f.trys.push([8, 10, , 11]);
                                         return [4 /*yield*/, this.IC3Client.initialize({
                                                 token: this.chatToken.token,
                                                 regionGtms: this.chatToken.regionGTMS,
                                                 visitor: true
                                             })];
                                     case 9:
-                                        _e.sent();
+                                        _f.sent();
                                         return [3 /*break*/, 11];
                                     case 10:
-                                        error_10 = _e.sent();
+                                        error_10 = _f.sent();
                                         telemetryData = {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId,
@@ -1171,18 +1178,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                         exceptionThrowers_1.default.throwMessagingClientInitializationFailure(error_10, this.scenarioMarker, TelemetryEvent_1.default.StartChat, telemetryData);
                                         return [3 /*break*/, 11];
                                     case 11:
-                                        _e.trys.push([11, 13, , 14]);
+                                        _f.trys.push([11, 13, , 14]);
                                         _b = this;
                                         return [4 /*yield*/, this.IC3Client.joinConversation(this.chatToken.chatId)];
                                     case 12:
-                                        _b.conversation = _e.sent();
+                                        _b.conversation = _f.sent();
                                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId
                                         });
                                         return [3 /*break*/, 14];
                                     case 13:
-                                        error_11 = _e.sent();
+                                        error_11 = _f.sent();
                                         telemetryData = {
                                             RequestId: this.requestId,
                                             ChatId: this.chatToken.chatId,
@@ -1425,6 +1432,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.conversation = null;
                         this.requestId = (0, ocsdk_1.uuidv4)();
                         this.chatToken = {};
+                        this.chatTokenUnauthorizedRecovery = null;
                         this.reconnectId = null;
                         if (this.IC3Client) {
                             this.IC3Client.dispose();
@@ -1790,6 +1798,181 @@ 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
+        }
+    };
+    /**
+     * 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.
+     */
+    OmnichannelChatSDK.prototype.createChatTokenUnauthorizedRecovery = function (initialToken, tokenRefresher) {
+        var _this = this;
+        var _a, _b, _c;
+        try {
+            if (!tokenRefresher
+                || ((_b = (_a = this.chatSDKConfig) === null || _a === void 0 ? void 0 : _a.chatTokenRenewal) === null || _b === void 0 ? void 0 : _b.disableUnauthorizedRecovery) === true
+                || !initialToken) {
+                return null;
+            }
+            var telemetryData_3 = {
+                RequestId: this.requestId,
+                ChatId: (_c = this.chatToken) === null || _c === void 0 ? void 0 : _c.chatId
+            };
+            return (0, chatTokenUnauthorizedRecovery_1.createChatTokenUnauthorizedRecovery)({
+                initialToken: initialToken,
+                refreshToken: tokenRefresher,
+                onStart: function () { return _this.scenarioMarker.startScenario(TelemetryEvent_1.default.ChatTokenUnauthorizedRecovery, telemetryData_3); },
+                onSuccess: function (_source, usedExistingToken) {
+                    if (!usedExistingToken) {
+                        _this.scenarioMarker.completeScenario(TelemetryEvent_1.default.ChatTokenUnauthorizedRecovery, telemetryData_3);
+                    }
+                },
+                onFailure: function (source, reason) {
+                    _this.scenarioMarker.failScenario(TelemetryEvent_1.default.ChatTokenUnauthorizedRecovery, __assign(__assign({}, telemetryData_3), { ExceptionDetails: JSON.stringify({ response: reason, source: source }) }));
+                }
+            });
+        }
+        catch (_d) {
+            return null;
+        }
+    };
+    /**
+     * 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) {