@uniformdev/canvas-next-rsc-shared 19.55.2-alpha.54 → 19.55.2-alpha.60

package/dist/index.d.mts

@@ -1,8 +1,78 @@
+import { ContextInstance, ContextState, ContextOptions } from '@uniformdev/context';
 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 CacheMode = {
+    type: RequestInit['cache'];
+} | {
+    type: 'revalidate';
+    interval: number;
+};
+type UniformServerConfig = {
+    /**
+     * Sets the default value of storage consent for new unknown visitors.
+     *
+     * @default false
+     */
+    defaultConsent?: boolean;
+    /**
+     * Cache mode for manifest data.
+     *
+     */
+    manifestCache?: CacheMode;
+    /**
+     * Cache mode for canvas data.
+     *
+     */
+    canvasCache?: CacheMode;
+    /**
+     * Cache mode for project map data.
+     *
+     */
+    projectMapCache?: CacheMode;
+    /**
+     * Configure where system components should be evaluated.
+     */
+    evaluation?: {
+        /**
+         * Configure where personalization components should be evaluated.
+         */
+        personalization: 'client' | 'server';
+        /**
+         * Configure where testing components should be evaluated.
+         */
+        testing: 'client' | 'server';
+    };
+    /**
+     * 😅
+     */
+    experimental?: {
+        /**
+         * Enables edge cache of redirects.
+         *
+         * @default false
+         */
+        edgeRedirects?: boolean;
+        /**
+         * Enables edge cache of compositions.
+         *
+         * @default false
+         */
+        edgeCompositions?: boolean;
+        /**
+         * Dynamic tokens names that should be used for localization.
+         */
+        localeDynamicInputs?: string[];
+        /**
+         * Enables visual editing mode.
+         */
+        vercelVisualEditing?: boolean;
+    };
+};
+
+declare const getServerConfig: () => UniformServerConfig;
+
 type PageParameters = {
     /**
      * The params object from Next.js router. Used to resolve a composition.
@@ -60,6 +130,10 @@ type AppDirectoryServerContext = Omit<AppDirectoryContext, 'update'> & {
     };
 };
 
+declare const createUniformContext: ({ serverCookieValue, ...rest }: Omit<ContextOptions, "transitionStore"> & {
+    serverCookieValue: string | undefined;
+}) => AppDirectoryContext;
+
 type PersonalizeProps = {
     trackingEventName: string;
     count: number | undefined;
@@ -92,4 +166,12 @@ declare const runTest: ({ test, component, contextInstance, }: TestProps & {
     index: number | null;
 };
 
-export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, PlaygroundParameters, SlotDefinition, TestProps, runPersonalization, runTest };
+type ResolvePathResult = {
+    type: 'slug' | '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 };

package/dist/index.d.ts

@@ -1,8 +1,78 @@
+import { ContextInstance, ContextState, ContextOptions } from '@uniformdev/context';
 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 CacheMode = {
+    type: RequestInit['cache'];
+} | {
+    type: 'revalidate';
+    interval: number;
+};
+type UniformServerConfig = {
+    /**
+     * Sets the default value of storage consent for new unknown visitors.
+     *
+     * @default false
+     */
+    defaultConsent?: boolean;
+    /**
+     * Cache mode for manifest data.
+     *
+     */
+    manifestCache?: CacheMode;
+    /**
+     * Cache mode for canvas data.
+     *
+     */
+    canvasCache?: CacheMode;
+    /**
+     * Cache mode for project map data.
+     *
+     */
+    projectMapCache?: CacheMode;
+    /**
+     * Configure where system components should be evaluated.
+     */
+    evaluation?: {
+        /**
+         * Configure where personalization components should be evaluated.
+         */
+        personalization: 'client' | 'server';
+        /**
+         * Configure where testing components should be evaluated.
+         */
+        testing: 'client' | 'server';
+    };
+    /**
+     * 😅
+     */
+    experimental?: {
+        /**
+         * Enables edge cache of redirects.
+         *
+         * @default false
+         */
+        edgeRedirects?: boolean;
+        /**
+         * Enables edge cache of compositions.
+         *
+         * @default false
+         */
+        edgeCompositions?: boolean;
+        /**
+         * Dynamic tokens names that should be used for localization.
+         */
+        localeDynamicInputs?: string[];
+        /**
+         * Enables visual editing mode.
+         */
+        vercelVisualEditing?: boolean;
+    };
+};
+
+declare const getServerConfig: () => UniformServerConfig;
+
 type PageParameters = {
     /**
      * The params object from Next.js router. Used to resolve a composition.
@@ -60,6 +130,10 @@ type AppDirectoryServerContext = Omit<AppDirectoryContext, 'update'> & {
     };
 };
 
+declare const createUniformContext: ({ serverCookieValue, ...rest }: Omit<ContextOptions, "transitionStore"> & {
+    serverCookieValue: string | undefined;
+}) => AppDirectoryContext;
+
 type PersonalizeProps = {
     trackingEventName: string;
     count: number | undefined;
@@ -92,4 +166,12 @@ declare const runTest: ({ test, component, contextInstance, }: TestProps & {
     index: number | null;
 };
 
-export { AppDirectoryContext, AppDirectoryContextState, AppDirectoryServerContext, ComponentProps, CompositionContext, PageParameters, PersonalizeProps, PersonalizeWithContextComponentProps, PlaygroundParameters, SlotDefinition, TestProps, runPersonalization, runTest };
+type ResolvePathResult = {
+    type: 'slug' | '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 };

package/dist/index.esm.js

@@ -1,3 +1,138 @@
+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.");
+  }
+};
+var processPath = (value) => {
+  const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
+  let joined = `/${Array.isArray(definedSlug) ? definedSlug.join("/") : definedSlug}`;
+  if (joined === "/index") {
+    joined = "/";
+  }
+  return joined;
+};
+var resolveSlugFromString = (originalSlug) => {
+  if (!originalSlug) {
+    return [""];
+  }
+  const slug = decodeURIComponent(originalSlug);
+  if (slug.includes("/")) {
+    return slug.split("/");
+  }
+  return [slug || ""];
+};
+var resolveSlugFromArray = (slug) => {
+  const slugPieces = [];
+  for (let i = 0; i < slug.length; i++) {
+    const decoded = decodeURIComponent(slug[i]);
+    if (decoded.includes("/")) {
+      slugPieces.push(...decoded.split("/"));
+    } else {
+      slugPieces.push(decoded);
+    }
+  }
+  return slugPieces;
+};
+
+// src/utils/url.ts
+function getBaseUrl() {
+  var _a;
+  if (process.env.VERCEL_URL) {
+    return `https://${process.env.VERCEL_URL}`;
+  }
+  if (process.env.RENDER_INTERNAL_HOSTNAME) {
+    return `http://${process.env.RENDER_INTERNAL_HOSTNAME}:${process.env.PORT}`;
+  }
+  return `http://localhost:${(_a = process.env.PORT) != null ? _a : 3e3}`;
+}
+
+// src/context/createUniformContext.ts
+var createUniformContext = ({
+  serverCookieValue,
+  ...rest
+}) => {
+  var _a;
+  const context = new Context({
+    ...rest,
+    defaultConsent: (_a = getServerConfig()) == null ? void 0 : _a.defaultConsent,
+    transitionStore: new CookieTransitionDataStore({
+      serverCookieValue
+    })
+  });
+  const appDirectoryContext = {
+    forget: (...props) => context.forget(...props),
+    getServerToClientTransitionState: () => context.getServerToClientTransitionState(),
+    getTestVariantId: (...props) => context.getTestVariantId(...props),
+    log: (...props) => context.log(...props),
+    personalize: (...props) => context.personalize(...props),
+    quirks: context.quirks,
+    setTestVariantId: (...props) => context.setTestVariantId(...props),
+    scores: context.scores,
+    test: (...props) => context.test(...props),
+    update: (update) => {
+      const { params, searchParams } = update;
+      const DEFAULT_URL = `${getBaseUrl()}/`;
+      let url = void 0;
+      if (params) {
+        const path = resolvePath({
+          params
+        });
+        if (!url) {
+          url = new URL(DEFAULT_URL);
+        }
+        url.pathname = path.value;
+      }
+      if (searchParams) {
+        Object.keys(searchParams).forEach((key) => {
+          const value = searchParams[key];
+          if (typeof value === "string") {
+            if (!url) {
+              url = new URL(DEFAULT_URL);
+            }
+            url.searchParams.set(key, value);
+          }
+        });
+      }
+      return context.update({
+        ...update,
+        url
+      });
+    }
+  };
+  return appDirectoryContext;
+};
+
 // src/runPersonalization.ts
 import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
 var runPersonalization = ({
@@ -87,6 +222,10 @@ var runTest = ({
   };
 };
 export {
+  createUniformContext,
+  getBaseUrl,
+  getServerConfig,
+  resolvePath,
   runPersonalization,
   runTest
 };

package/dist/index.js

@@ -20,11 +20,142 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 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.");
+  }
+};
+var processPath = (value) => {
+  const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
+  let joined = `/${Array.isArray(definedSlug) ? definedSlug.join("/") : definedSlug}`;
+  if (joined === "/index") {
+    joined = "/";
+  }
+  return joined;
+};
+var resolveSlugFromString = (originalSlug) => {
+  if (!originalSlug) {
+    return [""];
+  }
+  const slug = decodeURIComponent(originalSlug);
+  if (slug.includes("/")) {
+    return slug.split("/");
+  }
+  return [slug || ""];
+};
+var resolveSlugFromArray = (slug) => {
+  const slugPieces = [];
+  for (let i = 0; i < slug.length; i++) {
+    const decoded = decodeURIComponent(slug[i]);
+    if (decoded.includes("/")) {
+      slugPieces.push(...decoded.split("/"));
+    } else {
+      slugPieces.push(decoded);
+    }
+  }
+  return slugPieces;
+};
+
+// src/utils/url.ts
+function getBaseUrl() {
+  var _a;
+  if (process.env.VERCEL_URL) {
+    return `https://${process.env.VERCEL_URL}`;
+  }
+  if (process.env.RENDER_INTERNAL_HOSTNAME) {
+    return `http://${process.env.RENDER_INTERNAL_HOSTNAME}:${process.env.PORT}`;
+  }
+  return `http://localhost:${(_a = process.env.PORT) != null ? _a : 3e3}`;
+}
+
+// src/context/createUniformContext.ts
+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
+    })
+  });
+  const appDirectoryContext = {
+    forget: (...props) => context.forget(...props),
+    getServerToClientTransitionState: () => context.getServerToClientTransitionState(),
+    getTestVariantId: (...props) => context.getTestVariantId(...props),
+    log: (...props) => context.log(...props),
+    personalize: (...props) => context.personalize(...props),
+    quirks: context.quirks,
+    setTestVariantId: (...props) => context.setTestVariantId(...props),
+    scores: context.scores,
+    test: (...props) => context.test(...props),
+    update: (update) => {
+      const { params, searchParams } = update;
+      const DEFAULT_URL = `${getBaseUrl()}/`;
+      let url = void 0;
+      if (params) {
+        const path = resolvePath({
+          params
+        });
+        if (!url) {
+          url = new URL(DEFAULT_URL);
+        }
+        url.pathname = path.value;
+      }
+      if (searchParams) {
+        Object.keys(searchParams).forEach((key) => {
+          const value = searchParams[key];
+          if (typeof value === "string") {
+            if (!url) {
+              url = new URL(DEFAULT_URL);
+            }
+            url.searchParams.set(key, value);
+          }
+        });
+      }
+      return context.update({
+        ...update,
+        url
+      });
+    }
+  };
+  return appDirectoryContext;
+};
+
 // src/runPersonalization.ts
 var import_canvas = require("@uniformdev/canvas");
 var runPersonalization = ({
@@ -115,6 +246,10 @@ var runTest = ({
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  createUniformContext,
+  getBaseUrl,
+  getServerConfig,
+  resolvePath,
   runPersonalization,
   runTest
 });

package/dist/index.mjs

@@ -1,3 +1,138 @@
+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.");
+  }
+};
+var processPath = (value) => {
+  const definedSlug = !Array.isArray(value) ? resolveSlugFromString(value) : resolveSlugFromArray(value);
+  let joined = `/${Array.isArray(definedSlug) ? definedSlug.join("/") : definedSlug}`;
+  if (joined === "/index") {
+    joined = "/";
+  }
+  return joined;
+};
+var resolveSlugFromString = (originalSlug) => {
+  if (!originalSlug) {
+    return [""];
+  }
+  const slug = decodeURIComponent(originalSlug);
+  if (slug.includes("/")) {
+    return slug.split("/");
+  }
+  return [slug || ""];
+};
+var resolveSlugFromArray = (slug) => {
+  const slugPieces = [];
+  for (let i = 0; i < slug.length; i++) {
+    const decoded = decodeURIComponent(slug[i]);
+    if (decoded.includes("/")) {
+      slugPieces.push(...decoded.split("/"));
+    } else {
+      slugPieces.push(decoded);
+    }
+  }
+  return slugPieces;
+};
+
+// src/utils/url.ts
+function getBaseUrl() {
+  var _a;
+  if (process.env.VERCEL_URL) {
+    return `https://${process.env.VERCEL_URL}`;
+  }
+  if (process.env.RENDER_INTERNAL_HOSTNAME) {
+    return `http://${process.env.RENDER_INTERNAL_HOSTNAME}:${process.env.PORT}`;
+  }
+  return `http://localhost:${(_a = process.env.PORT) != null ? _a : 3e3}`;
+}
+
+// src/context/createUniformContext.ts
+var createUniformContext = ({
+  serverCookieValue,
+  ...rest
+}) => {
+  var _a;
+  const context = new Context({
+    ...rest,
+    defaultConsent: (_a = getServerConfig()) == null ? void 0 : _a.defaultConsent,
+    transitionStore: new CookieTransitionDataStore({
+      serverCookieValue
+    })
+  });
+  const appDirectoryContext = {
+    forget: (...props) => context.forget(...props),
+    getServerToClientTransitionState: () => context.getServerToClientTransitionState(),
+    getTestVariantId: (...props) => context.getTestVariantId(...props),
+    log: (...props) => context.log(...props),
+    personalize: (...props) => context.personalize(...props),
+    quirks: context.quirks,
+    setTestVariantId: (...props) => context.setTestVariantId(...props),
+    scores: context.scores,
+    test: (...props) => context.test(...props),
+    update: (update) => {
+      const { params, searchParams } = update;
+      const DEFAULT_URL = `${getBaseUrl()}/`;
+      let url = void 0;
+      if (params) {
+        const path = resolvePath({
+          params
+        });
+        if (!url) {
+          url = new URL(DEFAULT_URL);
+        }
+        url.pathname = path.value;
+      }
+      if (searchParams) {
+        Object.keys(searchParams).forEach((key) => {
+          const value = searchParams[key];
+          if (typeof value === "string") {
+            if (!url) {
+              url = new URL(DEFAULT_URL);
+            }
+            url.searchParams.set(key, value);
+          }
+        });
+      }
+      return context.update({
+        ...update,
+        url
+      });
+    }
+  };
+  return appDirectoryContext;
+};
+
 // src/runPersonalization.ts
 import { CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
 var runPersonalization = ({
@@ -87,6 +222,10 @@ var runTest = ({
   };
 };
 export {
+  createUniformContext,
+  getBaseUrl,
+  getServerConfig,
+  resolvePath,
   runPersonalization,
   runTest
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc-shared",
-  "version": "19.55.2-alpha.54+5c0508742",
+  "version": "19.55.2-alpha.60+f5039d327",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -32,8 +32,8 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.55.2-alpha.54+5c0508742",
-    "@uniformdev/context": "19.55.2-alpha.54+5c0508742"
+    "@uniformdev/canvas": "19.55.2-alpha.60+f5039d327",
+    "@uniformdev/context": "19.55.2-alpha.60+f5039d327"
   },
   "engines": {
     "node": ">=16.14.0"
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c0508742475c257e8e24003c4515dd06252045b"
+  "gitHead": "f5039d327b25d3ea6334791fb8e3a4ccdb6bc6da"
 }