@microsoft/omnichannel-chat-sdk - npm Package Compare versions

Comparing version 1.0.1-main.8af1160 to 1.0.1-main.c6dccf8

CHANGELOG.md

@@ -6,2 +6,10 @@ # Changelog
 
+### Added
+- Add Post Chat Survey Support
+- Add `getPostChatSurveyContext` & `initializePostChatRenderer` and `renderPostChatSurvey` API methods
+- Add `GetPostChatSurveyContext`, `RenderPostChatSurvey`, and `InitializePostChatRenderer` telemetry events
+
+### Changed
+- README: added examples on usages of the post chat APIs.
+
 ## [1.0.0] - 2021-10-08
@@ -8,0 +16,0 @@ ### Added

lib/core/ChatConfig.d.ts

 export default interface ChatConfig {
+    ChatWidgetLanguage: any;
     DataMaskingInfo: unknown;
@@ -3,0 +4,0 @@ LiveChatConfigAuthSettings: unknown;

lib/OmnichannelChatSDK.d.ts

 import ACSClient from "./core/messaging/ACSClient";
+import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import ChatConfig from "./core/ChatConfig";
@@ -8,3 +9,2 @@ import ChatReconnectContext from "./core/ChatReconnectContext";
 import ChatTranscriptBody from "./core/ChatTranscriptBody";
-import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
@@ -17,3 +17,2 @@ import FramedClient from "@microsoft/omnichannel-amsclient/lib/FramedClient";
 import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
-import OmnichannelConfig from "./core/OmnichannelConfig";
 import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
@@ -23,4 +22,6 @@ import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
+import OmnichannelConfig from "./core/OmnichannelConfig";
+import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
 import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
-import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
+import PostChatContext from "./core/PostChatContext";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
@@ -87,2 +88,5 @@ declare class OmnichannelChatSDK {
     getVoiceVideoCalling(params?: any): Promise<any>;
+    getPostChatSurveyContext(): Promise<any>;
+    initializePostChatRenderer(): Promise<void>;
+    renderPostChatSurvey(containerId: string, postChatContext: PostChatContext): Promise<void>;
     private getIC3Client;
@@ -89,0 +93,0 @@ private getChatConfig;

lib/telemetry/TelemetryEvent.d.ts

@@ -34,4 +34,7 @@ declare enum TelemetryEvent {
     UpdateChatToken = "UpdateChatToken",
-    GetChatReconnectContext = "GetChatReconnectContext"
+    GetChatReconnectContext = "GetChatReconnectContext",
+    GetPostChatSurveyContext = "GetPostChatSurveyContext",
+    RenderPostChatSurvey = "RenderPostChatSurvey",
+    InitializePostChatRenderer = "InitializePostChatRenderer"
 }
 export default TelemetryEvent;

lib/telemetry/TelemetryEvent.js

@@ -38,4 +38,7 @@ "use strict";
     TelemetryEvent["GetChatReconnectContext"] = "GetChatReconnectContext";
+    TelemetryEvent["GetPostChatSurveyContext"] = "GetPostChatSurveyContext";
+    TelemetryEvent["RenderPostChatSurvey"] = "RenderPostChatSurvey";
+    TelemetryEvent["InitializePostChatRenderer"] = "InitializePostChatRenderer";
 })(TelemetryEvent || (TelemetryEvent = {}));
 exports.default = TelemetryEvent;
 //# sourceMappingURL=TelemetryEvent.js.map

lib/utils/libraries.d.ts

 declare const getIC3ClientCDNUrl: (version?: string) => string;
 declare const getIC3AdapterCDNUrl: (version?: string) => string;
 declare const getACSAdapterCDNUrl: (version?: string) => string;
+declare const getMsfpEmbedScript: () => string;
 declare const _default: {
@@ -8,4 +9,5 @@ getIC3ClientCDNUrl: (version?: string) => string;
     getACSAdapterCDNUrl: (version?: string) => string;
+    getMsfpEmbedScript: () => string;
 };
 export default _default;
-export { getIC3ClientCDNUrl, getIC3AdapterCDNUrl, getACSAdapterCDNUrl };
+export { getIC3ClientCDNUrl, getIC3AdapterCDNUrl, getACSAdapterCDNUrl, getMsfpEmbedScript };

lib/utils/libraries.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getACSAdapterCDNUrl = exports.getIC3AdapterCDNUrl = exports.getIC3ClientCDNUrl = void 0;
+exports.getMsfpEmbedScript = exports.getACSAdapterCDNUrl = exports.getIC3AdapterCDNUrl = exports.getIC3ClientCDNUrl = void 0;
 var settings_1 = require("../config/settings");
@@ -23,7 +23,16 @@ var getIC3ClientCDNUrl = function (version) {
 exports.getACSAdapterCDNUrl = getACSAdapterCDNUrl;
+var getMsfpEmbedScript = function () {
+    var msfpEmbedScript = '<script src="https://oc-cdn-ocprod.azureedge.net/livechatwidget/WebChatControl/lib/Embed.min.js" type="text/javascript"></script>' +
+        '<link rel="stylesheet" type="text/css" href="https://mfpembedcdnwus2.azureedge.net/mfpembedcontwus2/Embed.css" />' +
+        '<script type = "text/javascript" >function renderSurvey(parentElementId,surveyurl,FirstName, LastName, locale){var se = new SurveyEmbed(surveyurl,"https://mfpembedcdnmsit.azureedge.net/mfpembedcontmsit/","true");' +
+        'var context = {"First Name": FirstName,"Last Name": LastName,"locale": locale,"showmultilingual":"false"};se.renderInline(parentElementId, context);}</script>';
+    return msfpEmbedScript;
+};
+exports.getMsfpEmbedScript = getMsfpEmbedScript;
 exports.default = {
     getIC3ClientCDNUrl: getIC3ClientCDNUrl,
     getIC3AdapterCDNUrl: getIC3AdapterCDNUrl,
-    getACSAdapterCDNUrl: getACSAdapterCDNUrl
+    getACSAdapterCDNUrl: getACSAdapterCDNUrl,
+    getMsfpEmbedScript: getMsfpEmbedScript
 };
 //# sourceMappingURL=libraries.js.map

package.json

 {
   "name": "@microsoft/omnichannel-chat-sdk",
-  "version": "1.0.1-main.8af1160",
+  "version": "1.0.1-main.c6dccf8",
   "description": "Microsoft Omnichannel Chat SDK",
@@ -5,0 +5,0 @@ "files": [

README.md

@@ -17,3 +17,3 @@ # Omnichannel Chat SDK
 - [API Examples](#api-examples)
-- [Sample Apps](samples/)
+- [Sample Apps](https://github.com/microsoft/omnichannel-chat-sdk-samples)
 - [Common Scenarios](#common-scenarios)
@@ -39,10 +39,8 @@ - [Feature Comparisons](#feature-comparisons)
 | 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 | ✔ | ✔ |
 | Download Transcript | ✔ | ✔ |
@@ -57,2 +55,4 @@ | Email Transcript | ✔ | ✔ |
 | Operating Hours | ✔ | ✔ |
+| Queue Position | ✔ | ✔ | No SDK method. Handled as *system message* |
+| Average Wait Time | ✔ | ✔ | No SDK method. Handled as *system message* |
 
@@ -96,2 +96,12 @@ **\*** BYOI: Bring Your Own Implementation
 
+1. Install `react-native-get-random-values`
+    ```
+    npm install react-native-get-random-values --save-dev
+    ```
+
+1. Import `react-native-get-random-values` on top of your entry point file
+    ```ts
+    import 'react-native-get-random-values';
+    ```
+
 ## API Reference
@@ -123,3 +133,3 @@
 | OmnichannelChatSDK.createChatAdapter() | Get IC3Adapter | **Web only** |
-| OmnichannelChatSDK.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video| **Web only** |
+| OmnichannelChatSDK.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video | **Web only** |
 
@@ -126,0 +136,0 @@ ## API examples

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1238665

increased by2.04%

Number of package files

234

increased by2.63%

Lines of code

11623

increased by2.44%

Number of lines in readme file

727

increased by1.39%

No dependency changes