@uniformdev/context 20.35.0 → 20.35.1-alpha.188

package/dist/index.mjs

@@ -227,6 +227,10 @@ var ManifestInstance = class {
     }
     return (_d = (_c = __privateGet(this, _mf).pz) == null ? void 0 : _c.enr) == null ? void 0 : _d[scoreKey.substring(0, enrichmentIndex)];
   }
+  getAggregateDimensionByKey(scoreKey) {
+    var _a, _b;
+    return (_b = (_a = __privateGet(this, _mf).pz) == null ? void 0 : _a.agg) == null ? void 0 : _b[scoreKey];
+  }
 };
 _mf = new WeakMap();
 _signalInstances = new WeakMap();
@@ -941,6 +945,9 @@ var testVariations = ({
     }
     if (selectedVariant) {
       onLogMessage == null ? void 0 : onLogMessage(["info", 404, selectedVariant.id]);
+      if (selectedVariant.control === void 0) {
+        selectedVariant.control = variations.findIndex((variation) => variation.id === selectedVariantId) === 0;
+      }
     }
     return {
       result: selectedVariant,
@@ -1737,6 +1744,9 @@ var Context = class {
             __privateSet(this, _scores, state.ssv);
             __privateGet(this, _mitt3).emit("log", ["debug", 130, state]);
           }
+          if (state.compositionMetadata) {
+            __privateGet(this, _state).compositionMetadata = state.compositionMetadata;
+          }
         },
         onLogMessage: (message) => __privateGet(this, _mitt3).emit("log", message)
       });
@@ -1889,10 +1899,16 @@ var Context = class {
           scores: __privateGet(this, _serverTransitionState) ? __privateMethod(this, _Context_instances, calculateScores_fn).call(this, this.storage.data) : __privateGet(this, _scores)
         })
       );
+      const previousCompositionMetadata = __privateGet(this, _state).compositionMetadata;
       __privateSet(this, _state, {
         ...__privateGet(this, _state),
         ...newData
       });
+      if (newData.compositionMetadata && // deep equal is not too bad, as we only have 1 level of depth in dynamic inputs
+      !dequal5(previousCompositionMetadata, __privateGet(this, _state).compositionMetadata)) {
+        __privateGet(this, _mitt3).emit("canvasDataUpdated", __privateGet(this, _state).compositionMetadata);
+        __privateGet(this, _state).compositionMetadata = newData.compositionMetadata;
+      }
       await this.storage.updateData(commands);
       if (__privateGet(this, _serverTransitionState)) {
         await this.processServerCommands({
@@ -1904,7 +1920,9 @@ var Context = class {
           __privateMethod(this, _Context_instances, emitTest_fn).call(this, {
             name: testName,
             variantId: testVariantId,
-            variantAssigned: true
+            variantAssigned: true,
+            control: false,
+            compositionMetadata: void 0
           });
         });
         const haveQuirksChanged = __privateGet(this, _serverTransitionState) && !dequal5(__privateGet(this, _serverTransitionState).quirks, this.storage.data.quirks);
@@ -1920,7 +1938,7 @@ var Context = class {
           if (!plugin.update) {
             continue;
           }
-          await plugin.update(newData);
+          await plugin.update(newData, __privateGet(this, _scores));
         }
       }
       (_e = __privateGet(this, _commands)) == null ? void 0 : _e.push(...commands);
@@ -1986,7 +2004,7 @@ var Context = class {
   }
   /** Executes an A/B test with a given set of variants, showing the visitor's assigned variant (or selecting one to assign, if none is set yet) */
   test(options) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     if (options.name === CONTEXTUAL_EDITING_TEST_NAME) {
       const selectedVariant = (_a = options.variations.find((variant) => variant.id === CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID)) != null ? _a : options.variations.at(-1);
       const value2 = {
@@ -2003,7 +2021,9 @@ var Context = class {
     __privateMethod(this, _Context_instances, emitTest_fn).call(this, {
       name: options.name,
       variantId: (_c = (_b = value.result) == null ? void 0 : _b.id) != null ? _c : void 0,
-      variantAssigned: value.variantAssigned
+      variantAssigned: value.variantAssigned,
+      control: (_e = (_d = value.result) == null ? void 0 : _d.control) != null ? _e : false,
+      compositionMetadata: options.compositionMetadata
     });
     return value;
   }
@@ -2032,7 +2052,8 @@ var Context = class {
         control: variation.control
       })),
       control: this.storage.data.controlGroup,
-      changed: true
+      changed: true,
+      compositionMetadata: options.compositionMetadata
     };
     if (previousPlacement && dequal5(eventData.variantIds, previousPlacement)) {
       eventData.changed = false;
@@ -2046,7 +2067,10 @@ var Context = class {
    * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
    */
   async forget(fromAllDevices) {
-    __privateSet(this, _state, {});
+    const previousCompositionMetadata = __privateGet(this, _state).compositionMetadata;
+    __privateSet(this, _state, {
+      compositionMetadata: previousCompositionMetadata
+    });
     if (__privateGet(this, _plugins)) {
       for (let i = 0; i < __privateGet(this, _plugins).length; i++) {
         const plugin = __privateGet(this, _plugins)[i];
@@ -2069,7 +2093,8 @@ var Context = class {
       ssv: __privateGet(this, _scores),
       tests: {},
       personalizeVariants: this.storage.data.personalizeVariants,
-      commands: __privateGet(this, _commands)
+      commands: __privateGet(this, _commands),
+      compositionMetadata: __privateGet(this, _state).compositionMetadata
     };
     const allTests = this.storage.data.tests;
     Object.entries(allTests).map(([testName, testValue]) => {
@@ -2092,6 +2117,27 @@ var Context = class {
     __privateGet(this, _pzCache)[event.name] = event.variantIds;
     __privateGet(this, _mitt3).emit("personalizationResult", event);
   }
+  /**
+   * Gets the current canvas data
+   */
+  getCompositionMetadata() {
+    return __privateGet(this, _state).compositionMetadata;
+  }
+  /**
+   * Updates the canvas data and emits a canvasDataUpdated event
+   */
+  async updateCompositionMetadata(newData) {
+    const currentCanvas = __privateGet(this, _state).compositionMetadata || {};
+    const updatedCanvas = { ...currentCanvas, ...newData };
+    if (!dequal5(currentCanvas, updatedCanvas)) {
+      __privateSet(this, _state, {
+        ...__privateGet(this, _state),
+        compositionMetadata: updatedCanvas
+      });
+      __privateGet(this, _mitt3).emit("canvasDataUpdated", updatedCanvas);
+      __privateGet(this, _mitt3).emit("log", ["info", 4, "Canvas data updated"]);
+    }
+  }
 };
 _personalizationSelectionAlgorithms = new WeakMap();
 _serverTransitionState = new WeakMap();
@@ -2256,7 +2302,31 @@ var ScriptType = /* @__PURE__ */ ((ScriptType2) => {
 })(ScriptType || {});
 var EdgeNodeTagName = "nesitag";
 
-// src/insights/index.ts
+// src/insights/storage.ts
+var createInsightsStorage = () => {
+  const STORAGE_KEY2 = "ufin";
+  return {
+    get: () => {
+      const data = localStorage.getItem(STORAGE_KEY2);
+      if (!data) {
+        return;
+      }
+      return JSON.parse(data);
+    },
+    set: (data) => {
+      const toSet = {
+        ...data,
+        updated: Date.now()
+      };
+      localStorage.setItem(STORAGE_KEY2, JSON.stringify(toSet));
+    },
+    clear: () => {
+      localStorage.removeItem(STORAGE_KEY2);
+    }
+  };
+};
+
+// src/insights/types.ts
 var getBasePayload = () => {
   const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
   const locale = navigator.languages && navigator.languages.length ? navigator.languages[0] : navigator.userLanguage || navigator.language || navigator.browserLanguage || "en";
@@ -2269,13 +2339,34 @@ var getBasePayload = () => {
     href: window.location.href
   };
 };
+var generateVisitorId = () => {
+  return `visitor_${generalRandomId()}`;
+};
+var generateSessionId = () => {
+  return `session_${generalRandomId()}`;
+};
+var generatePageId = () => {
+  return `page_${generalRandomId()}`;
+};
+var generalRandomId = () => {
+  if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
+    const id = crypto.randomUUID();
+    return id.replaceAll("-", "").toLowerCase();
+  }
+  return Math.random().toString(32).substring(2);
+};
+
+// src/insights/v1.ts
 var createInsightsClient = ({ endpoint }) => {
   let endpointUrl;
   const apiKey = endpoint.apiKey;
   const projectId = endpoint.projectId;
   if (endpoint.type === "api") {
     const url = new URL(endpoint.host);
-    url.pathname = "/v0/events";
+    url.pathname = `/v0/events`;
+    if (endpoint.host.includes("tinybird.co")) {
+      url.pathname = "/v0/events";
+    }
     url.searchParams.set("name", "analytics_events");
     endpointUrl = url.toString();
   } else {
@@ -2405,38 +2496,7 @@ var createInsightsClient = ({ endpoint }) => {
     }
   };
 };
-var createInsightsStorage = () => {
-  const STORAGE_KEY2 = "ufin";
-  return {
-    get: () => {
-      const data = localStorage.getItem(STORAGE_KEY2);
-      if (!data) {
-        return;
-      }
-      return JSON.parse(data);
-    },
-    set: (data) => {
-      const toSet = {
-        ...data,
-        updated: Date.now()
-      };
-      localStorage.setItem(STORAGE_KEY2, JSON.stringify(toSet));
-    },
-    clear: () => {
-      localStorage.removeItem(STORAGE_KEY2);
-    }
-  };
-};
-var generateVisitorId = () => {
-  return `visitor_${generalRandomId()}`;
-};
-var generateSessionId = () => {
-  return `session_${generalRandomId()}`;
-};
-var generatePageId = () => {
-  return `page_${generalRandomId()}`;
-};
-var createInsights = ({
+var createInsightsV1 = ({
   endpoint,
   sessionDurationSeconds = 30 * 60
 }) => {
@@ -2537,8 +2597,10 @@ var createInsights = ({
     }
   };
 };
+
+// src/insights/index.ts
 var enableUniformInsights = (options) => {
-  const insights = createInsights({
+  const insights = createInsightsV1({
     endpoint: options.endpoint
   });
   let previousUrl = void 0;
@@ -2584,8 +2646,8 @@ var enableUniformInsights = (options) => {
       };
     },
     update: (context) => {
-      if (context.url && context.url !== previousUrl) {
-        previousUrl = context.url;
+      if (context.url && context.url.toString() !== previousUrl) {
+        previousUrl = context.url.toString();
         insights.pageHit();
       }
     },
@@ -2594,13 +2656,6 @@ var enableUniformInsights = (options) => {
     }
   };
 };
-var generalRandomId = () => {
-  if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
-    const id = crypto.randomUUID();
-    return id.replaceAll("-", "").toLowerCase();
-  }
-  return Math.random().toString(32).substring(2);
-};
 
 // src/logging/enableConsoleLogDrain.ts
 import rfdc2 from "rfdc";

package/dist/{types-CzIkFCDD.d.mts → types-CKTfVAJs.d.mts}

@@ -76,6 +76,17 @@ type VisitorData = {
     personalizeVariants?: PersonalizeVariants;
 };
 declare const emptyVisitorData: () => VisitorData;
+/**
+ * Canvas-specific data that should be managed separately from regular context updates
+ */
+type CompositionMetadata = {
+    /** The composition ID always required, otherwise whole metadata should not be set */
+    compositionId: string;
+    /** The matched route from router endpoint. Same as matched project map node pathname */
+    matchedRoute?: string;
+    /** Dynamic inputs for the route */
+    dynamicInputs?: Record<string, string>;
+};
 /**
  * Expresses a 'patch' to the Uniform Context state
  */
@@ -85,6 +96,11 @@ type ContextState = {
     quirks: Quirks;
     enrichments: EnrichmentData[];
     events: EventData[];
+    /**
+     * Metadata about the composition that is being rendered right now.
+     * if you have multiple compositions on the page, please set this one manually.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 type ContextStateUpdate = {
     /** The new effective state of the visitor after this state update is applied */
@@ -374,6 +390,7 @@ declare class ManifestInstance {
      */
     computeAggregateDimensions(primitiveScores: ScoreVector): ScoreVector;
     getDimensionByKey(scoreKey: string): EnrichmentCategory | Signal | undefined;
+    getAggregateDimensionByKey(scoreKey: string): AggregateDimension | undefined;
 }
 
 interface paths {
@@ -1030,6 +1047,10 @@ type TestVariant = {
      * If not provided, this variant will be selected in equal proportion to other variants without an explicit distribution.
      */
     testDistribution?: number;
+    /** Whether this variant is a control variant.
+     * Can be undefined for backward compatibility with older versions of the SDK which were not explicitly setting the control flag.
+     */
+    control?: boolean;
 };
 /** The result of computing an A/B test result */
 type TestResult<TVariant> = {
@@ -1051,6 +1072,8 @@ interface PersonalizeOptions<TVariant> {
     take?: number;
     /** Name of the personalization selection algorithm to use. Defaults to top-down criteria when not specified. */
     algorithm?: string;
+    /** Composition metadata where the personalization is being rendered for analytics tracking */
+    compositionMetadata?: CompositionMetadata;
 }
 interface PersonalizationSelectionAlgorithmOptions<TCriteria, TVariant extends PersonalizedVariant<TCriteria> = PersonalizedVariant<TCriteria>> {
     /** Name of placement (sent to analytics) */
@@ -1070,6 +1093,8 @@ type TestOptions<TVariant extends TestVariant> = {
     name: string;
     /** Variations that are being tested. */
     variations: TVariant[];
+    /** Composition metadata where the personalization is being rendered for analytics tracking */
+    compositionMetadata?: CompositionMetadata;
 };
 declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, onLogMessage, }: TestOptions<TVariant> & {
     context: Context;
@@ -1092,8 +1117,8 @@ type ContextPlugin = {
     init?: (context: Context) => () => void;
     /** Plugin-specific actions to perform when a user is forgotten */
     forget?: () => Promise<void> | void;
-    /** Plugin-specific actions to perform when the visitor context is updated */
-    update?: (newData: Partial<ContextState>) => Promise<void> | void;
+    /** Plugin-specific actions to perform when the visitor context is updated, second parameter is the recalculated scores after the update */
+    update?: (newData: Partial<ContextState>, recalculatedScores: ScoreVector) => Promise<void> | void;
     /**
      * Allows the plugin to register named personalization selection algorithms
      *
@@ -1140,6 +1165,12 @@ type PersonalizationEvent = {
      * False: the variant(s) selected were the same as a previous evaluation of this placement.
      */
     changed: boolean;
+    /**
+     * Contains information about the composition that contains personalization wrapper component,
+     * which triggered the personalization event.
+     * Only references top level root composition after pattern resolutions.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 /** Emitted event when an A/B test runs */
 type TestEvent = {
@@ -1147,12 +1178,22 @@ type TestEvent = {
     name: string;
     /** ID of the variant that was selected */
     variantId: string | undefined;
+    /**
+     * Whether the variant is part of the control group.
+     */
+    control: boolean;
     /**
      * Whether the test variant was newly assigned to the visitor.
      * True: variant was assigned to the visitor for the first time.
      * False: variant was already assigned to the visitor and is being reused.
      */
     variantAssigned: boolean;
+    /**
+     * Contains information about the composition that contains A/B test wrapper component,
+     * which triggered the A/B test event.
+     * Only references top level root composition after pattern resolutions.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 type ContextEvents = {
     /**
@@ -1176,6 +1217,8 @@ type ContextEvents = {
     testResult: TestEvent;
     /** Personalization variants have been selected */
     personalizationResult: PersonalizationEvent;
+    /** Composition metadata has been set/updated, usually happens when new composition is being rendered during client-side navigation for example */
+    canvasDataUpdated: CompositionMetadata;
 };
 interface ContextInstance {
     get scores(): Readonly<ScoreVector>;
@@ -1197,6 +1240,14 @@ interface ContextInstance {
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
 }
 declare class Context implements ContextInstance {
     #private;
@@ -1266,6 +1317,14 @@ declare class Context implements ContextInstance {
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
 }
 
 /**
@@ -1337,4 +1396,4 @@ declare global {
     }
 }
 
-export { type ManifestV2 as $, type AggregateDimension as A, type DevToolsLogEvent as B, type ContextPlugin as C, type DecayFunction as D, type DevToolsDataEvent as E, type DevToolsHelloEvent as F, type DevToolsUpdateEvent as G, type DevToolsRawCommandsEvent as H, type DevToolsForgetEvent as I, type LogMessages as J, type Severity as K, type LogDrain as L, type MessageCategory as M, type MessageFunc as N, type OutputSeverity as O, type PersonalizedVariant as P, type Quirks as Q, type LogMessageSingle as R, type ScoreVector as S, TransitionDataStore as T, type LogMessageGroup as U, type VisitorData as V, ManifestInstance as W, GroupCriteriaEvaluator as X, type CriteriaEvaluatorResult as Y, type CriteriaEvaluatorParameters as Z, type SignalData as _, type StorageCommands as a, type PersonalizationManifest as a0, type Signal as a1, type SignalCriteriaGroup as a2, type SignalCriteria as a3, type EnrichmentCategory as a4, type NumberMatch as a5, type TestDefinition as a6, type AggregateDimensionInput as a7, type TestOptions as a8, testVariations as a9, type EnrichmentData as aA, type PersonalizeControlVariant as aB, type PersonalizeVariants as aC, type EventData as aD, emptyVisitorData as aE, type ContextState as aF, type ContextStateUpdate as aG, type GoalStateUpdate as aH, type paths as aI, type VariationMatchMetadata as aa, type DimensionMatch as ab, type QuirkMatch as ac, type BehaviorTag as ad, type TestVariant as ae, type TestResult as af, type StorageCommand as ag, type SetGoalCommand as ah, type ModifyScoreCommand as ai, type ModifySessionScoreCommand as aj, type SetConsentCommand as ak, type SetQuirkCommand as al, type SetTestCommand as am, type IdentifyCommand as an, type SetControlGroupCommand as ao, type SetPersonalizeVariantControlCommand as ap, areCommandsEqual as aq, type ServerToClientTransitionState as ar, SERVER_STATE_ID as as, type TransitionDataStoreEvents as at, type DecayOptions as au, type VisitorDataStoreOptions as av, type VisitorDataStoreEvents as aw, VisitorDataStore as ax, type Tests as ay, type Goals as az, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type PersonalizeOptions as g, Context as h, type PersonalizedResult as i, type VariationMatchDimensionCriteria as j, type PersonalizationSelectionAlgorithmOptions as k, type DevToolsEvents as l, CONTEXTUAL_EDITING_TEST_NAME as m, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as n, type PersonalizationSelectionAlgorithm as o, type PersonalizationSelectionAlgorithms as p, type ContextOptions as q, type PersonalizationEventVariantId as r, type PersonalizationEvent as s, type TestEvent as t, type ContextEvents as u, type ContextInstance as v, type DevToolsUiVersion as w, type DevToolsState as x, type DevToolsActions as y, type DevToolsEvent as z };
+export { type ManifestV2 as $, type AggregateDimension as A, type DevToolsLogEvent as B, type ContextPlugin as C, type DecayFunction as D, type DevToolsDataEvent as E, type DevToolsHelloEvent as F, type DevToolsUpdateEvent as G, type DevToolsRawCommandsEvent as H, type DevToolsForgetEvent as I, type LogMessages as J, type Severity as K, type LogDrain as L, type MessageCategory as M, type MessageFunc as N, type OutputSeverity as O, type PersonalizedVariant as P, type Quirks as Q, type LogMessageSingle as R, type ScoreVector as S, TransitionDataStore as T, type LogMessageGroup as U, type VisitorData as V, ManifestInstance as W, GroupCriteriaEvaluator as X, type CriteriaEvaluatorResult as Y, type CriteriaEvaluatorParameters as Z, type SignalData as _, type StorageCommands as a, type PersonalizationManifest as a0, type Signal as a1, type SignalCriteriaGroup as a2, type SignalCriteria as a3, type EnrichmentCategory as a4, type NumberMatch as a5, type TestDefinition as a6, type AggregateDimensionInput as a7, type TestOptions as a8, testVariations as a9, type EnrichmentData as aA, type PersonalizeControlVariant as aB, type PersonalizeVariants as aC, type EventData as aD, emptyVisitorData as aE, type CompositionMetadata as aF, type ContextState as aG, type ContextStateUpdate as aH, type GoalStateUpdate as aI, type paths as aJ, type VariationMatchMetadata as aa, type DimensionMatch as ab, type QuirkMatch as ac, type BehaviorTag as ad, type TestVariant as ae, type TestResult as af, type StorageCommand as ag, type SetGoalCommand as ah, type ModifyScoreCommand as ai, type ModifySessionScoreCommand as aj, type SetConsentCommand as ak, type SetQuirkCommand as al, type SetTestCommand as am, type IdentifyCommand as an, type SetControlGroupCommand as ao, type SetPersonalizeVariantControlCommand as ap, areCommandsEqual as aq, type ServerToClientTransitionState as ar, SERVER_STATE_ID as as, type TransitionDataStoreEvents as at, type DecayOptions as au, type VisitorDataStoreOptions as av, type VisitorDataStoreEvents as aw, VisitorDataStore as ax, type Tests as ay, type Goals as az, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type PersonalizeOptions as g, Context as h, type PersonalizedResult as i, type VariationMatchDimensionCriteria as j, type PersonalizationSelectionAlgorithmOptions as k, type DevToolsEvents as l, CONTEXTUAL_EDITING_TEST_NAME as m, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as n, type PersonalizationSelectionAlgorithm as o, type PersonalizationSelectionAlgorithms as p, type ContextOptions as q, type PersonalizationEventVariantId as r, type PersonalizationEvent as s, type TestEvent as t, type ContextEvents as u, type ContextInstance as v, type DevToolsUiVersion as w, type DevToolsState as x, type DevToolsActions as y, type DevToolsEvent as z };

package/dist/{types-CzIkFCDD.d.ts → types-CKTfVAJs.d.ts}

@@ -76,6 +76,17 @@ type VisitorData = {
     personalizeVariants?: PersonalizeVariants;
 };
 declare const emptyVisitorData: () => VisitorData;
+/**
+ * Canvas-specific data that should be managed separately from regular context updates
+ */
+type CompositionMetadata = {
+    /** The composition ID always required, otherwise whole metadata should not be set */
+    compositionId: string;
+    /** The matched route from router endpoint. Same as matched project map node pathname */
+    matchedRoute?: string;
+    /** Dynamic inputs for the route */
+    dynamicInputs?: Record<string, string>;
+};
 /**
  * Expresses a 'patch' to the Uniform Context state
  */
@@ -85,6 +96,11 @@ type ContextState = {
     quirks: Quirks;
     enrichments: EnrichmentData[];
     events: EventData[];
+    /**
+     * Metadata about the composition that is being rendered right now.
+     * if you have multiple compositions on the page, please set this one manually.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 type ContextStateUpdate = {
     /** The new effective state of the visitor after this state update is applied */
@@ -374,6 +390,7 @@ declare class ManifestInstance {
      */
     computeAggregateDimensions(primitiveScores: ScoreVector): ScoreVector;
     getDimensionByKey(scoreKey: string): EnrichmentCategory | Signal | undefined;
+    getAggregateDimensionByKey(scoreKey: string): AggregateDimension | undefined;
 }
 
 interface paths {
@@ -1030,6 +1047,10 @@ type TestVariant = {
      * If not provided, this variant will be selected in equal proportion to other variants without an explicit distribution.
      */
     testDistribution?: number;
+    /** Whether this variant is a control variant.
+     * Can be undefined for backward compatibility with older versions of the SDK which were not explicitly setting the control flag.
+     */
+    control?: boolean;
 };
 /** The result of computing an A/B test result */
 type TestResult<TVariant> = {
@@ -1051,6 +1072,8 @@ interface PersonalizeOptions<TVariant> {
     take?: number;
     /** Name of the personalization selection algorithm to use. Defaults to top-down criteria when not specified. */
     algorithm?: string;
+    /** Composition metadata where the personalization is being rendered for analytics tracking */
+    compositionMetadata?: CompositionMetadata;
 }
 interface PersonalizationSelectionAlgorithmOptions<TCriteria, TVariant extends PersonalizedVariant<TCriteria> = PersonalizedVariant<TCriteria>> {
     /** Name of placement (sent to analytics) */
@@ -1070,6 +1093,8 @@ type TestOptions<TVariant extends TestVariant> = {
     name: string;
     /** Variations that are being tested. */
     variations: TVariant[];
+    /** Composition metadata where the personalization is being rendered for analytics tracking */
+    compositionMetadata?: CompositionMetadata;
 };
 declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, onLogMessage, }: TestOptions<TVariant> & {
     context: Context;
@@ -1092,8 +1117,8 @@ type ContextPlugin = {
     init?: (context: Context) => () => void;
     /** Plugin-specific actions to perform when a user is forgotten */
     forget?: () => Promise<void> | void;
-    /** Plugin-specific actions to perform when the visitor context is updated */
-    update?: (newData: Partial<ContextState>) => Promise<void> | void;
+    /** Plugin-specific actions to perform when the visitor context is updated, second parameter is the recalculated scores after the update */
+    update?: (newData: Partial<ContextState>, recalculatedScores: ScoreVector) => Promise<void> | void;
     /**
      * Allows the plugin to register named personalization selection algorithms
      *
@@ -1140,6 +1165,12 @@ type PersonalizationEvent = {
      * False: the variant(s) selected were the same as a previous evaluation of this placement.
      */
     changed: boolean;
+    /**
+     * Contains information about the composition that contains personalization wrapper component,
+     * which triggered the personalization event.
+     * Only references top level root composition after pattern resolutions.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 /** Emitted event when an A/B test runs */
 type TestEvent = {
@@ -1147,12 +1178,22 @@ type TestEvent = {
     name: string;
     /** ID of the variant that was selected */
     variantId: string | undefined;
+    /**
+     * Whether the variant is part of the control group.
+     */
+    control: boolean;
     /**
      * Whether the test variant was newly assigned to the visitor.
      * True: variant was assigned to the visitor for the first time.
      * False: variant was already assigned to the visitor and is being reused.
      */
     variantAssigned: boolean;
+    /**
+     * Contains information about the composition that contains A/B test wrapper component,
+     * which triggered the A/B test event.
+     * Only references top level root composition after pattern resolutions.
+     */
+    compositionMetadata?: CompositionMetadata;
 };
 type ContextEvents = {
     /**
@@ -1176,6 +1217,8 @@ type ContextEvents = {
     testResult: TestEvent;
     /** Personalization variants have been selected */
     personalizationResult: PersonalizationEvent;
+    /** Composition metadata has been set/updated, usually happens when new composition is being rendered during client-side navigation for example */
+    canvasDataUpdated: CompositionMetadata;
 };
 interface ContextInstance {
     get scores(): Readonly<ScoreVector>;
@@ -1197,6 +1240,14 @@ interface ContextInstance {
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
 }
 declare class Context implements ContextInstance {
     #private;
@@ -1266,6 +1317,14 @@ declare class Context implements ContextInstance {
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
 }
 
 /**
@@ -1337,4 +1396,4 @@ declare global {
     }
 }
 
-export { type ManifestV2 as $, type AggregateDimension as A, type DevToolsLogEvent as B, type ContextPlugin as C, type DecayFunction as D, type DevToolsDataEvent as E, type DevToolsHelloEvent as F, type DevToolsUpdateEvent as G, type DevToolsRawCommandsEvent as H, type DevToolsForgetEvent as I, type LogMessages as J, type Severity as K, type LogDrain as L, type MessageCategory as M, type MessageFunc as N, type OutputSeverity as O, type PersonalizedVariant as P, type Quirks as Q, type LogMessageSingle as R, type ScoreVector as S, TransitionDataStore as T, type LogMessageGroup as U, type VisitorData as V, ManifestInstance as W, GroupCriteriaEvaluator as X, type CriteriaEvaluatorResult as Y, type CriteriaEvaluatorParameters as Z, type SignalData as _, type StorageCommands as a, type PersonalizationManifest as a0, type Signal as a1, type SignalCriteriaGroup as a2, type SignalCriteria as a3, type EnrichmentCategory as a4, type NumberMatch as a5, type TestDefinition as a6, type AggregateDimensionInput as a7, type TestOptions as a8, testVariations as a9, type EnrichmentData as aA, type PersonalizeControlVariant as aB, type PersonalizeVariants as aC, type EventData as aD, emptyVisitorData as aE, type ContextState as aF, type ContextStateUpdate as aG, type GoalStateUpdate as aH, type paths as aI, type VariationMatchMetadata as aa, type DimensionMatch as ab, type QuirkMatch as ac, type BehaviorTag as ad, type TestVariant as ae, type TestResult as af, type StorageCommand as ag, type SetGoalCommand as ah, type ModifyScoreCommand as ai, type ModifySessionScoreCommand as aj, type SetConsentCommand as ak, type SetQuirkCommand as al, type SetTestCommand as am, type IdentifyCommand as an, type SetControlGroupCommand as ao, type SetPersonalizeVariantControlCommand as ap, areCommandsEqual as aq, type ServerToClientTransitionState as ar, SERVER_STATE_ID as as, type TransitionDataStoreEvents as at, type DecayOptions as au, type VisitorDataStoreOptions as av, type VisitorDataStoreEvents as aw, VisitorDataStore as ax, type Tests as ay, type Goals as az, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type PersonalizeOptions as g, Context as h, type PersonalizedResult as i, type VariationMatchDimensionCriteria as j, type PersonalizationSelectionAlgorithmOptions as k, type DevToolsEvents as l, CONTEXTUAL_EDITING_TEST_NAME as m, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as n, type PersonalizationSelectionAlgorithm as o, type PersonalizationSelectionAlgorithms as p, type ContextOptions as q, type PersonalizationEventVariantId as r, type PersonalizationEvent as s, type TestEvent as t, type ContextEvents as u, type ContextInstance as v, type DevToolsUiVersion as w, type DevToolsState as x, type DevToolsActions as y, type DevToolsEvent as z };
+export { type ManifestV2 as $, type AggregateDimension as A, type DevToolsLogEvent as B, type ContextPlugin as C, type DecayFunction as D, type DevToolsDataEvent as E, type DevToolsHelloEvent as F, type DevToolsUpdateEvent as G, type DevToolsRawCommandsEvent as H, type DevToolsForgetEvent as I, type LogMessages as J, type Severity as K, type LogDrain as L, type MessageCategory as M, type MessageFunc as N, type OutputSeverity as O, type PersonalizedVariant as P, type Quirks as Q, type LogMessageSingle as R, type ScoreVector as S, TransitionDataStore as T, type LogMessageGroup as U, type VisitorData as V, ManifestInstance as W, GroupCriteriaEvaluator as X, type CriteriaEvaluatorResult as Y, type CriteriaEvaluatorParameters as Z, type SignalData as _, type StorageCommands as a, type PersonalizationManifest as a0, type Signal as a1, type SignalCriteriaGroup as a2, type SignalCriteria as a3, type EnrichmentCategory as a4, type NumberMatch as a5, type TestDefinition as a6, type AggregateDimensionInput as a7, type TestOptions as a8, testVariations as a9, type EnrichmentData as aA, type PersonalizeControlVariant as aB, type PersonalizeVariants as aC, type EventData as aD, emptyVisitorData as aE, type CompositionMetadata as aF, type ContextState as aG, type ContextStateUpdate as aH, type GoalStateUpdate as aI, type paths as aJ, type VariationMatchMetadata as aa, type DimensionMatch as ab, type QuirkMatch as ac, type BehaviorTag as ad, type TestVariant as ae, type TestResult as af, type StorageCommand as ag, type SetGoalCommand as ah, type ModifyScoreCommand as ai, type ModifySessionScoreCommand as aj, type SetConsentCommand as ak, type SetQuirkCommand as al, type SetTestCommand as am, type IdentifyCommand as an, type SetControlGroupCommand as ao, type SetPersonalizeVariantControlCommand as ap, areCommandsEqual as aq, type ServerToClientTransitionState as ar, SERVER_STATE_ID as as, type TransitionDataStoreEvents as at, type DecayOptions as au, type VisitorDataStoreOptions as av, type VisitorDataStoreEvents as aw, VisitorDataStore as ax, type Tests as ay, type Goals as az, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type PersonalizeOptions as g, Context as h, type PersonalizedResult as i, type VariationMatchDimensionCriteria as j, type PersonalizationSelectionAlgorithmOptions as k, type DevToolsEvents as l, CONTEXTUAL_EDITING_TEST_NAME as m, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as n, type PersonalizationSelectionAlgorithm as o, type PersonalizationSelectionAlgorithms as p, type ContextOptions as q, type PersonalizationEventVariantId as r, type PersonalizationEvent as s, type TestEvent as t, type ContextEvents as u, type ContextInstance as v, type DevToolsUiVersion as w, type DevToolsState as x, type DevToolsActions as y, type DevToolsEvent as z };