@ada-support/embed2 1.2.17 → 1.3.1

package/dist/npm-entry/client/components/ChatFrame/index.d.ts

@@ -27,6 +27,7 @@ interface OwnProps {
     setChatHasBeenRendered: () => void;
     resetChat: () => void;
     skipGreeting: boolean;
+    chatVersion?: string;
 }
 interface PropsFromDispatch {
     setConnectionState: (payload: MessagePayload) => Promise<StoreState>;

package/dist/npm-entry/client/components/Container/index.d.ts

@@ -11,5 +11,5 @@ interface OwnProps {
     initializationResolve?: () => void;
     initializationReject?: (error: Error) => void;
 }
-declare const _default: (ownProps: OwnProps) => h.JSX.Element;
-export default _default;
+export declare const ConnectedContainer: (ownProps: OwnProps) => h.JSX.Element;
+export {};

package/dist/npm-entry/common/helpers/url/constants.d.ts

@@ -4,4 +4,15 @@ export interface Hosts {
 export interface Ports {
     [key: string]: number;
 }
-export declare const ports: Hosts;
+export declare const ports: {
+    readonly localhost: {
+        readonly api: 8000;
+        readonly chat: 8002;
+        readonly default: 9001;
+    };
+    readonly e2ereference: {
+        readonly api: 8000;
+        readonly chat: 8002;
+        readonly default: 9001;
+    };
+};

package/dist/npm-entry/common/helpers/url/index.d.ts

@@ -4,15 +4,16 @@ interface GetEmbedUrlParams {
     cluster?: string;
     domain?: string;
 }
+interface QueryParams {
+    [key: string]: string | boolean | number | null | undefined;
+}
 export interface CSInterface {
-    name: "api" | "chat";
+    name: "api";
     handle: string;
     cluster?: string;
     domain?: string;
     route?: string;
-    qp?: {
-        [key: string]: string | boolean | number | null | undefined;
-    };
+    qp?: QueryParams;
     isEmbedFramed?: boolean;
 }
 export declare function getClientCacheUrl(handle: string, cluster?: string, domain?: string): string;
@@ -21,4 +22,11 @@ export declare function getEmbedURL({ frameName, handle, cluster, domain, }: Get
  * Generate the Chat / API URL
  */
 export declare function getURL({ name, handle, cluster, domain, route, qp, }: CSInterface): string;
+export declare function getChatURL({ handle, version, cluster, domain, qp, }: {
+    handle: string;
+    version?: string;
+    cluster?: string;
+    domain?: string;
+    qp?: QueryParams;
+}): string;
 export {};

package/dist/npm-entry/index.js

@@ -15811,7 +15811,7 @@ const client = new error_tracker_BrowserClient({
   },
 
   environment: "production",
-  release: "1.2.17-d6480a6",
+  release: "1.3.1-512664b",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -16398,6 +16398,12 @@ const ports = {
 ;// CONCATENATED MODULE: ./src/common/helpers/url/index.ts
 
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+
+
 
 const DEFAULT_ADA_DOMAIN = "ada";
 function getClientCacheUrl(handle, cluster, domain) {
@@ -16426,12 +16432,25 @@ function getEmbedURL(_ref) {
     host = "http://".concat(window.location.hostname, ":9001");
   }
 
-  return "".concat(host, "/embed/").concat(frameName, "/").concat("d6480a6", "/index.html");
+  return "".concat(host, "/embed/").concat(frameName, "/").concat("512664b", "/index.html");
+}
+
+function constructQueryString(query) {
+  return Object.keys(query).map(key => {
+    const value = query[key];
+
+    if (value === undefined || value === null) {
+      return null;
+    }
+
+    return "".concat(key, "=").concat(window.encodeURIComponent(value));
+  }).filter(v => v !== null).join("&");
 }
 /**
  * Generate the Chat / API URL
  */
 
+
 function getURL(_ref2) {
   var _context;
 
@@ -16443,15 +16462,7 @@ function getURL(_ref2) {
     route,
     qp = {}
   } = _ref2;
-  const queryString = Object.keys(qp).map(key => {
-    const value = qp[key];
-
-    if (value === undefined || value === null) {
-      return null;
-    }
-
-    return "".concat(key, "=").concat(window.encodeURIComponent(value));
-  }).filter(v => v !== null).join("&");
+  const queryString = constructQueryString(qp);
   const questionSym = queryString.length ? "?" : "";
   const routeString = route ? "".concat(route, "/") : "";
   const clusterString = cluster ? ".".concat(cluster) : "";
@@ -16465,22 +16476,51 @@ function getURL(_ref2) {
   if (includes_default()(_context = window.location.hostname).call(_context, "localhost") || handle === "e2ereference") {
     var _context2;
 
-    let host = window.location.hostname;
     const domainName = includes_default()(_context2 = window.location.hostname).call(_context2, "localhost") ? "localhost" : "e2ereference";
+    const host = "".concat(window.location.hostname, ":").concat(ports[domainName].api);
+    return "http://".concat(host, "/").concat(routeString).concat(questionSym).concat(queryString);
+  }
+
+  return prodUrl;
+}
+function getChatURL(_ref3) {
+  var _context3;
 
-    if (domainName === "localhost" && name === "chat") {
+  let {
+    handle,
+    version,
+    cluster,
+    domain,
+    qp
+  } = _ref3;
+
+  const queryParams = _objectSpread(_objectSpread({}, qp), {}, {
+    version
+  });
+
+  const queryString = constructQueryString(queryParams);
+  const questionSym = queryString.length ? "?" : "";
+  const clusterString = cluster ? ".".concat(cluster) : "";
+  const domainString = domain || DEFAULT_ADA_DOMAIN;
+  const prodUrl = "https://".concat(handle).concat(clusterString, ".").concat(domainString, ".support/chat/").concat(questionSym).concat(queryString);
+
+  if (isProduction || false || domain) {
+    return prodUrl;
+  }
+
+  if (includes_default()(_context3 = window.location.hostname).call(_context3, "localhost") || handle === "e2ereference") {
+    var _context4;
+
+    const domainName = includes_default()(_context4 = window.location.hostname).call(_context4, "localhost") ? "localhost" : "e2ereference";
+
+    if (domainName === "localhost") {
       // Chat should be on a different domain (even though the port is different).
       // We need this to test Embed+Chat behaviour when third-party cookies are disabled (incognito mode).
-      return "".concat(window.location.protocol, "//").concat(handle, ".chat:8002/").concat(routeString).concat(questionSym).concat(queryString);
+      return "".concat(window.location.protocol, "//").concat(handle, ".chat:8002/").concat(questionSym).concat(queryString);
     }
 
-    if (name === "api" || name === "chat") {
-      host += ":".concat(ports[domainName][name]);
-    } else {
-      host += ":".concat(ports[domainName].default);
-    }
-
-    return "http://".concat(host, "/").concat(routeString).concat(questionSym).concat(queryString);
+    const host = "".concat(window.location.hostname, ":").concat(ports[domainName].chat);
+    return "http://".concat(host, "/").concat(questionSym).concat(queryString);
   }
 
   return prodUrl;
@@ -16695,9 +16735,9 @@ const safeSessionStorage = new SafeStorage(StorageTypes.Session);
 ;// CONCATENATED MODULE: ./src/client/store/mutations/index.ts
 
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function mutations_ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function mutations_objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? mutations_ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : mutations_ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
 
 
@@ -16720,7 +16760,7 @@ const mutations = (state, action) => {
         }
 
         safeLocalStorage.setItem(IS_DRAWER_OPEN_STORAGE_KEY, !state.isDrawerOpen);
-        return _objectSpread(_objectSpread({}, state), {}, {
+        return mutations_objectSpread(mutations_objectSpread({}, state), {}, {
           isDrawerOpen: !state.isDrawerOpen,
           isIntroShown: false,
           drawerHasBeenOpened: true,
@@ -16730,7 +16770,7 @@ const mutations = (state, action) => {
       }
 
     case ActionTypes.SET_STATE_TYPE:
-      return _objectSpread(_objectSpread({}, state), action.payload);
+      return mutations_objectSpread(mutations_objectSpread({}, state), action.payload);
 
     case ActionTypes.INCREMENT_MESSAGE_COUNT_TYPE:
       {
@@ -16739,14 +16779,14 @@ const mutations = (state, action) => {
         } = action.payload; // Filter out Proactive Messages
 
         const nonProactive = messages.filter(message => !message.campaign_key);
-        return _objectSpread(_objectSpread({}, state), {}, {
+        return mutations_objectSpread(mutations_objectSpread({}, state), {}, {
           unreadMessageCount: nonProactive.length
         });
       }
 
     case ActionTypes.SET_CONNECTION_STATE_TYPE:
       {
-        const newConnections = _objectSpread(_objectSpread({}, state.connections), action.payload);
+        const newConnections = mutations_objectSpread(mutations_objectSpread({}, state.connections), action.payload);
 
         const connectionValues = Object.values(newConnections);
         let appConnectionState;
@@ -16764,7 +16804,7 @@ const mutations = (state, action) => {
           appConnectionState = ConnectionState.Uninitiated;
         }
 
-        return _objectSpread(_objectSpread({}, state), {}, {
+        return mutations_objectSpread(mutations_objectSpread({}, state), {}, {
           connections: newConnections,
           appConnectionState
         });
@@ -17958,6 +17998,102 @@ function retrieveStorage(key, client, privateMode) {
 
   return null;
 }
+;// CONCATENATED MODULE: ./src/services/chat-versioning/manifest.ts
+
+const CHAT_MANIFEST_PATH = "https://static.ada.support/chat-manifest.json";
+const loadChatManifest = async () => {
+  const r = await fetch(CHAT_MANIFEST_PATH);
+  return r.json();
+}; // Use one message for different errors to reduce the bundle size
+
+const MANIFEST_VALIDATION_ERROR_MESSAGE = "The format of manifest file is incorrect";
+const isManifest = input => {
+  if (!(typeof input === "object")) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (input === null) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  const objectInput = input;
+
+  if (!Array.isArray(objectInput.versions)) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (!objectInput.versions.length) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (!(typeof objectInput.versions[0].hash === "string")) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (!objectInput.versions[0].hash) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (!(typeof objectInput.versions[0].weight === "number")) {
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  }
+
+  if (objectInput.versions.reduce((s, v) => s + v.weight, 0) !== 1) {
+    throw new AdaEmbedError("The sum of version weights must be \"1\"");
+  }
+
+  return true;
+};
+;// CONCATENATED MODULE: ./src/services/chat-versioning/index.ts
+ // TODO CHATX-1613: Turn on persistence when we're allowed to
+// import { persistence } from "services/persistence";
+
+
+const getChatVersionFromManifest = manifest => {
+  /* istanbul ignore next */
+  if (!isManifest(manifest)) {
+    // This should never happen since isManifest throws an error for invalid input
+    throw new AdaEmbedError(MANIFEST_VALIDATION_ERROR_MESSAGE);
+  } // TODO CHATX-1613: Turn on persistence when we're allowed to
+  // const manifestString = JSON.stringify(manifest);
+  // const manifestCache = persistence.get("ada-embed_chat-manifest-cache");
+  // if (manifestString === manifestCache) {
+  //   const assignedVersion = persistence.get("ada-embed_chat-assigned-version");
+  //
+  //   /* istanbul ignore else */
+  //   if (assignedVersion) {
+  //     return assignedVersion;
+  //   }
+  // }
+
+
+  const random = Math.random();
+  const {
+    versions
+  } = manifest; // Use hash from last version in array by default
+
+  let {
+    hash
+  } = versions[versions.length - 1]; // Loop through versions
+
+  for (let i = 0; i < versions.length; i += 1) {
+    const v = versions[i]; // If random falls into version weight
+
+    if (random <= v.weight) {
+      hash = v.hash;
+      break;
+    }
+  } // TODO CHATX-1613: Turn on persistence when we're allowed to
+  // persistence.set("ada-embed_chat-assigned-version", hash);
+  // persistence.set("ada-embed_chat-manifest-cache", manifestString);
+
+
+  return hash;
+};
+const getChatVersion = async () => {
+  const manifest = await loadChatManifest();
+  return getChatVersionFromManifest(manifest);
+};
 // EXTERNAL MODULE: ./node_modules/lodash.memoize/index.js
 var lodash_memoize = __webpack_require__(773);
 var lodash_memoize_default = /*#__PURE__*/__webpack_require__.n(lodash_memoize);
@@ -18001,9 +18137,9 @@ async function log(message, extra, options) {
       service: "embed",
       env: "production",
       embedVersion: 2,
-      version: "1.2.17",
+      version: "1.3.1",
       isNpm: true,
-      commitHash: "d6480a6"
+      commitHash: "512664b"
     }))
   });
 }
@@ -18413,13 +18549,14 @@ class ChatFrame extends d {
       wasIntroShown,
       privateMode,
       testMode,
-      adaSettings
+      adaSettings,
+      chatVersion
     } = this.props; // check the host page URL for an adaSMSToken and add it as a chatterToken query param for chat's iframe URL
 
     const hostPageUrlParams = new (url_default())(window.location.href).searchParams;
     const smsToken = hostPageUrlParams.get("adaSMSToken");
     const queryParams = {
-      embedVersion: "d6480a6".slice(0, 7),
+      embedVersion: "512664b".slice(0, 7),
       greeting,
       language,
       skipGreeting,
@@ -18434,8 +18571,8 @@ class ChatFrame extends d {
       queryParams.adaSMSToken = smsToken;
     }
 
-    return getURL({
-      name: "chat",
+    return getChatURL({
+      version: chatVersion,
       handle,
       cluster,
       domain,
@@ -19297,6 +19434,7 @@ function Container_objectSpread(target) { for (var i = 1; i < arguments.length;
 
 
 
+
 
 
 class Container extends d {
@@ -19312,7 +19450,9 @@ class Container extends d {
       chatHasBeenRendered: false,
       hideChatOverride: false,
       hideIntroOverride: false,
-      followUpResponseId: null
+      followUpResponseId: null,
+      chatVersion: undefined,
+      readyToRenderChatFrame: false
     });
 
     _defineProperty(this, "resetChatBound", this.resetChat.bind(this));
@@ -19334,7 +19474,7 @@ class Container extends d {
     })());
   }
 
-  componentDidMount() {
+  async componentDidMount() {
     const {
       adaSettings,
       setState
@@ -19355,7 +19495,20 @@ class Container extends d {
     this.notificationPermHandler();
     bindLocationChangeOverrides();
     addServiceWorkerListeners();
-    window.addEventListener("locationchange", this.locationChangeHandlerBound);
+    window.addEventListener("locationchange", this.locationChangeHandlerBound); // Get chat version. Skip for ATT cluster.
+
+    const chatVersion = await (async () => {
+      if (adaSettings.cluster === "att") {
+        return undefined;
+      }
+
+      return getChatVersion();
+    })();
+    this.setState({
+      chatVersion,
+      // We shouldn't try to render chat frame until version is attempted to be retrieved.
+      readyToRenderChatFrame: true
+    });
   }
   /** To be called when `props.appConnectionState` value changes */
 
@@ -19515,9 +19668,14 @@ class Container extends d {
     } = adaSettings;
     const {
       chatHasBeenRendered,
-      hideChatOverride
+      hideChatOverride,
+      readyToRenderChatFrame
     } = this.state;
 
+    if (!readyToRenderChatFrame) {
+      return false;
+    }
+
     if (hideChatOverride) {
       return false;
     }
@@ -20136,7 +20294,15 @@ class Container extends d {
     const {
       chatHasBeenRendered
     } = this.state;
-    messageService.getChannel(XSTORAGE_IFRAME).postMessage(DELETE_HISTORY_EVENT);
+    const xStorageChannel = messageService.getChannel(XSTORAGE_IFRAME);
+    /* istanbul ignore next */
+
+    if (!xStorageChannel) {
+      // This should never happen (ideally).
+      throw new AdaEmbedError("`xStorageChannel` is null");
+    }
+
+    xStorageChannel.postMessage(DELETE_HISTORY_EVENT);
 
     if (chatHasBeenRendered) {
       this.setState({
@@ -20168,21 +20334,23 @@ class Container extends d {
     } = this.props;
     const {
       campaignToTrigger,
-      followUpResponseId
+      followUpResponseId,
+      chatVersion
     } = this.state;
 
-    if (this.shouldRenderChatFrame) {
-      return v(components_ChatFrame, {
-        setChatHasBeenRendered: this.setChatHasBeenRenderedBound,
-        adaSettings: adaSettings,
-        store: store,
-        messageService: messageService,
-        resetChat: this.resetChatBound,
-        skipGreeting: Boolean(campaignToTrigger || followUpResponseId)
-      });
+    if (!this.shouldRenderChatFrame) {
+      return null;
     }
 
-    return null;
+    return v(components_ChatFrame, {
+      chatVersion: chatVersion,
+      setChatHasBeenRendered: this.setChatHasBeenRenderedBound,
+      adaSettings: adaSettings,
+      store: store,
+      messageService: messageService,
+      resetChat: this.resetChatBound,
+      skipGreeting: Boolean(campaignToTrigger || followUpResponseId)
+    });
   }
 
   renderIntroFrame() {
@@ -20348,7 +20516,7 @@ function Container_mapDispatchToProps(dispatch) {
   };
 }
 
-/* harmony default export */ var components_Container = (connect(Container_mapStateToProps, Container_mapDispatchToProps)(Container));
+const ConnectedContainer = connect(Container_mapStateToProps, Container_mapDispatchToProps)(Container);
 ;// CONCATENATED MODULE: ./src/client/embed.tsx
 
 
@@ -20438,7 +20606,7 @@ class Embed {
       value: this.store
     }, v(MessageServiceContext.Provider, {
       value: this.messageService
-    }, v(components_Container, {
+    }, v(ConnectedContainer, {
       store: this.store,
       messageService: this.messageService,
       adaSettings: this.adaSettings,
@@ -20578,7 +20746,7 @@ class Embed {
 
 }
 
-_defineProperty(Embed, "embed2Version", "d6480a6");
+_defineProperty(Embed, "embed2Version", "512664b");
 ;// CONCATENATED MODULE: ./src/common/helpers/startup.ts
 
 

package/dist/npm-entry/services/chat-versioning/index.d.ts

@@ -0,0 +1,3 @@
+import type { Manifest } from "./manifest";
+export declare const getChatVersionFromManifest: (manifest: Manifest | unknown) => string;
+export declare const getChatVersion: () => Promise<string>;

package/dist/npm-entry/services/chat-versioning/manifest.d.ts

@@ -0,0 +1,10 @@
+export declare const CHAT_MANIFEST_PATH = "https://static.ada.support/chat-manifest.json";
+export interface Manifest {
+    versions: {
+        hash: string;
+        weight: number;
+    }[];
+}
+export declare const loadChatManifest: () => Promise<Manifest>;
+export declare const MANIFEST_VALIDATION_ERROR_MESSAGE = "The format of manifest file is incorrect";
+export declare const isManifest: (input: unknown) => input is Manifest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/embed2",
-  "version": "1.2.17",
+  "version": "1.3.1",
   "description": "",
   "main": "dist/npm-entry",
   "typings": "dist/npm-entry/index-npm.d.ts",
@@ -11,9 +11,9 @@
     "build": "TS_NODE_PROJECT=wp.tsconfig.json NODE_ENV=production npx webpack --config webpack.prod.ts",
     "build:npm-types": "tsc --project tsconfig.npm.json --declaration --outDir dist/npm-entry --emitDeclarationOnly --allowJs false --checkJs false",
     "build:npm": "./npm-build.sh",
-    "lint": "tsc --noEmit --strict false && ./node_modules/.bin/eslint --report-unused-disable-directives --ext .js,.jsx,.ts,.tsx . --max-warnings 23",
+    "lint": "tsc --noEmit --strict false && ./node_modules/.bin/eslint --report-unused-disable-directives --ext .js,.jsx,.ts,.tsx . --max-warnings 22",
     "lint:fix": "yarn lint --fix",
-    "test": "jest",
+    "test": "jest --detectOpenHandles",
     "check-types": "./node_modules/typescript/bin/tsc --project ./tsconfig.json --noEmit --strict false",
     "check-types-strict": "./node_modules/typescript/bin/tsc --project ./tsconfig.json --noEmit",
     "tc": "export $(cat .env | xargs) && testcafe",