@measured/puck 0.16.0-canary.7c79787 → 0.16.0-canary.937bb92

package/dist/index.d.ts

@@ -1,128 +1,26 @@
-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 { F as Field, a as FieldProps, C as Config, D as Data, I as ItemSelector, P as PuckAction, b as DropZoneProps, E as ExtractPropsFromConfig, c as ExtractRootPropsFromConfig, U as UiState, O as OnAction, d as Permissions, e as Plugin, f as Overrides, A as AppState, V as Viewports, g as IframeConfig, h as DefaultComponentProps, i as DefaultRootFieldProps, j as ComponentData } from './actions-DDAd8cys.js';
+export { H as Adaptor, z as ArrayField, p as ArrayState, $ as AsFieldProps, B as BaseData, w as BaseField, r as ComponentConfig, u as ComponentDataMap, v as Content, L as CustomField, Y as DefaultRootProps, X as DefaultRootRenderProps, K as ExternalField, J as ExternalFieldWithAdaptor, m as FieldRenderFunctions, Q as Fields, n as ItemWithId, M as MappedItem, N as NumberField, G as ObjectField, l as OverrideKey, q as PuckComponent, W as PuckContext, y as RadioField, t as RootData, R as RootDataWithProps, s as RootDataWithoutProps, S as SelectField, T as TextField, x as TextareaField, k as Viewport, a0 as WithChildren, Z as WithId, _ as WithPuckProps, o as overrideKeys } from './actions-DDAd8cys.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
 import { DragStart, DragUpdate } from '@measured/dnd';
 
-type InsertAction = {
-    type: "insert";
-    componentType: string;
-    destinationIndex: number;
-    destinationZone: string;
-    id?: string;
-};
-type DuplicateAction = {
-    type: "duplicate";
-    sourceIndex: number;
-    sourceZone: string;
-};
-type ReplaceAction = {
-    type: "replace";
-    destinationIndex: number;
-    destinationZone: string;
-    data: any;
-};
-type ReorderAction = {
-    type: "reorder";
-    sourceIndex: number;
-    destinationIndex: number;
-    destinationZone: string;
-};
-type MoveAction = {
-    type: "move";
-    sourceIndex: number;
-    sourceZone: string;
-    destinationIndex: number;
-    destinationZone: string;
-};
-type RemoveAction = {
-    type: "remove";
-    index: number;
-    zone: string;
-};
-type SetUiAction = {
-    type: "setUi";
-    ui: Partial<UiState> | ((previous: UiState) => Partial<UiState>);
-};
-type SetDataAction = {
-    type: "setData";
-    data: Partial<Data> | ((previous: Data) => Partial<Data>);
-};
-type SetAction = {
-    type: "set";
-    state: Partial<AppState> | ((previous: AppState) => Partial<AppState>);
-};
-type RegisterZoneAction = {
-    type: "registerZone";
-    zone: string;
-};
-type UnregisterZoneAction = {
-    type: "unregisterZone";
-    zone: string;
-};
-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<{
+declare const ActionBar: {
+    ({ label, children, }: {
+        label?: string;
         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> & {
+    }): react_jsx_runtime.JSX.Element;
+    Action: ({ children, label, onClick, }: {
         children: ReactNode;
-        name: string;
-    }>;
-};
-
-type Plugin = {
-    overrides: Partial<Overrides>;
+        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;
@@ -177,7 +75,7 @@ declare const Drawer: {
         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: ReactNode;
@@ -186,6 +84,7 @@ declare const Drawer: {
         id?: string;
         label?: string;
         index: number;
+        isDragDisabled?: boolean;
     }) => react_jsx_runtime.JSX.Element;
 };
 
@@ -208,8 +107,6 @@ type HistoryStore<D = any> = {
     setHistoryIndex: (index: number) => void;
 };
 
-type OnAction = (action: PuckAction, appState: AppState, prevAppState: AppState) => void;
-
 type PathData = Record<string, {
     path: string[];
     label: string;
@@ -262,27 +159,24 @@ declare const IconButton: ({ children, href, onClick, variant, type, disabled, t
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-type IframeConfig = {
-    enabled?: boolean;
-};
-
-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, }: {
+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 = 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;
-    onAction?: OnAction;
+    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;
@@ -306,14 +200,14 @@ declare namespace Puck {
     }) => 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 = 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];
@@ -322,18 +216,25 @@ 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: RootData<DefaultRootProps> | RootDataWithProps;
-    content: any;
-    zones: Record<string, MappedItem[]>;
-}>;
+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;
     dispatch: (action: PuckAction) => void;
+    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;
@@ -345,9 +246,7 @@ declare const usePuck: () => {
         index: number;
         historyStore: HistoryStore | undefined;
     };
-    selectedItem: ComponentData<DefaultComponentProps & {
-        id: string;
-    }> | null;
+    selectedItem: ComponentData<any, string> | null;
 };
 
-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 };
+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, IframeConfig, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, Render, UiState, Viewports, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };