@ada-support/embed2 1.8.4 → 1.8.5

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

@@ -37,6 +37,7 @@ export interface EmbedRequestPayloadByEvent {
     TRIGGER_PROACTIVE: TriggerProactiveParams;
     INJECT_PROACTIVE_CONVERSATION: {
         key: string;
+        messageParams: Record<string, string>;
     };
 }
 export declare type EmbedRequestEvent = keyof EmbedRequestPayloadByEvent;

package/dist/npm-entry/index.js

@@ -13949,7 +13949,7 @@ const client = new BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.8.4-20e63ea",
+  release: "1.8.5-7c0137e",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -14524,7 +14524,7 @@ function getEmbedURL(_ref) {
   } else {
     host = `http://${handle}.localhost:9001`;
   }
-  return `${host}/embed/${frameName}/${"20e63ea"}/index.html`;
+  return `${host}/embed/${frameName}/${"7c0137e"}/index.html`;
 }
 function constructQueryString(query) {
   return Object.keys(query).map(key => {
@@ -15702,9 +15702,9 @@ async function log(message, extra, options) {
       service: "embed",
       env: "production",
       embedVersion: 2,
-      version: "1.8.4",
+      version: "1.8.5",
       isNpm: true,
-      commitHash: "20e63ea"
+      commitHash: "7c0137e"
     }))
   });
 }
@@ -16276,25 +16276,51 @@ function recordProactiveTrigger(proactiveConversationKey, frequency, handle) {
 function proactiveTriggerImpl(_ref) {
   let {
     proactiveConversation,
-    messageKey,
     adaSettings,
     messageService,
-    setRecentProactiveConversationKey,
+    setRecentProactiveConversationConfig,
     clearProactiveConversation
   } = _ref;
   const {
     handle
   } = adaSettings;
+  const {
+    key,
+    params = {},
+    is_template: isTemplate
+  } = proactiveConversation;
+  const messageKey = String(key);
   const {
     duration,
     delay,
     frequency,
     active
   } = proactiveConversation.modality_config.chat;
+  const lang = adaSettings.language || get_browser_language();
+  let proactiveMessage = proactiveConversation.messages[lang][0];
   if (!active) {
     warn("Proactive message is not active");
     return;
   }
+  if (isTemplate) {
+    if (Object.keys(params).length === 0) {
+      warn("Proactive message is a template but no parameters were provided");
+      return;
+    }
+
+    // Replace the template variables with the param values
+    const missingParams = [];
+    proactiveMessage = proactiveMessage.replace(/{{(.*?)}}/g, (match, variableKey) => {
+      if (!(variableKey in params)) {
+        missingParams.push(variableKey);
+      }
+      return params[variableKey];
+    });
+    if (missingParams.length > 0) {
+      warn(`Missing parameters for template message: ${missingParams.join(", ")}`);
+      return;
+    }
+  }
 
   // Check if the proactive message has been shown within the specified frequency
   const doesPassFrequencyCheck = !proactiveShownWithinFrequency(messageKey, frequency, handle);
@@ -16304,13 +16330,14 @@ function proactiveTriggerImpl(_ref) {
 
   // Record the proactive message as being shown
   recordProactiveTrigger(messageKey, frequency, handle);
-  setRecentProactiveConversationKey(messageKey);
+  setRecentProactiveConversationConfig({
+    key: messageKey,
+    params
+  });
   clearProactiveConversation();
   const localChannel = messageService.getChannel("local");
-  const lang = adaSettings.language || get_browser_language();
-  const message = proactiveConversation.messages[lang][0];
   localChannel.postMessage(CREATE_PROACTIVE, {
-    body: message,
+    body: proactiveMessage,
     duration,
     delay
   });
@@ -16853,7 +16880,7 @@ class ChatFrame extends d {
     const hostPageUrlParams = new URL(window.location.href).searchParams;
     const smsToken = hostPageUrlParams.get("adaSMSToken");
     const queryParams = {
-      embedVersion: "20e63ea".slice(0, 7),
+      embedVersion: "7c0137e".slice(0, 7),
       greeting,
       language,
       skipGreeting,
@@ -17730,7 +17757,7 @@ class Container extends d {
       chatVersion: undefined,
       readyToRenderChatFrame: false,
       proactiveConversation: null,
-      recentProactiveConversationKey: null
+      recentProactiveConversationConfig: null
     });
     _defineProperty(this, "resetChatBound", this.resetChat.bind(this));
     _defineProperty(this, "locationChangeHandlerBound", this.locationChangeHandler.bind(this));
@@ -17847,7 +17874,7 @@ class Container extends d {
       campaignTriggerOptions,
       followUpResponseId,
       proactiveConversation,
-      recentProactiveConversationKey
+      recentProactiveConversationConfig
     } = this.state;
 
     /* We wait for all necessary preconditions (e.g. necessary connections established) to be true,
@@ -17876,11 +17903,10 @@ class Container extends d {
     if (proactiveConversation && appConnectionState === ConnectionState.Done) {
       proactiveTriggerImpl({
         proactiveConversation,
-        messageKey: proactiveConversation.key,
         adaSettings,
         messageService,
-        setRecentProactiveConversationKey: key => this.setState({
-          recentProactiveConversationKey: key
+        setRecentProactiveConversationConfig: config => this.setState({
+          recentProactiveConversationConfig: config
         }),
         clearProactiveConversation: () => this.setState({
           proactiveConversation: null
@@ -17906,7 +17932,7 @@ class Container extends d {
         });
       }
     }
-    if (isChatWebsocketConnected && isDrawerOpen && recentProactiveConversationKey) {
+    if (isChatWebsocketConnected && isDrawerOpen && recentProactiveConversationConfig) {
       const chatChannel = messageService.getChannel(CHAT_IFRAME);
       if (chatChannel) {
         // Set meta field to indicate that a proactive conversation has been injected
@@ -17917,14 +17943,15 @@ class Container extends d {
           }
         });
         chatChannel.postMessage(INJECT_PROACTIVE_CONVERSATION, {
-          key: recentProactiveConversationKey
+          key: recentProactiveConversationConfig.key,
+          messageParams: recentProactiveConversationConfig.params
         });
         log("Proactive message clicked", {
           handle: adaSettings.handle,
           embedSettings: adaSettings
         });
         this.setState({
-          recentProactiveConversationKey: null
+          recentProactiveConversationConfig: null
         });
       }
     }
@@ -18147,7 +18174,8 @@ class Container extends d {
     Object.entries(proactiveConversations).forEach(_ref => {
       let [key, conversation] = _ref;
       const chatConfig = conversation.modality_config.chat;
-      if (chatConfig.active && evaluateUrlTriggerConditions(chatConfig.url_trigger_conditions, currentUrl)) {
+      const isTemplate = conversation.is_template;
+      if (chatConfig.active && !isTemplate && evaluateUrlTriggerConditions(chatConfig.url_trigger_conditions, currentUrl)) {
         this.handleProactiveTrigger(Container_objectSpread({
           key
         }, conversation));
@@ -18435,12 +18463,14 @@ class Container extends d {
             throw new AdaEmbedError("`client` is not defined");
           }
           const {
-            messageKey
+            messageKey,
+            params
           } = 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
+              key: messageKey,
+              params
             }));
           } else {
             warn(`Proactive message with key ${messageKey} not found`);

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

@@ -1,12 +1,11 @@
 import type { StartOptions } from "@ada-support/embed-types";
 import type { MessageService } from "client/lib/message-service";
-import type { ProactiveConversation, UrlTriggerCondition } from "./types";
-export declare function proactiveTriggerImpl({ proactiveConversation, messageKey, adaSettings, messageService, setRecentProactiveConversationKey, clearProactiveConversation, }: {
+import type { ProactiveConversation, RecentProactiveConversationConfig, UrlTriggerCondition } from "./types";
+export declare function proactiveTriggerImpl({ proactiveConversation, adaSettings, messageService, setRecentProactiveConversationConfig, clearProactiveConversation, }: {
     proactiveConversation: ProactiveConversation;
-    messageKey: string;
     adaSettings: StartOptions;
     messageService: MessageService;
-    setRecentProactiveConversationKey: (key: string) => void;
+    setRecentProactiveConversationConfig: (config: RecentProactiveConversationConfig) => void;
     clearProactiveConversation: () => void;
 }): void;
 export declare function evaluateUrlTriggerConditions(conditions: UrlTriggerCondition[], url: string): boolean;

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

@@ -11,11 +11,17 @@ export interface ProactiveConversation {
             frequency: ProactiveConversationFrequency;
         };
     };
+    is_template: boolean;
+    params?: Record<string, string>;
     key?: string;
 }
 export interface ProactiveConversations {
     [messageKey: string]: ProactiveConversation;
 }
+export interface RecentProactiveConversationConfig {
+    key: string;
+    params: Record<string, string>;
+}
 export declare type ProactiveConversationFrequency = "always" | "session";
 export declare type ProactiveConversationUrlTriggerConditionType = "equals" | "ends-with" | "regex" | "contains";
 export interface UrlTriggerCondition {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/embed2",
-  "version": "1.8.4",
+  "version": "1.8.5",
   "description": "",
   "main": "dist/npm-entry",
   "typings": "dist/npm-entry/index-npm.d.ts",
@@ -96,7 +96,7 @@
     "webpack-merge": "^5.8.0"
   },
   "dependencies": {
-    "@ada-support/embed-types": "^1.8.0",
+    "@ada-support/embed-types": "^1.8.1",
     "@ada-support/web-storage": "^1.2.9",
     "@babel/runtime-corejs3": "^7.15.4",
     "@sentry/browser": "^8.33.0",