@uniformdev/context 20.6.1-alpha.0 → 20.6.2-alpha.10

package/dist/api/api.d.mts

@@ -1,4 +1,4 @@
-import { aC as paths$7, N as ManifestV2 } from '../types-EJl31yuP.mjs';
+import { aI as paths$7, $ as ManifestV2 } from '../types-CzIkFCDD.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-EJl31yuP.js';
+import { aI as paths$7, $ as ManifestV2 } from '../types-CzIkFCDD.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, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-EJl31yuP.mjs';
-export { $ as AggregateDimensionInput, a5 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, ao 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, a2 as DimensionMatch, Y as EnrichmentCategory, au as EnrichmentData, ax as EventData, aB as GoalStateUpdate, at as Goals, H as GroupCriteriaEvaluator, ah as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, ac as ModifyScoreCommand, ad as ModifySessionScoreCommand, Z as NumberMatch, P as PersonalizationEvent, R as PersonalizationManifest, av as PersonalizeControlVariant, a3 as PersonalizeOptions, aw as PersonalizeVariants, a7 as PersonalizedResult, a6 as PersonalizedVariant, am as SERVER_STATE_ID, al as ServerToClientTransitionState, ae as SetConsentCommand, ai as SetControlGroupCommand, ab as SetGoalCommand, aj as SetPersonalizeVariantControlCommand, af as SetQuirkCommand, ag as SetTestCommand, z as Severity, U as Signal, X as SignalCriteria, W as SignalCriteriaGroup, K as SignalData, aa as StorageCommand, _ as TestDefinition, k as TestEvent, a0 as TestOptions, a9 as TestResult, a8 as TestVariant, as as Tests, an as TransitionDataStoreEvents, ar as VisitorDataStore, aq as VisitorDataStoreEvents, ap as VisitorDataStoreOptions, ak as areCommandsEqual, ay as emptyVisitorData, a4 as personalizeVariations, a1 as testVariations } from './types-EJl31yuP.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, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-CzIkFCDD.mjs';
+export { a7 as AggregateDimensionInput, ad as BehaviorTag, m as CONTEXTUAL_EDITING_TEST_NAME, n as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, u as ContextEvents, v as ContextInstance, q as ContextOptions, aF as ContextState, aG as ContextStateUpdate, Z as CriteriaEvaluatorParameters, Y as CriteriaEvaluatorResult, au as DecayOptions, y as DevToolsActions, E as DevToolsDataEvent, z as DevToolsEvent, I as DevToolsForgetEvent, F as DevToolsHelloEvent, B as DevToolsLogEvent, H as DevToolsRawCommandsEvent, x as DevToolsState, w as DevToolsUiVersion, G as DevToolsUpdateEvent, ab as DimensionMatch, a4 as EnrichmentCategory, aA as EnrichmentData, aD as EventData, aH as GoalStateUpdate, az as Goals, X as GroupCriteriaEvaluator, an as IdentifyCommand, U as LogMessageGroup, R as LogMessageSingle, J as LogMessages, W as ManifestInstance, $ as ManifestV2, M as MessageCategory, N as MessageFunc, ai as ModifyScoreCommand, aj as ModifySessionScoreCommand, a5 as NumberMatch, s as PersonalizationEvent, r as PersonalizationEventVariantId, a0 as PersonalizationManifest, o as PersonalizationSelectionAlgorithm, p as PersonalizationSelectionAlgorithms, aB as PersonalizeControlVariant, aC as PersonalizeVariants, ac as QuirkMatch, as as SERVER_STATE_ID, ar as ServerToClientTransitionState, ak as SetConsentCommand, ao as SetControlGroupCommand, ah as SetGoalCommand, ap as SetPersonalizeVariantControlCommand, al as SetQuirkCommand, am as SetTestCommand, K as Severity, a1 as Signal, a3 as SignalCriteria, a2 as SignalCriteriaGroup, _ as SignalData, ag as StorageCommand, a6 as TestDefinition, t as TestEvent, a8 as TestOptions, af as TestResult, ae as TestVariant, ay as Tests, at as TransitionDataStoreEvents, aa as VariationMatchMetadata, ax as VisitorDataStore, aw as VisitorDataStoreEvents, av as VisitorDataStoreOptions, aq as areCommandsEqual, aE as emptyVisitorData, a9 as testVariations } from './types-CzIkFCDD.mjs';
 import Cookies from 'js-cookie';
 import 'mitt';
 
@@ -158,7 +158,35 @@ declare function createDebugConsoleLogDrain(level: OutputSeverity, options?: Con
  */
 declare function enableDebugConsoleLogDrain(level: OutputSeverity, options?: ConsoleDebugLogDrainOptions): ContextPlugin;
 
-declare function evaluateVariantMatch(variantId: string, match: VariantMatchCriteria | undefined | null, vec: ScoreVector, onLogMessage?: (message: LogMessage) => void): boolean;
+declare function evaluateVariantMatch(variantId: string, match: VariantMatchCriteria | undefined | null, vec: ScoreVector, onLogMessage?: (message: LogMessage) => void, quirks?: Quirks): boolean;
+
+/**
+ * @deprecated Use `topDownCriteriaPersonalizationSelectionAlgorithm` instead
+ */
+declare function personalizeVariations<TVariant extends PersonalizedVariant<VariantMatchCriteria>>(options: PersonalizeOptions<TVariant> & {
+    context: Context;
+}): PersonalizedResult<TVariant>;
+
+declare const STRONGEST_SCORE_PERSONALIZATION_ALGORITHM = "ssc";
+/**
+ * Implementation of the strongest score personalization selection algorithm.
+ *
+ * In this mode, we take all variations and break them into two groups:
+ * 1. Variations that have a positive score for their tagged dimension
+ * 2. Variations that do not have a dimension tag
+ *
+ * We then sort the first group by score, concatenate the second group, and return the top <take> variations.
+ */
+declare function strongestScorePersonalizationSelectionAlgorithm<TCriteria extends VariationMatchDimensionCriteria, TVariation extends PersonalizedVariant<TCriteria>>({ name, context, variations, take, onLogMessage, }: PersonalizationSelectionAlgorithmOptions<TCriteria, TVariation>): PersonalizedResult<TVariation>;
+
+declare const TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM = "default";
+/**
+ * Implementation of the top-down criteria personalization selection algorithm.
+ *
+ * In this mode, we evaluate variations in the order they are declared and the first <take>
+ * variations whose criteria evaluate to true are selected.
+ */
+declare function topDownCriteriaPersonalizationSelectionAlgorithm<TCriteria extends VariantMatchCriteria, TVariation extends PersonalizedVariant<TCriteria>>({ name, context, variations, take, onLogMessage, }: PersonalizationSelectionAlgorithmOptions<TCriteria, TVariation>): PersonalizedResult<TVariation>;
 
 type ContextDevToolOptions = {
     onAfterMessageReceived?: (message: DevToolsEvents) => void;
@@ -183,6 +211,7 @@ declare enum ScriptType {
 type EdgePersonalizeComponentOptions = {
     name: string;
     count?: number;
+    algorithm?: string;
 };
 type EdgeTestComponentOptions = {
     name: string;
@@ -213,4 +242,4 @@ type QuickConnectConfig = {
 declare function serializeQuickConnect(config: QuickConnectConfig): string;
 declare function parseQuickConnect(serialized: string): Required<QuickConnectConfig>;
 
-export { AggregateDimension, type ConsoleDebugLogDrainOptions, type ContextDevToolOptions, ContextPlugin, CookieTransitionDataStore, type CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DevToolsEvents, ENR_SEPARATOR, EdgeNodeTagName, type EdgePersonalizeComponentOptions, type EdgeTestComponentOptions, EdgeTransitionDataStore, type EdgeTransitionDataStoreOptions, type EnableUniformInsightsOptions, KV_SEP, type LinearDecayOptions, LogDrain, LogMessage, OutputSeverity, PAIR_SEP, QUIRK_SEP, type QuickConnectConfig, Quirks, ScoreVector, ScriptType, StorageCommands, StringMatch, TYPE_SEP, TransitionDataStore, TransitionDataStoreOptions, UNIFORM_DEFAULT_COOKIE_NAME, UNIFORM_DEFAULT_QUIRK_COOKIE_NAME, VariantMatchCriteria, VisitorData, computeAggregateDimensions, cookieEvaluator, createConsoleLogDrain, createDebugConsoleLogDrain, createLinearDecay, currentPageEvaluator, decodeCookieType, decodePersonalizeVariants, enableConsoleLogDrain, enableContextDevTools, enableDebugConsoleLogDrain, enableUniformInsights, encodeCookieType, evaluateVariantMatch, eventEvaluator, explainStringMatch, explainStringMatchCriteria, getEnrichmentVectorKey, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, parseCookieScores, parseCookieType, parseQuickConnect, parseQuirkCookie, parseScoreCookie, queryStringEvaluator, quirkEvaluator, serializeCookie, serializeCookieType, serializePersonalizeVariants, serializeQuickConnect, serializeQuirks };
+export { AggregateDimension, type ConsoleDebugLogDrainOptions, Context, type ContextDevToolOptions, ContextPlugin, CookieTransitionDataStore, type CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DevToolsEvents, ENR_SEPARATOR, EdgeNodeTagName, type EdgePersonalizeComponentOptions, type EdgeTestComponentOptions, EdgeTransitionDataStore, type EdgeTransitionDataStoreOptions, type EnableUniformInsightsOptions, KV_SEP, type LinearDecayOptions, LogDrain, LogMessage, OutputSeverity, PAIR_SEP, PersonalizationSelectionAlgorithmOptions, PersonalizeOptions, PersonalizedResult, PersonalizedVariant, QUIRK_SEP, type QuickConnectConfig, Quirks, STRONGEST_SCORE_PERSONALIZATION_ALGORITHM, ScoreVector, ScriptType, StorageCommands, StringMatch, TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM, TYPE_SEP, TransitionDataStore, TransitionDataStoreOptions, UNIFORM_DEFAULT_COOKIE_NAME, UNIFORM_DEFAULT_QUIRK_COOKIE_NAME, VariantMatchCriteria, VariationMatchDimensionCriteria, VisitorData, computeAggregateDimensions, cookieEvaluator, createConsoleLogDrain, createDebugConsoleLogDrain, createLinearDecay, currentPageEvaluator, decodeCookieType, decodePersonalizeVariants, enableConsoleLogDrain, enableContextDevTools, enableDebugConsoleLogDrain, enableUniformInsights, encodeCookieType, evaluateVariantMatch, eventEvaluator, explainStringMatch, explainStringMatchCriteria, getEnrichmentVectorKey, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, parseCookieScores, parseCookieType, parseQuickConnect, parseQuirkCookie, parseScoreCookie, personalizeVariations, queryStringEvaluator, quirkEvaluator, serializeCookie, serializeCookieType, serializePersonalizeVariants, serializeQuickConnect, serializeQuirks, strongestScorePersonalizationSelectionAlgorithm, topDownCriteriaPersonalizationSelectionAlgorithm };

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, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, g as DevToolsEvents } from './types-EJl31yuP.js';
-export { $ as AggregateDimensionInput, a5 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, ao 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, a2 as DimensionMatch, Y as EnrichmentCategory, au as EnrichmentData, ax as EventData, aB as GoalStateUpdate, at as Goals, H as GroupCriteriaEvaluator, ah as IdentifyCommand, F as LogMessageGroup, E as LogMessageSingle, y as LogMessages, G as ManifestInstance, N as ManifestV2, M as MessageCategory, B as MessageFunc, ac as ModifyScoreCommand, ad as ModifySessionScoreCommand, Z as NumberMatch, P as PersonalizationEvent, R as PersonalizationManifest, av as PersonalizeControlVariant, a3 as PersonalizeOptions, aw as PersonalizeVariants, a7 as PersonalizedResult, a6 as PersonalizedVariant, am as SERVER_STATE_ID, al as ServerToClientTransitionState, ae as SetConsentCommand, ai as SetControlGroupCommand, ab as SetGoalCommand, aj as SetPersonalizeVariantControlCommand, af as SetQuirkCommand, ag as SetTestCommand, z as Severity, U as Signal, X as SignalCriteria, W as SignalCriteriaGroup, K as SignalData, aa as StorageCommand, _ as TestDefinition, k as TestEvent, a0 as TestOptions, a9 as TestResult, a8 as TestVariant, as as Tests, an as TransitionDataStoreEvents, ar as VisitorDataStore, aq as VisitorDataStoreEvents, ap as VisitorDataStoreOptions, ak as areCommandsEqual, ay as emptyVisitorData, a4 as personalizeVariations, a1 as testVariations } from './types-EJl31yuP.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, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-CzIkFCDD.js';
+export { a7 as AggregateDimensionInput, ad as BehaviorTag, m as CONTEXTUAL_EDITING_TEST_NAME, n as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, u as ContextEvents, v as ContextInstance, q as ContextOptions, aF as ContextState, aG as ContextStateUpdate, Z as CriteriaEvaluatorParameters, Y as CriteriaEvaluatorResult, au as DecayOptions, y as DevToolsActions, E as DevToolsDataEvent, z as DevToolsEvent, I as DevToolsForgetEvent, F as DevToolsHelloEvent, B as DevToolsLogEvent, H as DevToolsRawCommandsEvent, x as DevToolsState, w as DevToolsUiVersion, G as DevToolsUpdateEvent, ab as DimensionMatch, a4 as EnrichmentCategory, aA as EnrichmentData, aD as EventData, aH as GoalStateUpdate, az as Goals, X as GroupCriteriaEvaluator, an as IdentifyCommand, U as LogMessageGroup, R as LogMessageSingle, J as LogMessages, W as ManifestInstance, $ as ManifestV2, M as MessageCategory, N as MessageFunc, ai as ModifyScoreCommand, aj as ModifySessionScoreCommand, a5 as NumberMatch, s as PersonalizationEvent, r as PersonalizationEventVariantId, a0 as PersonalizationManifest, o as PersonalizationSelectionAlgorithm, p as PersonalizationSelectionAlgorithms, aB as PersonalizeControlVariant, aC as PersonalizeVariants, ac as QuirkMatch, as as SERVER_STATE_ID, ar as ServerToClientTransitionState, ak as SetConsentCommand, ao as SetControlGroupCommand, ah as SetGoalCommand, ap as SetPersonalizeVariantControlCommand, al as SetQuirkCommand, am as SetTestCommand, K as Severity, a1 as Signal, a3 as SignalCriteria, a2 as SignalCriteriaGroup, _ as SignalData, ag as StorageCommand, a6 as TestDefinition, t as TestEvent, a8 as TestOptions, af as TestResult, ae as TestVariant, ay as Tests, at as TransitionDataStoreEvents, aa as VariationMatchMetadata, ax as VisitorDataStore, aw as VisitorDataStoreEvents, av as VisitorDataStoreOptions, aq as areCommandsEqual, aE as emptyVisitorData, a9 as testVariations } from './types-CzIkFCDD.js';
 import Cookies from 'js-cookie';
 import 'mitt';
 
@@ -158,7 +158,35 @@ declare function createDebugConsoleLogDrain(level: OutputSeverity, options?: Con
  */
 declare function enableDebugConsoleLogDrain(level: OutputSeverity, options?: ConsoleDebugLogDrainOptions): ContextPlugin;
 
-declare function evaluateVariantMatch(variantId: string, match: VariantMatchCriteria | undefined | null, vec: ScoreVector, onLogMessage?: (message: LogMessage) => void): boolean;
+declare function evaluateVariantMatch(variantId: string, match: VariantMatchCriteria | undefined | null, vec: ScoreVector, onLogMessage?: (message: LogMessage) => void, quirks?: Quirks): boolean;
+
+/**
+ * @deprecated Use `topDownCriteriaPersonalizationSelectionAlgorithm` instead
+ */
+declare function personalizeVariations<TVariant extends PersonalizedVariant<VariantMatchCriteria>>(options: PersonalizeOptions<TVariant> & {
+    context: Context;
+}): PersonalizedResult<TVariant>;
+
+declare const STRONGEST_SCORE_PERSONALIZATION_ALGORITHM = "ssc";
+/**
+ * Implementation of the strongest score personalization selection algorithm.
+ *
+ * In this mode, we take all variations and break them into two groups:
+ * 1. Variations that have a positive score for their tagged dimension
+ * 2. Variations that do not have a dimension tag
+ *
+ * We then sort the first group by score, concatenate the second group, and return the top <take> variations.
+ */
+declare function strongestScorePersonalizationSelectionAlgorithm<TCriteria extends VariationMatchDimensionCriteria, TVariation extends PersonalizedVariant<TCriteria>>({ name, context, variations, take, onLogMessage, }: PersonalizationSelectionAlgorithmOptions<TCriteria, TVariation>): PersonalizedResult<TVariation>;
+
+declare const TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM = "default";
+/**
+ * Implementation of the top-down criteria personalization selection algorithm.
+ *
+ * In this mode, we evaluate variations in the order they are declared and the first <take>
+ * variations whose criteria evaluate to true are selected.
+ */
+declare function topDownCriteriaPersonalizationSelectionAlgorithm<TCriteria extends VariantMatchCriteria, TVariation extends PersonalizedVariant<TCriteria>>({ name, context, variations, take, onLogMessage, }: PersonalizationSelectionAlgorithmOptions<TCriteria, TVariation>): PersonalizedResult<TVariation>;
 
 type ContextDevToolOptions = {
     onAfterMessageReceived?: (message: DevToolsEvents) => void;
@@ -183,6 +211,7 @@ declare enum ScriptType {
 type EdgePersonalizeComponentOptions = {
     name: string;
     count?: number;
+    algorithm?: string;
 };
 type EdgeTestComponentOptions = {
     name: string;
@@ -213,4 +242,4 @@ type QuickConnectConfig = {
 declare function serializeQuickConnect(config: QuickConnectConfig): string;
 declare function parseQuickConnect(serialized: string): Required<QuickConnectConfig>;
 
-export { AggregateDimension, type ConsoleDebugLogDrainOptions, type ContextDevToolOptions, ContextPlugin, CookieTransitionDataStore, type CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DevToolsEvents, ENR_SEPARATOR, EdgeNodeTagName, type EdgePersonalizeComponentOptions, type EdgeTestComponentOptions, EdgeTransitionDataStore, type EdgeTransitionDataStoreOptions, type EnableUniformInsightsOptions, KV_SEP, type LinearDecayOptions, LogDrain, LogMessage, OutputSeverity, PAIR_SEP, QUIRK_SEP, type QuickConnectConfig, Quirks, ScoreVector, ScriptType, StorageCommands, StringMatch, TYPE_SEP, TransitionDataStore, TransitionDataStoreOptions, UNIFORM_DEFAULT_COOKIE_NAME, UNIFORM_DEFAULT_QUIRK_COOKIE_NAME, VariantMatchCriteria, VisitorData, computeAggregateDimensions, cookieEvaluator, createConsoleLogDrain, createDebugConsoleLogDrain, createLinearDecay, currentPageEvaluator, decodeCookieType, decodePersonalizeVariants, enableConsoleLogDrain, enableContextDevTools, enableDebugConsoleLogDrain, enableUniformInsights, encodeCookieType, evaluateVariantMatch, eventEvaluator, explainStringMatch, explainStringMatchCriteria, getEnrichmentVectorKey, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, parseCookieScores, parseCookieType, parseQuickConnect, parseQuirkCookie, parseScoreCookie, queryStringEvaluator, quirkEvaluator, serializeCookie, serializeCookieType, serializePersonalizeVariants, serializeQuickConnect, serializeQuirks };
+export { AggregateDimension, type ConsoleDebugLogDrainOptions, Context, type ContextDevToolOptions, ContextPlugin, CookieTransitionDataStore, type CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DevToolsEvents, ENR_SEPARATOR, EdgeNodeTagName, type EdgePersonalizeComponentOptions, type EdgeTestComponentOptions, EdgeTransitionDataStore, type EdgeTransitionDataStoreOptions, type EnableUniformInsightsOptions, KV_SEP, type LinearDecayOptions, LogDrain, LogMessage, OutputSeverity, PAIR_SEP, PersonalizationSelectionAlgorithmOptions, PersonalizeOptions, PersonalizedResult, PersonalizedVariant, QUIRK_SEP, type QuickConnectConfig, Quirks, STRONGEST_SCORE_PERSONALIZATION_ALGORITHM, ScoreVector, ScriptType, StorageCommands, StringMatch, TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM, TYPE_SEP, TransitionDataStore, TransitionDataStoreOptions, UNIFORM_DEFAULT_COOKIE_NAME, UNIFORM_DEFAULT_QUIRK_COOKIE_NAME, VariantMatchCriteria, VariationMatchDimensionCriteria, VisitorData, computeAggregateDimensions, cookieEvaluator, createConsoleLogDrain, createDebugConsoleLogDrain, createLinearDecay, currentPageEvaluator, decodeCookieType, decodePersonalizeVariants, enableConsoleLogDrain, enableContextDevTools, enableDebugConsoleLogDrain, enableUniformInsights, encodeCookieType, evaluateVariantMatch, eventEvaluator, explainStringMatch, explainStringMatchCriteria, getEnrichmentVectorKey, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, parseCookieScores, parseCookieType, parseQuickConnect, parseQuirkCookie, parseScoreCookie, personalizeVariations, queryStringEvaluator, quirkEvaluator, serializeCookie, serializeCookieType, serializePersonalizeVariants, serializeQuickConnect, serializeQuirks, strongestScorePersonalizationSelectionAlgorithm, topDownCriteriaPersonalizationSelectionAlgorithm };

package/dist/index.esm.js

@@ -516,7 +516,7 @@ var GroupCriteriaEvaluator = class {
 _evaluators = new WeakMap();
 
 // src/placement/criteria/evaluateVariantMatch.ts
-function evaluateVariantMatch(variantId, match, vec, onLogMessage) {
+function evaluateVariantMatch(variantId, match, vec, onLogMessage, quirks) {
   onLogMessage == null ? void 0 : onLogMessage(["info", 301, "GROUP", { id: variantId, op: match == null ? void 0 : match.op }]);
   let result;
   try {
@@ -524,9 +524,9 @@ function evaluateVariantMatch(variantId, match, vec, onLogMessage) {
       onLogMessage == null ? void 0 : onLogMessage(["info", 302, { matched: true, description: "default variation" }]);
       result = true;
     } else if (!match.op || match.op === "&") {
-      result = match.crit.every((c) => evaluateDimensionMatch(c, vec, onLogMessage));
+      result = match.crit.every((c) => evaluateMatch(c, vec, quirks != null ? quirks : {}, onLogMessage));
     } else {
-      result = match.crit.some((c) => evaluateDimensionMatch(c, vec, onLogMessage));
+      result = match.crit.some((c) => evaluateMatch(c, vec, quirks != null ? quirks : {}, onLogMessage));
     }
     onLogMessage == null ? void 0 : onLogMessage(["info", 303, result]);
   } finally {
@@ -534,9 +534,16 @@ function evaluateVariantMatch(variantId, match, vec, onLogMessage) {
   }
   return result;
 }
+function evaluateMatch(crit, vec, quirks, onLogMessage) {
+  if ("t" in crit && crit.t === "q") {
+    return evaluateQuirkMatch(crit, quirks, onLogMessage);
+  } else {
+    return evaluateDimensionMatch(crit, vec, onLogMessage);
+  }
+}
 function evaluateDimensionMatch(crit, vec, onLogMessage) {
   var _a, _b;
-  const { op, l: lhs } = crit;
+  const { l: lhs, op } = crit;
   const lhsScore = (_a = vec[lhs]) != null ? _a : 0;
   if (op === "^") {
     const [cat] = lhs.split(ENR_SEPARATOR);
@@ -603,33 +610,65 @@ function evaluateDimensionMatch(crit, vec, onLogMessage) {
   }
   if (op === ">") {
     const result = lhsScore > rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else if (op === ">=") {
     const result = lhsScore >= rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else if (op === "<") {
     const result = lhsScore < rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else if (op === "<=") {
     const result = lhsScore <= rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else if (op === "=") {
     const result = lhsScore === rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else if (op === "!=") {
     const result = lhsScore !== rhsScore;
-    explain(onLogMessage, result, crit, lhsScore, rhsScore);
+    explainScore(onLogMessage, result, crit, lhsScore, rhsScore);
     return result;
   } else {
-    throw new Error(`Unknown op: ${op}`);
+    onLogMessage == null ? void 0 : onLogMessage([
+      "error",
+      302,
+      {
+        matched: false,
+        description: `${crit.l} ${crit.op} ${crit.rDim ? `${crit.rDim}` : crit.r}: Unknown op ${crit.op}.`
+      }
+    ]);
+    return false;
+  }
+}
+function evaluateQuirkMatch(crit, quirks, onLogMessage) {
+  var _a;
+  const { l: targetQuirk, op, r: targetValue } = crit;
+  const targetQuirkValue = (_a = quirks[targetQuirk]) != null ? _a : "";
+  if (op === "=") {
+    const result = targetQuirkValue === targetValue;
+    explainQuirk(onLogMessage, result, crit, targetQuirkValue);
+    return result;
+  } else if (op === "!=") {
+    const result = targetQuirkValue !== targetValue;
+    explainQuirk(onLogMessage, result, crit, targetQuirkValue);
+    return result;
+  } else {
+    onLogMessage == null ? void 0 : onLogMessage([
+      "error",
+      302,
+      {
+        matched: false,
+        description: `Quirk ${crit.l} ${crit.op} ${crit.r}: Unknown quirk op ${crit.op}.`
+      }
+    ]);
+    return false;
   }
 }
-function explain(onLogMessage, result, crit, lhsScore, rhsScore) {
+function explainScore(onLogMessage, result, crit, lhsScore, rhsScore) {
   onLogMessage == null ? void 0 : onLogMessage([
     "info",
     302,
@@ -639,9 +678,20 @@ function explain(onLogMessage, result, crit, lhsScore, rhsScore) {
     }
   ]);
 }
+function explainQuirk(onLogMessage, result, crit, lhs) {
+  onLogMessage == null ? void 0 : onLogMessage([
+    "info",
+    302,
+    {
+      matched: result,
+      description: `Quirk ${crit.l}[${lhs}] ${crit.op} ${crit.r}`
+    }
+  ]);
+}
 
-// src/placement/personalize.ts
-function personalizeVariations({
+// src/placement/topDownCriteriaPersonalizationSelectionAlgorithm.ts
+var TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM = "default";
+function topDownCriteriaPersonalizationSelectionAlgorithm({
   name,
   context,
   variations,
@@ -651,27 +701,34 @@ function personalizeVariations({
   var _a, _b, _c;
   onLogMessage == null ? void 0 : onLogMessage(["info", 300, "GROUP", { name, take }]);
   try {
-    const variantMatches = [];
-    const defaultVariants = [];
-    const needsConsent = context.requireConsentForPersonalization;
-    const canEvaluate = !needsConsent || context.storage.data.consent;
-    for (const variant of variations) {
-      if ((_a = variant.pz) == null ? void 0 : _a.crit.length) {
-        if (canEvaluate && variantMatches.length !== take && evaluateVariantMatch(variant.id, variant.pz, context.scores, onLogMessage)) {
-          variantMatches.push(variant);
+    const variationMatches = [];
+    const defaultVariations = [];
+    const needsConsentToPersonalize = context.requireConsentForPersonalization;
+    const personalizationAllowed = !needsConsentToPersonalize || context.storage.data.consent;
+    for (const variation of variations) {
+      const isInvalidFormat = variation.pz && (typeof variation.pz !== "object" || variation.pz === null || !("crit" in variation.pz && Array.isArray(variation.pz.crit)));
+      let validVariation;
+      if (isInvalidFormat) {
+        validVariation = { id: variation.id };
+      } else {
+        validVariation = variation;
+      }
+      if ((_a = validVariation.pz) == null ? void 0 : _a.crit.length) {
+        if (personalizationAllowed && variationMatches.length !== take && evaluateVariantMatch(variation.id, validVariation.pz, context.scores, onLogMessage, context.quirks)) {
+          variationMatches.push(validVariation);
         }
       } else {
-        defaultVariants.push(variant);
+        defaultVariations.push(validVariation);
       }
     }
     const result = [];
-    for (let i = 0; i < variantMatches.length; i++) {
+    for (let i = 0; i < variationMatches.length; i++) {
       let isControl = (_b = context.storage.data.controlGroup) != null ? _b : false;
-      const variant = variantMatches[i];
-      if (!isControl && typeof ((_c = variant.pz) == null ? void 0 : _c.control) === "number") {
+      const variation = variationMatches[i];
+      if (!isControl && typeof ((_c = variation.pz) == null ? void 0 : _c.control) === "number") {
         isControl = context.getPersonalizeVariantControl(name, i);
         if (typeof isControl === "undefined") {
-          isControl = rollForControlGroup(variant.pz.control);
+          isControl = rollForControlGroup(variation.pz.control);
           context.storage.updateData([
             {
               type: "setpersonalizecontrol",
@@ -684,13 +741,13 @@ function personalizeVariations({
           ]);
         }
       }
-      let variantToAdd = variant;
+      let variantToAdd = variation;
       if (isControl) {
-        const defaultReplacement = defaultVariants.shift();
+        const defaultReplacement = defaultVariations.shift();
         if (defaultReplacement) {
           variantToAdd = {
             ...defaultReplacement,
-            id: variant.id
+            id: variation.id
           };
         } else {
           variantToAdd = void 0;
@@ -700,8 +757,8 @@ function personalizeVariations({
         result.push({ ...variantToAdd, control: isControl });
       }
     }
-    while (result.length < take && defaultVariants.length) {
-      result.push({ ...defaultVariants.shift(), control: false });
+    while (result.length < take && defaultVariations.length) {
+      result.push({ ...defaultVariations.shift(), control: false });
     }
     const personalized = result.some((v) => {
       var _a2;
@@ -716,7 +773,82 @@ function personalizeVariations({
   }
 }
 
-// src/placement/test.ts
+// src/placement/personalizeVariations.ts
+function personalizeVariations(options) {
+  return topDownCriteriaPersonalizationSelectionAlgorithm(options);
+}
+
+// src/placement/strongestScorePersonalizationSelectionAlgorithm.ts
+var STRONGEST_SCORE_PERSONALIZATION_ALGORITHM = "ssc";
+function strongestScorePersonalizationSelectionAlgorithm({
+  name,
+  context,
+  variations,
+  take = 1,
+  onLogMessage
+}) {
+  var _a, _b;
+  onLogMessage == null ? void 0 : onLogMessage(["info", 300, "GROUP", { name, take }]);
+  try {
+    const variationMatches = [];
+    const defaultVariations = [];
+    const needsConsentToPersonalize = context.requireConsentForPersonalization;
+    const isInGlobalControlGroup = (_a = context.storage.data.controlGroup) != null ? _a : false;
+    const personalizationAllowed = !needsConsentToPersonalize || context.storage.data.consent;
+    for (const variation of variations) {
+      const isInvalidFormat = variation.pz && (typeof variation.pz !== "object" || variation.pz === null);
+      let validVariation;
+      if (isInvalidFormat) {
+        validVariation = { id: variation.id };
+      } else {
+        validVariation = variation;
+      }
+      if ((_b = validVariation.pz) == null ? void 0 : _b.dim) {
+        if (!personalizationAllowed) {
+          continue;
+        }
+        const score = context.scores[validVariation.pz.dim];
+        if (score === void 0 || score <= 0) {
+          continue;
+        }
+        variationMatches.push({ variation: validVariation, score });
+      } else {
+        defaultVariations.push(validVariation);
+      }
+    }
+    variationMatches.sort((a, b) => b.score - a.score);
+    const result = [];
+    for (let i = 0; i < variationMatches.length; i++) {
+      const variationMatch = variationMatches[i];
+      let variantToAdd = variationMatch.variation;
+      if (isInGlobalControlGroup) {
+        const defaultReplacement = defaultVariations.shift();
+        if (defaultReplacement) {
+          variantToAdd = {
+            ...defaultReplacement,
+            id: variationMatch.variation.id
+          };
+        } else {
+          variantToAdd = void 0;
+        }
+      }
+      if (variantToAdd) {
+        result.push({ ...variantToAdd, control: isInGlobalControlGroup });
+      }
+    }
+    while (result.length < take && defaultVariations.length) {
+      result.push({ ...defaultVariations.shift(), control: false });
+    }
+    return {
+      personalized: variationMatches.length > 0 && !isInGlobalControlGroup,
+      variations: result
+    };
+  } finally {
+    onLogMessage == null ? void 0 : onLogMessage(["info", 300, "ENDGROUP"]);
+  }
+}
+
+// src/placement/normalizeVariationDistributions.ts
 var normalizeVariationDistributions = (variations) => {
   const { values, total, missingDistribution } = variations.reduce(
     (previous, current) => {
@@ -735,7 +867,12 @@ var normalizeVariationDistributions = (variations) => {
     }
   );
   if (total > 100) {
-    throw new Error(`Total distribution ${total} is over the maximum 100.`);
+    const autoScaleFactor = 100 / total;
+    values.forEach((value, index) => {
+      if (typeof value === "number") {
+        values[index] = value * autoScaleFactor;
+      }
+    });
   } else if (total < 100) {
     const remainder = 100 - total;
     const missingSlice = remainder / missingDistribution;
@@ -747,6 +884,8 @@ var normalizeVariationDistributions = (variations) => {
   }
   return values;
 };
+
+// src/placement/testVariations.ts
 var testVariations = ({
   name,
   context,
@@ -1513,11 +1652,12 @@ import { dequal as dequal5 } from "dequal/lite";
 import mitt3 from "mitt";
 var CONTEXTUAL_EDITING_TEST_NAME = "contextual_editing_test";
 var CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID = "contextual_editing_test_selected_variant";
-var _serverTransitionState, _scores, _state, _pzCache, _plugins, _commands, _requireConsentForPersonalization, _mitt3, _Context_instances, emitTest_fn, updateGoals_fn, updateComputedScores_fn, calculateScores_fn;
+var _personalizationSelectionAlgorithms, _serverTransitionState, _scores, _state, _pzCache, _plugins, _commands, _requireConsentForPersonalization, _mitt3, _Context_instances, emitTest_fn, updateGoals_fn, updateComputedScores_fn, calculateScores_fn;
 var Context = class {
   constructor(options) {
     __privateAdd(this, _Context_instances);
     __publicField(this, "manifest");
+    __privateAdd(this, _personalizationSelectionAlgorithms);
     __privateAdd(this, _serverTransitionState);
     __privateAdd(this, _scores, {});
     __privateAdd(this, _state);
@@ -1534,7 +1674,7 @@ var Context = class {
       off: __privateGet(this, _mitt3).off
     });
     __publicField(this, "storage");
-    var _a, _b;
+    var _a, _b, _c;
     const { manifest, ...storageOptions } = options;
     __privateSet(this, _state, {});
     __privateSet(this, _plugins, options.plugins);
@@ -1542,7 +1682,20 @@ var Context = class {
     if (typeof options.transitionStore !== "undefined") {
       __privateSet(this, _commands, []);
     }
+    __privateSet(this, _personalizationSelectionAlgorithms, {
+      [TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM]: topDownCriteriaPersonalizationSelectionAlgorithm,
+      [STRONGEST_SCORE_PERSONALIZATION_ALGORITHM]: strongestScorePersonalizationSelectionAlgorithm
+    });
     (_a = __privateGet(this, _plugins)) == null ? void 0 : _a.forEach((plugin) => {
+      if (!plugin.personalizationSelectionAlgorithms) {
+        return;
+      }
+      __privateSet(this, _personalizationSelectionAlgorithms, {
+        ...__privateGet(this, _personalizationSelectionAlgorithms),
+        ...plugin.personalizationSelectionAlgorithms
+      });
+    });
+    (_b = __privateGet(this, _plugins)) == null ? void 0 : _b.forEach((plugin) => {
       if (!plugin.logDrain) {
         return;
       }
@@ -1593,7 +1746,7 @@ var Context = class {
         __privateGet(this, _mitt3).emit("quirksUpdated", quirks.quirks);
         __privateGet(this, _mitt3).emit("log", ["info", 4, quirks.quirks]);
       });
-      (_b = __privateGet(this, _plugins)) == null ? void 0 : _b.forEach((plugin) => {
+      (_c = __privateGet(this, _plugins)) == null ? void 0 : _c.forEach((plugin) => {
         if (!plugin.init) {
           return;
         }
@@ -1843,7 +1996,17 @@ var Context = class {
   }
   /** Executes a personalized placement with a given set of variants */
   personalize(options) {
-    const value = personalizeVariations({
+    var _a;
+    const algorithmName = (_a = options.algorithm) != null ? _a : TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM;
+    const algorithm = __privateGet(this, _personalizationSelectionAlgorithms)[algorithmName];
+    if (!algorithm) {
+      __privateGet(this, _mitt3).emit("log", ["warn", 304, { algorithm: algorithmName }]);
+      return {
+        personalized: false,
+        variations: []
+      };
+    }
+    const value = algorithm({
       ...options,
       context: this,
       onLogMessage: (message) => __privateGet(this, _mitt3).emit("log", message)
@@ -1917,6 +2080,7 @@ var Context = class {
     __privateGet(this, _mitt3).emit("personalizationResult", event);
   }
 };
+_personalizationSelectionAlgorithms = new WeakMap();
 _serverTransitionState = new WeakMap();
 _scores = new WeakMap();
 _state = new WeakMap();
@@ -2512,6 +2676,10 @@ var messageContent = {
   301: ({ id, op }) => ["personalization", `testing variation ${id} (${op === "|" ? "OR" : "AND"})`],
   302: ({ matched, description }) => ["personalization", `${description} is ${matched}`],
   303: (selected) => ["personalization", selected ? "selected variation" : "did not select variation"],
+  304: ({ algorithm }) => [
+    "personalization",
+    `personalization selection algorithm '${algorithm}' not found. Hiding placement.`
+  ],
   // TESTING
   400: (name) => ["testing", `executing A/B test '${name}'`],
   401: (testName) => ["testing", `${testName} is not registered in the manifest; it will not be run.`],
@@ -2616,7 +2784,9 @@ export {
   PAIR_SEP,
   QUIRK_SEP,
   SERVER_STATE_ID,
+  STRONGEST_SCORE_PERSONALIZATION_ALGORITHM,
   ScriptType,
+  TOP_DOWN_CRITERIA_PERSONALIZATION_ALGORITHM,
   TYPE_SEP,
   TransitionDataStore,
   UNIFORM_DEFAULT_COOKIE_NAME,
@@ -2658,5 +2828,7 @@ export {
   serializePersonalizeVariants,
   serializeQuickConnect,
   serializeQuirks,
-  testVariations
+  strongestScorePersonalizationSelectionAlgorithm,
+  testVariations,
+  topDownCriteriaPersonalizationSelectionAlgorithm
 };