@measured/puck-plugin-emotion-cache 0.21.0-canary.6dae6cb7 → 0.21.0-canary.7dca3a5a

package/dist/index.d.mts

@@ -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;
@@ -195,6 +199,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>;
@@ -210,7 +216,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>;
@@ -219,7 +225,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: {
@@ -231,8 +237,8 @@ UserField extends BaseField = {}> = {
         appState: AppState;
         lastData: DataShape | null;
     }) => Promise<Partial<Permissions>> | Partial<Permissions>;
-    metadata?: Metadata;
-};
+    metadata?: ComponentMetadata;
+} & ComponentConfigExtensions;
 type RootConfigInternal<RootProps extends DefaultComponentProps = DefaultComponentProps, UserField extends BaseField = {}> = Partial<ComponentConfigInternal<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>, UserField>>;
 type Category<ComponentName> = {
     components?: ComponentName[];
@@ -259,6 +265,12 @@ 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 BaseData<Props extends {
     [key: string]: any;
@@ -298,6 +310,12 @@ 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;
@@ -312,6 +330,7 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
+    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -324,7 +343,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number;
+            width: number | "100%";
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -333,6 +352,9 @@ type UiState = {
     field: {
         focus?: string | null;
     };
+    plugin: {
+        current: string | null;
+    };
 };
 type AppState<UserData extends Data = Data> = {
     data: UserData;
@@ -366,12 +388,6 @@ 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;
@@ -382,6 +398,11 @@ type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<
 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 MapFnParams<ThisField = Field> = {
     value: any;
@@ -405,11 +426,6 @@ 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 {
@@ -480,7 +496,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;
@@ -494,8 +510,13 @@ type Permissions = {
     insert: boolean;
 } & Record<string, boolean>;
 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 Slot<Props extends {
     [key: string]: DefaultComponentProps;

package/dist/index.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;
@@ -195,6 +199,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>;
@@ -210,7 +216,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>;
@@ -219,7 +225,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: {
@@ -231,8 +237,8 @@ UserField extends BaseField = {}> = {
         appState: AppState;
         lastData: DataShape | null;
     }) => Promise<Partial<Permissions>> | Partial<Permissions>;
-    metadata?: Metadata;
-};
+    metadata?: ComponentMetadata;
+} & ComponentConfigExtensions;
 type RootConfigInternal<RootProps extends DefaultComponentProps = DefaultComponentProps, UserField extends BaseField = {}> = Partial<ComponentConfigInternal<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>, UserField>>;
 type Category<ComponentName> = {
     components?: ComponentName[];
@@ -259,6 +265,12 @@ 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 BaseData<Props extends {
     [key: string]: any;
@@ -298,6 +310,12 @@ 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;
@@ -312,6 +330,7 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
+    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -324,7 +343,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number;
+            width: number | "100%";
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -333,6 +352,9 @@ type UiState = {
     field: {
         focus?: string | null;
     };
+    plugin: {
+        current: string | null;
+    };
 };
 type AppState<UserData extends Data = Data> = {
     data: UserData;
@@ -366,12 +388,6 @@ 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;
@@ -382,6 +398,11 @@ type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<
 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 MapFnParams<ThisField = Field> = {
     value: any;
@@ -405,11 +426,6 @@ 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 {
@@ -480,7 +496,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;
@@ -494,8 +510,13 @@ type Permissions = {
     insert: boolean;
 } & Record<string, boolean>;
 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 Slot<Props extends {
     [key: string]: DefaultComponentProps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@measured/puck-plugin-emotion-cache",
-  "version": "0.21.0-canary.6dae6cb7",
+  "version": "0.21.0-canary.7dca3a5a",
   "author": "Chris Villa <chris@puckeditor.com>",
   "repository": "measuredco/puck",
   "bugs": "https://github.com/measuredco/puck/issues",
@@ -24,7 +24,7 @@
   ],
   "devDependencies": {
     "@emotion/react": "^11.13.3",
-    "@measured/puck": "^0.21.0-canary.6dae6cb7",
+    "@measured/puck": "^0.21.0-canary.7dca3a5a",
     "@types/react": "^19.0.1",
     "@types/react-dom": "^19.0.2",
     "eslint": "^7.32.0",