@uniformdev/canvas-next-rsc-shared 20.6.2-alpha.11 → 20.7.1-alpha.102

package/LICENSE.txt

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

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _uniformdev_context from '@uniformdev/context';
-import { ContextInstance, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, LogMessage, TestVariant, TestOptions, PersonalizedVariant, PersonalizeOptions, TestEvent, PersonalizationEvent } from '@uniformdev/context';
+import { ContextInstance, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, LogMessage, TestVariant, TestOptions, PersonalizedVariant, PersonalizeOptions, TestEvent, PersonalizationEvent, CompositionMetadata } from '@uniformdev/context';
 import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
 import { PropsWithChildren } from 'react';
 
@@ -208,6 +208,14 @@ declare class AppDirectoryContextInstance implements AppDirectoryContext {
     internal_processTestEvent(event: TestEvent): void;
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
     update(update: Partial<AppDirectoryContextState>): Promise<void>;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
     updateConsent(consent: boolean): Promise<void>;
     get consent(): boolean | undefined;
     internal_update(update: Partial<AppDirectoryContextState>): Promise<void>;
@@ -222,11 +230,10 @@ type PersonalizeWithContextComponentProps = ComponentProps<PersonalizeProps> & {
     contextInstance: AppDirectoryServerContext;
 };
 
-interface RunPersonalizationProps extends PersonalizeProps {
-    component: ComponentProps['component'];
+type RunPersonalizationProps = Omit<ComponentProps<PersonalizeProps & {
     contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
-}
-declare const runPersonalization: ({ component, trackingEventName, count, algorithm, contextInstance, }: RunPersonalizationProps) => {
+}>, 'slots' | 'slotName' | 'slotIndex'>;
+declare const runPersonalization: ({ component, trackingEventName, count, algorithm, contextInstance, context, }: RunPersonalizationProps) => {
     indexes: number[];
     event: PersonalizationEvent;
 };
@@ -235,9 +242,9 @@ type TestProps = {
     test: string;
 };
 
-declare const runTest: ({ test, component, contextInstance, context, }: ComponentProps<TestProps> & {
+declare const runTest: ({ test, component, contextInstance, context, }: Omit<ComponentProps<TestProps> & {
     contextInstance: Pick<ContextInstance, "test" | "manifest"> | undefined;
-}) => {
+}, "slots" | "slotName" | "slotIndex">) => {
     index: number | null;
     event: TestEvent | null;
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _uniformdev_context from '@uniformdev/context';
-import { ContextInstance, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, LogMessage, TestVariant, TestOptions, PersonalizedVariant, PersonalizeOptions, TestEvent, PersonalizationEvent } from '@uniformdev/context';
+import { ContextInstance, ContextState, ContextOptions, CookieTransitionDataStoreOptions, Context, LogMessage, TestVariant, TestOptions, PersonalizedVariant, PersonalizeOptions, TestEvent, PersonalizationEvent, CompositionMetadata } from '@uniformdev/context';
 import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
 import { PropsWithChildren } from 'react';
 
@@ -208,6 +208,14 @@ declare class AppDirectoryContextInstance implements AppDirectoryContext {
     internal_processTestEvent(event: TestEvent): void;
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
     update(update: Partial<AppDirectoryContextState>): Promise<void>;
+    /**
+     * Gets the current canvas data
+     */
+    getCompositionMetadata(): Readonly<CompositionMetadata | undefined>;
+    /**
+     * Updates the canvas data and emits a canvasDataUpdated event
+     */
+    updateCompositionMetadata(newData: CompositionMetadata): Promise<void>;
     updateConsent(consent: boolean): Promise<void>;
     get consent(): boolean | undefined;
     internal_update(update: Partial<AppDirectoryContextState>): Promise<void>;
@@ -222,11 +230,10 @@ type PersonalizeWithContextComponentProps = ComponentProps<PersonalizeProps> & {
     contextInstance: AppDirectoryServerContext;
 };
 
-interface RunPersonalizationProps extends PersonalizeProps {
-    component: ComponentProps['component'];
+type RunPersonalizationProps = Omit<ComponentProps<PersonalizeProps & {
     contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
-}
-declare const runPersonalization: ({ component, trackingEventName, count, algorithm, contextInstance, }: RunPersonalizationProps) => {
+}>, 'slots' | 'slotName' | 'slotIndex'>;
+declare const runPersonalization: ({ component, trackingEventName, count, algorithm, contextInstance, context, }: RunPersonalizationProps) => {
     indexes: number[];
     event: PersonalizationEvent;
 };
@@ -235,9 +242,9 @@ type TestProps = {
     test: string;
 };
 
-declare const runTest: ({ test, component, contextInstance, context, }: ComponentProps<TestProps> & {
+declare const runTest: ({ test, component, contextInstance, context, }: Omit<ComponentProps<TestProps> & {
     contextInstance: Pick<ContextInstance, "test" | "manifest"> | undefined;
-}) => {
+}, "slots" | "slotName" | "slotIndex">) => {
     index: number | null;
     event: TestEvent | null;
 };

package/dist/index.esm.js

@@ -153,6 +153,18 @@ var AppDirectoryContextInstance = class {
       url
     });
   }
+  /**
+   * Gets the current canvas data
+   */
+  getCompositionMetadata() {
+    return __privateGet(this, _context).getCompositionMetadata();
+  }
+  /**
+   * Updates the canvas data and emits a canvasDataUpdated event
+   */
+  async updateCompositionMetadata(newData) {
+    return __privateGet(this, _context).updateCompositionMetadata(newData);
+  }
   async updateConsent(consent) {
     return __privateGet(this, _context).storage.updateData([
       {
@@ -171,23 +183,20 @@ var AppDirectoryContextInstance = class {
 _context = new WeakMap();
 
 // src/runPersonalization.ts
-import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
+import { CANVAS_PERSONALIZE_SLOT, mapSlotToPersonalizedVariations } from "@uniformdev/canvas";
 var runPersonalization = ({
   component,
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b;
-    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b.value;
-    const id = v._id || `pz-${i}-${v.type}`;
+  const componentVariations = mapSlotToPersonalizedVariations(slot).map((v, i) => {
     return {
-      id,
-      pz: contextTag,
+      ...v,
       index: i
     };
   });
@@ -206,7 +215,12 @@ var runPersonalization = ({
       name: trackingEventName,
       take: parsedCount,
       variations: componentVariations,
-      algorithm
+      algorithm,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
@@ -223,7 +237,12 @@ var runPersonalization = ({
     name: trackingEventName,
     variantIds,
     changed: true,
-    control: false
+    control: false,
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     indexes,
@@ -232,7 +251,7 @@ var runPersonalization = ({
 };
 
 // src/runTest.ts
-import { CANVAS_TEST_SLOT, CANVAS_TEST_VARIANT_PARAM } from "@uniformdev/canvas";
+import { CANVAS_TEST_SLOT, mapSlotToTestVariations } from "@uniformdev/canvas";
 import { CONTEXTUAL_EDITING_TEST_NAME } from "@uniformdev/context";
 var runTest = ({
   test,
@@ -240,7 +259,7 @@ var runTest = ({
   contextInstance,
   context
 }) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const isTestDefined = Boolean((_a = contextInstance == null ? void 0 : contextInstance.manifest.data.project.test) == null ? void 0 : _a[test]);
   const isContextualTest = context.isContextualEditing && test === CONTEXTUAL_EDITING_TEST_NAME;
   const shouldShowTest = isTestDefined || isContextualTest;
@@ -252,26 +271,29 @@ var runTest = ({
     };
   }
   const slot = ((_b = component.slots) == null ? void 0 : _b[CANVAS_TEST_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b2, _c;
-    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b2.value;
-    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+  const componentVariations = mapSlotToTestVariations(slot).map((v, i) => {
     return {
-      id,
-      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      ...v,
       index: i
     };
   });
   let index = null;
   let variantId = null;
+  let variantAssigned = false;
   if (contextInstance) {
-    const { result } = contextInstance.test({
+    const { result, variantAssigned: wasVariantAssigned } = contextInstance.test({
       name: test,
-      variations: componentVariations
+      variations: componentVariations,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (result) {
       index = result.index;
       variantId = result.id;
+      variantAssigned = wasVariantAssigned;
     }
   }
   if (!variantId) {
@@ -283,8 +305,14 @@ var runTest = ({
   }
   const event = {
     name: test,
-    variantAssigned: true,
-    variantId: variantId != null ? variantId : "NO_VARIANTS"
+    variantAssigned,
+    control: variantId ? (_d = (_c = componentVariations.find((v) => v.id === variantId)) == null ? void 0 : _c.control) != null ? _d : false : false,
+    variantId: variantId != null ? variantId : "NO_VARIANTS",
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     index,

package/dist/index.js

@@ -180,6 +180,18 @@ var AppDirectoryContextInstance = class {
       url
     });
   }
+  /**
+   * Gets the current canvas data
+   */
+  getCompositionMetadata() {
+    return __privateGet(this, _context).getCompositionMetadata();
+  }
+  /**
+   * Updates the canvas data and emits a canvasDataUpdated event
+   */
+  async updateCompositionMetadata(newData) {
+    return __privateGet(this, _context).updateCompositionMetadata(newData);
+  }
   async updateConsent(consent) {
     return __privateGet(this, _context).storage.updateData([
       {
@@ -204,17 +216,14 @@ var runPersonalization = ({
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[import_canvas.CANVAS_PERSONALIZE_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b;
-    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[import_canvas.CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b.value;
-    const id = v._id || `pz-${i}-${v.type}`;
+  const componentVariations = (0, import_canvas.mapSlotToPersonalizedVariations)(slot).map((v, i) => {
     return {
-      id,
-      pz: contextTag,
+      ...v,
       index: i
     };
   });
@@ -233,7 +242,12 @@ var runPersonalization = ({
       name: trackingEventName,
       take: parsedCount,
       variations: componentVariations,
-      algorithm
+      algorithm,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
@@ -250,7 +264,12 @@ var runPersonalization = ({
     name: trackingEventName,
     variantIds,
     changed: true,
-    control: false
+    control: false,
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     indexes,
@@ -267,7 +286,7 @@ var runTest = ({
   contextInstance,
   context
 }) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const isTestDefined = Boolean((_a = contextInstance == null ? void 0 : contextInstance.manifest.data.project.test) == null ? void 0 : _a[test]);
   const isContextualTest = context.isContextualEditing && test === import_context2.CONTEXTUAL_EDITING_TEST_NAME;
   const shouldShowTest = isTestDefined || isContextualTest;
@@ -279,26 +298,29 @@ var runTest = ({
     };
   }
   const slot = ((_b = component.slots) == null ? void 0 : _b[import_canvas2.CANVAS_TEST_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b2, _c;
-    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[import_canvas2.CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b2.value;
-    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+  const componentVariations = (0, import_canvas2.mapSlotToTestVariations)(slot).map((v, i) => {
     return {
-      id,
-      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      ...v,
       index: i
     };
   });
   let index = null;
   let variantId = null;
+  let variantAssigned = false;
   if (contextInstance) {
-    const { result } = contextInstance.test({
+    const { result, variantAssigned: wasVariantAssigned } = contextInstance.test({
       name: test,
-      variations: componentVariations
+      variations: componentVariations,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (result) {
       index = result.index;
       variantId = result.id;
+      variantAssigned = wasVariantAssigned;
     }
   }
   if (!variantId) {
@@ -310,8 +332,14 @@ var runTest = ({
   }
   const event = {
     name: test,
-    variantAssigned: true,
-    variantId: variantId != null ? variantId : "NO_VARIANTS"
+    variantAssigned,
+    control: variantId ? (_d = (_c = componentVariations.find((v) => v.id === variantId)) == null ? void 0 : _c.control) != null ? _d : false : false,
+    variantId: variantId != null ? variantId : "NO_VARIANTS",
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     index,

package/dist/index.mjs

@@ -153,6 +153,18 @@ var AppDirectoryContextInstance = class {
       url
     });
   }
+  /**
+   * Gets the current canvas data
+   */
+  getCompositionMetadata() {
+    return __privateGet(this, _context).getCompositionMetadata();
+  }
+  /**
+   * Updates the canvas data and emits a canvasDataUpdated event
+   */
+  async updateCompositionMetadata(newData) {
+    return __privateGet(this, _context).updateCompositionMetadata(newData);
+  }
   async updateConsent(consent) {
     return __privateGet(this, _context).storage.updateData([
       {
@@ -171,23 +183,20 @@ var AppDirectoryContextInstance = class {
 _context = new WeakMap();
 
 // src/runPersonalization.ts
-import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
+import { CANVAS_PERSONALIZE_SLOT, mapSlotToPersonalizedVariations } from "@uniformdev/canvas";
 var runPersonalization = ({
   component,
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b;
-    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b.value;
-    const id = v._id || `pz-${i}-${v.type}`;
+  const componentVariations = mapSlotToPersonalizedVariations(slot).map((v, i) => {
     return {
-      id,
-      pz: contextTag,
+      ...v,
       index: i
     };
   });
@@ -206,7 +215,12 @@ var runPersonalization = ({
       name: trackingEventName,
       take: parsedCount,
       variations: componentVariations,
-      algorithm
+      algorithm,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
@@ -223,7 +237,12 @@ var runPersonalization = ({
     name: trackingEventName,
     variantIds,
     changed: true,
-    control: false
+    control: false,
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     indexes,
@@ -232,7 +251,7 @@ var runPersonalization = ({
 };
 
 // src/runTest.ts
-import { CANVAS_TEST_SLOT, CANVAS_TEST_VARIANT_PARAM } from "@uniformdev/canvas";
+import { CANVAS_TEST_SLOT, mapSlotToTestVariations } from "@uniformdev/canvas";
 import { CONTEXTUAL_EDITING_TEST_NAME } from "@uniformdev/context";
 var runTest = ({
   test,
@@ -240,7 +259,7 @@ var runTest = ({
   contextInstance,
   context
 }) => {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const isTestDefined = Boolean((_a = contextInstance == null ? void 0 : contextInstance.manifest.data.project.test) == null ? void 0 : _a[test]);
   const isContextualTest = context.isContextualEditing && test === CONTEXTUAL_EDITING_TEST_NAME;
   const shouldShowTest = isTestDefined || isContextualTest;
@@ -252,26 +271,29 @@ var runTest = ({
     };
   }
   const slot = ((_b = component.slots) == null ? void 0 : _b[CANVAS_TEST_SLOT]) || [];
-  const componentVariations = slot.map((v, i) => {
-    var _a2, _b2, _c;
-    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b2.value;
-    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+  const componentVariations = mapSlotToTestVariations(slot).map((v, i) => {
     return {
-      id,
-      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      ...v,
       index: i
     };
   });
   let index = null;
   let variantId = null;
+  let variantAssigned = false;
   if (contextInstance) {
-    const { result } = contextInstance.test({
+    const { result, variantAssigned: wasVariantAssigned } = contextInstance.test({
       name: test,
-      variations: componentVariations
+      variations: componentVariations,
+      compositionMetadata: {
+        compositionId: context.composition._id,
+        matchedRoute: context.matchedRoute,
+        dynamicInputs: context.dynamicInputs
+      }
     });
     if (result) {
       index = result.index;
       variantId = result.id;
+      variantAssigned = wasVariantAssigned;
     }
   }
   if (!variantId) {
@@ -283,8 +305,14 @@ var runTest = ({
   }
   const event = {
     name: test,
-    variantAssigned: true,
-    variantId: variantId != null ? variantId : "NO_VARIANTS"
+    variantAssigned,
+    control: variantId ? (_d = (_c = componentVariations.find((v) => v.id === variantId)) == null ? void 0 : _c.control) != null ? _d : false : false,
+    variantId: variantId != null ? variantId : "NO_VARIANTS",
+    compositionMetadata: {
+      compositionId: context.composition._id,
+      matchedRoute: context.matchedRoute,
+      dynamicInputs: context.dynamicInputs
+    }
   };
   return {
     index,

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@uniformdev/canvas-next-rsc-shared",
-  "version": "20.6.2-alpha.11+af78064791",
+  "version": "20.7.1-alpha.102+d621aa22b2",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
     "lint": "eslint \"src/**/*.{ts,tsx}\" --fix",
-    "test": "jest --maxWorkers=1 --passWithNoTests"
+    "test": "jest --maxWorkers=1 --passWithNoTests",
+    "document": "api-extractor run --local"
   },
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -24,27 +25,26 @@
     "/dist"
   ],
   "devDependencies": {
-    "@types/node": "22.7.8",
-    "@types/react": "18.3.11",
-    "eslint": "9.9.0",
-    "next": "15.1.0",
+    "@types/node": "24.3.1",
+    "@types/react": "18.3.24",
+    "next": "15.2.4",
     "react": "18.3.1",
     "react-dom": "18.3.1"
   },
   "dependencies": {
-    "@uniformdev/canvas": "20.6.2-alpha.11+af78064791",
-    "@uniformdev/context": "20.6.2-alpha.11+af78064791"
+    "@uniformdev/canvas": "20.7.1-alpha.102+d621aa22b2",
+    "@uniformdev/context": "20.7.1-alpha.102+d621aa22b2"
   },
   "engines": {
     "node": "^18.18.0 || ^19.8.0 || >= 20.0.0"
   },
   "peerDependencies": {
-    "next": ">=15.1.0",
+    "next": ">=15.2.3",
     "react": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0",
     "react-dom": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "af78064791c47044f8ba447bbe1221f672f6de3e"
+  "gitHead": "d621aa22b220347565e307b064fb1eda8963abbe"
 }