@uniformdev/canvas-next-rsc-shared 19.61.1-alpha.23 → 19.62.1-alpha.127

package/LICENSE.txt

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

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ContextInstance, ContextState, ContextOptions } from '@uniformdev/context';
+import { ContextInstance, ContextState, ContextOptions, PersonalizationEvent, TestEvent } from '@uniformdev/context';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
 import { PropsWithChildren } from 'react';
@@ -31,6 +31,17 @@ type UniformServerConfig = {
      *
      */
     projectMapCache?: CacheMode;
+    /**
+     * Options for Uniform Context
+     */
+    context?: {
+        /**
+         * Disables the Uniform Context dev tools.
+         *
+         * @default false
+         */
+        disableDevTools?: boolean;
+    };
     /**
      * Configure where system components should be evaluated.
      */
@@ -71,14 +82,11 @@ type UniformServerConfig = {
     };
 };
 
-declare const getServerConfig: () => UniformServerConfig;
-
 type PageParameters = {
     /**
      * The params object from Next.js router. Used to resolve a composition.
      */
     params: {
-        slug?: string | string[];
         path?: string | string[];
     };
     /**
@@ -104,6 +112,8 @@ type ComponentProps<TProps = unknown, TSlotNames extends string = string> = TPro
     component: ComponentInstance;
     context: CompositionContext;
     slots: Record<TSlotNames, SlotDefinition>;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
 };
 type CompositionContext = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
     composition: RootComponentInstance;
@@ -148,6 +158,7 @@ declare const runPersonalization: ({ component, trackingEventName, count, contex
     contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
 }) => {
     indexes: number[];
+    event: PersonalizationEvent;
 };
 
 type TestProps = {
@@ -158,18 +169,21 @@ declare const runTest: ({ test, component, contextInstance, }: TestProps & {
     component: _uniformdev_canvas.ComponentInstance;
     context: CompositionContext;
     slots: Record<string, SlotDefinition>;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
 } & {
     contextInstance: Pick<ContextInstance, 'test'> | undefined;
 }) => {
     index: number | null;
+    event: TestEvent;
 };
 
 type ResolvePathResult = {
-    type: 'slug' | 'path';
+    type: 'path';
     value: string;
 };
 declare const resolvePath: ({ params }: Pick<PageParameters, 'params'>) => ResolvePathResult;
 
 declare function getBaseUrl(): string;
 
-export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, CacheMode, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, PlaygroundParameters, ResolvePathResult, SlotDefinition, TestProps, UniformServerConfig, createUniformContext, getBaseUrl, getServerConfig, resolvePath, runPersonalization, runTest };
+export { type AppDirectoryContext, type AppDirectoryContextState, type AppDirectoryServerContext, type CacheMode, type ComponentProps, type CompositionContext, type PageParameters, type PersonalizeProps, type PersonalizeWithContextComponentProps, type PlaygroundParameters, type ResolvePathResult, type SlotDefinition, type TestProps, type UniformServerConfig, createUniformContext, getBaseUrl, resolvePath, runPersonalization, runTest };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ContextInstance, ContextState, ContextOptions } from '@uniformdev/context';
+import { ContextInstance, ContextState, ContextOptions, PersonalizationEvent, TestEvent } from '@uniformdev/context';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
 import { PropsWithChildren } from 'react';
@@ -31,6 +31,17 @@ type UniformServerConfig = {
      *
      */
     projectMapCache?: CacheMode;
+    /**
+     * Options for Uniform Context
+     */
+    context?: {
+        /**
+         * Disables the Uniform Context dev tools.
+         *
+         * @default false
+         */
+        disableDevTools?: boolean;
+    };
     /**
      * Configure where system components should be evaluated.
      */
@@ -71,14 +82,11 @@ type UniformServerConfig = {
     };
 };
 
-declare const getServerConfig: () => UniformServerConfig;
-
 type PageParameters = {
     /**
      * The params object from Next.js router. Used to resolve a composition.
      */
     params: {
-        slug?: string | string[];
         path?: string | string[];
     };
     /**
@@ -104,6 +112,8 @@ type ComponentProps<TProps = unknown, TSlotNames extends string = string> = TPro
     component: ComponentInstance;
     context: CompositionContext;
     slots: Record<TSlotNames, SlotDefinition>;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
 };
 type CompositionContext = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
     composition: RootComponentInstance;
@@ -148,6 +158,7 @@ declare const runPersonalization: ({ component, trackingEventName, count, contex
     contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
 }) => {
     indexes: number[];
+    event: PersonalizationEvent;
 };
 
 type TestProps = {
@@ -158,18 +169,21 @@ declare const runTest: ({ test, component, contextInstance, }: TestProps & {
     component: _uniformdev_canvas.ComponentInstance;
     context: CompositionContext;
     slots: Record<string, SlotDefinition>;
+    slotName: string | undefined;
+    slotIndex: number | undefined;
 } & {
     contextInstance: Pick<ContextInstance, 'test'> | undefined;
 }) => {
     index: number | null;
+    event: TestEvent;
 };
 
 type ResolvePathResult = {
-    type: 'slug' | 'path';
+    type: 'path';
     value: string;
 };
 declare const resolvePath: ({ params }: Pick<PageParameters, 'params'>) => ResolvePathResult;
 
 declare function getBaseUrl(): string;
 
-export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, CacheMode, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, PlaygroundParameters, ResolvePathResult, SlotDefinition, TestProps, UniformServerConfig, createUniformContext, getBaseUrl, getServerConfig, resolvePath, runPersonalization, runTest };
+export { type AppDirectoryContext, type AppDirectoryContextState, type AppDirectoryServerContext, type CacheMode, type ComponentProps, type CompositionContext, type PageParameters, type PersonalizeProps, type PersonalizeWithContextComponentProps, type PlaygroundParameters, type ResolvePathResult, type SlotDefinition, type TestProps, type UniformServerConfig, createUniformContext, getBaseUrl, resolvePath, runPersonalization, runTest };

package/dist/index.esm.js

@@ -1,38 +1,13 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/config/helpers.ts
-var getServerConfig = () => {
-  let serverConfig;
-  try {
-    serverConfig = __require("uniform.server.config.js");
-  } catch (e) {
-    serverConfig = {
-      defaultConsent: false
-    };
-  }
-  return serverConfig;
-};
-
 // src/context/createUniformContext.ts
 import { Context, CookieTransitionDataStore } from "@uniformdev/context";
 
 // src/utils/path.ts
 var resolvePath = ({ params }) => {
-  if (params.path || Object.keys(params).length === 0) {
-    const value = processPath(params.path || "");
-    return {
-      type: "path",
-      value
-    };
-  } else {
-    throw new Error("Slug resolution is currently not implemented.");
-  }
+  const value = processPath(params.path || "");
+  return {
+    type: "path",
+    value
+  };
 };
 var processPath = (value) => {
   const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
@@ -82,10 +57,8 @@ var createUniformContext = ({
   serverCookieValue,
   ...rest
 }) => {
-  var _a;
   const context = new Context({
     ...rest,
-    defaultConsent: (_a = getServerConfig()) == null ? void 0 : _a.defaultConsent,
     transitionStore: new CookieTransitionDataStore({
       serverCookieValue
     })
@@ -100,6 +73,7 @@ var createUniformContext = ({
     setTestVariantId: (...props) => context.setTestVariantId(...props),
     scores: context.scores,
     test: (...props) => context.test(...props),
+    manifest: context.manifest,
     update: (update) => {
       const { params, searchParams } = update;
       const DEFAULT_URL = `${getBaseUrl()}/`;
@@ -128,7 +102,9 @@ var createUniformContext = ({
         ...update,
         url
       });
-    }
+    },
+    internal_processTestEvent: (...props) => context.internal_processTestEvent(...props),
+    internal_processPersonalizationEvent: (...props) => context.internal_processPersonalizationEvent(...props)
   };
   return appDirectoryContext;
 };
@@ -154,6 +130,7 @@ var runPersonalization = ({
     };
   });
   const indexes = [];
+  const variantIds = [];
   let parsedCount;
   if (typeof count === "string") {
     parsedCount = parseInt(count, 10);
@@ -171,6 +148,10 @@ var runPersonalization = ({
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
         indexes.push(variations[i].index);
+        variantIds.push({
+          id: variations[i].id,
+          control: variations[i].control
+        });
       }
     }
   } else {
@@ -185,9 +166,22 @@ var runPersonalization = ({
       }
     }
     indexes.push(...defaults);
+    variantIds.push(
+      ...defaults.map((i) => ({
+        id: componentVariations[i].id,
+        control: false
+      }))
+    );
   }
+  const event = {
+    name: trackingEventName,
+    variantIds,
+    changed: true,
+    control: false
+  };
   return {
-    indexes
+    indexes,
+    event
   };
 };
 
@@ -211,6 +205,7 @@ var runTest = ({
     };
   });
   let index = null;
+  let variantId = null;
   if (contextInstance) {
     const { result } = contextInstance.test({
       name: test,
@@ -218,21 +213,29 @@ var runTest = ({
     });
     if (result) {
       index = result.index;
+      variantId = result.id;
     }
-  } else {
+  }
+  if (!variantId) {
     const [first] = componentVariations;
     if (first) {
       index = first.index;
+      variantId = first.id;
     }
   }
+  const event = {
+    name: test,
+    variantAssigned: true,
+    variantId: variantId != null ? variantId : "NO_VARIANTS"
+  };
   return {
-    index
+    index,
+    event
   };
 };
 export {
   createUniformContext,
   getBaseUrl,
-  getServerConfig,
   resolvePath,
   runPersonalization,
   runTest

package/dist/index.js

@@ -22,40 +22,22 @@ var src_exports = {};
 __export(src_exports, {
   createUniformContext: () => createUniformContext,
   getBaseUrl: () => getBaseUrl,
-  getServerConfig: () => getServerConfig,
   resolvePath: () => resolvePath,
   runPersonalization: () => runPersonalization,
   runTest: () => runTest
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/config/helpers.ts
-var getServerConfig = () => {
-  let serverConfig;
-  try {
-    serverConfig = require("uniform.server.config.js");
-  } catch (e) {
-    serverConfig = {
-      defaultConsent: false
-    };
-  }
-  return serverConfig;
-};
-
 // src/context/createUniformContext.ts
 var import_context = require("@uniformdev/context");
 
 // src/utils/path.ts
 var resolvePath = ({ params }) => {
-  if (params.path || Object.keys(params).length === 0) {
-    const value = processPath(params.path || "");
-    return {
-      type: "path",
-      value
-    };
-  } else {
-    throw new Error("Slug resolution is currently not implemented.");
-  }
+  const value = processPath(params.path || "");
+  return {
+    type: "path",
+    value
+  };
 };
 var processPath = (value) => {
   const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
@@ -105,10 +87,8 @@ var createUniformContext = ({
   serverCookieValue,
   ...rest
 }) => {
-  var _a;
   const context = new import_context.Context({
     ...rest,
-    defaultConsent: (_a = getServerConfig()) == null ? void 0 : _a.defaultConsent,
     transitionStore: new import_context.CookieTransitionDataStore({
       serverCookieValue
     })
@@ -123,6 +103,7 @@ var createUniformContext = ({
     setTestVariantId: (...props) => context.setTestVariantId(...props),
     scores: context.scores,
     test: (...props) => context.test(...props),
+    manifest: context.manifest,
     update: (update) => {
       const { params, searchParams } = update;
       const DEFAULT_URL = `${getBaseUrl()}/`;
@@ -151,7 +132,9 @@ var createUniformContext = ({
         ...update,
         url
       });
-    }
+    },
+    internal_processTestEvent: (...props) => context.internal_processTestEvent(...props),
+    internal_processPersonalizationEvent: (...props) => context.internal_processPersonalizationEvent(...props)
   };
   return appDirectoryContext;
 };
@@ -177,6 +160,7 @@ var runPersonalization = ({
     };
   });
   const indexes = [];
+  const variantIds = [];
   let parsedCount;
   if (typeof count === "string") {
     parsedCount = parseInt(count, 10);
@@ -194,6 +178,10 @@ var runPersonalization = ({
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
         indexes.push(variations[i].index);
+        variantIds.push({
+          id: variations[i].id,
+          control: variations[i].control
+        });
       }
     }
   } else {
@@ -208,9 +196,22 @@ var runPersonalization = ({
       }
     }
     indexes.push(...defaults);
+    variantIds.push(
+      ...defaults.map((i) => ({
+        id: componentVariations[i].id,
+        control: false
+      }))
+    );
   }
+  const event = {
+    name: trackingEventName,
+    variantIds,
+    changed: true,
+    control: false
+  };
   return {
-    indexes
+    indexes,
+    event
   };
 };
 
@@ -234,6 +235,7 @@ var runTest = ({
     };
   });
   let index = null;
+  let variantId = null;
   if (contextInstance) {
     const { result } = contextInstance.test({
       name: test,
@@ -241,22 +243,30 @@ var runTest = ({
     });
     if (result) {
       index = result.index;
+      variantId = result.id;
     }
-  } else {
+  }
+  if (!variantId) {
     const [first] = componentVariations;
     if (first) {
       index = first.index;
+      variantId = first.id;
     }
   }
+  const event = {
+    name: test,
+    variantAssigned: true,
+    variantId: variantId != null ? variantId : "NO_VARIANTS"
+  };
   return {
-    index
+    index,
+    event
   };
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createUniformContext,
   getBaseUrl,
-  getServerConfig,
   resolvePath,
   runPersonalization,
   runTest

package/dist/index.mjs

@@ -1,38 +1,13 @@
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-
-// src/config/helpers.ts
-var getServerConfig = () => {
-  let serverConfig;
-  try {
-    serverConfig = __require("uniform.server.config.js");
-  } catch (e) {
-    serverConfig = {
-      defaultConsent: false
-    };
-  }
-  return serverConfig;
-};
-
 // src/context/createUniformContext.ts
 import { Context, CookieTransitionDataStore } from "@uniformdev/context";
 
 // src/utils/path.ts
 var resolvePath = ({ params }) => {
-  if (params.path || Object.keys(params).length === 0) {
-    const value = processPath(params.path || "");
-    return {
-      type: "path",
-      value
-    };
-  } else {
-    throw new Error("Slug resolution is currently not implemented.");
-  }
+  const value = processPath(params.path || "");
+  return {
+    type: "path",
+    value
+  };
 };
 var processPath = (value) => {
   const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
@@ -82,10 +57,8 @@ var createUniformContext = ({
   serverCookieValue,
   ...rest
 }) => {
-  var _a;
   const context = new Context({
     ...rest,
-    defaultConsent: (_a = getServerConfig()) == null ? void 0 : _a.defaultConsent,
     transitionStore: new CookieTransitionDataStore({
       serverCookieValue
     })
@@ -100,6 +73,7 @@ var createUniformContext = ({
     setTestVariantId: (...props) => context.setTestVariantId(...props),
     scores: context.scores,
     test: (...props) => context.test(...props),
+    manifest: context.manifest,
     update: (update) => {
       const { params, searchParams } = update;
       const DEFAULT_URL = `${getBaseUrl()}/`;
@@ -128,7 +102,9 @@ var createUniformContext = ({
         ...update,
         url
       });
-    }
+    },
+    internal_processTestEvent: (...props) => context.internal_processTestEvent(...props),
+    internal_processPersonalizationEvent: (...props) => context.internal_processPersonalizationEvent(...props)
   };
   return appDirectoryContext;
 };
@@ -154,6 +130,7 @@ var runPersonalization = ({
     };
   });
   const indexes = [];
+  const variantIds = [];
   let parsedCount;
   if (typeof count === "string") {
     parsedCount = parseInt(count, 10);
@@ -171,6 +148,10 @@ var runPersonalization = ({
     if (variations) {
       for (let i = 0; i < variations.length; i++) {
         indexes.push(variations[i].index);
+        variantIds.push({
+          id: variations[i].id,
+          control: variations[i].control
+        });
       }
     }
   } else {
@@ -185,9 +166,22 @@ var runPersonalization = ({
       }
     }
     indexes.push(...defaults);
+    variantIds.push(
+      ...defaults.map((i) => ({
+        id: componentVariations[i].id,
+        control: false
+      }))
+    );
   }
+  const event = {
+    name: trackingEventName,
+    variantIds,
+    changed: true,
+    control: false
+  };
   return {
-    indexes
+    indexes,
+    event
   };
 };
 
@@ -211,6 +205,7 @@ var runTest = ({
     };
   });
   let index = null;
+  let variantId = null;
   if (contextInstance) {
     const { result } = contextInstance.test({
       name: test,
@@ -218,21 +213,29 @@ var runTest = ({
     });
     if (result) {
       index = result.index;
+      variantId = result.id;
     }
-  } else {
+  }
+  if (!variantId) {
     const [first] = componentVariations;
     if (first) {
       index = first.index;
+      variantId = first.id;
     }
   }
+  const event = {
+    name: test,
+    variantAssigned: true,
+    variantId: variantId != null ? variantId : "NO_VARIANTS"
+  };
   return {
-    index
+    index,
+    event
   };
 };
 export {
   createUniformContext,
   getBaseUrl,
-  getServerConfig,
   resolvePath,
   runPersonalization,
   runTest

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc-shared",
-  "version": "19.61.1-alpha.23+f3b91f17a",
+  "version": "19.62.1-alpha.127+d49e5a0782",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -24,16 +24,16 @@
     "/dist"
   ],
   "devDependencies": {
-    "@types/node": "^18.0.0",
-    "@types/react": "^18.2.20",
-    "eslint": "^8.11.0",
-    "next": "^13.4.12",
+    "@types/node": "^20.0.0",
+    "@types/react": "18.2.40",
+    "eslint": "8.57.0",
+    "next": "^14.0.0",
     "react": "18.2.0",
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.61.1-alpha.23+f3b91f17a",
-    "@uniformdev/context": "19.61.1-alpha.23+f3b91f17a"
+    "@uniformdev/canvas": "19.62.1-alpha.127+d49e5a0782",
+    "@uniformdev/context": "19.62.1-alpha.127+d49e5a0782"
   },
   "engines": {
     "node": ">=16.14.0"
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f3b91f17a3a9f28f817e68e91ace4b414e9befe4"
+  "gitHead": "d49e5a07824d69e5df3a92ff10bc9acd88d0bc22"
 }