@microsoft/omnichannel-chat-sdk 1.0.0 → 1.0.1-main.1e6bcff

package/CHANGELOG.md

@@ -3,6 +3,24 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+- Add `getPostChatSurveyContext` API method
+- Add `GetPostChatSurveyContext` telemetry event
+- Add `widgetId` & `clientMessageId` as metadata on sending message
+- Update `ChatConfig` interface with `LiveChatVersion`, `allowedFileExtensions` & `maxUploadFileSize` properties
+- Add ability to automatically detect locale from chat config
+- Add `runtimeId` attribute in `OmnichannelChatSDK` & `ChatSDKRuntimeId` field in telemetry
+
+### Fix
+- Add `acs_webchat-chat-adapter` middlewares to format `channelData.tags`
+- Skip `session init` call on existing conversation
+- Fix `chat reconnect` not ending the conversation on calling `ChatSDK.endChat()`
+
+### Changed
+- README: added examples on usages of the post chat APIs.
+- Uptake [@azure/communication-chat@1.1.1](https://www.npmjs.com/package/@azure/communication-chat/v/1.1.1)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.2](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.2/dist/chat-adapter.js)
+
 ## [1.0.0] - 2021-10-08
 ### Added
 - Add `GetAuthToken` & `GetPreChatSurvey` telemetry events

package/README.md

@@ -14,7 +14,7 @@ Please make sure you have a chat widget configured before using this package or
 - [Installation on React Native](#installation-on-react-native)
 - [API Reference](#api-reference)
 - [API Examples](#api-examples)
-- [Sample Apps](samples/)
+- [Sample Apps](https://github.com/microsoft/omnichannel-chat-sdk-samples)
 - [Common Scenarios](#common-scenarios)
 - [Feature Comparisons](#feature-comparisons)
 - [Telemetry](#telemetry)
@@ -35,14 +35,12 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | Bring Your Own Widget | ❌ | ✔ | |
 | Web Support | ✔ | ✔ |
 | React Native Support | ❌ | ✔ |
-| Escalation to Voice & Video | ✔ | Web Only |
-| Co-browse | ✔ | Web Only |
-| Screen Sharing | ✔ | Web Only |
+| Escalation to Voice & Video | ✔ | ✔ | Only supported on Web |
+| Co-browse | ✔ | 3rd party add-on | Only supported on Web |
+| Screen Sharing | ✔ | 3rd party add-on | Only supported on Web |
 | Authenticated Chat | ✔ | ✔ |
 | Pre-chat Survey | ✔ | ✔ |
-| Post-chat Survey | ✔ | ❌ |
-| Queue Position | ✔ | ✔ |
-| Average Wait Time | ✔ | ✔ |
+| Post-chat Survey | ✔ | ✔ |
 | Download Transcript | ✔ | ✔ |
 | Email Transcript | ✔ | ✔ |
 | Data Masking | ✔ | ✔ |
@@ -52,6 +50,8 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | Persistent Chat | ✔ | ✔ |
 | Chat Reconnect | ✔ | ✔ |
 | Operating Hours | ✔ | ✔ |
+| Queue Position | ✔ | ✔ | No SDK method. Handled as *system message* |
+| Average Wait Time | ✔ | ✔ | No SDK method. Handled as *system message* |
 
 **\*** BYOI: Bring Your Own Implementation
 
@@ -65,7 +65,26 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 
 The following steps will be required to run Omnichannel Chat SDK on React Native:
 
-1. Run `npm install node-libs-react-native --save-dev`
+1. Install `node-libs-react-native`
+    ```
+    npm install node-libs-react-native --save-dev
+    ```
+
+1. Install `react-native-randomBytes`
+    ```
+    npm install react-native-randombytes --save-dev
+    ```
+
+1. Install `react-native-get-random-values`
+    ```
+    npm install react-native-get-random-values --save-dev
+    ```
+
+1. Install `react-native-url-polyfill`
+    ```
+    npm install react-native-url-polyfill --save-dev
+    ```
+
 1. Update *metro.config.js* to use React Native compatible Node Core modules
     ```ts
     module.exports = {
@@ -80,14 +99,11 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     };
     ```
 
-1. Import 'node-libs-react-native/globals' on top of your entry point file
+1. Add following *import* on top of your entry point file
     ```ts
     import 'node-libs-react-native/globals';
-    ```
-
-1. Install `react-native-randomBytes`
-    ```
-    npm install react-native-randombytes --save-dev
+    import 'react-native-get-random-values';
+    import 'react-native-url-polyfill';
     ```
 
 ## API Reference
@@ -116,7 +132,8 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
 | OmnichannelChatSDK.uploadFileAttachment() | Send file attachment | |
 | OmnichannelChatSDK.downloadFileAttachment() | Download file attachment | |
 | OmnichannelChatSDK.createChatAdapter() | Get IC3Adapter | **Web only** |
-| OmnichannelChatSDK.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video| **Web only** |
+| OmnichannelChatSDK.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video | **Web only** |
+| OmnichannelChatSDK.getPostChatSurveyContext() | Get post chat survey link, survey locale, and whether an agent has joined the survey | |
 
 ## API examples
 
@@ -194,6 +211,21 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     const preChatSurvey = await getPreChatSurvey(parseToJSON); // Adaptive Cards payload data as string
 ```
 
+### Get PostChat Survey
+```ts
+    try {
+        const context = await chatSDK.getPostChatSurveyContext();
+        if (context.participantJoined) { // participantJoined will be true if an agent has joined the conversation, or a bot has joined the conversation and the bot survey flag has been turned on on the admin side.
+            // formsProLocale is the default language you have set on the CustomerVoice portal. You can override this url parameter with any locale that CustomerVoice supports.
+            // If "&lang=" is not set on the url, the locale will be English.
+            const linkToSend = context.surveyInviteLink + "&lang=" + context.formsProLocale; 
+            // This link is accessible and will redirect to the survey page. Use it as you see fit.
+        }
+    } catch (ex) {
+        // If the post chat should not be shown by any reason (e.g. post chat is not enabled), promise will be rejected.
+    }
+```
+
 ### Start Chat
 ```ts
     const customContext = {

package/lib/OmnichannelChatSDK.d.ts

@@ -1,11 +1,11 @@
 import ACSClient from "./core/messaging/ACSClient";
+import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import ChatConfig from "./core/ChatConfig";
 import ChatReconnectContext from "./core/ChatReconnectContext";
 import ChatReconnectOptionalParams from "./core/ChatReconnectOptionalParams";
 import ChatSDKConfig from "./core/ChatSDKConfig";
 import ChatSDKMessage from "./core/messaging/ChatSDKMessage";
 import ChatTranscriptBody from "./core/ChatTranscriptBody";
-import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
 import FramedClient from "@microsoft/omnichannel-amsclient/lib/FramedClient";
 import FramedlessClient from "@microsoft/omnichannel-amsclient/lib/FramedlessClient";
@@ -13,16 +13,17 @@ import IChatToken from "./external/IC3Adapter/IChatToken";
 import IFileInfo from "@microsoft/omnichannel-ic3core/lib/interfaces/IFileInfo";
 import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
 import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
-import OmnichannelConfig from "./core/OmnichannelConfig";
 import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
 import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import LiveChatContext from "./core/LiveChatContext";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
-import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
+import OmnichannelConfig from "./core/OmnichannelConfig";
 import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
+import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
 declare class OmnichannelChatSDK {
     private debug;
+    runtimeId: string;
     OCSDKProvider: unknown;
     IC3SDKProvider: unknown;
     OCClient: any;
@@ -32,6 +33,7 @@ declare class OmnichannelChatSDK {
     omnichannelConfig: OmnichannelConfig;
     chatSDKConfig: ChatSDKConfig;
     isInitialized: boolean;
+    localeId: string;
     requestId: string;
     private chatToken;
     private liveChatConfig;
@@ -81,6 +83,7 @@ declare class OmnichannelChatSDK {
     getLiveChatTranscript(): Promise<any>;
     createChatAdapter(protocol?: string | null): Promise<unknown>;
     getVoiceVideoCalling(params?: any): Promise<any>;
+    getPostChatSurveyContext(): Promise<any>;
     private getIC3Client;
     private getChatConfig;
     private resolveIC3ClientUrl;

package/lib/OmnichannelChatSDK.js

@@ -55,37 +55,40 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
     return r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var loggers_1 = require("./utils/loggers");
 var ACSClient_1 = require("./core/messaging/ACSClient");
+var ocsdk_1 = require("@microsoft/ocsdk");
+var platform_1 = require("./utils/platform");
+var SDKConfigValidators_1 = require("./validators/SDKConfigValidators");
 var ACSParticipantDisplayName_1 = require("./core/messaging/ACSParticipantDisplayName");
 var AMSFileManager_1 = require("./external/ACSAdapter/AMSFileManager");
 var CallingOptionsOptionSetNumber_1 = require("./core/CallingOptionsOptionSetNumber");
 var ChatAdapterProtocols_1 = require("./core/messaging/ChatAdapterProtocols");
 var ConversationMode_1 = require("./core/ConversationMode");
-var omnichannel_amsclient_1 = require("@microsoft/omnichannel-amsclient");
-var loggers_1 = require("./utils/loggers");
-var createOmnichannelMessage_1 = require("./utils/createOmnichannelMessage");
-var createTelemetry_1 = require("./utils/createTelemetry");
-var createVoiceVideoCalling_1 = require("./api/createVoiceVideoCalling");
-var MessageTags_1 = require("./core/messaging/MessageTags");
+var createFormatEgressTagsMiddleware_1 = require("./external/ACSAdapter/createFormatEgressTagsMiddleware");
+var createFormatIngressTagsMiddleware_1 = require("./external/ACSAdapter/createFormatIngressTagsMiddleware");
 var DeliveryMode_1 = require("@microsoft/omnichannel-ic3core/lib/model/DeliveryMode");
 var FileSharingProtocolType_1 = require("@microsoft/omnichannel-ic3core/lib/model/FileSharingProtocolType");
 var HostType_1 = require("@microsoft/omnichannel-ic3core/lib/interfaces/HostType");
-var utilities_1 = require("./utils/utilities");
-var libraries_1 = require("./utils/libraries");
-var LiveWorkItemState_1 = require("./core/LiveWorkItemState");
+var omnichannel_ic3core_1 = require("@microsoft/omnichannel-ic3core");
 var LiveChatVersion_1 = require("./core/LiveChatVersion");
-var WebUtils_1 = require("./utils/WebUtils");
+var LiveWorkItemState_1 = require("./core/LiveWorkItemState");
 var MessageContentType_1 = require("@microsoft/omnichannel-ic3core/lib/model/MessageContentType");
 var MessageType_1 = require("@microsoft/omnichannel-ic3core/lib/model/MessageType");
 var PersonType_1 = require("@microsoft/omnichannel-ic3core/lib/model/PersonType");
-var platform_1 = require("./utils/platform");
 var ProtocoleType_1 = require("@microsoft/omnichannel-ic3core/lib/interfaces/ProtocoleType");
 var ScenarioMarker_1 = require("./telemetry/ScenarioMarker");
-var ocsdk_1 = require("@microsoft/ocsdk");
-var omnichannel_ic3core_1 = require("@microsoft/omnichannel-ic3core");
 var TelemetryEvent_1 = require("./telemetry/TelemetryEvent");
+var omnichannel_amsclient_1 = require("@microsoft/omnichannel-amsclient");
+var createOmnichannelMessage_1 = require("./utils/createOmnichannelMessage");
+var createTelemetry_1 = require("./utils/createTelemetry");
+var createVoiceVideoCalling_1 = require("./api/createVoiceVideoCalling");
+var MessageTags_1 = require("./core/messaging/MessageTags");
+var locale_1 = require("./utils/locale");
+var utilities_1 = require("./utils/utilities");
+var libraries_1 = require("./utils/libraries");
+var WebUtils_1 = require("./utils/WebUtils");
 var OmnichannelConfigValidator_1 = require("./validators/OmnichannelConfigValidator");
-var SDKConfigValidators_1 = require("./validators/SDKConfigValidators");
 var OmnichannelChatSDK = /** @class */ (function () {
     function OmnichannelChatSDK(omnichannelConfig, chatSDKConfig) {
         if (chatSDKConfig === void 0) { chatSDKConfig = SDKConfigValidators_1.defaultChatSDKConfig; }
@@ -106,11 +109,13 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.reconnectId = null;
         this.refreshTokenTimer = null;
         this.debug = false;
+        this.runtimeId = ocsdk_1.uuidv4();
         this.omnichannelConfig = omnichannelConfig;
         this.chatSDKConfig = __assign(__assign({}, SDKConfigValidators_1.defaultChatSDKConfig), chatSDKConfig // overrides
         );
         this.isInitialized = false;
         this.liveChatVersion = LiveChatVersion_1.default.V1;
+        this.localeId = locale_1.defaultLocaleId;
         this.requestId = ocsdk_1.uuidv4();
         this.chatToken = {};
         this.liveChatConfig = {};
@@ -128,6 +133,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.ocSdkLogger.useTelemetry(this.telemetry);
         this.acsClientLogger.useTelemetry(this.telemetry);
         this.acsAdapterLogger.useTelemetry(this.telemetry);
+        this.scenarioMarker.setRuntimeId(this.runtimeId);
+        this.ic3ClientLogger.setRuntimeId(this.runtimeId);
+        this.ocSdkLogger.setRuntimeId(this.runtimeId);
+        this.acsClientLogger.setRuntimeId(this.runtimeId);
+        this.acsAdapterLogger.setRuntimeId(this.runtimeId);
         OmnichannelConfigValidator_1.default(omnichannelConfig);
         SDKConfigValidators_1.default(chatSDKConfig);
         ((_a = this.chatSDKConfig.telemetry) === null || _a === void 0 ? void 0 : _a.disable) && ((_b = this.telemetry) === null || _b === void 0 ? void 0 : _b.disable());
@@ -323,7 +333,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         };
                         throw Error(exceptionDetails.response);
                     case 4:
-                        if (!(optionalParams.liveChatContext && !this.isPersistentChat && !this.isChatReconnect)) return [3 /*break*/, 6];
+                        if (!(optionalParams.liveChatContext && !this.reconnectId)) return [3 /*break*/, 6];
                         this.chatToken = optionalParams.liveChatContext.chatToken || {};
                         this.requestId = optionalParams.liveChatContext.requestId || ocsdk_1.uuidv4();
                         return [4 /*yield*/, this.getConversationDetails()];
@@ -368,6 +378,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         sessionInitOptionalParams = {
                             initContext: {}
                         };
+                        sessionInitOptionalParams.initContext.locale = locale_1.getLocaleStringFromId(this.localeId);
                         if (this.isPersistentChat && !((_g = this.chatSDKConfig.persistentChat) === null || _g === void 0 ? void 0 : _g.disable)) {
                             sessionInitOptionalParams.reconnectId = this.reconnectId;
                         }
@@ -399,6 +410,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (this.authenticatedUserToken) {
                             sessionInitOptionalParams.authenticatedUserToken = this.authenticatedUserToken;
                         }
+                        if (!!optionalParams.liveChatContext) return [3 /*break*/, 12];
                         _s.label = 9;
                     case 9:
                         _s.trys.push([9, 11, , 12]);
@@ -579,6 +591,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         if (this.isChatReconnect && !((_b = this.chatSDKConfig.chatReconnect) === null || _b === void 0 ? void 0 : _b.disable) && !this.isPersistentChat) {
                             isChatReconnect = this.reconnectId !== null ? true : false;
+                            this.requestId = isChatReconnect ? this.reconnectId : this.requestId; // Chat Reconnect session to close
                             sessionCloseOptionalParams.isReconnectChat = isChatReconnect;
                         }
                         if (this.authenticatedUserToken) {
@@ -896,6 +909,13 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         sendMessageRequest = {
                             content: message.content,
                         };
+                        sendMessageRequest.metadata = {
+                            widgetId: this.omnichannelConfig.widgetId,
+                            clientMessageId: Date.now().toString()
+                        };
+                        if (message.metadata) {
+                            sendMessageRequest.metadata = __assign(__assign({}, sendMessageRequest.metadata), message.metadata);
+                        }
                         _e.label = 1;
                     case 1:
                         _e.trys.push([1, 3, , 4]);
@@ -1278,7 +1298,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         };
                         sendMessageRequest = {
                             content: '',
-                            metadata: __assign(__assign({}, fileIdsProperty), fileMetaProperty)
+                            metadata: __assign(__assign({ widgetId: this.omnichannelConfig.widgetId, clientMessageId: Date.now().toString() }, fileIdsProperty), fileMetaProperty)
                         };
                         messageToSend = {
                             content: "",
@@ -1504,16 +1524,20 @@ var OmnichannelChatSDK = /** @class */ (function () {
                 }
                 if (protocol === ChatAdapterProtocols_1.default.ACS || this.liveChatVersion === LiveChatVersion_1.default.V2) {
                     return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-                            var featuresOption, acsAdapterCDNUrl;
+                            var egressMiddlewares, ingressMiddlewares, featuresOption, acsAdapterCDNUrl;
                             var _this = this;
                             var _a;
                             return __generator(this, function (_b) {
                                 switch (_b.label) {
                                     case 0:
+                                        egressMiddlewares = [createFormatEgressTagsMiddleware_1.default()];
+                                        ingressMiddlewares = [createFormatIngressTagsMiddleware_1.default()];
                                         featuresOption = {
-                                            enableAdaptiveCards: false,
+                                            enableAdaptiveCards: true,
                                             enableThreadMemberUpdateNotification: true,
-                                            enableLeaveThreadOnWindowClosed: false
+                                            enableLeaveThreadOnWindowClosed: false,
+                                            egressMiddleware: egressMiddlewares,
+                                            ingressMiddleware: ingressMiddlewares
                                         };
                                         acsAdapterCDNUrl = this.resolveChatAdapterUrl(protocol || ChatAdapterProtocols_1.default.ACS);
                                         (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setCDNPackages({
@@ -1525,7 +1549,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                                 try {
                                                     var ChatAdapter = window.ChatAdapter; // eslint-disable-line @typescript-eslint/no-explicit-any
                                                     var fileManager = new AMSFileManager_1.default(_this.AMSClient, _this.acsAdapterLogger);
-                                                    var adapter = ChatAdapter.createACSAdapter(_this.chatToken.token, _this.chatToken.visitorId || 'teamsvisitor', _this.chatToken.chatId, _this.chatToken.acsEndpoint, fileManager, 1000, ACSParticipantDisplayName_1.default.Customer, undefined, featuresOption);
+                                                    var adapter = ChatAdapter.createACSAdapter(_this.chatToken.token, _this.chatToken.visitorId || 'teamsvisitor', _this.chatToken.chatId, _this.chatToken.acsEndpoint, fileManager, 1000, ACSParticipantDisplayName_1.default.Customer, undefined, undefined, // logger
+                                                    featuresOption);
                                                     resolve(adapter);
                                                 }
                                                 catch (_a) {
@@ -1659,6 +1684,92 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
+    OmnichannelChatSDK.prototype.getPostChatSurveyContext = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var conversationId, liveWSAndLiveChatEngJoin, msdyn_postconversationsurveyenable, msfp_sourcesurveyidentifier, postConversationSurveyOwnerId, liveWorkItemDetails, participantJoined, surveyInviteLinkRequest, optionalParams, surveyInviteLinkResponse, surveyInviteLink, formsProLocale, postChatContext, ex_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
+                            RequestId: this.requestId
+                        });
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 6, , 7]);
+                        liveWSAndLiveChatEngJoin = this.liveChatConfig.LiveWSAndLiveChatEngJoin;
+                        msdyn_postconversationsurveyenable = liveWSAndLiveChatEngJoin.msdyn_postconversationsurveyenable, msfp_sourcesurveyidentifier = liveWSAndLiveChatEngJoin.msfp_sourcesurveyidentifier, postConversationSurveyOwnerId = liveWSAndLiveChatEngJoin.postConversationSurveyOwnerId;
+                        if (!msdyn_postconversationsurveyenable) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.OCClient.getLWIDetails(this.requestId)];
+                    case 2:
+                        liveWorkItemDetails = _a.sent();
+                        participantJoined = (liveWorkItemDetails === null || liveWorkItemDetails === void 0 ? void 0 : liveWorkItemDetails.CanRenderPostChat) && (liveWorkItemDetails === null || liveWorkItemDetails === void 0 ? void 0 : liveWorkItemDetails.CanRenderPostChat) === "True";
+                        conversationId = liveWorkItemDetails === null || liveWorkItemDetails === void 0 ? void 0 : liveWorkItemDetails.ConversationId;
+                        surveyInviteLinkRequest = {
+                            "FormId": msfp_sourcesurveyidentifier,
+                            "ConversationId": conversationId,
+                            "OCLocaleCode": locale_1.getLocaleStringFromId(this.localeId) || locale_1.getLocaleStringFromId(locale_1.defaultLocaleId)
+                        };
+                        optionalParams = {
+                            "requestId": this.requestId
+                        };
+                        if (this.authenticatedUserToken) {
+                            optionalParams.authenticatedUserToken = this.authenticatedUserToken;
+                        }
+                        return [4 /*yield*/, this.OCClient.getSurveyInviteLink(postConversationSurveyOwnerId, surveyInviteLinkRequest)];
+                    case 3:
+                        surveyInviteLinkResponse = _a.sent();
+                        surveyInviteLink = void 0, formsProLocale = void 0;
+                        if (surveyInviteLinkResponse != null) {
+                            if (surveyInviteLinkResponse.inviteList != null && surveyInviteLinkResponse.inviteList.length == 1) {
+                                surveyInviteLink = surveyInviteLinkResponse.inviteList[0].invitationLink;
+                            }
+                            else {
+                                this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
+                                    ConversationId: conversationId,
+                                    RequestId: this.requestId,
+                                    ExceptionDetails: "Survey Invite link failed to send response."
+                                });
+                                return [2 /*return*/, Promise.reject("Survey Invite link failed to send response.")];
+                            }
+                            if (surveyInviteLinkResponse.formsProLocaleCode != null) {
+                                formsProLocale = surveyInviteLinkResponse.formsProLocaleCode;
+                            }
+                            postChatContext = {
+                                participantJoined: participantJoined,
+                                surveyInviteLink: surveyInviteLink,
+                                formsProLocale: formsProLocale
+                            };
+                            return [2 /*return*/, Promise.resolve(postChatContext)];
+                        }
+                        else {
+                            this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
+                                ConversationId: conversationId,
+                                RequestId: this.requestId,
+                                ExceptionDetails: "surveyInviteLinkResponse is null."
+                            });
+                            return [2 /*return*/, Promise.reject("surveyInviteLinkResponse is null.")];
+                        }
+                        return [3 /*break*/, 5];
+                    case 4:
+                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
+                            RequestId: this.requestId,
+                            ExceptionDetails: "Post Chat Survey is disabled. Please check the Omnichannel Administration Portal."
+                        });
+                        return [2 /*return*/, Promise.reject("Post Chat is disabled from admin side.")];
+                    case 5: return [3 /*break*/, 7];
+                    case 6:
+                        ex_1 = _a.sent();
+                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
+                            ConversationId: conversationId,
+                            RequestId: this.requestId,
+                            ExceptionDetails: JSON.stringify(ex_1)
+                        });
+                        return [2 /*return*/, Promise.reject("Retrieving post chat context failed " + JSON.stringify(ex_1))];
+                    case 7: return [2 /*return*/];
+                }
+            });
+        });
+    };
     OmnichannelChatSDK.prototype.getIC3Client = function () {
         return __awaiter(this, void 0, void 0, function () {
             var IC3Client;
@@ -1744,7 +1855,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getChatConfig = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var liveChatConfig, dataMaskingConfig, authSettings, liveWSAndLiveChatEngJoin, liveChatVersion, setting, preChatSurvey, msdyn_prechatenabled, msdyn_callingoptions, msdyn_conversationmode, msdyn_enablechatreconnect, isPreChatEnabled, isChatReconnectEnabled, token, exceptionDetails, _a, exceptionDetails, exceptionDetails, error_18;
+            var liveChatConfig, dataMaskingConfig, authSettings, liveWSAndLiveChatEngJoin, liveChatVersion, chatWidgetLanguage, msdyn_localeid, setting, preChatSurvey, msdyn_prechatenabled, msdyn_callingoptions, msdyn_conversationmode, msdyn_enablechatreconnect, isPreChatEnabled, isChatReconnectEnabled, token, exceptionDetails, _a, exceptionDetails, exceptionDetails, error_18;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -1752,7 +1863,9 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [4 /*yield*/, this.OCClient.getChatConfig()];
                     case 1:
                         liveChatConfig = _b.sent();
-                        dataMaskingConfig = liveChatConfig.DataMaskingInfo, authSettings = liveChatConfig.LiveChatConfigAuthSettings, liveWSAndLiveChatEngJoin = liveChatConfig.LiveWSAndLiveChatEngJoin, liveChatVersion = liveChatConfig.LiveChatVersion;
+                        dataMaskingConfig = liveChatConfig.DataMaskingInfo, authSettings = liveChatConfig.LiveChatConfigAuthSettings, liveWSAndLiveChatEngJoin = liveChatConfig.LiveWSAndLiveChatEngJoin, liveChatVersion = liveChatConfig.LiveChatVersion, chatWidgetLanguage = liveChatConfig.ChatWidgetLanguage;
+                        msdyn_localeid = chatWidgetLanguage.msdyn_localeid;
+                        this.localeId = msdyn_localeid || locale_1.defaultLocaleId;
                         this.liveChatVersion = liveChatVersion || LiveChatVersion_1.default.V1;
                         /* istanbul ignore next */
                         this.debug && console.log("[OmnichannelChatSDK][getChatConfig][liveChatVersion] " + this.liveChatVersion);