@microsoft/omnichannel-chat-sdk 1.10.19-main.abf425e → 1.10.20-main.018fa96

package/README.md

@@ -54,7 +54,7 @@ Please make sure you have a chat widget configured before using this package or
   - [Persistent Chat](#persistent-chat)
   - [Chat Reconnect with Authenticated User](#chat-reconnect-with-authenticated-user)
   - [Chat Reconnect with Unauthenticated User](#chat-reconnect-with-unauthenticated-user)
-  - [Handling chat Disconnect on Mobile platform](#handling-chat-disconnect-on-mobile-platform)
+  - [Best Practices for Chat Session Management: Handling Disconnections and Network Instabilit(#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)
@@ -625,7 +625,9 @@ const agentAvailability = await chatSDK.getAgentAvailability();
 
 > See <https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-post-conversation-survey?tabs=customerserviceadmincenter> on how to set up post-conversation surveys
 
-> ❗ `chatSDK.getPostChatSurveyContext()` needs to be called before `chatSDK.endChat()` is called
+__NOTE : It should be called ONLY when the chat contains a post-survey as part of their configuration, otherwise it will throw an error.__
+
+> ❗ `chatSDK.getPostChatSurveyContext()` needs to be called before `chatSDK.endChat()` is called.
 
 ```ts
 // 1. Start chat
@@ -831,9 +833,9 @@ if (outOfOperatingHours === "True") {
 }
 ```
 
-### Handling chat Disconnect on Mobile platform
+### Best Practices for Chat Session Management: Handling Disconnections and Network Instability
 
-> On mobile platforms, where users often switch the app between foreground and background, it is important to verify if the chat is still active before allowing the user to send a message after returning from the background .
+> When users switch away from a browser tab or move an browser app to the background, it's important to check if the chat session is still active before allowing message sending when user resumes. This applies to both mobile and desktop environments, as sessions can expire or disconnect when not actively used
 
 ```ts
 // 1. Register a listener for visbilitychange event
@@ -851,6 +853,25 @@ window.addEventListener("visibilitychange", async () => {
                    
     }
 });
+
+
+
+window.addEventListener('online', async () => {
+  // Re-establish chat connection
+   const optionalParams = {
+        liveChatContext: {}, // EXISTING chat context data
+    };
+    const conversationDetails = await chatSDK.getConversationDetails(optionalParams);
+    if (conversationDetails?.state === "WrapUp" || conversationDetails?.state === "Closed") {
+          
+    }
+});
+
+window.addEventListener('offline', () => {
+  // Inform user of connectivity issues
+});
+
+
 ```
 
 ### Using [BotFramework-WebChat](https://github.com/microsoft/BotFramework-WebChat)

package/lib/OmnichannelChatSDK.d.ts

@@ -9,6 +9,7 @@ import ChatReconnectOptionalParams from "./core/ChatReconnectOptionalParams";
 import ChatSDKConfig from "./core/ChatSDKConfig";
 import ChatSDKMessage from "./core/messaging/ChatSDKMessage";
 import ChatTranscriptBody from "./core/ChatTranscriptBody";
+import DebugOptionalParams from "./core/DebugOptionalParams";
 import EmailLiveChatTranscriptOptionaParams from "./core/EmailLiveChatTranscriptOptionalParams";
 import EndChatOptionalParams from "./core/EndChatOptionalParams";
 import FetchChatTokenResponse from "@microsoft/ocsdk/lib/Model/FetchChatTokenResponse";
@@ -75,8 +76,23 @@ declare class OmnichannelChatSDK {
     private maskingCharacter;
     private botCSPId;
     private isAMSClientAllowed;
+    private debugSDK;
+    private debugAMS;
+    private debugACS;
+    private detailedDebugEnabled;
     constructor(omnichannelConfig: OmnichannelConfig, chatSDKConfig?: ChatSDKConfig);
+    /**
+     * @param flag Flag to enable/disable debug log telemetry, will be applied to all components
+     * @description Set the debug flag to enable/disable debug log telemetry
+     */
     setDebug(flag: boolean): void;
+    /**
+     * @description Allow to target specific components to enable/disable debug log telemetry, reducing the noise in the logs.
+     * @param flagSDK Flag to enable disable SDK debug log telemetry
+     * @param flagAcs Flag to enable/disable debugg log telemetry for Acs components (ACSClient and ACSAdapter)
+     * @param flagAttachment Flag to enable/disable debug log telemetry for Attachment components)
+     */
+    setDebugDetailed(optionalParams: DebugOptionalParams): void;
     private retryLoadAMSClient;
     private getAMSClient;
     private loadInitComponents;

package/lib/OmnichannelChatSDK.js

@@ -59,6 +59,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var loggers_1 = require("./utils/loggers");
 var ACSClient_1 = require("./core/messaging/ACSClient");
+var ChatSDKError_1 = require("./core/ChatSDKError");
 var MessagePrinterFactory_1 = require("./utils/printers/MessagePrinterFactory");
 var ocsdk_1 = require("@microsoft/ocsdk");
 var chatAdapterCreators_1 = require("./utils/chatAdapterCreators");
@@ -74,7 +75,6 @@ var AMSClientLoadStates_1 = require("./utils/AMSClientLoadStates");
 var AMSFileManager_1 = require("./external/ACSAdapter/AMSFileManager");
 var CallingOptionsOptionSetNumber_1 = require("./core/CallingOptionsOptionSetNumber");
 var ChatAdapterProtocols_1 = require("./core/messaging/ChatAdapterProtocols");
-var ChatSDKError_1 = require("./core/ChatSDKError");
 var ConversationMode_1 = require("./core/ConversationMode");
 var DeliveryMode_1 = require("@microsoft/omnichannel-ic3core/lib/model/DeliveryMode");
 var FileSharingProtocolType_1 = require("@microsoft/omnichannel-ic3core/lib/model/FileSharingProtocolType");
@@ -140,6 +140,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.maskingCharacter = "#";
         this.botCSPId = null;
         this.isAMSClientAllowed = false;
+        this.debugSDK = false;
+        this.debugAMS = false;
+        this.debugACS = false;
+        this.detailedDebugEnabled = false;
         this.populateInitChatOptionalParam = function (requestOptionalParams, optionalParams, telemetryEvent) {
             requestOptionalParams.initContext.locale = (0, locale_1.getLocaleStringFromId)(_this.localeId);
             if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.customContext) {
@@ -197,6 +201,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
             return requestOptionalParams;
         };
         this.debug = false;
+        this.debugSDK = false;
+        this.debugAMS = false;
+        this.debugACS = false;
+        this.detailedDebugEnabled = false;
         this.runtimeId = (0, utilities_1.getRuntimeId)((_b = (_a = chatSDKConfig === null || chatSDKConfig === void 0 ? void 0 : chatSDKConfig.telemetry) === null || _a === void 0 ? void 0 : _a.runtimeId) !== null && _b !== void 0 ? _b : null);
         this.omnichannelConfig = omnichannelConfig;
         this.chatSDKConfig = __assign(__assign({}, SDKConfigValidators_1.defaultChatSDKConfig), chatSDKConfig // overrides
@@ -243,9 +251,14 @@ var OmnichannelChatSDK = /** @class */ (function () {
         }
         loggerUtils_1.default.setRequestId(this.requestId, this.ocSdkLogger, this.acsClientLogger, this.acsAdapterLogger, this.callingSdkLogger, this.amsClientLogger, this.ic3ClientLogger);
     }
+    /**
+     * @param flag Flag to enable/disable debug log telemetry, will be applied to all components
+     * @description Set the debug flag to enable/disable debug log telemetry
+     */
     /* istanbul ignore next */
     OmnichannelChatSDK.prototype.setDebug = function (flag) {
         var _a;
+        this.detailedDebugEnabled = false;
         this.debug = flag;
         (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setDebug(flag);
         this.scenarioMarker.setDebug(flag);
@@ -254,6 +267,26 @@ var OmnichannelChatSDK = /** @class */ (function () {
         }
         loggerUtils_1.default.setDebug(flag, this.ocSdkLogger, this.acsClientLogger, this.acsAdapterLogger, this.callingSdkLogger, this.amsClientLogger, this.ic3ClientLogger);
     };
+    /**
+     * @description Allow to target specific components to enable/disable debug log telemetry, reducing the noise in the logs.
+     * @param flagSDK Flag to enable disable SDK debug log telemetry
+     * @param flagAcs Flag to enable/disable debugg log telemetry for Acs components (ACSClient and ACSAdapter)
+     * @param flagAttachment Flag to enable/disable debug log telemetry for Attachment components)
+     */
+    /* istanbul ignore next */
+    OmnichannelChatSDK.prototype.setDebugDetailed = function (optionalParams) {
+        var _a;
+        this.detailedDebugEnabled = true;
+        this.debug = (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.flagSDK) === true;
+        this.debugACS = (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.flagACS) === true;
+        this.debugAMS = (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.flagAttachment) === true;
+        (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setDebug(this.debug);
+        this.scenarioMarker.setDebug(this.debug);
+        if (this.AMSClient) {
+            this.AMSClient.setDebug(this.debugAMS);
+        }
+        loggerUtils_1.default.setDebugDetailed(this.debug, this.debugACS, this.debugAMS, this.ocSdkLogger, this.acsClientLogger, this.acsAdapterLogger, this.callingSdkLogger, this.amsClientLogger);
+    };
     OmnichannelChatSDK.prototype.retryLoadAMSClient = function () {
         return __awaiter(this, void 0, void 0, function () {
             var RETRY_DELAY_MS, MAX_RETRY_COUNT, retryCount;
@@ -376,7 +409,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
                                 framedMode: (0, platform_1.isBrowser)(),
                                 multiClient: true,
-                                debug: this.debug,
+                                debug: (this.detailedDebugEnabled ? this.debugAMS : this.debug),
                                 logger: this.amsClientLogger
                             })];
                     case 2:
@@ -487,7 +520,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
                                 framedMode: (0, platform_1.isBrowser)(),
                                 multiClient: true,
-                                debug: this.debug,
+                                debug: (this.detailedDebugEnabled ? this.debugAMS : this.debug),
                                 logger: this.amsClientLogger
                             })];
                     case 9:
@@ -649,7 +682,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.OCClient.getReconnectAvailability(optionalParams.reconnectId)];
+                        return [4 /*yield*/, this.OCClient.getReconnectAvailability(optionalParams.reconnectId, { requestId: this.requestId })];
                     case 2:
                         reconnectAvailabilityResponse = _a.sent();
                         // isReconnectAvailable , indicates if the chat is still valid, or the token has expired
@@ -699,6 +732,9 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (!this.isInitialized) {
                             exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.GetChatReconnectContext);
                         }
+                        if (!this.requestId) {
+                            this.requestId = (0, ocsdk_1.uuidv4)();
+                        }
                         context = {
                             reconnectId: null,
                             redirectURL: null
@@ -741,6 +777,9 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (!this.isInitialized) {
                             exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.StartChat);
                         }
+                        if (!this.requestId) {
+                            this.requestId = (0, ocsdk_1.uuidv4)();
+                        }
                         shouldReinitIC3Client = !platform_1.default.isNode() && !platform_1.default.isReactNative() && !this.IC3Client && this.liveChatVersion === LiveChatVersion_1.default.V1;
                         if (!shouldReinitIC3Client) return [3 /*break*/, 2];
                         _a = this;
@@ -1056,19 +1095,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                 }
                             });
                         }); };
-                        if (!!((_k = this.chatSDKConfig.useCreateConversation) === null || _k === void 0 ? void 0 : _k.disable)) return [3 /*break*/, 21];
+                        if (!!((_k = this.chatSDKConfig.useCreateConversation) === null || _k === void 0 ? void 0 : _k.disable)) return [3 /*break*/, 20];
                         return [4 /*yield*/, createConversationPromise()];
                     case 19:
                         _o.sent();
-                        return [4 /*yield*/, Promise.all([messagingClientPromise(), attachmentClientPromise()])];
-                    case 20:
-                        _o.sent();
-                        return [3 /*break*/, 23];
-                    case 21: return [4 /*yield*/, Promise.all([sessionInitPromise(), messagingClientPromise(), attachmentClientPromise()])];
-                    case 22:
-                        _o.sent();
-                        _o.label = 23;
+                        return [3 /*break*/, 22];
+                    case 20: return [4 /*yield*/, sessionInitPromise()];
+                    case 21:
+                        _o.sent(); // Await the session initialization
+                        _o.label = 22;
+                    case 22: return [4 /*yield*/, Promise.all([messagingClientPromise(), attachmentClientPromise()])];
                     case 23:
+                        _o.sent();
                         if (this.isPersistentChat && !((_l = this.chatSDKConfig.persistentChat) === null || _l === void 0 ? void 0 : _l.disable)) {
                             this.refreshTokenTimer = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
                                 return __generator(this, function (_a) {
@@ -1153,12 +1191,15 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         _b.label = 1;
                     case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        // calling close chat, internally will handle the session close
-                        return [4 /*yield*/, this.closeChat(endChatOptionalParams)];
+                        _b.trys.push([1, 6, , 7]);
+                        _b.label = 2;
                     case 2:
-                        // calling close chat, internally will handle the session close
+                        _b.trys.push([2, , 4, 5]);
+                        return [4 /*yield*/, this.closeChat(endChatOptionalParams)];
+                    case 3:
                         _b.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
                         (_a = this.conversation) === null || _a === void 0 ? void 0 : _a.disconnect();
                         this.conversation = null;
                         this.requestId = (0, ocsdk_1.uuidv4)();
@@ -1179,17 +1220,22 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             clearInterval(this.refreshTokenTimer);
                             this.refreshTokenTimer = null;
                         }
+                        return [7 /*endfinally*/];
+                    case 5:
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.EndChat, cleanupMetadata);
-                        return [3 /*break*/, 4];
-                    case 3:
+                        return [3 /*break*/, 7];
+                    case 6:
                         error_12 = _b.sent();
                         telemetryData = {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         };
+                        if (error_12 instanceof ChatSDKError_1.ChatSDKError) {
+                            exceptionThrowers_1.default.throwConversationClosureFailure(new Error(JSON.stringify(error_12.exceptionDetails)), this.scenarioMarker, TelemetryEvent_1.default.EndChat, telemetryData);
+                        }
                         exceptionThrowers_1.default.throwConversationClosureFailure(error_12, this.scenarioMarker, TelemetryEvent_1.default.EndChat, telemetryData);
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/];
+                        return [3 /*break*/, 7];
+                    case 7: return [2 /*return*/];
                 }
             });
         });
@@ -1245,6 +1291,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         chatId = chatToken.chatId;
                         reconnectId = this.reconnectId;
                         sessionId = this.sessionId;
+                        if (!this.requestId) {
+                            this.requestId = (0, ocsdk_1.uuidv4)();
+                            requestId = this.requestId;
+                        }
                         if (optionalParams.liveChatContext) {
                             requestId = optionalParams.liveChatContext.requestId;
                             chatToken = optionalParams.liveChatContext.chatToken;
@@ -1593,7 +1643,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ChatId: this.chatToken.chatId,
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
-                        throw new Error(ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed);
+                        throw new ChatSDKError_1.ChatSDKError(ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed, undefined, {
+                            response: ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed,
+                            errorObject: "".concat(error_15)
+                        });
                     case 4: return [3 /*break*/, 9];
                     case 5:
                         messageToSend = {
@@ -1692,7 +1745,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                 var id = event.id;
                                 var omnichannelMessage = (0, createOmnichannelMessage_1.default)(event, {
                                     liveChatVersion: _this.liveChatVersion,
-                                    debug: _this.debug
+                                    debug: (_this.detailedDebugEnabled ? _this.debugACS : _this.debug),
                                 });
                                 if (!postedMessages_1.has(id)) {
                                     onNewMessageCallback(omnichannelMessage);
@@ -2206,6 +2259,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             sessionId = optionalParams.liveChatContext.sessionId;
                             this.OCClient.sessionId = sessionId;
                         }
+                        if (!chatId) {
+                            throw new ChatSDKError_1.ChatSDKError(ChatSDKError_1.ChatSDKErrorName.LiveChatTranscriptRetrievalFailure, undefined, {
+                                response: ChatSDKError_1.ChatSDKErrorName.LiveChatTranscriptRetrievalFailure,
+                                errorObject: "ChatId is not defined"
+                            });
+                        }
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetLiveChatTranscript, {
                             RequestId: requestId,
                             ChatId: chatId
@@ -2480,7 +2539,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ChatId: (_g = this.chatToken) === null || _g === void 0 ? void 0 : _g.chatId,
                             ExceptionDetails: "Post Chat Survey is disabled. Please check the Omnichannel Administration Portal."
                         });
-                        return [2 /*return*/, Promise.reject("Post Chat is disabled from admin side.")];
+                        return [2 /*return*/, Promise.reject("Post Chat is disabled from admin side, or chat doesnt have a survey as part of their configuration.")];
                     case 7: return [3 /*break*/, 9];
                     case 8:
                         ex_1 = _j.sent();