@measured/puck 0.16.0-canary.54b5a87 → 0.16.0-canary.555902

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, E as ExtractPropsFromConfig, c as ExtractRootPropsFromConfig, P as Permissions, V as Viewports, d as DefaultComponentProps, e as DefaultRootFieldProps, f as ComponentData } from './Config-RpUGTBxI.js';
+export { v as Adaptor, u as ArrayField, q as ArrayState, B as BaseData, r as BaseField, l as ComponentConfig, m as ComponentDataMap, i as Content, y as CustomField, h as DefaultRootProps, g as DefaultRootRenderProps, x as ExternalField, w as ExternalFieldWithAdaptor, z as Fields, p as ItemWithId, M as MappedItem, N as NumberField, O as ObjectField, j as PuckComponent, k as PuckContext, t as RadioField, o as RootData, R as RootDataWithProps, n as RootDataWithoutProps, S as SelectField, T as TextField, s as TextareaField } from './Config-RpUGTBxI.js';
 import * as react from 'react';
-import { ReactNode, ReactElement, CSSProperties, SyntheticEvent } from 'react';
+import { ReactNode, ReactElement, SyntheticEvent, CSSProperties } 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";
@@ -48,9 +49,9 @@ type SetDataAction = {
     type: "setData";
     data: Partial<Data> | ((previous: Data) => Partial<Data>);
 };
-type SetAction = {
+type SetAction<UserData extends Data = Data> = {
     type: "set";
-    state: Partial<AppState> | ((previous: AppState) => Partial<AppState>);
+    state: Partial<AppState<UserData>> | ((previous: AppState<UserData>) => Partial<AppState<UserData>>);
 };
 type RegisterZoneAction = {
     type: "registerZone";
@@ -64,13 +65,97 @@ 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;
+    }>;
+    actionBar: RenderFunc<{
+        label?: string;
+        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;
+    }>;
+    iframe: RenderFunc<{
+        children: ReactNode;
+        document?: Document;
+    }>;
+    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 ActionBar: {
+    ({ label, children, }: {
+        label?: string;
+        children?: ReactNode;
+    }): react_jsx_runtime.JSX.Element;
+    Action: ({ children, label, onClick, }: {
+        children: ReactNode;
+        label?: string;
+        onClick: (e: SyntheticEvent) => void;
+    }) => react_jsx_runtime.JSX.Element;
+};
+declare const Action: ({ children, label, onClick, }: {
+    children: ReactNode;
+    label?: string;
+    onClick: (e: SyntheticEvent) => void;
+}) => react_jsx_runtime.JSX.Element;
+
 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 +183,59 @@ 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, }: {
+    Item: ({ name, children, id, label, index, isDragDisabled, }: {
         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;
+        isDragDisabled?: boolean;
     }) => 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<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
+
 type PathData = Record<string, {
     path: string[];
     label: string;
@@ -160,7 +267,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,113 +277,39 @@ 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, UserProps extends ExtractPropsFromConfig<UserConfig> = ExtractPropsFromConfig<UserConfig>, UserRootProps extends ExtractRootPropsFromConfig<UserConfig> = ExtractRootPropsFromConfig<UserConfig>, UserData extends Data<UserProps, UserRootProps> = Data<UserProps, UserRootProps>>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, onAction, permissions, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe, dnd, initialHistory, }: {
     children?: ReactNode;
     config: UserConfig;
-    data: Partial<Data>;
+    data: Partial<UserData>;
     ui?: Partial<UiState>;
-    onChange?: (data: Data) => void;
-    onPublish?: (data: Data) => void;
+    onChange?: (data: UserData) => void;
+    onPublish?: (data: UserData) => void;
+    onAction?: OnAction<UserData>;
+    permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
-        state: AppState;
+        state: AppState<UserData>;
     }) => ReactElement;
     renderHeaderActions?: (props: {
-        state: AppState;
+        state: AppState<UserData>;
         dispatch: (action: PuckAction) => void;
     }) => ReactElement;
     headerTitle?: string;
@@ -286,7 +319,7 @@ declare function Puck<UserConfig extends Config = Config>({ children, config, da
     dnd?: {
         disableAutoScroll?: boolean;
     };
-    initialHistories?: {
+    initialHistory?: {
         histories: History<any>[];
         index: number;
     };
@@ -296,18 +329,18 @@ 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;
 }
 
-declare function Render<UserConfig extends Config = Config>({ config, data, }: {
+declare function Render<UserConfig extends Config = Config, UserProps extends ExtractPropsFromConfig<UserConfig> = ExtractPropsFromConfig<UserConfig>, UserRootProps extends ExtractRootPropsFromConfig<UserConfig> = ExtractRootPropsFromConfig<UserConfig>, UserData extends Data<UserProps, UserRootProps> = Data<UserProps, UserRootProps>>({ config, data }: {
     config: UserConfig;
-    data: Partial<Data>;
+    data: Partial<UserData>;
 }): react_jsx_runtime.JSX.Element;
 
 declare function migrate(data: Data): Data;
 
-type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultRootProps = DefaultRootProps> = Partial<{
+type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
     [ComponentName in keyof Props]: (props: Props[ComponentName] & {
         [key: string]: any;
     }) => Props[ComponentName];
@@ -316,28 +349,37 @@ type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps,
         [key: string]: any;
     }) => RootProps;
 }>;
-declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultComponentProps>(data: Partial<Data>, propTransforms: PropTransform<Props, RootProps>): Data;
+declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(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[];
-    zones: Record<string, MappedItem[]>;
-}>;
-
-type PuckHistory = {
-    back: VoidFunction;
-    forward: VoidFunction;
-    historyStore: HistoryStore;
-};
+declare function resolveAllData<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends Record<string, any> = DefaultRootFieldProps>(data: Partial<Data>, config: Config, onResolveStart?: (item: ComponentData) => void, onResolveEnd?: (item: ComponentData) => void): Promise<Data<Props, RootProps>>;
 
 declare const usePuck: () => {
     appState: AppState;
-    config: Config<Record<string, any>, DefaultRootProps, string>;
+    config: Config;
     dispatch: (action: PuckAction) => void;
-    history: Partial<PuckHistory>;
-    selectedItem: ComponentData<DefaultComponentProps & {
-        id: string;
-    }> | null;
+    getPermissions: ({ item, type, }?: {
+        item?: ComponentData;
+        type?: keyof DefaultComponentProps;
+    }) => {
+        [x: string]: boolean | undefined;
+        drag?: boolean | undefined;
+        duplicate?: boolean | undefined;
+        delete?: boolean | undefined;
+        edit?: boolean | undefined;
+        insert?: boolean | undefined;
+    };
+    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<any, 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 { Action, ActionBar, AppState, AutoField, AutoFieldPrivate, Button, ComponentData, Config, Data, DefaultComponentProps, DefaultRootFieldProps, Drawer, DropZone, DropZoneProvider, ExtractPropsFromConfig, ExtractRootPropsFromConfig, Field, FieldLabel, FieldLabelInternal, FieldProps, type FieldPropsInternal, type History, IconButton, Permissions, type Plugin, Puck, type PuckAction, Render, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };