@uniformdev/canvas-next 18.24.0 → 18.24.1-alpha.2

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

@@ -1,12 +1,11 @@
 // src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
-  params,
-  prefix
+  params
 }) => {
   const slug = (params == null ? void 0 : params[param]) || "";
   const slugString = Array.isArray(slug) ? slug.join("/") : slug;
-  return `/${slugString}` || prefix || "/";
+  return `/${slugString}`;
 };
 
 export {

package/dist/index.d.ts

@@ -4,10 +4,9 @@ import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 import '@uniformdev/canvas-react';
 
-declare const resolveSlugFromParams: ({ param, params, prefix, }: {
+declare const resolveSlugFromParams: ({ param, params, }: {
     param: string | undefined;
     params: ParsedUrlQuery | undefined;
-    prefix?: string | undefined;
 }) => string;
 
 type ResolveFullPath = (options: {

package/dist/index.esm.js

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

package/dist/index.js

@@ -30,12 +30,11 @@ module.exports = __toCommonJS(src_exports);
 // src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
-  params,
-  prefix
+  params
 }) => {
   const slug = (params == null ? void 0 : params[param]) || "";
   const slugString = Array.isArray(slug) ? slug.join("/") : slug;
-  return `/${slugString}` || prefix || "/";
+  return `/${slugString}`;
 };
 
 // src/preview/previewHandlerGet.ts

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import {
   resolveSlugFromParams
-} from "./chunk-SH3D2DYY.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

@@ -1,6 +1,6 @@
-import { c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from '../models-6ff72d91.js';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-6ff72d91.js';
 import * as next from 'next';
-import { GetServerSideProps, GetStaticProps } from 'next';
+import { GetServerSidePropsContext, PreviewData, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
@@ -13,11 +13,13 @@ declare const withUniformGetServerSideProps: <TProps extends {
 } = {
     [key: string]: any;
 }>(options?: {
-    /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
+    /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
-    /** Pathname prefix (or base url) that you don't want to be used on PM API request. */
+    /** 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 | undefined;
-    /** Composition published state. If TRUE - draft composition will be used as well */
+    /** Useful when you need to modify the path passed to the API */
+    modifyPath?: ((path: string, context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>) => string) | undefined;
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
     projectMapId?: string | undefined;
     /** Way to override getCompositionByNodePath request params */
@@ -31,16 +33,16 @@ declare const withUniformGetServerSideProps: <TProps extends {
         withUIStatus?: boolean | 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, querystring.ParsedUrlQuery, next.PreviewData> | undefined;
-} | undefined) => GetServerSideProps<TProps, querystring.ParsedUrlQuery, next.PreviewData>;
+    callback?: UniformGetServerSideProps<TProps, ParsedUrlQuery, PreviewData> | undefined;
+} | undefined) => GetServerSideProps<TProps, ParsedUrlQuery, PreviewData>;
 
 declare const withUniformGetStaticPaths: (options?: {
     projectMapId?: string | undefined;
     /** Starting path to fetch nodes from */
     rootPath?: string | undefined;
-    /** Pathname prefix (or base url) that you don't want to be used on PM API request. */
+    /** 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;
-    /** Composition published state. If TRUE - draft composition will be used as well */
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
     /** Way to override getNodes request params */
     requestOptions?: Partial<{
@@ -61,7 +63,7 @@ declare const withUniformGetStaticPaths: (options?: {
     }> | undefined;
     /** Way to modify list of nodes before building array of paths */
     callback?: ((nodes: ProjectMapNodeGetResponse['nodes']) => Promise<ProjectMapNodeGetResponse['nodes']>) | undefined;
-    /** Way to override default ProjectMapClient, to override some constructor params, such as fetch instance, etc */
+    /** If you need to override the default client, you can pass it here */
     client?: ProjectMapClient | undefined;
 } | undefined) => () => Promise<{
     paths: string[] | undefined;
@@ -76,11 +78,11 @@ declare const withUniformGetStaticProps: <TProps extends {
     projectMapId?: string | undefined;
     /** Name of dynamic parameter coming from getStaticPath, usually specified in page file name (e.g. [...slug].jsx will have param = 'slug' */
     param: string;
-    /** Pathname prefix (or base url) that you don't want to be used on PM API request. */
-    prefix?: string | undefined;
-    /** Composition published state. If TRUE - draft composition will be used as well */
+    /** Useful when you need to modify the path passed to the API */
+    modifyPath?: ((path: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string) | undefined;
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
-    /** Way to override default CanvasClient, to override some constructor params, such as fetch instance, etc */
+    /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
     /** Way to override getCompositionByNodePath request params */
     requestOptions?: Partial<{

package/dist/project-map/index.js

@@ -42,11 +42,15 @@ var withUniformGetServerSideProps = (options) => {
     });
     const preview = context.preview || (options == null ? void 0 : options.preview);
     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);
+    }
     try {
       const response = await canvasClient.getCompositionByNodePath({
         ...options == null ? void 0 : options.requestOptions,
         projectMapId,
-        projectMapNodePath: (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl,
+        projectMapNodePath: nodePath,
         state: preview ? import_canvas.CANVAS_DRAFT_STATE : import_canvas.CANVAS_PUBLISHED_STATE
       });
       composition = response.composition;
@@ -101,12 +105,11 @@ var import_canvas3 = require("@uniformdev/canvas");
 // src/helpers/slug.ts
 var resolveSlugFromParams = ({
   param = "slug",
-  params,
-  prefix
+  params
 }) => {
   const slug = (params == null ? void 0 : params[param]) || "";
   const slugString = Array.isArray(slug) ? slug.join("/") : slug;
-  return `/${slugString}` || prefix || "/";
+  return `/${slugString}`;
 };
 
 // src/project-map/withUniformGetStaticProps.ts
@@ -114,11 +117,13 @@ var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
     var _a, _b;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
-    const pathString = resolveSlugFromParams({
+    let pathString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
+      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 import_canvas3.CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,

package/dist/project-map/index.mjs

@@ -1,6 +1,6 @@
 import {
   resolveSlugFromParams
-} from "../chunk-SH3D2DYY.mjs";
+} from "../chunk-2MI7UYW7.mjs";
 
 // src/project-map/withUniformGetServerSideProps.ts
 import {
@@ -19,11 +19,15 @@ var withUniformGetServerSideProps = (options) => {
     });
     const preview = context.preview || (options == null ? void 0 : options.preview);
     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);
+    }
     try {
       const response = await canvasClient.getCompositionByNodePath({
         ...options == null ? void 0 : options.requestOptions,
         projectMapId,
-        projectMapNodePath: (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl,
+        projectMapNodePath: nodePath,
         state: preview ? CANVAS_DRAFT_STATE : CANVAS_PUBLISHED_STATE
       });
       composition = response.composition;
@@ -84,11 +88,13 @@ var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
     var _a, _b;
     const projectMapId = (_a = options == null ? void 0 : options.projectMapId) != null ? _a : process.env.UNIFORM_PROJECT_MAP_ID;
-    const pathString = resolveSlugFromParams({
+    let pathString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
+      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,

package/dist/slug/index.d.ts

@@ -1,6 +1,6 @@
 import * as next from 'next';
-import { GetServerSideProps, GetStaticProps } from 'next';
-import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-6ff72d91.js';
+import { GetServerSidePropsContext, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
+import { a as UniformPreviewData, c as UniformGetServerSideProps, b as UniformGetStaticProps } from '../models-6ff72d91.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
 import * as _uniformdev_canvas from '@uniformdev/canvas';
@@ -12,9 +12,13 @@ declare const withUniformGetServerSideProps: <TProps extends {
 } = {
     [key: string]: any;
 }>(options?: {
-    param: string;
+    /** 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 slug structure */
     prefix?: string | undefined;
+    /** Useful when you need to modify the slug passed to the API */
+    modifySlug?: ((slug: string, context: GetServerSidePropsContext<ParsedUrlQuery, UniformPreviewData>) => string) | undefined;
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
+    /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
     requestOptions?: Partial<{
         skipEnhance?: boolean | undefined;
@@ -30,15 +34,15 @@ declare const withUniformGetServerSideProps: <TProps extends {
 
 declare const withUniformGetStaticPaths: (options?: {
     projectMapId?: string | undefined;
-    /** Pathname prefix (or base url) that you don't want to be used on PM API request. */
+    /** A string that you want prepended to slugs returned by Canvas. Useful when calling from a nested folder which is not part of your slug structure */
     prefix?: string | undefined;
-    /** Composition published state. If TRUE - draft composition will be used as well */
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
     /** Way to override getCompositionList request params */
     requestOptions?: Partial<CompositionGetParameters> | undefined;
     /** Way to modify list of slugs before building array of paths */
     callback?: ((compositions: CompositionGetResponse[]) => Promise<CompositionGetResponse[]>) | undefined;
-    /** Way to override default ProjectMapClient, to override some constructor params, such as fetch instance, etc */
+    /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
 } | undefined) => () => Promise<{
     paths: string[];
@@ -52,11 +56,11 @@ declare const withUniformGetStaticProps: <TProps extends {
 }>(options: {
     /** Name of dynamic parameter coming from getStaticPath, usually specified in page file name (e.g. [...slug].jsx will have param = 'slug' */
     param: string;
-    /** Pathname prefix (or base url) that you don't want to be used on PM API request. */
-    prefix?: string | undefined;
-    /** Composition published state. If TRUE - draft composition will be used as well */
+    /** Useful when you need to modify the slug passed to the API */
+    modifySlug?: ((slug: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string) | undefined;
+    /** Set to true if you want to include draft compositions */
     preview?: boolean | undefined;
-    /** Way to override default CanvasClient, to override some constructor params, such as fetch instance, etc */
+    /** If you need to override the default client, you can pass it here */
     client?: CanvasClient | undefined;
     /** Way to override getCompositionBySlug request params */
     requestOptions?: Partial<{

package/dist/slug/index.js

@@ -31,26 +31,8 @@ module.exports = __toCommonJS(slug_exports);
 
 // src/slug/withUniformGetServerSideProps.ts
 var import_canvas = require("@uniformdev/canvas");
-
-// src/helpers/slug.ts
-var resolveSlugFromParams = ({
-  param = "slug",
-  params,
-  prefix
-}) => {
-  const slug = (params == null ? void 0 : params[param]) || "";
-  const slugString = Array.isArray(slug) ? slug.join("/") : slug;
-  return `/${slugString}` || prefix || "/";
-};
-
-// src/slug/withUniformGetServerSideProps.ts
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
-    const slugString = resolveSlugFromParams({
-      param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
-    });
     const canvasClient = (options == null ? void 0 : options.client) || new import_canvas.CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,
@@ -58,10 +40,14 @@ var withUniformGetServerSideProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
+    let slug = (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl;
+    if (options == null ? void 0 : options.modifySlug) {
+      slug = options.modifySlug(slug, context);
+    }
     try {
       const response = await canvasClient.getCompositionBySlug({
         ...options == null ? void 0 : options.requestOptions,
-        slug: slugString,
+        slug,
         state: preview || (options == null ? void 0 : options.preview) ? import_canvas.CANVAS_DRAFT_STATE : import_canvas.CANVAS_PUBLISHED_STATE
       });
       composition = response.composition;
@@ -110,14 +96,28 @@ var withUniformGetStaticPaths = (options) => {
 
 // src/slug/withUniformGetStaticProps.ts
 var import_canvas3 = require("@uniformdev/canvas");
+
+// src/helpers/slug.ts
+var resolveSlugFromParams = ({
+  param = "slug",
+  params
+}) => {
+  const slug = (params == null ? void 0 : params[param]) || "";
+  const slugString = Array.isArray(slug) ? slug.join("/") : slug;
+  return `/${slugString}`;
+};
+
+// src/slug/withUniformGetStaticProps.ts
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
     var _a;
-    const slugString = resolveSlugFromParams({
+    let slugString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
+      params: context == null ? void 0 : context.params
     });
+    if (options == null ? void 0 : options.modifySlug) {
+      slugString = options.modifySlug(slugString, context);
+    }
     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,

package/dist/slug/index.mjs

@@ -1,6 +1,6 @@
 import {
   resolveSlugFromParams
-} from "../chunk-SH3D2DYY.mjs";
+} from "../chunk-2MI7UYW7.mjs";
 
 // src/slug/withUniformGetServerSideProps.ts
 import {
@@ -10,11 +10,6 @@ import {
 } from "@uniformdev/canvas";
 var withUniformGetServerSideProps = (options) => {
   return async function wrappedGetServerSideProps(context) {
-    const slugString = resolveSlugFromParams({
-      param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
-    });
     const canvasClient = (options == null ? void 0 : options.client) || new CanvasClient({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,
@@ -22,10 +17,14 @@ var withUniformGetServerSideProps = (options) => {
     });
     const { preview, previewData } = context;
     let composition = void 0;
+    let slug = (options == null ? void 0 : options.prefix) ? context.resolvedUrl.replace(new RegExp(`^${options.prefix}`), "") : context.resolvedUrl;
+    if (options == null ? void 0 : options.modifySlug) {
+      slug = options.modifySlug(slug, context);
+    }
     try {
       const response = await canvasClient.getCompositionBySlug({
         ...options == null ? void 0 : options.requestOptions,
-        slug: slugString,
+        slug,
         state: preview || (options == null ? void 0 : options.preview) ? CANVAS_DRAFT_STATE : CANVAS_PUBLISHED_STATE
       });
       composition = response.composition;
@@ -85,11 +84,13 @@ import {
 var withUniformGetStaticProps = (options) => {
   return async function wrappedGetStaticProps(context) {
     var _a;
-    const slugString = resolveSlugFromParams({
+    let slugString = resolveSlugFromParams({
       param: options == null ? void 0 : options.param,
-      params: context == null ? void 0 : context.params,
-      prefix: options == null ? void 0 : options.prefix
+      params: context == null ? void 0 : context.params
     });
+    if (options == null ? void 0 : options.modifySlug) {
+      slugString = options.modifySlug(slugString, context);
+    }
     const canvasClient = (_a = options == null ? void 0 : options.client) != null ? _a : new CanvasClient3({
       apiKey: process.env.UNIFORM_API_KEY,
       projectId: process.env.UNIFORM_PROJECT_ID,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas-next",
-  "version": "18.24.0",
+  "version": "18.24.1-alpha.2+0802c591e",
   "description": "Next.js SDK for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -53,9 +53,9 @@
     "document": "api-extractor run --local"
   },
   "dependencies": {
-    "@uniformdev/canvas": "18.24.0",
-    "@uniformdev/canvas-react": "18.24.0",
-    "@uniformdev/project-map": "18.24.0"
+    "@uniformdev/canvas": "18.24.1-alpha.2+0802c591e",
+    "@uniformdev/canvas-react": "18.24.1-alpha.2+0802c591e",
+    "@uniformdev/project-map": "18.24.1-alpha.2+0802c591e"
   },
   "peerDependencies": {
     "next": ">= 12.0.0",
@@ -74,5 +74,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1e3a51a48860f7ec5861307dcda7d75278ac1505"
+  "gitHead": "0802c591e6e0730c6796ec9c4bca8ad8be427a54"
 }