@measured/puck 0.16.0-canary.60fe631 → 0.16.0-canary.6d43ba0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-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 { U as UiState, D as Data, A as AppState, I as ItemSelector, F as Field, a as FieldProps, C as Config, b as DropZoneProps, P as Permissions, V as Viewports, c as DefaultComponentProps, d as DefaultRootFieldProps, e as ComponentData, R as RootData, f as RootDataWithProps, g as Content } from './Config-XUGMjfT5.js';
+export { u as Adaptor, t as ArrayField, p as ArrayState, B as BaseData, q as BaseField, l as ComponentConfig, m as ComponentDataMap, w as CustomField, i as DefaultRootProps, h as DefaultRootRenderProps, v as ExternalField, E as ExternalFieldWithAdaptor, x as Fields, o as ItemWithId, M as MappedItem, N as NumberField, O as ObjectField, j as PuckComponent, k as PuckContext, s as RadioField, n as RootDataWithoutProps, S as SelectField, T as TextField, r as TextareaField } from './Config-XUGMjfT5.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';
 
@@ -10,6 +10,7 @@ type InsertAction = {
     componentType: string;
     destinationIndex: number;
     destinationZone: string;
+    id?: string;
 };
 type DuplicateAction = {
     type: "duplicate";
@@ -80,6 +81,10 @@ type Overrides = OverridesGeneric<{
         actions: ReactNode;
         children: ReactNode;
     }>;
+    actionBar: RenderFunc<{
+        label?: string;
+        children: ReactNode;
+    }>;
     headerActions: RenderFunc<{
         children: ReactNode;
     }>;
@@ -102,6 +107,10 @@ type Overrides = OverridesGeneric<{
         children: ReactNode;
         name: string;
     }>;
+    iframe: RenderFunc<{
+        children: ReactNode;
+        document?: Document;
+    }>;
     outline: RenderFunc;
     puck: RenderFunc;
 }>;
@@ -123,6 +132,23 @@ 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;
@@ -176,7 +202,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;
@@ -185,6 +211,7 @@ declare const Drawer: {
         id?: string;
         label?: string;
         index: number;
+        isDragDisabled?: boolean;
     }) => react_jsx_runtime.JSX.Element;
 };
 
@@ -207,6 +234,8 @@ 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;
@@ -263,13 +292,15 @@ 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, initialHistory, }: {
+declare function Puck<UserConfig extends Config = Config>({ 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>;
     ui?: Partial<UiState>;
     onChange?: (data: Data) => void;
     onPublish?: (data: Data) => void;
+    onAction?: OnAction;
+    permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
     renderHeader?: (props: {
@@ -309,7 +340,7 @@ declare function Render<UserConfig extends Config = Config>({ config, data, }: {
 
 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];
@@ -318,18 +349,29 @@ 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<{
+    root: RootData<DefaultRootFieldProps> | RootDataWithProps;
+    content: Content<Props>;
+    zones: Record<string, Content<Props>>;
 }>;
 
 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;
@@ -341,9 +383,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, Content, Data, DefaultComponentProps, DefaultRootFieldProps, Drawer, DropZone, DropZoneProvider, Field, FieldLabel, FieldLabelInternal, FieldProps, type FieldPropsInternal, type History, IconButton, Permissions, type Plugin, Puck, type PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };