@prismicio/editor-fields 0.4.64 → 0.4.65

package/dist/core/service/user.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { type AuthStrategy } from "../../EditorConfig";
-declare const repositoryRole: z.ZodUnion<[z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>>>]>;
+declare const repositoryRole: z.ZodUnion<[z.ZodEnum<["SuperUser", "Owner", "Administrator", "Writer", "Manager", "Readonly"]>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodEnum<["SuperUser", "Owner", "Administrator", "Writer", "Manager", "Readonly"]>>>]>;
 export declare const roleMap: {
     readonly SuperUser: "SuperUser";
     readonly Owner: "Owner";
@@ -12,6 +12,7 @@ export declare const roleMap: {
 export type Role = (typeof roleMap)[keyof typeof roleMap];
 export type RepositoryRole = z.TypeOf<typeof repositoryRole>;
 export declare const profileResponse: z.ZodObject<{
+    userId: z.ZodString;
     shortId: z.ZodString;
     intercomHash: z.ZodString;
     email: z.ZodString;
@@ -21,18 +22,19 @@ export declare const profileResponse: z.ZodObject<{
     repositories: z.ZodArray<z.ZodObject<{
         domain: z.ZodString;
         name: z.ZodOptional<z.ZodString>;
-        role: z.ZodUnion<[z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodEnum<["Owner", "Administrator", "Writer", "Manager", "Readonly"]>>>]>;
+        role: z.ZodUnion<[z.ZodEnum<["SuperUser", "Owner", "Administrator", "Writer", "Manager", "Readonly"]>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodEnum<["SuperUser", "Owner", "Administrator", "Writer", "Manager", "Readonly"]>>>]>;
     }, "strip", z.ZodTypeAny, {
         domain: string;
-        role: "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | Record<string, "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | undefined>;
+        role: "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | Record<string, "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | undefined>;
         name?: string | undefined;
     }, {
         domain: string;
-        role: "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | Record<string, "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | undefined>;
+        role: "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | Record<string, "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | undefined>;
         name?: string | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     email: string;
+    userId: string;
     shortId: string;
     intercomHash: string;
     firstName: string;
@@ -40,11 +42,12 @@ export declare const profileResponse: z.ZodObject<{
     superPower: boolean;
     repositories: {
         domain: string;
-        role: "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | Record<string, "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | undefined>;
+        role: "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | Record<string, "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | undefined>;
         name?: string | undefined;
     }[];
 }, {
     email: string;
+    userId: string;
     shortId: string;
     intercomHash: string;
     firstName: string;
@@ -52,7 +55,7 @@ export declare const profileResponse: z.ZodObject<{
     superPower: boolean;
     repositories: {
         domain: string;
-        role: "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | Record<string, "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | undefined>;
+        role: "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | Record<string, "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | undefined>;
         name?: string | undefined;
     }[];
 }>;
@@ -60,6 +63,7 @@ export type Profile = z.infer<typeof profileResponse>;
 export declare function getProfile(userServiceBaseUrl: URL, authStrategy: AuthStrategy): Promise<Profile>;
 export declare function useProfile(): {
     email: string;
+    userId: string;
     shortId: string;
     intercomHash: string;
     firstName: string;
@@ -67,7 +71,7 @@ export declare function useProfile(): {
     superPower: boolean;
     repositories: {
         domain: string;
-        role: "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | Record<string, "Manager" | "Writer" | "Readonly" | "Owner" | "Administrator" | undefined>;
+        role: "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | Record<string, "SuperUser" | "Owner" | "Administrator" | "Manager" | "Writer" | "Readonly" | undefined>;
         name?: string | undefined;
     }[];
 };

package/dist/fields/ImageField/useImageField.d.ts

@@ -88,18 +88,18 @@ export declare function useImageField(props: useImageFieldProps): {
     }) | undefined;
     onClear: () => void;
     uploadImage: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<{
+        id: string;
+        url: string;
+        kind: string;
+        size: number;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
         width?: number | undefined;

package/dist/fields/ImageField/useImageFieldImageUpload.d.ts

@@ -4,18 +4,18 @@ interface UseImageFieldImageUploadArgs {
 }
 export declare function useImageFieldImageUpload(args: UseImageFieldImageUploadArgs): {
     uploadImage: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<{
+        id: string;
+        url: string;
+        kind: string;
+        size: number;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
         width?: number | undefined;

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

@@ -16,8 +16,8 @@ export declare function useDocuments(params: {
         } | {
             status: "archived";
         }) & {
-            tags: string[];
             version_id: string;
+            tags: string[];
             last_modified_date: Date;
             custom_type_label: string;
             author: {
@@ -40,8 +40,8 @@ export declare function useDocuments(params: {
         } | {
             status: "archived";
         }) & {
-            tags: string[];
             version_id: string;
+            tags: string[];
             last_modified_date: Date;
             preview_image?: string | undefined;
             uid?: string | undefined;
@@ -72,8 +72,8 @@ export declare function useDocuments(params: {
         } | {
             status: "archived";
         }) & {
-            tags: string[];
             version_id: string;
+            tags: string[];
             last_modified_date: Date;
             custom_type_label: string;
             author: {
@@ -96,8 +96,8 @@ export declare function useDocuments(params: {
         } | {
             status: "archived";
         }) & {
-            tags: string[];
             version_id: string;
+            tags: string[];
             last_modified_date: Date;
             preview_image?: string | undefined;
             uid?: string | undefined;

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

@@ -7,6 +7,13 @@ interface Props<TContent extends ExtendedRichTextContent> {
     field: RichText;
     readOnly: boolean;
     onContentChange: (content: TContent | undefined) => void;
+    padding?: "normal" | "zero";
+    scroll?: "hidden" | "x-auto";
+    /** Checks `editor.isEmpty` before calling `onContentChange`.
+     * - When `true`, the current structure of the document will be returned, even if it has no content.
+     * - When `false`, `undefined` will be returned.
+     * @default false */
+    shouldReturnEmptyContent?: boolean;
 }
 export declare function RichTextField<TContent extends ExtendedRichTextContent>(props: Props<TContent>): JSX.Element;
 export {};

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

@@ -20,18 +20,18 @@ export declare function useImageView(props: useImageViewProps): {
     updateContent: (content?: ImageBlockData) => void;
     onClear: () => void;
     uploadImage: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<{
+        id: string;
+        url: string;
+        kind: string;
+        size: number;
         tags: {
-            name: string;
             id: string;
+            name: string;
             created_at: number;
             last_modified: number;
             count: number;
             uploader_id?: string | undefined;
         }[];
-        id: string;
-        url: string;
-        kind: string;
-        size: number;
         last_modified: number;
         filename: string;
         width?: number | undefined;

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

@@ -5,15 +5,15 @@ declare module "@tiptap/core" {
             /**
              * Add a row at the end of the table
              * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addRowEnd()
+             * @example editor.commands.addRowToEnd()
              */
-            addRowEnd: () => ReturnType;
+            addRowToEnd: () => ReturnType;
             /**
              * Add a column at the end of the table
              * @returns True if the command was successful, otherwise false
-             * @example editor.commands.addColumnEnd()
+             * @example editor.commands.addColumnToEnd()
              */
-            addColumnEnd: () => ReturnType;
+            addColumnToEnd: () => ReturnType;
         };
     }
 }

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

@@ -0,0 +1,10 @@
+import { TableContent } from "@prismicio/types-internal/lib/content";
+import { Node as ProseMirrorNode, type Schema } from "@tiptap/pm/model";
+type TableRowBlock = TableContent["content"][number];
+type TableCellOrHeaderBlock = TableRowBlock["content"][number];
+export declare const TableCell: import("@tiptap/core").Node<import("@tiptap/extension-table-cell").TableCellOptions, any>;
+export declare const tableCellConverter: {
+    fromPrismic(schema: Schema): (cell: TableCellOrHeaderBlock) => ProseMirrorNode;
+    toPrismic(node: ProseMirrorNode): TableCellOrHeaderBlock;
+};
+export {};

package/dist/fields/RichTextField/extensions/Table/TableCell/TableHeaderCell.d.ts

@@ -0,0 +1,10 @@
+import { TableContent } from "@prismicio/types-internal/lib/content";
+import type { Node as ProseMirrorNode, Schema } from "@tiptap/pm/model";
+type TableRowBlock = TableContent["content"][number];
+type TableCellOrHeaderBlock = TableRowBlock["content"][number];
+export declare const TableHeader: import("@tiptap/core").Node<import("@tiptap/extension-table-header").TableHeaderOptions, any>;
+export declare const tableHeaderCellConverter: {
+    fromPrismic(schema: Schema): (header: TableCellOrHeaderBlock) => ProseMirrorNode;
+    toPrismic(node: ProseMirrorNode): TableCellOrHeaderBlock;
+};
+export {};

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

@@ -0,0 +1,2 @@
+export * from "./TableCell";
+export * from "./TableHeaderCell";

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/TableHandles/TableHandlesPlugin.d.ts

@@ -0,0 +1,8 @@
+import type { Editor } from "@tiptap/core";
+import { Plugin } from "@tiptap/pm/state";
+import { DecorationSet } from "@tiptap/pm/view";
+/** Plugin responsible for showing and hiding the row and column handles. */
+export declare function TableHandlesPlugin(this: {
+    editor: Editor;
+    name: string;
+}): Plugin<DecorationSet>;

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/TableHandles/TableHandlesPluginView.d.ts

@@ -0,0 +1,34 @@
+import { type PluginView } from "@tiptap/pm/state";
+import type { EditorView } from "@tiptap/pm/view";
+/**
+ * This plugin centralizes the logic for showing and hiding the row and column
+ * handle buttons (the ones that on click open a floating menu).
+ *
+ * Ideally, hiding and showing the handles would be handled using only CSS,
+ * but identifying the topmost cell in a column is not trivial, as the grouping
+ * of cells in a column is not clearly defined in the DOM (only by colgroup),
+ * and CSS cannot dynamically select it depending on the hovered cell.
+ *
+ * Another option was to dynamically generate hardcoded selectors, given that
+ * we know the number of rows and cells, but inline styles can only contain
+ * property declarations, not pseudo-classes like :hover.
+ *
+ * That leaves us with handling it solely in JavaScript, which is what this
+ * plugin does.
+ */
+export declare class TableHandlesPluginView implements PluginView {
+    private readonly view;
+    private abortController;
+    private currentRowHandle;
+    private currentColumnHandle;
+    constructor(view: EditorView);
+    update(view: EditorView): void;
+    destroy(): void;
+    private attachEventListeners;
+    private showCurrentHandles;
+    private hidePreviousHandles;
+    private getRowHandle;
+    private getColumnHandle;
+    private displayHandle;
+    private hideHandle;
+}

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/TableHandles/events.d.ts

@@ -0,0 +1,19 @@
+import type { Editor } from "@tiptap/core";
+export type TableHandleEventDetail = {
+    type: "row" | "column";
+    referenceElement: HTMLElement;
+};
+export type TableHandleEventType = {
+    name: "handleClick";
+    detail: TableHandleEventDetail;
+};
+export declare class TableHandleEvent extends CustomEvent<TableHandleEventType["detail"]> {
+    constructor({ name, detail }: TableHandleEventType);
+    static dispatch<TEvent extends TableHandleEventType>(name: TEvent["name"], args: {
+        editor: Editor;
+    } & TEvent["detail"]): void;
+    static listen<TEvent extends TableHandleEventType>(name: TEvent["name"], args: {
+        editor: Editor;
+        callback: (detail: TEvent["detail"]) => void;
+    }): () => void;
+}

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/TableHandles/index.d.ts

@@ -0,0 +1 @@
+export { TableHandlesPlugin } from "./TableHandlesPlugin";

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/TableHandles/utils.d.ts

@@ -0,0 +1,23 @@
+import { type Editor } from "@tiptap/core";
+import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
+import type { Selection } from "@tiptap/pm/state";
+interface NodePos {
+    pos: number;
+    start: number;
+    node: ProseMirrorNode | null | undefined;
+}
+export declare function getCellsInColumn(columnIndex: number | number[]): (selection: Selection) => NodePos[] | null;
+export declare function getCellsInRow(rowIndex: number | number[]): (selection: Selection) => NodePos[] | null;
+/** Finds the table handle element for the given type and element. */
+export declare function findTableHandleElement(args: {
+    type: "row" | "column";
+    element: Element;
+}): Element;
+/** Creates a table handle element for the given type. */
+export declare function createTableHandleElement(args: {
+    type: "row" | "column";
+    editor: Editor;
+    rowIndex: number;
+    columnIndex: number;
+}): HTMLButtonElement;
+export {};

package/dist/fields/RichTextField/extensions/Table/TableCell/plugins/index.d.ts

@@ -0,0 +1 @@
+export { TableHandlesPlugin } from "./TableHandles";

package/dist/fields/RichTextField/extensions/Table/TableCell/types.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+export declare const tableCellAttrs: z.ZodObject<{
+    colspan: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    rowspan: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    colwidth: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    colspan?: number | null | undefined;
+    rowspan?: number | null | undefined;
+    colwidth?: number[] | null | undefined;
+}, {
+    colspan?: number | null | undefined;
+    rowspan?: number | null | undefined;
+    colwidth?: number[] | null | undefined;
+}>;

package/dist/fields/RichTextField/extensions/Table/TableCell/utils.d.ts

@@ -0,0 +1,16 @@
+import type { Block } from "@prismicio/types-internal/lib/content";
+import type { Node as ProseMirrorNode, Schema } from "@tiptap/pm/model";
+export declare function mapTableCellToParagraph(schema: Schema, block: Block): ProseMirrorNode | undefined;
+interface CreateButtonElementArgs {
+    title: string;
+    className: string;
+    tabIndex?: number;
+    disabled?: boolean;
+    onMouseDown?: (event: MouseEvent, currentTarget: HTMLButtonElement) => void;
+    onClick: (event: MouseEvent, currentTarget: HTMLButtonElement) => void;
+    [key: `data-${string}`]: string | number | boolean;
+    [key: `aria-${string}`]: string | number | boolean;
+}
+export declare function createButtonElement(args: CreateButtonElementArgs): HTMLButtonElement;
+export declare function renderHtmlFromString(html: string): ChildNode | null;
+export {};

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

@@ -0,0 +1,9 @@
+import { TableContent } from "@prismicio/types-internal/lib/content";
+import type { Node as ProseMirrorNode, Schema } from "@tiptap/pm/model";
+type TableRowBlock = TableContent["content"][number];
+export declare const TableRow: import("@tiptap/core").Node<import("@tiptap/extension-table-row").TableRowOptions, any>;
+export declare const tableRowConverter: {
+    fromPrismic(schema: Schema): (row: TableRowBlock) => ProseMirrorNode;
+    toPrismic(node: ProseMirrorNode): TableRowBlock;
+};
+export {};

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

@@ -0,0 +1,20 @@
+import type { TableOptions as TTTableOptions } from "@tiptap/extension-table";
+import type { Node as ProseMirrorNode } from "@tiptap/pm/model";
+import { TableView as TTTableView } from "@tiptap/pm/tables";
+import type { NodeView, ViewMutationRecord } from "@tiptap/pm/view";
+import { Editor } from "@tiptap/react";
+export interface TableOptions extends TTTableOptions {
+    defaultCellMinWidth: number;
+}
+/**
+ * Renders a custom table, with a container for the table and the add
+ * row/column buttons, while keeping the default table view for the
+ * table content.
+ */
+export declare class TableView extends TTTableView implements NodeView {
+    constructor(args: {
+        node: ProseMirrorNode;
+        editor: Editor;
+    }, options: TableOptions);
+    ignoreMutation(mutation: ViewMutationRecord): boolean;
+}

package/dist/fields/RichTextField/extensions/Table/menus/TableColumnMenu.d.ts

@@ -0,0 +1,11 @@
+import type { Editor } from "@tiptap/core";
+import { type CSSProperties } from "react";
+interface TableColumnMenuProps {
+    editor: Editor;
+    style?: CSSProperties;
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    triggerElement: HTMLElement | undefined;
+}
+export declare function TableColumnMenu(props: TableColumnMenuProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/extensions/Table/menus/TableFloatingMenus.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import type { Editor } from "@tiptap/core";
+interface TableHandlesMenusProps {
+    editor: Editor;
+}
+export declare function TableFloatingMenus(props: TableHandlesMenusProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/extensions/Table/menus/TableRowMenu.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import type { Editor } from "@tiptap/core";
+interface TableRowMenuProps {
+    editor: Editor;
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    triggerElement: HTMLElement | undefined;
+}
+export declare function TableRowMenu(props: TableRowMenuProps): JSX.Element;
+export {};

package/dist/fields/RichTextField/extensions/Table/menus/TriggerAnchor.d.ts

@@ -0,0 +1,11 @@
+import { type HTMLAttributes } from "react";
+interface TriggerProps extends HTMLAttributes<HTMLDivElement> {
+    anchorElement: HTMLElement | undefined;
+}
+/**
+ * This component serves as a dummy trigger for radix dialog to be able to open.
+ * It won't be visible, and it's only purpose is to sync the props that are
+ * passed to it by radix with the real trigger via the anchorRef prop.
+ */
+export declare const TriggerAnchor: (props: TriggerProps & import("react").RefAttributes<HTMLElement>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;
+export {};

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

@@ -0,0 +1,2 @@
+export { TableFloatingMenus } from "./TableFloatingMenus";
+export { TableRowMenu } from "./TableRowMenu";

package/dist/fields/RichTextField/extensions/Table/menus/utils.d.ts

@@ -0,0 +1,13 @@
+import type { Editor } from "@tiptap/core";
+/**
+ * Row utilities
+ */
+export declare const isFirstRow: (editor: Editor) => boolean;
+export declare const isHeaderRowToggled: (editor: Editor) => boolean;
+export declare const isSingleRow: (editor: Editor) => boolean;
+/**
+ * Column utilities
+ */
+export declare const isFirstColumn: (editor: Editor) => boolean;
+export declare const isHeaderColumnToggled: (editor: Editor) => boolean;
+export declare const isSingleColumn: (editor: Editor) => boolean;

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

@@ -0,0 +1,14 @@
+import { Editor } from "@tiptap/core";
+import type { Schema } from "@tiptap/pm/model";
+import type { Selection } from "@tiptap/pm/state";
+export declare function getNodeFromSchema(schema: Schema, name: string): import("prosemirror-model").NodeType;
+export declare function findTable(selection: Selection): {
+    pos: number;
+    start: number;
+    depth: number;
+    node: import("prosemirror-model").Node;
+} | undefined;
+export declare function getTableColumnCount(editor: Editor): number;
+export declare function getTableRowCount(editor: Editor): number;
+export declare function isTableColumnLimitReached(editor: Editor): boolean;
+export declare function isTableRowLimitReached(editor: Editor): boolean;