@measured/puck 0.16.0-canary.f761e5f → 0.16.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-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.mjs';
-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.mjs';
+import { F as Field, a as FieldProps, C as Config, D as Data, I as ItemSelector, P as PuckAction, b as DropZoneProps, U as UserGenerics, c as UiState, O as OnAction, d as Permissions, e as Plugin, f as Overrides, V as Viewports, g as IframeConfig, h as InitialHistory, i as DefaultComponentProps, j as DefaultRootFieldProps, k as ComponentData, H as History, A as AppState, E as ExtractPropsFromConfig, l as ExtractRootPropsFromConfig, m as ComponentDataMap } from './actions-9pHbVtMU.mjs';
+export { L as Adaptor, J as ArrayField, s as ArrayState, a2 as AsFieldProps, B as BaseData, y as BaseField, u as ComponentConfig, x as Content, X as CustomField, $ as DefaultRootProps, _ as DefaultRootRenderProps, W as ExternalField, Q as ExternalFieldWithAdaptor, q as FieldRenderFunctions, Y as Fields, r as ItemWithId, M as MappedItem, N as NumberField, K as ObjectField, p as OverrideKey, t as PuckComponent, Z as PuckContext, G as RadioField, w as RootData, R as RootDataWithProps, v as RootDataWithoutProps, S as SelectField, T as TextField, z as TextareaField, n as Viewport, a3 as WithChildren, a0 as WithId, a1 as WithPuckProps, o as overrideKeys } from './actions-9pHbVtMU.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
@@ -15,12 +15,18 @@ declare const ActionBar: {
         label?: string;
         onClick: (e: SyntheticEvent) => void;
     }) => react_jsx_runtime.JSX.Element;
+    Group: ({ children }: {
+        children: ReactNode;
+    }) => 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 Group: ({ children }: {
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }: {
     children?: ReactNode;
@@ -88,25 +94,6 @@ declare const Drawer: {
     }) => 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 PathData = Record<string, {
     path: string[];
     label: string;
@@ -159,24 +146,24 @@ declare const IconButton: ({ children, href, onClick, variant, type, disabled, t
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-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, }: {
+declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, onAction, permissions, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe: _iframe, dnd, initialHistory: _initialHistory, }: {
     children?: ReactNode;
     config: UserConfig;
-    data: Partial<UserData>;
+    data: Partial<G["UserData"] | Data>;
     ui?: Partial<UiState>;
-    onChange?: (data: UserData) => void;
-    onPublish?: (data: UserData) => void;
-    onAction?: OnAction<UserData>;
+    onChange?: (data: G["UserData"]) => void;
+    onPublish?: (data: G["UserData"]) => void;
+    onAction?: OnAction<G["UserData"]>;
     permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
-        state: AppState<UserData>;
+        state: G["UserAppState"];
     }) => ReactElement;
     renderHeaderActions?: (props: {
-        state: AppState<UserData>;
+        state: G["UserAppState"];
         dispatch: (action: PuckAction) => void;
     }) => ReactElement;
     headerTitle?: string;
@@ -186,10 +173,7 @@ declare function Puck<UserConfig extends Config = Config, UserProps extends Extr
     dnd?: {
         disableAutoScroll?: boolean;
     };
-    initialHistory?: {
-        histories: History<any>[];
-        index: number;
-    };
+    initialHistory?: InitialHistory;
 }): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
     var Components: () => react_jsx_runtime.JSX.Element;
@@ -200,9 +184,9 @@ declare namespace Puck {
     }) => react_jsx_runtime.JSX.Element;
 }
 
-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 }: {
+declare function Render<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ config, data, }: {
     config: UserConfig;
-    data: Partial<UserData>;
+    data: Partial<G["UserData"] | Data>;
 }): react_jsx_runtime.JSX.Element;
 
 declare function migrate(data: Data): Data;
@@ -220,21 +204,35 @@ declare function transformProps<Props extends DefaultComponentProps = DefaultCom
 
 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;
+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 PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    item?: G["UserComponentData"];
+    type?: keyof G["UserProps"];
+    root?: boolean;
+};
+type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Partial<Permissions>;
+type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+
+declare const usePuck: <UserConfig extends Config = Config>() => {
+    appState: AppState<Data<ExtractPropsFromConfig<UserConfig>, ExtractRootPropsFromConfig<UserConfig>>>;
+    config: UserConfig;
     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;
-    };
+    getPermissions: GetPermissions<UserConfig>;
+    refreshPermissions: RefreshPermissions<UserConfig>;
     history: {
         back: VoidFunction;
         forward: VoidFunction;
@@ -246,7 +244,7 @@ declare const usePuck: () => {
         index: number;
         historyStore: HistoryStore | undefined;
     };
-    selectedItem: ComponentData<any, string> | null;
+    selectedItem: ComponentDataMap<ExtractPropsFromConfig<UserConfig>> | null;
 };
 
-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 };
+export { Action, ActionBar, AppState, AutoField, AutoFieldPrivate, Button, ComponentData, ComponentDataMap, Config, Data, DefaultComponentProps, DefaultRootFieldProps, Drawer, DropZone, DropZoneProvider, ExtractPropsFromConfig, ExtractRootPropsFromConfig, Field, FieldLabel, FieldLabelInternal, FieldProps, type FieldPropsInternal, Group, History, IconButton, IframeConfig, InitialHistory, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, Render, UiState, UserGenerics, Viewports, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-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 { F as Field, a as FieldProps, C as Config, D as Data, I as ItemSelector, P as PuckAction, b as DropZoneProps, U as UserGenerics, c as UiState, O as OnAction, d as Permissions, e as Plugin, f as Overrides, V as Viewports, g as IframeConfig, h as InitialHistory, i as DefaultComponentProps, j as DefaultRootFieldProps, k as ComponentData, H as History, A as AppState, E as ExtractPropsFromConfig, l as ExtractRootPropsFromConfig, m as ComponentDataMap } from './actions-9pHbVtMU.js';
+export { L as Adaptor, J as ArrayField, s as ArrayState, a2 as AsFieldProps, B as BaseData, y as BaseField, u as ComponentConfig, x as Content, X as CustomField, $ as DefaultRootProps, _ as DefaultRootRenderProps, W as ExternalField, Q as ExternalFieldWithAdaptor, q as FieldRenderFunctions, Y as Fields, r as ItemWithId, M as MappedItem, N as NumberField, K as ObjectField, p as OverrideKey, t as PuckComponent, Z as PuckContext, G as RadioField, w as RootData, R as RootDataWithProps, v as RootDataWithoutProps, S as SelectField, T as TextField, z as TextareaField, n as Viewport, a3 as WithChildren, a0 as WithId, a1 as WithPuckProps, o as overrideKeys } from './actions-9pHbVtMU.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
@@ -15,12 +15,18 @@ declare const ActionBar: {
         label?: string;
         onClick: (e: SyntheticEvent) => void;
     }) => react_jsx_runtime.JSX.Element;
+    Group: ({ children }: {
+        children: ReactNode;
+    }) => 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 Group: ({ children }: {
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
 
 declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }: {
     children?: ReactNode;
@@ -88,25 +94,6 @@ declare const Drawer: {
     }) => 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 PathData = Record<string, {
     path: string[];
     label: string;
@@ -159,24 +146,24 @@ declare const IconButton: ({ children, href, onClick, variant, type, disabled, t
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-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, }: {
+declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, onAction, permissions, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe: _iframe, dnd, initialHistory: _initialHistory, }: {
     children?: ReactNode;
     config: UserConfig;
-    data: Partial<UserData>;
+    data: Partial<G["UserData"] | Data>;
     ui?: Partial<UiState>;
-    onChange?: (data: UserData) => void;
-    onPublish?: (data: UserData) => void;
-    onAction?: OnAction<UserData>;
+    onChange?: (data: G["UserData"]) => void;
+    onPublish?: (data: G["UserData"]) => void;
+    onAction?: OnAction<G["UserData"]>;
     permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
-        state: AppState<UserData>;
+        state: G["UserAppState"];
     }) => ReactElement;
     renderHeaderActions?: (props: {
-        state: AppState<UserData>;
+        state: G["UserAppState"];
         dispatch: (action: PuckAction) => void;
     }) => ReactElement;
     headerTitle?: string;
@@ -186,10 +173,7 @@ declare function Puck<UserConfig extends Config = Config, UserProps extends Extr
     dnd?: {
         disableAutoScroll?: boolean;
     };
-    initialHistory?: {
-        histories: History<any>[];
-        index: number;
-    };
+    initialHistory?: InitialHistory;
 }): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
     var Components: () => react_jsx_runtime.JSX.Element;
@@ -200,9 +184,9 @@ declare namespace Puck {
     }) => react_jsx_runtime.JSX.Element;
 }
 
-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 }: {
+declare function Render<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ config, data, }: {
     config: UserConfig;
-    data: Partial<UserData>;
+    data: Partial<G["UserData"] | Data>;
 }): react_jsx_runtime.JSX.Element;
 
 declare function migrate(data: Data): Data;
@@ -220,21 +204,35 @@ declare function transformProps<Props extends DefaultComponentProps = DefaultCom
 
 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;
+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 PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    item?: G["UserComponentData"];
+    type?: keyof G["UserProps"];
+    root?: boolean;
+};
+type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Partial<Permissions>;
+type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+
+declare const usePuck: <UserConfig extends Config = Config>() => {
+    appState: AppState<Data<ExtractPropsFromConfig<UserConfig>, ExtractRootPropsFromConfig<UserConfig>>>;
+    config: UserConfig;
     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;
-    };
+    getPermissions: GetPermissions<UserConfig>;
+    refreshPermissions: RefreshPermissions<UserConfig>;
     history: {
         back: VoidFunction;
         forward: VoidFunction;
@@ -246,7 +244,7 @@ declare const usePuck: () => {
         index: number;
         historyStore: HistoryStore | undefined;
     };
-    selectedItem: ComponentData<any, string> | null;
+    selectedItem: ComponentDataMap<ExtractPropsFromConfig<UserConfig>> | null;
 };
 
-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 };
+export { Action, ActionBar, AppState, AutoField, AutoFieldPrivate, Button, ComponentData, ComponentDataMap, Config, Data, DefaultComponentProps, DefaultRootFieldProps, Drawer, DropZone, DropZoneProvider, ExtractPropsFromConfig, ExtractRootPropsFromConfig, Field, FieldLabel, FieldLabelInternal, FieldProps, type FieldPropsInternal, Group, History, IconButton, IframeConfig, InitialHistory, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, Render, UiState, UserGenerics, Viewports, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };