@uniformdev/canvas-next 19.9.2-alpha.3 → 19.10.0

package/dist/{chunk-TR7V6ABJ.mjs → chunk-2MI7UYW7.mjs}

@@ -1,4 +1,4 @@
-// src/helpers/resolveSlugFromParams.ts
+// src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
   params

package/dist/index.esm.js

@@ -1,6 +1,6 @@
 import {
   resolveSlugFromParams
-} from "./chunk-TR7V6ABJ.mjs";
+} from "./chunk-2MI7UYW7.mjs";
 
 // src/preview/previewHandlerGet.ts
 import { IN_CONTEXT_EDITOR_QUERY_STRING_PARAM } from "@uniformdev/canvas";

package/dist/index.js

@@ -27,7 +27,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/helpers/resolveSlugFromParams.ts
+// src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
   params

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import {
   resolveSlugFromParams
-} from "./chunk-TR7V6ABJ.mjs";
+} from "./chunk-2MI7UYW7.mjs";
 
 // src/preview/previewHandlerGet.ts
 import { IN_CONTEXT_EDITOR_QUERY_STRING_PARAM } from "@uniformdev/canvas";

package/dist/project-map/index.d.ts

@@ -5,9 +5,8 @@ import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
 import { CanvasClient, DataResolutionOption } from '@uniformdev/canvas';
-export { w as withUniformGetStaticPaths } from '../withUniformGetStaticPaths-6a31a8f8.js';
+import { ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
 import '@uniformdev/canvas-react';
-import '@uniformdev/project-map';
 
 declare const withUniformGetServerSideProps: <TProps extends {
     [key: string]: any;
@@ -24,7 +23,7 @@ declare const withUniformGetServerSideProps: <TProps extends {
     preview?: boolean | undefined;
     projectMapId?: string | undefined;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
+    requestOptions?: Partial<{
         skipEnhance?: boolean | undefined;
         skipPatternResolution?: boolean | undefined;
         skipOverridesResolution?: boolean | undefined;
@@ -32,13 +31,46 @@ declare const withUniformGetServerSideProps: <TProps extends {
         withComponentIDs?: boolean | undefined;
         withTotalCount?: boolean | undefined;
         withUIStatus?: boolean | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption> | undefined;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
     callback?: UniformGetServerSideProps<TProps> | undefined;
-    /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
 } | undefined) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
+declare const withUniformGetStaticPaths: (options?: {
+    projectMapId?: string | undefined;
+    /** Starting path to fetch nodes from */
+    rootPath?: string | undefined;
+    /** A string that you want prepended to paths returned by your project map. Useful when calling from a nested folder which is not part of your project map structure */
+    prefix?: string | undefined;
+    /** Set to true if you want to include draft compositions */
+    preview?: boolean | undefined;
+    /** Way to override getNodes request params */
+    requestOptions?: Partial<{
+        projectMapId?: string | undefined;
+        projectId: string;
+        id?: string | undefined;
+        path?: string | undefined;
+        compositionId?: string | undefined;
+        limit?: number | undefined;
+        offset?: number | undefined;
+        depth?: number | undefined;
+        state?: number | undefined;
+        tree?: boolean | undefined;
+        search?: string | undefined;
+        includeAncestors?: boolean | undefined;
+        expanded?: boolean | undefined;
+        withCompositionData?: boolean | undefined;
+        withCompositionUIStatus?: boolean | undefined;
+    }> | undefined;
+    /** Way to modify list of nodes before building array of paths */
+    callback?: ((nodes: ProjectMapNodeGetResponse['nodes']) => Promise<ProjectMapNodeGetResponse['nodes']>) | undefined;
+    /** If you need to override the default client, you can pass it here */
+    client?: ProjectMapClient | undefined;
+} | undefined) => () => Promise<{
+    paths: string[] | undefined;
+    fallback: boolean;
+}>;
+
 declare const withUniformGetStaticProps: <TProps extends {
     [key: string]: any;
 } = {
@@ -54,7 +86,7 @@ declare const withUniformGetStaticProps: <TProps extends {
     /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
+    requestOptions?: Partial<{
         skipEnhance?: boolean | undefined;
         skipPatternResolution?: boolean | undefined;
         skipOverridesResolution?: boolean | undefined;
@@ -62,11 +94,9 @@ declare const withUniformGetStaticProps: <TProps extends {
         withComponentIDs?: boolean | undefined;
         withTotalCount?: boolean | undefined;
         withUIStatus?: boolean | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption> | undefined;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
     callback?: UniformGetStaticProps<TProps> | undefined;
-    /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
 }) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 declare const getServerSideProps: next.GetServerSideProps<{
@@ -81,4 +111,4 @@ declare const getStaticPaths: () => Promise<{
     fallback: boolean;
 }>;
 
-export { getServerSideProps, getStaticPaths, getStaticProps, withUniformGetServerSideProps, withUniformGetStaticProps };
+export { getServerSideProps, getStaticPaths, getStaticProps, withUniformGetServerSideProps, withUniformGetStaticPaths, withUniformGetStaticProps };

package/dist/project-map/index.js

@@ -32,15 +32,15 @@ module.exports = __toCommonJS(project_map_exports);
 // src/project-map/withUniformGetServerSideProps.ts
 var import_canvas = require("@uniformdev/canvas");
 var withUniformGetServerSideProps = (options) => {
-  const canvasClient = (options == null ? void 0 : options.client) || new import_canvas.CanvasClient({
-    apiKey: process.env.UNIFORM_API_KEY,
-    projectId: process.env.UNIFORM_PROJECT_ID,
-    apiHost: process.env.UNIFORM_CLI_BASE_URL,
-    edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
-  });
   return async function wrappedGetServerSideProps(context) {
     var _a, _b;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
+    const canvasClient = (options == null ? void 0 : options.client) || new import_canvas.CanvasClient({
+      apiKey: process.env.UNIFORM_API_KEY,
+      projectId: process.env.UNIFORM_PROJECT_ID,
+      apiHost: process.env.UNIFORM_CLI_BASE_URL,
+      edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
+    });
     const { preview, previewData } = context;
     let composition = void 0;
     let nodePath = (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl;
@@ -51,18 +51,13 @@ var withUniformGetServerSideProps = (options) => {
       composition = { ...import_canvas.EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : import_canvas.EMPTY_COMPOSITION._id };
     } else {
       try {
-        const time = Date.now();
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,
           projectMapId,
           projectMapNodePath: nodePath,
           state: preview || (options == null ? void 0 : options.preview) ? import_canvas.CANVAS_DRAFT_STATE : import_canvas.CANVAS_PUBLISHED_STATE
         });
-        const duration = Date.now() - time;
         composition = response.composition;
-        if (!(options == null ? void 0 : options.silent)) {
-          (0, import_canvas.logCompositionResponse)(response, duration);
-        }
       } catch (e) {
         console.error("[canvas-next] Failed to fetch composition", e);
         return {
@@ -112,7 +107,7 @@ var withUniformGetStaticPaths = (options) => {
 // src/project-map/withUniformGetStaticProps.ts
 var import_canvas3 = require("@uniformdev/canvas");
 
-// src/helpers/resolveSlugFromParams.ts
+// src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
   params
@@ -124,16 +119,9 @@ var resolveSlugFromParams = ({
 
 // src/project-map/withUniformGetStaticProps.ts
 var withUniformGetStaticProps = (options) => {
-  var _a;
-  const canvasClient = (_a = options == null ? void 0 : options.client) != null ? _a : new import_canvas3.CanvasClient({
-    apiKey: process.env.UNIFORM_API_KEY,
-    projectId: process.env.UNIFORM_PROJECT_ID,
-    apiHost: process.env.UNIFORM_CLI_BASE_URL,
-    edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
-  });
   return async function wrappedGetStaticProps(context) {
-    var _a2, _b;
-    const projectMapId = (_a2 = options == null ? void 0 : options.projectMapId) != null ? _a2 : process.env.UNIFORM_PROJECT_MAP_ID;
+    var _a, _b, _c;
+    const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
     let pathString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
       params: context == null ? void 0 : context.params
@@ -141,24 +129,25 @@ var withUniformGetStaticProps = (options) => {
     if (options == null ? void 0 : options.modifyPath) {
       pathString = options.modifyPath(pathString, context);
     }
+    const canvasClient = (_b = options == null ? void 0 : options.client) != null ? _b : new import_canvas3.CanvasClient({
+      apiKey: process.env.UNIFORM_API_KEY,
+      projectId: process.env.UNIFORM_PROJECT_ID,
+      apiHost: process.env.UNIFORM_CLI_BASE_URL,
+      edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
+    });
     const { preview, previewData } = context;
     let composition = void 0;
     if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
-      composition = { ...import_canvas3.EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : import_canvas3.EMPTY_COMPOSITION._id };
+      composition = { ...import_canvas3.EMPTY_COMPOSITION, _id: (_c = previewData.compositionId) != null ? _c : import_canvas3.EMPTY_COMPOSITION._id };
     } else {
       try {
-        const time = Date.now();
         const response = await canvasClient.getCompositionByNodePath({
           ...options == null ? void 0 : options.requestOptions,
           projectMapId,
           projectMapNodePath: pathString,
           state: preview || (options == null ? void 0 : options.preview) ? import_canvas3.CANVAS_DRAFT_STATE : import_canvas3.CANVAS_PUBLISHED_STATE
         });
-        const duration = Date.now() - time;
         composition = response.composition;
-        if (!(options == null ? void 0 : options.silent)) {
-          (0, import_canvas3.logCompositionResponse)(response, duration);
-        }
       } catch (e) {
         console.error("[canvas-next] Failed to fetch composition", e);
         return {

package/dist/project-map/index.mjs

@@ -1,12 +1,146 @@
 import {
-  getServerSideProps,
-  getStaticPaths,
-  getStaticProps,
-  withUniformGetServerSideProps,
-  withUniformGetStaticPaths,
-  withUniformGetStaticProps
-} from "../chunk-ZOXJSPVQ.mjs";
-import "../chunk-TR7V6ABJ.mjs";
+  resolveSlugFromParams
+} from "../chunk-2MI7UYW7.mjs";
+
+// src/project-map/withUniformGetServerSideProps.ts
+import {
+  CANVAS_DRAFT_STATE,
+  CANVAS_PUBLISHED_STATE,
+  CanvasClient,
+  EMPTY_COMPOSITION
+} from "@uniformdev/canvas";
+var withUniformGetServerSideProps = (options) => {
+  return async function wrappedGetServerSideProps(context) {
+    var _a, _b;
+    const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
+    const canvasClient = (options == null ? void 0 : options.client) || new CanvasClient({
+      apiKey: process.env.UNIFORM_API_KEY,
+      projectId: process.env.UNIFORM_PROJECT_ID,
+      apiHost: process.env.UNIFORM_CLI_BASE_URL,
+      edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
+    });
+    const { preview, previewData } = context;
+    let composition = void 0;
+    let nodePath = (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl;
+    if (options == null ? void 0 : options.modifyPath) {
+      nodePath = options.modifyPath(nodePath, context);
+    }
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION, _id: (_b = previewData.compositionId) != null ? _b : EMPTY_COMPOSITION._id };
+    } else {
+      try {
+        const response = await canvasClient.getCompositionByNodePath({
+          ...options == null ? void 0 : options.requestOptions,
+          projectMapId,
+          projectMapNodePath: nodePath,
+          state: preview || (options == null ? void 0 : options.preview) ? CANVAS_DRAFT_STATE : CANVAS_PUBLISHED_STATE
+        });
+        composition = response.composition;
+      } catch (e) {
+        console.error("[canvas-next] Failed to fetch composition", e);
+        return {
+          notFound: true
+        };
+      }
+    }
+    const ret = (options == null ? void 0 : options.callback) ? await options.callback(context, composition) : { props: {} };
+    if (Object.hasOwn(ret, "props")) {
+      const casted = ret;
+      casted.props["data"] = composition;
+    }
+    return ret;
+  };
+};
+
+// src/project-map/withUniformGetStaticPaths.ts
+import { CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE2, CANVAS_PUBLISHED_STATE as CANVAS_PUBLISHED_STATE2 } from "@uniformdev/canvas";
+import {
+  ProjectMapClient
+} from "@uniformdev/project-map";
+var withUniformGetStaticPaths = (options) => {
+  return async function wrappedGetStaticPaths() {
+    var _a, _b;
+    const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
+    const projectMapClient = (_b = options == null ? void 0 : options.client) != null ? _b : new ProjectMapClient({
+      apiKey: process.env.UNIFORM_API_KEY,
+      projectId: process.env.UNIFORM_PROJECT_ID,
+      apiHost: process.env.UNIFORM_CLI_BASE_URL
+    });
+    const response = await projectMapClient.getNodes({
+      ...options == null ? void 0 : options.requestOptions,
+      path: options == null ? void 0 : options.rootPath,
+      projectMapId,
+      state: (options == null ? void 0 : options.preview) ? CANVAS_DRAFT_STATE2 : CANVAS_PUBLISHED_STATE2
+    });
+    const nodes = (options == null ? void 0 : options.callback) ? await options.callback(response.nodes) : response.nodes;
+    const paths = nodes == null ? void 0 : nodes.filter((node) => Boolean(node.compositionId)).map((node) => {
+      var _a2;
+      return `${(_a2 = options == null ? void 0 : options.prefix) != null ? _a2 : ""}${node.path}`;
+    });
+    return {
+      paths,
+      fallback: true
+    };
+  };
+};
+
+// src/project-map/withUniformGetStaticProps.ts
+import {
+  CANVAS_DRAFT_STATE as CANVAS_DRAFT_STATE3,
+  CANVAS_PUBLISHED_STATE as CANVAS_PUBLISHED_STATE3,
+  CanvasClient as CanvasClient2,
+  EMPTY_COMPOSITION as EMPTY_COMPOSITION2
+} from "@uniformdev/canvas";
+var withUniformGetStaticProps = (options) => {
+  return async function wrappedGetStaticProps(context) {
+    var _a, _b, _c;
+    const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
+    let pathString = resolveSlugFromParams({
+      param: options == null ? void 0 : options.param,
+      params: context == null ? void 0 : context.params
+    });
+    if (options == null ? void 0 : options.modifyPath) {
+      pathString = options.modifyPath(pathString, context);
+    }
+    const canvasClient = (_b = options == null ? void 0 : options.client) != null ? _b : new CanvasClient2({
+      apiKey: process.env.UNIFORM_API_KEY,
+      projectId: process.env.UNIFORM_PROJECT_ID,
+      apiHost: process.env.UNIFORM_CLI_BASE_URL,
+      edgeApiHost: process.env.UNIFORM_CLI_BASE_EDGE_URL
+    });
+    const { preview, previewData } = context;
+    let composition = void 0;
+    if (previewData == null ? void 0 : previewData.isUniformContextualEditing) {
+      composition = { ...EMPTY_COMPOSITION2, _id: (_c = previewData.compositionId) != null ? _c : EMPTY_COMPOSITION2._id };
+    } else {
+      try {
+        const response = await canvasClient.getCompositionByNodePath({
+          ...options == null ? void 0 : options.requestOptions,
+          projectMapId,
+          projectMapNodePath: pathString,
+          state: preview || (options == null ? void 0 : options.preview) ? CANVAS_DRAFT_STATE3 : CANVAS_PUBLISHED_STATE3
+        });
+        composition = response.composition;
+      } catch (e) {
+        console.error("[canvas-next] Failed to fetch composition", e);
+        return {
+          notFound: true
+        };
+      }
+    }
+    const ret = options.callback ? await options.callback(context, composition) : { props: {} };
+    if (composition && Object.hasOwn(ret, "props")) {
+      const casted = ret;
+      casted.props["data"] = composition;
+    }
+    return ret;
+  };
+};
+
+// src/project-map/index.ts
+var getServerSideProps = withUniformGetServerSideProps();
+var getStaticProps = withUniformGetStaticProps({ param: "path" });
+var getStaticPaths = withUniformGetStaticPaths();
 export {
   getServerSideProps,
   getStaticPaths,