@measured/puck 0.21.0-canary.c0db75c1 → 0.21.0-canary.c78dc826

package/dist/{actions-CaYAKtsG.d.ts → walk-tree-Ja9bNCM9.d.ts}

@@ -1,10 +1,185 @@
-import { ReactElement, ReactNode, CSSProperties, ElementType, JSX } from 'react';
+import { ReactElement, CSSProperties, ReactNode, ElementType, 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;
 }[] = {
@@ -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 {} = {}> = {
@@ -334,7 +531,6 @@ interface FieldMetadata extends Metadata {
 type ItemWithId = {
     _arrayId: string;
     _originalIndex: number;
-    _currentIndex: number;
 };
 type ArrayState = {
     items: ItemWithId[];
@@ -345,7 +541,6 @@ type UiState = {
     rightSideBarVisible: boolean;
     leftSideBarWidth?: number | null;
     rightSideBarWidth?: number | null;
-    mobilePanelExpanded?: boolean;
     itemSelector: ItemSelector | null;
     arrayState: Record<string, ArrayState | undefined>;
     previewMode: "interactive" | "edit";
@@ -358,7 +553,7 @@ type UiState = {
     isDragging: boolean;
     viewports: {
         current: {
-            width: number | "100%";
+            width: number;
             height: number | "auto";
         };
         controlsVisible: boolean;
@@ -366,9 +561,7 @@ type UiState = {
     };
     field: {
         focus?: string | null;
-    };
-    plugin: {
-        current: string | null;
+        metadata?: Record<string, any>;
     };
 };
 type AppState<UserData extends Data = Data> = {
@@ -413,14 +606,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 PluginInternal = Plugin & {
-    mobileOnly?: boolean;
-};
 
 type MapFnParams<ThisField = Field> = {
     value: any;
@@ -444,6 +629,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 {
@@ -515,7 +705,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;
@@ -535,13 +725,8 @@ type IframeConfig = {
 };
 type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
 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 History<D = any> = {
     state: D;
@@ -566,6 +751,7 @@ type Slot<Props extends {
     [K in keyof Props]: ComponentDataOptionalId<Props[K], K extends string ? K : never>;
 }[keyof Props][];
 type WithSlotProps<Target extends Record<string, any>, Components extends DefaultComponents = DefaultComponents, SlotType extends Content<Components> = Content<Components>> = WithDeepSlots<Target, SlotType>;
+type RichText = string | ReactNode;
 
 type InsertAction = {
     type: "insert";
@@ -633,4 +819,30 @@ type PuckAction = {
     recordHistory?: boolean;
 } & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
 
-export { type RootDataWithoutProps as $, type AppState as A, overrideKeys as B, type Config as C, type Data as D, type OverrideKey as E, type Fields as F, type FieldRenderFunctions as G, type History as H, type IframeConfig as I, type ItemWithId as J, type ArrayState as K, type SlotComponent as L, type Metadata as M, type PuckComponent as N, type OnAction as O, type PrivateAppState as P, type ComponentConfigExtensions as Q, type RootData as R, type Slot as S, type RootConfig as T, type UserGenerics as U, type Viewports as V, type WithId as W, type ExtractConfigParams as X, type ConfigParams as Y, type ComponentConfigParams as Z, type BaseData as _, type PuckAction as a, type ComponentDataOptionalId as a0, type MappedItem as a1, type ComponentDataMap as a2, type PuckMetadata as a3, type ComponentMetadata as a4, type FieldMetadata as a5, type BaseField as a6, type TextField as a7, type NumberField as a8, type TextareaField as a9, type SelectField as aa, type RadioField as ab, type ArrayField as ac, type ObjectField as ad, type Adaptor as ae, type ExternalFieldWithAdaptor as af, type CacheOpts as ag, type ExternalField as ah, type CustomFieldRender as ai, type CustomField as aj, type SlotField as ak, type PuckContext as al, type DefaultRootRenderProps as am, type DefaultRootProps as an, type WithPuckProps as ao, type AsFieldProps as ap, type WithChildren as aq, type ExtractField as ar, type Content as b, type ComponentData as c, type DefaultComponents as d, type DefaultComponentProps as e, type DefaultRootFieldProps as f, type Permissions as g, type RootDataWithProps as h, type ResolveDataTrigger as i, type Plugin as j, type Overrides as k, type UiState as l, type ComponentConfig as m, type FieldTransforms as n, type Field as o, type FieldProps as p, type DropZoneProps as q, type InitialHistory as r, type ItemSelector as s, type PluginInternal as t, type WithSlotProps as u, type Direction as v, type DragAxis as w, type Viewport as x, type FieldTransformFnParams as y, type FieldTransformFn as z };
+type MigrationOptions<UserConfig extends Config> = {
+    migrateDynamicZonesForComponent?: {
+        [ComponentName in keyof UserConfig["components"]]: (props: WithId<UserGenerics<UserConfig>["UserProps"][ComponentName]>, zones: Record<string, Content>) => ComponentData["props"];
+    };
+};
+declare function migrate<UserConfig extends Config = Config>(data: Data, config?: UserConfig, migrationOptions?: MigrationOptions<UserConfig>): Data;
+
+type PropTransform<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
+    [ComponentName in keyof Components]: (props: Components[ComponentName] & {
+        [key: string]: any;
+    }) => Components[ComponentName];
+} & {
+    root: (props: RootProps & {
+        [key: string]: any;
+    }) => RootProps;
+}>;
+declare function transformProps<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Components, RootProps>, config?: Config): Data;
+
+declare function resolveAllData<Components extends DefaultComponents = DefaultComponents, RootProps extends Record<string, any> = DefaultRootFieldProps>(data: Partial<Data>, config: Config, metadata?: Metadata, onResolveStart?: (item: ComponentData) => void, onResolveEnd?: (item: ComponentData) => void): Promise<Data<Components, RootProps>>;
+
+type WalkTreeOptions = {
+    parentId: string;
+    propName: string;
+};
+declare function walkTree<T extends ComponentData | RootData | G["UserData"], UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(data: T, config: UserConfig, callbackFn: (data: Content, options: WalkTreeOptions) => Content | null | void): T;
+
+export { type RootData as $, type AppState as A, type FieldRenderFunctions as B, type Config as C, type DropZoneProps as D, type ItemWithId as E, type Fields as F, type ArrayState as G, type History as H, type IframeConfig as I, type SlotComponent as J, type PuckComponent as K, type ComponentConfigExtensions as L, type Metadata as M, type RootConfig as N, type Overrides as O, type Permissions as P, type DefaultComponents as Q, type RootDataWithProps as R, type Slot as S, type ExtractConfigParams as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type ConfigParams as X, type ComponentConfigParams as Y, type BaseData as Z, type RootDataWithoutProps as _, type ComponentData as a, type ComponentDataOptionalId as a0, type MappedItem as a1, type ComponentDataMap as a2, type Content as a3, type PuckMetadata as a4, type ComponentMetadata as a5, type FieldMetadata as a6, type BaseField as a7, type TextField as a8, type NumberField as a9, type TextareaField as aa, type SelectField as ab, type RadioField as ac, type ArrayField as ad, type ObjectField as ae, type Adaptor as af, type ExternalFieldWithAdaptor as ag, type CacheOpts as ah, type ExternalField as ai, type CustomFieldRender as aj, type CustomField as ak, type SlotField as al, type PuckContext as am, type DefaultRootFieldProps as an, type DefaultRootRenderProps as ao, type DefaultRootProps as ap, type DefaultComponentProps as aq, type WithId as ar, type WithPuckProps as as, type AsFieldProps as at, type WithChildren as au, type ExtractField as av, type PuckAction as b, type ResolveDataTrigger as c, type Plugin as d, type UiState as e, type ComponentConfig as f, type FieldTransforms as g, type RichtextField as h, type Field as i, type FieldProps as j, type Data as k, type OnAction as l, migrate as m, type InitialHistory as n, type ItemSelector as o, type RichText as p, type Direction as q, resolveAllData as r, type DragAxis as s, transformProps as t, type Viewport as u, type FieldTransformFnParams as v, walkTree as w, type FieldTransformFn as x, overrideKeys as y, type OverrideKey as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@measured/puck",
-  "version": "0.21.0-canary.c0db75c1",
+  "version": "0.21.0-canary.c78dc826",
   "description": "The open-source visual editor for React",
   "author": "Chris Villa <chris@puckeditor.com>",
   "repository": "measuredco/puck",
@@ -45,11 +45,6 @@
       "import": "./dist/rsc.mjs",
       "require": "./dist/rsc.js"
     },
-    "./internal": {
-      "types": "./dist/internal.d.ts",
-      "import": "./dist/internal.mjs",
-      "require": "./dist/internal.js"
-    },
     "./puck.css": "./dist/index.css",
     "./no-external.css": "./dist/no-external.css",
     "./dist/index.css": "./dist/index.css",
@@ -65,7 +60,7 @@
   "license": "MIT",
   "scripts": {
     "lint": "eslint \"**/*.ts*\"",
-    "build": "rm -rf dist && tsup bundle/index.ts bundle/rsc.tsx bundle/no-external.ts bundle/internal.ts",
+    "build": "rm -rf dist && tsup bundle/index.ts bundle/rsc.tsx bundle/no-external.ts",
     "test": "jest",
     "prepare": "cp ../../README.md . && yarn build",
     "postpublish": "rm README.md"
@@ -100,9 +95,31 @@
   "dependencies": {
     "@dnd-kit/helpers": "0.1.18",
     "@dnd-kit/react": "0.1.18",
+    "@radix-ui/react-popover": "^1.1.15",
+    "@tiptap/core": "^3.11.1",
+    "@tiptap/extension-blockquote": "^3.11.1",
+    "@tiptap/extension-bold": "^3.11.1",
+    "@tiptap/extension-code": "^3.11.1",
+    "@tiptap/extension-code-block": "^3.11.1",
+    "@tiptap/extension-document": "^3.11.1",
+    "@tiptap/extension-hard-break": "^3.11.1",
+    "@tiptap/extension-heading": "^3.11.1",
+    "@tiptap/extension-horizontal-rule": "^3.11.1",
+    "@tiptap/extension-italic": "^3.11.1",
+    "@tiptap/extension-link": "^3.11.1",
+    "@tiptap/extension-list": "^3.11.1",
+    "@tiptap/extension-paragraph": "^3.11.1",
+    "@tiptap/extension-strike": "^3.11.1",
+    "@tiptap/extension-text": "^3.11.1",
+    "@tiptap/extension-text-align": "^3.11.1",
+    "@tiptap/extension-underline": "^3.11.1",
+    "@tiptap/html": "^3.11.1",
+    "@tiptap/pm": "^3.11.1",
+    "@tiptap/react": "^3.11.1",
     "deep-diff": "^1.0.2",
     "fast-equals": "5.2.2",
     "flat": "^5.0.2",
+    "happy-dom": "^20.0.10",
     "object-hash": "^3.0.0",
     "react-hotkeys-hook": "^4.6.1",
     "use-debounce": "^9.0.4",