@prismicio/editor-fields 0.4.10 → 0.4.14

package/dist/fields/LinkField/useLinkField.d.ts

@@ -1,8 +1,9 @@
 import type { ErrorBoundary } from "@prismicio/editor-ui";
 import type { LinkContent } from "@prismicio/types-internal/lib/content";
 import type { Link } from "@prismicio/types-internal/lib/customtypes";
-import { TypeOf } from "zod";
-import { Env } from "../../EditorConfig";
+import { type TypeOf } from "zod";
+import { type Env } from "../../EditorConfig";
+import { type MediaAssetOrExternalImage } from "../ImageField/MediaPicker/MediaLibrary/mediaLibraryData";
 import type { FieldSelectTypes } from "./LinkFieldActions";
 interface useLinkFieldParams {
     field: Link;
@@ -12,7 +13,6 @@ interface useLinkFieldParams {
 export declare function useLinkField(params: useLinkFieldParams): {
     contentType: "ImageLink" | "FileLink" | "DocumentLink" | "ExternalLink" | undefined;
     selectType: "media" | "web" | "document" | undefined;
-    isUnsupportedField: boolean | undefined;
     fieldValue: string;
     onValueChange: (value: string) => void;
     onTypeChange: (newValue: FieldSelectTypes) => void;
@@ -23,6 +23,7 @@ export declare function useLinkField(params: useLinkFieldParams): {
     errorBoundaryRef: import("react").RefObject<ErrorBoundary>;
     isTargetNewTab: boolean;
     updateWebLinkTarget: (newTab: boolean) => void;
+    onMediaSelected: (media: MediaAssetOrExternalImage) => void;
 };
 export declare function useDocumentTitle(id: string): string;
 declare const documentMeta: import("zod").ZodObject<{
@@ -35,6 +36,49 @@ declare const documentMeta: import("zod").ZodObject<{
     id: string;
     title: string;
 }>;
-export declare type DocumentMeta = TypeOf<typeof documentMeta>;
+export type DocumentMeta = TypeOf<typeof documentMeta>;
 export declare function getDocumentTitleRequest(baseUrl: string, env: Env, id: string): Promise<DocumentMeta>;
+interface MapMediaToLinkContentArgs {
+    media: MediaAssetOrExternalImage;
+}
+export declare function mapMediaToLinkContent(args: MapMediaToLinkContentArgs): {
+    __TYPE__: "LinkContent";
+    value: {
+        __TYPE__: "FileLink";
+        id: string;
+        name: string;
+        kind: string;
+        url: string;
+        size: string;
+        date: string;
+        height?: undefined;
+        width?: undefined;
+    };
+} | {
+    __TYPE__: "LinkContent";
+    value: {
+        __TYPE__: "ImageLink";
+        id: string;
+        name: string;
+        url: string;
+        kind: string;
+        size: string;
+        height: string;
+        width: string;
+        date: string;
+    };
+} | {
+    __TYPE__: "LinkContent";
+    value: {
+        __TYPE__: "ImageLink";
+        id: string;
+        name: string;
+        kind: string;
+        url: string;
+        size: string;
+        height: string;
+        width: string;
+        date?: undefined;
+    };
+};
 export {};

package/dist/fields/NumberField.d.ts

@@ -1,7 +1,7 @@
 import type { NumberContent } from "@prismicio/types-internal/lib/content";
 import type { Number as NumberT } from "@prismicio/types-internal/lib/customtypes";
 import type { FC } from "react";
-declare type NumberFieldProps = Readonly<{
+type NumberFieldProps = Readonly<{
     content: NumberContent | undefined;
     field: NumberT;
     id: string;

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

@@ -3,5 +3,6 @@ interface BubbleMenuProps {
     editor: Editor;
     nodeTypes: string[];
 }
+export type Modal = "webLink" | "documentLink" | "mediaLink" | undefined;
 export declare function BubbleMenu(props: BubbleMenuProps): JSX.Element;
 export {};

package/dist/fields/RichTextField/BubbleMenu/Link/DocumentDescriptionCard.d.ts

@@ -0,0 +1,7 @@
+interface DocumentDescriptionCardProps {
+    docId: string;
+    onEdit: () => void;
+    onUnlink: () => void;
+}
+export declare function DocumentDescriptionCard(props: DocumentDescriptionCardProps): JSX.Element | null;
+export {};

package/dist/fields/RichTextField/BubbleMenu/Link/LinkItems.d.ts

@@ -1,8 +1,9 @@
 import type { Editor } from "@tiptap/core";
 import type { MutableRefObject } from "react";
+import type { Modal } from "../BubbleMenu";
 interface LinkItemsProps {
     editor: Editor;
-    setDisplayLinkModal: (open: boolean) => void;
+    setModal: (modal: Modal) => void;
     bubbleMenuContainerRef?: MutableRefObject<null>;
 }
 export declare function LinkItems(props: LinkItemsProps): JSX.Element;

package/dist/fields/RichTextField/BubbleMenu/Link/LinkPopover.d.ts

@@ -1,7 +1,15 @@
 import type { Editor } from "@tiptap/core";
 interface LinkPopoverProps {
     editor: Editor;
-    onEdit: () => void;
+    onEditWebLink: () => void;
+    onEditDocumentLink: () => void;
+    onEditMediaLink: () => void;
 }
-export declare function LinkPopover(props: LinkPopoverProps): JSX.Element;
+export declare function LinkPopover(props: LinkPopoverProps): JSX.Element | null;
+interface DocumentLinkPopoverProps {
+    editor: Editor;
+    onEditDocumentLink: () => void;
+    docId: string;
+}
+export declare function DocumentLinkPopover(props: DocumentLinkPopoverProps): JSX.Element;
 export {};

package/dist/fields/RichTextField/BubbleMenu/Link/SetDocumentLinkModal.d.ts

@@ -0,0 +1,8 @@
+import type { Editor } from "@tiptap/core";
+interface SetDocumentLinkModalProps {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    editor: Editor;
+}
+export declare function SetDocumentLinkModal(props: SetDocumentLinkModalProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/BubbleMenu/Link/SetMediaLinkModal.d.ts

@@ -0,0 +1,8 @@
+import type { Editor } from "@tiptap/core";
+interface SetMediaLinkModalProps {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    editor: Editor;
+}
+export declare function SetMediaLinkModal(props: SetMediaLinkModalProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/BubbleMenu/Link/{SetLinkModal.d.ts → SetWebLinkModal.d.ts}

@@ -1,8 +1,8 @@
 import type { Editor } from "@tiptap/core";
-interface SetLinkModalProps {
+interface SetWebLinkModalProps {
     open: boolean;
     setOpen: (open: boolean) => void;
     editor: Editor;
 }
-export declare function SetLinkModal(props: SetLinkModalProps): JSX.Element;
+export declare function SetWebLinkModal(props: SetWebLinkModalProps): JSX.Element;
 export {};

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

@@ -1,4 +1,3 @@
-import type { ReadonlyNonEmptyArray } from "fp-ts/ReadonlyNonEmptyArray";
 import type { Node as ProsemirrorNode, Schema } from "prosemirror-model";
 declare const _default: {
     component: import("@tiptap/core").Node<import("@tiptap/extension-list-item").ListItemOptions, any>;
@@ -9,11 +8,57 @@ declare const _default: {
                 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;
             };
         } & {
@@ -26,11 +71,57 @@ declare const _default: {
                 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: "hyperlink";
+                } | {
+                    data: string;
+                    start: number;
+                    end: number;
+                    type: "label";
+                } | {
                     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" | "strong" | "list-item";
                 })[] | undefined;
             };
         } & {
@@ -41,4 +132,4 @@ declare const _default: {
     placeholder: string;
 };
 export default _default;
-export declare function mergeLists(lists: ReadonlyNonEmptyArray<ProsemirrorNode>): ProsemirrorNode | undefined;
+export declare function mergeLists(previousNode: ProsemirrorNode, newNode: ProsemirrorNode): ProsemirrorNode | undefined;

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

@@ -1,4 +1,4 @@
-import { type ExtensionPlaceholder, NodeExtension } from "../models";
+import { type ExtensionPlaceholder, type NodeExtension } from "../models";
 interface PlaceholderParams {
     placeholderByNodeType: Record<string, ExtensionPlaceholder>;
     unfocusedPlaceholder: string | undefined;

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

@@ -1,9 +1,10 @@
 import { type RichText } from "@prismicio/types-internal/lib/customtypes";
-import type { Node } from "@tiptap/core";
 import { type NodeExtension } from "../models";
 import { default as Document } from "./Document";
 import { default as HardBreak } from "./HardBreak";
 import { default as ListItem } from "./ListItem";
 import { default as Text } from "./Text";
-export declare function CoreComponents(field: RichText, nodeExtensions: readonly NodeExtension[]): readonly Node[];
+export declare function CoreComponents(field: RichText, nodeExtensions: NodeExtension[]): NonNullable<import("@tiptap/core").Node<any, any> | import("@tiptap/core").Extension<import("@tiptap/extension-placeholder").PlaceholderOptions, any> | import("@tiptap/core").Extension<Readonly<{
+    nodeTypes: readonly string[];
+}>, any> | undefined>[];
 export { Document, HardBreak, ListItem, Text };

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

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

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

@@ -0,0 +1,23 @@
+import type { Mark } from "@tiptap/core";
+import type { Mark as ProsemirrorMark, Schema } from "prosemirror-model";
+import { ExtensionType } from "../../models";
+export declare class BoldExtension {
+    readonly name: string;
+    readonly component: Mark;
+    readonly converter: {
+        fromPrismic(schema: Schema): (elmt: BoldElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): undefined;
+    };
+    extType: ExtensionType.Mark;
+    richTextNodeTypes: "strong";
+    constructor(name: string, component: Mark, converter: {
+        fromPrismic(schema: Schema): (elmt: BoldElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): undefined;
+    });
+}
+interface BoldElement {
+    type: "strong" | "em" | "list-item";
+    start: number;
+    end: number;
+}
+export {};

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

@@ -1,6 +1,6 @@
 import type { EmbedContent } from "@prismicio/types-internal/lib/content";
 import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
-import { NodeViewProps } from "@tiptap/react";
+import { type NodeViewProps } from "@tiptap/react";
 interface EmbedNode extends ProseMirrorNode {
     attrs: {
         content: EmbedContent | undefined;

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

@@ -1,12 +1,31 @@
 import type { EmbedContent } from "@prismicio/types-internal/lib/content";
-import { KeyboardEvent, RefObject } from "react";
+import { type KeyboardEvent, type 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;
+    urlChanged: (newUrl: string) => void;
     onContentChange: (content?: EmbedContent) => void;
     debouncedUrl: string;
+    content: ({
+        embed_url: string;
+        type: string;
+    } & {
+        version?: string | number | null | undefined;
+        title?: string | null | undefined;
+        author_name?: string | null | undefined;
+        author_url?: string | null | undefined;
+        provider_name?: string | null | undefined;
+        provider_url?: string | null | undefined;
+        cache_age?: string | number | null | undefined;
+        thumbnail_url?: string | null | undefined;
+        thumbnail_width?: number | null | undefined;
+        thumbnail_height?: number | null | undefined;
+        html?: string | null | undefined;
+    } & {
+        __TYPE__: "EmbedContent";
+        all: unknown;
+    }) | undefined;
 };

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

@@ -1,9 +1,8 @@
 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;
+export type Level = TTLevel;
 interface HeadingName {
     fullName: RichTextNodeType;
     level: Level;
@@ -11,8 +10,8 @@ interface HeadingName {
 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;
+    fromPrismic(headingName: string, levels?: Level[]): HeadingName | undefined;
+    fromProsemirror(nodeAttributes: ProsemirrorNode["attrs"], levels: Level[]): HeadingName | undefined;
 };
 declare const _default: {
     name: string;

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

@@ -1,6 +1,6 @@
 import type { ImageContent } from "@prismicio/types-internal/lib/content";
 import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
-import { NodeViewProps } from "@tiptap/react";
+import { type NodeViewProps } from "@tiptap/react";
 interface ImageNode extends ProseMirrorNode {
     attrs: {
         content: ImageContent | undefined;

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

@@ -1,6 +1,6 @@
 import type { ImageContent } from "@prismicio/types-internal/lib/content";
 import type { CroppedImages } from "../../../ImageField/CropperDialog";
-import { ExternalImage } from "../../../ImageField/MediaPicker/externalImage";
+import type { MediaAssetOrExternalImage } from "../../../ImageField/MediaPicker/MediaLibrary/mediaLibraryData";
 import type { ImageViewProps } from "./ImageView";
 interface useImageViewProps {
     content: ImageContent | undefined;
@@ -12,7 +12,7 @@ interface useImageViewProps {
     imageViewProps: ImageViewProps;
 }
 export declare function useImageView(props: useImageViewProps): {
-    onMediaSelected: (media: ExternalImage) => void;
+    onMediaSelected: (media: MediaAssetOrExternalImage) => void;
     onCropperDialogClose: ({ croppedImages }: {
         croppedImages: CroppedImages;
     }) => void;

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

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

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

@@ -0,0 +1,23 @@
+import type { Mark } from "@tiptap/core";
+import type { Mark as ProsemirrorMark, Schema } from "prosemirror-model";
+import { ExtensionType } from "../../models";
+export declare class ItalicExtension {
+    readonly name: string;
+    readonly component: Mark;
+    readonly converter: {
+        fromPrismic(schema: Schema): (elmt: ItalicElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): undefined;
+    };
+    extType: ExtensionType.Mark;
+    richTextNodeTypes: "em";
+    constructor(name: string, component: Mark, converter: {
+        fromPrismic(schema: Schema): (elmt: ItalicElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): undefined;
+    });
+}
+interface ItalicElement {
+    type: "strong" | "em" | "list-item";
+    start: number;
+    end: number;
+}
+export {};

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

@@ -0,0 +1,35 @@
+import type { MediaAssetOrExternalImage } from "../../../ImageField/MediaPicker/MediaLibrary/mediaLibraryData";
+import { type FileLinkData, type ImageLinkData, type LinkElementData, LinkExtension } from "./LinkModel";
+export interface LinkProtocolOptions {
+    scheme: string;
+    optionalSlashes?: boolean;
+}
+export interface LinkOptions {
+    autolink: boolean;
+    protocols: (LinkProtocolOptions | string)[];
+    openOnClick: boolean;
+    linkOnPaste: boolean;
+    /** These are the values passed into the HTML through the Tiptap extension. */
+    htmlAttributes: Record<string, any>;
+    validate?: (url: string) => boolean;
+}
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        Link: {
+            setWebLink: (attributes: {
+                href: string;
+                target?: string | null;
+            }) => ReturnType;
+            setDocumentLink: (attributes: {
+                id: string;
+            }) => ReturnType;
+            setMediaLink: (attributes: {
+                media: MediaAssetOrExternalImage;
+            }) => ReturnType;
+            unsetLink: () => ReturnType;
+        };
+    }
+}
+export declare const Link: LinkExtension;
+export declare function stringifyMediaLinkData(media: ImageLinkData | FileLinkData): string;
+export declare function parseMediaLinkData(media: string): LinkElementData;

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

@@ -0,0 +1,58 @@
+import type { Mark } from "@tiptap/core";
+import type { Mark as ProsemirrorMark, Schema } from "prosemirror-model";
+import { ExtensionType } from "../../models";
+export declare class LinkExtension {
+    readonly name: string;
+    readonly component: Mark;
+    readonly converter: {
+        fromPrismic(schema: Schema): (elmt: LinkElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): LinkElementData;
+    };
+    extType: ExtensionType.Mark;
+    richTextNodeTypes: "hyperlink";
+    constructor(name: string, component: Mark, converter: {
+        fromPrismic(schema: Schema): (elmt: LinkElement) => ProsemirrorMark | undefined;
+        toPrismic(elmt: ProsemirrorMark): LinkElementData;
+    });
+}
+export interface LinkElement {
+    type: "hyperlink";
+    start: number;
+    end: number;
+    data: LinkElementData;
+}
+export type LinkElementData = ImageLinkData | FileLinkData | DocumentLinkData | ExternalLinkData;
+export interface ImageLinkData {
+    __TYPE__: "ImageLink";
+    id: string;
+    url: string;
+    height: string;
+    width: string;
+    size: string;
+    name: string;
+    kind: string;
+    date?: string | null | undefined;
+}
+export interface FileLinkData {
+    __TYPE__: "FileLink";
+    id: string;
+    url: string;
+    name: string;
+    kind: string;
+    size: string;
+    date?: string | null | undefined;
+}
+interface DocumentLinkData {
+    __TYPE__: "DocumentLink";
+    id: string;
+}
+interface ExternalLinkData {
+    __TYPE__: "ExternalLink";
+    url: string;
+    kind?: "web";
+    target?: string | null | undefined;
+    preview?: {
+        title?: string;
+    } | null | undefined;
+}
+export {};

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

@@ -7,10 +7,10 @@ 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 { Link } from "./Link/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 const MarkExtensions: (import("./Bold/BoldModel").BoldExtension | import("./Italic/ItalicModel").ItalicExtension | import("./Link/LinkModel").LinkExtension)[];
 export declare function getAllExtensions(nodeTypes?: Set<RichTextNodeType>): WidgetExtension[];
 export { Bold, BulletList, CodeBlock, Embed, Heading, Image, Italic, Link, OrderedList, Paragraph };