@prismicio/editor-fields 0.4.10 → 0.4.14

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

@@ -1,10 +1,11 @@
 import type { EmbedBlock, ImageBlock, RichTextContent, TextBlock } from "@prismicio/types-internal/lib/content";
 import type { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
-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 { Node } from "@tiptap/core";
+import type { Node as ProsemirrorNode, Schema } from "prosemirror-model";
+import type { BoldExtension } from "../extensions/Bold/BoldModel";
 import type { Level } from "../extensions/Heading/Heading";
+import type { ItalicExtension } from "../extensions/Italic/ItalicModel";
+import type { LinkExtension } from "../extensions/Link/LinkModel";
 export declare enum ExtensionType {
     Document = "document",
     Mark = "mark",
@@ -15,9 +16,9 @@ export declare enum NodeType {
     Embed = "embed",
     Image = "image"
 }
-export declare type Extension = WidgetExtension | DocumentExtension;
-export declare type WidgetExtension = MarkExtension<unknown> | NodeExtension;
-export declare type ExtensionPlaceholder = string | ((nodeAttrs: ProsemirrorNode["attrs"]) => string | undefined) | undefined;
+export type Extension = WidgetExtension | DocumentExtension;
+export type WidgetExtension = MarkExtension | NodeExtension;
+export type ExtensionPlaceholder = string | ((nodeAttrs: ProsemirrorNode["attrs"]) => string | undefined) | undefined;
 export declare class DocumentExtension {
     readonly name: string;
     readonly component: (multiLines: boolean) => Node;
@@ -31,23 +32,10 @@ export declare class DocumentExtension {
         toPrismic(elmt: ProsemirrorNode): RichTextContent | undefined;
     });
 }
-export declare class MarkExtension<P> {
-    readonly richTextNodeTypes: NonEmptyArray<RichTextNodeType>;
-    readonly name: string;
-    readonly component: Mark;
-    readonly converter: {
-        fromPrismic(schema: Schema): (elmt: P) => ProsemirrorMark | undefined;
-        toPrismic(elmt: ProsemirrorMark): P | undefined;
-    };
-    extType: ExtensionType.Mark;
-    constructor(richTextNodeTypes: NonEmptyArray<RichTextNodeType>, name: string, component: Mark, converter: {
-        fromPrismic(schema: Schema): (elmt: P) => ProsemirrorMark | undefined;
-        toPrismic(elmt: ProsemirrorMark): P | undefined;
-    });
-}
-export declare type NodeExtension = TextExtension | EmbedExtension | ImageExtension;
+export type MarkExtension = LinkExtension | BoldExtension | ItalicExtension;
+export type NodeExtension = TextExtension | EmbedExtension | ImageExtension;
 export declare class TextExtension {
-    readonly richTextNodeTypes: ReadonlyNonEmptyArray<RichTextNodeType>;
+    readonly richTextNodeTypes: RichTextNodeType[];
     readonly name: string;
     readonly component: Node;
     readonly converter: {
@@ -58,14 +46,14 @@ export declare class TextExtension {
     readonly lockedFormat: boolean;
     extType: ExtensionType.Node;
     nodeType: NodeType.Text;
-    constructor(richTextNodeTypes: ReadonlyNonEmptyArray<RichTextNodeType>, name: string, component: Node, converter: {
+    constructor(richTextNodeTypes: RichTextNodeType[], name: string, component: Node, converter: {
         fromPrismic(schema: Schema): (elmt: TextBlock) => ProsemirrorNode | undefined;
         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 richTextNodeTypes: RichTextNodeType[];
     readonly name: string;
     readonly component: Node;
     readonly converter: {
@@ -74,13 +62,13 @@ export declare class EmbedExtension {
     };
     extType: ExtensionType;
     nodeType: NodeType.Embed;
-    constructor(richTextNodeTypes: NonEmptyArray<RichTextNodeType>, name: string, component: Node, converter: {
+    constructor(richTextNodeTypes: RichTextNodeType[], name: string, component: Node, converter: {
         fromPrismic(schema: Schema): (elmt: EmbedBlock) => ProsemirrorNode | undefined;
         toPrismic(elmt: ProsemirrorNode): EmbedBlock | undefined;
     });
 }
 export declare class ImageExtension {
-    readonly richTextNodeTypes: NonEmptyArray<RichTextNodeType>;
+    readonly richTextNodeTypes: RichTextNodeType[];
     readonly name: string;
     readonly component: Node;
     readonly converter: {
@@ -89,20 +77,20 @@ export declare class ImageExtension {
     };
     extType: ExtensionType.Node;
     nodeType: NodeType.Image;
-    constructor(richTextNodeTypes: NonEmptyArray<RichTextNodeType>, name: string, component: Node, converter: {
+    constructor(richTextNodeTypes: RichTextNodeType[], name: string, component: Node, converter: {
         fromPrismic(schema: Schema): (elmt: ImageBlock) => ProsemirrorNode | undefined;
         toPrismic(elmt: ProsemirrorNode): ImageBlock | undefined;
     });
 }
 export declare class HeadingTextExtension extends TextExtension {
     readonly levels: readonly Level[];
-    constructor(richTextNodeTypes: ReadonlyNonEmptyArray<RichTextNodeType>, Component: Node, levels: readonly Level[], Converter: {
+    constructor(richTextNodeTypes: RichTextNodeType[], Component: Node, levels: readonly Level[], Converter: {
         fromPrismic(schema: Schema): (elmt: TextBlock) => ProsemirrorNode | undefined;
         toPrismic(elmt: ProsemirrorNode): TextBlock | undefined;
     }, placeholder?: ExtensionPlaceholder);
 }
 export declare class ListExtension extends TextExtension {
-    constructor(richTextNodeTypes: NonEmptyArray<RichTextNodeType>, name: string, Component: Node, Converter: {
+    constructor(richTextNodeTypes: RichTextNodeType[], name: string, Component: Node, Converter: {
         fromPrismic(schema: Schema): (elmt: TextBlock) => ProsemirrorNode | undefined;
         toPrismic(elmt: ProsemirrorNode): readonly TextBlock[];
     });

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

@@ -1,7 +1,7 @@
 import type { IconName } from "@prismicio/editor-ui";
 import { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
 import type { ChainedCommands, Editor, Range } from "@tiptap/core";
-export declare type MenuItem = Readonly<{
+export type MenuItem = Readonly<{
     nodeType: RichTextNodeType;
     icon: IconName;
     isActive: (editor: Editor) => boolean;
@@ -13,7 +13,7 @@ export declare type MenuItem = Readonly<{
     shortText?: undefined;
     text?: undefined;
 })>;
-declare type RunCommandsOptions = Readonly<{
+type RunCommandsOptions = Readonly<{
     can?: boolean;
     deleteRange?: Range;
 }>;

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

@@ -12,11 +12,57 @@ export declare function composeExtensions(config?: RichTextConfig): {
             text: string;
         } & {
             spans?: ({
-                data?: unknown;
-            } & {
+                data: ({
+                    __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;
+                });
                 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: "hyperlink";
+            } | {
+                data: string;
+                start: number;
+                end: number;
+                type: "label";
+            } | {
+                start: number;
+                end: number;
+                type: "em" | "strong" | "list-item";
             })[] | undefined;
         };
     } & {

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

@@ -1,11 +1,95 @@
 import type { Span } from "@prismicio/types-internal/lib/content";
 export declare const SpanUtils: {
-    groupBy<K extends unknown>(spans: readonly Span[], f: (span: Span) => K): Map<K, readonly ({
-        data?: unknown;
-    } & {
+    groupBy<K extends number | "label" | "em" | "strong" | "list-item" | "hyperlink">(spans: readonly Span[], f: (span: Span) => K): Map<K, readonly ({
+        data: ({
+            __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;
+        }) | ({
+            __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;
+        });
         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: "hyperlink";
+    } | {
+        data: string;
+        start: number;
+        end: number;
+        type: "label";
+    } | {
+        start: number;
+        end: number;
+        type: "em" | "strong" | "list-item";
     })[]>;
     sort(spans: readonly Span[]): readonly Span[];
     mergeOverlap(spans: readonly Span[]): readonly Span[];

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

@@ -1,4 +1,9 @@
 import type { EditorOptions } from "@tiptap/core";
 import { Editor } from "@tiptap/react";
-import { DependencyList } from "react";
+import { type DependencyList } from "react";
 export declare function useEditor(options?: Partial<EditorOptions>, deps?: DependencyList): Editor | undefined;
+/**
+ * setTimeout is required to combat tiptap flushsync issue
+ * https://github.com/ueberdosis/tiptap/issues/3764
+ */
+export declare function handleEditorFlushSyncError(callback: VoidFunction): number;

package/dist/fields/UIDField/UIDField.d.ts

@@ -1,10 +1,10 @@
 import type { UIDContent } from "@prismicio/types-internal/lib/content";
 import type { UID as UIDType } from "@prismicio/types-internal/lib/customtypes";
-declare type Props = Readonly<{
+interface UIDFieldProps {
     id: string;
     content?: UIDContent;
     field: UIDType;
     onContentChange: (content?: UIDContent) => void;
-}>;
-export declare const UIDField: ({ id, field, content, onContentChange }: Props) => JSX.Element;
+}
+export declare function UIDField(props: UIDFieldProps): JSX.Element;
 export {};

package/dist/fields/utils.d.ts

@@ -1,6 +1,6 @@
 import type { BooleanField, GeoPoint, NestableWidget, Separator, UID } from "@prismicio/types-internal/lib/customtypes";
-declare type Widgets = NestableWidget | UID;
-declare type Field = Exclude<Widgets, Separator | GeoPoint>;
+type Widgets = NestableWidget | UID;
+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;

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export { DocumentEditor } from "./DocumentEditor";
 export { type EditorConfig, suppressConfigErrors, throwConfigError } from "./EditorConfig";
-export type { Selection } from "./Selection";
+export { getSelectionDOMId, type Selection, type SelectionArea, SelectionContext, useSelection } from "./Selection";
+export { defaultImageContentWidget } from "./slices/defaults";
 export { SharedSliceEditor } from "./slices/SharedSliceEditor";
+export { UIDContext } from "./UID";