@measured/puck-plugin-heading-analyzer 0.21.0-canary.f3ce0d72 → 0.21.0-canary.fee2ba98

package/dist/index.d.ts

@@ -1,10 +1,185 @@
-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;
@@ -41,6 +216,28 @@ interface RadioField extends BaseField {
     type: "radio";
     options: FieldOptions;
 }
+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;
 }[] = {
@@ -53,7 +250,7 @@ interface ArrayField<Props extends {
         } ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
     };
     defaultItemProps?: Props[0] | ((index: number) => Props[0]);
-    getItemSummary?: (item: Props[0], index?: number) => string;
+    getItemSummary?: (item: Props[0], index?: number) => ReactNode;
     max?: number;
     min?: number;
 }
@@ -80,7 +277,7 @@ 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;
@@ -97,7 +294,7 @@ interface 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[];
@@ -125,7 +322,7 @@ interface SlotField extends BaseField {
     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 : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
 type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
@@ -146,9 +343,11 @@ 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 = {
@@ -237,6 +436,7 @@ UserField extends BaseField = {}> = {
         permissions: Partial<Permissions>;
         appState: AppState;
         lastData: DataShape | null;
+        parent: ComponentData | null;
     }) => Promise<Partial<Permissions>> | Partial<Permissions>;
     metadata?: ComponentMetadata;
 } & ComponentConfigExtensions;
@@ -332,7 +532,6 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
-    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -345,7 +544,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number | "100%";
+            width: number;
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -353,9 +552,7 @@ type UiState = {
     };
     field: {
         focus?: string | null;
-    };
-    plugin: {
-        current: string | null;
+        metadata?: Record<string, any>;
     };
 };
 type AppState<UserData extends Data = Data> = {
@@ -400,11 +597,6 @@ 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;
@@ -428,6 +620,11 @@ 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 {
@@ -498,7 +695,7 @@ type DragAxis = "dynamic" | "y" | "x";
 
 type iconTypes = "Smartphone" | "Monitor" | "Tablet";
 type Viewport = {
-    width: number | "100%";
+    width: number;
     height?: number | "auto";
     label?: string;
     icon?: iconTypes | ReactNode;
@@ -512,13 +709,8 @@ 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;