@uniformdev/canvas-next 19.20.0 → 19.21.0

package/dist/index.esm.js

@@ -161,7 +161,7 @@ var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async
     res.setHeader("Access-Control-Allow-Origin", "*");
     res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
     res.setHeader("Access-Control-Allow-Methods", "GET");
-    return res.status(204);
+    return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });
 };

package/dist/index.js

@@ -207,7 +207,7 @@ var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async
     res.setHeader("Access-Control-Allow-Origin", "*");
     res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
     res.setHeader("Access-Control-Allow-Methods", "GET");
-    return res.status(204);
+    return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });
 };

package/dist/index.mjs

@@ -161,7 +161,7 @@ var createPreviewHandler = ({ secret, enhance, resolveFullPath } = {}) => async
     res.setHeader("Access-Control-Allow-Origin", "*");
     res.setHeader("Access-Control-Allow-Headers", "Origin, Content-Type, Accept");
     res.setHeader("Access-Control-Allow-Methods", "GET");
-    return res.status(204);
+    return res.status(204).end();
   }
   return res.status(501).json({ message: `Method "${method}" not implemented` });
 };

package/dist/route/index.d.ts

@@ -4,7 +4,7 @@ import { a as UniformPreviewData } from '../models-092c0912.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 export { w as withUniformGetStaticPaths } from '../withUniformGetStaticPaths-6a31a8f8.js';
-import { RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, unstable_RouteClient, RouteGetParameters, RootComponentInstance } from '@uniformdev/canvas';
+import { RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, RouteClient, RouteGetParameters, RootComponentInstance } from '@uniformdev/canvas';
 import '@uniformdev/canvas-react';
 import '@uniformdev/project-map';
 
@@ -13,15 +13,15 @@ type HandleRouteNotFoundFunction<TContext, TResult> = (result: RouteGetResponseN
 type HandleRouteRedirectFunction<TContext, TResult> = (requestUrl: string, redirect: RouteGetResponseRedirect, context: TContext, defaultHandler: (redirect: RouteGetResponseRedirect) => TResult, duration: number) => TResult;
 type RouteHandlerOptions<TContext, TResult, TSuccessResult> = {
     /** If you need to override the default client, you can pass it here */
-    client?: unstable_RouteClient;
+    client?: RouteClient;
     /** A string that you want to strip from the resolved context.resolvedUrl. Useful when calling from a nested folder which is not part of your project map structure */
     prefix?: string;
     /** Useful when you need to modify the path passed to the API */
     modifyPath?: (path: string, context: TContext) => string;
     /** The project map ID to connect to. If not set, the default project map for the configured project will be used. */
     projectMapId?: string;
-    /** Way to override getRoute request params */
-    requestOptions?: Partial<RouteGetParameters>;
+    /** Way to override getRoute request params. Can also be a function to compute options based on context values. */
+    requestOptions?: Partial<RouteGetParameters> | ((context: TContext) => Partial<RouteGetParameters>);
     /** Disables logging of response information and timings */
     silent?: boolean;
     /** Override handling of a composition route response. Return null to signal not found. */
@@ -40,18 +40,18 @@ type RouteHandlerOptions<TContext, TResult, TSuccessResult> = {
  * Static and dynamic routing as well as redirection is automatically supported.
  * Custom behavior can be added by passing in options to hook to specific processing events.
  */
-declare const unstable_withUniformGetServerSideProps: <TProps extends {
+declare const withUniformGetServerSideProps: <TProps extends {
     [key: string]: any;
 } = {
     data: RootComponentInstance;
 }>(options?: RouteHandlerOptions<GetServerSidePropsContext<ParsedUrlQuery, UniformPreviewData>, GetServerSidePropsResult<never>, GetServerSidePropsResult<TProps>> | undefined) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 /**
- * Creates an implementation of `getServerSideProps` using the Uniform Route API.
+ * Creates an implementation of `getStaticProps` using the Uniform Route API.
  * Static and dynamic routing as well as redirection is automatically supported.
  * Custom behavior can be added by passing in options to hook to specific processing events.
  */
-declare const unstable_withUniformGetStaticProps: <TProps extends {
+declare const withUniformGetStaticProps: <TProps extends {
     [key: string]: any;
 } = {
     data: RootComponentInstance;
@@ -60,7 +60,12 @@ declare const unstable_withUniformGetStaticProps: <TProps extends {
     param?: string | undefined;
 }) | undefined) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
-declare const unstable_getServerSideProps: next.GetServerSideProps<{
+/**
+ * Default implementation of getServerSideProps with routes
+ * To configure custom behavior, use:
+ * export getServerSideProps = withUniformGetServerSideProps({ ... });
+ */
+declare const getServerSideProps: next.GetServerSideProps<{
     data: {
         type: string;
         parameters?: {
@@ -179,7 +184,12 @@ declare const unstable_getServerSideProps: next.GetServerSideProps<{
     };
 }, querystring.ParsedUrlQuery, UniformPreviewData>;
 
-declare const unstable_getStaticProps: next.GetStaticProps<{
+/**
+ * Default implementation of getStaticProps with routes
+ * To configure custom behavior, use:
+ * export getStaticProps = withUniformGetStaticProps({ ... });
+ */
+declare const getStaticProps: next.GetStaticProps<{
     data: {
         type: string;
         parameters?: {
@@ -297,9 +307,16 @@ declare const unstable_getStaticProps: next.GetStaticProps<{
         } | undefined;
     };
 }, querystring.ParsedUrlQuery, UniformPreviewData>;
+/**
+ * Default implementation of getStaticPaths with routes
+ * To configure custom behavior, use:
+ * export getStaticPaths = withUniformGetStaticProps({ ... });
+ *
+ * NOTE: fallback must be supported. You cannot generate static paths for dynamic routes which contain query parameters.
+ */
 declare const getStaticPaths: () => Promise<{
     paths: string[] | undefined;
     fallback: boolean;
 }>;
 
-export { HandleRouteCompositionFunction, HandleRouteNotFoundFunction, HandleRouteRedirectFunction, RouteHandlerOptions, getStaticPaths, unstable_getServerSideProps, unstable_getStaticProps, unstable_withUniformGetServerSideProps, unstable_withUniformGetStaticProps };
+export { HandleRouteCompositionFunction, HandleRouteNotFoundFunction, HandleRouteRedirectFunction, RouteHandlerOptions, getServerSideProps, getStaticPaths, getStaticProps, withUniformGetServerSideProps, withUniformGetStaticProps };

package/dist/route/index.js

@@ -20,12 +20,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/route/index.ts
 var route_exports = {};
 __export(route_exports, {
+  getServerSideProps: () => getServerSideProps2,
   getStaticPaths: () => getStaticPaths2,
-  unstable_getServerSideProps: () => unstable_getServerSideProps,
-  unstable_getStaticProps: () => unstable_getStaticProps,
-  unstable_withUniformGetServerSideProps: () => unstable_withUniformGetServerSideProps,
-  unstable_withUniformGetStaticProps: () => unstable_withUniformGetStaticProps,
-  withUniformGetStaticPaths: () => withUniformGetStaticPaths
+  getStaticProps: () => getStaticProps2,
+  withUniformGetServerSideProps: () => withUniformGetServerSideProps2,
+  withUniformGetStaticPaths: () => withUniformGetStaticPaths,
+  withUniformGetStaticProps: () => withUniformGetStaticProps2
 });
 module.exports = __toCommonJS(route_exports);
 
@@ -335,6 +335,7 @@ var getStaticProps = withUniformGetStaticProps({ param: "path" });
 var getStaticPaths = withUniformGetStaticPaths();
 
 // src/route/withUniformGetServerSideProps.ts
+var import_canvas5 = require("@uniformdev/canvas");
 var import_redirect = require("@uniformdev/redirect");
 
 // src/route/createRouteFetcher.ts
@@ -356,14 +357,19 @@ function createRouteFetcher(options) {
     silent,
     parseContext
   } = options;
-  const routeClient = client || new import_canvas4.unstable_RouteClient({
+  const routeClient = client || new import_canvas4.RouteClient({
     apiKey: process.env.UNIFORM_API_KEY,
     projectId: process.env.UNIFORM_PROJECT_ID,
     edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
   });
   const handleModifyPath = modifyPath != null ? modifyPath : (path) => decodeURI(path);
   return async function fetcher(context) {
-    const { contextualEditingCompositionId, resolvedUrl } = parseContext(context);
+    var _a, _b;
+    const {
+      contextualEditingCompositionId,
+      resolvedUrl,
+      defaultFetchState: defaultPreviewState
+    } = parseContext(context);
     let nodePath = prefix ? resolvedUrl.replace(new RegExp(`^${prefix}`), "") : resolvedUrl;
     nodePath = handleModifyPath(nodePath, context);
     const invokeRedirectResult = (redirect, duration) => (handleRedirect != null ? handleRedirect : defaultHandleRedirect)(
@@ -427,9 +433,11 @@ function createRouteFetcher(options) {
         if (!silent) {
           console.log("Fetch route", nodePath);
         }
+        const resolvedOptions = typeof requestOptions === "function" ? requestOptions(context) : requestOptions;
         const time = Date.now();
         const response = await routeClient.getRoute({
-          ...requestOptions,
+          ...resolvedOptions,
+          state: (_b = (_a = resolvedOptions == null ? void 0 : resolvedOptions.state) != null ? _a : defaultPreviewState) != null ? _b : import_canvas4.CANVAS_PUBLISHED_STATE,
           projectMapId,
           path: nodePath
         });
@@ -463,7 +471,7 @@ function createRouteFetcher(options) {
 }
 
 // src/route/withUniformGetServerSideProps.ts
-var unstable_withUniformGetServerSideProps = (options) => {
+var withUniformGetServerSideProps2 = (options) => {
   const defaultHandleRedirect = (requestUrl, matched) => {
     if (matched.redirect.targetStatusCode > 400) {
       return {
@@ -496,7 +504,10 @@ var unstable_withUniformGetServerSideProps = (options) => {
       var _a;
       return {
         contextualEditingCompositionId: (_a = context.previewData) == null ? void 0 : _a.compositionId,
-        resolvedUrl: context.resolvedUrl
+        resolvedUrl: context.resolvedUrl,
+        // auto engage draft content when in next preview mode
+        // (can override with explicit setting of request options)'
+        defaultFetchState: context.preview ? import_canvas5.CANVAS_DRAFT_STATE : void 0
       };
     }
   });
@@ -504,8 +515,9 @@ var unstable_withUniformGetServerSideProps = (options) => {
 };
 
 // src/route/withUniformGetStaticProps.ts
+var import_canvas6 = require("@uniformdev/canvas");
 var import_redirect2 = require("@uniformdev/redirect");
-var unstable_withUniformGetStaticProps = (options) => {
+var withUniformGetStaticProps2 = (options) => {
   const defaultHandleRedirect = (requestUrl, matched) => {
     return {
       redirect: {
@@ -536,7 +548,10 @@ var unstable_withUniformGetStaticProps = (options) => {
         resolvedUrl: resolveSlugFromParams({
           params: context.params,
           param: (_b = options == null ? void 0 : options.param) != null ? _b : "route"
-        })
+        }),
+        // auto engage draft content when in next preview mode
+        // (can override with explicit setting of request options)
+        defaultFetchState: context.preview ? import_canvas6.CANVAS_DRAFT_STATE : void 0
       };
     }
   });
@@ -544,15 +559,15 @@ var unstable_withUniformGetStaticProps = (options) => {
 };
 
 // src/route/index.ts
-var unstable_getServerSideProps = unstable_withUniformGetServerSideProps();
-var unstable_getStaticProps = unstable_withUniformGetStaticProps();
+var getServerSideProps2 = withUniformGetServerSideProps2();
+var getStaticProps2 = withUniformGetStaticProps2();
 var getStaticPaths2 = withUniformGetStaticPaths();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getServerSideProps,
   getStaticPaths,
-  unstable_getServerSideProps,
-  unstable_getStaticProps,
-  unstable_withUniformGetServerSideProps,
-  unstable_withUniformGetStaticProps,
-  withUniformGetStaticPaths
+  getStaticProps,
+  withUniformGetServerSideProps,
+  withUniformGetStaticPaths,
+  withUniformGetStaticProps
 });

package/dist/route/index.mjs

@@ -57,13 +57,15 @@ function logRouteResponse(response, duration) {
 }
 
 // src/route/withUniformGetServerSideProps.ts
+import { CANVAS_DRAFT_STATE } from "@uniformdev/canvas";
 import { RedirectClient } from "@uniformdev/redirect";
 
 // src/route/createRouteFetcher.ts
 import {
   ApiClientError,
+  CANVAS_PUBLISHED_STATE,
   EMPTY_COMPOSITION,
-  unstable_RouteClient
+  RouteClient
 } from "@uniformdev/canvas";
 import { red as red2 } from "colorette";
 function createRouteFetcher(options) {
@@ -82,14 +84,19 @@ function createRouteFetcher(options) {
     silent,
     parseContext
   } = options;
-  const routeClient = client || new unstable_RouteClient({
+  const routeClient = client || new RouteClient({
     apiKey: process.env.UNIFORM_API_KEY,
     projectId: process.env.UNIFORM_PROJECT_ID,
     edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
   });
   const handleModifyPath = modifyPath != null ? modifyPath : (path) => decodeURI(path);
   return async function fetcher(context) {
-    const { contextualEditingCompositionId, resolvedUrl } = parseContext(context);
+    var _a, _b;
+    const {
+      contextualEditingCompositionId,
+      resolvedUrl,
+      defaultFetchState: defaultPreviewState
+    } = parseContext(context);
     let nodePath = prefix ? resolvedUrl.replace(new RegExp(`^${prefix}`), "") : resolvedUrl;
     nodePath = handleModifyPath(nodePath, context);
     const invokeRedirectResult = (redirect, duration) => (handleRedirect != null ? handleRedirect : defaultHandleRedirect)(
@@ -153,9 +160,11 @@ function createRouteFetcher(options) {
         if (!silent) {
           console.log("Fetch route", nodePath);
         }
+        const resolvedOptions = typeof requestOptions === "function" ? requestOptions(context) : requestOptions;
         const time = Date.now();
         const response = await routeClient.getRoute({
-          ...requestOptions,
+          ...resolvedOptions,
+          state: (_b = (_a = resolvedOptions == null ? void 0 : resolvedOptions.state) != null ? _a : defaultPreviewState) != null ? _b : CANVAS_PUBLISHED_STATE,
           projectMapId,
           path: nodePath
         });
@@ -189,7 +198,7 @@ function createRouteFetcher(options) {
 }
 
 // src/route/withUniformGetServerSideProps.ts
-var unstable_withUniformGetServerSideProps = (options) => {
+var withUniformGetServerSideProps = (options) => {
   const defaultHandleRedirect = (requestUrl, matched) => {
     if (matched.redirect.targetStatusCode > 400) {
       return {
@@ -222,7 +231,10 @@ var unstable_withUniformGetServerSideProps = (options) => {
       var _a;
       return {
         contextualEditingCompositionId: (_a = context.previewData) == null ? void 0 : _a.compositionId,
-        resolvedUrl: context.resolvedUrl
+        resolvedUrl: context.resolvedUrl,
+        // auto engage draft content when in next preview mode
+        // (can override with explicit setting of request options)'
+        defaultFetchState: context.preview ? CANVAS_DRAFT_STATE : void 0
       };
     }
   });
@@ -230,8 +242,9 @@ var unstable_withUniformGetServerSideProps = (options) => {
 };
 
 // src/route/withUniformGetStaticProps.ts
+import { CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE2 } from "@uniformdev/canvas";
 import { RedirectClient as RedirectClient2 } from "@uniformdev/redirect";
-var unstable_withUniformGetStaticProps = (options) => {
+var withUniformGetStaticProps = (options) => {
   const defaultHandleRedirect = (requestUrl, matched) => {
     return {
       redirect: {
@@ -262,7 +275,10 @@ var unstable_withUniformGetStaticProps = (options) => {
         resolvedUrl: resolveSlugFromParams({
           params: context.params,
           param: (_b = options == null ? void 0 : options.param) != null ? _b : "route"
-        })
+        }),
+        // auto engage draft content when in next preview mode
+        // (can override with explicit setting of request options)
+        defaultFetchState: context.preview ? CANVAS_DRAFT_STATE2 : void 0
       };
     }
   });
@@ -270,14 +286,14 @@ var unstable_withUniformGetStaticProps = (options) => {
 };
 
 // src/route/index.ts
-var unstable_getServerSideProps = unstable_withUniformGetServerSideProps();
-var unstable_getStaticProps = unstable_withUniformGetStaticProps();
+var getServerSideProps = withUniformGetServerSideProps();
+var getStaticProps = withUniformGetStaticProps();
 var getStaticPaths = withUniformGetStaticPaths();
 export {
+  getServerSideProps,
   getStaticPaths,
-  unstable_getServerSideProps,
-  unstable_getStaticProps,
-  unstable_withUniformGetServerSideProps,
-  unstable_withUniformGetStaticProps,
-  withUniformGetStaticPaths
+  getStaticProps,
+  withUniformGetServerSideProps,
+  withUniformGetStaticPaths,
+  withUniformGetStaticProps
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next",
-  "version": "19.20.0",
+  "version": "19.21.0",
   "description": "Next.js SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -63,11 +63,11 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.20.0",
-    "@uniformdev/canvas-react": "19.20.0",
-    "@uniformdev/project-map": "19.20.0",
-    "@uniformdev/redirect": "19.20.0",
-    "@uniformdev/richtext": "19.20.0",
+    "@uniformdev/canvas": "19.21.0",
+    "@uniformdev/canvas-react": "19.21.0",
+    "@uniformdev/project-map": "19.21.0",
+    "@uniformdev/redirect": "19.21.0",
+    "@uniformdev/richtext": "19.21.0",
     "colorette": "2.0.20"
   },
   "peerDependencies": {
@@ -87,5 +87,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "eb731fec3a9f35b9cc6d218e2a77861ccf00441a"
+  "gitHead": "3db4c0f1c775a5cf9677c6df294322cfbf79611e"
 }