@microsoft/omnichannel-chat-sdk 1.0.1-main.8af1160 → 1.0.1-main.935a7e1

package/CHANGELOG.md

@@ -3,6 +3,35 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+- Add `getPostChatSurveyContext` API method
+- Add `GetPostChatSurveyContext` telemetry event
+- Add `widgetId` & `clientMessageId` as metadata on sending message
+- Update `ChatConfig` interface with `LiveChatVersion`, `allowedFileExtensions` & `maxUploadFileSize` properties
+- Add ability to automatically detect locale from chat config
+- Add `runtimeId` attribute in `OmnichannelChatSDK` & `ChatSDKRuntimeId` field in telemetry
+- 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`
+- Update `ChatConfig` interface with `msdyn_enablemarkdown` property
+- Throw exception on `ChatSDK.getVoiceVideoCalling()` if feature is disabled or platform is not supported
+- Add `participantType` & `canRenderPostChat` as response of getConversationDetails() API
+- Add support for separate bot post chat survey feature
+
+### 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.
+- Uptake [@azure/communication-chat@1.1.1](https://www.npmjs.com/package/@azure/communication-chat/v/1.1.1)
+- Uptake [acs_webchat-chat-adapter@0.0.35-beta.2](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.2/dist/chat-adapter.js)
+- Update `locale` property in `ChatTranscriptBody` interface to be optional
+
 ## [1.0.0] - 2021-10-08
 ### Added
 - Add `GetAuthToken` & `GetPreChatSurvey` telemetry events

package/README.md

@@ -14,7 +14,7 @@ Please make sure you have a chat widget configured before using this package or
 - [Installation on React Native](#installation-on-react-native)
 - [API Reference](#api-reference)
 - [API Examples](#api-examples)
-- [Sample Apps](samples/)
+- [Sample Apps](https://github.com/microsoft/omnichannel-chat-sdk-samples)
 - [Common Scenarios](#common-scenarios)
 - [Feature Comparisons](#feature-comparisons)
 - [Telemetry](#telemetry)
@@ -35,14 +35,12 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | Bring Your Own Widget | ❌ | ✔ | |
 | Web Support | ✔ | ✔ |
 | React Native Support | ❌ | ✔ |
-| Escalation to Voice & Video | ✔ | Web Only |
-| Co-browse | ✔ | Web Only |
-| Screen Sharing | ✔ | Web Only |
+| Escalation to Voice & Video | ✔ | ✔ | Only supported on Web |
+| Co-browse | ✔ | 3rd party add-on | Only supported on Web |
+| Screen Sharing | ✔ | 3rd party add-on | Only supported on Web |
 | Authenticated Chat | ✔ | ✔ |
 | Pre-chat Survey | ✔ | ✔ |
-| Post-chat Survey | ✔ | ❌ |
-| Queue Position | ✔ | ✔ |
-| Average Wait Time | ✔ | ✔ |
+| Post-chat Survey | ✔ | ✔ |
 | Download Transcript | ✔ | ✔ |
 | Email Transcript | ✔ | ✔ |
 | Data Masking | ✔ | ✔ |
@@ -52,6 +50,8 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | Persistent Chat | ✔ | ✔ |
 | Chat Reconnect | ✔ | ✔ |
 | Operating Hours | ✔ | ✔ |
+| Queue Position | ✔ | ✔ | No SDK method. Handled as *system message* |
+| Average Wait Time | ✔ | ✔ | No SDK method. Handled as *system message* |
 
 **\*** BYOI: Bring Your Own Implementation
 
@@ -65,7 +65,26 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 
 The following steps will be required to run Omnichannel Chat SDK on React Native:
 
-1. Run `npm install node-libs-react-native --save-dev`
+1. Install `node-libs-react-native`
+    ```
+    npm install node-libs-react-native --save-dev
+    ```
+
+1. Install `react-native-randomBytes`
+    ```
+    npm install react-native-randombytes --save-dev
+    ```
+
+1. Install `react-native-get-random-values`
+    ```
+    npm install react-native-get-random-values --save-dev
+    ```
+
+1. Install `react-native-url-polyfill`
+    ```
+    npm install react-native-url-polyfill --save-dev
+    ```
+
 1. Update *metro.config.js* to use React Native compatible Node Core modules
     ```ts
     module.exports = {
@@ -80,14 +99,11 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     };
     ```
 
-1. Import 'node-libs-react-native/globals' on top of your entry point file
+1. Add following *import* on top of your entry point file
     ```ts
     import 'node-libs-react-native/globals';
-    ```
-
-1. Install `react-native-randomBytes`
-    ```
-    npm install react-native-randombytes --save-dev
+    import 'react-native-get-random-values';
+    import 'react-native-url-polyfill';
     ```
 
 ## API Reference
@@ -115,8 +131,9 @@ 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.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video| **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 | |
 
 ## API examples
 
@@ -194,6 +211,21 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
     const preChatSurvey = await getPreChatSurvey(parseToJSON); // Adaptive Cards payload data as string
 ```
 
+### Get PostChat Survey
+```ts
+    try {
+        const context = await chatSDK.getPostChatSurveyContext();
+        if (context.participantJoined) { // participantJoined will be true if an agent has joined the conversation, or a bot has joined the conversation and the bot survey flag has been turned on on the admin side.
+            // formsProLocale is the default language you have set on the CustomerVoice portal. You can override this url parameter with any locale that CustomerVoice supports.
+            // If "&lang=" is not set on the url, the locale will be English.
+            const linkToSend = context.surveyInviteLink + "&lang=" + context.formsProLocale;
+            // This link is accessible and will redirect to the survey page. Use it as you see fit.
+        }
+    } catch (ex) {
+        // If the post chat should not be shown by any reason (e.g. post chat is not enabled), promise will be rejected.
+    }
+```
+
 ### Start Chat
 ```ts
     const customContext = {
@@ -303,8 +335,7 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
 ```ts
     const body = {
         emailAddress: 'contoso@microsoft.com',
-        attachmentMessage: 'Attachment Message',
-        locale: 'en-us'
+        attachmentMessage: 'Attachment Message'
     };
     await chatSDK.emailLiveChatTranscript(body);
 ```
@@ -565,82 +596,93 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
         console.log("VoiceVideoCalling loaded");
     } catch (e) {
         console.log(`Failed to load VoiceVideoCalling: ${e}`);
+
+        if (e.message === 'UnsupportedPlatform') {
+            // Voice Video Calling feature is not supported on this platform
+        }
+
+        if (e.message === 'FeatureDisabled') {
+            // Voice Video Calling feature is disabled on admin side
+        }
     }
 
     await chatSDK.startChat();
 
     const chatToken: any = await chatSDK.getChatToken();
 
-    try {
-        await VoiceVideoCallingSDK.initialize({
-            chatToken,
-            selfVideoHTMLElementId: 'selfVideo', // HTML element id where video stream of the agent will be rendered
-            remoteVideoHTMLElementId: 'remoteVideo', // HTML element id where video stream of the customer will be rendered
-            OCClient: chatSDK.OCClient
-        });
-    } catch (e) {
-        console.error("Failed to initialize VoiceVideoCalling!");
-    }
+    // Initialize only if VoiceVideoCallingSDK is defined
+    if (VoiceVideoCallingSDK) {
+        try {
+            await VoiceVideoCallingSDK.initialize({
+                chatToken,
+                selfVideoHTMLElementId: 'selfVideo', // HTML element id where video stream of the agent will be rendered
+                remoteVideoHTMLElementId: 'remoteVideo', // HTML element id where video stream of the customer will be rendered
+                OCClient: chatSDK.OCClient
+            });
+        } catch (e) {
+            console.error("Failed to initialize VoiceVideoCalling!");
+        }
 
-    // Triggered when there's an incoming call
-    VoiceVideoCallingSDK.onCallAdded(() => {
-        ...
-    });
+        // Triggered when there's an incoming call
+        VoiceVideoCallingSDK.onCallAdded(() => {
+            ...
+        });
 
-    // Triggered when local video stream is available (e.g.: Local video added succesfully in selfVideoHTMLElement)
-    VoiceVideoCallingSDK.onLocalVideoStreamAdded(() => {
-        ...
-    });
+        // Triggered when local video stream is available (e.g.: Local video added succesfully in selfVideoHTMLElement)
+        VoiceVideoCallingSDK.onLocalVideoStreamAdded(() => {
+            ...
+        });
 
-    // Triggered when local video stream is unavailable (e.g.: Customer turning off local video)
-    VoiceVideoCallingSDK.onLocalVideoStreamRemoved(() => {
-        ...
-    });
+        // Triggered when local video stream is unavailable (e.g.: Customer turning off local video)
+        VoiceVideoCallingSDK.onLocalVideoStreamRemoved(() => {
+            ...
+        });
 
-    // Triggered when remote video stream is available (e.g.: Remote video added succesfully in remoteVideoHTMLElement)
-    VoiceVideoCallingSDK.onRemoteVideoStreamAdded(() => {
-        ...
-    });
+        // Triggered when remote video stream is available (e.g.: Remote video added succesfully in remoteVideoHTMLElement)
+        VoiceVideoCallingSDK.onRemoteVideoStreamAdded(() => {
+            ...
+        });
 
-    // Triggered when remote video stream is unavailable (e.g.: Agent turning off remote video)
-    VoiceVideoCallingSDK.onRemoteVideoStreamRemoved(() => {
-        ...
-    });
+        // Triggered when remote video stream is unavailable (e.g.: Agent turning off remote video)
+        VoiceVideoCallingSDK.onRemoteVideoStreamRemoved(() => {
+            ...
+        });
 
-    // Triggered when current call has ended or disconnected regardless the party
-    VoiceVideoCalling.onCallDisconnected(() => {
-        ...
-    });
+        // Triggered when current call has ended or disconnected regardless the party
+        VoiceVideoCalling.onCallDisconnected(() => {
+            ...
+        });
 
-    // Check if microphone is muted
-    const isMicrophoneMuted = VoiceVideoCallingSDK.isMicrophoneMuted();
+        // Check if microphone is muted
+        const isMicrophoneMuted = VoiceVideoCallingSDK.isMicrophoneMuted();
 
-    // Check if remote video is available
-    const isRemoteVideoEnabled = VoiceVideoCallingSDK.isRemoteVideoEnabled();
+        // Check if remote video is available
+        const isRemoteVideoEnabled = VoiceVideoCallingSDK.isRemoteVideoEnabled();
 
-    // Check if local video is available
-    const isLocalVideoEnabled = VoiceVideoCallingSDK.isLocalVideoEnabled();
+        // Check if local video is available
+        const isLocalVideoEnabled = VoiceVideoCallingSDK.isLocalVideoEnabled();
 
-    // Accepts incoming call
-    const acceptCallConfig = {
-        withVideo: true // Accept call with/without video stream
-    };
-    await VoiceVideoCallingSDK.acceptCall(acceptCallConfig);
+        // Accepts incoming call
+        const acceptCallConfig = {
+            withVideo: true // Accept call with/without video stream
+        };
+        await VoiceVideoCallingSDK.acceptCall(acceptCallConfig);
 
-    // Rejects incoming call
-    await VoiceVideoCallingSDK.rejectCall();
+        // Rejects incoming call
+        await VoiceVideoCallingSDK.rejectCall();
 
-    // Ends/Stops current call
-    await VoiceVideoCallingSDK.stopCall();
+        // Ends/Stops current call
+        await VoiceVideoCallingSDK.stopCall();
 
-    // Mute/Unmute current call
-    await VoiceVideoCallingSDK.toggleMute()
+        // Mute/Unmute current call
+        await VoiceVideoCallingSDK.toggleMute()
 
-    // Display/Hide local video of current call
-    await VoiceVideoCallingSDK.toggleLocalVideo()
+        // Display/Hide local video of current call
+        await VoiceVideoCallingSDK.toggleLocalVideo()
 
-    // Clean up VoiceVideoCallingSDK (e.g.: Usually called when customer ends chat session)
-    VoiceVideoCallingSDK.close();
+        // Clean up VoiceVideoCallingSDK (e.g.: Usually called when customer ends chat session)
+        VoiceVideoCallingSDK.close();
+    }
 ```
 
 ## Feature Comparisons

package/lib/OmnichannelChatSDK.d.ts

@@ -1,11 +1,12 @@
 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";
 import ChatSDKConfig from "./core/ChatSDKConfig";
 import ChatSDKMessage from "./core/messaging/ChatSDKMessage";
 import ChatTranscriptBody from "./core/ChatTranscriptBody";
-import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
 import FramedClient from "@microsoft/omnichannel-amsclient/lib/FramedClient";
 import FramedlessClient from "@microsoft/omnichannel-amsclient/lib/FramedlessClient";
@@ -13,16 +14,17 @@ import IChatToken from "./external/IC3Adapter/IChatToken";
 import IFileInfo from "@microsoft/omnichannel-ic3core/lib/interfaces/IFileInfo";
 import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
 import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
-import OmnichannelConfig from "./core/OmnichannelConfig";
 import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
 import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import LiveChatContext from "./core/LiveChatContext";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
-import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
+import OmnichannelConfig from "./core/OmnichannelConfig";
 import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
+import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
 declare class OmnichannelChatSDK {
     private debug;
+    runtimeId: string;
     OCSDKProvider: unknown;
     IC3SDKProvider: unknown;
     OCClient: any;
@@ -32,6 +34,7 @@ declare class OmnichannelChatSDK {
     omnichannelConfig: OmnichannelConfig;
     chatSDKConfig: ChatSDKConfig;
     isInitialized: boolean;
+    localeId: string;
     requestId: string;
     private chatToken;
     private liveChatConfig;
@@ -48,6 +51,7 @@ declare class OmnichannelChatSDK {
     private ocSdkLogger;
     private acsClientLogger;
     private acsAdapterLogger;
+    private callingSdkLogger;
     private isPersistentChat;
     private isChatReconnect;
     private reconnectId;
@@ -79,12 +83,14 @@ 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;
     private getChatConfig;
     private resolveIC3ClientUrl;
     private resolveChatAdapterUrl;
     private updateChatToken;
+    private setAuthTokenProvider;
 }
 export default OmnichannelChatSDK;