@measured/puck-plugin-heading-analyzer 0.21.0-canary.15fe8d60 → 0.21.0-canary.17395b2c

package/dist/index.css

@@ -1,162 +1,18 @@
 /* css-module:/home/runner/work/puck/puck/packages/plugin-heading-analyzer/src/HeadingAnalyzer.module.css/#css-module-data */
-._HeadingAnalyzer_116v6_1 {
+._HeadingAnalyzer_yg0s7_1 {
   display: block;
+  padding: 16px;
 }
-._HeadingAnalyzer-cssWarning_116v6_5 {
+._HeadingAnalyzer-cssWarning_yg0s7_6 {
   display: none !important;
 }
-._HeadingAnalyzerItem_116v6_9 {
+._HeadingAnalyzerItem_yg0s7_10 {
   display: inline;
 }
-._HeadingAnalyzerItem--missing_116v6_13 {
+._HeadingAnalyzerItem--missing_yg0s7_14 {
   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

@@ -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[];
@@ -118,13 +315,14 @@ interface CustomField<Value extends any> extends BaseField {
     type: "custom";
     render: CustomFieldRender<Value>;
     contentEditable?: boolean;
+    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 : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
 type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
@@ -145,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 = {
@@ -236,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;
@@ -320,6 +521,7 @@ interface FieldMetadata extends Metadata {
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
+    _currentIndex: number;
 };
 type ArrayState = {
     items: ItemWithId[];
@@ -330,6 +532,7 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
+    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -342,7 +545,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number;
+            width: number | "100%";
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -350,6 +553,10 @@ type UiState = {
     };
     field: {
         focus?: string | null;
+        metadata?: Record<string, any>;
+    };
+    plugin: {
+        current: string | null;
     };
 };
 type AppState<UserData extends Data = Data> = {
@@ -394,6 +601,11 @@ 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;
@@ -417,11 +629,6 @@ 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 {
@@ -492,7 +699,7 @@ type DragAxis = "dynamic" | "y" | "x";
 
 type iconTypes = "Smartphone" | "Monitor" | "Tablet";
 type Viewport = {
-    width: number;
+    width: number | "100%";
     height?: number | "auto";
     label?: string;
     icon?: iconTypes | ReactNode;
@@ -506,8 +713,13 @@ 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;