@uniformdev/canvas-next 19.135.1-alpha.10 → 19.135.1-alpha.11

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { RichTextRendererComponent, RenderRichTextComponentResolver, UniformRichText as UniformRichText$1, UniformRichTextNode as UniformRichTextNode$1 } from '@uniformdev/canvas-react';
 import { ParsedUrlQuery } from 'querystring';
-export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-IAhm-va2.mjs';
+export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-CupnCqnn.mjs';
 import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { RichTextRendererComponent, RenderRichTextComponentResolver, UniformRichText as UniformRichText$1, UniformRichTextNode as UniformRichTextNode$1 } from '@uniformdev/canvas-react';
 import { ParsedUrlQuery } from 'querystring';
-export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-IAhm-va2.js';
+export { U as UniformCompositionNextPage, c as UniformGetServerSideProps, b as UniformGetStaticProps, a as UniformPreviewData } from './models-CupnCqnn.js';
 import { NextApiHandler, NextApiRequest } from 'next';
 import { RootComponentInstance } from '@uniformdev/canvas';
 

package/dist/index.esm.js

@@ -125,7 +125,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionSlug: slug,
       compositionPath: path,
       locale,
-      isPlayground
+      isPlayground,
+      patternType: !isPlayground ? void 0 : getQueryParam(req, "patternType")
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.

package/dist/index.js

@@ -167,7 +167,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionSlug: slug,
       compositionPath: path,
       locale,
-      isPlayground
+      isPlayground,
+      patternType: !isPlayground ? void 0 : getQueryParam(req, "patternType")
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.

package/dist/index.mjs

@@ -125,7 +125,8 @@ var createPreviewHandlerGet = ({ secret, resolveFullPath = resolveFullPathDefaul
       compositionSlug: slug,
       compositionPath: path,
       locale,
-      isPlayground
+      isPlayground,
+      patternType: !isPlayground ? void 0 : getQueryParam(req, "patternType")
     },
     {
       // By default the preview cookies stays as long as the tab is open. And in contextual editing mode, people tend to open Canvas editor (one tab) and another tab to see published changes.

package/dist/{models-IAhm-va2.d.mts → models-CupnCqnn.d.mts}

@@ -1,4 +1,4 @@
-import { RootComponentInstance } from '@uniformdev/canvas';
+import { CompositionGetParameters, RootComponentInstance } from '@uniformdev/canvas';
 import { UniformCompositionProps } from '@uniformdev/canvas-react';
 import { NextPage, PreviewData, GetStaticPropsContext, GetStaticPropsResult, GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
 import { ParsedUrlQuery } from 'querystring';
@@ -11,6 +11,11 @@ type UniformPreviewData = PreviewData & {
     compositionPath?: string;
     locale?: string;
     isPlayground?: boolean;
+    /**
+     * The type of pattern being previewed in Canvas editor. This value is only set when `isPlayground` is `true`.
+     * "component" for component patterns, and "composition" for composition patterns
+     */
+    patternType?: Exclude<CompositionGetParameters['patternType'], 'all'>;
 };
 type UniformGetStaticProps<P extends {
     [key: string]: any;

package/dist/{models-IAhm-va2.d.ts → models-CupnCqnn.d.ts}

@@ -1,4 +1,4 @@
-import { RootComponentInstance } from '@uniformdev/canvas';
+import { CompositionGetParameters, RootComponentInstance } from '@uniformdev/canvas';
 import { UniformCompositionProps } from '@uniformdev/canvas-react';
 import { NextPage, PreviewData, GetStaticPropsContext, GetStaticPropsResult, GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
 import { ParsedUrlQuery } from 'querystring';
@@ -11,6 +11,11 @@ type UniformPreviewData = PreviewData & {
     compositionPath?: string;
     locale?: string;
     isPlayground?: boolean;
+    /**
+     * The type of pattern being previewed in Canvas editor. This value is only set when `isPlayground` is `true`.
+     * "component" for component patterns, and "composition" for composition patterns
+     */
+    patternType?: Exclude<CompositionGetParameters['patternType'], 'all'>;
 };
 type UniformGetStaticProps<P extends {
     [key: string]: any;

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

@@ -1,11 +1,10 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, PreviewData, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-IAhm-va2.mjs';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-CupnCqnn.mjs';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
-import * as _uniformdev_canvas from '@uniformdev/canvas';
-import { CanvasClient, DataResolutionOption } from '@uniformdev/canvas';
-import { ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
+import { CanvasClient, CompositionGetByNodePathParameters, DataResolutionOption } from '@uniformdev/canvas';
+import { ProjectMapNodeGetRequest, ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
 import '@uniformdev/canvas-react';
 
 declare const withUniformGetServerSideProps: <TProps extends {
@@ -14,69 +13,37 @@ declare const withUniformGetServerSideProps: <TProps extends {
     [key: string]: any;
 }>(options?: {
     /** If you need to override the default client, you can pass it here */
-    client?: CanvasClient | undefined;
+    client?: CanvasClient;
     /** 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;
+    prefix?: string;
     /** Useful when you need to modify the path passed to the API */
-    modifyPath?: ((path: string, context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>) => string) | undefined;
+    modifyPath?: (path: string, context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>) => string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
-    projectMapId?: string | undefined;
+    preview?: boolean;
+    projectMapId?: string;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
-        versionId?: string | undefined;
-        skipEnhance?: boolean | undefined;
-        skipPatternResolution?: boolean | undefined;
-        skipOverridesResolution?: boolean | undefined;
-        state?: number | undefined;
-        withComponentIDs?: boolean | undefined;
-        withTotalCount?: boolean | undefined;
-        withUIStatus?: boolean | undefined;
-        withWorkflowDefinition?: boolean | undefined;
-        withProjectMapNodes?: boolean | undefined;
-        withContentSourceMap?: boolean | undefined;
-        locale?: string | undefined;
-        releaseId?: string | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    requestOptions?: Omit<Partial<CompositionGetByNodePathParameters & DataResolutionOption>, "state">;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
-    callback?: UniformGetServerSideProps<TProps> | undefined;
+    callback?: UniformGetServerSideProps<TProps>;
     /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
-} | undefined) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
+    silent?: boolean;
+}) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 declare const withUniformGetStaticPaths: (options?: {
-    projectMapId?: string | undefined;
+    projectMapId?: string;
     /** Starting path to fetch nodes from */
-    rootPath?: string | undefined;
+    rootPath?: string;
     /** 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;
+    prefix?: string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
+    preview?: boolean;
     /** Way to override getNodes request params */
-    requestOptions?: Partial<{
-        projectMapId?: string | undefined;
-        projectId: string;
-        releaseId?: string | undefined;
-        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;
-        withRedirectData?: boolean | undefined;
-    }> | undefined;
+    requestOptions?: Partial<ProjectMapNodeGetRequest>;
     /** Way to modify list of nodes before building array of paths */
-    callback?: ((nodes: ProjectMapNodeGetResponse['nodes']) => Promise<ProjectMapNodeGetResponse['nodes']>) | undefined;
+    callback?: (nodes: ProjectMapNodeGetResponse["nodes"]) => Promise<ProjectMapNodeGetResponse["nodes"]>;
     /** If you need to override the default client, you can pass it here */
-    client?: ProjectMapClient | undefined;
-} | undefined) => () => Promise<{
+    client?: ProjectMapClient;
+}) => () => Promise<{
     paths: string[] | undefined;
     fallback: boolean;
 }>;
@@ -86,35 +53,21 @@ declare const withUniformGetStaticProps: <TProps extends {
 } = {
     [key: string]: any;
 }>(options: {
-    projectMapId?: string | undefined;
+    projectMapId?: string;
     /** Name of dynamic parameter coming from getStaticPath, usually specified in page file name (e.g. [...slug].jsx will have param = 'slug' */
     param: string;
     /** Useful when you need to modify the path passed to the API */
-    modifyPath?: ((path: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string) | undefined;
+    modifyPath?: (path: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
+    preview?: boolean;
     /** If you need to override the default client, you can pass it here */
-    client?: CanvasClient | undefined;
+    client?: CanvasClient;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
-        versionId?: string | undefined;
-        skipEnhance?: boolean | undefined;
-        skipPatternResolution?: boolean | undefined;
-        skipOverridesResolution?: boolean | undefined;
-        state?: number | undefined;
-        withComponentIDs?: boolean | undefined;
-        withTotalCount?: boolean | undefined;
-        withUIStatus?: boolean | undefined;
-        withWorkflowDefinition?: boolean | undefined;
-        withProjectMapNodes?: boolean | undefined;
-        withContentSourceMap?: boolean | undefined;
-        locale?: string | undefined;
-        releaseId?: string | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    requestOptions?: Omit<Partial<CompositionGetByNodePathParameters & DataResolutionOption>, "state">;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
-    callback?: UniformGetStaticProps<TProps> | undefined;
+    callback?: UniformGetStaticProps<TProps>;
     /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
+    silent?: boolean;
 }) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 declare const getServerSideProps: next.GetServerSideProps<{

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

@@ -1,11 +1,10 @@
 import * as next from 'next';
 import { GetServerSidePropsContext, PreviewData, GetServerSideProps, GetStaticPropsContext, GetStaticProps } from 'next';
-import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-IAhm-va2.js';
+import { c as UniformGetServerSideProps, a as UniformPreviewData, b as UniformGetStaticProps } from '../models-CupnCqnn.js';
 import * as querystring from 'querystring';
 import { ParsedUrlQuery } from 'querystring';
-import * as _uniformdev_canvas from '@uniformdev/canvas';
-import { CanvasClient, DataResolutionOption } from '@uniformdev/canvas';
-import { ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
+import { CanvasClient, CompositionGetByNodePathParameters, DataResolutionOption } from '@uniformdev/canvas';
+import { ProjectMapNodeGetRequest, ProjectMapNodeGetResponse, ProjectMapClient } from '@uniformdev/project-map';
 import '@uniformdev/canvas-react';
 
 declare const withUniformGetServerSideProps: <TProps extends {
@@ -14,69 +13,37 @@ declare const withUniformGetServerSideProps: <TProps extends {
     [key: string]: any;
 }>(options?: {
     /** If you need to override the default client, you can pass it here */
-    client?: CanvasClient | undefined;
+    client?: CanvasClient;
     /** 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;
+    prefix?: string;
     /** Useful when you need to modify the path passed to the API */
-    modifyPath?: ((path: string, context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>) => string) | undefined;
+    modifyPath?: (path: string, context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>) => string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
-    projectMapId?: string | undefined;
+    preview?: boolean;
+    projectMapId?: string;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
-        versionId?: string | undefined;
-        skipEnhance?: boolean | undefined;
-        skipPatternResolution?: boolean | undefined;
-        skipOverridesResolution?: boolean | undefined;
-        state?: number | undefined;
-        withComponentIDs?: boolean | undefined;
-        withTotalCount?: boolean | undefined;
-        withUIStatus?: boolean | undefined;
-        withWorkflowDefinition?: boolean | undefined;
-        withProjectMapNodes?: boolean | undefined;
-        withContentSourceMap?: boolean | undefined;
-        locale?: string | undefined;
-        releaseId?: string | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    requestOptions?: Omit<Partial<CompositionGetByNodePathParameters & DataResolutionOption>, "state">;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
-    callback?: UniformGetServerSideProps<TProps> | undefined;
+    callback?: UniformGetServerSideProps<TProps>;
     /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
-} | undefined) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
+    silent?: boolean;
+}) => GetServerSideProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 declare const withUniformGetStaticPaths: (options?: {
-    projectMapId?: string | undefined;
+    projectMapId?: string;
     /** Starting path to fetch nodes from */
-    rootPath?: string | undefined;
+    rootPath?: string;
     /** 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;
+    prefix?: string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
+    preview?: boolean;
     /** Way to override getNodes request params */
-    requestOptions?: Partial<{
-        projectMapId?: string | undefined;
-        projectId: string;
-        releaseId?: string | undefined;
-        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;
-        withRedirectData?: boolean | undefined;
-    }> | undefined;
+    requestOptions?: Partial<ProjectMapNodeGetRequest>;
     /** Way to modify list of nodes before building array of paths */
-    callback?: ((nodes: ProjectMapNodeGetResponse['nodes']) => Promise<ProjectMapNodeGetResponse['nodes']>) | undefined;
+    callback?: (nodes: ProjectMapNodeGetResponse["nodes"]) => Promise<ProjectMapNodeGetResponse["nodes"]>;
     /** If you need to override the default client, you can pass it here */
-    client?: ProjectMapClient | undefined;
-} | undefined) => () => Promise<{
+    client?: ProjectMapClient;
+}) => () => Promise<{
     paths: string[] | undefined;
     fallback: boolean;
 }>;
@@ -86,35 +53,21 @@ declare const withUniformGetStaticProps: <TProps extends {
 } = {
     [key: string]: any;
 }>(options: {
-    projectMapId?: string | undefined;
+    projectMapId?: string;
     /** Name of dynamic parameter coming from getStaticPath, usually specified in page file name (e.g. [...slug].jsx will have param = 'slug' */
     param: string;
     /** Useful when you need to modify the path passed to the API */
-    modifyPath?: ((path: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string) | undefined;
+    modifyPath?: (path: string, context: GetStaticPropsContext<ParsedUrlQuery, UniformPreviewData>) => string;
     /** Set to true if you want to include draft compositions */
-    preview?: boolean | undefined;
+    preview?: boolean;
     /** If you need to override the default client, you can pass it here */
-    client?: CanvasClient | undefined;
+    client?: CanvasClient;
     /** Way to override getCompositionByNodePath request params */
-    requestOptions?: Omit<Partial<{
-        versionId?: string | undefined;
-        skipEnhance?: boolean | undefined;
-        skipPatternResolution?: boolean | undefined;
-        skipOverridesResolution?: boolean | undefined;
-        state?: number | undefined;
-        withComponentIDs?: boolean | undefined;
-        withTotalCount?: boolean | undefined;
-        withUIStatus?: boolean | undefined;
-        withWorkflowDefinition?: boolean | undefined;
-        withProjectMapNodes?: boolean | undefined;
-        withContentSourceMap?: boolean | undefined;
-        locale?: string | undefined;
-        releaseId?: string | undefined;
-    } & Required<Pick<_uniformdev_canvas.CompositionGetParameters, "projectMapNodePath">> & _uniformdev_canvas.SpecificProjectMap & DataResolutionOption>, "state"> | undefined;
+    requestOptions?: Omit<Partial<CompositionGetByNodePathParameters & DataResolutionOption>, "state">;
     /** Custom handler to specify return value and modify composition - e.g. enhance with CMS data */
-    callback?: UniformGetStaticProps<TProps> | undefined;
+    callback?: UniformGetStaticProps<TProps>;
     /** Disables logging of response information and timings */
-    silent?: boolean | undefined;
+    silent?: boolean;
 }) => GetStaticProps<TProps, ParsedUrlQuery, UniformPreviewData>;
 
 declare const getServerSideProps: next.GetServerSideProps<{