@prismicio/editor-fields 0.4.30 → 0.4.31

package/dist/EditorConfig.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
 import type { MediaAssetType } from "./core/MediaLibrary/hooks/mediaLibraryData";
 export type EditorConfig = {
+    baseUrl: URL;
     embedApiEndpoint: URL;
     unsplashApiBaseUrl: URL;
     authStrategy: AuthStrategy;
-    baseUrl: URL;
 } & OptionalConfigs;
-type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields;
+type OptionalConfigs = SearchDocuments & MediaLibrary & UIDField & Analytics & ErrorTracking & IntegrationFields & LayoutConfig;
 type MediaLibrary = {
     mediaLibrary?: never;
 } | {
@@ -43,6 +43,12 @@ type IntegrationFields = {
     integrationFieldsApiBaseUrl: URL;
     repository: string;
 };
+interface LayoutConfig {
+    /**
+     * Teaches fields about their containing scrolling element.
+     */
+    scrollOffsetTop?: number;
+}
 interface OnAnalyticsEvent {
     (event: "Media Library Search", args: {
         useOpenSearch: "1" | "0";

package/dist/core/MediaLibrary/components/MediaLibraryContext.d.ts

@@ -18,10 +18,6 @@ interface MediaLibraryContextValue {
     onFilesUpload: (files: File[]) => void;
     isUploading: boolean;
     uploadingFiles: UploadFile[];
-    selectedMediaIds: Set<string>;
-    addMediaItemSelection: (id: string) => void;
-    removeMediaItemSelection: (id: string) => void;
-    replaceMediaItemSelection: (id: string) => void;
     isMediaCacheInvalid: boolean;
     isMediaRevalidationInProgress: boolean;
     revalidateMedia: () => void;

package/dist/core/SelectionManager/SelectionManager.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { SelectionManagerProviderProps, SelectionStateListener, UseSelectionManager } from "./SelectionManagerTypes";
+export declare function SelectionManagerProvider(props: SelectionManagerProviderProps): JSX.Element;
+interface useSelectionManagerArgs {
+    totalItemCount?: number;
+    onChangeSelection?: SelectionStateListener;
+}
+export declare function useSelectionManager(args?: useSelectionManagerArgs): UseSelectionManager;
+export {};

package/dist/core/SelectionManager/SelectionManagerTypes.d.ts

@@ -0,0 +1,93 @@
+import type { PropsWithChildren } from "react";
+export type ID = string;
+export interface ToggleSelectionArgs {
+    /**
+     * The ID of the item to toggle selection for.
+     */
+    id: ID;
+    /**
+     * Indicates if the selection is a single selection.
+     * @default false
+     */
+    isSingleSelection?: boolean;
+    /**
+     * Indicates if the meta key (e.g., Command on Mac, Ctrl on Windows) was pressed.
+     * When `true`, single selection gets ignored if enabled.
+     * @default false
+     */
+    metaKey?: boolean;
+    /**
+     * Indicates if the shift key was pressed.
+     * When `true`, and `ids` are defined - range selection gets enabled.
+     * @default false
+     */
+    shiftKey?: boolean;
+    /**
+     * A sorted array of the item IDs. This is required with range selection.
+     */
+    ids?: ID[];
+}
+export type SelectionManager = {
+    /**
+     * Checks if an item is selected.
+     * @param id - The ID of the item to check.
+     * @returns `true` if the item is selected, otherwise `false`.
+     */
+    isSelected: (id: ID) => boolean;
+    /**
+     * Toggles the selection state of an item.
+     * @param args - Arguments for toggling selection.
+     * @returns `true` if the item state is selected, otherwise `false`.
+     */
+    toggleSelection: (args: ToggleSelectionArgs) => boolean;
+    /**
+     * Toggles the select all state.
+     */
+    toggleSelectAll: () => void;
+    /**
+     * Clears all the selection.
+     */
+    clearSelection: () => void;
+    /**
+     * Sets the total count of items available for the selectable entity.
+     * @param count - The total item count.
+     */
+    setTotalItemCount: (count: number) => void;
+    /**
+     * Gets the current selection state. This is used when performing any action with the selection.
+     * @returns The selection state object.
+     */
+    getSelectionState: () => {
+        selectedIds: ID[];
+        excludedIds: ID[];
+        isAllSelected: boolean;
+        selectedCount: number;
+    };
+    /**
+     * Count of selected items.
+     */
+    selectedCount: number;
+    totalItemCount: number;
+    isSelectAllEnabled: boolean;
+    state: CoreSelectionState;
+};
+export interface CoreSelectionState {
+    /**
+     * Set of selected IDs.
+     */
+    selectedIds: Set<ID>;
+    /**
+     * Set of excluded IDs - only aplicable when `isAllSelected=true`
+     */
+    excludedIds: Set<ID>;
+    /**
+     * Indicates if all items are selected.
+     */
+    isAllSelected: boolean;
+}
+export interface SelectionManagerProviderProps extends PropsWithChildren {
+    initialTotalItemCount?: number;
+    isSelectAllEnabled?: boolean;
+}
+export type UseSelectionManager = Omit<SelectionManager, "registerListener" | "setTotalItemCount" | "totalItemCount" | "state"> & Pick<CoreSelectionState, "isAllSelected">;
+export type SelectionStateListener = (state: ReturnType<SelectionManager["getSelectionState"]>) => void;

package/dist/core/SelectionManager/index.d.ts

@@ -0,0 +1 @@
+export * from "./SelectionManager";

package/dist/core/imageUtils.d.ts

@@ -1,4 +1,4 @@
-import type { ImageContent, ImageContentView } from "@prismicio/types-internal/lib/content";
+import type { ImageBlock, ImageContent, ImageContentView } from "@prismicio/types-internal/lib/content";
 import type { Image, ImageConstraint } from "@prismicio/types-internal/lib/customtypes";
 import type { MediaAsset, MediaAssetOrExternalImage } from "./MediaLibrary/hooks/mediaLibraryData";
 /**
@@ -20,7 +20,7 @@ export interface CropperImage {
     labels: ImageLabel;
 }
 type ImageLabel = [thumbnailName: string | undefined, size: string | undefined];
-export declare function getImageLabel(thumbnail: Thumbnail, content: ImageContent | undefined, contentView: ImageContentView | undefined): ImageLabel;
+export declare function getImageLabel(thumbnail: Thumbnail, content: ImageContent | ImageBlockData | undefined, contentView: ImageContentView | undefined): ImageLabel;
 export declare function getImageThumbnails(field: Image): readonly Thumbnail[];
 export declare function getImageContentViews(field: Image, content: ImageContent): readonly [ImageContentView, ...(ImageContentView | undefined)[]];
 export declare function updateImageContentAlt(thumbnailName: string, content: ImageContent, contentView: ImageContentView, value: string): ImageContent;
@@ -54,4 +54,5 @@ export declare function fitImage(extImage: {
     };
 };
 export declare function getTitleWithoutExtension(selectedMedia?: MediaAsset): string;
+export type ImageBlockData = ImageBlock["data"];
 export {};

package/dist/fields/ImageField/Components/ImageAltControl.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 interface ImageAltControlProps {
     id?: string;
-    readOnly: boolean;
+    readOnly?: boolean;
     altText: string;
     onValueChange: (value: string) => void;
     selected?: boolean;

package/dist/fields/ImageField/Components/ImageFieldCard.d.ts

@@ -1,10 +1,9 @@
-import type { ImageContent } from "@prismicio/types-internal/lib/content";
 import { type ReactNode } from "react";
 import type { CropperImage } from "../../../core/imageUtils";
 import type { MediaAssetOrExternalImage } from "../../../core/MediaLibrary/hooks/mediaLibraryData";
 import { type CroppedImages } from "../CropperDialog";
 interface ImageFieldCardProps {
-    content: ImageContent | undefined;
+    url: string | undefined;
     selected?: boolean;
     fieldLabel: string;
     readOnly: boolean;

package/dist/fields/ImageField/CropperDialog/croppedImage.d.ts

@@ -1,5 +1,6 @@
 import type { ImageContent, ImageContentView } from "@prismicio/types-internal/lib/content";
 import type { Image } from "@prismicio/types-internal/lib/customtypes";
+import { type ImageBlockData } from "../../../core/imageUtils";
 export interface Point {
     x: number;
     y: number;
@@ -30,12 +31,67 @@ export interface CroppedImage {
     height: number;
 }
 interface UpdateImageArgs {
-    field?: Image;
+    field: Image;
     content: ImageContent;
     thumbnail: string;
     croppedImage: CroppedImage;
 }
-export declare function updateImage(args: UpdateImageArgs): ImageContent;
+export declare function updateImage(args: UpdateImageArgs): {
+    origin: {
+        id: string;
+        url: string;
+        width: number;
+        height: number;
+    };
+    width: number;
+    height: number;
+    edit: {
+        zoom: number;
+        crop: {
+            x: number;
+            y: number;
+        };
+        background: string;
+    };
+} & {
+    url?: string | undefined;
+    credits?: string | null | undefined;
+    alt?: string | null | undefined;
+    provider?: string | null | undefined;
+} & {
+    thumbnails?: {
+        [x: string]: {
+            origin: {
+                id: string;
+                url: string;
+                width: number;
+                height: number;
+            };
+            width: number;
+            height: number;
+            edit: {
+                zoom: number;
+                crop: {
+                    x: number;
+                    y: number;
+                };
+                background: string;
+            };
+        } & {
+            url?: string | undefined;
+            credits?: string | null | undefined;
+            alt?: string | null | undefined;
+            provider?: string | null | undefined;
+        };
+    } | undefined;
+} & {
+    __TYPE__: "ImageContent";
+};
+interface UpdateImageMainThumbnailArgs<T> {
+    content: T;
+    croppedImage: CroppedImage;
+}
+export declare function updateImageMainThumbnail<T extends ImageContent | ImageBlockData>(args: UpdateImageMainThumbnailArgs<T>): T;
 interface BuildCropUrlArgs {
     origin: ImageContent["origin"];
     /** Image crop parameters */

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

@@ -2,9 +2,9 @@
 import type { LinkContent } from "@prismicio/types-internal/lib/content";
 import type { Link } from "@prismicio/types-internal/lib/customtypes";
 interface LinkFieldProps {
-    id: string;
+    id?: string;
     field: Link;
-    readOnly: boolean;
+    readOnly?: boolean;
     content: LinkContent | undefined;
     onContentChange: (content: LinkContent | undefined) => void;
 }

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

@@ -2,6 +2,13 @@ import type { TextBlock } from "@prismicio/types-internal/lib/content";
 import type { RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
 import type { Node as ProsemirrorNode, Schema } from "prosemirror-model";
 import type { Direction } from "../globalExtensions/TextDirection";
+export declare const prismicToProsemirrorMark: {
+    strong: "bold";
+    label: "label";
+    em: "em";
+    hyperlink: "hyperlink";
+    "list-item": undefined;
+};
 declare const EditorText: {
     name: string;
     component: import("@tiptap/core").Node<any, any>;

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import type { ImageBlockData } from "../../../../core/imageUtils";
+type LinkTo = ImageBlockData["linkTo"];
+interface ImageLinkControlProps {
+    linkTo: LinkTo;
+    onLinkToChange: (linkTo: LinkTo) => void;
+}
+export declare function ImageLinkControl(props: ImageLinkControlProps): JSX.Element;
+export {};

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

@@ -1,10 +1,10 @@
 /// <reference types="react" />
-import type { ImageContent } from "@prismicio/types-internal/lib/content";
 import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
 import { type NodeViewProps } from "@tiptap/react";
+import { type ImageBlockData } from "../../../../core/imageUtils";
 interface ImageNode extends ProseMirrorNode {
     attrs: {
-        content: ImageContent | undefined;
+        content: ImageBlockData | undefined;
     };
 }
 export interface ImageViewProps extends NodeViewProps {

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

@@ -1,9 +1,9 @@
-import type { ImageContent } from "@prismicio/types-internal/lib/content";
+import { type ImageBlockData } from "../../../../core/imageUtils";
 import type { MediaAssetOrExternalImage } from "../../../../core/MediaLibrary/hooks/mediaLibraryData";
 import type { CroppedImages } from "../../../ImageField/CropperDialog";
 import type { ImageViewProps } from "./ImageView";
 interface useImageViewProps {
-    content: ImageContent | undefined;
+    content: ImageBlockData | undefined;
     thumbnail: {
         width: number | undefined;
         height: number | undefined;
@@ -17,7 +17,7 @@ export declare function useImageView(props: useImageViewProps): {
         croppedImages: CroppedImages;
     }) => void;
     isUpdating: boolean;
-    updateContent: (content?: ImageContent) => void;
+    updateContent: (content?: ImageBlockData) => void;
     onClear: () => void;
 };
 export {};

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

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

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

@@ -24,13 +24,13 @@ export declare class DocumentExtension {
     readonly name: string;
     readonly component: (multiLines: boolean) => Node;
     readonly converter: (extensions: NodeExtension[]) => {
-        fromPrismic(schema: Schema, defaultTextConverter?: (block: TextBlock) => ProsemirrorNode | undefined): (elmt: RichTextContent) => ProsemirrorNode | undefined;
-        toPrismic(elmt: ProsemirrorNode): RichTextContent | undefined;
+        fromPrismic(schema: Schema, nodeTypes: Set<RichTextNodeType>, content: RichTextContent): ProsemirrorNode | undefined;
+        toPrismic(node: ProsemirrorNode): RichTextContent | undefined;
     };
     extType: ExtensionType.Document;
     constructor(name: string, component: (multiLines: boolean) => Node, converter: (extensions: NodeExtension[]) => {
-        fromPrismic(schema: Schema, defaultTextConverter?: (block: TextBlock) => ProsemirrorNode | undefined): (elmt: RichTextContent) => ProsemirrorNode | undefined;
-        toPrismic(elmt: ProsemirrorNode): RichTextContent | undefined;
+        fromPrismic(schema: Schema, nodeTypes: Set<RichTextNodeType>, content: RichTextContent): ProsemirrorNode | undefined;
+        toPrismic(node: ProsemirrorNode): RichTextContent | undefined;
     });
 }
 export type MarkExtension = LinkExtension | BoldExtension | ItalicExtension | LabelExtension;

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

@@ -1,72 +1,8 @@
-import { RichTextConfig } from "@prismicio/types-internal/lib/customtypes";
-import type { Node as ProsemirrorNode, Schema } from "prosemirror-model";
+import { RichTextConfig, type RichTextNodeType } from "@prismicio/types-internal/lib/customtypes";
 import { type WidgetExtension } from "./EditorExtension";
-export declare function composeExtensions(config?: RichTextConfig): {
+export declare function composeExtensions(config?: RichTextConfig): Extensions;
+interface Extensions {
     extensions: WidgetExtension[];
-    defaultTextConverter: undefined;
-} | {
-    extensions: WidgetExtension[];
-    defaultTextConverter: (schema: Schema<any, any>) => (block: {
-        type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
-        content: {
-            text: string;
-        } & {
-            spans?: ({
-                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: "em" | "strong" | "list-item";
-            })[] | undefined;
-        };
-    } & {
-        label?: string | undefined;
-        direction?: string | undefined;
-    }) => ProsemirrorNode | undefined;
-};
+    nodeTypes: Set<RichTextNodeType>;
+}
+export {};