@microsoft/omnichannel-chat-sdk 1.0.1-main.2d305f2 → 1.0.1-main.474110f

package/CHANGELOG.md

@@ -11,12 +11,16 @@ All notable changes to this project will be documented in this file.
 - Add ability to automatically detect locale from chat config
 - Add `runtimeId` attribute in `OmnichannelChatSDK` & `ChatSDKRuntimeId` field in telemetry
 - Add ability to automatically pass locale from chat config on calling `ChatSDK.emailLiveChatTranscript()`
+- Bubble up `WidgetUseOutsideOperatingHour` exception
+- Add `acs_webchat-chat-adapter` middleware to add default `channelData.tags` & `channelData.metadata`
 
 ### 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()`
 - Fix on messaging client not sending heartbeat on new conversations subsequent to the first conversation
+- Fix `ChatSDK.getConversationDetails()` not passing `authenticatedUserToken`
+- Fix `IC3Client.dispose()` called when `IC3Client` is `undefined`
 
 ### Changed
 - README: added examples on usages of the post chat APIs.

package/README.md

@@ -131,7 +131,7 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
 | OmnichannelChatSDK.getLiveChatTranscript() | Get transcript data (JSON) | |
 | OmnichannelChatSDK.uploadFileAttachment() | Send file attachment | |
 | OmnichannelChatSDK.downloadFileAttachment() | Download file attachment | |
-| OmnichannelChatSDK.createChatAdapter() | Get IC3Adapter | **Web only** |
+| OmnichannelChatSDK.createChatAdapter() | Get Chat Adapter | **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 | |
 

package/lib/OmnichannelChatSDK.d.ts

@@ -1,5 +1,6 @@
 import ACSClient from "./core/messaging/ACSClient";
 import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
+import ChatAdapterOptionalParams from "./core/messaging/ChatAdapterOptionalParams";
 import ChatConfig from "./core/ChatConfig";
 import ChatReconnectContext from "./core/ChatReconnectContext";
 import ChatReconnectOptionalParams from "./core/ChatReconnectOptionalParams";
@@ -81,7 +82,7 @@ declare class OmnichannelChatSDK {
     downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
     emailLiveChatTranscript(body: ChatTranscriptBody): Promise<any>;
     getLiveChatTranscript(): Promise<any>;
-    createChatAdapter(protocol?: string | null): Promise<unknown>;
+    createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<unknown>;
     getVoiceVideoCalling(params?: any): Promise<any>;
     getPostChatSurveyContext(): Promise<any>;
     private getIC3Client;
@@ -89,5 +90,6 @@ declare class OmnichannelChatSDK {
     private resolveIC3ClientUrl;
     private resolveChatAdapterUrl;
     private updateChatToken;
+    private setAuthTokenProvider;
 }
 export default OmnichannelChatSDK;

package/lib/OmnichannelChatSDK.js

@@ -65,6 +65,7 @@ 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 createChannelDataEgressMiddleware_1 = require("./external/ACSAdapter/createChannelDataEgressMiddleware");
 var createFormatEgressTagsMiddleware_1 = require("./external/ACSAdapter/createFormatEgressTagsMiddleware");
 var createFormatIngressTagsMiddleware_1 = require("./external/ACSAdapter/createFormatIngressTagsMiddleware");
 var DeliveryMode_1 = require("@microsoft/omnichannel-ic3core/lib/model/DeliveryMode");
@@ -75,6 +76,7 @@ var LiveChatVersion_1 = require("./core/LiveChatVersion");
 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 OmnichannelErrorCodes_1 = require("./core/OmnichannelErrorCodes");
 var PersonType_1 = require("@microsoft/omnichannel-ic3core/lib/model/PersonType");
 var ProtocoleType_1 = require("@microsoft/omnichannel-ic3core/lib/interfaces/ProtocoleType");
 var ScenarioMarker_1 = require("./telemetry/ScenarioMarker");
@@ -298,44 +300,44 @@ var OmnichannelChatSDK = /** @class */ (function () {
         });
     };
     OmnichannelChatSDK.prototype.startChat = function (optionalParams) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
         if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var shouldReinitIC3Client, _p, reconnectableChatsParams, reconnectableChatsResponse, _q, exceptionDetails, conversationDetails, exceptionDetails, exceptionDetails, sessionInitOptionalParams, error_3, exceptionDetails, chatAdapterConfig, error_4, exceptionDetails, _r, error_5, exceptionDetails, error_6, exceptionDetails, error_7, exceptionDetails, _s, error_8, exceptionDetails;
+            var shouldReinitIC3Client, _s, reconnectableChatsParams, reconnectableChatsResponse, _t, exceptionDetails, conversationDetails, exceptionDetails, exceptionDetails, sessionInitOptionalParams, error_3, exceptionDetails, chatAdapterConfig, error_4, exceptionDetails, _u, error_5, exceptionDetails, error_6, exceptionDetails, error_7, exceptionDetails, _v, error_8, exceptionDetails;
             var _this = this;
-            return __generator(this, function (_t) {
-                switch (_t.label) {
+            return __generator(this, function (_w) {
+                switch (_w.label) {
                     case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId
                         });
                         shouldReinitIC3Client = !platform_1.default.isNode() && !platform_1.default.isReactNative() && !this.IC3Client && this.liveChatVersion === LiveChatVersion_1.default.V1;
                         if (!shouldReinitIC3Client) return [3 /*break*/, 2];
-                        _p = this;
+                        _s = this;
                         return [4 /*yield*/, this.getIC3Client()];
                     case 1:
-                        _p.IC3Client = _t.sent();
-                        _t.label = 2;
+                        _s.IC3Client = _w.sent();
+                        _w.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];
-                        _t.label = 3;
+                        _w.label = 3;
                     case 3:
-                        _t.trys.push([3, 5, , 6]);
+                        _w.trys.push([3, 5, , 6]);
                         reconnectableChatsParams = {
                             authenticatedUserToken: this.authenticatedUserToken
                         };
                         return [4 /*yield*/, this.OCClient.getReconnectableChats(reconnectableChatsParams)];
                     case 4:
-                        reconnectableChatsResponse = _t.sent();
+                        reconnectableChatsResponse = _w.sent();
                         if (reconnectableChatsResponse && reconnectableChatsResponse.reconnectid) {
                             this.reconnectId = reconnectableChatsResponse.reconnectid;
                         }
                         return [3 /*break*/, 6];
                     case 5:
-                        _q = _t.sent();
+                        _t = _w.sent();
                         exceptionDetails = {
                             response: "OCClientGetReconnectableChatsFailed"
                         };
@@ -346,7 +348,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.requestId = optionalParams.liveChatContext.requestId || ocsdk_1.uuidv4();
                         return [4 /*yield*/, this.getConversationDetails()];
                     case 7:
-                        conversationDetails = _t.sent();
+                        conversationDetails = _w.sent();
                         if (Object.keys(conversationDetails).length === 0) {
                             exceptionDetails = {
                                 response: "InvalidConversation"
@@ -371,13 +373,13 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             console.error("Unable to join conversation that's in '" + conversationDetails.state + "' state");
                             throw Error(exceptionDetails.response);
                         }
-                        _t.label = 8;
+                        _w.label = 8;
                     case 8:
                         if (!(this.chatToken && Object.keys(this.chatToken).length === 0)) return [3 /*break*/, 10];
                         return [4 /*yield*/, this.getChatToken(false)];
                     case 9:
-                        _t.sent();
-                        _t.label = 10;
+                        _w.sent();
+                        _w.label = 10;
                     case 10:
                         (_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 || '');
@@ -419,25 +421,30 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             sessionInitOptionalParams.authenticatedUserToken = this.authenticatedUserToken;
                         }
                         if (!!optionalParams.liveChatContext) return [3 /*break*/, 14];
-                        _t.label = 11;
+                        _w.label = 11;
                     case 11:
-                        _t.trys.push([11, 13, , 14]);
+                        _w.trys.push([11, 13, , 14]);
                         return [4 /*yield*/, this.OCClient.sessionInit(this.requestId, sessionInitOptionalParams)];
                     case 12:
-                        _t.sent();
+                        _w.sent();
                         return [3 /*break*/, 14];
                     case 13:
-                        error_3 = _t.sent();
+                        error_3 = _w.sent();
                         exceptionDetails = {
                             response: "OCClientSessionInitFailed"
                         };
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        if (((_j = error_3) === null || _j === void 0 ? void 0 : _j.isAxiosError) && ((_l = (_k = error_3.response) === null || _k === void 0 ? void 0 : _k.headers) === null || _l === void 0 ? void 0 : _l.errorcode.toString()) === OmnichannelErrorCodes_1.default.WidgetUseOutsideOperatingHour.toString()) {
+                            exceptionDetails.response = OmnichannelErrorCodes_1.default[OmnichannelErrorCodes_1.default.WidgetUseOutsideOperatingHour].toString();
+                            exceptionDetails.message = 'Widget used outside of operating hours';
+                            console.error(exceptionDetails.message);
+                        }
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId,
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
-                        console.error("OmnichannelChatSDK/startChat/sessionInit/error " + error_3);
-                        return [2 /*return*/, error_3];
+                        throw new Error(exceptionDetails.response);
                     case 14:
                         if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 25];
                         chatAdapterConfig = {
@@ -447,18 +454,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             environmentUrl: this.chatToken.acsEndpoint,
                             pollingInterval: 1000
                         };
-                        _t.label = 15;
+                        _w.label = 15;
                     case 15:
-                        _t.trys.push([15, 17, , 18]);
-                        return [4 /*yield*/, ((_j = this.ACSClient) === null || _j === void 0 ? void 0 : _j.initialize({
+                        _w.trys.push([15, 17, , 18]);
+                        return [4 /*yield*/, ((_m = this.ACSClient) === null || _m === void 0 ? void 0 : _m.initialize({
                                 token: chatAdapterConfig.token,
                                 environmentUrl: chatAdapterConfig.environmentUrl
                             }))];
                     case 16:
-                        _t.sent();
+                        _w.sent();
                         return [3 /*break*/, 18];
                     case 17:
-                        error_4 = _t.sent();
+                        error_4 = _w.sent();
                         exceptionDetails = {
                             response: "ACSClientInitializeFailed"
                         };
@@ -470,22 +477,22 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_4);
                         return [2 /*return*/, error_4];
                     case 18:
-                        _t.trys.push([18, 20, , 21]);
-                        _r = this;
-                        return [4 /*yield*/, ((_k = this.ACSClient) === null || _k === void 0 ? void 0 : _k.joinConversation({
+                        _w.trys.push([18, 20, , 21]);
+                        _u = this;
+                        return [4 /*yield*/, ((_o = this.ACSClient) === null || _o === void 0 ? void 0 : _o.joinConversation({
                                 id: chatAdapterConfig.id,
                                 threadId: chatAdapterConfig.threadId,
                                 pollingInterval: chatAdapterConfig.pollingInterval
                             }))];
                     case 19:
-                        _r.conversation = (_t.sent());
+                        _u.conversation = (_w.sent());
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
                         return [3 /*break*/, 21];
                     case 20:
-                        error_5 = _t.sent();
+                        error_5 = _w.sent();
                         exceptionDetails = {
                             response: "ACSClientJoinConversationFailed"
                         };
@@ -497,15 +504,15 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_5);
                         throw Error(exceptionDetails.response);
                     case 21:
-                        _t.trys.push([21, 23, , 24]);
-                        return [4 /*yield*/, ((_l = this.AMSClient) === null || _l === void 0 ? void 0 : _l.initialize({
+                        _w.trys.push([21, 23, , 24]);
+                        return [4 /*yield*/, ((_p = this.AMSClient) === null || _p === void 0 ? void 0 : _p.initialize({
                                 chatToken: this.chatToken
                             }))];
                     case 22:
-                        _t.sent();
+                        _w.sent();
                         return [3 /*break*/, 24];
                     case 23:
-                        error_6 = _t.sent();
+                        error_6 = _w.sent();
                         exceptionDetails = {
                             response: "AMSClientInitializeFailed"
                         };
@@ -517,17 +524,17 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         throw Error(exceptionDetails.response);
                     case 24: return [3 /*break*/, 31];
                     case 25:
-                        _t.trys.push([25, 27, , 28]);
+                        _w.trys.push([25, 27, , 28]);
                         return [4 /*yield*/, this.IC3Client.initialize({
                                 token: this.chatToken.token,
                                 regionGtms: this.chatToken.regionGTMS,
                                 visitor: true
                             })];
                     case 26:
-                        _t.sent();
+                        _w.sent();
                         return [3 /*break*/, 28];
                     case 27:
-                        error_7 = _t.sent();
+                        error_7 = _w.sent();
                         exceptionDetails = {
                             response: "IC3ClientInitializeFailed"
                         };
@@ -539,18 +546,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_7);
                         return [2 /*return*/, error_7];
                     case 28:
-                        _t.trys.push([28, 30, , 31]);
-                        _s = this;
+                        _w.trys.push([28, 30, , 31]);
+                        _v = this;
                         return [4 /*yield*/, this.IC3Client.joinConversation(this.chatToken.chatId)];
                     case 29:
-                        _s.conversation = _t.sent();
+                        _v.conversation = _w.sent();
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
                         return [3 /*break*/, 31];
                     case 30:
-                        error_8 = _t.sent();
+                        error_8 = _w.sent();
                         exceptionDetails = {
                             response: "IC3ClientJoinConversationFailed"
                         };
@@ -562,7 +569,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_8);
                         return [2 /*return*/, error_8];
                     case 31:
-                        if (this.isPersistentChat && !((_m = this.chatSDKConfig.persistentChat) === null || _m === void 0 ? void 0 : _m.disable)) {
+                        if (this.isPersistentChat && !((_q = this.chatSDKConfig.persistentChat) === null || _q === void 0 ? void 0 : _q.disable)) {
                             this.refreshTokenTimer = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
                                 return __generator(this, function (_a) {
                                     switch (_a.label) {
@@ -573,7 +580,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                             return [2 /*return*/];
                                     }
                                 });
-                            }); }, (_o = this.chatSDKConfig.persistentChat) === null || _o === void 0 ? void 0 : _o.tokenUpdateTime);
+                            }); }, (_r = this.chatSDKConfig.persistentChat) === null || _r === void 0 ? void 0 : _r.tokenUpdateTime);
                         }
                         return [2 /*return*/];
                 }
@@ -620,9 +627,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.requestId = ocsdk_1.uuidv4();
                         this.chatToken = {};
                         this.reconnectId = null;
-                        this.IC3Client.dispose();
-                        !platform_1.default.isNode() && !platform_1.default.isReactNative() && WebUtils_1.removeElementById(this.IC3Client.id);
-                        this.IC3Client = null;
+                        if (this.IC3Client) {
+                            this.IC3Client.dispose();
+                            !platform_1.default.isNode() && !platform_1.default.isReactNative() && WebUtils_1.removeElementById(this.IC3Client.id);
+                            this.IC3Client = null;
+                        }
                         (_d = this.ic3ClientLogger) === null || _d === void 0 ? void 0 : _d.setRequestId(this.requestId);
                         (_e = this.ic3ClientLogger) === null || _e === void 0 ? void 0 : _e.setChatId('');
                         (_f = this.ocSdkLogger) === null || _f === void 0 ? void 0 : _f.setRequestId(this.requestId);
@@ -684,22 +693,32 @@ var OmnichannelChatSDK = /** @class */ (function () {
         });
     };
     OmnichannelChatSDK.prototype.getConversationDetails = function () {
-        var _a, _b;
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function () {
-            var lwiDetails, state, conversationId, agentAcceptedOn, liveWorkItemDetails, error_10;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var getLWIDetailsOptionalParams, lwiDetails, state, conversationId, agentAcceptedOn, liveWorkItemDetails, error_10;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
                     case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetConversationDetails, {
                             RequestId: this.requestId,
                             ChatId: ((_a = this.chatToken) === null || _a === void 0 ? void 0 : _a.chatId) || '',
                         });
-                        _c.label = 1;
+                        getLWIDetailsOptionalParams = {};
+                        if (this.isPersistentChat && !((_b = this.chatSDKConfig.persistentChat) === null || _b === void 0 ? void 0 : _b.disable) && this.reconnectId) {
+                            getLWIDetailsOptionalParams.reconnectId = this.reconnectId;
+                        }
+                        if (this.isChatReconnect && !((_c = this.chatSDKConfig.chatReconnect) === null || _c === void 0 ? void 0 : _c.disable) && !this.isPersistentChat && this.reconnectId) {
+                            getLWIDetailsOptionalParams.reconnectId = this.reconnectId;
+                        }
+                        if (this.authenticatedUserToken) {
+                            getLWIDetailsOptionalParams.authenticatedUserToken = this.authenticatedUserToken;
+                        }
+                        _e.label = 1;
                     case 1:
-                        _c.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.OCClient.getLWIDetails(this.requestId)];
+                        _e.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.OCClient.getLWIDetails(this.requestId, getLWIDetailsOptionalParams)];
                     case 2:
-                        lwiDetails = _c.sent();
+                        lwiDetails = _e.sent();
                         state = lwiDetails.State, conversationId = lwiDetails.ConversationId, agentAcceptedOn = lwiDetails.AgentAcceptedOn;
                         liveWorkItemDetails = {
                             state: state,
@@ -710,11 +729,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.GetConversationDetails, {
                             RequestId: this.requestId,
-                            ChatId: ((_b = this.chatToken) === null || _b === void 0 ? void 0 : _b.chatId) || '',
+                            ChatId: ((_d = this.chatToken) === null || _d === void 0 ? void 0 : _d.chatId) || '',
                         });
                         return [2 /*return*/, liveWorkItemDetails];
                     case 3:
-                        error_10 = _c.sent();
+                        error_10 = _e.sent();
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetConversationDetails, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId || '',
@@ -1520,36 +1539,36 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
-    OmnichannelChatSDK.prototype.createChatAdapter = function (protocol) {
-        if (protocol === void 0) { protocol = null; }
+    OmnichannelChatSDK.prototype.createChatAdapter = function (optionalParams) {
+        if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var supportedChatAdapterProtocols;
+            var protocol, supportedChatAdapterProtocols;
             var _this = this;
             return __generator(this, function (_a) {
                 if (platform_1.default.isNode() || platform_1.default.isReactNative()) {
                     return [2 /*return*/, Promise.reject('ChatAdapter is only supported on browser')];
                 }
+                protocol = optionalParams.protocol;
                 supportedChatAdapterProtocols = [ChatAdapterProtocols_1.default.ACS, ChatAdapterProtocols_1.default.IC3];
                 if (protocol && !supportedChatAdapterProtocols.includes(protocol)) {
                     return [2 /*return*/, Promise.reject("ChatAdapter for protocol " + protocol + " currently not supported")];
                 }
                 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 egressMiddlewares, ingressMiddlewares, featuresOption, acsAdapterCDNUrl;
+                            var options, defaultEgressMiddlewares, defaultIngressMiddlewares, egressMiddleware, ingressMiddleware, 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: true,
-                                            enableThreadMemberUpdateNotification: true,
-                                            enableLeaveThreadOnWindowClosed: false,
-                                            egressMiddleware: egressMiddlewares,
-                                            ingressMiddleware: ingressMiddlewares
-                                        };
+                                        options = optionalParams.ACSAdapter ? optionalParams.ACSAdapter.options : {};
+                                        defaultEgressMiddlewares = [createChannelDataEgressMiddleware_1.default({ widgetId: this.omnichannelConfig.widgetId }), createFormatEgressTagsMiddleware_1.default()];
+                                        defaultIngressMiddlewares = [createFormatIngressTagsMiddleware_1.default()];
+                                        egressMiddleware = (options === null || options === void 0 ? void 0 : options.egressMiddleware) ? __spreadArrays(options.egressMiddleware, defaultEgressMiddlewares) : __spreadArrays(defaultEgressMiddlewares);
+                                        ingressMiddleware = (options === null || options === void 0 ? void 0 : options.ingressMiddleware) ? __spreadArrays(options.egressMiddleware, defaultIngressMiddlewares) : __spreadArrays(defaultIngressMiddlewares);
+                                        featuresOption = __assign(__assign({ enableAdaptiveCards: true, enableThreadMemberUpdateNotification: true, enableLeaveThreadOnWindowClosed: false }, options), { // overrides
+                                            ingressMiddleware: ingressMiddleware,
+                                            egressMiddleware: egressMiddleware });
                                         acsAdapterCDNUrl = this.resolveChatAdapterUrl(protocol || ChatAdapterProtocols_1.default.ACS);
                                         (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setCDNPackages({
                                             ACSAdapter: acsAdapterCDNUrl
@@ -1560,7 +1579,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, undefined, // logger
+                                                    var adapter = ChatAdapter.createACSAdapter(_this.chatToken.token, _this.chatToken.visitorId || 'teamsvisitor', _this.chatToken.chatId, _this.chatToken.acsEndpoint, fileManager, 1000, ACSParticipantDisplayName_1.default.Customer, undefined, // chatClient
+                                                    undefined, // logger
                                                     featuresOption);
                                                     resolve(adapter);
                                                 }
@@ -1579,12 +1599,13 @@ var OmnichannelChatSDK = /** @class */ (function () {
                 }
                 else if (protocol === ChatAdapterProtocols_1.default.IC3 || this.liveChatVersion === LiveChatVersion_1.default.V1) {
                     return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-                            var ic3AdapterCDNUrl;
+                            var options, ic3AdapterCDNUrl;
                             var _this = this;
                             var _a;
                             return __generator(this, function (_b) {
                                 switch (_b.label) {
                                     case 0:
+                                        options = optionalParams.IC3Adapter ? optionalParams.IC3Adapter.options : {};
                                         ic3AdapterCDNUrl = this.resolveChatAdapterUrl(protocol || ChatAdapterProtocols_1.default.IC3);
                                         (_a = this.telemetry) === null || _a === void 0 ? void 0 : _a.setCDNPackages({
                                             IC3Adapter: ic3AdapterCDNUrl
@@ -1593,13 +1614,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                         return [4 /*yield*/, WebUtils_1.loadScript(ic3AdapterCDNUrl, function () {
                                                 /* istanbul ignore next */
                                                 _this.debug && console.debug('IC3Adapter loaded!');
-                                                var adapterConfig = {
-                                                    chatToken: _this.chatToken,
-                                                    userDisplayName: 'Customer',
-                                                    userId: 'teamsvisitor',
-                                                    sdkURL: _this.resolveIC3ClientUrl(),
-                                                    sdk: _this.IC3Client
-                                                };
+                                                var adapterConfig = __assign({ chatToken: _this.chatToken, userDisplayName: 'Customer', userId: _this.chatToken.visitorId || 'teamsvisitor', sdkURL: _this.resolveIC3ClientUrl(), sdk: _this.IC3Client }, options // overrides
+                                                );
                                                 var adapter = new window.Microsoft.BotFramework.WebChat.IC3Adapter(adapterConfig);
                                                 adapter.logger = _this.ic3ClientLogger;
                                                 _this.scenarioMarker.completeScenario(TelemetryEvent_1.default.CreateIC3Adapter);
@@ -1874,14 +1890,14 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getChatConfig = function () {
         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, token, exceptionDetails, _a, exceptionDetails, exceptionDetails, error_18;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var 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:
-                        _b.trys.push([0, 8, , 9]);
+                        _a.trys.push([0, 4, , 5]);
                         return [4 /*yield*/, this.OCClient.getChatConfig()];
                     case 1:
-                        liveChatConfig = _b.sent();
+                        liveChatConfig = _a.sent();
                         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;
@@ -1907,47 +1923,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (isPreChatEnabled && preChatSurvey && preChatSurvey.trim().length > 0) {
                             this.preChatSurvey = preChatSurvey;
                         }
-                        if (!this.authSettings) return [3 /*break*/, 7];
-                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetAuthToken);
-                        if (!this.chatSDKConfig.getAuthToken) return [3 /*break*/, 6];
-                        _b.label = 2;
+                        if (!this.authSettings) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.setAuthTokenProvider(this.chatSDKConfig.getAuthToken)];
                     case 2:
-                        _b.trys.push([2, 4, , 5]);
-                        return [4 /*yield*/, this.chatSDKConfig.getAuthToken()];
+                        _a.sent();
+                        _a.label = 3;
                     case 3:
-                        token = _b.sent();
-                        if (token) {
-                            this.authenticatedUserToken = token;
-                            this.scenarioMarker.completeScenario(TelemetryEvent_1.default.GetAuthToken);
-                        }
-                        else {
-                            exceptionDetails = {
-                                response: "UndefinedAuthToken"
-                            };
-                            this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
-                                ExceptionDetails: JSON.stringify(exceptionDetails)
-                            });
-                        }
-                        return [3 /*break*/, 5];
-                    case 4:
-                        _a = _b.sent();
-                        exceptionDetails = {
-                            response: "GetAuthTokenFailed"
-                        };
-                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
-                            ExceptionDetails: JSON.stringify(exceptionDetails)
-                        });
-                        return [3 /*break*/, 5];
-                    case 5: return [3 /*break*/, 7];
-                    case 6:
-                        exceptionDetails = {
-                            response: "GetAuthTokenNotFound"
-                        };
-                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
-                            ExceptionDetails: JSON.stringify(exceptionDetails)
-                        });
-                        _b.label = 7;
-                    case 7:
                         if (this.preChatSurvey) {
                             /* istanbul ignore next */
                             this.debug && console.log('Prechat Survey!');
@@ -1955,11 +1936,11 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.callingOption = msdyn_callingoptions;
                         this.liveChatConfig = liveChatConfig;
                         return [2 /*return*/, this.liveChatConfig];
-                    case 8:
-                        error_18 = _b.sent();
+                    case 4:
+                        error_18 = _a.sent();
                         console.error("OmnichannelChatSDK/getChatConfig/error " + error_18);
                         return [2 /*return*/, error_18];
-                    case 9: return [2 /*return*/];
+                    case 5: return [2 /*return*/];
                 }
             });
         });
@@ -2041,6 +2022,57 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
+    OmnichannelChatSDK.prototype.setAuthTokenProvider = function (provider) {
+        return __awaiter(this, void 0, void 0, function () {
+            var token, exceptionDetails, _a, exceptionDetails, exceptionDetails;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetAuthToken);
+                        this.chatSDKConfig.getAuthToken = provider;
+                        if (!this.chatSDKConfig.getAuthToken) return [3 /*break*/, 5];
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.chatSDKConfig.getAuthToken()];
+                    case 2:
+                        token = _b.sent();
+                        if (token) {
+                            this.authenticatedUserToken = token;
+                            this.scenarioMarker.completeScenario(TelemetryEvent_1.default.GetAuthToken);
+                        }
+                        else {
+                            exceptionDetails = {
+                                response: "UndefinedAuthToken"
+                            };
+                            this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
+                                ExceptionDetails: JSON.stringify(exceptionDetails)
+                            });
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        _a = _b.sent();
+                        exceptionDetails = {
+                            response: "GetAuthTokenFailed"
+                        };
+                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
+                            ExceptionDetails: JSON.stringify(exceptionDetails)
+                        });
+                        return [3 /*break*/, 4];
+                    case 4: return [3 /*break*/, 6];
+                    case 5:
+                        exceptionDetails = {
+                            response: "GetAuthTokenNotFound"
+                        };
+                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
+                            ExceptionDetails: JSON.stringify(exceptionDetails)
+                        });
+                        _b.label = 6;
+                    case 6: return [2 /*return*/];
+                }
+            });
+        });
+    };
     return OmnichannelChatSDK;
 }());
 exports.default = OmnichannelChatSDK;