@uniformdev/context 19.132.0 → 19.134.0

package/dist/api/api.d.mts

@@ -1,4 +1,4 @@
-import { av as paths$7, N as ManifestV2 } from '../types-R41eD1zH.mjs';
+import { ay as paths$7, N as ManifestV2 } from '../types-o-_vpf1P.mjs';
 import 'mitt';
 
 type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;

package/dist/api/api.d.ts

@@ -1,4 +1,4 @@
-import { av as paths$7, N as ManifestV2 } from '../types-R41eD1zH.js';
+import { ay as paths$7, N as ManifestV2 } from '../types-o-_vpf1P.js';
 import 'mitt';
 
 type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-R41eD1zH.mjs';
-export { _ as AggregateDimensionInput, a4 as BehaviorTag, h as CONTEXTUAL_EDITING_TEST_NAME, i as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, n as Context, l as ContextEvents, m as ContextInstance, j as ContextOptions, at as ContextState, au as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, ak as DecayOptions, q as DevToolsActions, t as DevToolsDataEvent, r as DevToolsEvent, x as DevToolsForgetEvent, u as DevToolsHelloEvent, s as DevToolsLogEvent, w as DevToolsRawCommandsEvent, p as DevToolsState, o as DevToolsUiVersion, v as DevToolsUpdateEvent, a1 as DimensionMatch, X as EnrichmentCategory, aq as EnrichmentData, ar as EventData, H as GroupCriteriaEvaluator, af as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, aa as ModifyScoreCommand, ab as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, a2 as PersonalizeOptions, a6 as PersonalizedResult, a5 as PersonalizedVariant, ao as Quirks, ai as SERVER_STATE_ID, ah as ServerToClientTransitionState, ac as SetConsentCommand, ag as SetControlGroupCommand, ad as SetQuirkCommand, ae as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a9 as StorageCommand, Z as TestDefinition, k as TestEvent, $ as TestOptions, a8 as TestResult, a7 as TestVariant, ap as Tests, aj as TransitionDataStoreEvents, an as VisitorDataStore, am as VisitorDataStoreEvents, al as VisitorDataStoreOptions, as as emptyVisitorData, a3 as personalizeVariations, a0 as testVariations } from './types-R41eD1zH.mjs';
+import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-o-_vpf1P.mjs';
+export { _ as AggregateDimensionInput, a4 as BehaviorTag, h as CONTEXTUAL_EDITING_TEST_NAME, i as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, n as Context, l as ContextEvents, m as ContextInstance, j as ContextOptions, aw as ContextState, ax as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, al as DecayOptions, q as DevToolsActions, t as DevToolsDataEvent, r as DevToolsEvent, x as DevToolsForgetEvent, u as DevToolsHelloEvent, s as DevToolsLogEvent, w as DevToolsRawCommandsEvent, p as DevToolsState, o as DevToolsUiVersion, v as DevToolsUpdateEvent, a1 as DimensionMatch, X as EnrichmentCategory, ar as EnrichmentData, au as EventData, H as GroupCriteriaEvaluator, af as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, aa as ModifyScoreCommand, ab as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, as as PersonalizeControlVariant, a2 as PersonalizeOptions, at as PersonalizeVariants, a6 as PersonalizedResult, a5 as PersonalizedVariant, ap as Quirks, aj as SERVER_STATE_ID, ai as ServerToClientTransitionState, ac as SetConsentCommand, ag as SetControlGroupCommand, ah as SetPersonalizeVariantControlCommand, ad as SetQuirkCommand, ae as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a9 as StorageCommand, Z as TestDefinition, k as TestEvent, $ as TestOptions, a8 as TestResult, a7 as TestVariant, aq as Tests, ak as TransitionDataStoreEvents, ao as VisitorDataStore, an as VisitorDataStoreEvents, am as VisitorDataStoreOptions, av as emptyVisitorData, a3 as personalizeVariations, a0 as testVariations } from './types-o-_vpf1P.mjs';
 import Cookies from 'js-cookie';
 import 'mitt';
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-R41eD1zH.js';
-export { _ as AggregateDimensionInput, a4 as BehaviorTag, h as CONTEXTUAL_EDITING_TEST_NAME, i as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, n as Context, l as ContextEvents, m as ContextInstance, j as ContextOptions, at as ContextState, au as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, ak as DecayOptions, q as DevToolsActions, t as DevToolsDataEvent, r as DevToolsEvent, x as DevToolsForgetEvent, u as DevToolsHelloEvent, s as DevToolsLogEvent, w as DevToolsRawCommandsEvent, p as DevToolsState, o as DevToolsUiVersion, v as DevToolsUpdateEvent, a1 as DimensionMatch, X as EnrichmentCategory, aq as EnrichmentData, ar as EventData, H as GroupCriteriaEvaluator, af as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, aa as ModifyScoreCommand, ab as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, a2 as PersonalizeOptions, a6 as PersonalizedResult, a5 as PersonalizedVariant, ao as Quirks, ai as SERVER_STATE_ID, ah as ServerToClientTransitionState, ac as SetConsentCommand, ag as SetControlGroupCommand, ad as SetQuirkCommand, ae as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a9 as StorageCommand, Z as TestDefinition, k as TestEvent, $ as TestOptions, a8 as TestResult, a7 as TestVariant, ap as Tests, aj as TransitionDataStoreEvents, an as VisitorDataStore, am as VisitorDataStoreEvents, al as VisitorDataStoreOptions, as as emptyVisitorData, a3 as personalizeVariations, a0 as testVariations } from './types-R41eD1zH.js';
+import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-o-_vpf1P.js';
+export { _ as AggregateDimensionInput, a4 as BehaviorTag, h as CONTEXTUAL_EDITING_TEST_NAME, i as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, n as Context, l as ContextEvents, m as ContextInstance, j as ContextOptions, aw as ContextState, ax as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, al as DecayOptions, q as DevToolsActions, t as DevToolsDataEvent, r as DevToolsEvent, x as DevToolsForgetEvent, u as DevToolsHelloEvent, s as DevToolsLogEvent, w as DevToolsRawCommandsEvent, p as DevToolsState, o as DevToolsUiVersion, v as DevToolsUpdateEvent, a1 as DimensionMatch, X as EnrichmentCategory, ar as EnrichmentData, au as EventData, H as GroupCriteriaEvaluator, af as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, aa as ModifyScoreCommand, ab as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, as as PersonalizeControlVariant, a2 as PersonalizeOptions, at as PersonalizeVariants, a6 as PersonalizedResult, a5 as PersonalizedVariant, ap as Quirks, aj as SERVER_STATE_ID, ai as ServerToClientTransitionState, ac as SetConsentCommand, ag as SetControlGroupCommand, ah as SetPersonalizeVariantControlCommand, ad as SetQuirkCommand, ae as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a9 as StorageCommand, Z as TestDefinition, k as TestEvent, $ as TestOptions, a8 as TestResult, a7 as TestVariant, aq as Tests, ak as TransitionDataStoreEvents, ao as VisitorDataStore, an as VisitorDataStoreEvents, am as VisitorDataStoreOptions, av as emptyVisitorData, a3 as personalizeVariations, a0 as testVariations } from './types-o-_vpf1P.js';
 import Cookies from 'js-cookie';
 import 'mitt';
 

package/dist/index.esm.js

@@ -123,6 +123,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 {
@@ -146,12 +155,8 @@ var ManifestInstance = class {
     __privateSet(this, _onLogMessage2, onLogMessage);
   }
   rollForControlGroup() {
-    var _a, _b;
-    let control = (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) != null ? _b : 0;
-    if (control >= 1) {
-      control = control / 100;
-    }
-    return Math.random() < control;
+    var _a;
+    return rollForControlGroup(((_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) || 0);
   }
   getTest(name) {
     var _a;
@@ -499,7 +504,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",
@@ -586,31 +614,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 {
@@ -857,16 +924,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) {
@@ -890,9 +960,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);
@@ -980,7 +1089,8 @@ var emptyVisitorData = () => ({
   sessionScores: {},
   tests: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1029,6 +1139,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`);
     }
@@ -1390,7 +1519,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) {
@@ -1420,6 +1549,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",
@@ -1429,7 +1569,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) {
@@ -1511,6 +1651,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.
@@ -1553,10 +1700,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
     };
@@ -1584,7 +1731,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]) => {

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,12 +225,8 @@ var ManifestInstance = class {
     __privateSet(this, _onLogMessage2, onLogMessage);
   }
   rollForControlGroup() {
-    var _a, _b;
-    let control = (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) != null ? _b : 0;
-    if (control >= 1) {
-      control = control / 100;
-    }
-    return Math.random() < control;
+    var _a;
+    return rollForControlGroup(((_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) || 0);
   }
   getTest(name) {
     var _a;
@@ -569,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",
@@ -656,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 {
@@ -927,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) {
@@ -960,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);
@@ -1050,7 +1159,8 @@ var emptyVisitorData = () => ({
   sessionScores: {},
   tests: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1099,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`);
     }
@@ -1460,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) {
@@ -1490,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",
@@ -1499,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) {
@@ -1581,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.
@@ -1623,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
     };
@@ -1654,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]) => {

package/dist/index.mjs

@@ -123,6 +123,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 {
@@ -146,12 +155,8 @@ var ManifestInstance = class {
     __privateSet(this, _onLogMessage2, onLogMessage);
   }
   rollForControlGroup() {
-    var _a, _b;
-    let control = (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) != null ? _b : 0;
-    if (control >= 1) {
-      control = control / 100;
-    }
-    return Math.random() < control;
+    var _a;
+    return rollForControlGroup(((_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.control) || 0);
   }
   getTest(name) {
     var _a;
@@ -499,7 +504,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",
@@ -586,31 +614,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 {
@@ -857,16 +924,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) {
@@ -890,9 +960,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);
@@ -980,7 +1089,8 @@ var emptyVisitorData = () => ({
   sessionScores: {},
   tests: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1029,6 +1139,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`);
     }
@@ -1390,7 +1519,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) {
@@ -1420,6 +1549,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",
@@ -1429,7 +1569,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) {
@@ -1511,6 +1651,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.
@@ -1553,10 +1700,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
     };
@@ -1584,7 +1731,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]) => {

package/dist/{types-R41eD1zH.d.mts → types-o-_vpf1P.d.mts}

@@ -17,6 +17,13 @@ type EnrichmentData = {
     /** Strength value (amount of score added when viewing content) */
     str: number;
 };
+type PersonalizeControlVariant = {
+    index: number;
+    control: boolean;
+};
+type PersonalizeVariants = {
+    [key: string]: PersonalizeControlVariant[];
+};
 /** An event that has occurred (i.e. an analytics track) which may trigger an Event signal */
 type EventData = {
     /** The event name that has been fired */
@@ -55,6 +62,10 @@ type VisitorData = {
      * based on the control group size.
      */
     controlGroup?: boolean;
+    /**
+     * Records of personalized variants that have been shown to the visitor and their control group status
+     */
+    personalizeVariants?: PersonalizeVariants;
 };
 declare const emptyVisitorData: () => VisitorData;
 /**
@@ -79,7 +90,7 @@ type StorageCommand<TID extends string = string, TData = unknown> = {
     data: TData;
 };
 /** Commands that can be issued to alter the storage of Uniform Context data */
-type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand;
 /**
  * Changes the visitor's permanent score for a given dimension
  */
@@ -125,11 +136,16 @@ type IdentifyCommand = StorageCommand<'identify', {
  * this command is intended mostly for diagnostics and testing purposes.
  */
 type SetControlGroupCommand = StorageCommand<'setcontrol', boolean>;
+type SetPersonalizeVariantControlCommand = StorageCommand<'setpersonalizecontrol', {
+    personlizationName: string;
+    index: number;
+    control: boolean;
+}>;
 
 type TransitionDataStoreOptions = {
     initialData?: Partial<VisitorData>;
 };
-type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests'> & {
+type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests' | 'personalizeVariants'> & {
     /**
      * Server Score Vector - the resultant scores _on the server side_ after the server/edge render completes
      * Note that the client side does not trust these scores; they are only used until it's done with initial
@@ -826,6 +842,10 @@ type VariantMatchCriteria = {
      * Name of the variant for analytics tracking.
      */
     name?: string;
+    /**
+     * Control group percentage for the variant.
+     */
+    control?: number;
 };
 type DimensionMatch = {
     /**
@@ -836,7 +856,8 @@ type DimensionMatch = {
     /**
      * Operator of the match expression
      * Whole-vector (RHS only) operators - these do not require a `r` or `rDim` set:
-     * +: `l` is the strongest dimension in the score vector
+     * +: `l` is the strongest dimension in the score vector across all categories
+     * ^: `l` is the strongest dimension in the specified category
      * -: `l` is the weakest dimension in the score vector. This does not match if the dimension has no score at all.
      *
      * Comparison operators:
@@ -847,7 +868,7 @@ type DimensionMatch = {
      * =: `l` is equal to the right hand side expression
      * !=: `l` is not equal to the right hand side expression
      */
-    op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=';
+    op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=' | '^';
     /**
      * Right hand side of the match expression (not required for op = + or - which have no right side)
      * This value is treated as a constant value, if it is present. If it's a string, it is parsed to an integer.
@@ -881,7 +902,9 @@ type PersonalizedResult<TVariant> = {
     /** Whether or not this result contains a personalized result */
     personalized: boolean;
     /** Matching variations */
-    variations: Array<TVariant>;
+    variations: Array<TVariant & {
+        control: boolean;
+    }>;
 };
 /** Defines the shape of a A/B test variant */
 type TestVariant = {
@@ -957,7 +980,10 @@ type PersonalizationEvent = {
     /** Name of the personalized placement */
     name: string;
     /** Selected variant ID(s) */
-    variantIds: string[];
+    variantIds: {
+        id: string;
+        control: boolean;
+    }[];
     /** Whether the user was part of the control group (and did not receive any personalization) */
     control: boolean | undefined;
     /**
@@ -1056,6 +1082,7 @@ declare class Context implements ContextInstance {
     getTestVariantId(testName: string): string | null | undefined;
     /** use test() instead */
     setTestVariantId(testName: string, variantId: string): void;
+    getPersonalizeVariantControl(name: string, index: number): boolean | undefined;
     /**
      * Writes a message to the Context log sink.
      * Used by Uniform internal SDK; not intended for public use.
@@ -1146,4 +1173,4 @@ declare global {
     }
 }
 
-export { type TestOptions as $, type AggregateDimension as A, type MessageFunc as B, type ContextPlugin as C, type DecayFunction as D, type LogMessageSingle as E, type LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, type CriteriaEvaluatorResult as I, type CriteriaEvaluatorParameters as J, type SignalData as K, type LogDrain as L, type MessageCategory as M, type ManifestV2 as N, type OutputSeverity as O, type PersonalizationEvent as P, type PersonalizationManifest as Q, type Signal as R, type ScoreVector as S, TransitionDataStore as T, type SignalCriteriaGroup as U, type VisitorData as V, type SignalCriteria as W, type EnrichmentCategory as X, type NumberMatch as Y, type TestDefinition as Z, type AggregateDimensionInput as _, type StorageCommands as a, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type ServerToClientTransitionState as ah, SERVER_STATE_ID as ai, type TransitionDataStoreEvents as aj, type DecayOptions as ak, type VisitorDataStoreOptions as al, type VisitorDataStoreEvents as am, VisitorDataStore as an, type Quirks as ao, type Tests as ap, type EnrichmentData as aq, type EventData as ar, emptyVisitorData as as, type ContextState as at, type ContextStateUpdate as au, type paths as av, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, type ContextOptions as j, type TestEvent as k, type ContextEvents as l, type ContextInstance as m, Context as n, type DevToolsUiVersion as o, type DevToolsState as p, type DevToolsActions as q, type DevToolsEvent as r, type DevToolsLogEvent as s, type DevToolsDataEvent as t, type DevToolsHelloEvent as u, type DevToolsUpdateEvent as v, type DevToolsRawCommandsEvent as w, type DevToolsForgetEvent as x, type LogMessages as y, type Severity as z };
+export { type TestOptions as $, type AggregateDimension as A, type MessageFunc as B, type ContextPlugin as C, type DecayFunction as D, type LogMessageSingle as E, type LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, type CriteriaEvaluatorResult as I, type CriteriaEvaluatorParameters as J, type SignalData as K, type LogDrain as L, type MessageCategory as M, type ManifestV2 as N, type OutputSeverity as O, type PersonalizationEvent as P, type PersonalizationManifest as Q, type Signal as R, type ScoreVector as S, TransitionDataStore as T, type SignalCriteriaGroup as U, type VisitorData as V, type SignalCriteria as W, type EnrichmentCategory as X, type NumberMatch as Y, type TestDefinition as Z, type AggregateDimensionInput as _, type StorageCommands as a, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type SetPersonalizeVariantControlCommand as ah, type ServerToClientTransitionState as ai, SERVER_STATE_ID as aj, type TransitionDataStoreEvents as ak, type DecayOptions as al, type VisitorDataStoreOptions as am, type VisitorDataStoreEvents as an, VisitorDataStore as ao, type Quirks as ap, type Tests as aq, type EnrichmentData as ar, type PersonalizeControlVariant as as, type PersonalizeVariants as at, type EventData as au, emptyVisitorData as av, type ContextState as aw, type ContextStateUpdate as ax, type paths as ay, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, type ContextOptions as j, type TestEvent as k, type ContextEvents as l, type ContextInstance as m, Context as n, type DevToolsUiVersion as o, type DevToolsState as p, type DevToolsActions as q, type DevToolsEvent as r, type DevToolsLogEvent as s, type DevToolsDataEvent as t, type DevToolsHelloEvent as u, type DevToolsUpdateEvent as v, type DevToolsRawCommandsEvent as w, type DevToolsForgetEvent as x, type LogMessages as y, type Severity as z };

package/dist/{types-R41eD1zH.d.ts → types-o-_vpf1P.d.ts}

@@ -17,6 +17,13 @@ type EnrichmentData = {
     /** Strength value (amount of score added when viewing content) */
     str: number;
 };
+type PersonalizeControlVariant = {
+    index: number;
+    control: boolean;
+};
+type PersonalizeVariants = {
+    [key: string]: PersonalizeControlVariant[];
+};
 /** An event that has occurred (i.e. an analytics track) which may trigger an Event signal */
 type EventData = {
     /** The event name that has been fired */
@@ -55,6 +62,10 @@ type VisitorData = {
      * based on the control group size.
      */
     controlGroup?: boolean;
+    /**
+     * Records of personalized variants that have been shown to the visitor and their control group status
+     */
+    personalizeVariants?: PersonalizeVariants;
 };
 declare const emptyVisitorData: () => VisitorData;
 /**
@@ -79,7 +90,7 @@ type StorageCommand<TID extends string = string, TData = unknown> = {
     data: TData;
 };
 /** Commands that can be issued to alter the storage of Uniform Context data */
-type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand;
 /**
  * Changes the visitor's permanent score for a given dimension
  */
@@ -125,11 +136,16 @@ type IdentifyCommand = StorageCommand<'identify', {
  * this command is intended mostly for diagnostics and testing purposes.
  */
 type SetControlGroupCommand = StorageCommand<'setcontrol', boolean>;
+type SetPersonalizeVariantControlCommand = StorageCommand<'setpersonalizecontrol', {
+    personlizationName: string;
+    index: number;
+    control: boolean;
+}>;
 
 type TransitionDataStoreOptions = {
     initialData?: Partial<VisitorData>;
 };
-type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests'> & {
+type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests' | 'personalizeVariants'> & {
     /**
      * Server Score Vector - the resultant scores _on the server side_ after the server/edge render completes
      * Note that the client side does not trust these scores; they are only used until it's done with initial
@@ -826,6 +842,10 @@ type VariantMatchCriteria = {
      * Name of the variant for analytics tracking.
      */
     name?: string;
+    /**
+     * Control group percentage for the variant.
+     */
+    control?: number;
 };
 type DimensionMatch = {
     /**
@@ -836,7 +856,8 @@ type DimensionMatch = {
     /**
      * Operator of the match expression
      * Whole-vector (RHS only) operators - these do not require a `r` or `rDim` set:
-     * +: `l` is the strongest dimension in the score vector
+     * +: `l` is the strongest dimension in the score vector across all categories
+     * ^: `l` is the strongest dimension in the specified category
      * -: `l` is the weakest dimension in the score vector. This does not match if the dimension has no score at all.
      *
      * Comparison operators:
@@ -847,7 +868,7 @@ type DimensionMatch = {
      * =: `l` is equal to the right hand side expression
      * !=: `l` is not equal to the right hand side expression
      */
-    op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=';
+    op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=' | '^';
     /**
      * Right hand side of the match expression (not required for op = + or - which have no right side)
      * This value is treated as a constant value, if it is present. If it's a string, it is parsed to an integer.
@@ -881,7 +902,9 @@ type PersonalizedResult<TVariant> = {
     /** Whether or not this result contains a personalized result */
     personalized: boolean;
     /** Matching variations */
-    variations: Array<TVariant>;
+    variations: Array<TVariant & {
+        control: boolean;
+    }>;
 };
 /** Defines the shape of a A/B test variant */
 type TestVariant = {
@@ -957,7 +980,10 @@ type PersonalizationEvent = {
     /** Name of the personalized placement */
     name: string;
     /** Selected variant ID(s) */
-    variantIds: string[];
+    variantIds: {
+        id: string;
+        control: boolean;
+    }[];
     /** Whether the user was part of the control group (and did not receive any personalization) */
     control: boolean | undefined;
     /**
@@ -1056,6 +1082,7 @@ declare class Context implements ContextInstance {
     getTestVariantId(testName: string): string | null | undefined;
     /** use test() instead */
     setTestVariantId(testName: string, variantId: string): void;
+    getPersonalizeVariantControl(name: string, index: number): boolean | undefined;
     /**
      * Writes a message to the Context log sink.
      * Used by Uniform internal SDK; not intended for public use.
@@ -1146,4 +1173,4 @@ declare global {
     }
 }
 
-export { type TestOptions as $, type AggregateDimension as A, type MessageFunc as B, type ContextPlugin as C, type DecayFunction as D, type LogMessageSingle as E, type LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, type CriteriaEvaluatorResult as I, type CriteriaEvaluatorParameters as J, type SignalData as K, type LogDrain as L, type MessageCategory as M, type ManifestV2 as N, type OutputSeverity as O, type PersonalizationEvent as P, type PersonalizationManifest as Q, type Signal as R, type ScoreVector as S, TransitionDataStore as T, type SignalCriteriaGroup as U, type VisitorData as V, type SignalCriteria as W, type EnrichmentCategory as X, type NumberMatch as Y, type TestDefinition as Z, type AggregateDimensionInput as _, type StorageCommands as a, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type ServerToClientTransitionState as ah, SERVER_STATE_ID as ai, type TransitionDataStoreEvents as aj, type DecayOptions as ak, type VisitorDataStoreOptions as al, type VisitorDataStoreEvents as am, VisitorDataStore as an, type Quirks as ao, type Tests as ap, type EnrichmentData as aq, type EventData as ar, emptyVisitorData as as, type ContextState as at, type ContextStateUpdate as au, type paths as av, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, type ContextOptions as j, type TestEvent as k, type ContextEvents as l, type ContextInstance as m, Context as n, type DevToolsUiVersion as o, type DevToolsState as p, type DevToolsActions as q, type DevToolsEvent as r, type DevToolsLogEvent as s, type DevToolsDataEvent as t, type DevToolsHelloEvent as u, type DevToolsUpdateEvent as v, type DevToolsRawCommandsEvent as w, type DevToolsForgetEvent as x, type LogMessages as y, type Severity as z };
+export { type TestOptions as $, type AggregateDimension as A, type MessageFunc as B, type ContextPlugin as C, type DecayFunction as D, type LogMessageSingle as E, type LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, type CriteriaEvaluatorResult as I, type CriteriaEvaluatorParameters as J, type SignalData as K, type LogDrain as L, type MessageCategory as M, type ManifestV2 as N, type OutputSeverity as O, type PersonalizationEvent as P, type PersonalizationManifest as Q, type Signal as R, type ScoreVector as S, TransitionDataStore as T, type SignalCriteriaGroup as U, type VisitorData as V, type SignalCriteria as W, type EnrichmentCategory as X, type NumberMatch as Y, type TestDefinition as Z, type AggregateDimensionInput as _, type StorageCommands as a, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type SetPersonalizeVariantControlCommand as ah, type ServerToClientTransitionState as ai, SERVER_STATE_ID as aj, type TransitionDataStoreEvents as ak, type DecayOptions as al, type VisitorDataStoreOptions as am, type VisitorDataStoreEvents as an, VisitorDataStore as ao, type Quirks as ap, type Tests as aq, type EnrichmentData as ar, type PersonalizeControlVariant as as, type PersonalizeVariants as at, type EventData as au, emptyVisitorData as av, type ContextState as aw, type ContextStateUpdate as ax, type paths as ay, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, type ContextOptions as j, type TestEvent as k, type ContextEvents as l, type ContextInstance as m, Context as n, type DevToolsUiVersion as o, type DevToolsState as p, type DevToolsActions as q, type DevToolsEvent as r, type DevToolsLogEvent as s, type DevToolsDataEvent as t, type DevToolsHelloEvent as u, type DevToolsUpdateEvent as v, type DevToolsRawCommandsEvent as w, type DevToolsForgetEvent as x, type LogMessages as y, type Severity as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "19.132.0",
+  "version": "19.134.0",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -66,5 +66,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7e50a3037d22f060b5de46fbe32b9e4a6fb1c16c"
+  "gitHead": "4d3856ce53d66b4e69fd693dadc98292cfbc37d1"
 }