@measured/puck 0.16.0-canary.0c7fc83 → 0.16.0-canary.3298831

package/dist/{Config-041c35a2.d.ts → Config-VOJqVbHe.d.ts}

@@ -68,7 +68,7 @@ type ObjectField<Props extends {
     [key: string]: any;
 }> = BaseField & {
     type: "object";
-    objectFields: {
+    objectFields: Props extends any[] ? never : {
         [SubPropName in keyof Props]: Field<Props[SubPropName]>;
     };
 };
@@ -259,4 +259,4 @@ type AppState = {
     ui: UiState;
 };
 
-export { AppState as A, BaseData as B, Config as C, Data as D, ExternalFieldWithAdaptor as E, Field as F, ItemSelector as I, MappedItem as M, NumberField as N, ObjectField as O, PuckComponent as P, RootDataWithProps as R, SelectField as S, TextField as T, UiState as U, Viewports as V, FieldProps as a, DefaultRootProps as b, DropZoneProps as c, DefaultComponentProps as d, RootData as e, ComponentData as f, Content as g, PuckContext as h, ComponentConfig as i, RootDataWithoutProps as j, ItemWithId as k, ArrayState as l, BaseField as m, TextareaField as n, RadioField as o, ArrayField as p, Adaptor as q, ExternalField as r, CustomField as s, Fields as t };
+export type { AppState as A, BaseData as B, Config as C, Data as D, ExternalFieldWithAdaptor as E, Field as F, ItemSelector as I, MappedItem as M, NumberField as N, ObjectField as O, PuckComponent as P, RootData as R, SelectField as S, TextField as T, UiState as U, Viewports as V, FieldProps as a, DropZoneProps as b, DefaultComponentProps as c, DefaultRootProps as d, RootDataWithProps as e, ComponentData as f, Content as g, PuckContext as h, ComponentConfig as i, RootDataWithoutProps as j, ItemWithId as k, ArrayState as l, BaseField as m, TextareaField as n, RadioField as o, ArrayField as p, Adaptor as q, ExternalField as r, CustomField as s, Fields as t };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { U as UiState, D as Data, A as AppState, F as Field, a as FieldProps, C as Config, b as DefaultRootProps, I as ItemSelector, c as DropZoneProps, V as Viewports, d as DefaultComponentProps, M as MappedItem, R as RootDataWithProps, e as RootData, f as ComponentData } from './Config-041c35a2.js';
-export { q as Adaptor, p as ArrayField, l as ArrayState, B as BaseData, m as BaseField, i as ComponentConfig, g as Content, s as CustomField, r as ExternalField, E as ExternalFieldWithAdaptor, t as Fields, k as ItemWithId, N as NumberField, O as ObjectField, P as PuckComponent, h as PuckContext, o as RadioField, j as RootDataWithoutProps, S as SelectField, T as TextField, n as TextareaField } from './Config-041c35a2.js';
-import * as react_jsx_runtime from 'react/jsx-runtime';
+import { U as UiState, D as Data, A as AppState, I as ItemSelector, F as Field, a as FieldProps, C as Config, b as DropZoneProps, V as Viewports, c as DefaultComponentProps, d as DefaultRootProps, M as MappedItem, R as RootData, e as RootDataWithProps, f as ComponentData } from './Config-VOJqVbHe.js';
+export { q as Adaptor, p as ArrayField, l as ArrayState, B as BaseData, m as BaseField, i as ComponentConfig, g as Content, s as CustomField, r as ExternalField, E as ExternalFieldWithAdaptor, t as Fields, k as ItemWithId, N as NumberField, O as ObjectField, P as PuckComponent, h as PuckContext, o as RadioField, j as RootDataWithoutProps, S as SelectField, T as TextField, n as TextareaField } from './Config-VOJqVbHe.js';
 import * as react from 'react';
 import { ReactNode, ReactElement, CSSProperties, SyntheticEvent } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import { DragStart, DragUpdate } from '@measured/dnd';
 
 type InsertAction = {
@@ -10,6 +10,7 @@ type InsertAction = {
     componentType: string;
     destinationIndex: number;
     destinationZone: string;
+    id?: string;
 };
 type DuplicateAction = {
     type: "duplicate";
@@ -64,13 +65,72 @@ type PuckAction = {
     recordHistory?: boolean;
 } & (ReorderAction | InsertAction | MoveAction | ReplaceAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
 
+type RenderFunc<Props extends {
+    [key: string]: any;
+} = {
+    children: ReactNode;
+}> = (props: Props) => ReactElement;
+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;
+    }>;
+    headerActions: RenderFunc<{
+        children: ReactNode;
+    }>;
+    preview: RenderFunc;
+    fields: RenderFunc<{
+        children: ReactNode;
+        isLoading: boolean;
+        itemSelector?: ItemSelector | null;
+    }>;
+    fieldLabel: RenderFunc<{
+        children?: ReactNode;
+        icon?: ReactNode;
+        label: string;
+        el?: "label" | "div";
+        readOnly?: boolean;
+        className?: string;
+    }>;
+    components: RenderFunc;
+    componentItem: RenderFunc<{
+        children: ReactNode;
+        name: string;
+    }>;
+    outline: RenderFunc;
+    puck: RenderFunc;
+}>;
+type FieldRenderFunctions = Omit<{
+    [Type in Field["type"]]: React.FunctionComponent<FieldProps<Extract<Field, {
+        type: Type;
+    }>> & {
+        children: ReactNode;
+        name: string;
+    }>;
+}, "custom"> & {
+    [key: string]: React.FunctionComponent<FieldProps<any> & {
+        children: ReactNode;
+        name: string;
+    }>;
+};
+
+type Plugin = {
+    overrides: Partial<Overrides>;
+};
+
 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;
+    el?: "label" | "div";
+    readOnly?: boolean;
+    className?: string;
 }) => react_jsx_runtime.JSX.Element;
 type FieldLabelPropsInternal = {
     children?: ReactNode;
@@ -98,37 +158,58 @@ declare function AutoField<ValueType = any, FieldType extends Field<ValueType> =
 
 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;
-    variant?: "primary" | "secondary" | undefined;
-    type?: "button" | "submit" | "reset" | undefined;
-    disabled?: boolean | undefined;
-    tabIndex?: number | undefined;
-    newTab?: boolean | undefined;
-    fullWidth?: boolean | undefined;
+    href?: string;
+    onClick?: (e: any) => void | Promise<void>;
+    variant?: "primary" | "secondary";
+    type?: "button" | "submit" | "reset";
+    disabled?: boolean;
+    tabIndex?: number;
+    newTab?: boolean;
+    fullWidth?: boolean;
     icon?: ReactNode;
-    size?: "medium" | "large" | undefined;
-    loading?: boolean | undefined;
+    size?: "medium" | "large";
+    loading?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
 declare const Drawer: {
     ({ children, droppableId: _droppableId, direction, }: {
         children: ReactNode;
-        droppableId?: string | undefined;
-        direction?: "vertical" | "horizontal" | undefined;
+        droppableId?: string;
+        direction?: "vertical" | "horizontal";
     }): react_jsx_runtime.JSX.Element;
     Item: ({ name, children, id, label, index, }: {
         name: string;
-        children?: ((props: {
+        children?: (props: {
             children: ReactNode;
             name: string;
-        }) => ReactElement) | undefined;
-        id?: string | undefined;
-        label?: string | undefined;
+        }) => ReactElement;
+        id?: string;
+        label?: string;
         index: number;
     }) => react_jsx_runtime.JSX.Element;
 };
 
+type History<D = any> = {
+    id: string;
+    data: D;
+};
+type HistoryStore<D = any> = {
+    index: number;
+    hasPast: boolean;
+    hasFuture: boolean;
+    histories: History<D>[];
+    record: (data: D) => void;
+    back: VoidFunction;
+    forward: VoidFunction;
+    currentHistory: History;
+    nextHistory: History<D> | null;
+    prevHistory: History<D> | null;
+    setHistories: (histories: History[]) => void;
+    setHistoryIndex: (index: number) => void;
+};
+
+type OnAction = (action: PuckAction, appState: AppState, prevAppState: AppState) => void;
+
 type PathData = Record<string, {
     path: string[];
     label: string;
@@ -160,7 +241,7 @@ type DropZoneContext<UserConfig extends Config = Config> = {
     zoneWillDrag?: string;
     setZoneWillDrag?: (zone: string) => void;
 } | null;
-declare const dropZoneContext: react.Context<DropZoneContext<Config<Record<string, any>, DefaultRootProps, string>>>;
+declare const dropZoneContext: react.Context<DropZoneContext<Config>>;
 declare const DropZoneProvider: ({ children, value, }: {
     children: ReactNode;
     value: DropZoneContext;
@@ -170,104 +251,29 @@ declare function DropZone(props: DropZoneProps): react_jsx_runtime.JSX.Element;
 
 declare const IconButton: ({ children, href, onClick, variant, type, disabled, tabIndex, newTab, fullWidth, title, }: {
     children: ReactNode;
-    href?: string | undefined;
-    onClick?: ((e: SyntheticEvent) => void | Promise<void>) | undefined;
-    variant?: "primary" | "secondary" | undefined;
-    type?: "button" | "submit" | "reset" | undefined;
-    disabled?: boolean | undefined;
-    tabIndex?: number | undefined;
-    newTab?: boolean | undefined;
-    fullWidth?: boolean | undefined;
+    href?: string;
+    onClick?: (e: SyntheticEvent) => void | Promise<void>;
+    variant?: "primary" | "secondary";
+    type?: "button" | "submit" | "reset";
+    disabled?: boolean;
+    tabIndex?: number;
+    newTab?: boolean;
+    fullWidth?: boolean;
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-type RenderFunc<Props extends {
-    [key: string]: any;
-} = {
-    children: ReactNode;
-}> = (props: Props) => ReactElement;
-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;
-    }>;
-    headerActions: RenderFunc<{
-        children: ReactNode;
-    }>;
-    preview: RenderFunc;
-    fields: RenderFunc<{
-        children: ReactNode;
-        isLoading: boolean;
-        itemSelector?: ItemSelector | null;
-    }>;
-    fieldLabel: RenderFunc<{
-        children?: ReactNode;
-        icon?: ReactNode;
-        label: string;
-        el?: "label" | "div";
-        readOnly?: boolean;
-        className?: string;
-    }>;
-    components: RenderFunc;
-    componentItem: RenderFunc<{
-        children: ReactNode;
-        name: string;
-    }>;
-    outline: RenderFunc;
-    puck: RenderFunc;
-}>;
-type FieldRenderFunctions = Omit<{
-    [Type in Field["type"]]: React.FunctionComponent<FieldProps<Extract<Field, {
-        type: Type;
-    }>> & {
-        children: ReactNode;
-        name: string;
-    }>;
-}, "custom"> & {
-    [key: string]: React.FunctionComponent<FieldProps<any> & {
-        children: ReactNode;
-        name: string;
-    }>;
-};
-
-type Plugin = {
-    overrides: Partial<Overrides>;
-};
-
-type History<D = any> = {
-    id: string;
-    data: D;
-};
-type HistoryStore<D = any> = {
-    index: number;
-    currentHistory: History;
-    hasPast: boolean;
-    hasFuture: boolean;
-    record: (data: D) => void;
-    back: VoidFunction;
-    forward: VoidFunction;
-    nextHistory: History<D> | null;
-    prevHistory: History<D> | null;
-    histories: History<D>[];
-};
-
 type IframeConfig = {
     enabled?: boolean;
 };
 
-declare function Puck<UserConfig extends Config = Config>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe, dnd, initialHistories, }: {
+declare function Puck<UserConfig extends Config = Config>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, onAction, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe, dnd, initialHistory, }: {
     children?: ReactNode;
     config: UserConfig;
     data: Partial<Data>;
     ui?: Partial<UiState>;
     onChange?: (data: Data) => void;
     onPublish?: (data: Data) => void;
+    onAction?: OnAction;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
     renderHeader?: (props: {
@@ -286,7 +292,7 @@ declare function Puck<UserConfig extends Config = Config>({ children, config, da
     dnd?: {
         disableAutoScroll?: boolean;
     };
-    initialHistories?: {
+    initialHistory?: {
         histories: History<any>[];
         index: number;
     };
@@ -296,7 +302,7 @@ declare namespace Puck {
     var Fields: () => react_jsx_runtime.JSX.Element;
     var Outline: () => react_jsx_runtime.JSX.Element;
     var Preview: ({ id }: {
-        id?: string | undefined;
+        id?: string;
     }) => react_jsx_runtime.JSX.Element;
 }
 
@@ -319,25 +325,29 @@ type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps,
 declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultComponentProps>(data: Partial<Data>, propTransforms: PropTransform<Props, RootProps>): Data;
 
 declare function resolveAllData(data: Partial<Data>, config: Config, onResolveStart?: (item: MappedItem) => void, onResolveEnd?: (item: MappedItem) => void): Promise<{
-    root: RootDataWithProps<DefaultRootProps> | RootData<DefaultRootProps>;
-    content: any[];
+    root: RootData<DefaultRootProps> | RootDataWithProps;
+    content: any;
     zones: Record<string, MappedItem[]>;
 }>;
 
-type PuckHistory = {
-    back: VoidFunction;
-    forward: VoidFunction;
-    historyStore: HistoryStore;
-};
-
 declare const usePuck: () => {
     appState: AppState;
-    config: Config<Record<string, any>, DefaultRootProps, string>;
+    config: Config;
     dispatch: (action: PuckAction) => void;
-    history: Partial<PuckHistory>;
+    history: {
+        back: VoidFunction;
+        forward: VoidFunction;
+        setHistories: (histories: History[]) => void;
+        setHistoryIndex: (index: number) => void;
+        hasPast: boolean;
+        hasFuture: boolean;
+        histories: History<any>[];
+        index: number;
+        historyStore: HistoryStore | undefined;
+    };
     selectedItem: ComponentData<DefaultComponentProps & {
         id: string;
     }> | null;
 };
 
-export { AppState, AutoField, AutoFieldPrivate, Button, ComponentData, Config, Data, DefaultComponentProps, DefaultRootProps, Drawer, DropZone, DropZoneProvider, Field, FieldLabel, FieldLabelInternal, FieldProps, FieldPropsInternal, IconButton, MappedItem, Puck, PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };
+export { AppState, AutoField, AutoFieldPrivate, Button, ComponentData, Config, Data, DefaultComponentProps, DefaultRootProps, Drawer, DropZone, DropZoneProvider, Field, FieldLabel, FieldLabelInternal, FieldProps, type FieldPropsInternal, type History, IconButton, MappedItem, type Plugin, Puck, type PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };