@uniformdev/context 19.134.3-alpha.28 → 19.135.1-alpha.10

package/dist/index.mjs

@@ -76,6 +76,31 @@ function computeAggregateDimension(primitiveScores, aggregateDimension, allAggre
 // src/manifest/constants.ts
 var ENR_SEPARATOR = "_";
 
+// src/manifest/goals/evaluators/SignalGoalEvaluator.ts
+var _signal, _id;
+var SignalGoalEvaluator = class {
+  constructor(options) {
+    __privateAdd(this, _signal, void 0);
+    __privateAdd(this, _id, void 0);
+    __privateSet(this, _id, options.id);
+    __privateSet(this, _signal, options.signal);
+  }
+  get id() {
+    return __privateGet(this, _id);
+  }
+  evaluate({ scores, quirks }) {
+    const score = scores == null ? void 0 : scores[__privateGet(this, _id)];
+    const key = `goal_${__privateGet(this, _id)}_triggered`;
+    const hasGoalTriggered = (quirks == null ? void 0 : quirks[key]) === "1";
+    return {
+      key,
+      triggered: typeof score === "number" && !hasGoalTriggered
+    };
+  }
+};
+_signal = new WeakMap();
+_id = new WeakMap();
+
 // src/manifest/signals/SignalInstance.ts
 var _evaluator, _onLogMessage;
 var SignalInstance = class {
@@ -133,7 +158,7 @@ var rollForControlGroup = (value) => {
 };
 
 // src/manifest/ManifestInstance.ts
-var _mf, _signalInstances, _onLogMessage2;
+var _mf, _signalInstances, _goalEvaluators, _onLogMessage2;
 var ManifestInstance = class {
   constructor({
     manifest,
@@ -145,13 +170,19 @@ var ManifestInstance = class {
     __publicField(this, "data");
     __privateAdd(this, _mf, void 0);
     __privateAdd(this, _signalInstances, void 0);
+    __privateAdd(this, _goalEvaluators, []);
     __privateAdd(this, _onLogMessage2, void 0);
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     __privateSet(this, _mf, (_a = manifest.project) != null ? _a : {});
     this.data = manifest;
     __privateSet(this, _signalInstances, Object.entries((_c = (_b = __privateGet(this, _mf).pz) == null ? void 0 : _b.sig) != null ? _c : []).map(
       ([id, signal]) => new SignalInstance({ ...signal, id }, evaluator, onLogMessage)
     ));
+    Object.entries((_e = (_d = __privateGet(this, _mf).pz) == null ? void 0 : _d.sig) != null ? _e : []).forEach(([id, signal]) => {
+      if (signal.conversion) {
+        __privateGet(this, _goalEvaluators).push(new SignalGoalEvaluator({ id, signal }));
+      }
+    });
     __privateSet(this, _onLogMessage2, onLogMessage);
   }
   rollForControlGroup() {
@@ -179,6 +210,28 @@ var ManifestInstance = class {
     }
     return commands;
   }
+  computeGoals(data) {
+    const commands = [];
+    __privateGet(this, _goalEvaluators).forEach((evaluator) => {
+      const { triggered, key } = evaluator.evaluate(data);
+      if (triggered) {
+        commands.push({
+          type: "setgoal",
+          data: {
+            goal: evaluator.id
+          }
+        });
+        commands.push({
+          type: "setquirk",
+          data: {
+            key,
+            value: "1"
+          }
+        });
+      }
+    });
+    return commands;
+  }
   /**
    * Computes aggregated scores based on other dimensions
    */
@@ -197,6 +250,7 @@ var ManifestInstance = class {
 };
 _mf = new WeakMap();
 _signalInstances = new WeakMap();
+_goalEvaluators = new WeakMap();
 _onLogMessage2 = new WeakMap();
 
 // src/manifest/signals/criteria/evaluators/cookieEvaluator.ts
@@ -1088,6 +1142,7 @@ var emptyVisitorData = () => ({
   scores: {},
   sessionScores: {},
   tests: {},
+  goals: {},
   consent: false,
   controlGroup: false,
   personalizeVariants: {}
@@ -1103,7 +1158,7 @@ var clone = rfdc();
 function applyCommandsToData(commands, state, inControlGroup) {
   const newData = state ? clone(state) : emptyVisitorData();
   commands.forEach((command) => {
-    var _a, _b;
+    var _a, _b, _c;
     switch (command.type) {
       case "consent":
         newData.consent = command.data;
@@ -1158,6 +1213,10 @@ function applyCommandsToData(commands, state, inControlGroup) {
           console.warn("Overwriting existing control group definition is not allowed");
         }
         break;
+      case "setgoal":
+        newData.goals = (_c = newData.goals) != null ? _c : {};
+        newData.goals[command.data.goal] = true;
+        break;
       default:
         throw new Error(`Unknown command`);
     }
@@ -1323,7 +1382,7 @@ currentData_get = function() {
 };
 _replaceData = new WeakSet();
 replaceData_fn = function(data, quiet = false) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
   const oldData = __privateGet(this, _currentData, currentData_get);
   const now = Date.now();
   if (data.controlGroup) {
@@ -1344,6 +1403,7 @@ replaceData_fn = function(data, quiet = false) {
   const haveSessionScoresChanged = !dequal3(oldData == null ? void 0 : oldData.visitorData.sessionScores, data.sessionScores);
   const haveQuirksChanged = !dequal3(oldData == null ? void 0 : oldData.visitorData.quirks, data.quirks);
   const haveTestsChanged = !dequal3(oldData == null ? void 0 : oldData.visitorData.tests, data.tests);
+  const haveGoalsChanged = !dequal3(oldData == null ? void 0 : oldData.visitorData.goals, data.goals);
   const updatedData = {
     updated: now,
     visitorData: data
@@ -1368,6 +1428,15 @@ replaceData_fn = function(data, quiet = false) {
       __privateGet(this, _mitt2).emit("controlGroupUpdated", data);
       (_i = (_h = __privateGet(this, _options)).onLogMessage) == null ? void 0 : _i.call(_h, ["debug", 104, (_g = data.controlGroup) != null ? _g : false]);
     }
+    if (haveGoalsChanged) {
+      const newGoalKeys = Object.keys((_j = data.goals) != null ? _j : {});
+      for (let i = 0; i < newGoalKeys.length; i++) {
+        const key = newGoalKeys[i];
+        if (!((_k = oldData == null ? void 0 : oldData.visitorData.goals) == null ? void 0 : _k[key])) {
+          __privateGet(this, _mitt2).emit("goalConverted", { goalId: key });
+        }
+      }
+    }
   }
 };
 _setVisitTimeout = new WeakSet();
@@ -1420,10 +1489,11 @@ import { dequal as dequal4 } from "dequal/lite";
 import mitt3 from "mitt";
 var CONTEXTUAL_EDITING_TEST_NAME = "contextual_editing_test";
 var CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID = "contextual_editing_test_selected_variant";
-var _serverTransitionState, _scores, _state, _pzCache, _mitt3, _emitTest, emitTest_fn, _updateComputedScores, updateComputedScores_fn, _calculateScores, calculateScores_fn;
+var _serverTransitionState, _scores, _state, _pzCache, _plugins, _mitt3, _emitTest, emitTest_fn, _updateGoals, updateGoals_fn, _updateComputedScores, updateComputedScores_fn, _calculateScores, calculateScores_fn;
 var Context = class {
   constructor(options) {
     __privateAdd(this, _emitTest);
+    __privateAdd(this, _updateGoals);
     __privateAdd(this, _updateComputedScores);
     __privateAdd(this, _calculateScores);
     __publicField(this, "manifest");
@@ -1431,6 +1501,7 @@ var Context = class {
     __privateAdd(this, _scores, {});
     __privateAdd(this, _state, void 0);
     __privateAdd(this, _pzCache, {});
+    __privateAdd(this, _plugins, void 0);
     __privateAdd(this, _mitt3, mitt3());
     /**
      * Subscribe to events
@@ -1443,7 +1514,8 @@ var Context = class {
     var _a, _b;
     const { manifest, ...storageOptions } = options;
     __privateSet(this, _state, {});
-    (_a = options.plugins) == null ? void 0 : _a.forEach((plugin) => {
+    __privateSet(this, _plugins, options.plugins);
+    (_a = __privateGet(this, _plugins)) == null ? void 0 : _a.forEach((plugin) => {
       if (!plugin.logDrain) {
         return;
       }
@@ -1486,11 +1558,15 @@ var Context = class {
           previousState: __privateGet(this, _state),
           visitor: this.storage.data
         });
+        __privateMethod(this, _updateGoals, updateGoals_fn).call(this, {
+          quirks: quirks.quirks,
+          scores: void 0
+        });
         this.storage.updateData(updates);
         __privateGet(this, _mitt3).emit("quirksUpdated", quirks.quirks);
         __privateGet(this, _mitt3).emit("log", ["info", 4, quirks.quirks]);
       });
-      (_b = options.plugins) == null ? void 0 : _b.forEach((plugin) => {
+      (_b = __privateGet(this, _plugins)) == null ? void 0 : _b.forEach((plugin) => {
         if (!plugin.init) {
           return;
         }
@@ -1625,6 +1701,15 @@ var Context = class {
         __privateSet(this, _serverTransitionState, void 0);
         __privateGet(this, _mitt3).emit("log", ["debug", 131]);
       }
+      if (__privateGet(this, _plugins)) {
+        for (let i = 0; i < __privateGet(this, _plugins).length; i++) {
+          const plugin = __privateGet(this, _plugins)[i];
+          if (!plugin.update) {
+            continue;
+          }
+          await plugin.update(newData);
+        }
+      }
     } finally {
       __privateGet(this, _mitt3).emit("log", ["info", 2, "ENDGROUP"]);
     }
@@ -1720,6 +1805,15 @@ var Context = class {
    */
   async forget(fromAllDevices) {
     __privateSet(this, _state, {});
+    if (__privateGet(this, _plugins)) {
+      for (let i = 0; i < __privateGet(this, _plugins).length; i++) {
+        const plugin = __privateGet(this, _plugins)[i];
+        if (!plugin.forget) {
+          continue;
+        }
+        await plugin.forget();
+      }
+    }
     await this.storage.delete(fromAllDevices);
   }
   /**
@@ -1760,17 +1854,29 @@ _serverTransitionState = new WeakMap();
 _scores = new WeakMap();
 _state = new WeakMap();
 _pzCache = new WeakMap();
+_plugins = new WeakMap();
 _mitt3 = new WeakMap();
 _emitTest = new WeakSet();
 emitTest_fn = function(event) {
   __privateGet(this, _mitt3).emit("testResult", event);
 };
+_updateGoals = new WeakSet();
+updateGoals_fn = async function(data) {
+  const goalCommands = this.manifest.computeGoals(data);
+  if (goalCommands.length !== 0) {
+    await this.storage.updateData(goalCommands);
+  }
+};
 _updateComputedScores = new WeakSet();
 updateComputedScores_fn = function(newData) {
   const newScores = __privateMethod(this, _calculateScores, calculateScores_fn).call(this, newData);
   const newScoresHaveChanged = !dequal4(newScores, __privateGet(this, _scores));
   if (newScoresHaveChanged) {
     __privateSet(this, _scores, newScores);
+    __privateMethod(this, _updateGoals, updateGoals_fn).call(this, {
+      scores: __privateGet(this, _scores),
+      quirks: void 0
+    });
     __privateGet(this, _mitt3).emit("scoresUpdated", newScores);
     __privateGet(this, _mitt3).emit("log", ["info", 3, newScores]);
   }
@@ -1909,6 +2015,339 @@ var ScriptType = /* @__PURE__ */ ((ScriptType2) => {
 })(ScriptType || {});
 var EdgeNodeTagName = "nesitag";
 
+// src/insights/index.ts
+import { v4 } from "uuid";
+var getBasePayload = () => {
+  const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+  const locale = navigator.languages && navigator.languages.length ? navigator.languages[0] : navigator.userLanguage || navigator.language || navigator.browserLanguage || "en";
+  return {
+    "user-agent": window.navigator.userAgent,
+    locale,
+    location: timeZone,
+    referrer: document.referrer,
+    pathname: window.location.pathname,
+    href: window.location.href
+  };
+};
+var createInsightsClient = ({ endpoint }) => {
+  const url = new URL(endpoint.host);
+  url.pathname = "/v0/events";
+  url.searchParams.set("name", "analytics_events");
+  const endpointUrl = url.toString();
+  const sendMessage = async (message) => {
+    if (typeof window.__UNIFORM_CONTEXTUAL_EDITING__ !== "undefined") {
+      return;
+    }
+    const converted = {
+      ...message,
+      payload: JSON.stringify(message.payload)
+    };
+    const response = await fetch(endpointUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${endpoint.apiKey}`
+      },
+      body: JSON.stringify(converted)
+    });
+    const json = await response.json();
+    return json;
+  };
+  return {
+    sessionStart: (options) => {
+      const message = {
+        action: "session_start",
+        version: "1",
+        session_id: options.sessionId,
+        visitor_id: options.visitorId,
+        page_view_id: options.pageId,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        payload: {
+          ...getBasePayload(),
+          previous_session_id: options.previousSessionId
+        }
+      };
+      return sendMessage(message);
+    },
+    pageHit: (options) => {
+      const message = {
+        action: "page_hit",
+        version: "1",
+        session_id: options.sessionId,
+        visitor_id: options.visitorId,
+        page_view_id: options.pageId,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        payload: getBasePayload()
+      };
+      return sendMessage(message);
+    },
+    testResult: async (options) => {
+      const message = {
+        action: "test_result",
+        version: "1",
+        session_id: options.sessionId,
+        visitor_id: options.visitorId,
+        page_view_id: options.pageId,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        payload: {
+          ...getBasePayload(),
+          ...options
+        }
+      };
+      return sendMessage(message);
+    },
+    personalizationResult: async (options) => {
+      const messages = options.variantIds.map((variant) => {
+        const message = {
+          action: "personalization_result",
+          version: "1",
+          session_id: options.sessionId,
+          visitor_id: options.visitorId,
+          page_view_id: options.pageId,
+          timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+          payload: {
+            ...getBasePayload(),
+            name: options.name,
+            variantId: variant.id,
+            control: variant.control || options.control,
+            changed: options.changed
+          }
+        };
+        return message;
+      });
+      await Promise.all(messages.map((message) => sendMessage(message)));
+    },
+    goalConvert: (options) => {
+      const message = {
+        action: "goal_convert",
+        version: "1",
+        session_id: options.sessionId,
+        visitor_id: options.visitorId,
+        page_view_id: options.pageId,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        payload: {
+          ...getBasePayload(),
+          goalId: options.goalId
+        }
+      };
+      return sendMessage(message);
+    },
+    scoresChange: async (options) => {
+      const message = {
+        action: "scores_change",
+        version: "1",
+        session_id: options.sessionId,
+        visitor_id: options.visitorId,
+        page_view_id: options.pageId,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        payload: {
+          ...getBasePayload(),
+          scores: options.scores
+        }
+      };
+      return sendMessage(message);
+    }
+  };
+};
+var createInsightsStorage = () => {
+  const STORAGE_KEY2 = "ufin";
+  return {
+    get: () => {
+      const data = localStorage.getItem(STORAGE_KEY2);
+      if (!data) {
+        return;
+      }
+      return JSON.parse(data);
+    },
+    set: (data) => {
+      const toSet = {
+        ...data,
+        updated: Date.now()
+      };
+      localStorage.setItem(STORAGE_KEY2, JSON.stringify(toSet));
+    },
+    clear: () => {
+      localStorage.removeItem(STORAGE_KEY2);
+    }
+  };
+};
+var generateVisitorId = () => {
+  return `visitor_${generalRandomId()}`;
+};
+var generateSessionId = () => {
+  return `session_${generalRandomId()}`;
+};
+var generatePageId = () => {
+  return `page_${generalRandomId()}`;
+};
+var createInsights = ({
+  endpoint,
+  sessionDurationSeconds = 30 * 60
+}) => {
+  const client = createInsightsClient({
+    endpoint
+  });
+  const storage = createInsightsStorage();
+  let storageData = void 0;
+  let pageId = generatePageId();
+  let previousUrl = void 0;
+  return {
+    init: () => {
+      storageData = storage.get();
+      if (!storageData || Date.now() - storageData.updated > sessionDurationSeconds * 1e3) {
+        const previousSessionId = storageData == null ? void 0 : storageData.sessionId;
+        storageData = {
+          visitorId: (storageData == null ? void 0 : storageData.visitorId) || generateVisitorId(),
+          sessionId: generateSessionId(),
+          updated: Date.now()
+        };
+        storage.set(storageData);
+        client.sessionStart({
+          visitorId: storageData.visitorId,
+          sessionId: storageData.sessionId,
+          previousSessionId,
+          maxAgeSeconds: sessionDurationSeconds,
+          pageId
+        });
+      } else if (storageData) {
+        storage.set(storageData);
+      }
+    },
+    pageHit: () => {
+      if (!storageData) {
+        console.error("Insights not initialized");
+        return;
+      }
+      if (previousUrl === window.location.href) {
+        return;
+      }
+      previousUrl = window.location.href;
+      pageId = generatePageId();
+      client.pageHit({
+        visitorId: storageData.visitorId,
+        sessionId: storageData.sessionId,
+        pageId
+      });
+    },
+    testResult: (result) => {
+      if (!storageData) {
+        console.error("Insights not initialized");
+        return;
+      }
+      client.testResult({
+        ...result,
+        visitorId: storageData.visitorId,
+        sessionId: storageData.sessionId,
+        pageId
+      });
+    },
+    personalizationResult: (result) => {
+      if (!storageData) {
+        console.error("Insights not initialized");
+        return;
+      }
+      client.personalizationResult({
+        ...result,
+        visitorId: storageData.visitorId,
+        sessionId: storageData.sessionId,
+        pageId
+      });
+    },
+    goalConvert: (goalId) => {
+      if (!storageData) {
+        console.error("Insights not initialized");
+        return;
+      }
+      client.goalConvert({
+        visitorId: storageData.visitorId,
+        sessionId: storageData.sessionId,
+        goalId,
+        pageId
+      });
+    },
+    scoresChange: (scores) => {
+      if (!storageData) {
+        console.error("Insights not initialized");
+        return;
+      }
+      client.scoresChange({
+        visitorId: storageData.visitorId,
+        sessionId: storageData.sessionId,
+        scores,
+        pageId
+      });
+    },
+    forget: () => {
+      storage.clear();
+      storageData = void 0;
+    },
+    get sessionId() {
+      return storageData == null ? void 0 : storageData.sessionId;
+    }
+  };
+};
+var enableUniformInsights = (options) => {
+  const insights = createInsights({
+    endpoint: options.endpoint
+  });
+  let previousUrl = void 0;
+  return {
+    init: (context) => {
+      if (typeof window === "undefined") {
+        return () => {
+        };
+      }
+      const consentChanged = () => {
+        if (context.storage.data.consent) {
+          insights.init();
+        } else {
+          insights.forget();
+        }
+      };
+      const handlePersonalizationResult = (data) => {
+        insights.personalizationResult(data);
+      };
+      const handleTestResult = (result) => {
+        insights.testResult(result);
+      };
+      const handleGoalConvert = (result) => {
+        insights.goalConvert(result.goalId);
+      };
+      const handleScoreChange = (scores) => {
+        insights.scoresChange(scores);
+      };
+      context.storage.events.on("goalConverted", handleGoalConvert);
+      context.storage.events.on("consentUpdated", consentChanged);
+      context.events.on("personalizationResult", handlePersonalizationResult);
+      context.events.on("testResult", handleTestResult);
+      context.events.on("scoresUpdated", handleScoreChange);
+      if (context.storage.data.consent) {
+        consentChanged();
+      }
+      return () => {
+        context.storage.events.off("consentUpdated", consentChanged);
+        context.storage.events.off("goalConverted", handleGoalConvert);
+        context.events.off("personalizationResult", handlePersonalizationResult);
+        context.events.off("testResult", handleTestResult);
+        context.events.off("scoresUpdated", handleScoreChange);
+      };
+    },
+    update: (context) => {
+      if (context.url && context.url !== previousUrl) {
+        previousUrl = context.url;
+        insights.pageHit();
+      }
+    },
+    forget: () => {
+      insights.forget();
+    }
+  };
+};
+var generalRandomId = () => {
+  const id = v4();
+  return id.replaceAll("-", "").toLowerCase();
+};
+
 // src/logging/enableConsoleLogDrain.ts
 import rfdc2 from "rfdc";
 
@@ -2112,6 +2551,7 @@ export {
   enableConsoleLogDrain,
   enableContextDevTools,
   enableDebugConsoleLogDrain,
+  enableUniformInsights,
   evaluateVariantMatch,
   eventEvaluator,
   explainStringMatch,