@microsoft/omnichannel-chat-sdk 1.2.1-main.2a7572c → 1.2.1-main.30dca50

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+### 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
+- Pass `logger` to AMSClient
+- Add `portalContactId` in `StartChatOptionalParams` and `GetAgentAvailabilityOptionalParams`
+- Added exception on initialization failure
+- Upgraded ACSAdapter to version beta.17
+- Added `botSurveyInviteLink` and `botFormsProLocale` the `getPostChatSurveyContext()` response
+
+### Fixed
+- Fix `ChatAdapterOptionalParams.ACSAdapter.options.egressMiddleware` being used as `ingressMiddleware`
+- Fix `ChatSDK.onTypingEvent()` being triggered on current user typing
+- Update `ChatSDK.liveChatVersion` to be `V2` by default
+
+### Changed
+- Uptake [@microsoft/omnichannel-amsclient@0.1.4](https://www.npmjs.com/package/@microsoft/omnichannel-amsclient/v/0.1.4)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.17](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.17/dist/chat-adapter.js)
+- Uptake [@microsoft/ocsdk@0.3.4](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.4)
 
 ## [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* |
 
@@ -125,6 +126,11 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     npm install react-native-url-polyfill --save-dev
     ```
 
+1. Install `@azure/core-asynciterator-polyfill`
+    ```
+    npm install @azure/core-asynciterator-polyfill --save-dev
+    ```
+
 1. Update *metro.config.js* to use React Native compatible Node Core modules
     ```ts
     module.exports = {
@@ -143,7 +149,8 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     ```ts
     import 'node-libs-react-native/globals';
     import 'react-native-get-random-values';
-    import 'react-native-url-polyfill';
+    import 'react-native-url-polyfill/auto';
+    import '@azure/core-asynciterator-polyfill';
     ```
 
 ## SDK Methods
@@ -438,10 +445,18 @@ try {
 ```
 ### Get Post Chat Survey Context
 
-It gets post chat survey link, survey locale, and whether an agent has joined the survey.
+It gets the participant type that should be used for the survey and both the default and bot survey details.
+
+```ts
+const postChatSurveyContext = 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 context = await chatSDK.getPostChatSurveyContext();
+const agentAvailability = await chatSDK.getAgentAvailability();
 ```
 
 ## Common Scenarios
@@ -497,7 +512,9 @@ try {
     if (context.participantJoined) { // participantJoined will be true if an agent has joined the conversation, or a bot has joined the conversation and the bot survey flag has been turned on on the admin side.
         // formsProLocale is the default language you have set on the CustomerVoice portal. You can override this url parameter with any locale that CustomerVoice supports.
         // If "&lang=" is not set on the url, the locale will be English.
-        const linkToSend = context.surveyInviteLink + "&lang=" + context.formsProLocale;
+        const link = context.participantType === "Bot" ? context.botSurveyInviteLink : context.surveyInviteLink;
+        const locale = context.participantType === "Bot" ? context.botFormsProLocale : context.formsProLocale;
+        const linkToSend = link + "&lang=" + locale;
         // This link is accessible and will redirect to the survey page. Use it as you see fit.
     }
 } catch (ex) {

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";
@@ -54,6 +55,7 @@ declare class OmnichannelChatSDK {
     private acsClientLogger;
     private acsAdapterLogger;
     private callingSdkLogger;
+    private amsClientLogger;
     private isPersistentChat;
     private isChatReconnect;
     private reconnectId;
@@ -88,6 +90,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;