@microsoft/omnichannel-chat-sdk 1.11.2-main.9c92d7e → 1.11.3-main.12b9a51

package/README.md

@@ -150,7 +150,11 @@ npm install @microsoft/omnichannel-chat-sdk --save
 
 ## Installation on React Native
 
-The following steps will be required to run Omnichannel Chat SDK on React Native:
+***Important Note:***  
+- For React Native versions **0.71 and above**: Steps 1, 2, 3 are **required only for iOS**. Not needed for Android.
+- For React Native versions **below 0.71**: Steps 1, 2, 3 are **required for both Android and iOS**.
+  
+### Steps
 
 1. Install `node-libs-react-native`
 
@@ -158,46 +162,69 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     npm install node-libs-react-native --save-dev
     ```
 
-1. Install `react-native-randomBytes`
-
+2. Install `react-native-randombytes`
     ```console
     npm install react-native-randombytes --save-dev
     ```
 
-1. Install `react-native-get-random-values`
-
+3. Install `react-native-get-random-values`
     ```console
     npm install react-native-get-random-values --save-dev
     ```
-
-1. Install `react-native-url-polyfill`
+    
+4. Install `react-native-url-polyfill`
 
     ```console
     npm install react-native-url-polyfill --save-dev
     ```
 
-1. Install `@azure/core-asynciterator-polyfill`
+5. Install `@azure/core-asynciterator-polyfill`
 
     ```console
     npm install @azure/core-asynciterator-polyfill --save-dev
     ```
-
-1. Update *metro.config.js* to use React Native compatible Node Core modules
-
+**iOS and Android Platforms**
+
+|  React Native Version |           Libraries            |   iOS   | Android   |
+| ----------------------- | -------------------------------- | --------- | ----------- |
+| 0.71 and above        |                                |         |          | 
+|                       | node-libs-react-native         | ✅ Yes  | ❌ No     |
+|                       | react-native-randombytes       | ✅ Yes  | ❌ No     |
+|                       | react-native-get-random-values | ✅ Yes  | ❌ No     | 
+|                       | react-native-url-polyfill      | ✅ Yes  |  ✅ Yes     |
+|                       | @azure/core-asynciterator-polyfill     | ✅ Yes  |  ✅ Yes      |
+
+Below 0.71 version you need to add all above libraries.
+
+**Required file changes**
+1. In metro.config.js
+- Update *metro.config.js* to use React Native compatible Node Core modules.
     ```ts
-    module.exports = {
-        // ...
-        resolver: {
-            extraNodeModules: {
-                ...require('node-libs-react-native'),
-                net: require.resolve('node-libs-react-native/mock/net'),
-                tls: require.resolve('node-libs-react-native/mock/tls')
-            }
-        }
+    const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
+    const nodeLibs = require('node-libs-react-native'); // Import node-libs-react-native
+    const config = {
+      resolver: {
+        extraNodeModules: {
+          ...nodeLibs,
+          net: require.resolve('node-libs-react-native/mock/net'),
+          tls: require.resolve('node-libs-react-native/mock/tls'),
+        },
+      },
     };
     ```
-
-1. Add the following *import* on top of your entry point file
+- If you encounter a crypto issue for iOS (e.g. error "crypto.getRandomValues() not supported") you should install crypto-browserify and stream-browserify, then add the following lines to your *metro.config.js* file.
+   
+   ```ts
+    const config = {
+      resolver: {
+        extraNodeModules: {
+          crypto: require.resolve("crypto-browserify"),
+          stream: require.resolve("stream-browserify"),
+        },
+      },
+    };
+   ```
+2. Add the following *import* on top of your entry point file
 
     ```ts
     import 'node-libs-react-native/globals';

package/lib/OmnichannelChatSDK.js

@@ -409,7 +409,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.AMSClientLoadCurrentState = AMSClientLoadStates_1.AMSClientLoadStates.LOADING;
                         this.debug && console.time("ams_creation");
                         disableAMSWhitelistedUrls = ((_c = (_b = this.chatSDKConfig) === null || _b === void 0 ? void 0 : _b.internalConfig) === null || _c === void 0 ? void 0 : _c.disableAMSWhitelistedUrls) !== false;
-                        disableAMSRegionBasedUrl = ((_e = (_d = this.chatSDKConfig) === null || _d === void 0 ? void 0 : _d.internalConfig) === null || _e === void 0 ? void 0 : _e.disableAMSRegionBasedUrl) !== false;
+                        disableAMSRegionBasedUrl = ((_e = (_d = this.chatSDKConfig) === null || _d === void 0 ? void 0 : _d.internalConfig) === null || _e === void 0 ? void 0 : _e.disableAMSRegionBasedUrl) === true;
                         framedMode = (0, AMSClientUtils_1.shouldUseFramedMode)(disableAMSWhitelistedUrls);
                         _a = this;
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
@@ -475,7 +475,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     // We will keep this logic for backward compatibility for customers with unknown implementation, so they can test before fully adoption
     OmnichannelChatSDK.prototype.sequentialInitialization = function () {
         return __awaiter(this, arguments, void 0, function (optionalParams) {
-            var useCoreServices, _a, e_2, getLiveChatConfigOptionalParams, e_3, supportedLiveChatVersions, disableAMSWhitelistedUrls, disableAMSRegionBasedUrl, _b, _c, e_4;
+            var useCoreServices, _a, e_2, getLiveChatConfigOptionalParams, e_3, supportedLiveChatVersions, disableAMSWhitelistedUrls, disableAMSRegionBasedUrl, framedMode, _b, _c, e_4;
             var _d, _e, _f, _g, _h;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_j) {
@@ -526,15 +526,16 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         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");
-                        disableAMSWhitelistedUrls = ((_f = (_e = this.chatSDKConfig) === null || _e === void 0 ? void 0 : _e.internalConfig) === null || _f === void 0 ? void 0 : _f.disableAMSWhitelistedUrls) === false ? false : true;
-                        disableAMSRegionBasedUrl = ((_h = (_g = this.chatSDKConfig) === null || _g === void 0 ? void 0 : _g.internalConfig) === null || _h === void 0 ? void 0 : _h.disableAMSRegionBasedUrl) === false ? false : true;
+                        disableAMSWhitelistedUrls = ((_f = (_e = this.chatSDKConfig) === null || _e === void 0 ? void 0 : _e.internalConfig) === null || _f === void 0 ? void 0 : _f.disableAMSWhitelistedUrls) !== false;
+                        disableAMSRegionBasedUrl = ((_h = (_g = this.chatSDKConfig) === null || _g === void 0 ? void 0 : _g.internalConfig) === null || _h === void 0 ? void 0 : _h.disableAMSRegionBasedUrl) === true;
+                        framedMode = (0, AMSClientUtils_1.shouldUseFramedMode)(disableAMSWhitelistedUrls);
                         _b = this;
                         return [4 /*yield*/, (0, omnichannel_amsclient_1.default)({
-                                framedMode: (0, AMSClientUtils_1.shouldUseFramedMode)(disableAMSWhitelistedUrls),
+                                framedMode: framedMode,
                                 multiClient: true,
                                 debug: (this.detailedDebugEnabled ? this.debugAMS : this.debug),
                                 logger: this.amsClientLogger,
-                                baseUrl: (0, AMSClientUtils_1.shouldUseFramedMode)(disableAMSWhitelistedUrls) && !disableAMSRegionBasedUrl ? (0, AMSClientUtils_1.retrieveRegionBasedUrl)(this.widgetSnippetBaseUrl) : ''
+                                baseUrl: framedMode && !disableAMSRegionBasedUrl ? (0, AMSClientUtils_1.retrieveRegionBasedUrl)(this.widgetSnippetBaseUrl) : ''
                             })];
                     case 9:
                         _b.AMSClient = _j.sent();
@@ -1784,7 +1785,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.sendTypingEvent = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var error_17, typingPayload, members, botMembers, error_18;
+            var error_17;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1795,7 +1796,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (!this.isInitialized) {
                             exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.SendTypingEvent);
                         }
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 6];
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 5];
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 4, , 5]);
@@ -1819,35 +1820,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ChatId: this.chatToken.chatId
                         });
                         throw new Error('SendTypingFailure');
-                    case 5: return [3 /*break*/, 12];
-                    case 6:
-                        typingPayload = "{isTyping: 0}";
-                        _a.label = 7;
-                    case 7:
-                        _a.trys.push([7, 11, , 12]);
-                        return [4 /*yield*/, this.conversation.indicateTypingStatus(0)];
-                    case 8:
-                        _a.sent();
-                        return [4 /*yield*/, this.conversation.getMembers()];
-                    case 9:
-                        members = _a.sent();
-                        botMembers = members.filter(function (member) { return member.type === PersonType_1.default.Bot; });
-                        return [4 /*yield*/, this.conversation.sendMessageToBot(botMembers[0].id, { payload: typingPayload })];
-                    case 10:
-                        _a.sent();
-                        this.scenarioMarker.completeScenario(TelemetryEvent_1.default.SendTypingEvent, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                        return [3 /*break*/, 12];
-                    case 11:
-                        error_18 = _a.sent();
-                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.SendTypingEvent, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                        throw new Error('SendTypingFailure');
-                    case 12: return [2 /*return*/];
+                    case 5: return [2 /*return*/];
                 }
             });
         });
@@ -1978,7 +1951,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.uploadFileAttachment = function (fileInfo) {
         return __awaiter(this, void 0, void 0, function () {
-            var amsClient, createObjectResponse, documentId, uploadDocumentResponse, fileIdsProperty, fileMetaProperty, sendMessageRequest, messageToSend, error_19, fileMetadata, messageToSend, error_20;
+            var amsClient, createObjectResponse, documentId, uploadDocumentResponse, fileIdsProperty, fileMetaProperty, sendMessageRequest, messageToSend, error_18, fileMetadata, messageToSend, error_19;
             var _a, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
@@ -2047,7 +2020,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, messageToSend];
                     case 6:
-                        error_19 = _c.sent();
+                        error_18 = _c.sent();
                         console.error("OmnichannelChatSDK/uploadFileAttachment/sendMessage/error");
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.UploadFileAttachment, {
                             RequestId: this.requestId,
@@ -2093,8 +2066,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, messageToSend];
                     case 15:
-                        error_20 = _c.sent();
-                        console.error("OmnichannelChatSDK/uploadFileAttachment/error: ".concat(error_20));
+                        error_19 = _c.sent();
+                        console.error("OmnichannelChatSDK/uploadFileAttachment/error: ".concat(error_19));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.UploadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -2107,7 +2080,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.downloadFileAttachment = function (fileMetadata) {
         return __awaiter(this, void 0, void 0, function () {
-            var amsClient, response, view_location, viewResponse, _a, downloadedFile, error_21;
+            var amsClient, response, view_location, viewResponse, _a, downloadedFile, error_20;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -2167,8 +2140,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, downloadedFile];
                     case 9:
-                        error_21 = _b.sent();
-                        console.error("OmnichannelChatSDK/downloadFileAttachment/error: ".concat(error_21));
+                        error_20 = _b.sent();
+                        console.error("OmnichannelChatSDK/downloadFileAttachment/error: ".concat(error_20));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.DownloadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -2181,7 +2154,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.emailLiveChatTranscript = function (body_1) {
         return __awaiter(this, arguments, void 0, function (body, optionalParams) {
-            var emailTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, emailRequestBody, error_22;
+            var emailTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, emailRequestBody, error_21;
             var _a;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_b) {
@@ -2232,8 +2205,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 4];
                     case 3:
-                        error_22 = _b.sent();
-                        console.error("OmnichannelChatSDK/emailLiveChatTranscript/error: ".concat(error_22));
+                        error_21 = _b.sent();
+                        console.error("OmnichannelChatSDK/emailLiveChatTranscript/error: ".concat(error_21));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.EmailLiveChatTranscript, {
                             RequestId: requestId,
                             ChatId: chatId
@@ -2246,7 +2219,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getLiveChatTranscript = function () {
         return __awaiter(this, arguments, void 0, function (optionalParams) {
-            var getChatTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, transcriptResponse, error_23, telemetryData;
+            var getChatTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, transcriptResponse, error_22, telemetryData;
             var _a, _b;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_c) {
@@ -2303,12 +2276,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, transcriptResponse];
                     case 3:
-                        error_23 = _c.sent();
+                        error_22 = _c.sent();
                         telemetryData = {
                             RequestId: requestId,
                             ChatId: chatId
                         };
-                        exceptionThrowers_1.default.throwLiveChatTranscriptRetrievalFailure(error_23, this.scenarioMarker, TelemetryEvent_1.default.GetLiveChatTranscript, telemetryData);
+                        exceptionThrowers_1.default.throwLiveChatTranscriptRetrievalFailure(error_22, this.scenarioMarker, TelemetryEvent_1.default.GetLiveChatTranscript, telemetryData);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -2830,7 +2803,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getChatConfig = function () {
         return __awaiter(this, arguments, void 0, function (optionalParams) {
-            var sendCacheHeaders, bypassCache, liveChatConfig, error_24, _a;
+            var sendCacheHeaders, bypassCache, liveChatConfig, error_23, _a;
             var _b, _c;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_d) {
@@ -2851,8 +2824,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.debug && console.log("[OmnichannelChatSDK][getChatConfig][liveChatVersion] ".concat(this.liveChatVersion));
                         return [2 /*return*/, this.liveChatConfig];
                     case 3:
-                        error_24 = _d.sent();
-                        if (!(0, internalUtils_1.isCoreServicesOrgUrlDNSError)(error_24, this.coreServicesOrgUrl, this.dynamicsLocationCode)) return [3 /*break*/, 6];
+                        error_23 = _d.sent();
+                        if (!(0, internalUtils_1.isCoreServicesOrgUrlDNSError)(error_23, this.coreServicesOrgUrl, this.dynamicsLocationCode)) return [3 /*break*/, 6];
                         this.omnichannelConfig.orgUrl = this.unqServicesOrgUrl;
                         _a = this;
                         return [4 /*yield*/, ocsdk_1.SDKProvider.getSDK(this.omnichannelConfig, (0, createOcSDKConfiguration_1.default)(false), this.ocSdkLogger)];
@@ -2864,10 +2837,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [3 /*break*/, 7];
                     case 6:
                         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        if (((_c = (_b = error_24.response) === null || _b === void 0 ? void 0 : _b.headers) === null || _c === void 0 ? void 0 : _c.errorcode) && parseInt(error_24.response.headers.errorcode) === OmnichannelErrorCodes_1.default.WidgetNotFound) {
+                        if (((_c = (_b = error_23.response) === null || _b === void 0 ? void 0 : _b.headers) === null || _c === void 0 ? void 0 : _c.errorcode) && parseInt(error_23.response.headers.errorcode) === OmnichannelErrorCodes_1.default.WidgetNotFound) {
                             console.warn("No widget with the given app id is present in the system.");
                         }
-                        throw error_24; // Bubble up error by default to throw ChatConfigRetrievalFailure
+                        throw error_23; // Bubble up error by default to throw ChatConfigRetrievalFailure
                     case 7: return [3 /*break*/, 8];
                     case 8: return [2 /*return*/, this.liveChatConfig];
                 }
@@ -2902,7 +2875,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.updateChatToken = function (newToken, newRegionGTMS) {
         return __awaiter(this, void 0, void 0, function () {
-            var sessionInfo, error_25, exceptionDetails;
+            var sessionInfo, error_24, exceptionDetails;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -2930,7 +2903,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 5];
                     case 4:
-                        error_25 = _a.sent();
+                        error_24 = _a.sent();
                         exceptionDetails = {
                             response: "UpdateChatTokenFailed"
                         };
@@ -2947,7 +2920,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.setAuthTokenProvider = function (provider_1) {
         return __awaiter(this, arguments, void 0, function (provider, optionalParams) {
-            var token, exceptionDetails, error_26, exceptionDetails, exceptionDetails;
+            var token, exceptionDetails, error_25, exceptionDetails, exceptionDetails;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -2979,12 +2952,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         return [3 /*break*/, 4];
                     case 3:
-                        error_26 = _a.sent();
+                        error_25 = _a.sent();
                         exceptionDetails = {
                             response: ChatSDKError_1.ChatSDKErrorName.GetAuthTokenFailed
                         };
-                        if (error_26.message == ChatSDKError_1.ChatSDKErrorName.UndefinedAuthToken) {
-                            exceptionDetails.response = error_26.message;
+                        if (error_25.message == ChatSDKError_1.ChatSDKErrorName.UndefinedAuthToken) {
+                            exceptionDetails.response = error_25.message;
                         }
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
                             ExceptionDetails: JSON.stringify(exceptionDetails)