@uniformdev/context 19.79.1-alpha.13 → 19.79.1-alpha.25

package/LICENSE.txt

@@ -1,2 +1,2 @@
-© 2023 Uniform Systems, Inc. All Rights Reserved.
+© 2024 Uniform Systems, Inc. All Rights Reserved.
 See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/api/api.d.mts

@@ -1,4 +1,4 @@
-import { aC as paths$7, N as ManifestV2 } from '../types-8605X2cu.mjs';
+import { aF as paths$7, N as ManifestV2 } from '../types-D4Fs5NVm.mjs';
 import 'mitt';
 
 type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;

package/dist/api/api.d.ts

@@ -1,4 +1,4 @@
-import { aC as paths$7, N as ManifestV2 } from '../types-8605X2cu.js';
+import { aF as paths$7, N as ManifestV2 } from '../types-D4Fs5NVm.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-8605X2cu.mjs';
-export { _ as AggregateDimensionInput, a8 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, az as ContextState, aA as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, ap 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, a5 as DimensionMatch, X as EnrichmentCategory, aw as EnrichmentData, a1 as EnrichmentGoal, ax as EventData, $ as Goal, aB as GoalStateUpdate, av as Goals, H as GroupCriteriaEvaluator, ak as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, af as ModifyScoreCommand, ag as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, a6 as PersonalizeOptions, aa as PersonalizedResult, a9 as PersonalizedVariant, a2 as QuirkGoal, at as Quirks, an as SERVER_STATE_ID, am as ServerToClientTransitionState, ah as SetConsentCommand, al as SetControlGroupCommand, ae as SetGoalCommand, ai as SetQuirkCommand, aj as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a0 as SignalGoal, ad as StorageCommand, Z as TestDefinition, k as TestEvent, a3 as TestOptions, ac as TestResult, ab as TestVariant, au as Tests, ao as TransitionDataStoreEvents, as as VisitorDataStore, ar as VisitorDataStoreEvents, aq as VisitorDataStoreOptions, ay as emptyVisitorData, a7 as personalizeVariations, a4 as testVariations } from './types-8605X2cu.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-D4Fs5NVm.mjs';
+export { _ as AggregateDimensionInput, a8 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, aC as ContextState, aD as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, aq 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, a5 as DimensionMatch, X as EnrichmentCategory, ax as EnrichmentData, a1 as EnrichmentGoal, aA as EventData, $ as Goal, aE as GoalStateUpdate, aw as Goals, H as GroupCriteriaEvaluator, ak as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, af as ModifyScoreCommand, ag as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, ay as PersonalizeControlVariant, a6 as PersonalizeOptions, az as PersonalizeVariants, aa as PersonalizedResult, a9 as PersonalizedVariant, a2 as QuirkGoal, au as Quirks, ao as SERVER_STATE_ID, an as ServerToClientTransitionState, ah as SetConsentCommand, al as SetControlGroupCommand, ae as SetGoalCommand, am as SetPersonalizeVariantControlCommand, ai as SetQuirkCommand, aj as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a0 as SignalGoal, ad as StorageCommand, Z as TestDefinition, k as TestEvent, a3 as TestOptions, ac as TestResult, ab as TestVariant, av as Tests, ap as TransitionDataStoreEvents, at as VisitorDataStore, as as VisitorDataStoreEvents, ar as VisitorDataStoreOptions, aB as emptyVisitorData, a7 as personalizeVariations, a4 as testVariations } from './types-D4Fs5NVm.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-8605X2cu.js';
-export { _ as AggregateDimensionInput, a8 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, az as ContextState, aA as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, ap 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, a5 as DimensionMatch, X as EnrichmentCategory, aw as EnrichmentData, a1 as EnrichmentGoal, ax as EventData, $ as Goal, aB as GoalStateUpdate, av as Goals, H as GroupCriteriaEvaluator, ak as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, af as ModifyScoreCommand, ag as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, a6 as PersonalizeOptions, aa as PersonalizedResult, a9 as PersonalizedVariant, a2 as QuirkGoal, at as Quirks, an as SERVER_STATE_ID, am as ServerToClientTransitionState, ah as SetConsentCommand, al as SetControlGroupCommand, ae as SetGoalCommand, ai as SetQuirkCommand, aj as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a0 as SignalGoal, ad as StorageCommand, Z as TestDefinition, k as TestEvent, a3 as TestOptions, ac as TestResult, ab as TestVariant, au as Tests, ao as TransitionDataStoreEvents, as as VisitorDataStore, ar as VisitorDataStoreEvents, aq as VisitorDataStoreOptions, ay as emptyVisitorData, a7 as personalizeVariations, a4 as testVariations } from './types-8605X2cu.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-D4Fs5NVm.js';
+export { _ as AggregateDimensionInput, a8 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, aC as ContextState, aD as ContextStateUpdate, J as CriteriaEvaluatorParameters, I as CriteriaEvaluatorResult, aq 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, a5 as DimensionMatch, X as EnrichmentCategory, ax as EnrichmentData, a1 as EnrichmentGoal, aA as EventData, $ as Goal, aE as GoalStateUpdate, aw as Goals, H as GroupCriteriaEvaluator, ak as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, af as ModifyScoreCommand, ag as ModifySessionScoreCommand, Y as NumberMatch, P as PersonalizationEvent, Q as PersonalizationManifest, ay as PersonalizeControlVariant, a6 as PersonalizeOptions, az as PersonalizeVariants, aa as PersonalizedResult, a9 as PersonalizedVariant, a2 as QuirkGoal, au as Quirks, ao as SERVER_STATE_ID, an as ServerToClientTransitionState, ah as SetConsentCommand, al as SetControlGroupCommand, ae as SetGoalCommand, am as SetPersonalizeVariantControlCommand, ai as SetQuirkCommand, aj as SetTestCommand, z as Severity, R as Signal, W as SignalCriteria, U as SignalCriteriaGroup, K as SignalData, a0 as SignalGoal, ad as StorageCommand, Z as TestDefinition, k as TestEvent, a3 as TestOptions, ac as TestResult, ab as TestVariant, av as Tests, ap as TransitionDataStoreEvents, at as VisitorDataStore, as as VisitorDataStoreEvents, ar as VisitorDataStoreOptions, aB as emptyVisitorData, a7 as personalizeVariations, a4 as testVariations } from './types-D4Fs5NVm.js';
 import Cookies from 'js-cookie';
 import 'mitt';
 

package/dist/index.esm.js

@@ -522,6 +522,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, _goalEvaluators, _onLogMessage2;
 var ManifestInstance = class {
@@ -556,12 +565,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;
@@ -643,7 +648,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",
@@ -730,31 +758,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 {
@@ -1001,16 +1068,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) {
@@ -1034,9 +1104,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);
@@ -1125,7 +1234,8 @@ var emptyVisitorData = () => ({
   tests: {},
   goals: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1174,6 +1284,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;
       case "setgoal":
         newData.goals = (_c = newData.goals) != null ? _c : {};
         newData.goals[command.data.goal] = true;
@@ -1556,7 +1685,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) {
@@ -1586,6 +1715,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",
@@ -1595,7 +1735,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) {
@@ -1686,6 +1826,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.
@@ -1728,10 +1875,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
     };
@@ -1768,7 +1915,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]) => {
@@ -2468,7 +2616,7 @@ var createInsightsClient = ({ endpoint }) => {
       return sendMessage(message);
     },
     personalizationResult: async (options) => {
-      const messages = options.variantIds.map((variantId) => {
+      const messages = options.variantIds.map((variant) => {
         const message = {
           action: "personalization_result",
           version: "1",
@@ -2479,8 +2627,8 @@ var createInsightsClient = ({ endpoint }) => {
           payload: {
             ...getBasePayload(),
             name: options.name,
-            variantId,
-            control: options.control,
+            variantId: variant.id,
+            control: variant.control || options.control,
             changed: options.changed
           }
         };

package/dist/index.js

@@ -593,6 +593,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, _goalEvaluators, _onLogMessage2;
 var ManifestInstance = class {
@@ -627,12 +636,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;
@@ -714,7 +719,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",
@@ -801,31 +829,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 {
@@ -1072,16 +1139,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) {
@@ -1105,9 +1175,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);
@@ -1196,7 +1305,8 @@ var emptyVisitorData = () => ({
   tests: {},
   goals: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1245,6 +1355,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;
       case "setgoal":
         newData.goals = (_c = newData.goals) != null ? _c : {};
         newData.goals[command.data.goal] = true;
@@ -1627,7 +1756,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) {
@@ -1657,6 +1786,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",
@@ -1666,7 +1806,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) {
@@ -1757,6 +1897,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.
@@ -1799,10 +1946,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
     };
@@ -1839,7 +1986,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]) => {
@@ -2539,7 +2687,7 @@ var createInsightsClient = ({ endpoint }) => {
       return sendMessage(message);
     },
     personalizationResult: async (options) => {
-      const messages = options.variantIds.map((variantId) => {
+      const messages = options.variantIds.map((variant) => {
         const message = {
           action: "personalization_result",
           version: "1",
@@ -2550,8 +2698,8 @@ var createInsightsClient = ({ endpoint }) => {
           payload: {
             ...getBasePayload(),
             name: options.name,
-            variantId,
-            control: options.control,
+            variantId: variant.id,
+            control: variant.control || options.control,
             changed: options.changed
           }
         };

package/dist/index.mjs

@@ -522,6 +522,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, _goalEvaluators, _onLogMessage2;
 var ManifestInstance = class {
@@ -556,12 +565,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;
@@ -643,7 +648,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",
@@ -730,31 +758,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 {
@@ -1001,16 +1068,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) {
@@ -1034,9 +1104,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);
@@ -1125,7 +1234,8 @@ var emptyVisitorData = () => ({
   tests: {},
   goals: {},
   consent: false,
-  controlGroup: false
+  controlGroup: false,
+  personalizeVariants: {}
 });
 
 // src/storage/VisitorDataStore.ts
@@ -1174,6 +1284,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;
       case "setgoal":
         newData.goals = (_c = newData.goals) != null ? _c : {};
         newData.goals[command.data.goal] = true;
@@ -1556,7 +1685,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) {
@@ -1586,6 +1715,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",
@@ -1595,7 +1735,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) {
@@ -1686,6 +1826,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.
@@ -1728,10 +1875,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
     };
@@ -1768,7 +1915,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]) => {
@@ -2468,7 +2616,7 @@ var createInsightsClient = ({ endpoint }) => {
       return sendMessage(message);
     },
     personalizationResult: async (options) => {
-      const messages = options.variantIds.map((variantId) => {
+      const messages = options.variantIds.map((variant) => {
         const message = {
           action: "personalization_result",
           version: "1",
@@ -2479,8 +2627,8 @@ var createInsightsClient = ({ endpoint }) => {
           payload: {
             ...getBasePayload(),
             name: options.name,
-            variantId,
-            control: options.control,
+            variantId: variant.id,
+            control: variant.control || options.control,
             changed: options.changed
           }
         };

package/dist/{types-8605X2cu.d.mts → types-D4Fs5NVm.d.mts}

@@ -20,6 +20,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 */
@@ -62,6 +69,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;
 /**
@@ -90,7 +101,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 | SetGoalCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand | SetGoalCommand;
 /**
  * Converts the goal specified.
  */
@@ -142,11 +153,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
@@ -911,6 +927,10 @@ type VariantMatchCriteria = {
      * Name of the variant for analytics tracking.
      */
     name?: string;
+    /**
+     * Control group percentage for the variant.
+     */
+    control?: number;
 };
 type DimensionMatch = {
     /**
@@ -921,7 +941,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:
@@ -932,7 +953,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.
@@ -966,7 +987,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 = {
@@ -1044,7 +1067,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;
     /**
@@ -1143,6 +1169,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.
@@ -1233,4 +1260,4 @@ declare global {
     }
 }
 
-export { type Goal 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, type SignalGoal as a0, type EnrichmentGoal as a1, type QuirkGoal as a2, type TestOptions as a3, testVariations as a4, type DimensionMatch as a5, type PersonalizeOptions as a6, personalizeVariations as a7, type BehaviorTag as a8, type PersonalizedVariant as a9, type ContextStateUpdate as aA, type GoalStateUpdate as aB, type paths as aC, type PersonalizedResult as aa, type TestVariant as ab, type TestResult as ac, type StorageCommand as ad, type SetGoalCommand as ae, type ModifyScoreCommand as af, type ModifySessionScoreCommand as ag, type SetConsentCommand as ah, type SetQuirkCommand as ai, type SetTestCommand as aj, type IdentifyCommand as ak, type SetControlGroupCommand as al, type ServerToClientTransitionState as am, SERVER_STATE_ID as an, type TransitionDataStoreEvents as ao, type DecayOptions as ap, type VisitorDataStoreOptions as aq, type VisitorDataStoreEvents as ar, VisitorDataStore as as, type Quirks as at, type Tests as au, type Goals as av, type EnrichmentData as aw, type EventData as ax, emptyVisitorData as ay, type ContextState as az, 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 Goal 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, type SignalGoal as a0, type EnrichmentGoal as a1, type QuirkGoal as a2, type TestOptions as a3, testVariations as a4, type DimensionMatch as a5, type PersonalizeOptions as a6, personalizeVariations as a7, type BehaviorTag as a8, type PersonalizedVariant as a9, type EventData as aA, emptyVisitorData as aB, type ContextState as aC, type ContextStateUpdate as aD, type GoalStateUpdate as aE, type paths as aF, type PersonalizedResult as aa, type TestVariant as ab, type TestResult as ac, type StorageCommand as ad, type SetGoalCommand as ae, type ModifyScoreCommand as af, type ModifySessionScoreCommand as ag, type SetConsentCommand as ah, type SetQuirkCommand as ai, type SetTestCommand as aj, type IdentifyCommand as ak, type SetControlGroupCommand as al, type SetPersonalizeVariantControlCommand as am, type ServerToClientTransitionState as an, SERVER_STATE_ID as ao, type TransitionDataStoreEvents as ap, type DecayOptions as aq, type VisitorDataStoreOptions as ar, type VisitorDataStoreEvents as as, VisitorDataStore as at, type Quirks as au, type Tests as av, type Goals as aw, type EnrichmentData as ax, type PersonalizeControlVariant as ay, type PersonalizeVariants as az, 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-8605X2cu.d.ts → types-D4Fs5NVm.d.ts}

@@ -20,6 +20,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 */
@@ -62,6 +69,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;
 /**
@@ -90,7 +101,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 | SetGoalCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand | SetGoalCommand;
 /**
  * Converts the goal specified.
  */
@@ -142,11 +153,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
@@ -911,6 +927,10 @@ type VariantMatchCriteria = {
      * Name of the variant for analytics tracking.
      */
     name?: string;
+    /**
+     * Control group percentage for the variant.
+     */
+    control?: number;
 };
 type DimensionMatch = {
     /**
@@ -921,7 +941,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:
@@ -932,7 +953,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.
@@ -966,7 +987,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 = {
@@ -1044,7 +1067,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;
     /**
@@ -1143,6 +1169,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.
@@ -1233,4 +1260,4 @@ declare global {
     }
 }
 
-export { type Goal 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, type SignalGoal as a0, type EnrichmentGoal as a1, type QuirkGoal as a2, type TestOptions as a3, testVariations as a4, type DimensionMatch as a5, type PersonalizeOptions as a6, personalizeVariations as a7, type BehaviorTag as a8, type PersonalizedVariant as a9, type ContextStateUpdate as aA, type GoalStateUpdate as aB, type paths as aC, type PersonalizedResult as aa, type TestVariant as ab, type TestResult as ac, type StorageCommand as ad, type SetGoalCommand as ae, type ModifyScoreCommand as af, type ModifySessionScoreCommand as ag, type SetConsentCommand as ah, type SetQuirkCommand as ai, type SetTestCommand as aj, type IdentifyCommand as ak, type SetControlGroupCommand as al, type ServerToClientTransitionState as am, SERVER_STATE_ID as an, type TransitionDataStoreEvents as ao, type DecayOptions as ap, type VisitorDataStoreOptions as aq, type VisitorDataStoreEvents as ar, VisitorDataStore as as, type Quirks as at, type Tests as au, type Goals as av, type EnrichmentData as aw, type EventData as ax, emptyVisitorData as ay, type ContextState as az, 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 Goal 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, type SignalGoal as a0, type EnrichmentGoal as a1, type QuirkGoal as a2, type TestOptions as a3, testVariations as a4, type DimensionMatch as a5, type PersonalizeOptions as a6, personalizeVariations as a7, type BehaviorTag as a8, type PersonalizedVariant as a9, type EventData as aA, emptyVisitorData as aB, type ContextState as aC, type ContextStateUpdate as aD, type GoalStateUpdate as aE, type paths as aF, type PersonalizedResult as aa, type TestVariant as ab, type TestResult as ac, type StorageCommand as ad, type SetGoalCommand as ae, type ModifyScoreCommand as af, type ModifySessionScoreCommand as ag, type SetConsentCommand as ah, type SetQuirkCommand as ai, type SetTestCommand as aj, type IdentifyCommand as ak, type SetControlGroupCommand as al, type SetPersonalizeVariantControlCommand as am, type ServerToClientTransitionState as an, SERVER_STATE_ID as ao, type TransitionDataStoreEvents as ap, type DecayOptions as aq, type VisitorDataStoreOptions as ar, type VisitorDataStoreEvents as as, VisitorDataStore as at, type Quirks as au, type Tests as av, type Goals as aw, type EnrichmentData as ax, type PersonalizeControlVariant as ay, type PersonalizeVariants as az, 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.79.1-alpha.13+608a273da",
+  "version": "19.79.1-alpha.25+87cea1cd47",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -68,5 +68,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "608a273da87aa432f17b2c8ce15d747dadab0cd1"
+  "gitHead": "87cea1cd47c691f7d32b876660d5f7c984bb1d87"
 }