@measured/puck-plugin-heading-analyzer 0.12.1-canary.a2c62a8 → 0.13.0-canary.04e1acf

package/dist/index.css

@@ -1,56 +1,59 @@
 /* css-module:/home/runner/work/puck/puck/packages/core/components/SidebarSection/styles.module.css/#css-module-data */
-._SidebarSection_1uyg2_1 {
+._SidebarSection_170gs_1 {
   display: flex;
   position: relative;
   flex-direction: column;
   color: black;
 }
-._SidebarSection_1uyg2_1:last-of-type {
+._SidebarSection_170gs_1:last-of-type {
   flex-grow: 1;
 }
-._SidebarSection-title_1uyg2_12 {
+._SidebarSection-title_170gs_12 {
   background: white;
   padding: 16px;
   border-bottom: 1px solid var(--puck-color-grey-8);
+  border-top: 1px solid var(--puck-color-grey-8);
   overflow-x: auto;
 }
-._SidebarSection-content_1uyg2_19 {
-  border-bottom: 1px solid var(--puck-color-grey-8);
+._SidebarSection--noBorderTop_170gs_20 > ._SidebarSection-title_170gs_12 {
+  border-top: 0px;
+}
+._SidebarSection-content_170gs_24 {
   padding: 16px;
 }
-._SidebarSection--noPadding_1uyg2_24 ._SidebarSection-content_1uyg2_19 {
+._SidebarSection--noPadding_170gs_28 > ._SidebarSection-content_170gs_24 {
   padding: 0px;
 }
-._SidebarSection--noPadding_1uyg2_24 ._SidebarSection-content_1uyg2_19:last-child {
+._SidebarSection--noPadding_170gs_28 > ._SidebarSection-content_170gs_24:last-child {
   padding-bottom: 4px;
 }
-._SidebarSection_1uyg2_1:last-of-type ._SidebarSection-content_1uyg2_19 {
+._SidebarSection_170gs_1:last-of-type ._SidebarSection-content_170gs_24 {
   border-bottom: none;
   flex-grow: 1;
 }
-._SidebarSection-breadcrumbLabel_1uyg2_37 {
+._SidebarSection-breadcrumbLabel_170gs_41 {
   color: var(--puck-color-azure-3);
   flex-shrink: 0;
 }
-._SidebarSection-breadcrumbLabel_1uyg2_37:hover {
+._SidebarSection-breadcrumbLabel_170gs_41:hover {
   color: var(--puck-color-azure-4);
   cursor: pointer;
   text-decoration: underline;
 }
-._SidebarSection-breadcrumbs_1uyg2_48 {
+._SidebarSection-breadcrumbs_170gs_52 {
   align-items: center;
   display: flex;
   gap: 4px;
 }
-._SidebarSection-breadcrumb_1uyg2_37 {
+._SidebarSection-breadcrumb_170gs_41 {
   align-items: center;
   display: flex;
   gap: 4px;
 }
-._SidebarSection-heading_1uyg2_60 {
+._SidebarSection-heading_170gs_64 {
   padding-right: 16px;
 }
-._SidebarSection-loadingOverlay_1uyg2_64 {
+._SidebarSection-loadingOverlay_170gs_68 {
   background: white;
   display: flex;
   justify-content: center;

package/dist/index.d.ts

@@ -1,106 +1,108 @@
-import { ReactNode, ReactElement } from 'react';
+import { ReactElement, ReactNode } from 'react';
 
 type ItemSelector = {
     index: number;
     zone?: string;
 };
 
-type InsertAction = {
-    type: "insert";
-    componentType: string;
-    destinationIndex: number;
-    destinationZone: 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 BaseField = {
+    label?: string;
 };
-type SetDataAction = {
-    type: "setData";
-    data: Partial<Data> | ((previous: Data) => Partial<Data>);
+type TextField = BaseField & {
+    type: "text";
 };
-type SetAction = {
-    type: "set";
-    state: Partial<AppState> | ((previous: AppState) => Partial<AppState>);
+type NumberField = BaseField & {
+    type: "number";
 };
-type RegisterZoneAction = {
-    type: "registerZone";
-    zone: string;
+type TextareaField = BaseField & {
+    type: "textarea";
 };
-type UnregisterZoneAction = {
-    type: "unregisterZone";
-    zone: string;
+type SelectField = BaseField & {
+    type: "select";
+    options: {
+        label: string;
+        value: string | number | boolean;
+    }[];
 };
-type PuckAction = {
-    recordHistory?: boolean;
-} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
-
-type WithPuckProps<Props> = Props & {
-    id: string;
+type RadioField = BaseField & {
+    type: "radio";
+    options: {
+        label: string;
+        value: string | number | boolean;
+    }[];
 };
-type DefaultRootProps = {
-    title?: string;
+type ArrayField<Props extends {
     [key: string]: any;
-};
-type DefaultComponentProps = {
+} = {
     [key: string]: any;
-    editMode?: boolean;
-};
-type Content<Props extends {
+}> = BaseField & {
+    type: "array";
+    arrayFields: {
+        [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
+    };
+    defaultItemProps?: Props[0];
+    getItemSummary?: (item: Props[0], index?: number) => string;
+};
+type ObjectField<Props extends {
     [key: string]: any;
 } = {
     [key: string]: any;
-}> = ComponentData<Props>[];
-type BaseData<Props extends {
+}> = BaseField & {
+    type: "object";
+    objectFields: {
+        [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
+    };
+};
+type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
+    name: string;
+    fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
+    mapProp?: (value: TableShape) => PropShape;
+};
+type ExternalFieldWithAdaptor<Props extends {
     [key: string]: any;
 } = {
     [key: string]: any;
-}> = {
-    readOnly?: Partial<Record<keyof Props, boolean>>;
-};
-type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps> = {
-    type: keyof Props;
-    props: WithPuckProps<Props>;
-} & BaseData<Props>;
-type RootDataWithProps<Props extends DefaultRootProps = DefaultRootProps> = {
-    props: Props;
-};
-type RootDataWithoutProps<Props extends DefaultRootProps = DefaultRootProps> = Props;
-type RootData<Props extends DefaultRootProps = DefaultRootProps> = BaseData<Props> & Partial<RootDataWithProps<Props>> & Partial<RootDataWithoutProps<Props>>;
-type Data<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultRootProps = DefaultRootProps> = {
-    root: RootData<RootProps>;
-    content: Content<WithPuckProps<Props>>;
-    zones?: Record<string, Content<WithPuckProps<Props>>>;
-};
+}> = BaseField & {
+    type: "external";
+    placeholder?: string;
+    adaptor: Adaptor<any, any, Props>;
+    adaptorParams?: object;
+    getItemSummary: (item: Props, index?: number) => string;
+};
+type ExternalField<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "external";
+    placeholder?: string;
+    fetchList: (params: {
+        query: string;
+    }) => Promise<any[] | null>;
+    mapProp?: (value: any) => Props;
+    getItemSummary: (item: Props, index?: number) => string;
+    showSearch?: boolean;
+    initialQuery?: string;
+};
+type CustomField<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "custom";
+    render: (props: {
+        field: CustomField;
+        name: string;
+        value: any;
+        onChange: (value: Props) => void;
+        readOnly?: boolean;
+    }) => ReactElement;
+};
+type Field<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<Props> | ObjectField<Props> | ExternalField<Props> | ExternalFieldWithAdaptor<Props> | CustomField;
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
@@ -120,30 +122,74 @@ type UiState = {
         visible?: boolean;
         expanded?: boolean;
     }>;
+    isDragging: boolean;
 };
-type AppState = {
-    data: Data;
-    ui: UiState;
+
+type InputProps<F = Field<any>> = {
+    name: string;
+    field: F;
+    value: any;
+    id: string;
+    label?: string;
+    onChange: (value: any, uiState?: Partial<UiState>) => void;
+    readOnly?: boolean;
+    readOnlyFields?: Record<string, boolean | undefined>;
 };
 
-type Plugin = {
-    renderRootFields?: (props: {
+type RenderFunc<Props extends {
+    [key: string]: any;
+} = {
+    children: ReactNode;
+}> = React.FunctionComponent<Props>;
+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;
+    }>;
+    headerActions: RenderFunc<{
+        children?: ReactNode;
+    }>;
+    preview: RenderFunc;
+    fields: RenderFunc<{
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
-    renderRoot?: (props: {
+        isLoading: boolean;
+        itemSelector?: ItemSelector | null;
+    }>;
+    fieldLabel: RenderFunc<{
+        children?: ReactNode;
+        icon?: ReactNode;
+        label: string;
+        el?: "label" | "div";
+        readOnly?: boolean;
+        className?: string;
+    }>;
+    components: RenderFunc;
+    componentItem: RenderFunc;
+    outline: RenderFunc;
+    puck: RenderFunc;
+}>;
+type FieldRenderFunctions = Omit<{
+    [Type in Field["type"]]: React.FunctionComponent<InputProps<Extract<Field, {
+        type: Type;
+    }>> & {
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
-    renderFields?: (props: {
+    }>;
+}, "custom"> & {
+    [key: string]: React.FunctionComponent<InputProps<any> & {
         children: ReactNode;
-        dispatch: (action: PuckAction) => void;
-        state: AppState;
-    }) => ReactElement<any>;
+    }>;
+};
+
+type Plugin = {
+    overrides: Partial<Overrides>;
 };
 
-declare const HeadingAnalyzer: Plugin;
+declare const headingAnalyzer: Plugin;
 
-export { HeadingAnalyzer as default };
+export { headingAnalyzer as default };