@uniformdev/context 19.61.1 → 19.62.1-alpha.127

package/dist/index.js

@@ -193,6 +193,15 @@ var SignalInstance = class {
 _evaluator = new WeakMap();
 _onLogMessage = new WeakMap();
 
+// src/manifest/utils/control.ts
+var rollForControlGroup = (value) => {
+  let control = value;
+  if (control >= 1) {
+    control = control / 100;
+  }
+  return Math.random() < control;
+};
+
 // src/manifest/ManifestInstance.ts
 var _mf, _signalInstances, _onLogMessage2;
 var ManifestInstance = class {
@@ -216,8 +225,8 @@ var ManifestInstance = class {
     __privateSet(this, _onLogMessage2, onLogMessage);
   }
   rollForControlGroup() {
-    var _a, _b;
-    return Math.random() < ((_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) != null ? _b : 0);
+    var _a;
+    return rollForControlGroup(((_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) || 0);
   }
   getTest(name) {
     var _a;
@@ -565,7 +574,30 @@ function evaluateDimensionMatch(crit, vec, onLogMessage) {
   var _a, _b;
   const { op, l: lhs } = crit;
   const lhsScore = (_a = vec[lhs]) != null ? _a : 0;
-  if (op === "+") {
+  if (op === "^") {
+    const [cat] = lhs.split(ENR_SEPARATOR);
+    let topVectorName = void 0;
+    let topScore = 0;
+    Object.keys(vec).forEach((vectorName) => {
+      if (vectorName.startsWith(`${cat}${ENR_SEPARATOR}`)) {
+        const score = vec[vectorName];
+        if (score > topScore) {
+          topVectorName = vectorName;
+          topScore = score;
+        }
+      }
+    });
+    const result = topVectorName === lhs;
+    onLogMessage == null ? void 0 : onLogMessage([
+      "info",
+      302,
+      {
+        matched: result,
+        description: `${crit.l} has the highest score in the category`
+      }
+    ]);
+    return result;
+  } else if (op === "+") {
     const result = Math.max(...Object.values(vec)) === lhsScore && lhsScore > 0;
     onLogMessage == null ? void 0 : onLogMessage([
       "info",
@@ -652,31 +684,70 @@ function personalizeVariations({
   take = 1,
   onLogMessage
 }) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   onLogMessage == null ? void 0 : onLogMessage(["info", 300, "GROUP", { name, take }]);
   try {
     const control = (_a = context.storage.data.controlGroup) != null ? _a : false;
     const results = [];
     let personalized = false;
     const scores = context.scores;
+    let index = 0;
+    const defaultVariants = [];
+    for (const variant of variations) {
+      if (!((_b = variant.pz) == null ? void 0 : _b.crit.length)) {
+        defaultVariants.push(variant);
+      }
+    }
     for (const variant of variations) {
+      const currentIndex = index++;
       if (results.length === take) {
         break;
       }
-      if (!((_b = variant.pz) == null ? void 0 : _b.crit.length)) {
-        onLogMessage == null ? void 0 : onLogMessage(["info", 301, "GROUP", { id: variant.id, op: (_c = variant.pz) == null ? void 0 : _c.op }]);
+      if (!((_c = variant.pz) == null ? void 0 : _c.crit.length)) {
+        onLogMessage == null ? void 0 : onLogMessage(["info", 301, "GROUP", { id: variant.id, op: (_d = variant.pz) == null ? void 0 : _d.op }]);
         onLogMessage == null ? void 0 : onLogMessage(["info", 302, { matched: true, description: "default variation" }]);
         onLogMessage == null ? void 0 : onLogMessage(["info", 303, true]);
         onLogMessage == null ? void 0 : onLogMessage(["info", 301, "ENDGROUP"]);
-        results.push(variant);
+        results.push({
+          ...variant,
+          control: false
+        });
         continue;
       }
       if (control) {
         continue;
       }
       if (evaluateVariantMatch(variant.id, variant.pz, scores, onLogMessage)) {
-        personalized = true;
-        results.push(variant);
+        let variantToAdd = variant;
+        let isControl = false;
+        const isDefault = defaultVariants.find((v) => v.id === variant.id);
+        if (take === 1 && !isDefault && defaultVariants.length && typeof variant.pz.control === "number") {
+          isControl = context.getPersonalizeVariantControl(name, currentIndex);
+          if (typeof isControl === "undefined") {
+            isControl = rollForControlGroup(variant.pz.control);
+            context.storage.updateData([
+              {
+                type: "setpersonalizecontrol",
+                data: {
+                  personlizationName: name,
+                  index: currentIndex,
+                  control: isControl
+                }
+              }
+            ]);
+          }
+          if (isControl) {
+            variantToAdd = {
+              ...defaultVariants[0],
+              id: variant.id
+            };
+          }
+        }
+        personalized = personalized || typeof variantToAdd.pz !== "undefined";
+        results.push({
+          ...variantToAdd,
+          control: isControl
+        });
       }
     }
     return {
@@ -923,16 +994,19 @@ function parseScoreCookie(cookieValue) {
   if (!cookieValue)
     return;
   const types = cookieValue.split(TYPE_SEP);
-  if (types.length > 3)
+  if (types.length > 5)
     return;
-  const [abTestData, sessionScores, visitorScores] = types;
-  return {
+  const [abTestData, sessionScores, visitorScores, controlGroup, personalizeVariants] = types;
+  const data = {
     // this is true since we're reading a cookie, which wouldn't exist if consent wasn't given
     consent: true,
     sessionScores: decodeCookieType(parseCookieType(sessionScores)),
     scores: decodeCookieType(parseCookieType(visitorScores)),
-    tests: parseCookieType(abTestData)
+    tests: parseCookieType(abTestData),
+    controlGroup: controlGroup === "1",
+    personalizeVariants: decodePersonalizeVariants(personalizeVariants)
   };
+  return data;
 }
 function parseCookieType(type) {
   if (!type) {
@@ -956,9 +1030,48 @@ function serializeCookie(data) {
   return [
     serializeCookieType(data.tests),
     serializeCookieType(encodeCookieType(data.sessionScores)),
-    serializeCookieType(encodeCookieType(data.scores))
+    serializeCookieType(encodeCookieType(data.scores)),
+    data.controlGroup ? "1" : "0",
+    serializePersonalizeVariants(data)
   ].join(TYPE_SEP);
 }
+function serializePersonalizeVariants({
+  personalizeVariants
+}) {
+  const data = {};
+  if (typeof personalizeVariants === "object") {
+    Object.keys(personalizeVariants).forEach((personalizationName) => {
+      const results = [];
+      const variants = personalizeVariants[personalizationName];
+      variants.forEach((variant) => {
+        results.push(`${variant.index}:${variant.control ? "1" : "0"}`);
+      });
+      data[personalizationName] = results.join(",");
+    });
+  }
+  const serialized = serializeCookieType(data);
+  return serialized;
+}
+function decodePersonalizeVariants(data) {
+  const parsed = parseCookieType(data);
+  const keys = Object.keys(parsed);
+  if (!keys.length) {
+    return void 0;
+  }
+  const results = {};
+  Object.keys(parsed).forEach((k) => {
+    const variants = parsed[k].split(",");
+    const key = decodeURIComponent(k);
+    results[key] = variants.map((variant) => {
+      const [index, control] = variant.split(":");
+      return {
+        index: parseInt(index, 10),
+        control: control === "1"
+      };
+    });
+  });
+  return results;
+}
 function encodeCookieType(type) {
   return Object.entries(type).reduce((acc, [key, value]) => {
     acc[key] = ntob(value);
@@ -1046,7 +1159,8 @@ var emptyVisitorData = () => ({
   sessionScores: {},
   tests: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1095,6 +1209,25 @@ function applyCommandsToData(commands, state, inControlGroup) {
       case "setcontrol":
         newData.controlGroup = command.data;
         break;
+      case "setpersonalizecontrol":
+        if (!newData.personalizeVariants) {
+          newData.personalizeVariants = {};
+        }
+        if (!newData.personalizeVariants[command.data.personlizationName]) {
+          newData.personalizeVariants[command.data.personlizationName] = [];
+        }
+        const existingDef = newData.personalizeVariants[command.data.personlizationName].find(
+          (i) => i.index === command.data.index
+        );
+        if (!existingDef) {
+          newData.personalizeVariants[command.data.personlizationName].push({
+            index: command.data.index,
+            control: command.data.control
+          });
+        } else {
+          console.warn("Overwriting existing control group definition is not allowed");
+        }
+        break;
       default:
         throw new Error(`Unknown command`);
     }
@@ -1456,7 +1589,7 @@ var Context = class {
    * will NOT result in a recomputation of signal state.
    */
   async update(newData) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const commands = [];
     const newServerSideTests = {};
     if ((_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.quirks) {
@@ -1486,6 +1619,17 @@ var Context = class {
         );
       }
     }
+    if ((_c = __privateGet(this, _serverTransitionState)) == null ? void 0 : _c.personalizeVariants) {
+      Object.keys(__privateGet(this, _serverTransitionState).personalizeVariants).forEach((personalizationName) => {
+        const variants = __privateGet(this, _serverTransitionState).personalizeVariants[personalizationName];
+        variants.forEach((e) => {
+          commands.push({
+            type: "setpersonalizecontrol",
+            data: { personlizationName: personalizationName, index: e.index, control: e.control }
+          });
+        });
+      });
+    }
     try {
       __privateGet(this, _mitt3).emit("log", [
         "info",
@@ -1495,7 +1639,7 @@ var Context = class {
           ...newData,
           // need to convert url to string so it can be json serialized
           // to go over postMessage to chrome extension
-          url: (_c = newData.url) == null ? void 0 : _c.toString()
+          url: (_d = newData.url) == null ? void 0 : _d.toString()
         }
       ]);
       if (newData.quirks) {
@@ -1577,6 +1721,13 @@ var Context = class {
       }
     ]);
   }
+  getPersonalizeVariantControl(name, index) {
+    var _a, _b, _c;
+    const source = (_b = (_a = __privateGet(this, _serverTransitionState)) == null ? void 0 : _a.personalizeVariants) != null ? _b : this.storage.data.personalizeVariants;
+    const variants = (_c = source == null ? void 0 : source[name]) != null ? _c : [];
+    const variant = variants.find((v) => v.index === index);
+    return variant == null ? void 0 : variant.control;
+  }
   /**
    * Writes a message to the Context log sink.
    * Used by Uniform internal SDK; not intended for public use.
@@ -1619,10 +1770,10 @@ var Context = class {
     const previousPlacement = __privateGet(this, _pzCache)[options.name];
     const eventData = {
       name: options.name,
-      variantIds: value.variations.map((variation) => {
-        var _a;
-        return (_a = variation.id) != null ? _a : "Unknown";
-      }),
+      variantIds: value.variations.map((variation) => ({
+        id: variation.id || "Unknown",
+        control: variation.control
+      })),
       control: this.storage.data.controlGroup,
       changed: true
     };
@@ -1650,7 +1801,8 @@ var Context = class {
     const transitionState = {
       quirks: this.storage.data.quirks,
       ssv: __privateGet(this, _scores),
-      tests: {}
+      tests: {},
+      personalizeVariants: this.storage.data.personalizeVariants
     };
     const allTests = this.storage.data.tests;
     Object.entries(allTests).map(([testName, testValue]) => {
@@ -1661,6 +1813,18 @@ var Context = class {
     });
     return transitionState;
   }
+  /** @deprecated */
+  internal_processTestEvent(event) {
+    if (event.variantId) {
+      this.setTestVariantId(event.name, event.variantId);
+      __privateMethod(this, _emitTest, emitTest_fn).call(this, event);
+    }
+  }
+  /** @deprecated */
+  internal_processPersonalizationEvent(event) {
+    __privateGet(this, _pzCache)[event.name] = event.variantIds;
+    __privateGet(this, _mitt3).emit("personalizationResult", event);
+  }
 };
 _serverTransitionState = new WeakMap();
 _scores = new WeakMap();
@@ -1694,7 +1858,7 @@ calculateScores_fn = function(newData) {
 
 // src/devTools/enableContextDevTools.ts
 var isBrowser = typeof top !== "undefined";
-function enableContextDevTools() {
+function enableContextDevTools(options) {
   return {
     logDrain: (message) => {
       if (!isBrowser) {
@@ -1747,7 +1911,11 @@ function enableContextDevTools() {
               return;
             }
             const message = event.data;
-            await handleMessageFromDevTools(message, context);
+            await handleMessageFromDevTools({
+              message,
+              context,
+              afterMessageReceived: options == null ? void 0 : options.onAfterMessageReceived
+            });
           });
         } catch (e) {
           console.warn(
@@ -1767,26 +1935,35 @@ function enableContextDevTools() {
       context.events.on("personalizationResult", onPersonalizationResult);
       context.events.on("testResult", onTestResult);
       context.events.on("scoresUpdated", onContextDataUpdated);
-      context.storage.events.on("*", onContextDataUpdated);
       return () => {
         context.events.off("scoresUpdated", onContextDataUpdated);
-        context.storage.events.off("*", onContextDataUpdated);
         context.events.off("personalizationResult", onPersonalizationResult);
         context.events.off("testResult", onTestResult);
       };
     }
   };
 }
-async function handleMessageFromDevTools(message, context) {
+async function handleMessageFromDevTools({
+  message,
+  context,
+  afterMessageReceived
+}) {
+  let receivedUniformMessage = false;
   if (message.type === "uniform-in:context:update" && message.newData) {
+    receivedUniformMessage = true;
     await context.update(message.newData);
   }
   if (message.type === "uniform-in:context:commands" && message.commands && Array.isArray(message.commands)) {
+    receivedUniformMessage = true;
     await context.storage.updateData(message.commands);
   }
   if (message.type === "uniform-in:context:forget") {
+    receivedUniformMessage = true;
     await context.forget(false);
   }
+  if (receivedUniformMessage && typeof afterMessageReceived === "function") {
+    afterMessageReceived(message);
+  }
 }
 
 // src/edge/index.ts