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

package/dist/{UniformComposition-D4tBQ2U4.d.mts → UniformComposition-B-Z17dUt.d.mts}

@@ -36,6 +36,9 @@ type ResolveComponentFunction = (options: {
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
+    suspense?: {
+        fallback: ComponentType<any> | undefined;
+    };
 };
 declare const resolveComposition: (props: Omit<ResolveComponentsOptions, 'slotName' | 'slotIndex' | 'target'> & {
     composition: ComponentInstance;

package/dist/{UniformComposition-D4tBQ2U4.d.ts → UniformComposition-B-Z17dUt.d.ts}

@@ -36,6 +36,9 @@ type ResolveComponentFunction = (options: {
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
+    suspense?: {
+        fallback: ComponentType<any> | undefined;
+    };
 };
 declare const resolveComposition: (props: Omit<ResolveComponentsOptions, 'slotName' | 'slotIndex' | 'target'> & {
     composition: ComponentInstance;

package/dist/component.d.mts

@@ -1,7 +1,7 @@
 import { ComponentProps, CompositionContext, SlotDefinition } from '@uniformdev/canvas-next-rsc-shared';
 export { ComponentProps, CompositionContext } from '@uniformdev/canvas-next-rsc-shared';
 import React__default, { PropsWithChildren, ReactNode, Key } from 'react';
-export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-D4tBQ2U4.mjs';
+export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-B-Z17dUt.mjs';
 import { ComponentInstance } from '@uniformdev/canvas';
 import { RichTextNode } from '@uniformdev/richtext';
 import { PureUniformTextProps } from '@uniformdev/canvas-react/core';
@@ -55,6 +55,15 @@ declare const UniformRichText: React__default.ForwardRefExoticComponent<{
     component: ComponentInstance;
 } & Omit<React__default.HTMLAttributes<HTMLDivElement>, "children"> & React__default.RefAttributes<unknown>>;
 
+type UniformRichTextNodeProps = {
+    node: RichTextNode;
+    resolveRichTextRenderer?: RenderRichTextComponentResolver;
+};
+/**
+ * Render a single RichText node
+ */
+declare function UniformRichTextNode({ node, ...props }: UniformRichTextNodeProps): React__default.JSX.Element | null;
+
 type CustomSlotChildRenderFunc = (options: {
     child: ReactNode;
     component: ComponentInstance;
@@ -75,4 +84,4 @@ type UniformTextProps = {
 } & Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 declare const UniformText: ({ context, ...rest }: UniformTextProps) => React__default.JSX.Element;
 
-export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };
+export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };

package/dist/component.d.ts

@@ -1,7 +1,7 @@
 import { ComponentProps, CompositionContext, SlotDefinition } from '@uniformdev/canvas-next-rsc-shared';
 export { ComponentProps, CompositionContext } from '@uniformdev/canvas-next-rsc-shared';
 import React__default, { PropsWithChildren, ReactNode, Key } from 'react';
-export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-D4tBQ2U4.js';
+export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-B-Z17dUt.js';
 import { ComponentInstance } from '@uniformdev/canvas';
 import { RichTextNode } from '@uniformdev/richtext';
 import { PureUniformTextProps } from '@uniformdev/canvas-react/core';
@@ -55,6 +55,15 @@ declare const UniformRichText: React__default.ForwardRefExoticComponent<{
     component: ComponentInstance;
 } & Omit<React__default.HTMLAttributes<HTMLDivElement>, "children"> & React__default.RefAttributes<unknown>>;
 
+type UniformRichTextNodeProps = {
+    node: RichTextNode;
+    resolveRichTextRenderer?: RenderRichTextComponentResolver;
+};
+/**
+ * Render a single RichText node
+ */
+declare function UniformRichTextNode({ node, ...props }: UniformRichTextNodeProps): React__default.JSX.Element | null;
+
 type CustomSlotChildRenderFunc = (options: {
     child: ReactNode;
     component: ComponentInstance;
@@ -75,4 +84,4 @@ type UniformTextProps = {
 } & Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 declare const UniformText: ({ context, ...rest }: UniformTextProps) => React__default.JSX.Element;
 
-export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };
+export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, UniformRichTextNode, type UniformRichTextNodeProps, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };

package/dist/component.js

@@ -32,6 +32,7 @@ var component_exports = {};
 __export(component_exports, {
   DefaultNotImplementedComponent: () => DefaultNotImplementedComponent,
   UniformRichText: () => UniformRichText,
+  UniformRichTextNode: () => UniformRichTextNode,
   UniformSlot: () => UniformSlot,
   UniformText: () => UniformText,
   createClientUniformContext: () => import_canvas_next_rsc_client.createClientUniformContext,
@@ -212,6 +213,7 @@ var import_canvas_next_rsc_client = require("@uniformdev/canvas-next-rsc-client"
 0 && (module.exports = {
   DefaultNotImplementedComponent,
   UniformRichText,
+  UniformRichTextNode,
   UniformSlot,
   UniformText,
   createClientUniformContext,

package/dist/component.mjs

@@ -176,6 +176,7 @@ import {
 export {
   DefaultNotImplementedComponent,
   UniformRichText,
+  UniformRichTextNode,
   UniformSlot,
   UniformText,
   createClientUniformContext,

package/dist/handler.js

@@ -228,6 +228,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") {
@@ -259,7 +260,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
@@ -282,7 +283,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: {
@@ -301,6 +302,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") {
@@ -328,7 +330,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: {
@@ -382,6 +384,7 @@ var processCompositionChange = async (compositionId) => {
     getComposition({ compositionId })
   ]);
   const tags = [];
+  const paths = [];
   if (composition == null ? void 0 : composition.pattern) {
     tags.push("route");
   }
@@ -391,12 +394,17 @@ var processCompositionChange = async (compositionId) => {
       await processEdgeConfigChange({
         source_url: node.path
       });
-      tags.push(...buildProjectMapNodePaths(node.path));
+      const result = buildProjectMapNodePaths(node.path);
+      tags.push(...result.tags);
+      if (result.paths) {
+        paths.push(...result.paths);
+      }
     }
   }
   tags.push(buildCompositionTag(compositionId));
   return {
-    tags
+    tags,
+    paths
   };
 };
 var getComposition = async ({ compositionId }) => {
@@ -419,9 +427,11 @@ var getComposition = async ({ compositionId }) => {
 };
 var buildProjectMapNodePaths = (path) => {
   const tags = [];
+  const paths = [];
   const isDynamic = path.includes(":");
   if (!isDynamic) {
     tags.push(buildPathTag(path));
+    paths.push(path);
   } else {
     const pieces = path.split("/");
     const invalidatePieces = [];
@@ -434,8 +444,12 @@ var buildProjectMapNodePaths = (path) => {
     }
     const toInvalidate = invalidatePieces.join("/");
     tags.push(buildPathTag(toInvalidate));
+    paths.push(toInvalidate);
   }
-  return tags;
+  return {
+    tags,
+    paths
+  };
 };
 var getPathName = (url) => {
   try {
@@ -450,7 +464,8 @@ var processRedirectChange = async (sourceUrl) => {
   const pathName = getPathName(sourceUrl);
   tags.push(buildPathTag(pathName));
   return {
-    tags
+    tags,
+    paths: [pathName]
   };
 };
 var processEdgeConfigChange = async ({ source_url }) => {
@@ -557,7 +572,12 @@ var handleProjectMapNodeDelete = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
+  const paths = [];
+  const result = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...result.tags);
+  if (result.paths) {
+    paths.push(...result.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -565,7 +585,8 @@ var handleProjectMapNodeDelete = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -578,7 +599,12 @@ var handleProjectMapNodeInsert = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
+  const paths = [];
+  const result = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...result.tags);
+  if (result.paths) {
+    paths.push(...result.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -586,7 +612,8 @@ var handleProjectMapNodeInsert = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -599,8 +626,17 @@ var handleProjectMapNodeUpdate = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
-  tags.push(...buildProjectMapNodePaths(parsed.data.previous_path));
+  const paths = [];
+  const currentResult = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...currentResult.tags);
+  if (currentResult.paths) {
+    paths.push(...currentResult.paths);
+  }
+  const previousResult = buildProjectMapNodePaths(parsed.data.previous_path);
+  tags.push(...previousResult.tags);
+  if (previousResult.paths) {
+    paths.push(...previousResult.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -608,7 +644,8 @@ var handleProjectMapNodeUpdate = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -703,6 +740,7 @@ var handleSvixMessage = async (request) => {
     handleManifestPublished
   ];
   let tags = void 0;
+  let paths = void 0;
   let jsonBody;
   try {
     jsonBody = await request.json();
@@ -715,6 +753,7 @@ var handleSvixMessage = async (request) => {
     const result = await handler(jsonBody);
     if (result) {
       tags = result.tags;
+      paths = result.paths;
       break;
     }
   }
@@ -724,10 +763,17 @@ var handleSvixMessage = async (request) => {
       (0, import_cache.revalidateTag)(tag);
     }
   }
+  if (paths == null ? void 0 : paths.length) {
+    for (let i = 0; i < paths.length; i++) {
+      const path = paths[i];
+      (0, import_cache.revalidatePath)(path);
+    }
+  }
   return new Response(
     JSON.stringify({
-      handled: typeof tags !== "undefined",
-      tags
+      handled: typeof tags !== "undefined" || typeof paths !== "undefined",
+      tags,
+      paths
     })
   );
 };

package/dist/handler.mjs

@@ -142,7 +142,7 @@ var createPreviewOPTIONSRouteHandler = () => {
 
 // src/handler/createPreviewPOSTRouteHandler.ts
 import { SECRET_QUERY_STRING_PARAM as SECRET_QUERY_STRING_PARAM2 } from "@uniformdev/canvas";
-import { revalidateTag } from "next/cache";
+import { revalidatePath, revalidateTag } from "next/cache";
 
 // src/handler/helpers.ts
 import { ApiClientError } from "@uniformdev/canvas";
@@ -213,6 +213,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") {
@@ -244,7 +245,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
@@ -267,7 +268,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: {
@@ -286,6 +287,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") {
@@ -313,7 +315,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: {
@@ -367,6 +369,7 @@ var processCompositionChange = async (compositionId) => {
     getComposition({ compositionId })
   ]);
   const tags = [];
+  const paths = [];
   if (composition == null ? void 0 : composition.pattern) {
     tags.push("route");
   }
@@ -376,12 +379,17 @@ var processCompositionChange = async (compositionId) => {
       await processEdgeConfigChange({
         source_url: node.path
       });
-      tags.push(...buildProjectMapNodePaths(node.path));
+      const result = buildProjectMapNodePaths(node.path);
+      tags.push(...result.tags);
+      if (result.paths) {
+        paths.push(...result.paths);
+      }
     }
   }
   tags.push(buildCompositionTag(compositionId));
   return {
-    tags
+    tags,
+    paths
   };
 };
 var getComposition = async ({ compositionId }) => {
@@ -404,9 +412,11 @@ var getComposition = async ({ compositionId }) => {
 };
 var buildProjectMapNodePaths = (path) => {
   const tags = [];
+  const paths = [];
   const isDynamic = path.includes(":");
   if (!isDynamic) {
     tags.push(buildPathTag(path));
+    paths.push(path);
   } else {
     const pieces = path.split("/");
     const invalidatePieces = [];
@@ -419,8 +429,12 @@ var buildProjectMapNodePaths = (path) => {
     }
     const toInvalidate = invalidatePieces.join("/");
     tags.push(buildPathTag(toInvalidate));
+    paths.push(toInvalidate);
   }
-  return tags;
+  return {
+    tags,
+    paths
+  };
 };
 var getPathName = (url) => {
   try {
@@ -435,7 +449,8 @@ var processRedirectChange = async (sourceUrl) => {
   const pathName = getPathName(sourceUrl);
   tags.push(buildPathTag(pathName));
   return {
-    tags
+    tags,
+    paths: [pathName]
   };
 };
 var processEdgeConfigChange = async ({ source_url }) => {
@@ -542,7 +557,12 @@ var handleProjectMapNodeDelete = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
+  const paths = [];
+  const result = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...result.tags);
+  if (result.paths) {
+    paths.push(...result.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -550,7 +570,8 @@ var handleProjectMapNodeDelete = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -563,7 +584,12 @@ var handleProjectMapNodeInsert = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
+  const paths = [];
+  const result = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...result.tags);
+  if (result.paths) {
+    paths.push(...result.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -571,7 +597,8 @@ var handleProjectMapNodeInsert = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -584,8 +611,17 @@ var handleProjectMapNodeUpdate = async (body) => {
     return void 0;
   }
   const tags = [];
-  tags.push(...buildProjectMapNodePaths(parsed.data.path));
-  tags.push(...buildProjectMapNodePaths(parsed.data.previous_path));
+  const paths = [];
+  const currentResult = buildProjectMapNodePaths(parsed.data.path);
+  tags.push(...currentResult.tags);
+  if (currentResult.paths) {
+    paths.push(...currentResult.paths);
+  }
+  const previousResult = buildProjectMapNodePaths(parsed.data.previous_path);
+  tags.push(...previousResult.tags);
+  if (previousResult.paths) {
+    paths.push(...previousResult.paths);
+  }
   const config = getServerConfig();
   if ((_a = config.experimental) == null ? void 0 : _a.edgeCompositions) {
     await processEdgeConfigChange({
@@ -593,7 +629,8 @@ var handleProjectMapNodeUpdate = async (body) => {
     });
   }
   return {
-    tags
+    tags,
+    paths
   };
 };
 
@@ -688,6 +725,7 @@ var handleSvixMessage = async (request) => {
     handleManifestPublished
   ];
   let tags = void 0;
+  let paths = void 0;
   let jsonBody;
   try {
     jsonBody = await request.json();
@@ -700,6 +738,7 @@ var handleSvixMessage = async (request) => {
     const result = await handler(jsonBody);
     if (result) {
       tags = result.tags;
+      paths = result.paths;
       break;
     }
   }
@@ -709,10 +748,17 @@ var handleSvixMessage = async (request) => {
       revalidateTag(tag);
     }
   }
+  if (paths == null ? void 0 : paths.length) {
+    for (let i = 0; i < paths.length; i++) {
+      const path = paths[i];
+      revalidatePath(path);
+    }
+  }
   return new Response(
     JSON.stringify({
-      handled: typeof tags !== "undefined",
-      tags
+      handled: typeof tags !== "undefined" || typeof paths !== "undefined",
+      tags,
+      paths
     })
   );
 };

package/dist/index.d.mts

@@ -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.mjs';
-export { a as UniformComposition, r as resolveComposition } from './UniformComposition-D4tBQ2U4.mjs';
+import { U as UniformCompositionProps } from './UniformComposition-B-Z17dUt.mjs';
+export { a as UniformComposition, r as resolveComposition } from './UniformComposition-B-Z17dUt.mjs';
 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 };