@measured/puck 0.21.0-canary.2e1b5267 → 0.21.0-canary.56c45885

package/dist/{walk-tree-Cvtjzg9C.d.ts → walk-tree-BMbIeiqs.d.ts}

@@ -10,63 +10,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 +82,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 +105,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 +114,16 @@ 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 & {
+}
+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 +151,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 +201,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 +218,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 +227,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 +239,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 +271,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,11 +321,16 @@ 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[];
@@ -320,7 +341,6 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
-    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -333,7 +353,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number | "100%";
+            width: number;
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -342,9 +362,6 @@ type UiState = {
     field: {
         focus?: string | null;
     };
-    plugin: {
-        current: string | null;
-    };
 };
 type AppState<UserData extends Data = Data> = {
     data: UserData;
@@ -378,34 +395,16 @@ 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;
@@ -429,6 +428,11 @@ 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;
 declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
 type OverrideKey = (typeof overrideKeys)[number];
 type OverridesGeneric<Shape extends {
@@ -500,7 +504,7 @@ type DragAxis = "dynamic" | "y" | "x";
 
 type iconTypes = "Smartphone" | "Monitor" | "Tablet";
 type Viewport = {
-    width: number | "100%";
+    width: number;
     height?: number | "auto";
     label?: string;
     icon?: iconTypes | ReactNode;
@@ -520,13 +524,8 @@ 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;
@@ -644,4 +643,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 Content as $, type AppState as A, type ItemWithId as B, type Config as C, type DropZoneProps as D, type ArrayState as E, type Fields as F, type SlotComponent as G, type History as H, type IframeConfig as I, type PuckComponent as J, type RootConfig as K, type DefaultComponents as L, type Metadata as M, type ExtractConfigParams as N, type Overrides as O, type Permissions as P, type BaseData as Q, type RootDataWithProps as R, type Slot as S, type RootDataWithoutProps as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type RootData as X, type ComponentDataOptionalId as Y, type MappedItem as Z, type ComponentDataMap as _, type ComponentData as a, type BaseField as a0, type TextField as a1, type NumberField as a2, type TextareaField as a3, type SelectField as a4, type RadioField as a5, type ArrayField as a6, type ObjectField as a7, type Adaptor as a8, type ExternalFieldWithAdaptor as a9, type ExternalField as aa, type CustomFieldRender as ab, type CustomField as ac, type SlotField as ad, type PuckContext as ae, type DefaultRootFieldProps as af, type DefaultRootRenderProps as ag, type DefaultRootProps as ah, type DefaultComponentProps as ai, type WithId as aj, type WithPuckProps as ak, type AsFieldProps as al, type WithChildren as am, type ExtractField as an, 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 PluginInternal as o, type Direction as p, type DragAxis as q, resolveAllData as r, type Viewport as s, transformProps as t, type FieldTransformFnParams as u, type FieldTransformFn as v, walkTree as w, overrideKeys as x, type OverrideKey as y, type FieldRenderFunctions as z };
+export { type MappedItem 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 ComponentConfigExtensions as J, type RootConfig as K, type DefaultComponents as L, type Metadata as M, type ExtractConfigParams as N, type Overrides as O, type Permissions as P, type ConfigParams as Q, type RootDataWithProps as R, type Slot as S, type ComponentConfigParams as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type BaseData as X, type RootDataWithoutProps as Y, type RootData as Z, type ComponentDataOptionalId as _, type ComponentData as a, type ComponentDataMap as a0, type Content as a1, type PuckMetadata as a2, type ComponentMetadata as a3, type FieldMetadata as a4, type BaseField as a5, type TextField as a6, type NumberField as a7, type TextareaField as a8, type SelectField as a9, type RadioField as aa, type ArrayField as ab, type ObjectField as ac, type Adaptor as ad, type ExternalFieldWithAdaptor as ae, type CacheOpts as af, type ExternalField as ag, type CustomFieldRender as ah, type CustomField as ai, type SlotField as aj, type PuckContext as ak, type DefaultRootFieldProps as al, type DefaultRootRenderProps as am, type DefaultRootProps as an, type DefaultComponentProps as ao, type WithId as ap, type WithPuckProps as aq, type AsFieldProps as ar, type WithChildren as as, type ExtractField as at, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@measured/puck",
-  "version": "0.21.0-canary.2e1b5267",
+  "version": "0.21.0-canary.56c45885",
   "description": "The open-source visual editor for React",
   "author": "Chris Villa <chris@puckeditor.com>",
   "repository": "measuredco/puck",