@microsoft/omnichannel-chat-sdk 0.2.1-main.c6982c2 → 0.3.1-main.31aff70

package/CHANGELOG.md

@@ -2,14 +2,41 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+
+### Changed
+- Uptake [@microsoft/ocsdk@0.3.0](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.0)
+- Use `lockfileVersion: 2` in `package-lock.json` via npm v7
+
+### Fixed
+- `onNewMessage` with `rehydrate` flag set to `true` crashing when `getMessages` returns `undefined`
+- Fix `AriaTelemetry` unable to read property `logEvent` of undefined on `React Native`
+- Fix `Escalation to Voice & Video` library not being imported properly
+
+## [0.3.0] - 2021-09-03
+### Added
+- Persistent Chat Support
+- Chat Reconnect Support
+- Operating Hours Documentation
+
 ### Changed
 - Uptake [@microsoft/ocsdk@0.2.0](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.2.0)
 - Add `getCallingToken`
+- Send `ChannelId-lcw` message tag
+- Uptake [IC3Client@2021.08.14.1](https://comms.omnichannelengagementhub.com/release/2021.08.14.1/Scripts/SDK/SDK.min.js)
+- Uptake [botframework-webchat-adapter-ic3@0.1.0-master.2dba07b](https://www.npmjs.com/package/botframework-webchat-adapter-ic3/v/0.1.0-master.2dba07b)
+- Uptake [jest@27.1.0](https://www.npmjs.com/package/jest/v/27.1.0)
+- Update [@types/jest@27.0.1](https://www.npmjs.com/package/@types/jest/v/27.0.1)
+- Uptake [ts-jest@27.0.5](https://www.npmjs.com/package/ts-jest/v/27.0.5)
+
+### Fixed
+- `msdyn_enablechatreconnect` not being parsed properly
+- Fix unable to start multiple conversations with same instance due to chat client being disposed
+- Pass logger to adapter
 
 ## [0.2.0] - 2021-04-30
 ### Added
 - React Native sample app using Omnichannel Chat SDK with [react-native-gifted-chat](https://github.com/FaridSafi/react-native-gifted-chat)
-- Escalation to Voice & View support (Web Only)
+- Escalation to Voice & Video support (Web Only)
 - React sample app using Omnichannel Chat SDK with [BotFramework-WebChat](https://github.com/microsoft/BotFramework-WebChat)
 - Expose `sessiontInit`'s `initContext` on `startChat`'s optional paramaters
 - Add ability to use custom `ic3Config` & `chatAdapterConfig`

package/README.md

@@ -2,6 +2,7 @@
 
 [![npm version](https://badge.fury.io/js/%40microsoft%2Fomnichannel-chat-sdk.svg)](https://badge.fury.io/js/%40microsoft%2Fomnichannel-chat-sdk)
 ![Release CI](https://github.com/microsoft/omnichannel-chat-sdk/workflows/Release%20CI/badge.svg)
+![npm](https://img.shields.io/npm/dm/@microsoft/omnichannel-chat-sdk)
 
 Headless Chat SDK to build your own chat widget against Dynamics 365 Omnichannel Services.
 
@@ -16,6 +17,7 @@ Please make sure you have a chat widget configured before using this package or
 - [Common Scenarios](#common-scenarios)
 - [Feature Comparisons](#feature-comparisons)
 - [Telemetry](#telemetry)
+- [Troubleshooting Guide](docs/TROUBLESHOOTING_GUIDE.md)
 
 ## Live Chat Widget vs. Chat SDK
 
@@ -46,6 +48,9 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | File Attachments | ✔ | ✔ |
 | Custom Context | ✔ | ✔ |
 | Proactive Chat | ✔ | BYOI **\*** |
+| Persistent Chat | ✔ | ✔ |
+| Chat Reconnect | ✔ | ✔ |
+| Operating Hours | ✔ | ✔ |
 
 **\*** BYOI: Bring Your Own Implementation
 
@@ -66,6 +71,7 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
 | OmnichannelChatSDK.getLiveChatConfig() | Get live chat config | |
 | OmnichannelChatSDK.getDataMaskingRules() | Get active data masking rules | |
 | OmnichannelChatSDK.getCurrentLiveChatContext() | Get current live chat context information to reconnect to the same chat | |
+| OmnichannelChatSDK.getChatReconnectContext() | Get current reconnectable chat context information to reconnect to a previous existing chat session | |
 | OmnichannelChatSDK.getConversationDetails() | Get details of the current conversation such as its state & when the agent joined the conversation | |
 | OmnichannelChatSDK.getChatToken() | Get chat token | |
 | OmnichannelChatSDK.getCallingToken() | Get calling token | |
@@ -113,6 +119,15 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
     const liveChatContext = await chatSDK.getCurrentLiveChatContext();
 ```
 
+### Get Current Chat Reconnect Context
+```ts
+    const optionalParams = {
+        reconnectId: '', // reconnect Id
+    };
+
+    const chatReconnectContext = await chatSDK.getChatReconnectContext(optionalParams);
+```
+
 ### Get Conversation Details
 ```ts
     const conversationDetails = await chatSDK.getConversationDetails();
@@ -351,6 +366,125 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
     // from this point, this acts like a regular chat widget
 ```
 
+### Persistent Chat
+
+```ts
+    const chatSDKConfig = {
+        persistentChat: {
+            disable: false,
+            tokenUpdateTime: 21600000
+        },
+        getAuthToken: async () => {
+            const response = await fetch("http://contosohelp.com/token");
+            if (response.ok) {
+                return await response.text();
+            }
+            else {
+                return null
+            }
+        }
+    }
+
+    const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
+    await chatSDK.initialize();
+
+    // from this point, this acts like a persistent chat
+```
+### Chat Reconnect with Authenticated User
+
+```ts
+    const chatSDKConfig = {
+        chatReconnect: {
+            disable: false,
+        },
+        getAuthToken: async () => {
+            const response = await fetch("http://contosohelp.com/token");
+            if (response.ok) {
+                return await response.text();
+            }
+            else {
+                return null
+            }
+        }
+    }
+
+    const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
+    await chatSDK.initialize();
+
+    ...
+
+    const chatReconnectContext = await chatSDK.getChatReconnectContext();
+
+    if (chatReconnectContext.reconnectId) {
+       // Add UX with options to reconnect to previous existing chat or start new chat
+    }
+
+    // Reconnect chat option
+    const optionalParams = {};
+    optionalParams.reconnectId = chatReconnectContext.reconnectId;
+    chatSDK.startChat(optionalParams);
+
+    // Start new chat option
+    chatSDK.startChat();
+```
+
+### Chat Reconnect with Unauthenticated User
+
+```ts
+    const chatSDKConfig = {
+        chatReconnect: {
+            disable: false,
+        },
+    }
+
+    const chatSDK = new OmnichannelChatSDK.OmnichannelChatSDK(omnichannelConfig, chatSDKConfig);
+    await chatSDK.initialize();
+
+    ....
+
+    const optionalParams: any = {};
+
+    // Retrieve reconnect id from the URL
+    const urlParams = new URLSearchParams(window.location.search);
+    const reconnectId = urlParams.get('oc.reconnectid');
+
+    const params = {
+        reconnectId
+    };
+
+    // Validate reconnect id
+    const chatReconnectContext = await chatSDK.getChatReconnectContext(params);
+
+    // If the reconnect id is invalid or expired, redirect URL if there is any URL set in the configuration
+    if (chatReconnectContext.redirectURL) {
+        window.location.replace(chatReconnectContext.redirectURL);
+    }
+
+    // Valid reconnect id, reconnect to previous chat
+    if (chatReconnectContext.reconnectId) {
+        await chatSDK.startChat({
+            reconnectId: chatReconnectContext.reconnectId
+        });
+    } else {  // Reconnect id from URL is not valid, start new chat session
+        await chatSDK.startChat();
+    }
+```
+
+### Operating Hours
+
+```ts
+    const chatConfig = await chatSDK.getLiveChatConfig();
+    const {LiveWSAndLiveChatEngJoin: liveWSAndLiveChatEngJoin} = liveChatConfig;
+    const {OutOfOperatingHours: outOfOperatingHours} = liveWSAndLiveChatEngJoin;
+
+    if (outOfOperatingHours === "True") {
+        // Handles UX on Out of Operating Hours
+    } else {
+        await chatSDK.startChat();
+        // Renders Custom Chat Widget
+    }
+```
+
 ### Use [BotFramework-WebChat](https://github.com/microsoft/BotFramework-WebChat)
 
 **NOTE**: Currently supported on web only
@@ -370,20 +504,12 @@ Omnichannel offers an live chat widget (LCW) by default. You can use the Chat SD
     await chatSDK.startChat(optionalParams);
     const chatAdapter = await chatSDK.createChatAdapter();
 
-    // Subscribes to incoming message (OPTION 1)
+    // Subscribes to incoming message
     chatSDK.onNewMessage((message) => {
       console.log(`[NewMessage] ${message.content}`); // IC3 protocol message data
       console.log(message);
     });
 
-    // Subscribes to incoming message (OPTION 2)
-    (chatAdapter as any).activity$.subscribe((activity: any) => {
-        if (activity.type === "message") {
-            console.log("[Message activity]");
-            console.log(activity); // DirectLine protocol activity data
-        }
-    });
-
     ...
 
     <ReactWebChat

package/lib/OmnichannelChatSDK.d.ts

@@ -11,8 +11,10 @@ import IOmnichannelConfig from "./core/IOmnichannelConfig";
 import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
 import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import IStartChatOptionalParams from "./core/IStartChatOptionalParams";
-import OnNewMessageOptionalParams from "./core/OnNewMessageOptionalParams";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
+import OnNewMessageOptionalParams from "./core/OnNewMessageOptionalParams";
+import ChatReconnectOptionalParams from "./core/ChatReconnectOptionalParams";
+import ChatReconnectContext from "./core/ChatReconnectContext";
 declare class OmnichannelChatSDK {
     private debug;
     OCSDKProvider: unknown;
@@ -35,9 +37,14 @@ declare class OmnichannelChatSDK {
     private scenarioMarker;
     private ic3ClientLogger;
     private ocSdkLogger;
+    private isPersistentChat;
+    private isChatReconnect;
+    private reconnectId;
+    private refreshTokenTimer;
     constructor(omnichannelConfig: IOmnichannelConfig, chatSDKConfig?: IChatSDKConfig);
     setDebug(flag: boolean): void;
     initialize(): Promise<IChatConfig>;
+    getChatReconnectContext(optionalParams?: ChatReconnectOptionalParams): Promise<ChatReconnectContext>;
     startChat(optionalParams?: IStartChatOptionalParams): Promise<void>;
     endChat(): Promise<void>;
     getCurrentLiveChatContext(): Promise<ILiveChatContext | {}>;
@@ -67,5 +74,6 @@ declare class OmnichannelChatSDK {
     private getChatConfig;
     private resolveIC3ClientUrl;
     private resolveChatAdapterUrl;
+    private updateChatToken;
 }
 export default OmnichannelChatSDK;