@microsoft/omnichannel-chat-sdk 1.10.16 → 1.10.17-main.243dcc1

package/lib/OmnichannelChatSDK.js

@@ -64,6 +64,7 @@ var ocsdk_1 = require("@microsoft/ocsdk");
 var chatAdapterCreators_1 = require("./utils/chatAdapterCreators");
 var CoreServicesUtils_1 = require("./utils/CoreServicesUtils");
 var locale_1 = require("./utils/locale");
+var exceptionThrowers_1 = require("./utils/exceptionThrowers");
 var utilities_1 = require("./utils/utilities");
 var WebUtils_1 = require("./utils/WebUtils");
 var platform_1 = require("./utils/platform");
@@ -97,7 +98,6 @@ var createTelemetry_1 = require("./utils/createTelemetry");
 var createVoiceVideoCalling_1 = require("./api/createVoiceVideoCalling");
 var MessageTags_1 = require("./core/messaging/MessageTags");
 var exceptionSuppressors_1 = require("./utils/exceptionSuppressors");
-var exceptionThrowers_1 = require("./utils/exceptionThrowers");
 var location_1 = require("./utils/location");
 var internalUtils_1 = require("./utils/internalUtils");
 var loggerUtils_1 = require("./utils/loggerUtils");
@@ -138,6 +138,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.NOT_LOADED;
         this.isMaskingDisabled = false;
         this.maskingCharacter = "#";
+        this.isAMSClientAllowed = 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) {
@@ -242,9 +243,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
     OmnichannelChatSDK.prototype.setDebug = function (flag) {
         var _a;
         this.debug = flag;
-        this.getAMSClient().then(function (client) { return client === null || client === void 0 ? void 0 : client.setDebug(flag); });
         (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setDebug(flag);
         this.scenarioMarker.setDebug(flag);
+        if (this.AMSClient) {
+            this.AMSClient.setDebug(flag);
+        }
         loggerUtils_1.default.setDebug(flag, this.ocSdkLogger, this.acsClientLogger, this.acsAdapterLogger, this.callingSdkLogger, this.amsClientLogger, this.ic3ClientLogger);
     };
     OmnichannelChatSDK.prototype.retryLoadAMSClient = function () {
@@ -254,7 +257,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         RETRY_DELAY_MS = 1000;
-                        MAX_RETRY_COUNT = 5;
+                        MAX_RETRY_COUNT = 30;
                         retryCount = 0;
                         _a.label = 1;
                     case 1:
@@ -278,6 +281,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
+                        //return null to do not break promise creation
+                        if (this.isAMSClientAllowed === false) {
+                            return [2 /*return*/, null];
+                        }
                         if (this.AMSClientLoadCurrentState === AMSClientLoadStates_1.AMSClientLoadStates.NOT_LOADED && this.liveChatVersion === LiveChatVersion_1.default.V1) {
                             return [2 /*return*/, null];
                         }
@@ -289,10 +296,16 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             case AMSClientLoadStates_1.AMSClientLoadStates.NOT_LOADED: return [3 /*break*/, 4];
                         }
                         return [3 /*break*/, 6];
-                    case 1: return [2 /*return*/, this.AMSClient];
-                    case 2: return [4 /*yield*/, this.retryLoadAMSClient()];
+                    case 1:
+                        this.debug && console.log("Attachment handler is already loaded");
+                        return [2 /*return*/, this.AMSClient];
+                    case 2:
+                        this.debug && console.log("Attachment handler is loading, waiting for it to be ready");
+                        return [4 /*yield*/, this.retryLoadAMSClient()];
                     case 3: return [2 /*return*/, _b.sent()];
-                    case 4: return [4 /*yield*/, this.loadAmsClient()];
+                    case 4:
+                        this.debug && console.log("Attachment handler is not loaded, loading now");
+                        return [4 /*yield*/, this.loadAmsClient()];
                     case 5:
                         _b.sent();
                         return [2 /*return*/, this.AMSClient];
@@ -303,59 +316,79 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.loadInitComponents = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var supportedLiveChatVersions;
-            return __generator(this, function (_a) {
-                this.scenarioMarker.startScenario(TelemetryEvent_1.default.InitializeComponents);
-                supportedLiveChatVersions = [LiveChatVersion_1.default.V1, LiveChatVersion_1.default.V2];
-                if (!supportedLiveChatVersions.includes(this.liveChatVersion)) {
-                    exceptionThrowers_1.default.throwUnsupportedLiveChatVersionFailure(new Error(ChatSDKError_1.ChatSDKErrorName.UnsupportedLiveChatVersion), this.scenarioMarker, TelemetryEvent_1.default.InitializeComponents);
+            var supportedLiveChatVersions, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.InitializeComponents);
+                        supportedLiveChatVersions = [LiveChatVersion_1.default.V1, LiveChatVersion_1.default.V2];
+                        if (!supportedLiveChatVersions.includes(this.liveChatVersion)) {
+                            exceptionThrowers_1.default.throwUnsupportedLiveChatVersionFailure(new Error(ChatSDKError_1.ChatSDKErrorName.UnsupportedLiveChatVersion), this.scenarioMarker, TelemetryEvent_1.default.InitializeComponents);
+                        }
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 1];
+                        this.ACSClient = new ACSClient_1.default(this.acsClientLogger);
+                        return [3 /*break*/, 3];
+                    case 1:
+                        _a = this;
+                        return [4 /*yield*/, this.getIC3Client()];
+                    case 2:
+                        _a.IC3Client = _b.sent();
+                        _b.label = 3;
+                    case 3:
+                        this.scenarioMarker.completeScenario(TelemetryEvent_1.default.InitializeComponents);
+                        return [2 /*return*/];
                 }
-                this.isInitialized = true;
-                this.scenarioMarker.completeScenario(TelemetryEvent_1.default.InitializeComponents);
-                return [2 /*return*/];
             });
         });
     };
+    OmnichannelChatSDK.prototype.evaluateAMSAvailability = function () {
+        var _a, _b, _c, _d;
+        // it will load AMS only if enabled for Customer or Agent support for attachments, based on configuration
+        if (((_b = (_a = this.liveChatConfig) === null || _a === void 0 ? void 0 : _a.LiveWSAndLiveChatEngJoin) === null || _b === void 0 ? void 0 : _b.msdyn_enablefileattachmentsforcustomers) === "true" ||
+            ((_d = (_c = this.liveChatConfig) === null || _c === void 0 ? void 0 : _c.LiveWSAndLiveChatEngJoin) === null || _d === void 0 ? void 0 : _d.msdyn_enablefileattachmentsforagents) === "true") {
+            if (this.liveChatVersion === LiveChatVersion_1.default.V2) {
+                //override of this value, since it will be needed to control access to attachment operations
+                this.isAMSClientAllowed = true;
+                return this.isAMSClientAllowed;
+            }
+        }
+        return this.isAMSClientAllowed;
+    };
     OmnichannelChatSDK.prototype.loadAmsClient = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, e_1;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var _a, e_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.InitializeMessagingClient);
-                        _c.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _c.trys.push([1, 6, , 7]);
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 3];
-                        this.ACSClient = new ACSClient_1.default(this.acsClientLogger);
+                        _b.trys.push([1, 4, , 5]);
+                        if (!this.isAMSClientAllowed) return [3 /*break*/, 3];
+                        if (!(this.AMSClientLoadCurrentState === AMSClientLoadStates_1.AMSClientLoadStates.NOT_LOADED)) return [3 /*break*/, 3];
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.LOADING;
+                        this.debug && console.time("ams_creation");
                         _a = this;
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
                                 framedMode: (0, platform_1.isBrowser)(),
                                 multiClient: true,
-                                debug: false,
+                                debug: this.debug,
                                 logger: this.amsClientLogger
                             })];
                     case 2:
-                        _a.AMSClient = _c.sent();
+                        _a.AMSClient = _b.sent();
+                        this.debug && console.timeEnd("ams_creation");
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.LOADED;
-                        return [3 /*break*/, 5];
+                        _b.label = 3;
                     case 3:
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V1)) return [3 /*break*/, 5];
-                        _b = this;
-                        return [4 /*yield*/, this.getIC3Client()];
-                    case 4:
-                        _b.IC3Client = _c.sent();
-                        _c.label = 5;
-                    case 5:
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.InitializeMessagingClient);
-                        return [3 /*break*/, 7];
-                    case 6:
-                        e_1 = _c.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        e_1 = _b.sent();
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.ERROR;
                         exceptionThrowers_1.default.throwMessagingClientCreationFailure(e_1, this.scenarioMarker, TelemetryEvent_1.default.InitializeMessagingClient);
-                        return [3 /*break*/, 7];
-                    case 7: return [2 /*return*/];
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
                 }
             });
         });
@@ -440,37 +473,42 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         _e.label = 8;
                     case 8:
-                        _e.trys.push([8, 13, , 14]);
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 10];
+                        _e.trys.push([8, 14, , 15]);
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 11];
                         this.ACSClient = new ACSClient_1.default(this.acsClientLogger);
+                        if (!(this.isAMSClientAllowed && this.AMSClientLoadCurrentState === AMSClientLoadStates_1.AMSClientLoadStates.NOT_LOADED)) return [3 /*break*/, 10];
+                        this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.LOADING;
+                        this.debug && console.time("ams_seq_creation");
                         _b = this;
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
                                 framedMode: (0, platform_1.isBrowser)(),
                                 multiClient: true,
-                                debug: false,
+                                debug: this.debug,
                                 logger: this.amsClientLogger
                             })];
                     case 9:
                         _b.AMSClient = _e.sent();
+                        this.debug && console.timeEnd("ams_seq_creation");
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.LOADED;
-                        return [3 /*break*/, 12];
-                    case 10:
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V1)) return [3 /*break*/, 12];
+                        _e.label = 10;
+                    case 10: return [3 /*break*/, 13];
+                    case 11:
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V1)) return [3 /*break*/, 13];
                         _c = this;
                         return [4 /*yield*/, this.getIC3Client()];
-                    case 11:
-                        _c.IC3Client = _e.sent();
-                        _e.label = 12;
                     case 12:
+                        _c.IC3Client = _e.sent();
+                        _e.label = 13;
+                    case 13:
                         this.isInitialized = true;
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.InitializeChatSDK);
-                        return [3 /*break*/, 14];
-                    case 13:
+                        return [3 /*break*/, 15];
+                    case 14:
                         e_4 = _e.sent();
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.ERROR;
                         exceptionThrowers_1.default.throwMessagingClientCreationFailure(e_4, this.scenarioMarker, TelemetryEvent_1.default.InitializeChatSDK);
-                        return [3 /*break*/, 14];
-                    case 14: return [2 /*return*/, this.liveChatConfig];
+                        return [3 /*break*/, 15];
+                    case 15: return [2 /*return*/, this.liveChatConfig];
                 }
             });
         });
@@ -988,13 +1026,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                 switch (_a.label) {
                                     case 0:
                                         _a.trys.push([0, 4, , 5]);
+                                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 3];
+                                        if (!this.isAMSClientAllowed)
+                                            return [2 /*return*/];
+                                        // will wait till the AMSClient is loaded, and then initialize it
+                                        this.debug && console.time("ams_promise_initialization");
                                         return [4 /*yield*/, this.getAMSClient()];
                                     case 1:
                                         amsClient = _a.sent();
-                                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 3];
                                         return [4 /*yield*/, (amsClient === null || amsClient === void 0 ? void 0 : amsClient.initialize({ chatToken: this.chatToken }))];
                                     case 2:
                                         _a.sent();
+                                        this.debug && console.timeEnd("ams_promise_initialization");
                                         _a.label = 3;
                                     case 3: return [3 /*break*/, 5];
                                     case 4:
@@ -1866,9 +1909,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
             var _a, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
-                    case 0: return [4 /*yield*/, this.getAMSClient()];
-                    case 1:
-                        amsClient = _c.sent();
+                    case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.UploadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -1877,6 +1918,15 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.UploadFileAttachment);
                         }
                         if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 8];
+                        if (this.isAMSClientAllowed === false) {
+                            exceptionThrowers_1.default.throwFeatureDisabled(this.scenarioMarker, TelemetryEvent_1.default.UploadFileAttachment, "Enable support for attachment upload and receive in the widget configuration.");
+                        }
+                        return [4 /*yield*/, this.getAMSClient()];
+                    case 1:
+                        amsClient = _c.sent();
+                        if (amsClient === null || amsClient === undefined) {
+                            (0, exceptionThrowers_1.throwAMSLoadFailure)(this.scenarioMarker, TelemetryEvent_1.default.UploadFileAttachment, "Attachment handler client is null, no action can be performed");
+                        }
                         return [4 /*yield*/, (amsClient === null || amsClient === void 0 ? void 0 : amsClient.createObject((_a = this.chatToken) === null || _a === void 0 ? void 0 : _a.chatId, fileInfo))];
                     case 2:
                         createObjectResponse = _c.sent();
@@ -1987,9 +2037,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
             var amsClient, response, view_location, viewResponse, _a, downloadedFile, error_21;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this.getAMSClient()];
-                    case 1:
-                        amsClient = _b.sent();
+                    case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.DownloadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -1998,9 +2046,23 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.DownloadFileAttachment);
                         }
                         if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 7];
-                        _b.label = 2;
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 5, , 6]);
+                        if (this.isAMSClientAllowed === false) {
+                            this.scenarioMarker.failScenario(TelemetryEvent_1.default.DownloadFileAttachment, {
+                                RequestId: this.requestId,
+                                ChatId: this.chatToken.chatId,
+                                ExceptionDetails: "AMSClient is disabled"
+                            });
+                            exceptionThrowers_1.default.throwFeatureDisabled(this.scenarioMarker, TelemetryEvent_1.default.DownloadFileAttachment, "Enable support for attachment upload and receive in the widget configuration.");
+                        }
+                        return [4 /*yield*/, this.getAMSClient()];
                     case 2:
-                        _b.trys.push([2, 5, , 6]);
+                        amsClient = _b.sent();
+                        if (amsClient === null || amsClient === undefined) {
+                            (0, exceptionThrowers_1.throwAMSLoadFailure)(this.scenarioMarker, TelemetryEvent_1.default.DownloadFileAttachment, "Attachment handler is null, no action can be performed");
+                        }
                         return [4 /*yield*/, (amsClient === null || amsClient === void 0 ? void 0 : amsClient.getViewStatus(fileMetadata))];
                     case 3:
                         response = _b.sent();
@@ -2698,6 +2760,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                     case 2:
                         liveChatConfig = _d.sent();
                         this.liveChatConfig = liveChatConfig;
+                        this.evaluateAMSAvailability();
                         this.buildConfigurations(liveChatConfig);
                         /* istanbul ignore next */
                         this.debug && console.log("[OmnichannelChatSDK][getChatConfig][liveChatVersion] ".concat(this.liveChatVersion));