@ada-support/embed2 1.7.27 → 1.7.31

package/dist/npm-entry/client/embed.d.ts

@@ -1,4 +1,4 @@
-import type { CampaignParams, ResetParams, StartOptions, WindowInfo } from "@ada-support/embed-types";
+import type { CampaignParams, ResetParams, StartOptions, TriggerProactiveParams, WindowInfo } from "@ada-support/embed-types";
 import { MessageService } from "client/lib/message-service";
 import { StoreProxy } from "client/lib/store-proxy";
 import "client/lib/error-tracker";
@@ -20,5 +20,6 @@ export declare function createEmbed(adaSettings: StartOptions): {
     readonly createProactive: (body: string, duration: number, responseId?: string) => Promise<void>;
     readonly closeCampaign: () => Promise<void>;
     readonly setDeviceToken: (token: string) => Promise<void>;
+    readonly triggerProactive: (triggerProactiveParams: TriggerProactiveParams) => Promise<void>;
 };
 export declare type Embed = ReturnType<typeof createEmbed>;

package/dist/npm-entry/common/constants/events.d.ts

@@ -74,6 +74,8 @@ export declare const CLOSE_CAMPAIGN = "CLOSE_CAMPAIGN";
 export declare const CLOSE_CAMPAIGN_RESPONSE = "CLOSE_CAMPAIGN_RESPONSE";
 export declare const SET_DEVICE_TOKEN = "SET_DEVICE_TOKEN";
 export declare const SET_DEVICE_TOKEN_RESPONSE = "SET_DEVICE_TOKEN_RESPONSE";
+export declare const TRIGGER_PROACTIVE = "TRIGGER_PROACTIVE";
+export declare const TRIGGER_PROACTIVE_RESPONSE = "TRIGGER_PROACTIVE_RESPONSE";
 export declare const SEND_GREETING = "SEND_GREETING";
 /**
  * Fetch Event Status

package/dist/npm-entry/common/lib/channel.d.ts

@@ -1,4 +1,4 @@
-import type { CampaignParams, ResetParams } from "@ada-support/embed-types";
+import type { CampaignParams, ResetParams, TriggerProactiveParams } from "@ada-support/embed-types";
 import type { FetchEventStatusType } from "common/constants/events";
 import type { SendGreetingParams, StoreDispatchPayload, StoreGetPayload, TrackEventParams } from "common/types";
 import type { AdaCustomEvent, Refhandler } from "common/types/events";
@@ -8,6 +8,7 @@ export interface EmbedRequestPayloadByEvent {
     CREATE_PROACTIVE: {
         body: string;
         duration: number | null;
+        delay?: number;
         responseId?: string | null;
     };
     DELETE_HISTORY: undefined;
@@ -33,6 +34,7 @@ export interface EmbedRequestPayloadByEvent {
     SET_LANGUAGE: {
         language: string;
     };
+    TRIGGER_PROACTIVE: TriggerProactiveParams;
 }
 export declare type EmbedRequestEvent = keyof EmbedRequestPayloadByEvent;
 export interface EmbedResponsePayloadByEvent {
@@ -65,6 +67,7 @@ export interface EmbedResponsePayloadByEvent {
     "chat_INIT": unknown;
     "x-storage_INIT": unknown;
     "SET_DEVICE_TOKEN_RESPONSE": unknown;
+    "TRIGGER_PROACTIVE_RESPONSE": unknown;
 }
 export declare type EmbedResponseEvent = keyof EmbedResponsePayloadByEvent;
 export declare type EmbedEvent = EmbedRequestEvent | EmbedResponseEvent;

package/dist/npm-entry/common/models/client/index.d.ts

@@ -2,6 +2,7 @@ import type { BusinessEvent } from "businessEvents/types";
 import type { ChatButton, ClientResponse, CurrentIntro, Features } from "common/types/http";
 import type { LanguageKey, LanguageMap } from "common/types/languages";
 import type { MarketingCampaign } from "src/campaigns/types";
+import type { ProactiveConversations } from "src/proactiveConversations/types";
 export declare class Client {
     tint: string;
     chat: boolean;
@@ -31,6 +32,7 @@ export declare class Client {
         };
     };
     translated_languages: string[];
+    proactive_conversations?: ProactiveConversations;
     [key: string]: unknown;
     constructor(clientResponse: ClientResponse["client"]);
 }

package/dist/npm-entry/common/types/http.d.ts

@@ -1,5 +1,6 @@
 import type { BusinessEvent } from "businessEvents/types";
 import type { LanguageKey } from "common/types/languages";
+import type { ProactiveConversations } from "src/proactiveConversations/types";
 export interface ChatButton {
     size: number;
     background_color: string;
@@ -36,6 +37,7 @@ export interface ClientObject {
     features: Features;
     marketing_campaigns_order?: string[];
     translated_languages: string[];
+    proactive_conversations?: ProactiveConversations;
     [key: string]: unknown;
 }
 export interface CachedClientObject {
@@ -54,6 +56,7 @@ export interface CachedClientObject {
     features: Features;
     business_events?: BusinessEvent[];
     marketing_campaigns_order?: string[];
+    proactive_conversations?: ProactiveConversations;
     [key: string]: unknown;
 }
 export interface ClientResponse {

package/dist/npm-entry/index.js

@@ -13949,7 +13949,7 @@ const client = new BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.7.27-571929b",
+  release: "1.7.31-645ffae",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -14064,6 +14064,8 @@ const CLOSE_CAMPAIGN = "CLOSE_CAMPAIGN";
 const CLOSE_CAMPAIGN_RESPONSE = "CLOSE_CAMPAIGN_RESPONSE";
 const SET_DEVICE_TOKEN = "SET_DEVICE_TOKEN";
 const SET_DEVICE_TOKEN_RESPONSE = "SET_DEVICE_TOKEN_RESPONSE";
+const TRIGGER_PROACTIVE = "TRIGGER_PROACTIVE";
+const TRIGGER_PROACTIVE_RESPONSE = "TRIGGER_PROACTIVE_RESPONSE";
 
 // Tells chat to send a greeting
 const SEND_GREETING = "SEND_GREETING";
@@ -14521,7 +14523,7 @@ function getEmbedURL(_ref) {
   } else {
     host = `http://${handle}.localhost:9001`;
   }
-  return `${host}/embed/${frameName}/${"571929b"}/index.html`;
+  return `${host}/embed/${frameName}/${"645ffae"}/index.html`;
 }
 function constructQueryString(query) {
   return Object.keys(query).map(key => {
@@ -14926,7 +14928,7 @@ class StoreProxy {
   }
 }
 ;// CONCATENATED MODULE: ./src/client/helpers/local-notifications/index.ts
-const browserHasNotificationSupport = ("Notification" in window);
+const browserHasNotificationSupport = "Notification" in window;
 function checkIfUserHasGivenPermission() {
   if (!browserHasNotificationSupport) {
     return false;
@@ -15465,7 +15467,6 @@ function triggerCampaignImpl(_ref) {
     }).catch(NO_OP_FUNCTION); // we don't want to log errors here, it may fail because of rate limiting
   }
 }
-
 const getCampaignToTrigger = (adaSettings, marketingCampaigns, options, onlyBasic) => {
   const {
     ignoreStatus = false,
@@ -15615,6 +15616,7 @@ class Client {
     _defineProperty(this, "marketing_campaigns", void 0);
     _defineProperty(this, "ui_settings", void 0);
     _defineProperty(this, "translated_languages", void 0);
+    _defineProperty(this, "proactive_conversations", void 0);
     const {
         chat,
         chat_button: chatButton,
@@ -15699,9 +15701,9 @@ async function log(message, extra, options) {
       service: "embed",
       env: "production",
       embedVersion: 2,
-      version: "1.7.27",
+      version: "1.7.31",
       isNpm: true,
-      commitHash: "571929b"
+      commitHash: "645ffae"
     }))
   });
 }
@@ -16226,6 +16228,82 @@ function setBrowserStorageItem(key, value, persistenceSetting) {
     dist/* adaSessionStorage */.ad.setItem(key, value);
   }
 }
+;// CONCATENATED MODULE: ./src/proactiveConversations/proactiveConversation.ts
+
+function proactiveConversation_ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function proactiveConversation_objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? proactiveConversation_ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : proactiveConversation_ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+
+
+
+function proactiveShownWithinFrequency(proactiveConversationKey, frequency, handle) {
+  switch (frequency) {
+    case "always":
+      return false;
+    case "session":
+      {
+        const storageValue = dist/* adaSessionStorage */.ad.getFnItem("marketing_campaigns_shown");
+        const perSessionProactives = storageValue ? (storageValue[handle] || "").split(",") : [];
+        return perSessionProactives.includes(proactiveConversationKey);
+      }
+    default:
+      return false;
+  }
+}
+function addProactiveToStorageString(oldStorageValue, proactiveConversationId) {
+  return oldStorageValue ? `${oldStorageValue},${proactiveConversationId}` : proactiveConversationId;
+}
+function recordProactiveTrigger(proactiveConversationKey, frequency, handle) {
+  switch (frequency) {
+    case "always":
+      break;
+    case "session":
+      {
+        const currentStorageValue = dist/* adaSessionStorage */.ad.getFnItem("marketing_campaigns_shown");
+        const newStorageValue = addProactiveToStorageString(currentStorageValue ? currentStorageValue[handle] || "" : "", proactiveConversationKey);
+        dist/* adaSessionStorage */.ad.setFnItem("marketing_campaigns_shown", proactiveConversation_objectSpread(proactiveConversation_objectSpread({}, currentStorageValue), {}, {
+          [handle]: newStorageValue
+        }));
+        break;
+      }
+    default:
+      break;
+  }
+}
+function proactiveTriggerImpl(_ref) {
+  let {
+    proactiveConversation,
+    messageKey,
+    adaSettings,
+    messageService,
+    clearProactiveMessage
+  } = _ref;
+  const {
+    handle
+  } = adaSettings;
+  const {
+    duration,
+    delay,
+    frequency
+  } = proactiveConversation.modality_config.chat;
+
+  // Check if the proactive message has been shown within the specified frequency
+  const doesPassFrequencyCheck = !proactiveShownWithinFrequency(messageKey, frequency, handle);
+  if (!doesPassFrequencyCheck) {
+    return;
+  }
+
+  // Record the proactive message as being shown
+  recordProactiveTrigger(messageKey, frequency, handle);
+  clearProactiveMessage();
+  const localChannel = messageService.getChannel("local");
+  const lang = adaSettings.language || get_browser_language();
+  const message = proactiveConversation.messages[lang][0];
+  localChannel.postMessage(CREATE_PROACTIVE, {
+    body: message,
+    duration,
+    delay
+  });
+}
 ;// CONCATENATED MODULE: ./src/services/chat-versioning/manifest.ts
 
 
@@ -16748,7 +16826,7 @@ class ChatFrame extends d {
     const hostPageUrlParams = new URL(window.location.href).searchParams;
     const smsToken = hostPageUrlParams.get("adaSMSToken");
     const queryParams = {
-      embedVersion: "571929b".slice(0, 7),
+      embedVersion: "645ffae".slice(0, 7),
       greeting,
       language,
       skipGreeting,
@@ -17602,6 +17680,7 @@ function Container_objectSpread(e) { for (var r = 1; r < arguments.length; r++)
 
 
 
+
 
 
 class Container extends d {
@@ -17618,7 +17697,8 @@ class Container extends d {
       hideIntroOverride: false,
       followUpResponseId: null,
       chatVersion: undefined,
-      readyToRenderChatFrame: false
+      readyToRenderChatFrame: false,
+      proactiveConversation: null
     });
     _defineProperty(this, "resetChatBound", this.resetChat.bind(this));
     _defineProperty(this, "locationChangeHandlerBound", this.locationChangeHandler.bind(this));
@@ -17732,7 +17812,8 @@ class Container extends d {
     const {
       campaignToTrigger,
       campaignTriggerOptions,
-      followUpResponseId
+      followUpResponseId,
+      proactiveConversation
     } = this.state;
 
     /* We wait for all necessary preconditions (e.g. necessary connections established) to be true,
@@ -17758,6 +17839,17 @@ class Container extends d {
         messageService
       });
     }
+    if (proactiveConversation) {
+      proactiveTriggerImpl({
+        proactiveConversation,
+        messageKey: proactiveConversation.key,
+        adaSettings,
+        messageService,
+        clearProactiveMessage: () => this.setState({
+          proactiveConversation: null
+        })
+      });
+    }
 
     // If a follow-up response has been queued by a triggered Campaign, tell chat to show it
     if (isChatWebsocketConnected && isDrawerOpen && followUpResponseId) {
@@ -18001,6 +18093,17 @@ class Container extends d {
     });
     localChannel.postMessage(SET_DEVICE_TOKEN_RESPONSE, null, id);
   }
+  handleProactiveTrigger(proactiveConversation) {
+    const {
+      isDrawerOpen
+    } = this.props;
+    if (isDrawerOpen) {
+      return;
+    }
+    this.setState({
+      proactiveConversation
+    });
+  }
   async handleEmbedAction(type, payload, id) {
     const {
       client,
@@ -18197,7 +18300,8 @@ class Container extends d {
           }
           const {
             body,
-            duration
+            duration,
+            delay
           } = payload;
           const EXTRA_PROACTIVE_DELAY = 1000;
           this.setState({
@@ -18209,7 +18313,7 @@ class Container extends d {
             const newClient = new Client(Container_objectSpread(Container_objectSpread({}, client), {}, {
               intro: {
                 body,
-                delay: 0,
+                delay: delay || 0,
                 // Not just duration || null because we want to preserve 0 duration
                 duration: duration || duration === 0 ? duration : null,
                 style: "Text",
@@ -18242,6 +18346,26 @@ class Container extends d {
           this.handleSettingDeviceToken(localChannel, payload, id);
           break;
         }
+      case TRIGGER_PROACTIVE:
+        {
+          var _client$proactive_con;
+          if (!client) {
+            throw new AdaEmbedError("`client` is not defined");
+          }
+          const {
+            messageKey
+          } = payload;
+          if ((_client$proactive_con = client.proactive_conversations) !== null && _client$proactive_con !== void 0 && _client$proactive_con[messageKey]) {
+            const proactiveConversation = client.proactive_conversations[messageKey];
+            this.handleProactiveTrigger(Container_objectSpread(Container_objectSpread({}, proactiveConversation), {}, {
+              key: messageKey
+            }));
+          } else {
+            warn(`Proactive message with key ${messageKey} not found`);
+          }
+          localChannel.postMessage(TRIGGER_PROACTIVE_RESPONSE, null, id);
+          break;
+        }
       default:
         {
           // Do nothing
@@ -18780,6 +18904,10 @@ function createEmbed(adaSettings) {
       await localChannel.fetch(SET_DEVICE_TOKEN, SET_DEVICE_TOKEN_RESPONSE, {
         token
       });
+    },
+    async triggerProactive(triggerProactiveParams) {
+      await initialized;
+      await localChannel.fetch(TRIGGER_PROACTIVE, TRIGGER_PROACTIVE_RESPONSE, triggerProactiveParams);
     }
   };
 }
@@ -18947,6 +19075,12 @@ function createEmbedInterface() {
       channel.postMessage("TRIGGER_ANSWER", {
         answerId
       });
+    },
+    triggerProactive: triggerProactiveParams => {
+      if (!embed) {
+        throw EMBED_NOT_INITIALIZED_ERROR;
+      }
+      return embed.triggerProactive(triggerProactiveParams);
     }
   });
 }

package/dist/npm-entry/proactiveConversations/proactiveConversation.d.ts

@@ -0,0 +1,10 @@
+import type { StartOptions } from "@ada-support/embed-types";
+import type { MessageService } from "client/lib/message-service";
+import type { ProactiveConversation } from "./types";
+export declare function proactiveTriggerImpl({ proactiveConversation, messageKey, adaSettings, messageService, clearProactiveMessage, }: {
+    proactiveConversation: ProactiveConversation;
+    messageKey: string;
+    adaSettings: StartOptions;
+    messageService: MessageService;
+    clearProactiveMessage: () => void;
+}): void;

package/dist/npm-entry/proactiveConversations/types.d.ts

@@ -0,0 +1,19 @@
+export interface ProactiveConversation {
+    messages: {
+        [language: string]: string[];
+    };
+    modality_config: {
+        [modality: string]: {
+            active: boolean;
+            url_trigger_conditions: string[];
+            delay: number;
+            duration: number;
+            frequency: ProactiveConversationFrequency;
+        };
+    };
+    key?: string;
+}
+export interface ProactiveConversations {
+    [messageKey: string]: ProactiveConversation;
+}
+export declare type ProactiveConversationFrequency = "always" | "session";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/embed2",
-  "version": "1.7.27",
+  "version": "1.7.31",
   "description": "",
   "main": "dist/npm-entry",
   "typings": "dist/npm-entry/index-npm.d.ts",
@@ -43,6 +43,15 @@
   "license": "ISC",
   "devDependencies": {
     "@ada-support/eslint-config-ada": "^1.2.5",
+    "@babel/core": "^7.23.2",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-numeric-separator": "^7.16.7",
+    "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
+    "@babel/plugin-transform-react-jsx": "^7.16.7",
+    "@babel/plugin-transform-runtime": "^7.16.10",
+    "@babel/preset-env": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
     "@testing-library/preact": "^2.0.1",
     "@types/enzyme": "^3.10.11",
     "@types/jest": "^27.0.2",
@@ -54,17 +63,22 @@
     "@types/webpack": "^5.28.0",
     "@types/webpack-bundle-analyzer": "^4.4.1",
     "@types/webpack-dev-server": "^4.7.2",
+    "babel-loader": "9.1.2",
+    "babel-preset-preact": "^2.0.0",
     "browserslist": "^4.17.4",
     "cypress": "^9.6.1",
     "depcheck": "^1.4.3",
+    "dotenv": "^8.2.0",
     "enzyme": "^3.11.0",
     "enzyme-adapter-preact-pure": "^4.0.1",
     "eslint": "^8.8.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-chai-friendly": "^0.7.2",
     "eslint-plugin-compat": "^4.0.2",
     "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-sonarjs": "^0.11.0",
     "husky": "^7.0.0",
+    "html-webpack-plugin": "^5.5.0",
     "jest": "^27.5.1",
     "jest-localstorage-mock": "^2.4.0",
     "lint-staged": "^11.2.3",
@@ -74,39 +88,25 @@
     "start-server-and-test": "^2.0.4",
     "ts-node": "^10.2.1",
     "tsconfig-paths": "^3.11.0",
+    "typescript": "^4.6.2",
+    "webpack": "^5.76.0",
     "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-dev-server": "^4.3.1"
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^4.3.1",
+    "webpack-merge": "^5.8.0"
   },
   "dependencies": {
-    "@ada-support/embed-types": "^1.7.1",
+    "@ada-support/embed-types": "^1.8.0",
     "@ada-support/web-storage": "^1.2.6",
-    "@babel/core": "^7.23.2",
-    "@babel/plugin-proposal-class-properties": "^7.16.7",
-    "@babel/plugin-proposal-numeric-separator": "^7.16.7",
-    "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
-    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
-    "@babel/plugin-transform-react-jsx": "^7.16.7",
-    "@babel/plugin-transform-runtime": "^7.16.10",
-    "@babel/preset-env": "^7.23.2",
-    "@babel/preset-typescript": "^7.23.2",
     "@babel/runtime-corejs3": "^7.15.4",
     "@sentry/browser": "^8.33.0",
     "@sentry/types": "^8.33.1",
-    "babel-loader": "9.1.2",
-    "babel-preset-preact": "^2.0.0",
-    "dotenv": "^8.2.0",
-    "eslint-config-prettier": "^8.5.0",
     "focus-visible": "^5.2.0",
-    "html-webpack-plugin": "^5.5.0",
     "json-stable-stringify": "^1.0.1",
     "lodash.debounce": "^4.0.8",
     "lodash.memoize": "^4.1.2",
     "preact": "10.4.5",
-    "typescript": "^4.6.2",
-    "uniqid": "^5.3.0",
-    "webpack": "^5.76.0",
-    "webpack-cli": "^4.9.2",
-    "webpack-merge": "^5.8.0"
+    "uniqid": "^5.3.0"
   },
   "resolutions": {
     "@lambdatest/node-tunnel": ">=3.0.2",