@uniformdev/canvas-next-rsc 19.79.1-alpha.11 → 19.79.1-alpha.18

package/LICENSE.txt

@@ -1,2 +1,2 @@
-© 2023 Uniform Systems, Inc. All Rights Reserved.
+© 2024 Uniform Systems, Inc. All Rights Reserved.
 See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/{UniformComposition-d178d865.d.ts → UniformComposition-0pvEHduc.d.mts}

@@ -61,4 +61,4 @@ type ResolveComponentsOptions = {
     mode: UniformCompositionProps['mode'];
 };
 
-export { ResolveComponentFunction as R, UniformCompositionProps as U, UniformComposition as a, ResolveComponentResult as b, resolveComposition as r };
+export { type ResolveComponentFunction as R, type UniformCompositionProps as U, UniformComposition as a, type ResolveComponentResult as b, resolveComposition as r };

package/dist/UniformComposition-0pvEHduc.d.ts

@@ -0,0 +1,64 @@
+import * as React$1 from 'react';
+import { ComponentType, ReactNode } from 'react';
+import { ResolvedRouteGetResponse, ComponentInstance } from '@uniformdev/canvas';
+import { PageParameters, ComponentProps, CompositionContext, AppDirectoryServerContext } from '@uniformdev/canvas-next-rsc-shared';
+
+type UniformStaticCompositionProps = {
+    /**
+     * How to render the composition.
+     */
+    mode: 'static';
+};
+type UniformServerCompositionProps = {
+    /**
+     * How to render the composition.
+     */
+    mode: 'server';
+    /**
+     * The Context instance to use for server-side rendering.
+     */
+    serverContext?: AppDirectoryServerContext;
+};
+type UniformCompositionProps = PageParameters & {
+    /**
+     * The route data to render.
+     */
+    route: ResolvedRouteGetResponse | undefined;
+    /**
+     * Function to map composition components to React components.
+     */
+    resolveComponent: ResolveComponentFunction;
+} & (UniformStaticCompositionProps | UniformServerCompositionProps);
+declare const UniformComposition: React.FC<UniformCompositionProps>;
+type ResolveComponentFunction = (options: {
+    component: ComponentInstance;
+}) => ResolveComponentResult;
+type ResolveComponentResult = {
+    component: ComponentType<ComponentProps<any, any>> | null;
+    includeContext?: boolean;
+};
+declare const resolveComposition: (props: Omit<ResolveComponentsOptions, 'slotName' | 'slotIndex' | 'target'> & {
+    composition: ComponentInstance;
+    compositionContext: CompositionContext;
+}) => React$1.FunctionComponentElement<{
+    children?: ReactNode;
+}> | null;
+type ResolveComponentsOptions = {
+    serverContext?: AppDirectoryServerContext;
+    target: {
+        type: 'root';
+        composition: ComponentInstance;
+    } | {
+        type: 'slot';
+        components: ComponentInstance[];
+        parent: ComponentInstance;
+        root: ComponentInstance;
+    };
+    slotName: string | undefined;
+    slotIndex: number | undefined;
+    resolveComponent: ResolveComponentFunction;
+    compositionContext: CompositionContext;
+    mode: UniformCompositionProps['mode'];
+};
+
+export { type ResolveComponentFunction as R, type UniformCompositionProps as U, UniformComposition as a, type ResolveComponentResult as b, resolveComposition as r };

package/dist/component.d.mts

@@ -1,7 +1,7 @@
 import { ComponentProps, CompositionContext, SlotDefinition } from '@uniformdev/canvas-next-rsc-shared';
 export { ComponentProps, CompositionContext } from '@uniformdev/canvas-next-rsc-shared';
 import React__default, { PropsWithChildren, ReactNode, Key } from 'react';
-export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-d178d865.js';
+export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-0pvEHduc.mjs';
 import { ComponentInstance } from '@uniformdev/canvas';
 import { RichTextNode } from '@uniformdev/richtext';
 import { PureUniformTextProps } from '@uniformdev/canvas-react/core';
@@ -59,6 +59,8 @@ type CustomSlotChildRenderFunc = (options: {
     child: ReactNode;
     component: ComponentInstance;
     key: Key;
+    slotName: string;
+    slotIndex: number;
 }) => JSX.Element;
 type UniformSlotProps = {
     data: ComponentInstance;
@@ -73,4 +75,4 @@ type UniformTextProps = {
 } & Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 declare const UniformText: ({ context, ...rest }: UniformTextProps) => React__default.JSX.Element;
 
-export { CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformText, UniformTextProps };
+export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };

package/dist/component.d.ts

@@ -1,7 +1,7 @@
 import { ComponentProps, CompositionContext, SlotDefinition } from '@uniformdev/canvas-next-rsc-shared';
 export { ComponentProps, CompositionContext } from '@uniformdev/canvas-next-rsc-shared';
 import React__default, { PropsWithChildren, ReactNode, Key } from 'react';
-export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-d178d865.js';
+export { R as ResolveComponentFunction, b as ResolveComponentResult } from './UniformComposition-0pvEHduc.js';
 import { ComponentInstance } from '@uniformdev/canvas';
 import { RichTextNode } from '@uniformdev/richtext';
 import { PureUniformTextProps } from '@uniformdev/canvas-react/core';
@@ -59,6 +59,8 @@ type CustomSlotChildRenderFunc = (options: {
     child: ReactNode;
     component: ComponentInstance;
     key: Key;
+    slotName: string;
+    slotIndex: number;
 }) => JSX.Element;
 type UniformSlotProps = {
     data: ComponentInstance;
@@ -73,4 +75,4 @@ type UniformTextProps = {
 } & Omit<PureUniformTextProps, 'skipCustomRendering' | 'isContextualEditing'>;
 declare const UniformText: ({ context, ...rest }: UniformTextProps) => React__default.JSX.Element;
 
-export { CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, UniformRichTextProps, UniformSlot, UniformSlotProps, UniformText, UniformTextProps };
+export { type CustomSlotChildRenderFunc, DefaultNotImplementedComponent, UniformRichText, type UniformRichTextProps, UniformSlot, type UniformSlotProps, UniformText, type UniformTextProps };

package/dist/component.js

@@ -181,7 +181,9 @@ var UniformSlot = ({ data, slot, children }) => {
         const result = children({
           child,
           component: targetSlotData[i],
-          key: `inner-${i}`
+          key: `inner-${i}`,
+          slotName: slot.name,
+          slotIndex: i
         });
         resolved.push(result);
       }

package/dist/component.mjs

@@ -142,7 +142,9 @@ var UniformSlot = ({ data, slot, children }) => {
         const result = children({
           child,
           component: targetSlotData[i],
-          key: `inner-${i}`
+          key: `inner-${i}`,
+          slotName: slot.name,
+          slotIndex: i
         });
         resolved.push(result);
       }

package/dist/handler.d.mts

@@ -1,12 +1,23 @@
 import { NextRequest } from 'next/server';
 
+type ResolveFullPath = (options: {
+    /** The ID of the composition */
+    id?: string;
+    /** The slug of the composition */
+    slug?: string;
+    /** The path of the project map node attached to the composition, if there is one */
+    path?: string;
+    /** The preview locale selected in Visual Canvas, available only if Localization is set up */
+    locale?: string;
+}) => string | undefined;
 type CreatePreviewGETRouteHandlerOptions = {
+    resolveFullPath?: ResolveFullPath;
     playgroundPath?: string;
 };
-declare const createPreviewGETRouteHandler: (options?: CreatePreviewGETRouteHandlerOptions) => (request: NextRequest) => Promise<Response>;
+declare const createPreviewGETRouteHandler: (options?: CreatePreviewGETRouteHandlerOptions) => (request: NextRequest) => Promise<Response | undefined>;
 
 declare const createPreviewOPTIONSRouteHandler: () => () => Promise<Response>;
 
-declare const createPreviewPOSTRouteHandler: () => (request: Request) => Promise<Response>;
+declare const createPreviewPOSTRouteHandler: () => (request: NextRequest) => Promise<Response>;
 
-export { CreatePreviewGETRouteHandlerOptions, createPreviewGETRouteHandler, createPreviewOPTIONSRouteHandler, createPreviewPOSTRouteHandler };
+export { type CreatePreviewGETRouteHandlerOptions, createPreviewGETRouteHandler, createPreviewOPTIONSRouteHandler, createPreviewPOSTRouteHandler };

package/dist/handler.d.ts

@@ -1,12 +1,23 @@
 import { NextRequest } from 'next/server';
 
+type ResolveFullPath = (options: {
+    /** The ID of the composition */
+    id?: string;
+    /** The slug of the composition */
+    slug?: string;
+    /** The path of the project map node attached to the composition, if there is one */
+    path?: string;
+    /** The preview locale selected in Visual Canvas, available only if Localization is set up */
+    locale?: string;
+}) => string | undefined;
 type CreatePreviewGETRouteHandlerOptions = {
+    resolveFullPath?: ResolveFullPath;
     playgroundPath?: string;
 };
-declare const createPreviewGETRouteHandler: (options?: CreatePreviewGETRouteHandlerOptions) => (request: NextRequest) => Promise<Response>;
+declare const createPreviewGETRouteHandler: (options?: CreatePreviewGETRouteHandlerOptions) => (request: NextRequest) => Promise<Response | undefined>;
 
 declare const createPreviewOPTIONSRouteHandler: () => () => Promise<Response>;
 
-declare const createPreviewPOSTRouteHandler: () => (request: Request) => Promise<Response>;
+declare const createPreviewPOSTRouteHandler: () => (request: NextRequest) => Promise<Response>;
 
-export { CreatePreviewGETRouteHandlerOptions, createPreviewGETRouteHandler, createPreviewOPTIONSRouteHandler, createPreviewPOSTRouteHandler };
+export { type CreatePreviewGETRouteHandlerOptions, createPreviewGETRouteHandler, createPreviewOPTIONSRouteHandler, createPreviewPOSTRouteHandler };