@uniformdev/canvas-next-rsc 19.75.2-alpha.2 → 19.76.0

package/README.md

@@ -1,5 +1,5 @@
-Next.js RSC SDK for Uniform Canvas
+Next.js RSC SDK for Uniform
 
-**Note:** This package is in public preview.
+To get started, follow our [Getting Started](https://docs.uniform.app/docs/learn/tutorials/nextjs-app-router) guide.
 
 part of the [Uniform Platform](https://uniform.app). See our [documentation](https://docs.uniform.app) for more details.

package/dist/index.d.mts

@@ -240,6 +240,14 @@ declare const isIncontextEditingEnabled: ({ searchParams, }: {
 declare const isOnVercelPreviewEnvironment: () => boolean;
 declare const isDevelopmentEnvironment: () => boolean;
 
-declare const retrieveRoute: ({ params, searchParams, }: Pick<PageParameters, 'params' | 'searchParams'>) => Promise<ResolvedRouteGetResponse>;
+type RetrieveRouteOptions = PageParameters & {
+    /**
+     * If true, the manifest will not be prefetched.
+     *
+     * Prefetching allows the manifest to begin loading while the route data is being retrieved.
+     */
+    skipPrefetch?: boolean;
+};
+declare const retrieveRoute: ({ params, searchParams, skipPrefetch, }: RetrieveRouteOptions) => Promise<ResolvedRouteGetResponse>;
 
 export { ContextUpdateTransfer, ContextUpdateTransferProps, CreateServerUniformContextProps, CreateStaticParamsOptions, GetCanvasClientOptions, GetManifestClientOptions, GetProjectMapClientOptions, GetRouteClientOptions, UniformCompositionProps, UniformContext, UniformContextProps, UniformPlayground, UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment, retrieveRoute };

package/dist/index.d.ts

@@ -240,6 +240,14 @@ declare const isIncontextEditingEnabled: ({ searchParams, }: {
 declare const isOnVercelPreviewEnvironment: () => boolean;
 declare const isDevelopmentEnvironment: () => boolean;
 
-declare const retrieveRoute: ({ params, searchParams, }: Pick<PageParameters, 'params' | 'searchParams'>) => Promise<ResolvedRouteGetResponse>;
+type RetrieveRouteOptions = PageParameters & {
+    /**
+     * If true, the manifest will not be prefetched.
+     *
+     * Prefetching allows the manifest to begin loading while the route data is being retrieved.
+     */
+    skipPrefetch?: boolean;
+};
+declare const retrieveRoute: ({ params, searchParams, skipPrefetch, }: RetrieveRouteOptions) => Promise<ResolvedRouteGetResponse>;
 
 export { ContextUpdateTransfer, ContextUpdateTransferProps, CreateServerUniformContextProps, CreateStaticParamsOptions, GetCanvasClientOptions, GetManifestClientOptions, GetProjectMapClientOptions, GetRouteClientOptions, UniformCompositionProps, UniformContext, UniformContextProps, UniformPlayground, UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment, retrieveRoute };

package/dist/index.esm.js

@@ -444,8 +444,14 @@ import { getBaseUrl, getServerConfig as getServerConfig2, resolvePath } from "@u
 import { getTargetVariableExpandedUrl } from "@uniformdev/redirect";
 var retrieveRoute = async ({
   params,
-  searchParams
+  searchParams,
+  skipPrefetch
 }) => {
+  if (!skipPrefetch) {
+    void getManifest({
+      searchParams
+    });
+  }
   const { type, value } = resolvePath({
     params
   });

package/dist/index.js

@@ -483,8 +483,14 @@ var import_canvas_next_rsc_shared3 = require("@uniformdev/canvas-next-rsc-shared
 var import_redirect = require("@uniformdev/redirect");
 var retrieveRoute = async ({
   params,
-  searchParams
+  searchParams,
+  skipPrefetch
 }) => {
+  if (!skipPrefetch) {
+    void getManifest({
+      searchParams
+    });
+  }
   const { type, value } = (0, import_canvas_next_rsc_shared3.resolvePath)({
     params
   });

package/dist/index.mjs

@@ -444,8 +444,14 @@ import { getBaseUrl, getServerConfig as getServerConfig2, resolvePath } from "@u
 import { getTargetVariableExpandedUrl } from "@uniformdev/redirect";
 var retrieveRoute = async ({
   params,
-  searchParams
+  searchParams,
+  skipPrefetch
 }) => {
+  if (!skipPrefetch) {
+    void getManifest({
+      searchParams
+    });
+  }
   const { type, value } = resolvePath({
     params
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next-rsc",
-  "version": "19.75.2-alpha.2+8fe85545a",
+  "version": "19.76.0",
   "license": "SEE LICENSE IN LICENSE.txt",
   "scripts": {
     "build": "tsup",
@@ -61,15 +61,15 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/canvas-next-rsc-client": "^19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/canvas-next-rsc-shared": "^19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/canvas-react": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/context": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/project-map": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/redirect": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/richtext": "19.75.2-alpha.2+8fe85545a",
-    "@uniformdev/webhooks": "19.75.2-alpha.2+8fe85545a",
+    "@uniformdev/canvas": "19.76.0",
+    "@uniformdev/canvas-next-rsc-client": "^19.76.0",
+    "@uniformdev/canvas-next-rsc-shared": "^19.76.0",
+    "@uniformdev/canvas-react": "19.76.0",
+    "@uniformdev/context": "19.76.0",
+    "@uniformdev/project-map": "19.76.0",
+    "@uniformdev/redirect": "19.76.0",
+    "@uniformdev/richtext": "19.76.0",
+    "@uniformdev/webhooks": "19.76.0",
     "@vercel/edge-config": "^0.4.0",
     "encoding": "^0.1.13",
     "server-only": "^0.0.1",
@@ -86,5 +86,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8fe85545a0968d34c2ce64e5b1de4e76ffc4577b"
+  "gitHead": "68c676df4588906359e10e58f9394f3de70098ba"
 }