@measured/puck 0.14.0-canary.f975d87 → 0.14.0

package/README.md

@@ -15,6 +15,9 @@ The visual editor for React.
   <a aria-label="Join the community on Discord" href="https://discord.gg/D9e4E3MQVZ">
     <img alt="" src="https://img.shields.io/badge/Join%20the%20Discord-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20">
   </a>
+ <a aria-label="Browse the awesome-puck community repo" href="https://github.com/measuredco/awesome-puck">
+    <img alt="" src="https://img.shields.io/badge/repo-awesome--puck-fc60a8.svg?style=for-the-badge&labelColor=000000&logoWidth=20">
+  </a>
 </p>
 
 ## Demo
@@ -96,6 +99,11 @@ Available recipes include:
 - [**next**](https://github.com/measuredco/puck/tree/main/recipes/next): Next.js 13 app example, using App Router and static page generation
 - [**remix**](https://github.com/measuredco/puck/tree/main/recipes/remix): Remix Run v2 app example, using dynamic routes at root-level
 
+## Community
+
+- [Discord server](https://discord.gg/D9e4E3MQVZ) for discussions
+- [awesome-puck](https://github.com/measuredco/awesome-puck) community repo for plugins, custom fields & more
+
 ## Hire the Puck team
 
 Puck is developed and maintained by **Measured**, a small group of industry veterans with decades of experience helping companies solve hard UI problems. We offer consultancy and development services for scale-ups, SMEs and enterprises.

package/dist/{Config-1444273f.d.ts → Config-09628f3c.d.ts}

@@ -1,5 +1,4 @@
-import { CSSProperties, ReactElement, ReactNode } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CSSProperties, ReactNode, ReactElement } from 'react';
 
 type ItemSelector = {
     index: number;
@@ -12,7 +11,15 @@ type DropZoneProps = {
     disallow?: string[];
     style?: CSSProperties;
 };
-declare function DropZone(props: DropZoneProps): react_jsx_runtime.JSX.Element;
+
+type iconTypes = "Smartphone" | "Monitor" | "Tablet";
+type Viewport = {
+    width: number;
+    height?: number | "auto";
+    label?: string;
+    icon?: iconTypes | ReactNode;
+};
+type Viewports = Viewport[];
 
 type WithPuckProps<Props> = Props & {
     id: string;
@@ -55,6 +62,8 @@ type ArrayField<Props extends {
     };
     defaultItemProps?: Props[0];
     getItemSummary?: (item: Props[0], index?: number) => string;
+    max?: number;
+    min?: number;
 };
 type ObjectField<Props extends {
     [key: string]: any;
@@ -63,7 +72,7 @@ type ObjectField<Props extends {
 }> = BaseField & {
     type: "object";
     objectFields: {
-        [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
+        [SubPropName in keyof Props]: Field<Props[SubPropName]>;
     };
 };
 type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
@@ -91,11 +100,15 @@ type ExternalField<Props extends {
     placeholder?: string;
     fetchList: (params: {
         query: string;
+        filters: Record<string, any>;
     }) => Promise<any[] | null>;
     mapProp?: (value: any) => Props;
-    getItemSummary: (item: Props, index?: number) => string;
+    mapRow?: (value: any) => Record<string, string | number>;
+    getItemSummary?: (item: Props, index?: number) => string;
     showSearch?: boolean;
     initialQuery?: string;
+    filterFields?: Record<string, Field>;
+    initialFilters?: Record<string, any>;
 };
 type CustomField<Props extends {
     [key: string]: any;
@@ -132,19 +145,26 @@ type Content<Props extends {
 } = {
     [key: string]: any;
 }> = ComponentData<Props>[];
-type PuckComponent<Props extends DefaultComponentProps = DefaultComponentProps> = (props: WithPuckProps<Props & {
+type PuckComponent<Props> = (props: WithPuckProps<Props & {
     puck: PuckContext;
 }>) => JSX.Element;
 type PuckContext = {
-    renderDropZone: typeof DropZone;
+    renderDropZone: React.FC<DropZoneProps>;
 };
-type ComponentConfig<ComponentProps extends DefaultComponentProps = DefaultComponentProps, DefaultProps = ComponentProps, DataShape = ComponentData<ComponentProps>> = {
+type ComponentConfig<ComponentProps extends DefaultComponentProps = DefaultComponentProps, DefaultProps = ComponentProps, DataShape = Omit<ComponentData<ComponentProps>, "type">> = {
     render: PuckComponent<ComponentProps>;
+    label?: string;
     defaultProps?: DefaultProps;
     fields?: Fields<ComponentProps>;
     resolveData?: (data: DataShape, params: {
         changed: Partial<Record<keyof ComponentProps, boolean>>;
-    }) => Promise<Partial<ComponentDataWithOptionalProps<ComponentProps>>> | Partial<ComponentDataWithOptionalProps<ComponentProps>>;
+    }) => Promise<{
+        props?: Partial<ComponentProps>;
+        readOnly?: Partial<Record<keyof ComponentProps, boolean>>;
+    }> | {
+        props?: Partial<ComponentProps>;
+        readOnly?: Partial<Record<keyof ComponentProps, boolean>>;
+    };
 };
 type Category<ComponentName> = {
     components?: ComponentName[];
@@ -152,22 +172,18 @@ type Category<ComponentName> = {
     visible?: boolean;
     defaultExpanded?: boolean;
 };
-type Config<Props extends {
-    [key: string]: any;
-} = {
-    [key: string]: any;
-}, RootProps extends DefaultRootProps = DefaultRootProps, CategoryName extends string = any> = {
+type Config<Props extends Record<string, any> = Record<string, any>, RootProps extends DefaultRootProps = DefaultRootProps, CategoryName extends string = string> = {
     categories?: Record<CategoryName, Category<keyof Props>> & {
-        other?: Category<Props>;
+        other?: Category<keyof Props>;
     };
     components: {
         [ComponentName in keyof Props]: Omit<ComponentConfig<Props[ComponentName], Props[ComponentName]>, "type">;
     };
     root?: Partial<ComponentConfig<RootProps & {
-        children: ReactNode;
+        children?: ReactNode;
     }, Partial<RootProps & {
-        children: ReactNode;
-    }>, RootDataWithProps<RootProps>>>;
+        children?: ReactNode;
+    }>, RootDataWithProps>>;
 };
 type BaseData<Props extends {
     [key: string]: any;
@@ -185,13 +201,6 @@ type RootDataWithProps<Props extends DefaultRootProps = DefaultRootProps> = {
 };
 type RootDataWithoutProps<Props extends DefaultRootProps = DefaultRootProps> = Props;
 type RootData<Props extends DefaultRootProps = DefaultRootProps> = BaseData<Props> & Partial<RootDataWithProps<Props>> & Partial<RootDataWithoutProps<Props>>;
-type ComponentDataWithOptionalProps<Props extends {
-    [key: string]: any;
-} = {
-    [key: string]: any;
-}> = Omit<ComponentData, "props"> & {
-    props: Partial<WithPuckProps<Props>>;
-};
 type MappedItem = ComponentData;
 type Data<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultRootProps = DefaultRootProps> = {
     root: RootData<RootProps>;
@@ -218,10 +227,18 @@ type UiState = {
         expanded?: boolean;
     }>;
     isDragging: boolean;
+    viewports: {
+        current: {
+            width: number;
+            height: number | "auto";
+        };
+        controlsVisible: boolean;
+        options: Viewport[];
+    };
 };
 type AppState = {
     data: Data;
     ui: UiState;
 };
 
-export { AppState as A, BaseField 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, PuckComponent as P, RootDataWithProps as R, SelectField as S, TextField as T, UiState as U, DefaultComponentProps as a, DefaultRootProps as b, RootData as c, TextareaField as d, RadioField as e, ArrayField as f, Adaptor as g, ExternalField as h, CustomField as i, Fields as j, Content as k, PuckContext as l, ComponentConfig as m, BaseData as n, ComponentData as o, RootDataWithoutProps as p, ItemWithId as q, ArrayState as r, DropZone as s };
+export { AppState as A, BaseField 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, PuckComponent as P, RootDataWithProps as R, SelectField as S, TextField as T, UiState as U, Viewports as V, DefaultRootProps as a, DropZoneProps as b, DefaultComponentProps as c, RootData as d, ComponentData as e, TextareaField as f, RadioField as g, ArrayField as h, Adaptor as i, ExternalField as j, CustomField as k, Fields as l, Content as m, PuckContext as n, ComponentConfig as o, BaseData as p, RootDataWithoutProps as q, ItemWithId as r, ArrayState as s };