@microsoft/omnichannel-chat-sdk 1.1.1-main.502460d → 1.1.1-main.51d87bb

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+### Added
+- Add `sendDefaultInitContext` optional parameter to `ChatSDK.startChat()` to automatically populate `browser`, `device`, `originurl` & `os` as default init context on web
+- Add `sendCacheHeaders` as optional paramater to `ChatSDK.initialize()` and `ChatSDK.getLiveChatConfig()`
+- Add `validateAuthChatRecord` call on `ChatSDK.startChat()` with `liveChatContext` for all authenticated chat scenarios
+- Pass `ChatClient` during `ACSAdapter` initialization
+- Pass `multiClient` to `AMSClient` on initialization to support `ChatSDK` multi-client
+
+### Fixed
+- Prevent `AMSFileManager.getFileIds()` & `AMSFileManager.getFileMetadata()` to be triggered on all activities with null checks
+- Add `LiveChatVersion` check on `ChatSDK.updateChatToken()`
+- Use `amsreferences` property instead of `amsReferences` by default
+- Fix attachment download to use MIME types instead of file extensions
+- Remove `fileMetadata` property on messages not containing any attachment
+
+### Changed
+- Uptake [@microsoft/ocsdk@0.3.1](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.1)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.8](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.8/dist/chat-adapter.js)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.9](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.9/dist/chat-adapter.js)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.12](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.12/dist/chat-adapter.js)
+- Uptake [@microsoft/omnichannel-amsclient@0.1.2](https://www.npmjs.com/package/@microsoft/omnichannel-amsclient/v/0.1.2)
 
 ## [1.1.0] - 2022-04-15
 ### Added
@@ -20,7 +40,7 @@ All notable changes to this project will be documented in this file.
 - Add support for separate bot post chat survey feature
 - Pass `logger` to `acs_webchat-chat-adapter`
 
-### Fix
+### Fixed
 - 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()`

package/README.md

@@ -1,13 +1,17 @@
-# Omnichannel Chat SDK
+# Omnichannel Chat SDK 💬
 
 [![npm version](https://badge.fury.io/js/%40microsoft%2Fomnichannel-chat-sdk.svg)](https://badge.fury.io/js/%40microsoft%2Fomnichannel-chat-sdk)
 [![install size](https://packagephobia.com/badge?p=@microsoft/omnichannel-chat-sdk)](https://packagephobia.com/result?p=@microsoft/omnichannel-chat-sdk)
 ![Release CI](https://github.com/microsoft/omnichannel-chat-sdk/workflows/Release%20CI/badge.svg)
 ![npm](https://img.shields.io/npm/dm/@microsoft/omnichannel-chat-sdk)
 
+> ❗ Chat SDK **v1.1.0** is the minimum version to support the **new** messaging platform. More [here](https://docs.microsoft.com/en-us/dynamics365/customer-service/migrate-acs)
+
+> 📢 Try out our new React component library [omnichannel-chat-widget](https://github.com/microsoft/omnichannel-chat-widget) with Chat SDK
+
 Headless Chat SDK to build your own chat widget against Dynamics 365 Omnichannel Services.
 
-Please make sure you have a chat widget configured before using this package or you can follow this [link](https://docs.microsoft.com/en-us/dynamics365/customer-service/configure-live-chat)
+Please make sure you have a chat widget configured before using this package or you can follow this [link](https://docs.microsoft.com/en-us/dynamics365/customer-service/add-chat-widget)
 
 ## Table of Contents
 - [Live Chat Widget vs. Chat SDK](#live-chat-widget-vs-chat-sdk)
@@ -40,6 +44,7 @@ Please make sure you have a chat widget configured before using this package or
     - [Get Post Chat Survey Context](#get-post-chat-survey-context)
 - [Common Scenarios](#common-scenarios)
     - [Using BotFramework-WebChat](#using-botframework-webchat)
+    - [Escalation to Voice & Video](#escalation-to-voice--video)
     - [Pre-Chat Survey](#pre-chat-survey)
     - [Post-Chat Survey](#post-chat-survey)
     - [Reconnect to existing Chat](#reconnect-to-existing-chat)
@@ -48,6 +53,7 @@ Please make sure you have a chat widget configured before using this package or
     - [Chat Reconnect with Authenticated User](#chat-reconnect-with-authenticated-user)
     - [Chat Reconnect with Unauthenticated User](#chat-reconnect-with-unauthenticated-user)
     - [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)
 - [Feature Comparisons](#feature-comparisons)
 - [Telemetry](#telemetry)
@@ -163,7 +169,14 @@ const chatSDKConfig = { // Optional
 };
 
 const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
-await chatSDK.initialize();
+
+const optionalParams = {
+    getLiveChatConfigOptionalParams: {
+        sendCacheHeaders: false // Whether to send Cache-Control HTTP header to GetChatConfig call
+    }
+};
+
+await chatSDK.initialize(optionalParams);
 ```
 
 ### Start Chat
@@ -180,7 +193,8 @@ const customContext = {
 const optionalParams = {
     preChatResponse: '', // PreChatSurvey response
     liveChatContext: {}, // EXISTING chat context data
-    customContext // Custom Context
+    customContext, // Custom Context
+    sendDefaultInitContext: true // Send default init context ⚠️ Web only
 };
 
 await chatSDK.startChat(optionalParams);

package/lib/OmnichannelChatSDK.d.ts

@@ -10,10 +10,12 @@ import ChatTranscriptBody from "./core/ChatTranscriptBody";
 import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
 import FramedClient from "@microsoft/omnichannel-amsclient/lib/FramedClient";
 import FramedlessClient from "@microsoft/omnichannel-amsclient/lib/FramedlessClient";
+import GetLiveChatConfigOptionalParams from "./core/GetLiveChatConfigOptionalParams";
 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 InitializeOptionalParams from "./core/InitializeOptionalParams";
 import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
 import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import LiveChatContext from "./core/LiveChatContext";
@@ -58,7 +60,7 @@ declare class OmnichannelChatSDK {
     private refreshTokenTimer;
     constructor(omnichannelConfig: OmnichannelConfig, chatSDKConfig?: ChatSDKConfig);
     setDebug(flag: boolean): void;
-    initialize(): Promise<ChatConfig>;
+    initialize(optionalParams?: InitializeOptionalParams): Promise<ChatConfig>;
     getChatReconnectContext(optionalParams?: ChatReconnectOptionalParams): Promise<ChatReconnectContext>;
     startChat(optionalParams?: StartChatOptionalParams): Promise<void>;
     endChat(): Promise<void>;
@@ -69,7 +71,7 @@ declare class OmnichannelChatSDK {
      * @param parse Whether to parse PreChatSurvey to JSON or not.
      */
     getPreChatSurvey(parse?: boolean): Promise<any>;
-    getLiveChatConfig(cached?: boolean): Promise<ChatConfig>;
+    getLiveChatConfig(optionalParams?: GetLiveChatConfigOptionalParams): Promise<ChatConfig>;
     getChatToken(cached?: boolean): Promise<IChatToken>;
     getCallingToken(): Promise<string>;
     getMessages(): Promise<IMessage[] | OmnichannelMessage[] | undefined>;

package/lib/OmnichannelChatSDK.js

@@ -169,9 +169,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
         (_f = this.acsAdapterLogger) === null || _f === void 0 ? void 0 : _f.setDebug(flag);
         (_g = this.callingSdkLogger) === null || _g === void 0 ? void 0 : _g.setDebug(flag);
     };
-    OmnichannelChatSDK.prototype.initialize = function () {
+    OmnichannelChatSDK.prototype.initialize = function (optionalParams) {
+        if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, _c, _d;
+            var _a, getLiveChatConfigOptionalParams, _b, _c, _d;
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
@@ -188,7 +189,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [4 /*yield*/, ocsdk_1.SDKProvider.getSDK(this.omnichannelConfig, {}, this.ocSdkLogger)];
                     case 2:
                         _a.OCClient = _e.sent();
-                        return [4 /*yield*/, this.getChatConfig()];
+                        getLiveChatConfigOptionalParams = optionalParams.getLiveChatConfigOptionalParams;
+                        return [4 /*yield*/, this.getChatConfig(getLiveChatConfigOptionalParams || {})];
                     case 3:
                         _e.sent();
                         if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 5];
@@ -196,6 +198,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         _b = this;
                         return [4 /*yield*/, omnichannel_amsclient_1.default({
                                 framedMode: platform_1.isBrowser(),
+                                multiClient: true,
                                 debug: false,
                                 logger: undefined
                             })];
@@ -309,10 +312,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
         if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var shouldReinitIC3Client, _t, reconnectableChatsParams, reconnectableChatsResponse, _u, exceptionDetails, conversationDetails, exceptionDetails, exceptionDetails, sessionInitOptionalParams, error_3, exceptionDetails, chatAdapterConfig, error_4, exceptionDetails, _v, error_5, exceptionDetails, error_6, exceptionDetails, error_7, exceptionDetails, _w, error_8, exceptionDetails;
+            var shouldReinitIC3Client, _t, reconnectableChatsParams, reconnectableChatsResponse, _u, exceptionDetails, conversationDetails, exceptionDetails, exceptionDetails, _v, exceptionDetails, sessionInitOptionalParams, exceptionDetails, error_3, exceptionDetails, chatAdapterConfig, error_4, exceptionDetails, _w, error_5, exceptionDetails, error_6, exceptionDetails, error_7, exceptionDetails, _x, error_8, exceptionDetails;
             var _this = this;
-            return __generator(this, function (_x) {
-                switch (_x.label) {
+            return __generator(this, function (_y) {
+                switch (_y.label) {
                     case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId
@@ -322,39 +325,39 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         _t = this;
                         return [4 /*yield*/, this.getIC3Client()];
                     case 1:
-                        _t.IC3Client = _x.sent();
-                        _x.label = 2;
+                        _t.IC3Client = _y.sent();
+                        _y.label = 2;
                     case 2:
                         if (this.isChatReconnect && !((_a = this.chatSDKConfig.chatReconnect) === null || _a === void 0 ? void 0 : _a.disable) && !this.isPersistentChat && optionalParams.reconnectId) {
                             this.reconnectId = optionalParams.reconnectId;
                         }
                         if (!(this.isPersistentChat && !((_b = this.chatSDKConfig.persistentChat) === null || _b === void 0 ? void 0 : _b.disable))) return [3 /*break*/, 6];
-                        _x.label = 3;
+                        _y.label = 3;
                     case 3:
-                        _x.trys.push([3, 5, , 6]);
+                        _y.trys.push([3, 5, , 6]);
                         reconnectableChatsParams = {
                             authenticatedUserToken: this.authenticatedUserToken
                         };
                         return [4 /*yield*/, this.OCClient.getReconnectableChats(reconnectableChatsParams)];
                     case 4:
-                        reconnectableChatsResponse = _x.sent();
+                        reconnectableChatsResponse = _y.sent();
                         if (reconnectableChatsResponse && reconnectableChatsResponse.reconnectid) {
                             this.reconnectId = reconnectableChatsResponse.reconnectid;
                         }
                         return [3 /*break*/, 6];
                     case 5:
-                        _u = _x.sent();
+                        _u = _y.sent();
                         exceptionDetails = {
                             response: "OCClientGetReconnectableChatsFailed"
                         };
                         throw Error(exceptionDetails.response);
                     case 6:
-                        if (!(optionalParams.liveChatContext && !this.reconnectId)) return [3 /*break*/, 8];
+                        if (!(optionalParams.liveChatContext && Object.keys(optionalParams.liveChatContext).length > 0 && !this.reconnectId)) return [3 /*break*/, 8];
                         this.chatToken = optionalParams.liveChatContext.chatToken || {};
                         this.requestId = optionalParams.liveChatContext.requestId || ocsdk_1.uuidv4();
                         return [4 /*yield*/, this.getConversationDetails()];
                     case 7:
-                        conversationDetails = _x.sent();
+                        conversationDetails = _y.sent();
                         if (Object.keys(conversationDetails).length === 0) {
                             exceptionDetails = {
                                 response: "InvalidConversation"
@@ -379,14 +382,47 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             console.error("Unable to join conversation that's in '" + conversationDetails.state + "' state");
                             throw Error(exceptionDetails.response);
                         }
-                        _x.label = 8;
+                        _y.label = 8;
                     case 8:
-                        if (!(this.chatToken && Object.keys(this.chatToken).length === 0)) return [3 /*break*/, 10];
-                        return [4 /*yield*/, this.getChatToken(false)];
+                        if (!this.authSettings) return [3 /*break*/, 14];
+                        if (!!this.authenticatedUserToken) return [3 /*break*/, 10];
+                        return [4 /*yield*/, this.setAuthTokenProvider(this.chatSDKConfig.getAuthToken)];
                     case 9:
-                        _x.sent();
-                        _x.label = 10;
+                        _y.sent();
+                        _y.label = 10;
                     case 10:
+                        if (!(optionalParams.liveChatContext && Object.keys(optionalParams.liveChatContext).length > 0)) return [3 /*break*/, 14];
+                        this.chatToken = optionalParams.liveChatContext.chatToken || {};
+                        this.requestId = optionalParams.liveChatContext.requestId || ocsdk_1.uuidv4();
+                        _y.label = 11;
+                    case 11:
+                        _y.trys.push([11, 13, , 14]);
+                        return [4 /*yield*/, this.OCClient.validateAuthChatRecord(this.requestId, {
+                                authenticatedUserToken: this.authenticatedUserToken,
+                                chatId: this.chatToken.chatId
+                            })];
+                    case 12:
+                        _y.sent();
+                        return [3 /*break*/, 14];
+                    case 13:
+                        _v = _y.sent();
+                        exceptionDetails = {
+                            response: "OCClientValidateAuthChatRecordFailed",
+                            message: "InvalidAuthChatRecord"
+                        };
+                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.StartChat, {
+                            RequestId: this.requestId,
+                            ChatId: this.chatToken.chatId,
+                            ExceptionDetails: JSON.stringify(exceptionDetails)
+                        });
+                        throw Error(exceptionDetails.response);
+                    case 14:
+                        if (!(this.chatToken && Object.keys(this.chatToken).length === 0)) return [3 /*break*/, 16];
+                        return [4 /*yield*/, this.getChatToken(false)];
+                    case 15:
+                        _y.sent();
+                        _y.label = 16;
+                    case 16:
                         (_c = this.ic3ClientLogger) === null || _c === void 0 ? void 0 : _c.setChatId(this.chatToken.chatId || '');
                         (_d = this.ocSdkLogger) === null || _d === void 0 ? void 0 : _d.setChatId(this.chatToken.chatId || '');
                         (_e = this.acsClientLogger) === null || _e === void 0 ? void 0 : _e.setChatId(this.chatToken.chatId || '');
@@ -420,6 +456,22 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (optionalParams.preChatResponse) {
                             sessionInitOptionalParams.initContext.preChatResponse = optionalParams.preChatResponse;
                         }
+                        if (optionalParams.sendDefaultInitContext) {
+                            if (platform_1.default.isNode() || platform_1.default.isReactNative()) {
+                                exceptionDetails = {
+                                    response: "UnsupportedPlatform",
+                                    message: "sendDefaultInitContext is only supported on browser"
+                                };
+                                console.error(exceptionDetails.message);
+                                this.scenarioMarker.failScenario(TelemetryEvent_1.default.StartChat, {
+                                    RequestId: this.requestId,
+                                    ChatId: this.chatToken.chatId,
+                                    ExceptionDetails: JSON.stringify(exceptionDetails)
+                                });
+                                throw new Error(exceptionDetails.response);
+                            }
+                            sessionInitOptionalParams.getContext = true;
+                        }
                         // Override initContext completely
                         if (optionalParams.initContext) {
                             sessionInitOptionalParams.initContext = optionalParams.initContext;
@@ -427,16 +479,20 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (this.authenticatedUserToken) {
                             sessionInitOptionalParams.authenticatedUserToken = this.authenticatedUserToken;
                         }
-                        if (!!optionalParams.liveChatContext) return [3 /*break*/, 14];
-                        _x.label = 11;
-                    case 11:
-                        _x.trys.push([11, 13, , 14]);
+                        if (this.chatToken.chatId) {
+                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                            sessionInitOptionalParams.initContext.chatId = this.chatToken.chatId;
+                        }
+                        if (!!optionalParams.liveChatContext) return [3 /*break*/, 20];
+                        _y.label = 17;
+                    case 17:
+                        _y.trys.push([17, 19, , 20]);
                         return [4 /*yield*/, this.OCClient.sessionInit(this.requestId, sessionInitOptionalParams)];
-                    case 12:
-                        _x.sent();
-                        return [3 /*break*/, 14];
-                    case 13:
-                        error_3 = _x.sent();
+                    case 18:
+                        _y.sent();
+                        return [3 /*break*/, 20];
+                    case 19:
+                        error_3 = _y.sent();
                         exceptionDetails = {
                             response: "OCClientSessionInitFailed"
                         };
@@ -452,27 +508,27 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
                         throw new Error(exceptionDetails.response);
-                    case 14:
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 25];
+                    case 20:
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 31];
                         chatAdapterConfig = {
                             token: this.chatToken.token,
                             id: this.chatToken.visitorId || 'teamsvisitor',
                             threadId: this.chatToken.chatId,
                             environmentUrl: this.chatToken.acsEndpoint,
-                            pollingInterval: 1000
+                            pollingInterval: 30000
                         };
-                        _x.label = 15;
-                    case 15:
-                        _x.trys.push([15, 17, , 18]);
+                        _y.label = 21;
+                    case 21:
+                        _y.trys.push([21, 23, , 24]);
                         return [4 /*yield*/, ((_o = this.ACSClient) === null || _o === void 0 ? void 0 : _o.initialize({
                                 token: chatAdapterConfig.token,
                                 environmentUrl: chatAdapterConfig.environmentUrl
                             }))];
-                    case 16:
-                        _x.sent();
-                        return [3 /*break*/, 18];
-                    case 17:
-                        error_4 = _x.sent();
+                    case 22:
+                        _y.sent();
+                        return [3 /*break*/, 24];
+                    case 23:
+                        error_4 = _y.sent();
                         exceptionDetails = {
                             response: "ACSClientInitializeFailed"
                         };
@@ -483,23 +539,23 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_4);
                         return [2 /*return*/, error_4];
-                    case 18:
-                        _x.trys.push([18, 20, , 21]);
-                        _v = this;
+                    case 24:
+                        _y.trys.push([24, 26, , 27]);
+                        _w = this;
                         return [4 /*yield*/, ((_p = this.ACSClient) === null || _p === void 0 ? void 0 : _p.joinConversation({
                                 id: chatAdapterConfig.id,
                                 threadId: chatAdapterConfig.threadId,
                                 pollingInterval: chatAdapterConfig.pollingInterval
                             }))];
-                    case 19:
-                        _v.conversation = (_x.sent());
+                    case 25:
+                        _w.conversation = (_y.sent());
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 21];
-                    case 20:
-                        error_5 = _x.sent();
+                        return [3 /*break*/, 27];
+                    case 26:
+                        error_5 = _y.sent();
                         exceptionDetails = {
                             response: "ACSClientJoinConversationFailed"
                         };
@@ -510,16 +566,16 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_5);
                         throw Error(exceptionDetails.response);
-                    case 21:
-                        _x.trys.push([21, 23, , 24]);
+                    case 27:
+                        _y.trys.push([27, 29, , 30]);
                         return [4 /*yield*/, ((_q = this.AMSClient) === null || _q === void 0 ? void 0 : _q.initialize({
                                 chatToken: this.chatToken
                             }))];
-                    case 22:
-                        _x.sent();
-                        return [3 /*break*/, 24];
-                    case 23:
-                        error_6 = _x.sent();
+                    case 28:
+                        _y.sent();
+                        return [3 /*break*/, 30];
+                    case 29:
+                        error_6 = _y.sent();
                         exceptionDetails = {
                             response: "AMSClientInitializeFailed"
                         };
@@ -529,19 +585,19 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
                         throw Error(exceptionDetails.response);
-                    case 24: return [3 /*break*/, 31];
-                    case 25:
-                        _x.trys.push([25, 27, , 28]);
+                    case 30: return [3 /*break*/, 37];
+                    case 31:
+                        _y.trys.push([31, 33, , 34]);
                         return [4 /*yield*/, this.IC3Client.initialize({
                                 token: this.chatToken.token,
                                 regionGtms: this.chatToken.regionGTMS,
                                 visitor: true
                             })];
-                    case 26:
-                        _x.sent();
-                        return [3 /*break*/, 28];
-                    case 27:
-                        error_7 = _x.sent();
+                    case 32:
+                        _y.sent();
+                        return [3 /*break*/, 34];
+                    case 33:
+                        error_7 = _y.sent();
                         exceptionDetails = {
                             response: "IC3ClientInitializeFailed"
                         };
@@ -552,19 +608,19 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_7);
                         return [2 /*return*/, error_7];
-                    case 28:
-                        _x.trys.push([28, 30, , 31]);
-                        _w = this;
+                    case 34:
+                        _y.trys.push([34, 36, , 37]);
+                        _x = this;
                         return [4 /*yield*/, this.IC3Client.joinConversation(this.chatToken.chatId)];
-                    case 29:
-                        _w.conversation = _x.sent();
+                    case 35:
+                        _x.conversation = _y.sent();
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 31];
-                    case 30:
-                        error_8 = _x.sent();
+                        return [3 /*break*/, 37];
+                    case 36:
+                        error_8 = _y.sent();
                         exceptionDetails = {
                             response: "IC3ClientJoinConversationFailed"
                         };
@@ -575,7 +631,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_8);
                         return [2 /*return*/, error_8];
-                    case 31:
+                    case 37:
                         if (this.isPersistentChat && !((_r = this.chatSDKConfig.persistentChat) === null || _r === void 0 ? void 0 : _r.disable)) {
                             this.refreshTokenTimer = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
                                 return __generator(this, function (_a) {
@@ -782,14 +838,13 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
-    OmnichannelChatSDK.prototype.getLiveChatConfig = function (cached) {
-        if (cached === void 0) { cached = true; }
+    OmnichannelChatSDK.prototype.getLiveChatConfig = function (optionalParams) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                if (cached) {
+                if (!optionalParams || optionalParams.useRuntimeCache === true) {
                     return [2 /*return*/, this.liveChatConfig];
                 }
-                return [2 /*return*/, this.getChatConfig()];
+                return [2 /*return*/, this.getChatConfig({ sendCacheHeaders: (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.sendCacheHeaders) || false })];
             });
         });
     };
@@ -1333,7 +1388,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                     case 2:
                         uploadDocumentResponse = _e.sent();
                         fileIdsProperty = {
-                            amsReferences: JSON.stringify([documentId])
+                            amsReferences: JSON.stringify([documentId]),
+                            amsreferences: JSON.stringify([documentId])
                         };
                         fileMetaProperty = {
                             amsMetadata: JSON.stringify([{
@@ -1589,17 +1645,17 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                             ACSAdapter: acsAdapterCDNUrl
                                         });
                                         return [4 /*yield*/, WebUtils_1.loadScript(acsAdapterCDNUrl, function () {
+                                                var _a;
                                                 /* istanbul ignore next */
                                                 _this.debug && console.debug('ACSAdapter loaded!');
                                                 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, ACSParticipantDisplayName_1.default.Customer, undefined, // chatClient
-                                                    _this.acsAdapterLogger, // logger
+                                                    var adapter = ChatAdapter.createACSAdapter(_this.chatToken.token, _this.chatToken.visitorId || 'teamsvisitor', _this.chatToken.chatId, _this.chatToken.acsEndpoint, fileManager, 30000, ACSParticipantDisplayName_1.default.Customer, (_a = _this.ACSClient) === null || _a === void 0 ? void 0 : _a.getChatClient(), _this.acsAdapterLogger, // logger
                                                     featuresOption);
                                                     resolve(adapter);
                                                 }
-                                                catch (_a) {
+                                                catch (_b) {
                                                     throw new Error('Failed to load ACSAdapter');
                                                 }
                                             }, function () {
@@ -1924,15 +1980,20 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
-    OmnichannelChatSDK.prototype.getChatConfig = function () {
+    OmnichannelChatSDK.prototype.getChatConfig = function (optionalParams) {
+        if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var liveChatConfig, dataMaskingConfig, authSettings, liveWSAndLiveChatEngJoin, liveChatVersion, chatWidgetLanguage, msdyn_localeid, setting, preChatSurvey, msdyn_prechatenabled, msdyn_callingoptions, msdyn_conversationmode, msdyn_enablechatreconnect, isPreChatEnabled, isChatReconnectEnabled, error_18;
+            var sendCacheHeaders, bypassCache, liveChatConfig, dataMaskingConfig, authSettings, liveWSAndLiveChatEngJoin, liveChatVersion, chatWidgetLanguage, msdyn_localeid, setting, preChatSurvey, msdyn_prechatenabled, msdyn_callingoptions, msdyn_conversationmode, msdyn_enablechatreconnect, isPreChatEnabled, isChatReconnectEnabled, error_18;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 4, , 5]);
-                        return [4 /*yield*/, this.OCClient.getChatConfig()];
+                        sendCacheHeaders = optionalParams.sendCacheHeaders;
+                        _a.label = 1;
                     case 1:
+                        _a.trys.push([1, 5, , 6]);
+                        bypassCache = sendCacheHeaders === true;
+                        return [4 /*yield*/, this.OCClient.getChatConfig(this.requestId, bypassCache)];
+                    case 2:
                         liveChatConfig = _a.sent();
                         dataMaskingConfig = liveChatConfig.DataMaskingInfo, authSettings = liveChatConfig.LiveChatConfigAuthSettings, liveWSAndLiveChatEngJoin = liveChatConfig.LiveWSAndLiveChatEngJoin, liveChatVersion = liveChatConfig.LiveChatVersion, chatWidgetLanguage = liveChatConfig.ChatWidgetLanguage;
                         msdyn_localeid = chatWidgetLanguage.msdyn_localeid;
@@ -1959,12 +2020,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (isPreChatEnabled && preChatSurvey && preChatSurvey.trim().length > 0) {
                             this.preChatSurvey = preChatSurvey;
                         }
-                        if (!this.authSettings) return [3 /*break*/, 3];
+                        if (!this.authSettings) return [3 /*break*/, 4];
                         return [4 /*yield*/, this.setAuthTokenProvider(this.chatSDKConfig.getAuthToken)];
-                    case 2:
-                        _a.sent();
-                        _a.label = 3;
                     case 3:
+                        _a.sent();
+                        _a.label = 4;
+                    case 4:
                         if (this.preChatSurvey) {
                             /* istanbul ignore next */
                             this.debug && console.log('Prechat Survey!');
@@ -1972,11 +2033,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.callingOption = msdyn_callingoptions;
                         this.liveChatConfig = liveChatConfig;
                         return [2 /*return*/, this.liveChatConfig];
-                    case 4:
+                    case 5:
                         error_18 = _a.sent();
                         console.error("OmnichannelChatSDK/getChatConfig/error " + error_18);
                         return [2 /*return*/, error_18];
-                    case 5: return [2 /*return*/];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
@@ -2027,21 +2088,24 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         _a.label = 1;
                     case 1:
-                        _a.trys.push([1, 3, , 4]);
+                        _a.trys.push([1, 4, , 5]);
                         sessionInfo = {
                             token: newToken,
                             regionGtms: newRegionGTMS,
                             visitor: true
                         };
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V1)) return [3 /*break*/, 3];
                         return [4 /*yield*/, this.IC3Client.initialize(sessionInfo)];
                     case 2:
                         _a.sent();
+                        _a.label = 3;
+                    case 3:
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.UpdateChatToken, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 4];
-                    case 3:
+                        return [3 /*break*/, 5];
+                    case 4:
                         error_19 = _a.sent();
                         exceptionDetails = {
                             response: "UpdateChatTokenFailed"
@@ -2052,8 +2116,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
                         console.error("OmnichannelChatSDK/updateChatToken/error " + error_19);
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/];
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
                 }
             });
         });