@microsoft/omnichannel-chat-sdk 1.2.1-main.8f1151a → 1.2.1-main.94ae8ab

package/CHANGELOG.md

@@ -5,9 +5,12 @@ All notable changes to this project will be documented in this file.
 ### Added
 - Add ability to use `ChatSDK.createChatAdapter()` for `DirectLine` protocol
 - Add `CreateACSAdapter` telemetry event
+- Improve `ChatSDK.createChatAdapter()` with retries using exponential backoff & additional details on failures
+- Add `GetAgentAvailability` SDK method for auth chat
 
 ### Fixed
 - Fix `ChatAdapterOptionalParams.ACSAdapter.options.egressMiddleware` being used as `ingressMiddleware`
+- Fix `ChatSDK.onTypingEvent()` being triggered on current user typing
 
 ## [1.2.0] - 2022-11-11
 ### Added

package/README.md

@@ -90,6 +90,7 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | Persistent Chat | ✔ | ✔ |
 | Chat Reconnect | ✔ | ✔ |
 | Operating Hours | ✔ | ✔ |
+| Get Agent Availability | ✔ | ✔ |
 | Queue Position | ✔ | ✔ | No SDK method. Handled as *system message* |
 | Average Wait Time | ✔ | ✔ | No SDK method. Handled as *system message* |
 
@@ -450,6 +451,14 @@ It gets post chat survey link, survey locale, and whether an agent has joined th
 const context = await chatSDK.getPostChatSurveyContext();
 ```
 
+### Get Agent Availability
+
+It gets information on whether a queue is available, and whether there are agents available in that queue, as well as queue position and average wait time. This call only supports authenticated chat.
+
+```ts
+const agentAvailability = await chatSDK.getAgentAvailability();
+```
+
 ## Common Scenarios
 
 ### Pre-Chat Survey

package/lib/OmnichannelChatSDK.d.ts

@@ -10,14 +10,15 @@ 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 GetAgentAvailabilityOptionalParams from "./core/GetAgentAvailabilityOptionalParams";
 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 InitializeOptionalParams from "./core/InitializeOptionalParams";
 import LiveChatContext from "./core/LiveChatContext";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
 import OmnichannelConfig from "./core/OmnichannelConfig";
@@ -88,6 +89,8 @@ declare class OmnichannelChatSDK {
     createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<unknown>;
     getVoiceVideoCalling(params?: any): Promise<any>;
     getPostChatSurveyContext(): Promise<any>;
+    getAgentAvailability(optionalParams?: GetAgentAvailabilityOptionalParams): Promise<any>;
+    private populateInitChatOptionalParam;
     private getIC3Client;
     private getChatConfig;
     private resolveIC3ClientUrl;

package/lib/OmnichannelChatSDK.js

@@ -58,6 +58,7 @@ 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 chatAdapterCreators_1 = require("./utils/chatAdapterCreators");
 var locale_1 = require("./utils/locale");
 var WebUtils_1 = require("./utils/WebUtils");
 var platform_1 = require("./utils/platform");
@@ -67,7 +68,6 @@ var AMSFileManager_1 = require("./external/ACSAdapter/AMSFileManager");
 var CallingOptionsOptionSetNumber_1 = require("./core/CallingOptionsOptionSetNumber");
 var ChatAdapterProtocols_1 = require("./core/messaging/ChatAdapterProtocols");
 var ChatSDKErrors_1 = require("./core/ChatSDKErrors");
-var chatAdapterCreators_1 = require("./utils/chatAdapterCreators");
 var ConversationMode_1 = require("./core/ConversationMode");
 var DeliveryMode_1 = require("@microsoft/omnichannel-ic3core/lib/model/DeliveryMode");
 var FileSharingProtocolType_1 = require("@microsoft/omnichannel-ic3core/lib/model/FileSharingProtocolType");
@@ -87,11 +87,13 @@ 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 location_1 = require("./utils/location");
 var utilities_1 = require("./utils/utilities");
 var urlResolvers_1 = require("./utils/urlResolvers");
 var OmnichannelConfigValidator_1 = require("./validators/OmnichannelConfigValidator");
 var OmnichannelChatSDK = /** @class */ (function () {
     function OmnichannelChatSDK(omnichannelConfig, chatSDKConfig) {
+        var _this = this;
         if (chatSDKConfig === void 0) { chatSDKConfig = SDKConfigValidators_1.defaultChatSDKConfig; }
         var _a, _b, _c, _d, _e, _f, _g, _h;
         this.ACSClient = null;
@@ -110,6 +112,55 @@ var OmnichannelChatSDK = /** @class */ (function () {
         this.isChatReconnect = false;
         this.reconnectId = null;
         this.refreshTokenTimer = null;
+        this.populateInitChatOptionalParam = function (requestOptionalParams, optionalParams) {
+            requestOptionalParams.initContext.locale = locale_1.getLocaleStringFromId(_this.localeId);
+            if (optionalParams.customContext) {
+                requestOptionalParams.initContext.customContextData = optionalParams.customContext; // eslint-disable-line @typescript-eslint/no-explicit-any
+            }
+            if (optionalParams.browser) {
+                requestOptionalParams.initContext.browser = optionalParams.browser;
+            }
+            if (optionalParams.os) {
+                requestOptionalParams.initContext.os = optionalParams.os;
+            }
+            if (optionalParams.locale) {
+                requestOptionalParams.initContext.locale = optionalParams.locale;
+            }
+            if (optionalParams.device) {
+                requestOptionalParams.initContext.device = optionalParams.device;
+            }
+            if (optionalParams.preChatResponse) {
+                requestOptionalParams.initContext.preChatResponse = optionalParams.preChatResponse;
+            }
+            if (optionalParams.sendDefaultInitContext) {
+                if (platform_1.default.isNode() || platform_1.default.isReactNative()) {
+                    var exceptionDetails = {
+                        response: ChatSDKErrors_1.default.UnsupportedPlatform,
+                        message: "sendDefaultInitContext is only supported on browser"
+                    };
+                    console.error(exceptionDetails.message);
+                    _this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAgentAvailability, {
+                        RequestId: _this.requestId,
+                        ChatId: _this.chatToken.chatId,
+                        ExceptionDetails: JSON.stringify(exceptionDetails)
+                    });
+                    throw new Error(exceptionDetails.response);
+                }
+                requestOptionalParams.getContext = true;
+            }
+            // Override initContext completely
+            if (optionalParams.initContext) {
+                requestOptionalParams.initContext = optionalParams.initContext;
+            }
+            if (_this.authenticatedUserToken) {
+                requestOptionalParams.authenticatedUserToken = _this.authenticatedUserToken;
+            }
+            if (_this.chatToken.chatId) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                requestOptionalParams.initContext.chatId = _this.chatToken.chatId;
+            }
+            return requestOptionalParams;
+        };
         this.debug = false;
         this.runtimeId = ocsdk_1.uuidv4();
         this.omnichannelConfig = omnichannelConfig;
@@ -308,44 +359,44 @@ var OmnichannelChatSDK = /** @class */ (function () {
         });
     };
     OmnichannelChatSDK.prototype.startChat = function (optionalParams) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
         if (optionalParams === void 0) { optionalParams = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            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 shouldReinitIC3Client, _v, reconnectableChatsParams, reconnectableChatsResponse, _w, exceptionDetails, conversationDetails, exceptionDetails, exceptionDetails, _x, exceptionDetails, sessionInitOptionalParams, location_2, error_3, exceptionDetails, chatAdapterConfig, error_4, exceptionDetails, _y, error_5, exceptionDetails, error_6, exceptionDetails, error_7, exceptionDetails, _z, error_8, exceptionDetails;
             var _this = this;
-            return __generator(this, function (_y) {
-                switch (_y.label) {
+            return __generator(this, function (_0) {
+                switch (_0.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];
-                        _t = this;
+                        _v = this;
                         return [4 /*yield*/, this.getIC3Client()];
                     case 1:
-                        _t.IC3Client = _y.sent();
-                        _y.label = 2;
+                        _v.IC3Client = _0.sent();
+                        _0.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];
-                        _y.label = 3;
+                        _0.label = 3;
                     case 3:
-                        _y.trys.push([3, 5, , 6]);
+                        _0.trys.push([3, 5, , 6]);
                         reconnectableChatsParams = {
                             authenticatedUserToken: this.authenticatedUserToken
                         };
                         return [4 /*yield*/, this.OCClient.getReconnectableChats(reconnectableChatsParams)];
                     case 4:
-                        reconnectableChatsResponse = _y.sent();
+                        reconnectableChatsResponse = _0.sent();
                         if (reconnectableChatsResponse && reconnectableChatsResponse.reconnectid) {
                             this.reconnectId = reconnectableChatsResponse.reconnectid;
                         }
                         return [3 /*break*/, 6];
                     case 5:
-                        _u = _y.sent();
+                        _w = _0.sent();
                         exceptionDetails = {
                             response: "OCClientGetReconnectableChatsFailed"
                         };
@@ -356,7 +407,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.requestId = optionalParams.liveChatContext.requestId || ocsdk_1.uuidv4();
                         return [4 /*yield*/, this.getConversationDetails()];
                     case 7:
-                        conversationDetails = _y.sent();
+                        conversationDetails = _0.sent();
                         if (Object.keys(conversationDetails).length === 0) {
                             exceptionDetails = {
                                 response: "InvalidConversation"
@@ -381,30 +432,30 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             console.error("Unable to join conversation that's in '" + conversationDetails.state + "' state");
                             throw Error(exceptionDetails.response);
                         }
-                        _y.label = 8;
+                        _0.label = 8;
                     case 8:
                         if (!this.authSettings) return [3 /*break*/, 14];
                         if (!!this.authenticatedUserToken) return [3 /*break*/, 10];
                         return [4 /*yield*/, this.setAuthTokenProvider(this.chatSDKConfig.getAuthToken)];
                     case 9:
-                        _y.sent();
-                        _y.label = 10;
+                        _0.sent();
+                        _0.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;
+                        _0.label = 11;
                     case 11:
-                        _y.trys.push([11, 13, , 14]);
+                        _0.trys.push([11, 13, , 14]);
                         return [4 /*yield*/, this.OCClient.validateAuthChatRecord(this.requestId, {
                                 authenticatedUserToken: this.authenticatedUserToken,
                                 chatId: this.chatToken.chatId
                             })];
                     case 12:
-                        _y.sent();
+                        _0.sent();
                         return [3 /*break*/, 14];
                     case 13:
-                        _v = _y.sent();
+                        _x = _0.sent();
                         exceptionDetails = {
                             response: "OCClientValidateAuthChatRecordFailed",
                             message: "InvalidAuthChatRecord"
@@ -419,8 +470,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         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;
+                        _0.sent();
+                        _0.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 || '');
@@ -430,73 +481,37 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         sessionInitOptionalParams = {
                             initContext: {}
                         };
-                        sessionInitOptionalParams.initContext.locale = locale_1.getLocaleStringFromId(this.localeId);
+                        sessionInitOptionalParams = this.populateInitChatOptionalParam(sessionInitOptionalParams, optionalParams);
+                        sessionInitOptionalParams.initContext.isProactiveChat = !!optionalParams.isProactiveChat;
                         if (this.isPersistentChat && !((_h = this.chatSDKConfig.persistentChat) === null || _h === void 0 ? void 0 : _h.disable)) {
                             sessionInitOptionalParams.reconnectId = this.reconnectId;
                         }
-                        if (this.isChatReconnect && !((_j = this.chatSDKConfig.chatReconnect) === null || _j === void 0 ? void 0 : _j.disable) && !this.isPersistentChat) {
+                        else if (this.isChatReconnect && !((_j = this.chatSDKConfig.chatReconnect) === null || _j === void 0 ? void 0 : _j.disable) && !this.isPersistentChat) {
                             sessionInitOptionalParams.reconnectId = this.reconnectId;
                         }
-                        if (optionalParams.customContext) {
-                            sessionInitOptionalParams.initContext.customContextData = optionalParams.customContext; // eslint-disable-line @typescript-eslint/no-explicit-any
-                        }
-                        if (optionalParams.browser) {
-                            sessionInitOptionalParams.initContext.browser = optionalParams.browser;
-                        }
-                        if (optionalParams.os) {
-                            sessionInitOptionalParams.initContext.os = optionalParams.os;
-                        }
-                        if (optionalParams.locale) {
-                            sessionInitOptionalParams.initContext.locale = optionalParams.locale;
-                        }
-                        if (optionalParams.device) {
-                            sessionInitOptionalParams.initContext.device = optionalParams.device;
-                        }
-                        if (optionalParams.preChatResponse) {
-                            sessionInitOptionalParams.initContext.preChatResponse = optionalParams.preChatResponse;
-                        }
-                        if (optionalParams.sendDefaultInitContext) {
-                            if (platform_1.default.isNode() || platform_1.default.isReactNative()) {
-                                exceptionDetails = {
-                                    response: ChatSDKErrors_1.default.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;
-                        }
-                        if (this.authenticatedUserToken) {
-                            sessionInitOptionalParams.authenticatedUserToken = this.authenticatedUserToken;
-                        }
-                        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;
+                        if (!(((_l = (_k = this.liveChatConfig) === null || _k === void 0 ? void 0 : _k.LiveWSAndLiveChatEngJoin) === null || _l === void 0 ? void 0 : _l.msdyn_requestvisitorlocation) === "true")) return [3 /*break*/, 18];
+                        return [4 /*yield*/, location_1.getLocationInfo(this.scenarioMarker, this.chatToken.chatId, this.requestId)];
                     case 17:
-                        _y.trys.push([17, 19, , 20]);
-                        return [4 /*yield*/, this.OCClient.sessionInit(this.requestId, sessionInitOptionalParams)];
+                        location_2 = _0.sent();
+                        sessionInitOptionalParams.initContext.latitude = location_2.latitude;
+                        sessionInitOptionalParams.initContext.longitude = location_2.longitude;
+                        _0.label = 18;
                     case 18:
-                        _y.sent();
-                        return [3 /*break*/, 20];
+                        if (!!optionalParams.liveChatContext) return [3 /*break*/, 22];
+                        _0.label = 19;
                     case 19:
-                        error_3 = _y.sent();
+                        _0.trys.push([19, 21, , 22]);
+                        return [4 /*yield*/, this.OCClient.sessionInit(this.requestId, sessionInitOptionalParams)];
+                    case 20:
+                        _0.sent();
+                        return [3 /*break*/, 22];
+                    case 21:
+                        error_3 = _0.sent();
                         exceptionDetails = {
                             response: "OCClientSessionInitFailed"
                         };
                         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        if (((_k = error_3) === null || _k === void 0 ? void 0 : _k.isAxiosError) && ((_m = (_l = error_3.response) === null || _l === void 0 ? void 0 : _l.headers) === null || _m === void 0 ? void 0 : _m.errorcode.toString()) === OmnichannelErrorCodes_1.default.WidgetUseOutsideOperatingHour.toString()) {
+                        if (((_m = error_3) === null || _m === void 0 ? void 0 : _m.isAxiosError) && ((_p = (_o = error_3.response) === null || _o === void 0 ? void 0 : _o.headers) === null || _p === void 0 ? void 0 : _p.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);
@@ -507,8 +522,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
                         throw new Error(exceptionDetails.response);
-                    case 20:
-                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 31];
+                    case 22:
+                        if (!(this.liveChatVersion === LiveChatVersion_1.default.V2)) return [3 /*break*/, 33];
                         chatAdapterConfig = {
                             token: this.chatToken.token,
                             id: this.chatToken.visitorId || 'teamsvisitor',
@@ -516,18 +531,18 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             environmentUrl: this.chatToken.acsEndpoint,
                             pollingInterval: 30000
                         };
-                        _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({
+                        _0.label = 23;
+                    case 23:
+                        _0.trys.push([23, 25, , 26]);
+                        return [4 /*yield*/, ((_q = this.ACSClient) === null || _q === void 0 ? void 0 : _q.initialize({
                                 token: chatAdapterConfig.token,
                                 environmentUrl: chatAdapterConfig.environmentUrl
                             }))];
-                    case 22:
-                        _y.sent();
-                        return [3 /*break*/, 24];
-                    case 23:
-                        error_4 = _y.sent();
+                    case 24:
+                        _0.sent();
+                        return [3 /*break*/, 26];
+                    case 25:
+                        error_4 = _0.sent();
                         exceptionDetails = {
                             response: "ACSClientInitializeFailed"
                         };
@@ -538,23 +553,23 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_4);
                         return [2 /*return*/, error_4];
-                    case 24:
-                        _y.trys.push([24, 26, , 27]);
-                        _w = this;
-                        return [4 /*yield*/, ((_p = this.ACSClient) === null || _p === void 0 ? void 0 : _p.joinConversation({
+                    case 26:
+                        _0.trys.push([26, 28, , 29]);
+                        _y = this;
+                        return [4 /*yield*/, ((_r = this.ACSClient) === null || _r === void 0 ? void 0 : _r.joinConversation({
                                 id: chatAdapterConfig.id,
                                 threadId: chatAdapterConfig.threadId,
                                 pollingInterval: chatAdapterConfig.pollingInterval
                             }))];
-                    case 25:
-                        _w.conversation = (_y.sent());
+                    case 27:
+                        _y.conversation = (_0.sent());
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 27];
-                    case 26:
-                        error_5 = _y.sent();
+                        return [3 /*break*/, 29];
+                    case 28:
+                        error_5 = _0.sent();
                         exceptionDetails = {
                             response: "ACSClientJoinConversationFailed"
                         };
@@ -565,16 +580,16 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_5);
                         throw Error(exceptionDetails.response);
-                    case 27:
-                        _y.trys.push([27, 29, , 30]);
-                        return [4 /*yield*/, ((_q = this.AMSClient) === null || _q === void 0 ? void 0 : _q.initialize({
+                    case 29:
+                        _0.trys.push([29, 31, , 32]);
+                        return [4 /*yield*/, ((_s = this.AMSClient) === null || _s === void 0 ? void 0 : _s.initialize({
                                 chatToken: this.chatToken
                             }))];
-                    case 28:
-                        _y.sent();
-                        return [3 /*break*/, 30];
-                    case 29:
-                        error_6 = _y.sent();
+                    case 30:
+                        _0.sent();
+                        return [3 /*break*/, 32];
+                    case 31:
+                        error_6 = _0.sent();
                         exceptionDetails = {
                             response: "AMSClientInitializeFailed"
                         };
@@ -584,19 +599,19 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
                         throw Error(exceptionDetails.response);
-                    case 30: return [3 /*break*/, 37];
-                    case 31:
-                        _y.trys.push([31, 33, , 34]);
+                    case 32: return [3 /*break*/, 39];
+                    case 33:
+                        _0.trys.push([33, 35, , 36]);
                         return [4 /*yield*/, this.IC3Client.initialize({
                                 token: this.chatToken.token,
                                 regionGtms: this.chatToken.regionGTMS,
                                 visitor: true
                             })];
-                    case 32:
-                        _y.sent();
-                        return [3 /*break*/, 34];
-                    case 33:
-                        error_7 = _y.sent();
+                    case 34:
+                        _0.sent();
+                        return [3 /*break*/, 36];
+                    case 35:
+                        error_7 = _0.sent();
                         exceptionDetails = {
                             response: "IC3ClientInitializeFailed"
                         };
@@ -607,19 +622,19 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/initialize/error " + error_7);
                         return [2 /*return*/, error_7];
-                    case 34:
-                        _y.trys.push([34, 36, , 37]);
-                        _x = this;
+                    case 36:
+                        _0.trys.push([36, 38, , 39]);
+                        _z = this;
                         return [4 /*yield*/, this.IC3Client.joinConversation(this.chatToken.chatId)];
-                    case 35:
-                        _x.conversation = _y.sent();
+                    case 37:
+                        _z.conversation = _0.sent();
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.StartChat, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 37];
-                    case 36:
-                        error_8 = _y.sent();
+                        return [3 /*break*/, 39];
+                    case 38:
+                        error_8 = _0.sent();
                         exceptionDetails = {
                             response: "IC3ClientJoinConversationFailed"
                         };
@@ -630,8 +645,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         console.error("OmnichannelChatSDK/startChat/joinConversation/error " + error_8);
                         return [2 /*return*/, error_8];
-                    case 37:
-                        if (this.isPersistentChat && !((_r = this.chatSDKConfig.persistentChat) === null || _r === void 0 ? void 0 : _r.disable)) {
+                    case 39:
+                        if (this.isPersistentChat && !((_t = this.chatSDKConfig.persistentChat) === null || _t === void 0 ? void 0 : _t.disable)) {
                             this.refreshTokenTimer = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
                                 return __generator(this, function (_a) {
                                     switch (_a.label) {
@@ -642,7 +657,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                                             return [2 /*return*/];
                                     }
                                 });
-                            }); }, (_s = this.chatSDKConfig.persistentChat) === null || _s === void 0 ? void 0 : _s.tokenUpdateTime);
+                            }); }, (_u = this.chatSDKConfig.persistentChat) === null || _u === void 0 ? void 0 : _u.tokenUpdateTime);
                         }
                         return [2 /*return*/];
                 }
@@ -1818,6 +1833,60 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
+    OmnichannelChatSDK.prototype.getAgentAvailability = function (optionalParams) {
+        if (optionalParams === void 0) { optionalParams = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var reportError, getAgentAvailabilityOptionalParams, response, e_1;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        reportError = function (response, message, chatId) {
+                            if (chatId === void 0) { chatId = ""; }
+                            var exceptionDetails = {
+                                response: response,
+                                message: message
+                            };
+                            _this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAgentAvailability, {
+                                RequestId: _this.requestId,
+                                ExceptionDetails: JSON.stringify(exceptionDetails),
+                                ChatId: chatId
+                            });
+                            throw new Error(exceptionDetails.message);
+                        };
+                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetAgentAvailability, {
+                            RequestId: this.requestId
+                        });
+                        if (!this.authSettings) {
+                            reportError("Unsupported", "GetAgentAvailability is supported only for authenticated live chat widget.");
+                        }
+                        if (!this.authenticatedUserToken) {
+                            reportError("UndefinedAuthToken", "Missing AuthToken for GetAgentAvailability.");
+                        }
+                        if (this.conversation) {
+                            reportError("InvalidOperation", "GetAgentAvailability can only be called before a chat has started.", this.chatToken.chatId);
+                        }
+                        getAgentAvailabilityOptionalParams = {
+                            initContext: {}
+                        };
+                        getAgentAvailabilityOptionalParams = this.populateInitChatOptionalParam(getAgentAvailabilityOptionalParams, optionalParams);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.OCClient.getAgentAvailability(this.requestId, getAgentAvailabilityOptionalParams)];
+                    case 2:
+                        response = _a.sent();
+                        return [2 /*return*/, response];
+                    case 3:
+                        e_1 = _a.sent();
+                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                        reportError("GetAgentAvailabilityFailed", e_1.message);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     OmnichannelChatSDK.prototype.getIC3Client = function () {
         return __awaiter(this, void 0, void 0, function () {
             var IC3Client;