@uniformdev/canvas-next-rsc-shared 20.37.1-alpha.1 → 20.37.1-alpha.11

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([
       {
@@ -177,7 +189,8 @@ var runPersonalization = ({
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
@@ -202,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++) {
@@ -219,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,
@@ -236,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;
@@ -256,14 +279,21 @@ var runTest = ({
   });
   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) {
@@ -275,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,7 +216,8 @@ var runPersonalization = ({
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[import_canvas.CANVAS_PERSONALIZE_SLOT]) || [];
@@ -229,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++) {
@@ -246,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,
@@ -263,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;
@@ -283,14 +306,21 @@ var runTest = ({
   });
   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) {
@@ -302,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([
       {
@@ -177,7 +189,8 @@ var runPersonalization = ({
   trackingEventName,
   count,
   algorithm,
-  contextInstance
+  contextInstance,
+  context
 }) => {
   var _a;
   const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
@@ -202,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++) {
@@ -219,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,
@@ -236,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;
@@ -256,14 +279,21 @@ var runTest = ({
   });
   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) {
@@ -275,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,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc-shared",
-  "version": "20.37.1-alpha.1+5ac67f77a7",
+  "version": "20.37.1-alpha.11+f4e46464b5",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -32,8 +32,8 @@
     "react-dom": "18.3.1"
   },
   "dependencies": {
-    "@uniformdev/canvas": "20.37.1-alpha.1+5ac67f77a7",
-    "@uniformdev/context": "20.37.1-alpha.1+5ac67f77a7"
+    "@uniformdev/canvas": "20.37.1-alpha.11+f4e46464b5",
+    "@uniformdev/context": "20.37.1-alpha.11+f4e46464b5"
   },
   "engines": {
     "node": "^18.18.0 || ^19.8.0 || >= 20.0.0"
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5ac67f77a77da73d93c76b9ec23d86acbd0a2123"
+  "gitHead": "f4e46464b5578eadab4feec5dcb102446067e053"
 }