@measured/puck 0.21.0-canary.16a3eee1 → 0.21.0-canary.1d823fd9

package/dist/{walk-tree-Ctf3FZQI.d.mts → walk-tree-CegGHme5.d.mts}

@@ -1,4 +1,65 @@
-import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
+import { ReactElement, CSSProperties, ReactNode, JSX, Reducer } from 'react';
+
+type HistorySlice<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;
+    initialAppState: D;
+};
+
+type NodeMethods = {
+    sync: () => void;
+    hideOverlay: () => void;
+    showOverlay: () => void;
+};
+type PuckNodeInstance = {
+    id: string;
+    methods: NodeMethods;
+    element: HTMLElement | null;
+};
+type NodesSlice = {
+    nodes: Record<string, PuckNodeInstance | undefined>;
+    registerNode: (id: string, node: Partial<PuckNodeInstance>) => void;
+    unregisterNode: (id: string, node?: Partial<PuckNodeInstance>) => void;
+};
+
+type PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    item?: G["UserComponentData"] | null;
+    type?: keyof G["UserProps"];
+    root?: boolean;
+};
+type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Permissions;
+type ResolvePermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+type Cache = Record<string, {
+    lastPermissions: Partial<Permissions>;
+    lastData: ComponentData | null;
+}>;
+type PermissionsSlice = {
+    cache: Cache;
+    globalPermissions: Permissions;
+    resolvedPermissions: Record<string, Partial<Permissions> | undefined>;
+    getPermissions: GetPermissions<Config>;
+    resolvePermissions: ResolvePermissions<Config>;
+    refreshPermissions: RefreshPermissions<Config>;
+};
+
+type ComponentOrRootData = Omit<ComponentData<any>, "type">;
+type FieldsSlice = {
+    fields: Fields | Partial<Fields>;
+    loading: boolean;
+    lastResolvedData: Partial<ComponentOrRootData>;
+    id: string | undefined;
+};
 
 type ItemSelector = {
     index: number;
@@ -10,63 +71,63 @@ type FieldOption = {
     value: string | number | boolean | undefined | null | object;
 };
 type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
-type BaseField = {
+interface BaseField {
     label?: string;
     labelIcon?: ReactElement;
-    metadata?: Metadata;
+    metadata?: FieldMetadata;
     visible?: boolean;
-};
-type TextField = BaseField & {
+}
+interface TextField extends BaseField {
     type: "text";
     placeholder?: string;
     contentEditable?: boolean;
-};
-type NumberField = BaseField & {
+}
+interface NumberField extends BaseField {
     type: "number";
     placeholder?: string;
     min?: number;
     max?: number;
     step?: number;
-};
-type TextareaField = BaseField & {
+}
+interface TextareaField extends BaseField {
     type: "textarea";
     placeholder?: string;
     contentEditable?: boolean;
-};
-type SelectField = BaseField & {
+}
+interface SelectField extends BaseField {
     type: "select";
     options: FieldOptions;
-};
-type RadioField = BaseField & {
+}
+interface RadioField extends BaseField {
     type: "radio";
     options: FieldOptions;
-};
-type ArrayField<Props extends {
+}
+interface ArrayField<Props extends {
     [key: string]: any;
 }[] = {
     [key: string]: any;
-}[], UserField extends {} = {}> = BaseField & {
+}[], UserField extends {} = {}> extends BaseField {
     type: "array";
     arrayFields: {
         [SubPropName in keyof Props[0]]: UserField extends {
             type: PropertyKey;
         } ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
     };
-    defaultItemProps?: Props[0];
+    defaultItemProps?: Props[0] | ((index: number) => Props[0]);
     getItemSummary?: (item: Props[0], index?: number) => string;
     max?: number;
     min?: number;
-};
-type ObjectField<Props extends any = {
+}
+interface ObjectField<Props extends any = {
     [key: string]: any;
-}, UserField extends {} = {}> = BaseField & {
+}, UserField extends {} = {}> extends BaseField {
     type: "object";
     objectFields: {
         [SubPropName in keyof Props]: UserField extends {
             type: PropertyKey;
         } ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
     };
-};
+}
 type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
     name: string;
     fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
@@ -82,10 +143,14 @@ type ExternalFieldWithAdaptor<Props extends any = {
     adaptorParams?: object;
     getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
 };
-type ExternalField<Props extends any = {
+type CacheOpts = {
+    enabled?: boolean;
+};
+interface ExternalField<Props extends any = {
     [key: string]: any;
-}> = BaseField & {
+}> extends BaseField {
     type: "external";
+    cache?: CacheOpts;
     placeholder?: string;
     fetchList: (params: {
         query: string;
@@ -101,7 +166,7 @@ type ExternalField<Props extends any = {
     initialQuery?: string;
     filterFields?: Record<string, Field>;
     initialFilters?: Record<string, any>;
-};
+}
 type CustomFieldRender<Value extends any> = (props: {
     field: CustomField<Value>;
     name: string;
@@ -110,16 +175,17 @@ type CustomFieldRender<Value extends any> = (props: {
     onChange: (value: Value) => void;
     readOnly?: boolean;
 }) => ReactElement;
-type CustomField<Value extends any> = BaseField & {
+interface CustomField<Value extends any> extends BaseField {
     type: "custom";
     render: CustomFieldRender<Value>;
     contentEditable?: boolean;
-};
-type SlotField = BaseField & {
+    key?: string;
+}
+interface SlotField extends BaseField {
     type: "slot";
     allow?: string[];
     disallow?: string[];
-};
+}
 type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
     [key: string]: any;
 }[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
@@ -147,7 +213,7 @@ type DropZoneProps = {
 };
 
 type PuckContext = {
-    renderDropZone: React.FC<DropZoneProps>;
+    renderDropZone: (props: DropZoneProps) => React.ReactNode;
     metadata: Metadata;
     isEditing: boolean;
     dragRef: ((element: Element | null) => void) | null;
@@ -197,6 +263,8 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
 type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
     props?: Partial<Props>;
 };
+interface ComponentConfigExtensions {
+}
 type ComponentConfigInternal<RenderProps extends DefaultComponentProps, FieldProps extends DefaultComponentProps, DataShape = Omit<ComponentData<FieldProps>, "type">, // NB this doesn't include AllProps, so types will not contain deep slot types. To fix, we require a breaking change.
 UserField extends BaseField = {}> = {
     render: PuckComponent<RenderProps>;
@@ -212,7 +280,7 @@ UserField extends BaseField = {}> = {
         fields: Fields<FieldProps>;
         lastFields: Fields<FieldProps>;
         lastData: DataShape | null;
-        metadata: Metadata;
+        metadata: ComponentMetadata;
         appState: AppState;
         parent: ComponentData | null;
     }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
@@ -221,7 +289,7 @@ UserField extends BaseField = {}> = {
             id: string;
         }>;
         lastData: DataShape | null;
-        metadata: Metadata;
+        metadata: ComponentMetadata;
         trigger: ResolveDataTrigger;
     }) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
     resolvePermissions?: (data: DataShape, params: {
@@ -233,8 +301,8 @@ UserField extends BaseField = {}> = {
         appState: AppState;
         lastData: DataShape | null;
     }) => Promise<Partial<Permissions>> | Partial<Permissions>;
-    metadata?: Metadata;
-};
+    metadata?: ComponentMetadata;
+} & ComponentConfigExtensions;
 type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
     props: any;
 } ? RenderPropsOrParams["props"] : RenderPropsOrParams, DataShape = Omit<ComponentData<FieldProps>, "type">> = RenderPropsOrParams extends ComponentConfigParams<infer ParamsRenderProps, never> ? ComponentConfigInternal<ParamsRenderProps, FieldProps, DataShape, {}> : RenderPropsOrParams extends ComponentConfigParams<infer ParamsRenderProps, infer ParamsFields> ? ComponentConfigInternal<ParamsRenderProps, FieldProps, DataShape, ParamsFields[keyof ParamsFields] & BaseField> : ComponentConfigInternal<RenderPropsOrParams, FieldProps, DataShape>;
@@ -265,6 +333,16 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
         type: string;
     } ? UserField : Field;
 } : never;
+type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
+    components?: Components;
+    root?: RootProps;
+    categories?: CategoryNames;
+    fields?: AssertHasValue<UserFields>;
+};
+type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
+    props: Props;
+    fields?: AssertHasValue<UserFields>;
+};
 
 type BaseData<Props extends {
     [key: string]: any;
@@ -305,10 +383,17 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
 type Metadata = {
     [key: string]: any;
 };
+interface PuckMetadata extends Metadata {
+}
+interface ComponentMetadata extends PuckMetadata {
+}
+interface FieldMetadata extends Metadata {
+}
 
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
+    _currentIndex: number;
 };
 type ArrayState = {
     items: ItemWithId[];
@@ -319,6 +404,7 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
+    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -331,7 +417,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number;
+            width: number | "100%";
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -340,6 +426,9 @@ type UiState = {
     field: {
         focus?: string | null;
     };
+    plugin: {
+        current: string | null;
+    };
 };
 type AppState<UserData extends Data = Data> = {
     data: UserData;
@@ -373,26 +462,24 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
 type WithDeepSlots<T, SlotType = T> = T extends Slot ? SlotType : T extends (infer U)[] ? Array<WithDeepSlots<U, SlotType>> : T extends (infer U)[] ? WithDeepSlots<U, SlotType>[] : T extends BuiltinTypes ? T : T extends object ? {
     [K in keyof T]: WithDeepSlots<T[K], SlotType>;
 } : T;
-type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
-    components?: Components;
-    root?: RootProps;
-    categories?: CategoryNames;
-    fields?: AssertHasValue<UserFields>;
-};
 type FieldsExtension = {
     [Type in string]: {
         type: Type;
     };
 };
-type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
-    props: Props;
-    fields?: AssertHasValue<UserFields>;
-};
 type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
 type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
 type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
     never
 ] ? False : True;
+type RenderFunc<Props extends {
+    [key: string]: any;
+} = {
+    children: ReactNode;
+}> = (props: Props) => ReactElement;
+type PluginInternal = Plugin & {
+    mobileOnly?: boolean;
+};
 
 type MapFnParams<ThisField = Field> = {
     value: any;
@@ -416,11 +503,57 @@ G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends
     [Type in UserField["type"]]: FieldTransformFn<ExtractField<UserField, Type>>;
 }>;
 
-type RenderFunc<Props extends {
-    [key: string]: any;
-} = {
-    children: ReactNode;
-}> = (props: Props) => ReactElement;
+type Status = "LOADING" | "MOUNTED" | "READY";
+type ZoomConfig = {
+    autoZoom: number;
+    rootHeight: number;
+    zoom: number;
+};
+type ComponentState = Record<string, {
+    loadingCount: number;
+}>;
+type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    instanceId: string;
+    state: G["UserAppState"];
+    dispatch: (action: PuckAction) => void;
+    config: UserConfig;
+    componentState: ComponentState;
+    setComponentState: (componentState: ComponentState) => void;
+    setComponentLoading: (id: string, loading?: boolean, defer?: number) => () => void;
+    unsetComponentLoading: (id: string) => void;
+    pendingLoadTimeouts: Record<string, NodeJS.Timeout>;
+    resolveComponentData: <T extends ComponentData | RootDataWithProps>(componentData: T, trigger: ResolveDataTrigger) => Promise<{
+        node: T;
+        didChange: boolean;
+    }>;
+    resolveAndCommitData: () => void;
+    plugins: Plugin[];
+    overrides: Partial<Overrides>;
+    viewports: Viewports;
+    zoomConfig: ZoomConfig;
+    setZoomConfig: (zoomConfig: ZoomConfig) => void;
+    status: Status;
+    setStatus: (status: Status) => void;
+    iframe: IframeConfig;
+    selectedItem?: G["UserData"]["content"][0] | null;
+    setUi: (ui: Partial<UiState>, recordHistory?: boolean) => void;
+    getComponentConfig: (type?: string) => ComponentConfig | null | undefined;
+    onAction?: (action: PuckAction, newState: AppState, state: AppState) => void;
+    metadata: Metadata;
+    fields: FieldsSlice;
+    history: HistorySlice;
+    nodes: NodesSlice;
+    permissions: PermissionsSlice;
+    fieldTransforms: FieldTransforms;
+};
+
+type StateReducer<UserData extends Data = Data> = Reducer<PrivateAppState<UserData>, PuckAction>;
+declare function createReducer<UserData extends Data>({ record, onAction, appStore, }: {
+    record?: (appState: AppState<UserData>) => void;
+    onAction?: OnAction<UserData>;
+    appStore: AppStore;
+}): StateReducer<UserData>;
+
 declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
 type OverrideKey = (typeof overrideKeys)[number];
 type OverridesGeneric<Shape extends {
@@ -492,7 +625,7 @@ type DragAxis = "dynamic" | "y" | "x";
 
 type iconTypes = "Smartphone" | "Monitor" | "Tablet";
 type Viewport = {
-    width: number;
+    width: number | "100%";
     height?: number | "auto";
     label?: string;
     icon?: iconTypes | ReactNode;
@@ -512,8 +645,13 @@ type IframeConfig = {
 };
 type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
 type Plugin<UserConfig extends Config = Config> = {
+    name?: string;
+    label?: string;
+    icon?: ReactNode;
+    render?: () => ReactElement;
     overrides?: Partial<Overrides<UserConfig>>;
     fieldTransforms?: FieldTransforms<UserConfig>;
+    mobilePanelHeight?: "toggle" | "min-content";
 };
 type History<D = any> = {
     state: D;
@@ -631,4 +769,4 @@ type WalkTreeOptions = {
 };
 declare function walkTree<T extends ComponentData | RootData | G["UserData"], UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(data: T, config: UserConfig, callbackFn: (data: Content, options: WalkTreeOptions) => Content | null | void): T;
 
-export { type BaseField as $, type AppState as A, type ArrayState as B, type Config as C, type DropZoneProps as D, type SlotComponent as E, type Fields as F, type PuckComponent as G, type History as H, type IframeConfig as I, type RootConfig as J, type DefaultComponents as K, type ExtractConfigParams as L, type Metadata as M, type BaseData as N, type Overrides as O, type Permissions as P, type RootDataWithoutProps as Q, type RootDataWithProps as R, type Slot as S, type RootData as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type ComponentDataOptionalId as X, type MappedItem as Y, type ComponentDataMap as Z, type Content as _, type ComponentData as a, type TextField as a0, type NumberField as a1, type TextareaField as a2, type SelectField as a3, type RadioField as a4, type ArrayField as a5, type ObjectField as a6, type Adaptor as a7, type ExternalFieldWithAdaptor as a8, type ExternalField as a9, type CustomFieldRender as aa, type CustomField as ab, type SlotField as ac, type PuckContext as ad, type DefaultRootFieldProps as ae, type DefaultRootRenderProps as af, type DefaultRootProps as ag, type DefaultComponentProps as ah, type WithId as ai, type WithPuckProps as aj, type AsFieldProps as ak, type WithChildren as al, type ExtractField as am, type PuckAction as b, type ResolveDataTrigger as c, type Plugin as d, type UiState as e, type ComponentConfig as f, type FieldTransforms as g, type Field as h, type FieldProps as i, type Data as j, type OnAction as k, type InitialHistory as l, migrate as m, type ItemSelector as n, type Direction as o, type DragAxis as p, type Viewport as q, resolveAllData as r, type FieldTransformFnParams as s, transformProps as t, type FieldTransformFn as u, overrideKeys as v, walkTree as w, type OverrideKey as x, type FieldRenderFunctions as y, type ItemWithId as z };
+export { type RootDataWithProps as $, type AppStore as A, type AppState as B, type Config as C, type DropZoneProps as D, type SlotComponent as E, type Field as F, type GetPermissions as G, type HistorySlice as H, type IframeConfig as I, type PuckComponent as J, type ResolveDataTrigger as K, type ComponentConfigExtensions as L, type Metadata as M, type ComponentConfig as N, type OnAction as O, type Permissions as P, type RootConfig as Q, type RefreshPermissions as R, type Slot as S, type DefaultComponents as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type ExtractConfigParams as X, type ConfigParams as Y, type ComponentConfigParams as Z, type BaseData as _, type FieldProps as a, type RootDataWithoutProps as a0, type RootData as a1, type ComponentData as a2, type ComponentDataOptionalId as a3, type MappedItem as a4, type ComponentDataMap as a5, type Content as a6, type PuckMetadata as a7, type ComponentMetadata as a8, type FieldMetadata as a9, type BaseField as aa, type TextField as ab, type NumberField as ac, type TextareaField as ad, type SelectField as ae, type RadioField as af, type ArrayField as ag, type ObjectField as ah, type Adaptor as ai, type ExternalFieldWithAdaptor as aj, type CacheOpts as ak, type ExternalField as al, type CustomFieldRender as am, type CustomField as an, type SlotField as ao, type Fields as ap, type PuckContext as aq, type DefaultRootFieldProps as ar, type DefaultRootRenderProps as as, type DefaultRootProps as at, type DefaultComponentProps as au, type WithId as av, type WithPuckProps as aw, type AsFieldProps as ax, type WithChildren as ay, type ExtractField as az, type Data as b, createReducer as c, type UiState as d, type Plugin as e, type Overrides as f, type FieldTransforms as g, type PuckAction as h, type InitialHistory as i, type ItemSelector as j, type PluginInternal as k, type History as l, migrate as m, type Direction as n, type DragAxis as o, type Viewport as p, type FieldTransformFnParams as q, resolveAllData as r, type FieldTransformFn as s, transformProps as t, overrideKeys as u, type OverrideKey as v, walkTree as w, type FieldRenderFunctions as x, type ItemWithId as y, type ArrayState as z };