@ada-support/embed2 1.0.77 → 1.0.80

package/dist/npm-entry/common/types/store-state.d.ts

@@ -14,6 +14,7 @@ export interface StartOptions {
     sensitiveMetaFields?: Record<string, unknown>;
     parentElement?: string | HTMLElement;
     privateMode?: boolean;
+    chatFrameTimeoutCallback?(): void;
     adaReadyCallback?(params: {
         isRolledOut: boolean;
     }): void;
@@ -74,7 +75,7 @@ export interface StoreState extends StartOptionsNoFunction {
     language?: string;
     adaSettings: StartOptions;
     wasCampaignShownButNowClosed: boolean;
-    isChatEmpty: boolean;
+    proactiveCampaignHadMessages: boolean;
 }
 export interface StartOptionsNoFunction {
     handle?: string;

package/dist/npm-entry/index.js

@@ -8788,7 +8788,7 @@ var client = new error_tracker_BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.0.77-12e8ab2",
+  release: "1.0.80-a465c37",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -9490,7 +9490,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, "12e8ab2", "/index.html");
+  return concat_default()(_context5 = concat_default()(_context6 = concat_default()(_context7 = "".concat(host, "/embed/")).call(_context7, polyfillVersionString, "/")).call(_context6, frameName, "/")).call(_context5, "a465c37", "/index.html");
 }
 /**
  * Generate the Chat / API URL
@@ -9595,9 +9595,10 @@ var actions = {
     }
 
     var hasChatOpenedAfterProactiveMessagesShown = currentState.hasChatOpenedAfterProactiveMessagesShown,
-        wasCampaignShownButNowClosed = currentState.wasCampaignShownButNowClosed;
+        wasCampaignShownButNowClosed = currentState.wasCampaignShownButNowClosed,
+        proactiveCampaignHadMessages = currentState.proactiveCampaignHadMessages;
 
-    if (!currentState.isDrawerOpen && !hasChatOpenedAfterProactiveMessagesShown && !wasCampaignShownButNowClosed && currentState.latestCampaignKey) {
+    if (!currentState.isDrawerOpen && !hasChatOpenedAfterProactiveMessagesShown && !wasCampaignShownButNowClosed && proactiveCampaignHadMessages && currentState.latestCampaignKey) {
       var _url = getURL({
         name: "api",
         handle: currentState.handle,
@@ -9971,7 +9972,7 @@ var state = {
   chatterInLiveChat: false,
   adaSettings: {},
   wasCampaignShownButNowClosed: false,
-  isChatEmpty: false
+  proactiveCampaignHadMessages: false
 };
 /* harmony default export */ var store_state = (state);
 ;// CONCATENATED MODULE: ./src/client/store/index.ts
@@ -11617,6 +11618,8 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
 
     (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "channel", void 0);
 
+    (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "chatRenderTimeout", void 0);
+
     (0,defineProperty/* default */.Z)((0,assertThisInitialized/* default */.Z)(_this), "state", {
       isMounted: false,
       closeTransitionTime: 200
@@ -11941,7 +11944,7 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
               case 0:
                 _this$props9 = this.props, adaSettings = _this$props9.adaSettings, setState = _this$props9.setState, setConnectionState = _this$props9.setConnectionState;
                 _context22.t0 = type;
-                _context22.next = _context22.t0 === GET_WINDOW_ORIGIN ? 4 : _context22.t0 === CHAT_STARTED ? 8 : _context22.t0 === CHAT_WEBSOCKET_CONNECTED ? 13 : _context22.t0 === PUBLISH_EVENT ? 15 : _context22.t0 === ANALYTICS_EVENT ? 18 : _context22.t0 === CHATTER_EVENT ? 22 : _context22.t0 === "ZD_SESSION" ? 32 : _context22.t0 === ZD_MESSAGING_HANDOFF ? 41 : _context22.t0 === CHATTER_LIVECHAT_EVENT ? 50 : _context22.t0 === CUSTOM_JAVASCRIPT_EVENT ? 58 : _context22.t0 === RESET_FROM_CHAT_EVENT ? 67 : _context22.t0 === ZD_JWT_AUTH_EVENT ? 70 : _context22.t0 === CREATE_NOTIFICATION_EVENT ? 88 : _context22.t0 === BROWSER_HAS_NOTIFICATIONS_EVENT ? 90 : _context22.t0 === REQUEST_NOTIFICATIONS_EVENT ? 94 : _context22.t0 === END_CONVERSATION_EVENT ? 96 : 99;
+                _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;
 
               case 4:
@@ -11954,7 +11957,7 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
 
               case 6:
                 this.channel.postMessage("SET_WINDOW_ORIGIN", window.location, id);
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
               case 8:
                 if (this.channel) {
@@ -11965,24 +11968,25 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                 throw new errors/* AdaEmbedError */.S("`this.channel` is not defined");
 
               case 10:
+                clearTimeout(this.chatRenderTimeout);
                 this.channel.isConnected = true;
                 setConnectionState({
                   "chat": ConnectionState.Done
                 });
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 13:
+              case 14:
                 setState({
                   isChatWebsocketConnected: true
                 });
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 15:
+              case 16:
                 _ref = payload, eventKey = _ref.eventKey, data = _ref.data;
                 publishEvent(eventKey, data);
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 18:
+              case 19:
                 _ref2 = payload, analytics = _ref2.analytics;
                 analyticsCallback = adaSettings.analyticsCallback;
 
@@ -11990,28 +11994,28 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   analyticsCallback(analytics);
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 22:
+              case 23:
                 client = this.props.client;
                 _ref3 = payload, chatter = _ref3.chatter, created = _ref3.created;
                 chatterTokenCallback = adaSettings.chatterTokenCallback;
 
                 if (client) {
-                  _context22.next = 27;
+                  _context22.next = 28;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`client` is undefined");
 
-              case 27:
-                _context22.next = 29;
+              case 28:
+                _context22.next = 30;
                 return setState({
                   chatterToken: chatter,
                   chatterCreated: created
                 });
 
-              case 29:
+              case 30:
                 /**
                  * Store the token so when embed loads in the future, it doesn't have to wait for it to
                  * come from chat. This is important for campaign and business event triggers.
@@ -12028,26 +12032,26 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   chatterTokenCallback(chatter);
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 32:
+              case 33:
                 _client = this.props.client;
                 _ref4 = payload, zdSessionId = _ref4.zdSessionId, zdPreviousTags = _ref4.zdPreviousTags;
 
                 if (_client) {
-                  _context22.next = 36;
+                  _context22.next = 37;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`client` is undefined");
 
-              case 36:
-                _context22.next = 38;
+              case 37:
+                _context22.next = 39;
                 return setState({
                   zdSessionId: zdSessionId
                 });
 
-              case 38:
+              case 39:
                 storage = function () {
                   if (_client.persistence === PERSISTENCE_NORMAL) {
                     return safeLocalStorage;
@@ -12074,27 +12078,27 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   }
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 41:
+              case 42:
                 _client2 = this.props.client;
                 _ref5 = payload, zdMessagingExternalUserId = _ref5.zdMessagingExternalUserId, zdMessagingChatterCreated = _ref5.zdMessagingChatterCreated;
 
                 if (_client2) {
-                  _context22.next = 45;
+                  _context22.next = 46;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`client` is undefined");
 
-              case 45:
-                _context22.next = 47;
+              case 46:
+                _context22.next = 48;
                 return setState({
                   zdMessagingExternalUserId: zdMessagingExternalUserId,
                   zdMessagingChatterCreated: zdMessagingChatterCreated
                 });
 
-              case 47:
+              case 48:
                 if (zdMessagingExternalUserId === null) {
                   safeLocalStorage.removeItem(ZD_MESSAGING_EXTERNAL_USER_ID_STORAGE_KEY);
                 } else {
@@ -12107,25 +12111,25 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   safeLocalStorage.setItem(ZD_MESSAGING_CHATTER_CREATED_STORAGE_KEY, zdMessagingChatterCreated);
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 50:
+              case 51:
                 _client3 = this.props.client;
                 _ref6 = payload, inLiveChat = _ref6.inLiveChat;
-                _context22.next = 54;
+                _context22.next = 55;
                 return setState({
                   chatterInLiveChat: inLiveChat
                 });
 
-              case 54:
+              case 55:
                 if (_client3) {
-                  _context22.next = 56;
+                  _context22.next = 57;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`client` is not defined");
 
-              case 56:
+              case 57:
                 /**
                  * Store the token so when embed loads in the future, it doesn't have to wait for it to
                  * come from chat. This is important for campaign and business event triggers.
@@ -12136,19 +12140,19 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   safeSessionStorage.setItem(IN_LIVE_CHAT_STORAGE_KEY, inLiveChat);
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 58:
+              case 59:
                 eventCallbacks = adaSettings.eventCallbacks;
 
                 if (eventCallbacks) {
-                  _context22.next = 61;
+                  _context22.next = 62;
                   break;
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 61:
+              case 62:
                 customJavascriptEvent = payload.event_data;
                 specificCallback = eventCallbacks[customJavascriptEvent.event_name];
                 genericCallback = eventCallbacks["*"];
@@ -12161,22 +12165,22 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                   genericCallback(customJavascriptEvent);
                 }
 
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 67:
+              case 68:
                 resetChat = this.props.resetChat;
                 resetChat();
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 70:
+              case 71:
                 zdChatterAuthCallback = adaSettings.zdChatterAuthCallback;
 
                 if (!zdChatterAuthCallback) {
-                  _context22.next = 84;
+                  _context22.next = 85;
                   break;
                 }
 
-                _context22.prev = 72;
+                _context22.prev = 73;
                 zdChatterAuthCallback(function (token) {
                   if (!_this4.channel) {
                     throw new errors/* AdaEmbedError */.S("`this.channel` is not defined");
@@ -12186,82 +12190,82 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
                     token: token
                   }, id);
                 });
-                _context22.next = 82;
+                _context22.next = 83;
                 break;
 
-              case 76:
-                _context22.prev = 76;
-                _context22.t1 = _context22["catch"](72);
+              case 77:
+                _context22.prev = 77;
+                _context22.t1 = _context22["catch"](73);
                 console.warn("Function for zdChatterAuthCallback produced an error - please ensure the callback is functioning normally");
 
                 if (this.channel) {
-                  _context22.next = 81;
+                  _context22.next = 82;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`this.channel` is not defined");
 
-              case 81:
+              case 82:
                 this.channel.postMessage(ZD_JWT_AUTH_RESPONSE_EVENT, {}, id);
 
-              case 82:
-                _context22.next = 87;
+              case 83:
+                _context22.next = 88;
                 break;
 
-              case 84:
+              case 85:
                 if (this.channel) {
-                  _context22.next = 86;
+                  _context22.next = 87;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`this.channel` is not defined");
 
-              case 86:
-                this.channel.postMessage(ZD_JWT_AUTH_RESPONSE_EVENT, {}, id);
-
               case 87:
-                return _context22.abrupt("break", 100);
+                this.channel.postMessage(ZD_JWT_AUTH_RESPONSE_EVENT, {}, id);
 
               case 88:
+                return _context22.abrupt("break", 101);
+
+              case 89:
                 this.handleNotifications(payload);
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 90:
+              case 91:
                 if (this.channel) {
-                  _context22.next = 92;
+                  _context22.next = 93;
                   break;
                 }
 
                 throw new errors/* AdaEmbedError */.S("`this.channel` is not defined");
 
-              case 92:
+              case 93:
                 this.channel.postMessage(BROWSER_HAS_NOTIFICATIONS_RESPONSE_EVENT, {
                   browserHasNotificationSupport: browserHasNotificationSupport
                 });
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 94:
+              case 95:
                 requestNotificationPermission();
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
-              case 96:
+              case 97:
                 conversationEndCallback = adaSettings.conversationEndCallback;
 
                 if (conversationEndCallback) {
                   conversationEndCallback(payload);
                 }
 
-                return _context22.abrupt("break", 100);
-
-              case 99:
-                return _context22.abrupt("break", 100);
+                return _context22.abrupt("break", 101);
 
               case 100:
+                return _context22.abrupt("break", 101);
+
+              case 101:
               case "end":
                 return _context22.stop();
             }
           }
-        }, _callee, this, [[72, 76]]);
+        }, _callee, this, [[73, 77]]);
       }));
 
       function handleChatEvent(_x, _x2, _x3) {
@@ -12288,12 +12292,34 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
         _this5.handleChatEvent(type, payload, id);
       });
     }
+  }, {
+    key: "frameLoaded",
+    value: function frameLoaded() {
+      var _this6 = this;
+
+      var _this$props11 = this.props,
+          handle = _this$props11.handle,
+          adaSettings = _this$props11.adaSettings;
+      var chatFrameTimeoutCallback = adaSettings.chatFrameTimeoutCallback;
+      this.chatRenderTimeout = window.setTimeout(function () {
+        var _this6$channel;
+
+        (0,services_logger/* log */.cM)("Chat frame took over 5 seconds to respond", {
+          handle: handle,
+          embedSettings: adaSettings
+        });
+
+        if (chatFrameTimeoutCallback && !((_this6$channel = _this6.channel) !== null && _this6$channel !== void 0 && _this6$channel.isConnected)) {
+          chatFrameTimeoutCallback();
+        }
+      }, 5000);
+    }
   }, {
     key: "render",
     value: function render() {
-      var _this$props11 = this.props,
-          name = _this$props11.name,
-          isDrawerOpen = _this$props11.isDrawerOpen;
+      var _this$props12 = this.props,
+          name = _this$props12.name,
+          isDrawerOpen = _this$props12.isDrawerOpen;
       var iFrameName = "ada-".concat(name, "-frame");
       return v("iframe", {
         src: this.url,
@@ -12307,7 +12333,8 @@ var ChatFrame = /*#__PURE__*/function (_Component) {
         className: iFrameName,
         "aria-expanded": isDrawerOpen,
         allowTransparency: true,
-        allowFullScreen: true
+        allowFullScreen: true,
+        onLoad: this.frameLoaded.bind(this)
       });
     }
   }], [{
@@ -12774,8 +12801,7 @@ var Container = /*#__PURE__*/function (_Component) {
           adaSettings = _this$props2.adaSettings,
           chatterInLiveChat = _this$props2.chatterInLiveChat,
           messageService = _this$props2.messageService,
-          wasCampaignShownButNowClosed = _this$props2.wasCampaignShownButNowClosed,
-          isChatEmpty = _this$props2.isChatEmpty;
+          wasCampaignShownButNowClosed = _this$props2.wasCampaignShownButNowClosed;
       var adaReadyCallback = adaSettings.adaReadyCallback,
           toggleCallback = adaSettings.toggleCallback;
 
@@ -12842,10 +12868,12 @@ var Container = /*#__PURE__*/function (_Component) {
 
         if (chatChannel) {
           if (!wasCampaignShownButNowClosed) {
+            // If the campaign has not been closed (i.e. is still visible), send the follow up response
             chatChannel.postMessage(SEND_GREETING, {
               responseId: followUpResponseId
-            }); // If the campaign has not been closed (i.e. is still visible), send the follow up response
-          } else if (isChatEmpty) {
+            });
+          } else {
+            // otherwise, send the bot's default greeting answer (if the conversation has messages already, `chat` will ignore this message)
             chatChannel.postMessage(SEND_GREETING);
           }
 
@@ -13015,7 +13043,8 @@ var Container = /*#__PURE__*/function (_Component) {
       setState({
         latestCampaignKey: campaignKey,
         hasChatOpenedAfterProactiveMessagesShown: false,
-        wasCampaignShownButNowClosed: false
+        wasCampaignShownButNowClosed: false,
+        proactiveCampaignHadMessages: false
       });
       this.setState({
         // Only need to load chat for engage campaigns, not free tier (message_text) campaigns
@@ -13735,8 +13764,7 @@ function Container_mapStateToProps(storeState) {
       chatDimensions = storeState.chatDimensions,
       isIntroShown = storeState.isIntroShown,
       language = storeState.language,
-      wasCampaignShownButNowClosed = storeState.wasCampaignShownButNowClosed,
-      isChatEmpty = storeState.isChatEmpty;
+      wasCampaignShownButNowClosed = storeState.wasCampaignShownButNowClosed;
   return {
     client: client,
     hideMask: hideMask,
@@ -13751,8 +13779,7 @@ function Container_mapStateToProps(storeState) {
     chatDimensions: chatDimensions,
     isIntroShown: isIntroShown,
     language: language,
-    wasCampaignShownButNowClosed: wasCampaignShownButNowClosed,
-    isChatEmpty: isChatEmpty
+    wasCampaignShownButNowClosed: wasCampaignShownButNowClosed
   };
 }
 
@@ -14347,7 +14374,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)\\/(99|([1-9]\\d\\d|\\d{4,}))\\.\\d+(?:\\.\\d+)?)|(Version\\/(15|(1[6-9]|[2-9]\\d|\\d{3,}))\\.\\d+(?:\\.\\d+)? Safari\\/)|(Firefox\\/(98|(99|\\d{3,}))\\.\\d+\\.\\d+)|(Firefox\\/(98|(99|\\d{3,}))\\.\\d+(pre|[ab]\\d+[a-z]*)?)").test(navigator.userAgent);
 var isProduction = "production" === "production";
-var embed2Version = "12e8ab2";
+var embed2Version = "a465c37";
 
 /***/ }),
 
@@ -14693,9 +14720,9 @@ function _log() {
                 service: "embed",
                 env: "production",
                 embedVersion: 2,
-                version: "1.0.77",
+                version: "1.0.80",
                 isNpm: true,
-                commitHash: "12e8ab2"
+                commitHash: "a465c37"
               }))
             });
 
@@ -25636,7 +25663,7 @@ function _loadEmbed() {
                 polyfillVersionString = "legacy";
               }
 
-              embedScriptSource = concat_default()(_context17 = concat_default()(_context18 = "".concat(host, "/embed/")).call(_context18, polyfillVersionString, "/client/")).call(_context17, "12e8ab2", "/index.js");
+              embedScriptSource = concat_default()(_context17 = concat_default()(_context18 = "".concat(host, "/embed/")).call(_context18, polyfillVersionString, "/client/")).call(_context17, "a465c37", "/index.js");
             }
 
             clientScriptExists = Boolean( true || // The client script is bundled with npm module

package/package.json

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