@measured/puck 0.16.0-canary.6d43ba0 → 0.16.0-canary.72b8720

package/dist/{Config-XUGMjfT5.d.mts → actions-9pHbVtMU.d.mts}

@@ -1,4 +1,4 @@
-import { CSSProperties, ReactNode, ReactElement } from 'react';
+import { CSSProperties, ReactElement, ReactNode } from 'react';
 
 type ItemSelector = {
     index: number;
@@ -12,15 +12,6 @@ type DropZoneProps = {
     style?: CSSProperties;
 };
 
-type iconTypes = "Smartphone" | "Monitor" | "Tablet";
-type Viewport = {
-    width: number;
-    height?: number | "auto";
-    label?: string;
-    icon?: iconTypes | ReactNode;
-};
-type Viewports = Viewport[];
-
 type FieldOption = {
     label: string;
     value: string | number | boolean;
@@ -138,35 +129,7 @@ type FieldProps<ValueType = any, F = Field<any>> = {
     readOnly?: boolean;
 };
 
-type WithId<Props> = Props & {
-    id: string;
-};
-type WithPuckProps<Props> = Props & {
-    puck: PuckContext;
-    editMode?: boolean;
-};
-type AsFieldProps<Props> = Partial<Omit<Props, "children" | "puck" | "editMode">>;
-type WithChildren<Props> = Props & {
-    children: ReactNode;
-};
-type DefaultRootFieldProps = {
-    title?: string;
-};
-type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
-type DefaultRootProps = DefaultRootRenderProps;
-type DefaultComponentProps = {
-    [key: string]: any;
-};
-type Content<PropsMap extends {
-    [key: string]: any;
-} = {
-    [key: string]: any;
-}> = ComponentDataMap<PropsMap>[];
 type PuckComponent<Props> = (props: WithId<WithPuckProps<Props>>) => JSX.Element;
-type PuckContext = {
-    renderDropZone: React.FC<DropZoneProps>;
-    isEditing: boolean;
-};
 type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderProps, DataShape = Omit<ComponentData<FieldProps>, "type">> = {
     render: PuckComponent<RenderProps>;
     label?: string;
@@ -177,12 +140,12 @@ type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponen
         changed: Partial<Record<keyof FieldProps, boolean>>;
         fields: Fields<FieldProps>;
         lastFields: Fields<FieldProps>;
-        lastData: DataShape;
+        lastData: DataShape | null;
         appState: AppState;
     }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
     resolveData?: (data: DataShape, params: {
         changed: Partial<Record<keyof FieldProps, boolean>>;
-        lastData: DataShape;
+        lastData: DataShape | null;
     }) => Promise<{
         props?: Partial<FieldProps>;
         readOnly?: Partial<Record<keyof FieldProps, boolean>>;
@@ -192,10 +155,11 @@ type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponen
     };
     resolvePermissions?: (data: DataShape, params: {
         changed: Partial<Record<keyof FieldProps, boolean>>;
-        lastPermissions: Partial<Permissions> | undefined;
-        initialPermissions: Partial<Permissions>;
+        lastPermissions: Partial<Permissions>;
+        permissions: Partial<Permissions>;
         appState: AppState;
-    }) => Partial<Permissions>;
+        lastData: DataShape | null;
+    }) => Promise<Partial<Permissions>> | Partial<Permissions>;
 };
 type Category<ComponentName> = {
     components?: ComponentName[];
@@ -203,15 +167,51 @@ type Category<ComponentName> = {
     visible?: boolean;
     defaultExpanded?: boolean;
 };
-type Config<Props extends Record<string, any> = Record<string, any>, RootProps extends DefaultComponentProps = DefaultRootFieldProps, CategoryName extends string = string> = {
+type Config<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = any, CategoryName extends string = string> = {
     categories?: Record<CategoryName, Category<keyof Props>> & {
         other?: Category<keyof Props>;
     };
     components: {
         [ComponentName in keyof Props]: Omit<ComponentConfig<Props[ComponentName], Props[ComponentName]>, "type">;
     };
-    root?: Partial<ComponentConfig<DefaultRootRenderProps<RootProps>, AsFieldProps<RootProps>, RootData>>;
+    root?: Partial<ComponentConfig<DefaultRootRenderProps<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>>>;
+};
+
+type WithId<Props> = Props & {
+    id: string;
+};
+type WithPuckProps<Props> = Props & {
+    puck: PuckContext;
+    editMode?: boolean;
+};
+type AsFieldProps<Props> = Omit<Props, "children" | "puck" | "editMode">;
+type WithChildren<Props> = Props & {
+    children: ReactNode;
+};
+type ExtractPropsFromConfig<UserConfig> = UserConfig extends Config<infer P, any, any> ? P : never;
+type ExtractRootPropsFromConfig<UserConfig> = UserConfig extends Config<any, infer P, any> ? P : never;
+type UserGenerics<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>, UserAppState extends AppState<UserData> = AppState<UserData>, UserComponentData extends ComponentData = UserData["content"][0]> = {
+    UserConfig: UserConfig;
+    UserProps: UserProps;
+    UserRootProps: UserRootProps;
+    UserData: UserData;
+    UserAppState: UserAppState;
+    UserComponentData: UserComponentData;
 };
+
+type PuckContext = {
+    renderDropZone: React.FC<DropZoneProps>;
+    isEditing: boolean;
+};
+type DefaultRootFieldProps = {
+    title?: string;
+};
+type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
+type DefaultRootProps = DefaultRootRenderProps;
+type DefaultComponentProps = {
+    [key: string]: any;
+};
+
 type BaseData<Props extends {
     [key: string]: any;
 } = {
@@ -219,24 +219,30 @@ type BaseData<Props extends {
 }> = {
     readOnly?: Partial<Record<keyof Props, boolean>>;
 };
-type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
-    type: Name;
-    props: WithId<Props>;
-} & BaseData<Props>;
-type ComponentDataMap<Props extends Record<string, DefaultComponentProps> = DefaultComponentProps> = {
-    [K in keyof Props]: ComponentData<Props[K], K>;
-}[keyof Props];
 type RootDataWithProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = BaseData<Props> & {
     props: Props;
 };
 type RootDataWithoutProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = Props;
 type RootData<Props extends DefaultComponentProps = DefaultRootFieldProps> = Partial<RootDataWithProps<AsFieldProps<Props>>> & Partial<RootDataWithoutProps<Props>>;
+type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
+    type: Name;
+    props: WithId<Props>;
+} & BaseData<Props>;
 type MappedItem = ComponentData;
+type ComponentDataMap<Props extends Record<string, DefaultComponentProps> = DefaultComponentProps> = {
+    [K in keyof Props]: ComponentData<Props[K], K extends string ? K : never>;
+}[keyof Props];
+type Content<PropsMap extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = ComponentDataMap<PropsMap>[];
 type Data<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
     root: RootData<RootProps>;
     content: Content<Props>;
     zones?: Record<string, Content<Props>>;
 };
+
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
@@ -266,10 +272,83 @@ type UiState = {
         options: Viewport[];
     };
 };
-type AppState = {
-    data: Data;
+type AppState<UserData extends Data = Data> = {
+    data: UserData;
     ui: UiState;
 };
+
+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 iconTypes = "Smartphone" | "Monitor" | "Tablet";
+type Viewport = {
+    width: number;
+    height?: number | "auto";
+    label?: string;
+    icon?: iconTypes | ReactNode;
+};
+type Viewports = Viewport[];
+
 type Permissions = {
     drag: boolean;
     duplicate: boolean;
@@ -277,5 +356,88 @@ type Permissions = {
     edit: boolean;
     insert: boolean;
 } & Record<string, boolean>;
+type IframeConfig = {
+    enabled?: boolean;
+    waitForStyles?: boolean;
+};
+type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
+type Plugin = {
+    overrides: Partial<Overrides>;
+};
+type History<D = any> = {
+    state: D;
+    id?: string;
+};
+type InitialHistoryAppend<AS = Partial<AppState>> = {
+    histories: History<AS>[];
+    index?: number;
+    appendData?: true;
+};
+type InitialHistoryNoAppend<AS = Partial<AppState>> = {
+    histories: [History<AS>, ...History<AS>[]];
+    index?: number;
+    appendData?: false;
+};
+type InitialHistory<AS = Partial<AppState>> = InitialHistoryAppend<AS> | InitialHistoryNoAppend<AS>;
+
+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<UserData extends Data = Data> = {
+    type: "set";
+    state: Partial<AppState<UserData>> | ((previous: AppState<UserData>) => Partial<AppState<UserData>>);
+};
+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);
 
-export type { AppState as A, BaseData as B, Config as C, Data as D, ExternalFieldWithAdaptor as E, Field as F, ItemSelector as I, MappedItem as M, NumberField as N, ObjectField as O, Permissions as P, RootData as R, SelectField as S, TextField as T, UiState as U, Viewports as V, FieldProps as a, DropZoneProps as b, DefaultComponentProps as c, DefaultRootFieldProps as d, ComponentData as e, RootDataWithProps as f, Content as g, DefaultRootRenderProps as h, DefaultRootProps as i, PuckComponent as j, PuckContext as k, ComponentConfig as l, ComponentDataMap as m, RootDataWithoutProps as n, ItemWithId as o, ArrayState as p, BaseField as q, TextareaField as r, RadioField as s, ArrayField as t, Adaptor as u, ExternalField as v, CustomField as w, Fields as x };
+export { type DefaultRootProps as $, type AppState as A, type BaseData as B, type Config as C, type Data as D, type ExtractPropsFromConfig as E, type Field as F, type RadioField as G, type History as H, type ItemSelector as I, type ArrayField as J, type ObjectField as K, type Adaptor as L, type MappedItem as M, type NumberField as N, type OnAction as O, type PuckAction as P, type ExternalFieldWithAdaptor as Q, type RootDataWithProps as R, type SelectField as S, type TextField as T, type UserGenerics as U, type Viewports as V, type ExternalField as W, type CustomField as X, type Fields as Y, type PuckContext as Z, type DefaultRootRenderProps as _, type FieldProps as a, type WithId as a0, type WithPuckProps as a1, type AsFieldProps as a2, type WithChildren as a3, type DropZoneProps as b, type UiState as c, type Permissions as d, type Plugin as e, type Overrides as f, type IframeConfig as g, type InitialHistory as h, type DefaultComponentProps as i, type DefaultRootFieldProps as j, type ComponentData as k, type ExtractRootPropsFromConfig as l, type ComponentDataMap as m, type Viewport as n, overrideKeys as o, type OverrideKey as p, type FieldRenderFunctions as q, type ItemWithId as r, type ArrayState as s, type PuckComponent as t, type ComponentConfig as u, type RootDataWithoutProps as v, type RootData as w, type Content as x, type BaseField as y, type TextareaField as z };