@prismicio/editor-fields 0.4.68 → 0.4.70

package/dist/core/APIExplorer/components/APIExplorerContext.d.ts

@@ -31,6 +31,7 @@ export type UseAPIExplorerRequestProperties = {
         [Type in RequestTypes]?: Record<string, string>;
     };
     pagination: RequestPagination;
+    lang?: string;
     response?: ResponsePending | ResponseSuccess | ResponseError;
 };
 type UseAPIExplorerRequestMethods = {
@@ -42,6 +43,7 @@ type UseAPIExplorerRequestMethods = {
         page?: number;
         pageSize?: number;
     }) => void;
+    setLang: (lang?: string) => void;
     run: () => Promise<void>;
 };
 type APIExplorerContextType = {

package/dist/core/APIExplorer/components/Request/components/RequestLangFieldset.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/**
+ * Display a fieldset managing a request document lang setting.
+ */
+export declare function RequestLangFieldset(): JSX.Element;

package/dist/core/APIExplorer/components/Request/components/index.d.ts

@@ -1,3 +1,4 @@
 export { RequestFormInput } from "./RequestFormInput";
+export { RequestLangFieldset } from "./RequestLangFieldset";
 export { RequestPaginationFieldset } from "./RequestPaginationFieldset";
 export { RequestTypeFieldset } from "./RequestTypeFieldset";

package/dist/core/APIExplorer/components/Request/createRequest.d.ts

@@ -2,11 +2,14 @@
 import type { Client } from "@prismicio/client";
 import type { RequestPagination } from "../APIExplorerContext";
 import type { RequestRunReturnType } from "./types";
+type RequestOptions = Record<string, string | number | undefined> & RequestPagination & {
+    lang?: string;
+};
 export type RequestConfig<TType extends string> = {
     type: TType;
     Fieldset?: () => JSX.Element;
-    getSnippet: (options: Record<string, string | number> & RequestPagination) => string;
-    run: (client: Client, options: Record<string, string | number> & RequestPagination) => Promise<RequestRunReturnType>;
+    getSnippet: (options: RequestOptions) => string;
+    run: (client: Client, options: RequestOptions) => Promise<RequestRunReturnType>;
 };
 /**
  * A factory for creating request handlers (fieldset, snippet, runner, erc.) for the API explorer.
@@ -15,3 +18,4 @@ export type RequestConfig<TType extends string> = {
  * @returns A request handler to be referenced in `./types.ts` for the API explorer to use.
  */
 export declare function createRequest<TType extends string>(config: RequestConfig<TType>): RequestConfig<TType>;
+export {};

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

@@ -154,7 +154,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                     label?: string | null | undefined;
                     useAsTitle?: boolean | undefined;
                     placeholder?: string | undefined;
-                    select?: "web" | "document" | "media" | null | undefined;
+                    select?: "web" | "media" | "document" | null | undefined;
                     customtypes?: readonly string[] | undefined;
                     masks?: readonly string[] | undefined;
                     tags?: readonly string[] | undefined;
@@ -329,7 +329,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                 label?: string | null | undefined;
                                 useAsTitle?: boolean | undefined;
                                 placeholder?: string | undefined;
-                                select?: "web" | "document" | "media" | null | undefined;
+                                select?: "web" | "media" | "document" | null | undefined;
                                 customtypes?: readonly string[] | undefined;
                                 masks?: readonly string[] | undefined;
                                 tags?: readonly string[] | undefined;
@@ -504,7 +504,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                             label?: string | null | undefined;
                                             useAsTitle?: boolean | undefined;
                                             placeholder?: string | undefined;
-                                            select?: "web" | "document" | "media" | null | undefined;
+                                            select?: "web" | "media" | "document" | null | undefined;
                                             customtypes?: readonly string[] | undefined;
                                             masks?: readonly string[] | undefined;
                                             tags?: readonly string[] | undefined;
@@ -689,7 +689,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                 label?: string | null | undefined;
                                 useAsTitle?: boolean | undefined;
                                 placeholder?: string | undefined;
-                                select?: "web" | "document" | "media" | null | undefined;
+                                select?: "web" | "media" | "document" | null | undefined;
                                 customtypes?: readonly string[] | undefined;
                                 masks?: readonly string[] | undefined;
                                 tags?: readonly string[] | undefined;
@@ -864,7 +864,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                             label?: string | null | undefined;
                                             useAsTitle?: boolean | undefined;
                                             placeholder?: string | undefined;
-                                            select?: "web" | "document" | "media" | null | undefined;
+                                            select?: "web" | "media" | "document" | null | undefined;
                                             customtypes?: readonly string[] | undefined;
                                             masks?: readonly string[] | undefined;
                                             tags?: readonly string[] | undefined;
@@ -1040,7 +1040,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                         label?: string | null | undefined;
                                         useAsTitle?: boolean | undefined;
                                         placeholder?: string | undefined;
-                                        select?: "web" | "document" | "media" | null | undefined;
+                                        select?: "web" | "media" | "document" | null | undefined;
                                         customtypes?: readonly string[] | undefined;
                                         masks?: readonly string[] | undefined;
                                         tags?: readonly string[] | undefined;
@@ -1208,7 +1208,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                         label?: string | null | undefined;
                                         useAsTitle?: boolean | undefined;
                                         placeholder?: string | undefined;
-                                        select?: "web" | "document" | "media" | null | undefined;
+                                        select?: "web" | "media" | "document" | null | undefined;
                                         customtypes?: readonly string[] | undefined;
                                         masks?: readonly string[] | undefined;
                                         tags?: readonly string[] | undefined;
@@ -1392,7 +1392,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                             label?: string | null | undefined;
                                             useAsTitle?: boolean | undefined;
                                             placeholder?: string | undefined;
-                                            select?: "web" | "document" | "media" | null | undefined;
+                                            select?: "web" | "media" | "document" | null | undefined;
                                             customtypes?: readonly string[] | undefined;
                                             masks?: readonly string[] | undefined;
                                             tags?: readonly string[] | undefined;
@@ -1567,7 +1567,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                                         label?: string | null | undefined;
                                                         useAsTitle?: boolean | undefined;
                                                         placeholder?: string | undefined;
-                                                        select?: "web" | "document" | "media" | null | undefined;
+                                                        select?: "web" | "media" | "document" | null | undefined;
                                                         customtypes?: readonly string[] | undefined;
                                                         masks?: readonly string[] | undefined;
                                                         tags?: readonly string[] | undefined;
@@ -1742,7 +1742,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                                                     label?: string | null | undefined;
                                                                     useAsTitle?: boolean | undefined;
                                                                     placeholder?: string | undefined;
-                                                                    select?: "web" | "document" | "media" | null | undefined;
+                                                                    select?: "web" | "media" | "document" | null | undefined;
                                                                     customtypes?: readonly string[] | undefined;
                                                                     masks?: readonly string[] | undefined;
                                                                     tags?: readonly string[] | undefined;
@@ -1916,7 +1916,7 @@ export declare function useStaticCustomType(args: CustomTypeOptionsArgs): import
                                             label?: string | null | undefined;
                                             useAsTitle?: boolean | undefined;
                                             placeholder?: string | undefined;
-                                            select?: "web" | "document" | "media" | null | undefined;
+                                            select?: "web" | "media" | "document" | null | undefined;
                                             customtypes?: readonly string[] | undefined;
                                             masks?: readonly string[] | undefined;
                                             tags?: readonly string[] | undefined;

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

@@ -1460,7 +1460,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
             content: ({
                 key: string;
             } & {
-                type: "tableCell" | "tableHeader";
+                type: "tableHeader" | "tableCell";
                 content: {
                     __TYPE__: "StructuredTextContent";
                     value: (({
@@ -2061,7 +2061,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
                             content: ({
                                 key: string;
                             } & {
-                                type: "tableCell" | "tableHeader";
+                                type: "tableHeader" | "tableCell";
                                 content: {
                                     __TYPE__: "StructuredTextContent";
                                     value: (({
@@ -2654,7 +2654,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
                             content: ({
                                 key: string;
                             } & {
-                                type: "tableCell" | "tableHeader";
+                                type: "tableHeader" | "tableCell";
                                 content: {
                                     __TYPE__: "StructuredTextContent";
                                     value: (({
@@ -3246,7 +3246,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
                             content: ({
                                 key: string;
                             } & {
-                                type: "tableCell" | "tableHeader";
+                                type: "tableHeader" | "tableCell";
                                 content: {
                                     __TYPE__: "StructuredTextContent";
                                     value: (({
@@ -3839,7 +3839,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
                             content: ({
                                 key: string;
                             } & {
-                                type: "tableCell" | "tableHeader";
+                                type: "tableHeader" | "tableCell";
                                 content: {
                                     __TYPE__: "StructuredTextContent";
                                     value: (({
@@ -4427,7 +4427,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
                     content: ({
                         key: string;
                     } & {
-                        type: "tableCell" | "tableHeader";
+                        type: "tableHeader" | "tableCell";
                         content: {
                             __TYPE__: "StructuredTextContent";
                             value: (({
@@ -5027,7 +5027,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
                     content: ({
                         key: string;
                     } & {
-                        type: "tableCell" | "tableHeader";
+                        type: "tableHeader" | "tableCell";
                         content: {
                             __TYPE__: "StructuredTextContent";
                             value: (({
@@ -5620,7 +5620,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
                     content: ({
                         key: string;
                     } & {
-                        type: "tableCell" | "tableHeader";
+                        type: "tableHeader" | "tableCell";
                         content: {
                             __TYPE__: "StructuredTextContent";
                             value: (({
@@ -6215,7 +6215,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
                     content: ({
                         key: string;
                     } & {
-                        type: "tableCell" | "tableHeader";
+                        type: "tableHeader" | "tableCell";
                         content: {
                             __TYPE__: "StructuredTextContent";
                             value: (({
@@ -6808,7 +6808,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
                     content: ({
                         key: string;
                     } & {
-                        type: "tableCell" | "tableHeader";
+                        type: "tableHeader" | "tableCell";
                         content: {
                             __TYPE__: "StructuredTextContent";
                             value: (({
@@ -7399,7 +7399,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
             content: ({
                 key: string;
             } & {
-                type: "tableCell" | "tableHeader";
+                type: "tableHeader" | "tableCell";
                 content: {
                     __TYPE__: "StructuredTextContent";
                     value: (({

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

@@ -11,7 +11,7 @@ interface useLinkFieldParams {
 }
 export declare function useLinkField(params: useLinkFieldParams): {
     contentType: "ImageLink" | "FileLink" | "DocumentLink" | "ExternalLink" | "MediaLink" | "AnyLink" | undefined;
-    selectType: "web" | "document" | "media" | "any" | undefined;
+    selectType: "web" | "media" | "document" | "any" | undefined;
     fieldValue: string;
     onDisplayTextChange: (displayText: string) => void;
     onValueChange: (value: string, options?: {

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

@@ -15,5 +15,5 @@ interface Props<TContent extends ExtendedRichTextContent> {
      * @default false */
     shouldReturnEmptyContent?: boolean;
 }
-export declare function RichTextField<TContent extends ExtendedRichTextContent>(props: Props<TContent>): JSX.Element;
+export declare function RichTextField<TContent extends ExtendedRichTextContent>(props: Props<TContent>): JSX.Element | null;
 export {};

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/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/TableControlsWrapper.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { type NodeViewProps } from "@tiptap/react";
+export declare function TableControlsWrapper({ editor }: NodeViewProps): JSX.Element;

package/dist/fields/RichTextField/extensions/Table/plugins/TableHandles/TableHandlesPluginDef.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(args: {
+    editor: Editor;
+    name: string;
+}): Plugin<DecorationSet>;

package/dist/fields/RichTextField/extensions/Table/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/plugins/TableHandles/TableHandlesPluginViewClass.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;
+}