@ada-support/embed2 1.1.8 → 1.1.9

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

@@ -1,10 +1,26 @@
 import type { StartOptions } from "@ada-support/embed-types";
-import { h } from "preact";
+import { Component, h } from "preact";
 import type { MessageService } from "client/lib/message-service";
 import type { StoreProxy } from "client/lib/store-proxy";
-import type { Module } from "common/types/modules";
+import type { FrameChannel } from "common/lib/fc";
+import type { CreateNotificationPayload, MessagePayload } from "common/types/events";
+import type { StoreState } from "common/types/store-state";
+interface PropsFromState {
+    handle: StoreState["handle"];
+    domain: StoreState["domain"];
+    cluster: StoreState["cluster"];
+    isDrawerOpen: boolean;
+    greeting: StoreState["greeting"];
+    language: StoreState["language"];
+    wasIntroShown: boolean;
+    parentElement: StoreState["parentElement"];
+    privateMode: StoreState["privateMode"];
+    testMode: StoreState["testMode"];
+    client: StoreState["client"];
+    chatDimensions: StoreState["chatDimensions"];
+    drawerHasBeenOpened: StoreState["drawerHasBeenOpened"];
+}
 interface OwnProps {
-    name: Module;
     adaSettings: StartOptions;
     store: StoreProxy;
     messageService: MessageService;
@@ -12,5 +28,54 @@ interface OwnProps {
     resetChat: () => void;
     skipGreeting: boolean;
 }
+interface PropsFromDispatch {
+    setConnectionState: (payload: MessagePayload) => Promise<StoreState>;
+    setState: (payload: Partial<StoreState>) => Promise<StoreState>;
+    toggleChat: () => Promise<StoreState>;
+}
+declare type ChatFrameProps = PropsFromState & OwnProps & PropsFromDispatch;
+interface ChatFrameState {
+    isMounted: boolean;
+    closeTransitionTime: number;
+}
+export declare class ChatFrame extends Component<ChatFrameProps, ChatFrameState> {
+    iframeRef: import("preact").RefObject<any>;
+    pageYOffset: number;
+    documentBodyOverflow: string;
+    documentBodyPosition: string;
+    documentBodyTop: string;
+    documentBodyBottom: string;
+    documentBodyLeft: string;
+    documentBodyRight: string;
+    channel?: FrameChannel;
+    chatRenderTimeout?: number;
+    state: ChatFrameState;
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: ChatFrameProps): void;
+    componentWillUnmount(): void;
+    get darkMode(): boolean;
+    getIframeSrc(): string;
+    get styles(): string;
+    get hasVisibleProactiveMessages(): boolean;
+    get visibleProactiveStyles(): string;
+    static get parentElementStyles(): string;
+    get chooseStyles(): string;
+    handleScrollLock(): void;
+    /**
+     * Lock the document body from scrolling. If we don't do this,
+     * there are SERIOUS issues on iOS.
+     */
+    lockDocumentBodyFromScrolling(): void;
+    /**
+     * Set back initial values from client document body
+     */
+    unlockDocumentBodyFromScrolling(): void;
+    notificationOnClickHandler(isChatOpen: boolean): void;
+    handleNotifications(payload: CreateNotificationPayload): void;
+    handleChatEvent(type: string, payload: unknown, id?: string): Promise<void>;
+    bindChatEventHandlers(): void;
+    frameLoaded(): void;
+    render(): h.JSX.Element;
+}
 declare const _default: (ownProps: OwnProps) => h.JSX.Element;
 export default _default;

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

@@ -1,9 +1,8 @@
 import { h } from "preact";
 import type { MessageService } from "client/lib/message-service";
 import type { StoreProxy } from "client/lib/store-proxy";
-import type { Module } from "common/types/modules";
 interface OwnProps {
-    name: Module;
+    name: "button" | "x-storage" | "intro" | "drawer-mask";
     roleDescription?: string;
     styles: string;
     store: StoreProxy;

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

@@ -1,11 +1,11 @@
 interface GetEmbedUrlParams {
-    frameName: string;
+    frameName: "button" | "x-storage" | "intro" | "drawer-mask";
     handle: string;
     cluster?: string;
     domain?: string;
 }
 export interface CSInterface {
-    name: string;
+    name: "api" | "chat";
     handle: string;
     cluster?: string;
     domain?: string;

package/dist/npm-entry/index.js

@@ -8798,7 +8798,7 @@ var client = new error_tracker_BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.1.8-af3374e",
+  release: "1.1.9-c54a4e9",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -9500,7 +9500,7 @@ function getEmbedURL(_ref) {
     polyfillVersionString = "legacy";
   }
 
-  return concat_default()(_context5 = concat_default()(_context6 = concat_default()(_context7 = "".concat(host, "/embed/")).call(_context7, polyfillVersionString, "/")).call(_context6, frameName, "/")).call(_context5, "af3374e", "/index.html");
+  return concat_default()(_context5 = concat_default()(_context6 = concat_default()(_context7 = "".concat(host, "/embed/")).call(_context7, polyfillVersionString, "/")).call(_context6, frameName, "/")).call(_context5, "c54a4e9", "/index.html");
 }
 /**
  * Generate the Chat / API URL
@@ -11604,7 +11604,6 @@ function ChatFrame_isNativeReflectConstruct() { if (typeof Reflect === "undefine
 
 
 var documentBodyStyle = window.document.body.style;
-
 var ChatFrame = /*#__PURE__*/function (_Component) {
   (0,inherits/* default */.Z)(ChatFrame, _Component);
 
@@ -11639,8 +11638,6 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
 
     (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "documentBodyRight", documentBodyStyle.right);
 
-    (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "url", _this.getURL);
-
     (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "channel", void 0);
 
     (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "chatRenderTimeout", void 0);
@@ -11661,13 +11658,12 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
       var _this$props = this.props,
           adaSettings = _this$props.adaSettings,
           handle = _this$props.handle,
-          name = _this$props.name,
           setChatHasBeenRendered = _this$props.setChatHasBeenRendered,
           messageService = _this$props.messageService,
           store = _this$props.store;
       setChatHasBeenRendered();
-      this.channel = messageService.registerFrameChannel(name, this.iframeRef.current.contentWindow, this.iframeRef.current.src);
-      store.addChannelListener(name);
+      this.channel = messageService.registerFrameChannel("chat", this.iframeRef.current.contentWindow, this.iframeRef.current.src);
+      store.addChannelListener("chat");
       this.bindChatEventHandlers();
       this.handleScrollLock(); // We use this log to track number of chat impressions (times when users see chat iFrame render first time).
 
@@ -11694,10 +11690,8 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
   }, {
     key: "componentWillUnmount",
     value: function componentWillUnmount() {
-      var _this$props2 = this.props,
-          messageService = _this$props2.messageService,
-          name = _this$props2.name;
-      messageService.unregisterChannel(name);
+      var messageService = this.props.messageService;
+      messageService.unregisterChannel("chat");
     }
   }, {
     key: "darkMode",
@@ -11714,36 +11708,32 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
       var systemDarkMode = window.matchMedia("(prefers-color-scheme: dark)").matches;
       return theme === "dark" || theme === "auto" && systemDarkMode;
     }
-    /**
-     * @override
-     */
-
   }, {
-    key: "getURL",
-    get: function get() {
-      var _this$props3 = this.props,
-          name = _this$props3.name,
-          handle = _this$props3.handle,
-          domain = _this$props3.domain,
-          cluster = _this$props3.cluster,
-          greeting = _this$props3.greeting,
-          language = _this$props3.language,
-          skipGreeting = _this$props3.skipGreeting,
-          wasIntroShown = _this$props3.wasIntroShown,
-          privateMode = _this$props3.privateMode,
-          testMode = _this$props3.testMode,
-          adaSettings = _this$props3.adaSettings;
+    key: "getIframeSrc",
+    value: function getIframeSrc() {
+      var _this$props2 = this.props,
+          handle = _this$props2.handle,
+          domain = _this$props2.domain,
+          cluster = _this$props2.cluster,
+          greeting = _this$props2.greeting,
+          language = _this$props2.language,
+          skipGreeting = _this$props2.skipGreeting,
+          wasIntroShown = _this$props2.wasIntroShown,
+          privateMode = _this$props2.privateMode,
+          testMode = _this$props2.testMode,
+          adaSettings = _this$props2.adaSettings;
 
       if (!handle) {
         throw new errors/* AdaEmbedError */.S("`handle` is not defined");
       }
 
       return getURL({
-        name: name,
+        name: "chat",
         handle: handle,
         cluster: cluster,
         domain: domain,
         qp: {
+          embedVersion: slice_default()("c54a4e9").call("c54a4e9", 0, 7),
           greeting: greeting,
           language: language,
           skipGreeting: skipGreeting,
@@ -11760,11 +11750,11 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
     get: function get() {
       var _client$ui_settings2, _client$ui_settings2$, _context10, _context11, _context12, _context13, _context14;
 
-      var _this$props4 = this.props,
-          isDrawerOpen = _this$props4.isDrawerOpen,
-          client = _this$props4.client,
-          testMode = _this$props4.testMode,
-          adaSettings = _this$props4.adaSettings;
+      var _this$props3 = this.props,
+          isDrawerOpen = _this$props3.isDrawerOpen,
+          client = _this$props3.client,
+          testMode = _this$props3.testMode,
+          adaSettings = _this$props3.adaSettings;
 
       if (!client) {
         return "";
@@ -11801,10 +11791,10 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
     get: function get() {
       var _client$ui_settings3, _client$ui_settings3$, _context15, _context16, _context17;
 
-      var _this$props5 = this.props,
-          chatDimensions = _this$props5.chatDimensions,
-          client = _this$props5.client,
-          adaSettings = _this$props5.adaSettings;
+      var _this$props4 = this.props,
+          chatDimensions = _this$props4.chatDimensions,
+          client = _this$props4.client,
+          adaSettings = _this$props4.adaSettings;
 
       if (!(client !== null && client !== void 0 && client.chat_button)) {
         return "";
@@ -11820,11 +11810,11 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
   }, {
     key: "chooseStyles",
     get: function get() {
-      var _this$props6 = this.props,
-          parentElement = _this$props6.parentElement,
-          client = _this$props6.client,
-          isDrawerOpen = _this$props6.isDrawerOpen,
-          drawerHasBeenOpened = _this$props6.drawerHasBeenOpened;
+      var _this$props5 = this.props,
+          parentElement = _this$props5.parentElement,
+          client = _this$props5.client,
+          isDrawerOpen = _this$props5.isDrawerOpen,
+          drawerHasBeenOpened = _this$props5.drawerHasBeenOpened;
 
       if (parentElement) {
         return ChatFrame.parentElementStyles;
@@ -11853,9 +11843,9 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
     value: function handleScrollLock() {
       var _this3 = this;
 
-      var _this$props7 = this.props,
-          isDrawerOpen = _this$props7.isDrawerOpen,
-          parentElement = _this$props7.parentElement;
+      var _this$props6 = this.props,
+          isDrawerOpen = _this$props6.isDrawerOpen,
+          parentElement = _this$props6.parentElement;
       var closeTransitionTime = this.state.closeTransitionTime; // Lock scroll only on mobile
 
       if (!isMobile) {
@@ -11945,9 +11935,9 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
       var title = payload.title,
           body = payload.body,
           icon = payload.icon;
-      var _this$props8 = this.props,
-          isDrawerOpen = _this$props8.isDrawerOpen,
-          parentElement = _this$props8.parentElement;
+      var _this$props7 = this.props,
+          isDrawerOpen = _this$props7.isDrawerOpen,
+          parentElement = _this$props7.parentElement;
       var isChatOpen = isDrawerOpen || Boolean(parentElement);
       var onClickHandler = this.notificationOnClickHandler.bind(this, isChatOpen);
       createNotification(title, isChatOpen, onClickHandler, {
@@ -11961,13 +11951,13 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
       var _handleChatEvent = (0,asyncToGenerator/* default */.Z)( /*#__PURE__*/regenerator_default().mark(function _callee(type, payload, id) {
         var _this4 = this;
 
-        var _this$props9, adaSettings, setState, setConnectionState, _ref, eventKey, data, _ref2, analytics, analyticsCallback, client, _ref3, chatter, created, chatterTokenCallback, _client, _ref4, zdSessionId, zdPreviousTags, storage, _client2, _ref5, zdMessagingExternalUserId, zdMessagingChatterCreated, _client3, _ref6, inLiveChat, eventCallbacks, customJavascriptEvent, specificCallback, genericCallback, resetChat, zdChatterAuthCallback, conversationEndCallback;
+        var _this$props8, adaSettings, setState, setConnectionState, _ref, eventKey, data, _ref2, analytics, analyticsCallback, client, _ref3, chatter, created, chatterTokenCallback, _client, _ref4, zdSessionId, zdPreviousTags, storage, _client2, _ref5, zdMessagingExternalUserId, zdMessagingChatterCreated, _client3, _ref6, inLiveChat, eventCallbacks, customJavascriptEvent, specificCallback, genericCallback, resetChat, zdChatterAuthCallback, conversationEndCallback;
 
         return regenerator_default().wrap(function _callee$(_context22) {
           while (1) {
             switch (_context22.prev = _context22.next) {
               case 0:
-                _this$props9 = this.props, adaSettings = _this$props9.adaSettings, setState = _this$props9.setState, setConnectionState = _this$props9.setConnectionState;
+                _this$props8 = this.props, adaSettings = _this$props8.adaSettings, setState = _this$props8.setState, setConnectionState = _this$props8.setConnectionState;
                 _context22.t0 = type;
                 _context22.next = _context22.t0 === GET_WINDOW_ORIGIN ? 4 : _context22.t0 === CHAT_STARTED ? 8 : _context22.t0 === CHAT_WEBSOCKET_CONNECTED ? 14 : _context22.t0 === PUBLISH_EVENT ? 16 : _context22.t0 === ANALYTICS_EVENT ? 19 : _context22.t0 === CHATTER_EVENT ? 23 : _context22.t0 === "ZD_SESSION" ? 33 : _context22.t0 === ZD_MESSAGING_HANDOFF ? 42 : _context22.t0 === CHATTER_LIVECHAT_EVENT ? 51 : _context22.t0 === CUSTOM_JAVASCRIPT_EVENT ? 59 : _context22.t0 === RESET_FROM_CHAT_EVENT ? 68 : _context22.t0 === ZD_JWT_AUTH_EVENT ? 71 : _context22.t0 === CREATE_NOTIFICATION_EVENT ? 89 : _context22.t0 === BROWSER_HAS_NOTIFICATIONS_EVENT ? 91 : _context22.t0 === REQUEST_NOTIFICATIONS_EVENT ? 95 : _context22.t0 === END_CONVERSATION_EVENT ? 97 : 100;
                 break;
@@ -12304,10 +12294,8 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
     value: function bindChatEventHandlers() {
       var _this5 = this;
 
-      var _this$props10 = this.props,
-          name = _this$props10.name,
-          messageService = _this$props10.messageService;
-      var channel = messageService.getChannel(name);
+      var messageService = this.props.messageService;
+      var channel = messageService.getChannel("chat");
 
       if (!channel) {
         throw new errors/* AdaEmbedError */.S("`channel` is not defined");
@@ -12322,9 +12310,9 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
     value: function frameLoaded() {
       var _this6 = this;
 
-      var _this$props11 = this.props,
-          handle = _this$props11.handle,
-          adaSettings = _this$props11.adaSettings; // SUP-1141- TODO: Remove chatFrameTimeoutCallback
+      var _this$props9 = this.props,
+          handle = _this$props9.handle,
+          adaSettings = _this$props9.adaSettings; // SUP-1141- TODO: Remove chatFrameTimeoutCallback
 
       var _ref7 = adaSettings,
           chatFrameTimeoutCallback = _ref7.chatFrameTimeoutCallback;
@@ -12349,11 +12337,10 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
   }, {
     key: "render",
     value: function render() {
-      var _this$props12 = this.props,
-          name = _this$props12.name,
-          client = _this$props12.client,
-          isDrawerOpen = _this$props12.isDrawerOpen;
-      var iFrameName = "ada-".concat(name, "-frame");
+      var _this$props10 = this.props,
+          client = _this$props10.client,
+          isDrawerOpen = _this$props10.isDrawerOpen;
+      var iFrameName = "ada-chat-frame";
 
       var roleDescription = function roleDescription() {
         var _context23;
@@ -12366,7 +12353,7 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
       };
 
       return v("iframe", {
-        src: this.url,
+        src: this.getIframeSrc(),
         scrolling: "no",
         style: this.chooseStyles,
         frameBorder: "0",
@@ -13662,7 +13649,6 @@ var Container = /*#__PURE__*/function (_Component) {
   }, {
     key: "renderChatFrame",
     value: function renderChatFrame() {
-      var name = CHAT_IFRAME;
       var _this$props14 = this.props,
           messageService = _this$props14.messageService,
           store = _this$props14.store,
@@ -13673,7 +13659,6 @@ var Container = /*#__PURE__*/function (_Component) {
 
       if (this.shouldRenderChatFrame) {
         return v(components_ChatFrame, {
-          name: name,
           setChatHasBeenRendered: this.setChatHasBeenRenderedBound,
           adaSettings: adaSettings,
           store: store,
@@ -14417,7 +14402,7 @@ window.__AdaEmbedConstructor = Embed;
 /* harmony export */ });
 var isModern = new RegExp("((CPU[ +]OS|iPhone[ +]OS|CPU[ +]iPhone|CPU IPhone OS)[ +]+(15|(1[6-9]|[2-9]\\d|\\d{3,}))[_.]\\d+(?:[_.]\\d+)?)|((Chromium|Chrome)\\/(100|(10[1-9]|1[1-9]\\d|[2-9]\\d\\d|\\d{4,}))\\.\\d+(?:\\.\\d+)?)|(Version\\/(15|(1[6-9]|[2-9]\\d|\\d{3,}))\\.\\d+(?:\\.\\d+)? Safari\\/)|(Firefox\\/(99|([1-9]\\d\\d|\\d{4,}))\\.\\d+\\.\\d+)|(Firefox\\/(99|([1-9]\\d\\d|\\d{4,}))\\.\\d+(pre|[ab]\\d+[a-z]*)?)").test(navigator.userAgent);
 var isProduction = "production" === "production";
-var embed2Version = "af3374e";
+var embed2Version = "c54a4e9";
 
 /***/ }),
 
@@ -14762,9 +14747,9 @@ function _log() {
                 service: "embed",
                 env: "production",
                 embedVersion: 2,
-                version: "1.1.8",
+                version: "1.1.9",
                 isNpm: true,
-                commitHash: "af3374e"
+                commitHash: "c54a4e9"
               }))
             });
 
@@ -25705,7 +25690,7 @@ function _loadClientChunk() {
                 polyfillVersionString = "legacy";
               }
 
-              clientScriptSource = concat_default()(_context17 = concat_default()(_context18 = "".concat(host, "/embed/")).call(_context18, polyfillVersionString, "/client/")).call(_context17, "af3374e", "/index.js");
+              clientScriptSource = concat_default()(_context17 = concat_default()(_context18 = "".concat(host, "/embed/")).call(_context18, polyfillVersionString, "/client/")).call(_context17, "c54a4e9", "/index.js");
             } // `window.__AdaEmbedConstructor` gets created in the "client" bundle
 
 
@@ -25810,14 +25795,22 @@ function createEmbedObject() {
                 return loadClientChunk(adaSettings);
 
               case 5:
-                if (!(adaSettings.customDomains && window.__AdaEmbedConstructor && window.__AdaEmbedConstructor.embed2Version !== config_info/* embed2Version */.Mk)) {
+                if (window.__AdaEmbedConstructor) {
                   _context2.next = 7;
                   break;
                 }
 
-                throw new errors/* AdaEmbedError */.S("Entry script version does not match version specified in customDomains.");
+                throw new Error("`window.__AdaEmbedConstructor` is not defined");
 
               case 7:
+                if (!(adaSettings.customDomains && window.__AdaEmbedConstructor.embed2Version !== config_info/* embed2Version */.Mk)) {
+                  _context2.next = 9;
+                  break;
+                }
+
+                throw new errors/* AdaEmbedError */.S("Entry script version does not match version specified in customDomains.");
+
+              case 9:
                 /**
                  * We bind the window.__AdaEmbed instead of importing the Embed class because entry is a
                  * separate bundle.
@@ -25838,7 +25831,7 @@ function createEmbedObject() {
                 });
                 return _context2.abrupt("return", embed.initialized);
 
-              case 11:
+              case 13:
               case "end":
                 return _context2.stop();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/embed2",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "",
   "main": "dist/npm-entry",
   "typings": "dist/npm-entry/index.d.ts",