@measured/puck-plugin-heading-analyzer 0.21.0-canary.d32e582b → 0.21.0-canary.d5f934f0

package/dist/index.d.mts

@@ -1,78 +1,275 @@
-import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
+import { ReactElement, CSSProperties, ReactNode, ElementType, Ref, JSX } from 'react';
+import { EditorStateSnapshot, Editor, Extensions } from '@tiptap/react';
+import { BlockquoteOptions } from '@tiptap/extension-blockquote';
+import { BoldOptions } from '@tiptap/extension-bold';
+import { CodeOptions } from '@tiptap/extension-code';
+import { CodeBlockOptions } from '@tiptap/extension-code-block';
+import { HardBreakOptions } from '@tiptap/extension-hard-break';
+import { HeadingOptions } from '@tiptap/extension-heading';
+import { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
+import { ItalicOptions } from '@tiptap/extension-italic';
+import { LinkOptions } from '@tiptap/extension-link';
+import { BulletListOptions, ListItemOptions, ListKeymapOptions, OrderedListOptions } from '@tiptap/extension-list';
+import { ParagraphOptions } from '@tiptap/extension-paragraph';
+import { StrikeOptions } from '@tiptap/extension-strike';
+import { TextAlignOptions } from '@tiptap/extension-text-align';
+import { UnderlineOptions } from '@tiptap/extension-underline';
 
 type ItemSelector = {
     index: number;
     zone?: string;
 };
 
+declare const defaultEditorState: (ctx: EditorStateSnapshot, readOnly: boolean) => {
+    isAlignLeft?: undefined;
+    canAlignLeft?: undefined;
+    isAlignCenter?: undefined;
+    canAlignCenter?: undefined;
+    isAlignRight?: undefined;
+    canAlignRight?: undefined;
+    isAlignJustify?: undefined;
+    canAlignJustify?: undefined;
+    isBold?: undefined;
+    canBold?: undefined;
+    isItalic?: undefined;
+    canItalic?: undefined;
+    isUnderline?: undefined;
+    canUnderline?: undefined;
+    isStrike?: undefined;
+    canStrike?: undefined;
+    isInlineCode?: undefined;
+    canInlineCode?: undefined;
+    isBulletList?: undefined;
+    canBulletList?: undefined;
+    isOrderedList?: undefined;
+    canOrderedList?: undefined;
+    isCodeBlock?: undefined;
+    canCodeBlock?: undefined;
+    isBlockquote?: undefined;
+    canBlockquote?: undefined;
+    canHorizontalRule?: undefined;
+} | {
+    isAlignLeft: boolean;
+    canAlignLeft: boolean;
+    isAlignCenter: boolean;
+    canAlignCenter: boolean;
+    isAlignRight: boolean;
+    canAlignRight: boolean;
+    isAlignJustify: boolean;
+    canAlignJustify: boolean;
+    isBold: boolean;
+    canBold: boolean;
+    isItalic: boolean;
+    canItalic: boolean;
+    isUnderline: boolean;
+    canUnderline: boolean;
+    isStrike: boolean;
+    canStrike: boolean;
+    isInlineCode: boolean;
+    canInlineCode: boolean;
+    isBulletList: boolean;
+    canBulletList: boolean;
+    isOrderedList: boolean;
+    canOrderedList: boolean;
+    isCodeBlock: boolean;
+    canCodeBlock: boolean;
+    isBlockquote: boolean;
+    canBlockquote: boolean;
+    canHorizontalRule: boolean;
+};
+
+type RichTextSelector = (ctx: EditorStateSnapshot, readOnly: boolean) => Partial<Record<string, boolean>>;
+type DefaultEditorState = ReturnType<typeof defaultEditorState>;
+type EditorState<Selector extends RichTextSelector = RichTextSelector> = DefaultEditorState & ReturnType<Selector> & Record<string, boolean | undefined>;
+
+interface PuckRichTextOptions {
+    /**
+     * If set to false, the blockquote extension will not be registered
+     * @example blockquote: false
+     */
+    blockquote: Partial<BlockquoteOptions> | false;
+    /**
+     * If set to false, the bold extension will not be registered
+     * @example bold: false
+     */
+    bold: Partial<BoldOptions> | false;
+    /**
+     * If set to false, the bulletList extension will not be registered
+     * @example bulletList: false
+     */
+    bulletList: Partial<BulletListOptions> | false;
+    /**
+     * If set to false, the code extension will not be registered
+     * @example code: false
+     */
+    code: Partial<CodeOptions> | false;
+    /**
+     * If set to false, the codeBlock extension will not be registered
+     * @example codeBlock: false
+     */
+    codeBlock: Partial<CodeBlockOptions> | false;
+    /**
+     * If set to false, the document extension will not be registered
+     * @example document: false
+     */
+    document: false;
+    /**
+     * If set to false, the hardBreak extension will not be registered
+     * @example hardBreak: false
+     */
+    hardBreak: Partial<HardBreakOptions> | false;
+    /**
+     * If set to false, the heading extension will not be registered
+     * @example heading: false
+     */
+    heading: Partial<HeadingOptions> | false;
+    /**
+     * If set to false, the horizontalRule extension will not be registered
+     * @example horizontalRule: false
+     */
+    horizontalRule: Partial<HorizontalRuleOptions> | false;
+    /**
+     * If set to false, the italic extension will not be registered
+     * @example italic: false
+     */
+    italic: Partial<ItalicOptions> | false;
+    /**
+     * If set to false, the listItem extension will not be registered
+     * @example listItem: false
+     */
+    listItem: Partial<ListItemOptions> | false;
+    /**
+     * If set to false, the listItemKeymap extension will not be registered
+     * @example listKeymap: false
+     */
+    listKeymap: Partial<ListKeymapOptions> | false;
+    /**
+     * If set to false, the link extension will not be registered
+     * @example link: false
+     */
+    link: Partial<LinkOptions> | false;
+    /**
+     * If set to false, the orderedList extension will not be registered
+     * @example orderedList: false
+     */
+    orderedList: Partial<OrderedListOptions> | false;
+    /**
+     * If set to false, the paragraph extension will not be registered
+     * @example paragraph: false
+     */
+    paragraph: Partial<ParagraphOptions> | false;
+    /**
+     * If set to false, the strike extension will not be registered
+     * @example strike: false
+     */
+    strike: Partial<StrikeOptions> | false;
+    /**
+     * If set to false, the text extension will not be registered
+     * @example text: false
+     */
+    text: false;
+    /**
+     * If set to false, the textAlign extension will not be registered
+     * @example text: false
+     */
+    textAlign: Partial<TextAlignOptions> | false;
+    /**
+     * If set to false, the underline extension will not be registered
+     * @example underline: false
+     */
+    underline: Partial<UnderlineOptions> | false;
+}
+
 type FieldOption = {
     label: string;
     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 RichtextField<UserSelector extends RichTextSelector = RichTextSelector> extends BaseField {
+    type: "richtext";
+    contentEditable?: boolean;
+    initialHeight?: CSSProperties["height"];
+    options?: Partial<PuckRichTextOptions>;
+    renderMenu?: (props: {
+        children: ReactNode;
+        editor: Editor | null;
+        editorState: EditorState<UserSelector> | null;
+        readOnly: boolean;
+    }) => ReactNode;
+    renderInlineMenu?: (props: {
+        children: ReactNode;
+        editor: Editor | null;
+        editorState: EditorState<UserSelector> | null;
+        readOnly: boolean;
+    }) => ReactNode;
+    tiptap?: {
+        selector?: UserSelector;
+        extensions?: Extensions;
+    };
+}
+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];
-    getItemSummary?: (item: Props[0], index?: number) => string;
+    defaultItemProps?: Props[0] | ((index: number) => Props[0]);
+    getItemSummary?: (item: Props[0], index?: number) => ReactNode;
     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>;
     mapProp?: (value: TableShape) => PropShape;
 };
-type NotUndefined<T> = T extends undefined ? Record<string, any> : T;
+type NotUndefined<T> = T extends undefined ? never : T;
 type ExternalFieldWithAdaptor<Props extends any = {
     [key: string]: any;
 }> = BaseField & {
@@ -80,12 +277,16 @@ type ExternalFieldWithAdaptor<Props extends any = {
     placeholder?: string;
     adaptor: Adaptor<any, any, Props>;
     adaptorParams?: object;
-    getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
+    getItemSummary: (item: NotUndefined<Props>, index?: number) => ReactNode;
+};
+type CacheOpts = {
+    enabled?: boolean;
 };
-type ExternalField<Props extends any = {
+interface ExternalField<Props extends any = {
     [key: string]: any;
-}> = BaseField & {
+}> extends BaseField {
     type: "external";
+    cache?: CacheOpts;
     placeholder?: string;
     fetchList: (params: {
         query: string;
@@ -93,7 +294,7 @@ type ExternalField<Props extends any = {
     }) => Promise<any[] | null>;
     mapProp?: (value: any) => Props;
     mapRow?: (value: any) => Record<string, string | number | ReactElement>;
-    getItemSummary?: (item: NotUndefined<Props>, index?: number) => string;
+    getItemSummary?: (item: NotUndefined<Props>, index?: number) => ReactNode;
     showSearch?: boolean;
     renderFooter?: (props: {
         items: any[];
@@ -101,7 +302,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,19 +311,20 @@ 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 & {
+    key?: string;
+}
+interface SlotField extends BaseField {
     type: "slot";
     allow?: string[];
     disallow?: string[];
-};
-type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
+}
+type Field<ValueType = any, UserField extends {} = {}> = TextField | RichtextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
     [key: string]: any;
-}[] ? ValueType : {}[], UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
+}[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
 type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
     [PropName in keyof Omit<ComponentProps, "editMode">]: UserField extends {
         type: PropertyKey;
@@ -141,13 +343,15 @@ type DropZoneProps = {
     allow?: string[];
     disallow?: string[];
     style?: CSSProperties;
-    minEmptyHeight?: number;
+    minEmptyHeight?: CSSProperties["minHeight"] | number;
     className?: string;
     collisionAxis?: DragAxis;
+    as?: ElementType;
+    ref?: Ref<any>;
 };
 
 type PuckContext = {
-    renderDropZone: React.FC<DropZoneProps>;
+    renderDropZone: (props: DropZoneProps) => React.ReactNode;
     metadata: Metadata;
     isEditing: boolean;
     dragRef: ((element: Element | null) => void) | null;
@@ -195,6 +399,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,6 +416,7 @@ UserField extends BaseField = {}> = {
         fields: Fields<FieldProps>;
         lastFields: Fields<FieldProps>;
         lastData: DataShape | null;
+        metadata: ComponentMetadata;
         appState: AppState;
         parent: ComponentData | null;
     }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
@@ -218,7 +425,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: {
@@ -229,9 +436,10 @@ UserField extends BaseField = {}> = {
         permissions: Partial<Permissions>;
         appState: AppState;
         lastData: DataShape | null;
+        parent: ComponentData | 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[];
@@ -249,7 +457,7 @@ type ConfigInternal<Props extends DefaultComponents = DefaultComponents, RootPro
     root?: RootConfigInternal<RootProps, UserField>;
 };
 type DefaultComponents = Record<string, any>;
-type Config<PropsOrParams extends LeftOrExactRight<PropsOrParams, DefaultComponents, ConfigParams> = DefaultComponents | ConfigParams, RootProps extends DefaultComponentProps = DefaultComponentProps, CategoryName extends string = string> = PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, never> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number]> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, infer ParamFields> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], ParamFields[keyof ParamFields] & BaseField> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, any> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], {}> : ConfigInternal<PropsOrParams, RootProps, CategoryName>;
+type Config<PropsOrParams extends LeftOrExactRight<PropsOrParams, DefaultComponents, ConfigParams> = DefaultComponents | ConfigParams, RootProps extends DefaultComponentProps = any, CategoryName extends string = string> = PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, never> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number]> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, infer ParamFields> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], ParamFields[keyof ParamFields] & BaseField> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, any> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], {}> : ConfigInternal<PropsOrParams, RootProps, CategoryName>;
 type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends ConfigInternal<infer PropsOrParams, infer RootProps, infer CategoryName, infer UserField> ? {
     props: PropsOrParams;
     rootProps: RootProps & DefaultRootFieldProps;
@@ -258,6 +466,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;
@@ -297,6 +511,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;
@@ -333,6 +553,7 @@ type UiState = {
     };
     field: {
         focus?: string | null;
+        metadata?: Record<string, any>;
     };
     plugin: {
         current: string | null;
@@ -370,12 +591,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 = DefaultComponentProps, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
-    components?: Components;
-    root?: RootProps;
-    categories?: CategoryNames;
-    fields?: AssertHasValue<UserFields>;
-};
 type FieldsExtension = {
     [Type in string]: {
         type: Type;