@uniformdev/canvas-next-rsc 19.147.1-alpha.5 → 19.147.1-alpha.7

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { CanvasClient, RouteClient, ResolvedRouteGetResponse, RouteGetParameters } from '@uniformdev/canvas';
+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';
@@ -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.d.ts

@@ -1,4 +1,4 @@
-import { CanvasClient, RouteClient, ResolvedRouteGetResponse, RouteGetParameters } from '@uniformdev/canvas';
+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';
@@ -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

@@ -460,13 +460,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({
@@ -475,34 +524,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;
@@ -1070,5 +1100,6 @@ export {
   isIncontextEditingEnabled,
   isOnVercelPreviewEnvironment,
   resolveComposition,
+  retrieveCompositionBySlug,
   retrieveRoute
 };

package/dist/index.js

@@ -51,6 +51,7 @@ __export(src_exports, {
   isIncontextEditingEnabled: () => isIncontextEditingEnabled,
   isOnVercelPreviewEnvironment: () => isOnVercelPreviewEnvironment,
   resolveComposition: () => resolveComposition,
+  retrieveCompositionBySlug: () => retrieveCompositionBySlug,
   retrieveRoute: () => retrieveRoute
 });
 module.exports = __toCommonJS(src_exports);
@@ -491,13 +492,62 @@ var createServerUniformContextFromManifest = async (options) => {
 var import_canvas4 = require("@uniformdev/canvas");
 var import_canvas_next_rsc_shared2 = require("@uniformdev/canvas-next-rsc-shared");
 var import_redirect = require("@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 } = (0, import_canvas_next_rsc_shared2.resolvePath)({
+  const { value } = (0, import_canvas_next_rsc_shared2.resolvePath)({
     params
   });
   const states = determineState({
@@ -506,34 +556,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;
@@ -1097,5 +1128,6 @@ var UniformPlayground = async ({ searchParams, ...rest }) => {
   isIncontextEditingEnabled,
   isOnVercelPreviewEnvironment,
   resolveComposition,
+  retrieveCompositionBySlug,
   retrieveRoute
 });

package/dist/index.mjs

@@ -460,13 +460,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({
@@ -475,34 +524,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;
@@ -1070,5 +1100,6 @@ export {
   isIncontextEditingEnabled,
   isOnVercelPreviewEnvironment,
   resolveComposition,
+  retrieveCompositionBySlug,
   retrieveRoute
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc",
-  "version": "19.147.1-alpha.5+fd42f9399d",
+  "version": "19.147.1-alpha.7+28bb27296b",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -61,15 +61,15 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/canvas-next-rsc-client": "^19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/canvas-next-rsc-shared": "^19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/canvas-react": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/context": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/project-map": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/redirect": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/richtext": "19.147.1-alpha.5+fd42f9399d",
-    "@uniformdev/webhooks": "19.147.1-alpha.5+fd42f9399d",
+    "@uniformdev/canvas": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/canvas-next-rsc-client": "^19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/canvas-next-rsc-shared": "^19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/canvas-react": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/context": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/project-map": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/redirect": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/richtext": "19.147.1-alpha.7+28bb27296b",
+    "@uniformdev/webhooks": "19.147.1-alpha.7+28bb27296b",
     "@vercel/edge-config": "^0.4.0",
     "encoding": "^0.1.13",
     "server-only": "^0.0.1",
@@ -86,5 +86,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fd42f9399d22a39666b01163b53c2eab646081d2"
+  "gitHead": "28bb27296bbf7b66680eab516958fef155d59aa4"
 }