@microsoft/omnichannel-chat-widget 0.1.0-main.d5846c0 → 0.1.0-main.d80ebb6

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware.spec.js

@@ -0,0 +1,94 @@
+import "@testing-library/jest-dom/extend-expect";
+import { createCardActionMiddleware } from "./cardActionMiddleware";
+describe("cardActionMiddleware test", () => {
+  it("createCardActionMiddleware() with undefined botMagicCodeConfig should not change the sign in card url", () => {
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(undefined)()(next)(args);
+    expect(signInUrl).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode enabled should not change the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: false
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(args.cardAction.value).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode disabled & no fwdUrl should not change the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: true
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(args.cardAction.value).toEqual(results.cardAction.value);
+  });
+  it("createCardActionMiddleware() with botMagicCode disabled & fwdUrl should append the fwdUrl in the sign in card url", () => {
+    const botMagicCodeConfig = {
+      disabled: true,
+      fwdUrl: "http://localhost/forwarder.html"
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(signInUrl === results.cardAction.value).toBe(false);
+    expect(results.cardAction.value === `${signInUrl}&fwdUrl=${botMagicCodeConfig.fwdUrl}`).toBe(true);
+  });
+  it("createCardActionMiddleware() should not append fwdUrl if fwdUrl & sign in card url are not in the same domain", () => {
+    const botMagicCodeConfig = {
+      disabled: true,
+      fwdUrl: "https://localhost/forwarder.html"
+    };
+
+    const next = args => args; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+    const signInUrl = "https://token.botframework.com/api/oauth/signin?signin=[signin]";
+    const args = {
+      cardAction: {
+        type: "signin",
+        value: signInUrl
+      }
+    };
+    const results = createCardActionMiddleware(botMagicCodeConfig)()(next)(args);
+    expect(signInUrl === results.cardAction.value).toBe(true);
+    expect(results.cardAction.value === `${signInUrl}&fwdUrl=${botMagicCodeConfig.fwdUrl}`).toBe(false);
+  });
+});

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/mesageTimestampMiddleware.js

@@ -0,0 +1,106 @@
+import { WebChatActionType } from "../../enums/WebChatActionType";
+import { Constants } from "../../../../../common/Constants"; // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+
+const createMessageTimeStampMiddleware = _ref => {
+  let {
+    dispatch
+  } = _ref;
+  return next => action => {
+    if (isApplicable(action)) {
+      return next(evaluateTagsAndOverrideTimeStamp(action));
+    }
+
+    return next(action);
+  };
+};
+
+const isApplicable = action => {
+  return action.type === WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && isPVAConversation(action) && isPayloadValid(action) && isValidChannel(action);
+};
+
+const isPayloadValid = action => {
+  var _action$payload;
+
+  return action === null || action === void 0 ? void 0 : (_action$payload = action.payload) === null || _action$payload === void 0 ? void 0 : _action$payload.activity;
+};
+
+const isValidChannel = action => {
+  var _action$payload2, _action$payload2$acti;
+
+  return (action === null || action === void 0 ? void 0 : (_action$payload2 = action.payload) === null || _action$payload2 === void 0 ? void 0 : (_action$payload2$acti = _action$payload2.activity) === null || _action$payload2$acti === void 0 ? void 0 : _action$payload2$acti.channelId) === Constants.acsChannel;
+};
+
+const isPVAConversation = action => {
+  return !isTagIncluded(action, Constants.systemMessageTag) && !isTagIncluded(action, Constants.publicMessageTag) && !isRoleUserOn(action);
+};
+
+const isTagIncluded = (action, tag) => {
+  return isDataTagsPresent(action) && action.payload.activity.channelData.tags.includes(tag);
+};
+
+const isRoleUserOn = action => {
+  var _action$payload3, _action$payload3$acti, _action$payload3$acti2;
+
+  return (action === null || action === void 0 ? void 0 : (_action$payload3 = action.payload) === null || _action$payload3 === void 0 ? void 0 : (_action$payload3$acti = _action$payload3.activity) === null || _action$payload3$acti === void 0 ? void 0 : (_action$payload3$acti2 = _action$payload3$acti.from) === null || _action$payload3$acti2 === void 0 ? void 0 : _action$payload3$acti2.role) === Constants.userMessageTag;
+};
+
+const overrideTimeStamp = (timestampOriginal, timeStampNew) => {
+  return isTimestampValid(timeStampNew) ? timeStampNew : timestampOriginal;
+};
+
+const isTimestampValid = timeStamp => {
+  const regex = /(\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])(T)(\d{2})(:{1})(\d{2})(:{1})(\d{2})(.\d+)([Z]{1}))/;
+  return regex.test(timeStamp);
+};
+
+const isDataTagsPresent = action => {
+  var _action$payload4, _action$payload4$acti, _action$payload4$acti2;
+
+  return (action === null || action === void 0 ? void 0 : (_action$payload4 = action.payload) === null || _action$payload4 === void 0 ? void 0 : (_action$payload4$acti = _action$payload4.activity) === null || _action$payload4$acti === void 0 ? void 0 : (_action$payload4$acti2 = _action$payload4$acti.channelData) === null || _action$payload4$acti2 === void 0 ? void 0 : _action$payload4$acti2.tags) && action.payload.activity.channelData.tags.length > 0;
+};
+
+const evaluateTagsAndOverrideTimeStamp = action => {
+  const tagValue = tagLookup(action, Constants.prefixTimestampTag);
+
+  if (tagValue) {
+    const newTimestamp = extractTimeStamp(tagValue);
+    action.payload.activity.timestamp = overrideTimeStamp(action.payload.activity.timestamp, newTimestamp);
+  }
+
+  return action;
+};
+
+const extractTimeStamp = timeStamp => {
+  if (timeStamp && timeStamp.length > 0) {
+    const ts = timeStamp.split(Constants.prefixTimestampTag);
+
+    if (ts && ts.length > 1) {
+      return ts[1];
+    }
+  }
+
+  return timeStamp;
+};
+
+const tagLookup = (action, tag) => {
+  if (!isDataTagsPresent(action)) {
+    return null;
+  }
+
+  const tags = action.payload.activity.channelData.tags;
+  let value;
+
+  if (tags && tags.length > 0) {
+    for (let i = 0; i < tags.length; i++) {
+      value = tags[i];
+
+      if (value && value.indexOf(tag) > -1) {
+        return value;
+      }
+    }
+  }
+
+  return null;
+};
+
+export default createMessageTimeStampMiddleware;

package/lib/esm/contexts/common/LiveChatWidgetActionType.js

@@ -32,4 +32,5 @@ export let LiveChatWidgetActionType;
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_CONVERSATION_ENDED_BY_AGENT"] = 28] = "SET_CONVERSATION_ENDED_BY_AGENT";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_WIDGET_STATE"] = 29] = "SET_WIDGET_STATE";
   LiveChatWidgetActionType[LiveChatWidgetActionType["SET_LIVE_CHAT_CONTEXT"] = 30] = "SET_LIVE_CHAT_CONTEXT";
+  LiveChatWidgetActionType[LiveChatWidgetActionType["SET_BOT_OAUTH_SIGNIN_ID"] = 31] = "SET_BOT_OAUTH_SIGNIN_ID";
 })(LiveChatWidgetActionType || (LiveChatWidgetActionType = {}));

package/lib/types/common/Constants.d.ts

@@ -1,4 +1,6 @@
 export declare class Constants {
+    static readonly magicCodeBroadcastChannel = "MagicCodeChannel";
+    static readonly magicCodeResponseBroadcastChannel = "MagicCodeResponseChannel";
     static readonly systemMessageTag = "system";
     static readonly userMessageTag = "user";
     static readonly historyMessageTag = "history";
@@ -32,6 +34,10 @@ export declare class Constants {
     static readonly queuePositionMessageTag = "queueposition";
     static readonly averageWaitTimeMessageTag = "averagewaittime";
     static readonly message = "message";
+    static readonly hiddenTag = "Hidden";
+    static readonly prefixTimestampTag = "ServerMessageTimestamp_";
+    static readonly acsChannel = "ACS_CHANNEL";
+    static readonly publicMessageTag = "public";
     static readonly supportedAdaptiveCardContentTypes: Array<string>;
     static readonly maxUploadFileSize = "500000";
     static readonly imageRegex: RegExp;

package/lib/types/common/telemetry/TelemetryConstants.d.ts

@@ -26,7 +26,7 @@ export declare enum BroadcastEvent {
     ProactiveChatStartChat = "ProactiveChatStartChat",
     ProactiveChatStartPopoutChat = "ProactiveChatStartPopoutChat",
     ProactiveChatIsInPopoutMode = "ProactiveChatIsInPopoutMode",
-    ClosePopoutWindow = "ClosePopoutWindow",
+    ResetProactiveChatParams = "ResetProactiveChatParams",
     InvalidAdaptiveCardFormat = "InvalidAdaptiveCardFormat",
     NewMessageSent = "NewMessageSent",
     NewMessageReceived = "NewMessageReceived",
@@ -87,7 +87,7 @@ export declare enum TelemetryEvent {
     StartChatEventRecevied = "StartChatEventReceived",
     EndChatSDKCall = "EndChatCall",
     EndChatEventReceived = "EndChatEventReceived",
-    ClosePopoutWindowEventRecevied = "ClosePopoutWindowEventRecevied",
+    WindowClosed = "WindowClosed",
     OnNewMessageFailed = "OnNewMessageFailed",
     OnNewMessageAudioNotificationFailed = "OnNewMessageAudioNotificationFailed",
     DownloadTranscriptResponseNullOrUndefined = "DownloadTranscriptResponseNullOrUndefined",
@@ -112,6 +112,8 @@ export declare enum TelemetryEvent {
     EmailTranscriptButtonClicked = "EmailTranscriptButtonClicked",
     EmailTranscriptCancelButtonClicked = "EmailTranscriptCancelButtonClicked",
     AudioToggleButtonClicked = "AudioToggleButtonClicked",
+    SuppressBotMagicCodeSucceeded = "SuppressBotMagicCodeSucceeded",
+    SuppressBotMagicCodeFailed = "SuppressBotMagicCodeFailed",
     ProcessingHTMLTextMiddlewareFailed = "ProcessingHTMLTextMiddlewareFailed",
     ProcessingSanitizationMiddlewareFailed = "ProcessingSanitizationMiddlewareFailed",
     FormatTagsMiddlewareJSONStringifyFailed = "FormatTagsMiddlewareJSONStringifyFailed",

package/lib/types/components/webchatcontainerstateful/interfaces/IBotMagicCodeConfig.d.ts

@@ -0,0 +1,4 @@
+export interface IBotMagicCodeConfig {
+    disabled?: boolean;
+    fwdUrl?: string;
+}

package/lib/types/components/webchatcontainerstateful/interfaces/IWebChatContainerStatefulProps.d.ts

@@ -1,3 +1,4 @@
+import { IBotMagicCodeConfig } from "./IBotMagicCodeConfig";
 import { ILiveChatWidgetLocalizedTexts } from "../../../contexts/common/ILiveChatWidgetLocalizedTexts";
 import { IRenderingMiddlewareProps } from "./IRenderingMiddlewareProps";
 import { IStyle } from "@fluentui/react";
@@ -13,4 +14,5 @@ export interface IWebChatContainerStatefulProps {
     storeMiddlewares?: any[];
     renderingMiddlewareProps?: IRenderingMiddlewareProps;
     localizedTexts?: ILiveChatWidgetLocalizedTexts;
+    botMagicCode?: IBotMagicCodeConfig;
 }

package/lib/types/components/webchatcontainerstateful/webchatcontroller/BotMagicCodeStore.d.ts

@@ -0,0 +1,3 @@
+export declare class BotMagicCodeStore {
+    static botOAuthSignInId: string;
+}

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware.d.ts

@@ -0,0 +1,2 @@
+import { IBotMagicCodeConfig } from "../../../interfaces/IBotMagicCodeConfig";
+export declare const createCardActionMiddleware: (botMagicCodeConfig: IBotMagicCodeConfig | undefined) => () => (next: any) => (...args: any) => any;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/cardActionMiddleware.spec.d.ts

@@ -0,0 +1 @@
+import "@testing-library/jest-dom/extend-expect";

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/mesageTimestampMiddleware.d.ts

@@ -0,0 +1,5 @@
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+declare const createMessageTimeStampMiddleware: ({ dispatch }: {
+    dispatch: any;
+}) => (next: any) => (action: IWebChatAction) => any;
+export default createMessageTimeStampMiddleware;

package/lib/types/contexts/common/LiveChatWidgetActionType.d.ts

@@ -29,5 +29,6 @@ export declare enum LiveChatWidgetActionType {
     SET_FOCUS_CHAT_BUTTON = 27,
     SET_CONVERSATION_ENDED_BY_AGENT = 28,
     SET_WIDGET_STATE = 29,
-    SET_LIVE_CHAT_CONTEXT = 30
+    SET_LIVE_CHAT_CONTEXT = 30,
+    SET_BOT_OAUTH_SIGNIN_ID = 31
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "0.1.0-main.d5846c0",
+  "version": "0.1.0-main.d80ebb6",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -74,7 +74,7 @@
   },
   "dependencies": {
     "@fluentui/react": "^8.49.1",
-    "@microsoft/omnichannel-chat-components": "^0.1.0-main.423d0ce",
+    "@microsoft/omnichannel-chat-components": "^0.1.0-main.353ecff",
     "@microsoft/omnichannel-chat-sdk": "1.0.1-main.077d17c",
     "abort-controller-es5": "^2.0.1",
     "dompurify": "^2.3.4",