@measured/puck 0.12.1-canary.1c3372b → 0.13.0-canary.10a6025

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { D as Data, C as Config, I as ItemSelector, U as UiState, A as AppState, M as MappedItem, R as RootDataWithProps, a as DefaultRootProps, b as RootData } from './Config-35e6eaae.js';
-export { d as Adaptor, c as ArrayField, p as ArrayState, l as BaseData, B as BaseField, k as ComponentConfig, m as ComponentData, i as Content, f as CustomField, g as DefaultComponentProps, q as DropZone, e as ExternalField, E as ExternalFieldWithAdaptor, F as Field, h as Fields, o as ItemWithId, P as PuckComponent, j as PuckContext, n as RootDataWithoutProps, S as SelectField, T as TextField } from './Config-35e6eaae.js';
+import { D as Data, C as Config, I as ItemSelector, U as UiState, A as AppState, F as Field, a as DefaultComponentProps, b as DefaultRootProps, M as MappedItem, R as RootDataWithProps, c as RootData } from './Config-4367c689.js';
+export { g as Adaptor, f as ArrayField, r as ArrayState, n as BaseData, B as BaseField, m as ComponentConfig, o as ComponentData, k as Content, i as CustomField, s as DropZone, h as ExternalField, E as ExternalFieldWithAdaptor, j as Fields, q as ItemWithId, N as NumberField, O as ObjectField, P as PuckComponent, l as PuckContext, e as RadioField, p as RootDataWithoutProps, S as SelectField, T as TextField, d as TextareaField } from './Config-4367c689.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { ReactNode, CSSProperties, SyntheticEvent, ReactElement } from 'react';
+import { ReactNode, CSSProperties, ReactElement, SyntheticEvent } from 'react';
 import { DragStart, DragUpdate } from '@hello-pangea/dnd';
 
 type PathData = Record<string, {
@@ -33,6 +33,7 @@ type DropZoneContext = {
     pathData?: PathData;
     registerPath?: (selector: ItemSelector) => void;
     mode?: "edit" | "render";
+    disableZoom?: boolean;
 } | null;
 declare const dropZoneContext: react.Context<DropZoneContext>;
 declare const DropZoneProvider: ({ children, value, }: {
@@ -99,7 +100,7 @@ type PuckAction = {
     recordHistory?: boolean;
 } & (ReorderAction | InsertAction | MoveAction | ReplaceAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
 
-declare const Button: ({ children, href, onClick, variant, type, disabled, tabIndex, newTab, fullWidth, icon, size, }: {
+declare const Button: ({ children, href, onClick, variant, type, disabled, tabIndex, newTab, fullWidth, icon, size, loading: loadingProp, }: {
     children: ReactNode;
     href?: string | undefined;
     onClick?: ((e: any) => void | Promise<void>) | undefined;
@@ -111,8 +112,25 @@ declare const Button: ({ children, href, onClick, variant, type, disabled, tabIn
     fullWidth?: boolean | undefined;
     icon?: ReactNode;
     size?: "medium" | "large" | undefined;
+    loading?: boolean | undefined;
 }) => react_jsx_runtime.JSX.Element;
 
+declare const Drawer: {
+    ({ children, droppableId, direction, }: {
+        children: ReactNode;
+        droppableId?: string | undefined;
+        direction?: "horizontal" | "vertical" | undefined;
+    }): react_jsx_runtime.JSX.Element;
+    Item: ({ name, children, id, index, }: {
+        name: string;
+        children?: ((props: {
+            children: ReactNode;
+        }) => ReactElement) | undefined;
+        id?: string | undefined;
+        index: number;
+    }) => react_jsx_runtime.JSX.Element;
+};
+
 declare const IconButton: ({ children, href, onClick, variant, type, disabled, tabIndex, newTab, fullWidth, title, }: {
     children: ReactNode;
     href?: string | undefined;
@@ -126,35 +144,88 @@ declare const IconButton: ({ children, href, onClick, variant, type, disabled, t
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-type Plugin = {
-    renderRootFields?: (props: {
+declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }: {
+    children?: ReactNode;
+    icon?: ReactNode;
+    label: string;
+    el?: "label" | "div" | undefined;
+    readOnly?: boolean | undefined;
+    className?: string | undefined;
+}) => react_jsx_runtime.JSX.Element;
+type InputProps<F = Field<any>> = {
+    name: string;
+    field: F;
+    value: any;
+    id: string;
+    label?: string;
+    onChange: (value: any, uiState?: Partial<UiState>) => void;
+    readOnly?: boolean;
+    readOnlyFields?: Record<string, boolean | undefined>;
+};
+
+type RenderFunc<Props extends {
+    [key: string]: any;
+} = {
+    children: ReactNode;
+}> = React.FunctionComponent<Props>;
+declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
+type OverrideKey = (typeof overrideKeys)[number];
+type OverridesGeneric<Shape extends {
+    [key in OverrideKey]: any;
+}> = Shape;
+type Overrides = OverridesGeneric<{
+    fieldTypes: Partial<FieldRenderFunctions>;
+    header: RenderFunc<{
+        actions: ReactNode;
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
-    renderRoot?: (props: {
+    }>;
+    headerActions: RenderFunc<{
+        children?: ReactNode;
+    }>;
+    preview: RenderFunc;
+    fields: RenderFunc<{
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
-    renderFields?: (props: {
+        isLoading: boolean;
+        itemSelector?: ItemSelector | null;
+    }>;
+    fieldLabel: RenderFunc<{
+        children?: ReactNode;
+        icon?: ReactNode;
+        label: string;
+        el?: "label" | "div";
+        readOnly?: boolean;
+        className?: string;
+    }>;
+    components: RenderFunc;
+    componentItem: RenderFunc;
+    outline: RenderFunc;
+    puck: RenderFunc;
+}>;
+type FieldRenderFunctions = Omit<{
+    [Type in Field["type"]]: React.FunctionComponent<InputProps<Extract<Field, {
+        type: Type;
+    }>> & {
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
+    }>;
+}, "custom"> & {
+    [key: string]: React.FunctionComponent<InputProps<any> & {
+        children: ReactNode;
+    }>;
 };
 
-declare function Puck({ config, data: initialData, onChange, onPublish, plugins, renderComponentList, renderHeader, renderHeaderActions, headerTitle, headerPath, }: {
-    config: Config;
+type Plugin = {
+    overrides: Partial<Overrides>;
+};
+
+declare function Puck({ children, config, data: initialData, ui: initialUi, onChange, onPublish, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, }: {
+    children?: ReactNode;
+    config: Config<any, any, any>;
     data: Data;
+    ui?: Partial<UiState>;
     onChange?: (data: Data) => void;
-    onPublish: (data: Data) => void;
+    onPublish?: (data: Data) => void;
     plugins?: Plugin[];
-    renderComponentList?: (props: {
-        children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement;
+    overrides?: Partial<Overrides>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
@@ -167,25 +238,45 @@ declare function Puck({ config, data: initialData, onChange, onPublish, plugins,
     headerTitle?: string;
     headerPath?: string;
 }): react_jsx_runtime.JSX.Element;
+declare namespace Puck {
+    var Components: () => react_jsx_runtime.JSX.Element;
+    var Fields: () => react_jsx_runtime.JSX.Element;
+    var Outline: () => react_jsx_runtime.JSX.Element;
+    var Preview: ({ id }: {
+        id?: string | undefined;
+    }) => react_jsx_runtime.JSX.Element;
+}
 
-declare function Render({ config, data }: {
-    config: Config;
+declare function Render({ config, data, }: {
+    config: Config<any, any, any>;
     data: Data;
 }): react_jsx_runtime.JSX.Element;
 
-declare const resolveAllData: (data: Data, config: Config, onResolveStart?: ((item: MappedItem) => void) | undefined, onResolveEnd?: ((item: MappedItem) => void) | undefined) => Promise<{
+declare function migrate(data: Data): Data;
+
+type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultRootProps = DefaultRootProps> = Partial<{
+    [ComponentName in keyof Props]: (props: Props[ComponentName] & {
+        [key: string]: any;
+    }) => Props[ComponentName];
+} & {
+    root: (props: RootProps & {
+        [key: string]: any;
+    }) => RootProps;
+}>;
+declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultComponentProps>(data: Data, propTransforms: PropTransform<Props, RootProps>): Data;
+
+declare const resolveAllData: (data: Data, config: Config<any, any, any>, onResolveStart?: ((item: MappedItem) => void) | undefined, onResolveEnd?: ((item: MappedItem) => void) | undefined) => Promise<{
     root: RootDataWithProps<DefaultRootProps> | RootData<DefaultRootProps>;
     content: any[];
     zones: Record<string, MappedItem[]>;
 }>;
 
-declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }: {
-    children?: ReactNode;
-    icon?: ReactNode;
-    label: string;
-    el?: "label" | "div" | undefined;
-    readOnly?: boolean | undefined;
-    className?: string | undefined;
-}) => react_jsx_runtime.JSX.Element;
+declare const usePuck: () => {
+    appState: AppState;
+    config: Config<{
+        [key: string]: any;
+    }, DefaultRootProps, string>;
+    dispatch: (action: PuckAction) => void;
+};
 
-export { AppState, Button, Config, Data, DefaultRootProps, DropZoneProvider, FieldLabel, IconButton, MappedItem, Puck, PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, resolveAllData };
+export { AppState, Button, Config, Data, DefaultComponentProps, DefaultRootProps, Drawer, DropZoneProvider, Field, FieldLabel, IconButton, MappedItem, Puck, PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };