@measured/puck-plugin-heading-analyzer 0.20.0-canary.3da831b0 → 0.20.0-canary.5cc56415

package/dist/index.css

@@ -12,151 +12,6 @@
   color: var(--puck-color-red-04);
 }
 
-/* css-module:/home/runner/work/puck/puck/packages/core/components/SidebarSection/styles.module.css/#css-module-data */
-._SidebarSection_8boj8_1 {
-  display: flex;
-  position: relative;
-  flex-direction: column;
-  color: var(--puck-color-black);
-}
-._SidebarSection_8boj8_1:last-of-type {
-  flex-grow: 1;
-}
-._SidebarSection-title_8boj8_12 {
-  background: var(--puck-color-white);
-  padding: 16px;
-  border-bottom: 1px solid var(--puck-color-grey-09);
-  border-top: 1px solid var(--puck-color-grey-09);
-  overflow-x: auto;
-}
-._SidebarSection--noBorderTop_8boj8_20 > ._SidebarSection-title_8boj8_12 {
-  border-top: 0px;
-}
-._SidebarSection-content_8boj8_24 {
-  padding: 16px;
-}
-._SidebarSection--noPadding_8boj8_28 > ._SidebarSection-content_8boj8_24 {
-  padding: 0px;
-}
-._SidebarSection--noPadding_8boj8_28 > ._SidebarSection-content_8boj8_24:last-child {
-  padding-bottom: 4px;
-}
-._SidebarSection_8boj8_1:last-of-type ._SidebarSection-content_8boj8_24 {
-  border-bottom: none;
-  flex-grow: 1;
-}
-._SidebarSection-breadcrumbLabel_8boj8_41 {
-  background: none;
-  border: 0;
-  border-radius: 2px;
-  color: var(--puck-color-azure-04);
-  cursor: pointer;
-  font: inherit;
-  flex-shrink: 0;
-  padding: 0;
-  transition: color 50ms ease-in;
-}
-._SidebarSection-breadcrumbLabel_8boj8_41:focus-visible {
-  outline: 2px solid var(--puck-color-azure-05);
-  outline-offset: 2px;
-}
-@media (hover: hover) and (pointer: fine) {
-  ._SidebarSection-breadcrumbLabel_8boj8_41:hover {
-    color: var(--puck-color-azure-03);
-    transition: none;
-  }
-}
-._SidebarSection-breadcrumbLabel_8boj8_41:active {
-  color: var(--puck-color-azure-02);
-  transition: none;
-}
-._SidebarSection-breadcrumbs_8boj8_70 {
-  align-items: center;
-  display: flex;
-  gap: 4px;
-}
-._SidebarSection-breadcrumb_8boj8_41 {
-  align-items: center;
-  display: flex;
-  gap: 4px;
-}
-._SidebarSection-heading_8boj8_82 {
-  padding-inline-end: 16px;
-}
-._SidebarSection-loadingOverlay_8boj8_86 {
-  background: var(--puck-color-white);
-  display: flex;
-  justify-content: center;
-  align-items: center;
-  height: 100%;
-  width: 100%;
-  top: 0;
-  position: absolute;
-  z-index: 1;
-  pointer-events: all;
-  box-sizing: border-box;
-  opacity: 0.8;
-}
-
-/* css-module:/home/runner/work/puck/puck/packages/core/components/Heading/styles.module.css/#css-module-data */
-._Heading_qxrry_1 {
-  display: block;
-  color: var(--puck-color-black);
-  font-weight: 700;
-  margin: 0;
-}
-._Heading_qxrry_1 b {
-  font-weight: 700;
-}
-._Heading--xxxxl_qxrry_12 {
-  font-size: var(--puck-font-size-xxxxl);
-  letter-spacing: 0.08ch;
-  font-weight: 800;
-}
-._Heading--xxxl_qxrry_18 {
-  font-size: var(--puck-font-size-xxxl);
-}
-._Heading--xxl_qxrry_22 {
-  font-size: var(--puck-font-size-xxl);
-}
-._Heading--xl_qxrry_26 {
-  font-size: var(--puck-font-size-xl);
-}
-._Heading--l_qxrry_30 {
-  font-size: var(--puck-font-size-l);
-}
-._Heading--m_qxrry_34 {
-  font-size: var(--puck-font-size-m);
-}
-._Heading--s_qxrry_38 {
-  font-size: var(--puck-font-size-s);
-}
-._Heading--xs_qxrry_42 {
-  font-size: var(--puck-font-size-xs);
-}
-
-/* css-module:/home/runner/work/puck/puck/packages/core/components/Loader/styles.module.css/#css-module-data */
-@keyframes _loader-animation_nacdm_1 {
-  0% {
-    transform: rotate(0deg) scale(1);
-  }
-  50% {
-    transform: rotate(180deg) scale(0.8);
-  }
-  100% {
-    transform: rotate(360deg) scale(1);
-  }
-}
-._Loader_nacdm_13 {
-  background: transparent;
-  border-radius: 100%;
-  border: 2px solid currentColor;
-  border-bottom-color: transparent;
-  display: inline-block;
-  animation: _loader-animation_nacdm_1 1s 0s infinite linear;
-  animation-fill-mode: both;
-}
-
 /* css-module:/home/runner/work/puck/puck/packages/core/components/OutlineList/styles.module.css/#css-module-data */
 ._OutlineList_w4lzv_1 {
   color: var(--puck-color-grey-03);

package/dist/index.d.mts

@@ -7,7 +7,7 @@ type ItemSelector = {
 
 type FieldOption = {
     label: string;
-    value: string | number | boolean;
+    value: string | number | boolean | undefined | null | object;
 };
 type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
 type BaseField = {
@@ -19,6 +19,7 @@ type BaseField = {
 type TextField = BaseField & {
     type: "text";
     placeholder?: string;
+    contentEditable?: boolean;
 };
 type NumberField = BaseField & {
     type: "number";
@@ -30,6 +31,7 @@ type NumberField = BaseField & {
 type TextareaField = BaseField & {
     type: "textarea";
     placeholder?: string;
+    contentEditable?: boolean;
 };
 type SelectField = BaseField & {
     type: "select";
@@ -39,11 +41,11 @@ type RadioField = BaseField & {
     type: "radio";
     options: FieldOptions;
 };
-type ArrayField<Props extends {
+type ArrayField<Props extends any = {
     [key: string]: any;
-} = {
+}> = Props extends {
     [key: string]: any;
-}> = BaseField & {
+} ? BaseField & {
     type: "array";
     arrayFields: {
         [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
@@ -52,14 +54,12 @@ type ArrayField<Props extends {
     getItemSummary?: (item: Props[0], index?: number) => string;
     max?: number;
     min?: number;
-};
-type ObjectField<Props extends {
-    [key: string]: any;
-} = {
+} : never;
+type ObjectField<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "object";
-    objectFields: Props extends any[] ? never : {
+    objectFields: {
         [SubPropName in keyof Props]: Field<Props[SubPropName]>;
     };
 };
@@ -68,20 +68,17 @@ type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, Pr
     fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
     mapProp?: (value: TableShape) => PropShape;
 };
-type ExternalFieldWithAdaptor<Props extends {
-    [key: string]: any;
-} = {
+type NotUndefined<T> = T extends undefined ? Record<string, any> : T;
+type ExternalFieldWithAdaptor<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "external";
     placeholder?: string;
     adaptor: Adaptor<any, any, Props>;
     adaptorParams?: object;
-    getItemSummary: (item: Props, index?: number) => string;
+    getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
 };
-type ExternalField<Props extends {
-    [key: string]: any;
-} = {
+type ExternalField<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "external";
@@ -92,7 +89,7 @@ type ExternalField<Props extends {
     }) => Promise<any[] | null>;
     mapProp?: (value: any) => Props;
     mapRow?: (value: any) => Record<string, string | number | ReactElement>;
-    getItemSummary?: (item: Props, index?: number) => string;
+    getItemSummary?: (item: NotUndefined<Props>, index?: number) => string;
     showSearch?: boolean;
     renderFooter?: (props: {
         items: any[];
@@ -112,21 +109,14 @@ type CustomFieldRender<Value extends any> = (props: {
 type CustomField<Value extends any> = BaseField & {
     type: "custom";
     render: CustomFieldRender<Value>;
+    contentEditable?: boolean;
 };
 type SlotField = BaseField & {
     type: "slot";
     allow?: string[];
     disallow?: string[];
 };
-type Field<Props extends any = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ObjectField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ExternalField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ExternalFieldWithAdaptor<Props extends {
-    [key: string]: any;
-} ? Props : any> | CustomField<Props> | SlotField;
+type Field<ValueType = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType> | ObjectField<ValueType> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
 type FieldProps<F = Field<any>, ValueType = any> = {
     field: F;
     value: ValueType;
@@ -135,6 +125,10 @@ type FieldProps<F = Field<any>, ValueType = any> = {
     readOnly?: boolean;
 };
 
+type ExtractField<T extends Field["type"]> = Extract<Field, {
+    type: T;
+}>;
+
 type Metadata = {
     [key: string]: any;
 };
@@ -142,6 +136,7 @@ type Metadata = {
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
+    _currentIndex: number;
 };
 type ArrayState = {
     items: ItemWithId[];
@@ -150,6 +145,8 @@ type ArrayState = {
 type UiState = {
     leftSideBarVisible: boolean;
     rightSideBarVisible: boolean;
+    leftSideBarWidth?: number | null;
+    rightSideBarWidth?: number | null;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -178,7 +175,25 @@ type RenderFunc<Props extends {
 } = {
     children: ReactNode;
 }> = (props: Props) => ReactElement;
-declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
+
+type MapFnParams<ThisField = Field> = {
+    value: any;
+    parentId: string;
+    propName: string;
+    field: ThisField;
+    propPath: string;
+};
+
+type FieldTransformFnParams<T> = Omit<MapFnParams<T>, "parentId"> & {
+    isReadOnly: boolean;
+    componentId: string;
+};
+type FieldTransformFn<T = any> = (params: FieldTransformFnParams<T>) => any;
+type FieldTransforms = Partial<{
+    [FieldType in Field["type"]]: FieldTransformFn<ExtractField<FieldType>>;
+}>;
+
+declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
 type OverrideKey = (typeof overrideKeys)[number];
 type OverridesGeneric<Shape extends {
     [key in OverrideKey]: any;
@@ -216,11 +231,23 @@ type Overrides = OverridesGeneric<{
         children: ReactNode;
         name: string;
     }>;
+    drawer: RenderFunc;
+    drawerItem: RenderFunc<{
+        children: ReactNode;
+        name: string;
+    }>;
     iframe: RenderFunc<{
         children: ReactNode;
         document?: Document;
     }>;
     outline: RenderFunc;
+    componentOverlay: RenderFunc<{
+        children: ReactNode;
+        hover: boolean;
+        isSelected: boolean;
+        componentId: string;
+        componentType: string;
+    }>;
     puck: RenderFunc;
 }>;
 type FieldRenderFunctions = Omit<{
@@ -246,7 +273,12 @@ type Viewport = {
 };
 
 type Plugin = {
-    overrides: Partial<Overrides>;
+    name?: string;
+    label?: string;
+    icon?: ReactNode;
+    render?: () => ReactElement;
+    overrides?: Partial<Overrides>;
+    fieldTransforms?: FieldTransforms;
 };
 
 declare const headingAnalyzer: Plugin;

package/dist/index.d.ts

@@ -7,7 +7,7 @@ type ItemSelector = {
 
 type FieldOption = {
     label: string;
-    value: string | number | boolean;
+    value: string | number | boolean | undefined | null | object;
 };
 type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
 type BaseField = {
@@ -19,6 +19,7 @@ type BaseField = {
 type TextField = BaseField & {
     type: "text";
     placeholder?: string;
+    contentEditable?: boolean;
 };
 type NumberField = BaseField & {
     type: "number";
@@ -30,6 +31,7 @@ type NumberField = BaseField & {
 type TextareaField = BaseField & {
     type: "textarea";
     placeholder?: string;
+    contentEditable?: boolean;
 };
 type SelectField = BaseField & {
     type: "select";
@@ -39,11 +41,11 @@ type RadioField = BaseField & {
     type: "radio";
     options: FieldOptions;
 };
-type ArrayField<Props extends {
+type ArrayField<Props extends any = {
     [key: string]: any;
-} = {
+}> = Props extends {
     [key: string]: any;
-}> = BaseField & {
+} ? BaseField & {
     type: "array";
     arrayFields: {
         [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
@@ -52,14 +54,12 @@ type ArrayField<Props extends {
     getItemSummary?: (item: Props[0], index?: number) => string;
     max?: number;
     min?: number;
-};
-type ObjectField<Props extends {
-    [key: string]: any;
-} = {
+} : never;
+type ObjectField<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "object";
-    objectFields: Props extends any[] ? never : {
+    objectFields: {
         [SubPropName in keyof Props]: Field<Props[SubPropName]>;
     };
 };
@@ -68,20 +68,17 @@ type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, Pr
     fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
     mapProp?: (value: TableShape) => PropShape;
 };
-type ExternalFieldWithAdaptor<Props extends {
-    [key: string]: any;
-} = {
+type NotUndefined<T> = T extends undefined ? Record<string, any> : T;
+type ExternalFieldWithAdaptor<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "external";
     placeholder?: string;
     adaptor: Adaptor<any, any, Props>;
     adaptorParams?: object;
-    getItemSummary: (item: Props, index?: number) => string;
+    getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
 };
-type ExternalField<Props extends {
-    [key: string]: any;
-} = {
+type ExternalField<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
     type: "external";
@@ -92,7 +89,7 @@ type ExternalField<Props extends {
     }) => Promise<any[] | null>;
     mapProp?: (value: any) => Props;
     mapRow?: (value: any) => Record<string, string | number | ReactElement>;
-    getItemSummary?: (item: Props, index?: number) => string;
+    getItemSummary?: (item: NotUndefined<Props>, index?: number) => string;
     showSearch?: boolean;
     renderFooter?: (props: {
         items: any[];
@@ -112,21 +109,14 @@ type CustomFieldRender<Value extends any> = (props: {
 type CustomField<Value extends any> = BaseField & {
     type: "custom";
     render: CustomFieldRender<Value>;
+    contentEditable?: boolean;
 };
 type SlotField = BaseField & {
     type: "slot";
     allow?: string[];
     disallow?: string[];
 };
-type Field<Props extends any = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ObjectField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ExternalField<Props extends {
-    [key: string]: any;
-} ? Props : any> | ExternalFieldWithAdaptor<Props extends {
-    [key: string]: any;
-} ? Props : any> | CustomField<Props> | SlotField;
+type Field<ValueType = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType> | ObjectField<ValueType> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
 type FieldProps<F = Field<any>, ValueType = any> = {
     field: F;
     value: ValueType;
@@ -135,6 +125,10 @@ type FieldProps<F = Field<any>, ValueType = any> = {
     readOnly?: boolean;
 };
 
+type ExtractField<T extends Field["type"]> = Extract<Field, {
+    type: T;
+}>;
+
 type Metadata = {
     [key: string]: any;
 };
@@ -142,6 +136,7 @@ type Metadata = {
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
+    _currentIndex: number;
 };
 type ArrayState = {
     items: ItemWithId[];
@@ -150,6 +145,8 @@ type ArrayState = {
 type UiState = {
     leftSideBarVisible: boolean;
     rightSideBarVisible: boolean;
+    leftSideBarWidth?: number | null;
+    rightSideBarWidth?: number | null;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -178,7 +175,25 @@ type RenderFunc<Props extends {
 } = {
     children: ReactNode;
 }> = (props: Props) => ReactElement;
-declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
+
+type MapFnParams<ThisField = Field> = {
+    value: any;
+    parentId: string;
+    propName: string;
+    field: ThisField;
+    propPath: string;
+};
+
+type FieldTransformFnParams<T> = Omit<MapFnParams<T>, "parentId"> & {
+    isReadOnly: boolean;
+    componentId: string;
+};
+type FieldTransformFn<T = any> = (params: FieldTransformFnParams<T>) => any;
+type FieldTransforms = Partial<{
+    [FieldType in Field["type"]]: FieldTransformFn<ExtractField<FieldType>>;
+}>;
+
+declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
 type OverrideKey = (typeof overrideKeys)[number];
 type OverridesGeneric<Shape extends {
     [key in OverrideKey]: any;
@@ -216,11 +231,23 @@ type Overrides = OverridesGeneric<{
         children: ReactNode;
         name: string;
     }>;
+    drawer: RenderFunc;
+    drawerItem: RenderFunc<{
+        children: ReactNode;
+        name: string;
+    }>;
     iframe: RenderFunc<{
         children: ReactNode;
         document?: Document;
     }>;
     outline: RenderFunc;
+    componentOverlay: RenderFunc<{
+        children: ReactNode;
+        hover: boolean;
+        isSelected: boolean;
+        componentId: string;
+        componentType: string;
+    }>;
     puck: RenderFunc;
 }>;
 type FieldRenderFunctions = Omit<{
@@ -246,7 +273,12 @@ type Viewport = {
 };
 
 type Plugin = {
-    overrides: Partial<Overrides>;
+    name?: string;
+    label?: string;
+    icon?: ReactNode;
+    render?: () => ReactElement;
+    overrides?: Partial<Overrides>;
+    fieldTransforms?: FieldTransforms;
 };
 
 declare const headingAnalyzer: Plugin;