@measured/puck 0.14.0-canary.3816c08 → 0.14.0-canary.3d595db

package/dist/index.d.ts

@@ -1,45 +1,9 @@
-import { C as Config, D as Data, I as ItemSelector, U as UiState, A as AppState, F as Field, a as DefaultComponentProps, b as DefaultRootProps, M as MappedItem, R as RootDataWithProps, c as RootData } from './Config-1b86f0dc.js';
-export { g as Adaptor, f as ArrayField, r as ArrayState, n as BaseData, B as BaseField, m as ComponentConfig, o as ComponentData, k as Content, i as CustomField, s as DropZone, h as ExternalField, E as ExternalFieldWithAdaptor, j as Fields, q as ItemWithId, N as NumberField, O as ObjectField, P as PuckComponent, l as PuckContext, e as RadioField, p as RootDataWithoutProps, S as SelectField, T as TextField, d as TextareaField } from './Config-1b86f0dc.js';
+import { U as UiState, D as Data, A as AppState, C as Config, a as DefaultRootProps, I as ItemSelector, b as DropZoneProps, F as Field, V as Viewports, c as DefaultComponentProps, M as MappedItem, R as RootDataWithProps, d as RootData, e as ComponentData } from './Config-shqT_YTp.js';
+export { i as Adaptor, h as ArrayField, s as ArrayState, p as BaseData, B as BaseField, o as ComponentConfig, m as Content, k as CustomField, j as ExternalField, E as ExternalFieldWithAdaptor, l as Fields, r as ItemWithId, N as NumberField, O as ObjectField, P as PuckComponent, n as PuckContext, g as RadioField, q as RootDataWithoutProps, S as SelectField, T as TextField, f as TextareaField } from './Config-shqT_YTp.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { ReactNode, CSSProperties, ReactElement, SyntheticEvent } from 'react';
-import { DragStart, DragUpdate } from '@hello-pangea/dnd';
-
-type PathData = Record<string, {
-    path: string[];
-    label: string;
-}>;
-type DropZoneContext<UserConfig extends Config<any, any, any> = Config<any, any, any>> = {
-    data: Data;
-    config: UserConfig;
-    componentState?: Record<string, any>;
-    itemSelector?: ItemSelector | null;
-    setItemSelector?: (newIndex: ItemSelector | null) => void;
-    dispatch?: (action: PuckAction) => void;
-    areaId?: string;
-    draggedItem?: DragStart & Partial<DragUpdate>;
-    placeholderStyle?: CSSProperties;
-    hoveringArea?: string | null;
-    setHoveringArea?: (area: string | null) => void;
-    hoveringZone?: string | null;
-    setHoveringZone?: (zone: string | null) => void;
-    hoveringComponent?: string | null;
-    setHoveringComponent?: (id: string | null) => void;
-    registerZoneArea?: (areaId: string) => void;
-    areasWithZones?: Record<string, boolean>;
-    registerZone?: (zoneCompound: string) => void;
-    unregisterZone?: (zoneCompound: string) => void;
-    activeZones?: Record<string, boolean>;
-    pathData?: PathData;
-    registerPath?: (selector: ItemSelector) => void;
-    mode?: "edit" | "render";
-    disableZoom?: boolean;
-} | null;
-declare const dropZoneContext: react.Context<DropZoneContext<Config<any, any, any>>>;
-declare const DropZoneProvider: ({ children, value, }: {
-    children: ReactNode;
-    value: DropZoneContext;
-}) => react_jsx_runtime.JSX.Element;
+import { ReactNode, ReactElement, CSSProperties, SyntheticEvent } from 'react';
+import { DragStart, DragUpdate } from '@measured/dnd';
 
 type InsertAction = {
     type: "insert";
@@ -105,7 +69,7 @@ declare const Button: ({ children, href, onClick, variant, type, disabled, tabIn
     href?: string | undefined;
     onClick?: ((e: any) => void | Promise<void>) | undefined;
     variant?: "primary" | "secondary" | undefined;
-    type?: "reset" | "submit" | "button" | undefined;
+    type?: "button" | "submit" | "reset" | undefined;
     disabled?: boolean | undefined;
     tabIndex?: number | undefined;
     newTab?: boolean | undefined;
@@ -119,24 +83,65 @@ declare const Drawer: {
     ({ children, droppableId, direction, }: {
         children: ReactNode;
         droppableId?: string | undefined;
-        direction?: "horizontal" | "vertical" | undefined;
+        direction?: "vertical" | "horizontal" | undefined;
     }): react_jsx_runtime.JSX.Element;
-    Item: ({ name, children, id, index, }: {
+    Item: ({ name, children, id, label, index, }: {
         name: string;
         children?: ((props: {
             children: ReactNode;
+            name: string;
         }) => ReactElement) | undefined;
         id?: string | undefined;
+        label?: string | undefined;
         index: number;
     }) => react_jsx_runtime.JSX.Element;
 };
 
+type PathData = Record<string, {
+    path: string[];
+    label: string;
+}>;
+type DropZoneContext<UserConfig extends Config = Config> = {
+    data: Data;
+    config: UserConfig;
+    componentState?: Record<string, any>;
+    itemSelector?: ItemSelector | null;
+    setItemSelector?: (newIndex: ItemSelector | null) => void;
+    dispatch?: (action: PuckAction) => void;
+    areaId?: string;
+    draggedItem?: DragStart & Partial<DragUpdate>;
+    placeholderStyle?: CSSProperties;
+    hoveringArea?: string | null;
+    setHoveringArea?: (area: string | null) => void;
+    hoveringZone?: string | null;
+    setHoveringZone?: (zone: string | null) => void;
+    hoveringComponent?: string | null;
+    setHoveringComponent?: (id: string | null) => void;
+    registerZoneArea?: (areaId: string) => void;
+    areasWithZones?: Record<string, boolean>;
+    registerZone?: (zoneCompound: string) => void;
+    unregisterZone?: (zoneCompound: string) => void;
+    activeZones?: Record<string, boolean>;
+    pathData?: PathData;
+    registerPath?: (selector: ItemSelector) => void;
+    mode?: "edit" | "render";
+    zoneWillDrag?: string;
+    setZoneWillDrag?: (zone: string) => void;
+} | null;
+declare const dropZoneContext: react.Context<DropZoneContext<Config<Record<string, any>, DefaultRootProps, string>>>;
+declare const DropZoneProvider: ({ children, value, }: {
+    children: ReactNode;
+    value: DropZoneContext;
+}) => react_jsx_runtime.JSX.Element;
+
+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?: "reset" | "submit" | "button" | undefined;
+    type?: "button" | "submit" | "reset" | undefined;
     disabled?: boolean | undefined;
     tabIndex?: number | undefined;
     newTab?: boolean | undefined;
@@ -167,7 +172,7 @@ type RenderFunc<Props extends {
     [key: string]: any;
 } = {
     children: ReactNode;
-}> = React.FunctionComponent<Props>;
+}> = (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 {
@@ -197,7 +202,10 @@ type Overrides = OverridesGeneric<{
         className?: string;
     }>;
     components: RenderFunc;
-    componentItem: RenderFunc;
+    componentItem: RenderFunc<{
+        children: ReactNode;
+        name: string;
+    }>;
     outline: RenderFunc;
     puck: RenderFunc;
 }>;
@@ -217,7 +225,11 @@ type Plugin = {
     overrides: Partial<Overrides>;
 };
 
-declare function Puck<UserConfig extends Config<any, any, any> = Config<any, any, any>>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, }: {
+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, }: {
     children?: ReactNode;
     config: UserConfig;
     data: Data;
@@ -237,6 +249,8 @@ declare function Puck<UserConfig extends Config<any, any, any> = Config<any, any
     }) => ReactElement;
     headerTitle?: string;
     headerPath?: string;
+    viewports?: Viewports;
+    iframe?: IframeConfig;
 }): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
     var Components: () => react_jsx_runtime.JSX.Element;
@@ -247,7 +261,7 @@ declare namespace Puck {
     }) => react_jsx_runtime.JSX.Element;
 }
 
-declare function Render<UserConfig extends Config<any, any, any> = Config<any, any, any>>({ config, data }: {
+declare function Render<UserConfig extends Config = Config>({ config, data, }: {
     config: UserConfig;
     data: Data;
 }): react_jsx_runtime.JSX.Element;
@@ -265,16 +279,43 @@ type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps,
 }>;
 declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultComponentProps>(data: Data, propTransforms: PropTransform<Props, RootProps>): Data;
 
-declare const resolveAllData: (data: Data, config: Config<any, any, any>, onResolveStart?: ((item: MappedItem) => void) | undefined, onResolveEnd?: ((item: MappedItem) => void) | undefined) => Promise<{
+declare function resolveAllData(data: Data, config: Config, onResolveStart?: (item: MappedItem) => void, onResolveEnd?: (item: MappedItem) => void): Promise<{
     root: RootDataWithProps<DefaultRootProps> | RootData<DefaultRootProps>;
     content: any[];
     zones: Record<string, MappedItem[]>;
 }>;
 
+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 PuckHistory = {
+    back: VoidFunction;
+    forward: VoidFunction;
+    historyStore: HistoryStore;
+};
+
 declare const usePuck: () => {
     appState: AppState;
-    config: Config<any, any, any>;
+    config: Config<Record<string, any>, DefaultRootProps, string>;
     dispatch: (action: PuckAction) => void;
+    history: Partial<PuckHistory>;
+    selectedItem: ComponentData<DefaultComponentProps & {
+        id: string;
+    }> | null;
 };
 
-export { AppState, Button, Config, Data, DefaultComponentProps, DefaultRootProps, Drawer, DropZoneProvider, Field, FieldLabel, IconButton, MappedItem, Puck, PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };
+export { AppState, Button, ComponentData, Config, Data, DefaultComponentProps, DefaultRootProps, Drawer, DropZone, DropZoneProvider, Field, FieldLabel, IconButton, MappedItem, Puck, type PuckAction, Render, RootData, RootDataWithProps, UiState, dropZoneContext, migrate, resolveAllData, transformProps, usePuck };