@uniformdev/canvas-next-rsc-shared 19.55.2-alpha.14

package/LICENSE.txt

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

package/README.md

@@ -0,0 +1,5 @@
+Next.js RSC SDK for Uniform Canvas
+
+**Note:** This package is in public preview.
+
+part of the [Uniform Platform](https://uniform.app). See our [documentation](https://docs.uniform.app) for more details.

package/dist/index.d.mts

@@ -0,0 +1,87 @@
+import * as _uniformdev_canvas from '@uniformdev/canvas';
+import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
+import { ContextInstance, ContextState } from '@uniformdev/context';
+import { PropsWithChildren } from 'react';
+
+type PageParameters = {
+    /**
+     * The params object from Next.js router. Used to resolve a composition.
+     */
+    params: {
+        slug?: string | string[];
+        path?: string | string[];
+    };
+    /**
+     * The searchParams object from Next.js router. Used for signal evaluation.
+     */
+    searchParams?: {
+        [key: string]: string | undefined;
+    };
+};
+type SlotDefinition = {
+    name: string;
+    items: PropsWithChildren['children'][];
+};
+type ComponentProps<TProps = unknown, TSlotNames extends string = string> = TProps & {
+    component: ComponentInstance;
+    context: CompositionContext;
+    slots: Record<TSlotNames, SlotDefinition>;
+};
+type CompositionContext = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
+    composition: RootComponentInstance;
+    path: string;
+    state?: number;
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+    isDraftMode: boolean;
+    isContextualEditing: boolean;
+};
+type AppDirectoryContext = Omit<ContextInstance, 'update'> & {
+    update: (update: Partial<AppDirectoryContextState>) => Promise<void>;
+};
+type AppDirectoryContextState = Omit<ContextState, 'url'> & PageParameters;
+type AppDirectoryServerContext = Omit<AppDirectoryContext, 'update'> & {
+    /**
+     * Internal use only. Please use `ContextUpdateTransfer` to handle any Context updates.
+     *
+     * @deprecated
+     */
+    __INTERNAL__: {
+        update: AppDirectoryContext['update'];
+    };
+};
+
+type PersonalizeProps = {
+    trackingEventName: string;
+    count: number | undefined;
+};
+type PersonalizeWithContextComponentProps = ComponentProps<PersonalizeProps> & {
+    contextInstance: AppDirectoryServerContext;
+};
+
+declare const runPersonalization: ({ component, trackingEventName, count, contextInstance, }: PersonalizeProps & {
+    component: _uniformdev_canvas.ComponentInstance;
+    context: CompositionContext;
+    slots: Record<string, SlotDefinition>;
+} & {
+    contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
+}) => {
+    indexes: number[];
+};
+
+type TestProps = {
+    test: string;
+};
+
+declare const runTest: ({ test, component, contextInstance, }: TestProps & {
+    component: _uniformdev_canvas.ComponentInstance;
+    context: CompositionContext;
+    slots: Record<string, SlotDefinition>;
+} & {
+    contextInstance: Pick<ContextInstance, 'test'> | undefined;
+}) => {
+    index: number | null;
+};
+
+export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, SlotDefinition, TestProps, runPersonalization, runTest };

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import * as _uniformdev_canvas from '@uniformdev/canvas';
+import { ComponentInstance, RouteGetResponseComposition, RootComponentInstance } from '@uniformdev/canvas';
+import { ContextInstance, ContextState } from '@uniformdev/context';
+import { PropsWithChildren } from 'react';
+
+type PageParameters = {
+    /**
+     * The params object from Next.js router. Used to resolve a composition.
+     */
+    params: {
+        slug?: string | string[];
+        path?: string | string[];
+    };
+    /**
+     * The searchParams object from Next.js router. Used for signal evaluation.
+     */
+    searchParams?: {
+        [key: string]: string | undefined;
+    };
+};
+type SlotDefinition = {
+    name: string;
+    items: PropsWithChildren['children'][];
+};
+type ComponentProps<TProps = unknown, TSlotNames extends string = string> = TProps & {
+    component: ComponentInstance;
+    context: CompositionContext;
+    slots: Record<TSlotNames, SlotDefinition>;
+};
+type CompositionContext = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
+    composition: RootComponentInstance;
+    path: string;
+    state?: number;
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+    isDraftMode: boolean;
+    isContextualEditing: boolean;
+};
+type AppDirectoryContext = Omit<ContextInstance, 'update'> & {
+    update: (update: Partial<AppDirectoryContextState>) => Promise<void>;
+};
+type AppDirectoryContextState = Omit<ContextState, 'url'> & PageParameters;
+type AppDirectoryServerContext = Omit<AppDirectoryContext, 'update'> & {
+    /**
+     * Internal use only. Please use `ContextUpdateTransfer` to handle any Context updates.
+     *
+     * @deprecated
+     */
+    __INTERNAL__: {
+        update: AppDirectoryContext['update'];
+    };
+};
+
+type PersonalizeProps = {
+    trackingEventName: string;
+    count: number | undefined;
+};
+type PersonalizeWithContextComponentProps = ComponentProps<PersonalizeProps> & {
+    contextInstance: AppDirectoryServerContext;
+};
+
+declare const runPersonalization: ({ component, trackingEventName, count, contextInstance, }: PersonalizeProps & {
+    component: _uniformdev_canvas.ComponentInstance;
+    context: CompositionContext;
+    slots: Record<string, SlotDefinition>;
+} & {
+    contextInstance: Pick<ContextInstance, 'personalize'> | undefined;
+}) => {
+    indexes: number[];
+};
+
+type TestProps = {
+    test: string;
+};
+
+declare const runTest: ({ test, component, contextInstance, }: TestProps & {
+    component: _uniformdev_canvas.ComponentInstance;
+    context: CompositionContext;
+    slots: Record<string, SlotDefinition>;
+} & {
+    contextInstance: Pick<ContextInstance, 'test'> | undefined;
+}) => {
+    index: number | null;
+};
+
+export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, SlotDefinition, TestProps, runPersonalization, runTest };

package/dist/index.esm.js

@@ -0,0 +1,92 @@
+// src/runPersonalization.ts
+import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
+var runPersonalization = ({
+  component,
+  trackingEventName,
+  count,
+  contextInstance
+}) => {
+  var _a, _b;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b2;
+    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b2.value;
+    const id = (contextTag == null ? void 0 : contextTag.name) || `pz-${i}-${v.type}`;
+    return {
+      id,
+      pz: contextTag,
+      index: i
+    };
+  });
+  const indexes = [];
+  if (contextInstance) {
+    const { variations } = contextInstance.personalize({
+      name: trackingEventName,
+      take: count || 1,
+      variations: componentVariations
+    });
+    if (variations) {
+      for (let i = 0; i < variations.length; i++) {
+        indexes.push(variations[i].index);
+      }
+    }
+  } else {
+    const defaults = [];
+    for (let i = 0; i < componentVariations.length; i++) {
+      const v = componentVariations[i];
+      if (!((_b = v.pz) == null ? void 0 : _b.crit)) {
+        defaults.push(v.index);
+        if (defaults.length >= (count || 1)) {
+          break;
+        }
+      }
+    }
+    indexes.push(...defaults);
+  }
+  return {
+    indexes
+  };
+};
+
+// src/runTest.ts
+import { CANVAS_TEST_SLOT, CANVAS_TEST_VARIANT_PARAM } from "@uniformdev/canvas";
+var runTest = ({
+  test,
+  component,
+  contextInstance
+}) => {
+  var _a;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_TEST_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b, _c;
+    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b.value;
+    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+    return {
+      id,
+      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      index: i
+    };
+  });
+  let index = null;
+  if (contextInstance) {
+    const { result } = contextInstance.test({
+      name: test,
+      variations: componentVariations
+    });
+    if (result) {
+      index = result.index;
+    }
+  } else {
+    const [first] = componentVariations;
+    if (first) {
+      index = first.index;
+    }
+  }
+  return {
+    index
+  };
+};
+export {
+  runPersonalization,
+  runTest
+};

package/dist/index.js

@@ -0,0 +1,120 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  runPersonalization: () => runPersonalization,
+  runTest: () => runTest
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/runPersonalization.ts
+var import_canvas = require("@uniformdev/canvas");
+var runPersonalization = ({
+  component,
+  trackingEventName,
+  count,
+  contextInstance
+}) => {
+  var _a, _b;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[import_canvas.CANVAS_PERSONALIZE_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b2;
+    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[import_canvas.CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b2.value;
+    const id = (contextTag == null ? void 0 : contextTag.name) || `pz-${i}-${v.type}`;
+    return {
+      id,
+      pz: contextTag,
+      index: i
+    };
+  });
+  const indexes = [];
+  if (contextInstance) {
+    const { variations } = contextInstance.personalize({
+      name: trackingEventName,
+      take: count || 1,
+      variations: componentVariations
+    });
+    if (variations) {
+      for (let i = 0; i < variations.length; i++) {
+        indexes.push(variations[i].index);
+      }
+    }
+  } else {
+    const defaults = [];
+    for (let i = 0; i < componentVariations.length; i++) {
+      const v = componentVariations[i];
+      if (!((_b = v.pz) == null ? void 0 : _b.crit)) {
+        defaults.push(v.index);
+        if (defaults.length >= (count || 1)) {
+          break;
+        }
+      }
+    }
+    indexes.push(...defaults);
+  }
+  return {
+    indexes
+  };
+};
+
+// src/runTest.ts
+var import_canvas2 = require("@uniformdev/canvas");
+var runTest = ({
+  test,
+  component,
+  contextInstance
+}) => {
+  var _a;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[import_canvas2.CANVAS_TEST_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b, _c;
+    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[import_canvas2.CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b.value;
+    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+    return {
+      id,
+      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      index: i
+    };
+  });
+  let index = null;
+  if (contextInstance) {
+    const { result } = contextInstance.test({
+      name: test,
+      variations: componentVariations
+    });
+    if (result) {
+      index = result.index;
+    }
+  } else {
+    const [first] = componentVariations;
+    if (first) {
+      index = first.index;
+    }
+  }
+  return {
+    index
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  runPersonalization,
+  runTest
+});

package/dist/index.mjs

@@ -0,0 +1,92 @@
+// src/runPersonalization.ts
+import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
+var runPersonalization = ({
+  component,
+  trackingEventName,
+  count,
+  contextInstance
+}) => {
+  var _a, _b;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b2;
+    const contextTag = (_b2 = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b2.value;
+    const id = (contextTag == null ? void 0 : contextTag.name) || `pz-${i}-${v.type}`;
+    return {
+      id,
+      pz: contextTag,
+      index: i
+    };
+  });
+  const indexes = [];
+  if (contextInstance) {
+    const { variations } = contextInstance.personalize({
+      name: trackingEventName,
+      take: count || 1,
+      variations: componentVariations
+    });
+    if (variations) {
+      for (let i = 0; i < variations.length; i++) {
+        indexes.push(variations[i].index);
+      }
+    }
+  } else {
+    const defaults = [];
+    for (let i = 0; i < componentVariations.length; i++) {
+      const v = componentVariations[i];
+      if (!((_b = v.pz) == null ? void 0 : _b.crit)) {
+        defaults.push(v.index);
+        if (defaults.length >= (count || 1)) {
+          break;
+        }
+      }
+    }
+    indexes.push(...defaults);
+  }
+  return {
+    indexes
+  };
+};
+
+// src/runTest.ts
+import { CANVAS_TEST_SLOT, CANVAS_TEST_VARIANT_PARAM } from "@uniformdev/canvas";
+var runTest = ({
+  test,
+  component,
+  contextInstance
+}) => {
+  var _a;
+  const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_TEST_SLOT]) || [];
+  const componentVariations = slot.map((v, i) => {
+    var _a2, _b, _c;
+    const contextTag = (_b = (_a2 = v.parameters) == null ? void 0 : _a2[CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b.value;
+    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+    return {
+      id,
+      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      index: i
+    };
+  });
+  let index = null;
+  if (contextInstance) {
+    const { result } = contextInstance.test({
+      name: test,
+      variations: componentVariations
+    });
+    if (result) {
+      index = result.index;
+    }
+  } else {
+    const [first] = componentVariations;
+    if (first) {
+      index = first.index;
+    }
+  }
+  return {
+    index
+  };
+};
+export {
+  runPersonalization,
+  runTest
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@uniformdev/canvas-next-rsc-shared",
+  "version": "19.55.2-alpha.14+9b75d5322",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint \"**/*.{ts,tsx}\" --fix",
+    "test": "jest --maxWorkers=1 --passWithNoTests"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.mts",
+      "node": "./dist/index.mjs",
+      "default": "./dist/index.esm.js"
+    },
+    "require": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "@types/react": "^18.2.20",
+    "eslint": "^8.11.0",
+    "next": "^13.4.12",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "dependencies": {
+    "@uniformdev/canvas": "19.55.2-alpha.14+9b75d5322",
+    "@uniformdev/context": "19.55.2-alpha.14+9b75d5322"
+  },
+  "engines": {
+    "node": ">=16.14.0"
+  },
+  "peerDependencies": {
+    "next": ">=13.4.7",
+    "react": ">=18.2",
+    "react-dom": ">=18.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "9b75d5322988b2a8c59e7e1b641fb0c8cb7ad301"
+}