@prismicio/editor-fields 0.4.4 → 0.4.6

package/dist/fields/RichTextField/RichTextField.d.ts

@@ -1,6 +1,5 @@
 import type { RichTextContent } from "@prismicio/types-internal/lib/content";
 import type { RichText } from "@prismicio/types-internal/lib/customtypes";
-import { type FC } from "react";
 interface RichTextFieldProps {
     content: RichTextContent | undefined;
     field: RichText;
@@ -8,5 +7,5 @@ interface RichTextFieldProps {
     onContentChange: (content: RichTextContent | undefined) => void;
     readOnly: boolean;
 }
-export declare const RichTextField: FC<RichTextFieldProps>;
+export declare function RichTextField(props: RichTextFieldProps): JSX.Element;
 export {};

package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts

@@ -4,7 +4,7 @@ declare const _default: {
     component: import("@tiptap/core").Node<import("@tiptap/extension-list-item").ListItemOptions, any>;
     converter: {
         fromPrismic(schema: Schema<any, any>): (list: {
-            type: "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
+            type: "em" | "embed" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
             content: {
                 text: string;
             } & {
@@ -13,7 +13,7 @@ declare const _default: {
                 } & {
                     start: number;
                     end: number;
-                    type: "label" | "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
+                    type: "em" | "embed" | "label" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
                 })[] | undefined;
             };
         } & {
@@ -21,7 +21,7 @@ declare const _default: {
             direction?: string | undefined;
         }) => ProsemirrorNode | undefined;
         toPrismic(node: ProsemirrorNode, nodeType: "list-item" | "o-list-item"): readonly ({
-            type: "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
+            type: "em" | "embed" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
             content: {
                 text: string;
             } & {
@@ -30,7 +30,7 @@ declare const _default: {
                 } & {
                     start: number;
                     end: number;
-                    type: "label" | "em" | "embed" | "strong" | "image" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
+                    type: "em" | "embed" | "label" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
                 })[] | undefined;
             };
         } & {

package/dist/fields/RichTextField/extensions/Bold/Bold.d.ts

@@ -0,0 +1,3 @@
+import { MarkExtension } from "../../models/EditorExtension";
+declare const EditorBold: MarkExtension<unknown>;
+export default EditorBold;

package/dist/fields/RichTextField/extensions/BulletList/BulletList.d.ts

@@ -0,0 +1,3 @@
+import { ListExtension } from "../../models";
+declare const EditorBulletList: ListExtension;
+export default EditorBulletList;

package/dist/fields/RichTextField/extensions/CodeBlock/CodeBlock.d.ts

@@ -0,0 +1,3 @@
+import { TextExtension } from "../../models";
+declare const EditorCodeBlock: TextExtension;
+export default EditorCodeBlock;

package/dist/fields/RichTextField/extensions/Embed/EmbedExtension.d.ts

@@ -0,0 +1,10 @@
+import { EmbedExtension } from "../../models";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        embed: {
+            setEmbed: () => ReturnType;
+        };
+    }
+}
+declare const _default: EmbedExtension;
+export default _default;

package/dist/fields/RichTextField/extensions/Embed/EmbedView.d.ts

@@ -1,3 +1,13 @@
-import { type FC } from "react";
-declare const EmbedView: FC;
-export default EmbedView;
+import type { EmbedContent } from "@prismicio/types-internal/lib/content";
+import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
+import { NodeViewProps } from "@tiptap/react";
+interface EmbedNode extends ProseMirrorNode {
+    attrs: {
+        content: EmbedContent | undefined;
+    };
+}
+export interface EmbedViewProps extends NodeViewProps {
+    node: EmbedNode;
+}
+export declare function EmbedView(props: EmbedViewProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/extensions/Embed/useEmbedView.d.ts

@@ -0,0 +1,12 @@
+import type { EmbedContent } from "@prismicio/types-internal/lib/content";
+import { KeyboardEvent, RefObject } from "react";
+import type { EmbedViewProps } from "./EmbedView";
+export declare function useEmbedView(props: EmbedViewProps, inputRef: RefObject<HTMLInputElement>, containerRef: RefObject<HTMLDivElement>): {
+    inputRef: RefObject<HTMLInputElement>;
+    containerRef: RefObject<HTMLDivElement>;
+    onKeyDown: (event: KeyboardEvent<Element>) => void;
+    url: string;
+    urlChanged: (url: string) => void;
+    onContentChange: (content?: EmbedContent) => void;
+    debouncedUrl: string;
+};

package/dist/fields/RichTextField/extensions/Heading/Heading.d.ts

@@ -0,0 +1,21 @@
+import { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
+import { type Level as TTLevel } from "@tiptap/extension-heading";
+import { type ReadonlyNonEmptyArray } from "fp-ts/ReadonlyNonEmptyArray";
+import type { Node as ProsemirrorNode } from "prosemirror-model";
+import { HeadingTextExtension } from "../../models";
+export declare type Level = TTLevel;
+interface HeadingName {
+    fullName: RichTextNodeType;
+    level: Level;
+}
+export declare const HeadingName: {
+    byLevel(level: Level): RichTextNodeType;
+    default(level: Level): HeadingName;
+    fromPrismic(headingName: string, levels?: ReadonlyNonEmptyArray<Level>): HeadingName | undefined;
+    fromProsemirror(nodeAttributes: ProsemirrorNode["attrs"], levels: ReadonlyNonEmptyArray<Level>): HeadingName | undefined;
+};
+declare const _default: {
+    name: string;
+    build: (nodeTypes?: Set<RichTextNodeType>) => HeadingTextExtension | undefined;
+};
+export default _default;

package/dist/fields/RichTextField/extensions/Image/ImageExtension.d.ts

@@ -0,0 +1,10 @@
+import { ImageExtension } from "../../models";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        image: {
+            setImage: () => ReturnType;
+        };
+    }
+}
+declare const _default: ImageExtension;
+export default _default;

package/dist/fields/RichTextField/extensions/Image/ImageView.d.ts

@@ -0,0 +1,13 @@
+import type { ImageContent } from "@prismicio/types-internal/lib/content";
+import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
+import { NodeViewProps } from "@tiptap/react";
+interface ImageNode extends ProseMirrorNode {
+    attrs: {
+        content: ImageContent | undefined;
+    };
+}
+export interface ImageViewProps extends NodeViewProps {
+    node: ImageNode;
+}
+export declare function ImageView(props: ImageViewProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/extensions/Italic/Italic.d.ts

@@ -0,0 +1,3 @@
+import { MarkExtension } from "../../models/EditorExtension";
+declare const EditorItalic: MarkExtension<unknown>;
+export default EditorItalic;

package/dist/fields/RichTextField/extensions/Link/Link.d.ts

@@ -0,0 +1,44 @@
+import { MarkExtension } from "../../models";
+declare const EditorLink: MarkExtension<{
+    __TYPE__: "LinkContent";
+    value: ({
+        __TYPE__: "ImageLink";
+    } & {
+        id: string;
+        url: string;
+        height: string;
+        width: string;
+        size: string;
+        name: string;
+        kind: string;
+    } & {
+        date?: string | null | undefined;
+    }) | ({
+        id: string;
+        url: string;
+        name: string;
+        kind: string;
+        size: string;
+    } & {
+        date?: string | null | undefined;
+    } & {
+        __TYPE__: "FileLink";
+    } & {
+        size?: string | undefined;
+    }) | ({
+        __TYPE__: "DocumentLink";
+    } & {
+        id: string;
+    }) | ({
+        __TYPE__: "ExternalLink";
+    } & {
+        url: string;
+    } & {
+        kind?: "web" | undefined;
+        target?: string | null | undefined;
+        preview?: {
+            title?: string | undefined;
+        } | null | undefined;
+    });
+}>;
+export default EditorLink;

package/dist/fields/RichTextField/extensions/Link.d.ts

@@ -1,44 +1,2 @@
 import { MarkExtension } from "../models";
-declare const EditorLink: MarkExtension<{
-    __TYPE__: "LinkContent";
-    value: ({
-        __TYPE__: "ImageLink";
-    } & {
-        id: string;
-        url: string;
-        height: string;
-        width: string;
-        size: string;
-        name: string;
-        kind: string;
-    } & {
-        date?: string | null | undefined;
-    }) | ({
-        id: string;
-        url: string;
-        name: string;
-        kind: string;
-        size: string;
-    } & {
-        date?: string | null | undefined;
-    } & {
-        __TYPE__: "FileLink";
-    } & {
-        size?: string | undefined;
-    }) | ({
-        __TYPE__: "DocumentLink";
-    } & {
-        id: string;
-    }) | ({
-        __TYPE__: "ExternalLink";
-    } & {
-        url: string;
-    } & {
-        kind?: "web" | undefined;
-        target?: string | null | undefined;
-        preview?: {
-            title?: string | undefined;
-        } | null | undefined;
-    });
-}>;
-export default EditorLink;
+export declare const Link: MarkExtension<unknown>;

package/dist/fields/RichTextField/extensions/OrderedList/OrderedList.d.ts

@@ -0,0 +1,3 @@
+import { ListExtension } from "../../models";
+declare const EditorOrderedList: ListExtension;
+export default EditorOrderedList;

package/dist/fields/RichTextField/extensions/Paragraph/Paragraph.d.ts

@@ -0,0 +1,3 @@
+import { TextExtension } from "../../models";
+declare const EditorParagraph: TextExtension;
+export default EditorParagraph;

package/dist/fields/RichTextField/extensions/extensions.d.ts

@@ -0,0 +1,16 @@
+import type { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
+import type { WidgetExtension } from "../models";
+import { default as Bold } from "./Bold/Bold";
+import { default as BulletList } from "./BulletList/BulletList";
+import { default as CodeBlock } from "./CodeBlock/CodeBlock";
+import { default as Embed } from "./Embed/EmbedExtension";
+import { default as Heading } from "./Heading/Heading";
+import { default as Image } from "./Image/ImageExtension";
+import { default as Italic } from "./Italic/Italic";
+import { Link } from "./Link";
+import { default as OrderedList } from "./OrderedList/OrderedList";
+import { default as Paragraph } from "./Paragraph/Paragraph";
+export declare const DefaultTextExtension: import("../models").TextExtension;
+export declare const MarkExtensions: import("../models").MarkExtension<unknown>[];
+export declare function getAllExtensions(nodeTypes?: Set<RichTextNodeType>): WidgetExtension[];
+export { Bold, BulletList, CodeBlock, Embed, Heading, Image, Italic, Link, OrderedList, Paragraph };

package/dist/fields/RichTextField/extensions/index.d.ts

@@ -1,14 +1 @@
-import type { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
-import type { WidgetExtension } from "../models";
-import { default as Bold } from "./Bold";
-import { default as BulletList } from "./BulletList";
-import { default as CodeBlock } from "./CodeBlock";
-import { default as Embed } from "./Embed";
-import { default as Heading } from "./Heading";
-import { default as Italic } from "./Italic";
-import { default as OrderedList } from "./OrderedList";
-import { default as Paragraph } from "./Paragraph";
-export declare const DefaultExtension: import("../models").TextExtension;
-export declare const MarkExtensions: import("../models").MarkExtension<unknown>[];
-export declare const Extensions: (nodeTypes?: Set<RichTextNodeType>) => readonly WidgetExtension[];
-export { Bold, BulletList, CodeBlock, Embed, Heading, Italic, OrderedList, Paragraph };
+export * from "./extensions";

package/dist/fields/RichTextField/models/EditorExtension.d.ts

@@ -4,7 +4,7 @@ import type { Mark, Node } from "@tiptap/core";
 import type { NonEmptyArray } from "fp-ts/NonEmptyArray";
 import type { ReadonlyNonEmptyArray } from "fp-ts/ReadonlyNonEmptyArray";
 import type { Mark as ProsemirrorMark, Node as ProsemirrorNode, Schema } from "prosemirror-model";
-import type { Level } from "../extensions/Heading";
+import type { Level } from "../extensions/Heading/Heading";
 export declare enum ExtensionType {
     Document = "document",
     Mark = "mark",
@@ -63,6 +63,7 @@ export declare class TextExtension {
         toPrismic(elmt: ProsemirrorNode): TextBlock | readonly TextBlock[] | undefined;
     }, placeholder?: ExtensionPlaceholder, lockedFormat?: boolean);
 }
+export declare function isTextExtension(extension: WidgetExtension): extension is TextExtension;
 export declare class EmbedExtension {
     readonly richTextNodeTypes: NonEmptyArray<RichTextNodeType>;
     readonly name: string;
@@ -106,3 +107,4 @@ export declare class ListExtension extends TextExtension {
         toPrismic(elmt: ProsemirrorNode): readonly TextBlock[];
     });
 }
+export declare function isListExtension(extension: WidgetExtension): extension is ListExtension;

package/dist/fields/RichTextField/models/MenuItems.d.ts

@@ -1,9 +1,9 @@
+import type { IconName } from "@prismicio/editor-ui";
 import { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
-import type { Editor, Range } from "@tiptap/core";
-import type { ReactNode } from "react";
+import type { ChainedCommands, Editor, Range } from "@tiptap/core";
 export declare type MenuItem = Readonly<{
     nodeType: RichTextNodeType;
-    icon: ReactNode;
+    icon: IconName;
     isActive: (editor: Editor) => boolean;
     runCommands: (editor: Editor, options?: RunCommandsOptions) => boolean;
 } & ({
@@ -20,5 +20,6 @@ declare type RunCommandsOptions = Readonly<{
 export declare const ALL_NODE_ITEMS: readonly MenuItem[];
 export declare const ALL_MARK_ITEMS: readonly MenuItem[];
 export declare const ALL_EXTRA_ITEMS: readonly MenuItem[];
-export declare function filterMenuItems(menuItems: readonly MenuItem[], nodeTypes: readonly string[]): readonly MenuItem[];
+export declare function createRunCommandsFn(chainCommands: (commands: ChainedCommands, editor: Editor) => ChainedCommands): (editor: Editor, options?: RunCommandsOptions) => boolean;
+export declare function filterMenuItems(menuItems: readonly MenuItem[], nodeTypes: readonly string[]): MenuItem[];
 export {};

package/dist/fields/RichTextField/models/RichTextConfig.d.ts

@@ -1,10 +1,26 @@
-import type { TextBlock } from "@prismicio/types-internal/lib/content";
 import { RichTextConfig } from "@prismicio/types-internal/lib/customtypes";
 import type { Node as ProsemirrorNode, Schema } from "prosemirror-model";
 import { type WidgetExtension } from "./EditorExtension";
-declare type TextConverter = (text: TextBlock) => ProsemirrorNode | undefined;
-export declare function composeExtensions(config: RichTextConfig | undefined): {
-    defaultTextConverter: ((schema: Schema<any, any>) => TextConverter) | undefined;
-    extensions: readonly WidgetExtension[];
+export declare function composeExtensions(config?: RichTextConfig): {
+    extensions: WidgetExtension[];
+    defaultTextConverter: undefined;
+} | {
+    extensions: WidgetExtension[];
+    defaultTextConverter: (schema: Schema<any, any>) => (block: {
+        type: "em" | "embed" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
+        content: {
+            text: string;
+        } & {
+            spans?: ({
+                data?: unknown;
+            } & {
+                start: number;
+                end: number;
+                type: "em" | "embed" | "label" | "strong" | "image" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "paragraph" | "preformatted" | "hyperlink" | "rtl" | "list-item" | "o-list-item";
+            })[] | undefined;
+        };
+    } & {
+        label?: string | undefined;
+        direction?: string | undefined;
+    }) => ProsemirrorNode | undefined;
 };
-export {};

package/dist/fields/RichTextField/useEditor.d.ts

@@ -0,0 +1,4 @@
+import type { EditorOptions } from "@tiptap/core";
+import { Editor } from "@tiptap/react";
+import { DependencyList } from "react";
+export declare function useEditor(options?: Partial<EditorOptions>, deps?: DependencyList): Editor | undefined;

package/dist/fields/utils.d.ts

@@ -1,7 +1,8 @@
-import type { BooleanField, NestableWidget, Separator, UID } from "@prismicio/types-internal/lib/customtypes";
+import type { BooleanField, GeoPoint, NestableWidget, Separator, UID } from "@prismicio/types-internal/lib/customtypes";
 declare type Widgets = NestableWidget | UID;
-declare type Field = Exclude<Widgets, Separator>;
+declare type Field = Exclude<Widgets, Separator | GeoPoint>;
 export declare function getFieldLabel(field: Widgets): string;
+export declare const DEFAULT_PLACEHOLDER = "...";
 export declare function getFieldPlaceholder(field: Exclude<Field, BooleanField>): string;
 export declare function getFieldPlaceholder(field: BooleanField, value: boolean): string;
 export {};

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { DocumentEditor } from "./DocumentEditor";
-export type { EditorConfig } from "./EditorConfig";
+export { type EditorConfig, suppressConfigErrors, throwConfigError } from "./EditorConfig";
 export type { Selection } from "./Selection";
 export { SharedSliceEditor } from "./slices/SharedSliceEditor";