@prismicio/editor-fields 0.4.5 → 0.4.7

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.d.ts → OrderedList/OrderedList.d.ts}

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

package/dist/fields/RichTextField/extensions/{Paragraph.d.ts → Paragraph/Paragraph.d.ts}

@@ -1,3 +1,3 @@
-import { TextExtension } from "../models";
+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/EmbedExtension";
-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" | "paragraph" | "list-item" | "o-list-item" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "rtl";
+        content: {
+            text: string;
+        } & {
+            spans?: ({
+                data?: unknown;
+            } & {
+                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";
+            })[] | 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/SelectField.d.ts

@@ -1,12 +1,11 @@
 import type { SelectContent } from "@prismicio/types-internal/lib/content";
 import type { Select as SelectT } from "@prismicio/types-internal/lib/customtypes";
-import type { FC } from "react";
-declare type SelectFieldProps = Readonly<{
+interface Props {
     content: SelectContent | undefined;
     field: SelectT;
     id: string;
     onContentChange: (content: SelectContent | undefined) => void;
     readOnly: boolean;
-}>;
-export declare const SelectField: FC<SelectFieldProps>;
+}
+export declare function SelectField(props: Props): JSX.Element;
 export {};

package/dist/fields/TimestampField.d.ts

@@ -1,11 +1,11 @@
 import type { TimestampContent } from "@prismicio/types-internal/lib/content";
 import type { Timestamp } from "@prismicio/types-internal/lib/customtypes";
-declare type Props = Readonly<{
+interface Props {
     id: string;
     readOnly: boolean;
     field: Timestamp;
     content?: TimestampContent;
     onContentChange: (content?: TimestampContent) => void;
-}>;
-export declare const TimestampField: ({ id, readOnly, field, content, onContentChange }: Props) => JSX.Element;
+}
+export declare function TimestampField(props: Props): JSX.Element;
 export {};

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";