@uniformdev/canvas-next-rsc 19.158.0 → 19.159.1-alpha.9

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-import { CanvasClient, RouteClient, ResolvedRouteGetResponse, RouteGetParameters } from '@uniformdev/canvas';
-import { CacheMode, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
+import { CanvasClient, RouteClient, ResolvedRouteGetResponse, CompositionGetBySlugParameters, RouteGetParameters } from '@uniformdev/canvas';
+import { UniformServerConfig, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
 export { PageParameters, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
 import { ManifestClient } from '@uniformdev/context/api';
 import { ProjectMapClient, ProjectMapNode } from '@uniformdev/project-map';
 import { ContextState, ContextOptions } from '@uniformdev/context';
 import React__default, { PropsWithChildren } from 'react';
-import { U as UniformCompositionProps } from './UniformComposition-D4tBQ2U4.js';
-export { a as UniformComposition, r as resolveComposition } from './UniformComposition-D4tBQ2U4.js';
+import { U as UniformCompositionProps } from './UniformComposition-B-Z17dUt.js';
+export { a as UniformComposition, r as resolveComposition } from './UniformComposition-B-Z17dUt.js';
 import { ClientContextComponent } from '@uniformdev/canvas-next-rsc-client';
 
 type GetCanvasClientOptions = {
-    cache: CacheMode;
+    cache: NonNullable<UniformServerConfig['canvasCache']>;
 };
 declare const getCanvasClient: (options: GetCanvasClientOptions) => CanvasClient;
 declare const getDefaultCanvasClient: ({ searchParams, }: {
@@ -18,7 +18,7 @@ declare const getDefaultCanvasClient: ({ searchParams, }: {
 }) => CanvasClient;
 
 type GetManifestClientOptions = {
-    cache: CacheMode;
+    cache: NonNullable<UniformServerConfig['manifestCache']>;
 };
 declare const getManifestClient: (options: GetManifestClientOptions) => ManifestClient;
 declare const getDefaultManifestClient: ({ searchParams, }: {
@@ -183,7 +183,7 @@ declare const getManifest: ({ searchParams }: {
 }>;
 
 type GetProjectMapClientOptions = {
-    cache: CacheMode;
+    cache: NonNullable<UniformServerConfig['projectMapCache']>;
 };
 declare const getProjectMapClient: (options: GetProjectMapClientOptions) => ProjectMapClient;
 declare const getDefaultProjectMapClient: ({ searchParams, }: {
@@ -191,7 +191,7 @@ declare const getDefaultProjectMapClient: ({ searchParams, }: {
 }) => ProjectMapClient;
 
 type GetRouteClientOptions = {
-    cache: CacheMode;
+    cache: NonNullable<UniformServerConfig['canvasCache']>;
 };
 declare const getRouteClient: (options: GetRouteClientOptions) => RouteClient;
 declare const getDefaultRouteClient: ({ searchParams }: {
@@ -243,7 +243,7 @@ declare const isIncontextEditingEnabled: ({ searchParams, }: {
 declare const isOnVercelPreviewEnvironment: () => boolean;
 declare const isDevelopmentEnvironment: () => boolean;
 
-type RetrieveRouteOptions = PageParameters & {
+type RetrieveCommonOptions = {
     /**
      * If true, the manifest will not be prefetched.
      *
@@ -251,7 +251,17 @@ type RetrieveRouteOptions = PageParameters & {
      */
     skipPrefetch?: boolean;
 };
+type RetrieveRouteOptions = PageParameters & RetrieveCommonOptions;
+type RetrieveSlugOptions = Pick<CompositionGetBySlugParameters, 'slug' | 'locale' | 'releaseId' | 'versionId'> & {
+    /**
+     * The searchParams object from Next.js router. Used for signal evaluation.
+     */
+    searchParams?: {
+        [key: string]: string | undefined;
+    };
+} & RetrieveCommonOptions;
 type RetrieveRouteFetchOptions = Omit<RouteGetParameters, 'projectId' | 'path' | 'withComponentIDs' | 'withContentSourceMap' | 'state'>;
+declare const retrieveCompositionBySlug: ({ slug, searchParams, skipPrefetch, locale, releaseId, versionId, }: RetrieveSlugOptions) => Promise<ResolvedRouteGetResponse>;
 declare const retrieveRoute: ({ params, searchParams, skipPrefetch }: RetrieveRouteOptions, fetchOptions?: RetrieveRouteFetchOptions) => Promise<ResolvedRouteGetResponse>;
 
-export { ContextUpdateTransfer, type ContextUpdateTransferProps, type CreateServerUniformContextProps, type CreateStaticParamsOptions, type GetCanvasClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, UniformCompositionProps, UniformContext, type UniformContextProps, UniformPlayground, type UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment, retrieveRoute };
+export { ContextUpdateTransfer, type ContextUpdateTransferProps, type CreateServerUniformContextProps, type CreateStaticParamsOptions, type GetCanvasClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, UniformCompositionProps, UniformContext, type UniformContextProps, UniformPlayground, type UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment, retrieveCompositionBySlug, retrieveRoute };

package/dist/index.esm.js

@@ -77,7 +77,8 @@ var getCanvasCacheStrategy = (options) => {
       return config.canvasCache;
     }
     return {
-      type: "no-cache"
+      type: "no-cache",
+      bypassCache: true
     };
   }
   if (config.canvasCache) {
@@ -174,6 +175,7 @@ var getCanvasClient = (options) => {
     apiHost: env.getApiHost(),
     apiKey: env.getApiKey(),
     edgeApiHost: env.getEdgeApiHost(),
+    disableSWR: typeof options.cache.disableSWR !== "undefined" ? options.cache.disableSWR : true,
     fetch: (req, init) => {
       let requestedUrl;
       if (typeof req === "string") {
@@ -205,7 +207,7 @@ var getCanvasClient = (options) => {
         cache,
         headers: {
           ...init == null ? void 0 : init.headers,
-          "x-bypass-cache": "true"
+          "x-bypass-cache": typeof options.cache.bypassCache !== "undefined" ? options.cache.bypassCache.toString() : "false"
         },
         next: {
           revalidate
@@ -237,7 +239,7 @@ var getManifestClient = (options) => {
         ...init,
         headers: {
           ...init == null ? void 0 : init.headers,
-          "x-bypass-cache": "true"
+          "x-bypass-cache": typeof options.cache.bypassCache !== "undefined" ? options.cache.bypassCache.toString() : "false"
         },
         cache,
         next: {
@@ -278,7 +280,7 @@ var getProjectMapClient = (options) => {
         ...init,
         headers: {
           ...init == null ? void 0 : init.headers,
-          "x-bypass-cache": "true"
+          "x-bypass-cache": typeof options.cache.bypassCache !== "undefined" ? options.cache.bypassCache.toString() : "false"
         },
         cache,
         next: {
@@ -306,6 +308,7 @@ var getRouteClient = (options) => {
     projectId: env.getProjectId(),
     apiKey: env.getApiKey(),
     edgeApiHost: env.getEdgeApiHost(),
+    disableSWR: typeof options.cache.disableSWR !== "undefined" ? options.cache.disableSWR : true,
     fetch: (req, init) => {
       let requestedUrl;
       if (typeof req === "string") {
@@ -333,7 +336,7 @@ var getRouteClient = (options) => {
         ...init,
         headers: {
           ...init == null ? void 0 : init.headers,
-          "x-bypass-cache": "true"
+          "x-bypass-cache": typeof options.cache.bypassCache !== "undefined" ? options.cache.bypassCache.toString() : "false"
         },
         cache,
         next: {
@@ -420,7 +423,7 @@ import {
 import { PureContextualEditingComponentWrapper } from "@uniformdev/canvas-react/core";
 import { cookies as cookies2, headers } from "next/headers";
 import { notFound, redirect } from "next/navigation";
-import { createElement as createElement3, Fragment as Fragment3 } from "react";
+import { createElement as createElement3, Fragment as Fragment3, Suspense } from "react";
 
 // src/context/createServerUniformContext.ts
 import {
@@ -458,13 +461,62 @@ import {
 } from "@uniformdev/canvas";
 import { getBaseUrl, resolvePath } from "@uniformdev/canvas-next-rsc-shared";
 import { getTargetVariableExpandedUrl } from "@uniformdev/redirect";
+var retrieveCompositionBySlug = async ({
+  slug,
+  searchParams,
+  skipPrefetch,
+  locale,
+  releaseId,
+  versionId
+}) => {
+  var _a;
+  if (!skipPrefetch) {
+    void getManifest({
+      searchParams
+    });
+  }
+  let result;
+  const states = determineState({
+    searchParams
+  });
+  for (let i = 0; i < states.length; i++) {
+    const state = states[i];
+    const canvasClient = getDefaultCanvasClient({
+      searchParams
+    });
+    try {
+      const composition = await canvasClient.getCompositionBySlug({
+        slug,
+        state,
+        withComponentIDs: true,
+        withContentSourceMap: isOnVercelPreviewEnvironment() && ((_a = getServerConfig().experimental) == null ? void 0 : _a.vercelVisualEditing),
+        locale,
+        releaseId,
+        versionId
+      });
+      result = {
+        type: "composition",
+        compositionApiResponse: composition,
+        matchedRoute: "slug"
+      };
+    } catch (e) {
+      console.warn(`Failed to retrieve composition by slug: ${slug} with state ${state}`, e);
+    }
+    if ((result == null ? void 0 : result.type) !== "notFound") {
+      break;
+    }
+  }
+  return result || {
+    type: "notFound"
+  };
+};
 var retrieveRoute = async ({ params, searchParams, skipPrefetch }, fetchOptions) => {
   if (!skipPrefetch) {
     void getManifest({
       searchParams
     });
   }
-  const { type, value } = resolvePath({
+  const { value } = resolvePath({
     params
   });
   const states = determineState({
@@ -473,34 +525,15 @@ var retrieveRoute = async ({ params, searchParams, skipPrefetch }, fetchOptions)
   let result;
   for (let i = 0; i < states.length; i++) {
     const state = states[i];
-    if (type === "path") {
-      try {
-        result = await retrieveRouteByPath({
-          path: value,
-          state,
-          searchParams,
-          fetchOptions
-        });
-      } catch (e) {
-        console.warn(`Failed to retrieve route by path: ${value} with state ${state}`, e);
-      }
-    } else if (type === "slug") {
-      const canvasClient = getDefaultCanvasClient({
-        searchParams
+    try {
+      result = await retrieveRouteByPath({
+        path: value,
+        state,
+        searchParams,
+        fetchOptions
       });
-      try {
-        const composition = await canvasClient.getCompositionBySlug({
-          slug: value,
-          state
-        });
-        result = {
-          type: "composition",
-          compositionApiResponse: composition,
-          matchedRoute: "slug"
-        };
-      } catch (e) {
-        console.warn(`Failed to retrieve composition by slug: ${value} with state ${state}`, e);
-      }
+    } catch (e) {
+      console.warn(`Failed to retrieve route by path: ${value} with state ${state}`, e);
     }
     if ((result == null ? void 0 : result.type) !== "notFound") {
       break;
@@ -585,6 +618,7 @@ var PersonalizeClientWrapper = (props) => {
 // src/components/PersonalizeServer.ts
 import { CANVAS_PERSONALIZE_SLOT } from "@uniformdev/canvas";
 import { runPersonalization as runPersonalization2 } from "@uniformdev/canvas-next-rsc-shared";
+import { unstable_noStore as noStore } from "next/cache";
 import { createElement, Fragment } from "react";
 
 // src/components/ContextPersonalizationTransfer.tsx
@@ -596,15 +630,19 @@ var ContextPersonalizationTransfer = ({ event }) => {
 
 // src/components/PersonalizeServer.ts
 var PersonalizeServer = (props) => {
-  var _a;
+  var _a, _b;
+  if ((_a = getServerConfig().ppr) == null ? void 0 : _a.personalizationSuspense) {
+    noStore();
+  }
   const { indexes, event } = runPersonalization2(props);
-  const slot = (_a = props.slots) == null ? void 0 : _a[CANVAS_PERSONALIZE_SLOT];
+  const slot = (_b = props.slots) == null ? void 0 : _b[CANVAS_PERSONALIZE_SLOT];
   const components = indexes.map((index) => {
     const component = slot.items[index];
     return component;
   });
   const eventElement = createElement(ContextPersonalizationTransfer, {
-    event
+    event,
+    key: `${props.slotName}-${props.slotIndex}-personalization-transfer`
   });
   return createElement(Fragment, void 0, [...components, eventElement]);
 };
@@ -614,6 +652,7 @@ import { CANVAS_TEST_SLOT } from "@uniformdev/canvas";
 import {
   runTest
 } from "@uniformdev/canvas-next-rsc-shared";
+import { unstable_noStore as noStore2 } from "next/cache";
 import { createElement as createElement2, Fragment as Fragment2 } from "react";
 
 // src/components/ContextTestTransfer.tsx
@@ -624,17 +663,24 @@ var ContextTestTransfer = ({ event }) => {
 };
 
 // src/components/TestServer.ts
-var TestServer = (props) => {
-  var _a, _b, _c, _d;
+var TestServer = async (props) => {
+  var _a, _b, _c, _d, _e;
+  if ((_a = getServerConfig().ppr) == null ? void 0 : _a.testSuspense) {
+    noStore2();
+  }
   const { contextInstance, test } = props;
-  const isTestDefined = Boolean((_a = contextInstance.manifest.data.project.test) == null ? void 0 : _a[test]);
+  const isTestDefined = Boolean((_b = contextInstance.manifest.data.project.test) == null ? void 0 : _b[test]);
   if (!isTestDefined && process.env.NODE_ENV !== "production") {
     console.warn(`Test "${test}" is not defined in Uniform manifest.`);
   }
   const { index, event } = runTest(props);
-  const component = typeof index === "number" ? (_d = (_c = (_b = props.slots) == null ? void 0 : _b[CANVAS_TEST_SLOT]) == null ? void 0 : _c.items[index]) != null ? _d : null : null;
+  if (index === null || event === null) {
+    return null;
+  }
+  const component = typeof index === "number" ? (_e = (_d = (_c = props.slots) == null ? void 0 : _c[CANVAS_TEST_SLOT]) == null ? void 0 : _d.items[index]) != null ? _e : null : null;
   const eventElement = createElement2(ContextTestTransfer, {
-    event
+    event,
+    key: `${props.slotName}-${props.slotIndex}-server-transfer`
   });
   return createElement2(Fragment2, void 0, [component, eventElement]);
 };
@@ -738,19 +784,24 @@ var isServerComponent = ({
 };
 var resolveSystemComponent = ({
   component,
-  serverContext
+  server
 }) => {
-  const server = isServerComponent({
-    component,
-    serverContext
-  });
+  var _a, _b;
+  const config = getServerConfig();
+  let resolved = null;
+  let suspense = void 0;
   if (component.type === CANVAS_PERSONALIZE_TYPE) {
-    return server ? PersonalizeServer : PersonalizeClientWrapper;
+    resolved = server ? PersonalizeServer : PersonalizeClientWrapper;
+    suspense = server && ((_a = config.ppr) == null ? void 0 : _a.personalizationSuspense);
   }
   if (component.type === CANVAS_TEST_TYPE) {
-    return server ? TestServer : TestClient;
+    resolved = server ? TestServer : TestClient;
+    suspense = server && ((_b = config.ppr) == null ? void 0 : _b.testSuspense);
   }
-  return null;
+  return {
+    component: resolved,
+    suspense
+  };
 };
 var resolveSlots = ({
   component,
@@ -827,11 +878,15 @@ var resolveComponents = ({
       component,
       serverContext
     });
-    const systemComponent = resolveSystemComponent({
+    const { component: systemComponent, suspense: systemSuspense } = resolveSystemComponent({
       component,
-      serverContext
+      server: isServer
     });
-    const { component: regularComponent, includeContext } = resolveComponent({ component }) || {
+    const {
+      component: regularComponent,
+      includeContext,
+      suspense: componentSuspense
+    } = resolveComponent({ component }) || {
       component: null
     };
     if (!systemComponent && !regularComponent) {
@@ -846,10 +901,11 @@ var resolveComponents = ({
       mode
     });
     const resolvedComponent = systemComponent || regularComponent;
+    const wrapInSuspense = systemSuspense || componentSuspense;
     const parameters = (_a = component.parameters) != null ? _a : {};
     const enrichmentTags = (_b = parameters[CANVAS_ENRICHMENT_TAG_PARAM]) == null ? void 0 : _b.value;
+    const key = `${slotName}-${componentIndex}-component`;
     const componentProps = {
-      key: `${slotName}-${componentIndex}-component`,
       ...Object.keys(parameters).reduce((acc, cur) => {
         acc[cur] = parameters[cur].value;
         return acc;
@@ -861,7 +917,19 @@ var resolveComponents = ({
       slotName,
       slotIndex: isRoot ? void 0 : componentIndex
     };
-    const element = createElement3(resolvedComponent, componentProps);
+    let element = null;
+    if (wrapInSuspense) {
+      element = createElement3(
+        Suspense,
+        {
+          key,
+          fallback: typeof wrapInSuspense === "boolean" || typeof (wrapInSuspense == null ? void 0 : wrapInSuspense.fallback) === "undefined" ? void 0 : createElement3(wrapInSuspense.fallback)
+        },
+        createElement3(resolvedComponent, componentProps)
+      );
+    } else {
+      element = createElement3(resolvedComponent, { ...componentProps, key });
+    }
     let tagElement = null;
     if (enrichmentTags == null ? void 0 : enrichmentTags.length) {
       tagElement = createElement3(ContextUpdateTransfer, {
@@ -935,7 +1003,7 @@ import {
   DefaultUniformClientContext,
   UniformScript
 } from "@uniformdev/canvas-next-rsc-client";
-import { Suspense } from "react";
+import { Suspense as Suspense2 } from "react";
 import React6 from "react";
 var UniformContext = async ({
   clientContextComponent,
@@ -956,7 +1024,7 @@ var UniformContext = async ({
       disableDevTools,
       defaultConsent
     }
-  ), /* @__PURE__ */ React6.createElement(Suspense, { fallback: /* @__PURE__ */ React6.createElement(React6.Fragment, null) }, /* @__PURE__ */ React6.createElement(UniformScript, null)));
+  ), /* @__PURE__ */ React6.createElement(Suspense2, { fallback: /* @__PURE__ */ React6.createElement(React6.Fragment, null) }, /* @__PURE__ */ React6.createElement(UniformScript, null)));
 };
 
 // src/components/UniformPlayground.tsx
@@ -1033,5 +1101,6 @@ export {
   isIncontextEditingEnabled,
   isOnVercelPreviewEnvironment,
   resolveComposition,
+  retrieveCompositionBySlug,
   retrieveRoute
 };