@portabletext/editor 6.1.1 → 6.2.0

package/lib/_chunks-dts/behavior.types.action.d.ts

@@ -3,7 +3,7 @@ import { AnnotationDefinition, AnnotationSchemaType, AnnotationSchemaType as Ann
 import * as xstate73 from "xstate";
 import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
 import * as react8 from "react";
-import React$1, { BaseSyntheticEvent, ClipboardEvent as ClipboardEvent$1, FocusEvent, JSX, MutableRefObject, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
+import React$1, { BaseSyntheticEvent, ClipboardEvent as ClipboardEvent$1, FocusEvent, JSX, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
 import { Patch, Patch as Patch$1 } from "@portabletext/patches";
 type MIMEType = `${string}/${string}`;
 /**
@@ -183,22 +183,18 @@ interface BaseEditor {
   insertBreak: OmitFirstArg<typeof Editor$1.insertBreak>;
   insertNodes: OmitFirstArg<typeof Transforms.insertNodes>;
   insertText: OmitFirstArg<typeof Transforms.insertText>;
-  mergeNodes: OmitFirstArg<typeof Transforms.mergeNodes>;
   move: OmitFirstArg<typeof Transforms.move>;
-  moveNodes: OmitFirstArg<typeof Transforms.moveNodes>;
   normalize: OmitFirstArg<typeof Editor$1.normalize>;
   removeNodes: OmitFirstArg<typeof Transforms.removeNodes>;
   select: OmitFirstArg<typeof Transforms.select>;
   setNormalizing: OmitFirstArg<typeof Editor$1.setNormalizing>;
   setSelection: OmitFirstArg<typeof Transforms.setSelection>;
-  splitNodes: OmitFirstArg<typeof Transforms.splitNodes>;
   withoutNormalizing: OmitFirstArg<typeof Editor$1.withoutNormalizing>;
   above: <T extends Ancestor>(options?: EditorAboveOptions<T>) => NodeEntry<T> | undefined;
   after: OmitFirstArg<typeof Editor$1.after>;
   before: OmitFirstArg<typeof Editor$1.before>;
   elementReadOnly: OmitFirstArg<typeof Editor$1.elementReadOnly>;
   end: OmitFirstArg<typeof Editor$1.end>;
-  getMarks: OmitFirstArg<typeof Editor$1.marks>;
   hasInlines: OmitFirstArg<typeof Editor$1.hasInlines>;
   hasPath: OmitFirstArg<typeof Editor$1.hasPath>;
   isBlock: OmitFirstArg<typeof Editor$1.isBlock>;
@@ -412,10 +408,6 @@ interface EditorInterface {
    * Iterate through all of the levels at a location.
    */
   levels: <T extends Node$1>(editor: Editor$1, options?: EditorLevelsOptions<T>) => Generator<NodeEntry<T>, void, undefined>;
-  /**
-   * Get the marks that would be added to text at the current selection.
-   */
-  marks: (editor: Editor$1) => Omit<Text$1, 'text'> | null;
   /**
    * Get the matching node in the branch of the document after a location.
    */
@@ -554,28 +546,8 @@ interface ElementInterface {
    * Check if a value implements the `Element` interface.
    */
   isElement: (value: any, schema: EditorSchema) => value is Element$1;
-  /**
-   * Check if a value is an array of `Element` objects.
-   */
-  isElementList: (value: any, schema: EditorSchema) => value is Element$1[];
-  /**
-   * Check if a set of props is a partial of Element.
-   */
-  isElementProps: (props: any) => props is Partial<Element$1>;
-  /**
-   * Check if an element matches set of properties.
-   *
-   * Note: this checks custom properties, and it does not ensure that any
-   * children are equivalent.
-   */
-  matches: (element: Element$1, props: Partial<Element$1>) => boolean;
 }
 declare const Element$1: ElementInterface;
-/**
- * `ElementEntry` objects refer to an `Element` and the `Path` where it can be
- * found inside a root node.
- */
-type ElementEntry = [Element$1, Path$1];
 /**
  * The `Location` interface is a union of the ways to refer to a specific
  * location in a Slate document: paths, points or ranges.
@@ -585,13 +557,6 @@ type ElementEntry = [Element$1, Path$1];
  * converting between the different interfaces in their own code base.
  */
 type Location = Path$1 | Point | Range;
-interface LocationInterface {
-  /**
-   * Check if a value implements the `Location` interface.
-   */
-  isLocation: (value: any) => value is Location;
-}
-declare const Location: LocationInterface;
 /**
  * The `Span` interface is a low-level way to refer to locations in nodes
  * without using `Point` which requires leaf text nodes to be present.
@@ -623,24 +588,9 @@ interface BaseObjectNode {
 }
 type ObjectNode = ExtendedType<'ObjectNode', BaseObjectNode>;
 type Node$1 = Editor$1 | Element$1 | ObjectNode | Text$1;
-interface NodeAncestorsOptions {
-  reverse?: boolean;
-}
 interface NodeChildrenOptions {
   reverse?: boolean;
 }
-interface NodeDescendantsOptions {
-  from?: Path$1;
-  to?: Path$1;
-  reverse?: boolean;
-  pass?: (node: NodeEntry) => boolean;
-}
-interface NodeElementsOptions {
-  from?: Path$1;
-  to?: Path$1;
-  reverse?: boolean;
-  pass?: (node: NodeEntry) => boolean;
-}
 interface NodeLevelsOptions {
   reverse?: boolean;
 }
@@ -661,13 +611,6 @@ interface NodeInterface {
    * Get the node at a specific path, asserting that it's an ancestor node.
    */
   ancestor: (root: Node$1, path: Path$1, schema: EditorSchema) => Ancestor;
-  /**
-   * Return a generator of all the ancestor nodes above a specific path.
-   *
-   * By default the order is top-down, from highest to lowest ancestor in
-   * the tree, but you can pass the `reverse: true` option to go bottom-up.
-   */
-  ancestors: (root: Node$1, path: Path$1, schema: EditorSchema, options?: NodeAncestorsOptions) => Generator<NodeEntry<Ancestor>, void, undefined>;
   /**
    * Get the child of a node at a specific index.
    */
@@ -676,24 +619,6 @@ interface NodeInterface {
    * Iterate over the children of a node at a specific path.
    */
   children: (root: Node$1, path: Path$1, schema: EditorSchema, options?: NodeChildrenOptions) => Generator<NodeEntry<Descendant>, void, undefined>;
-  /**
-   * Get an entry for the common ancesetor node of two paths.
-   */
-  common: (root: Node$1, path: Path$1, another: Path$1, schema: EditorSchema) => NodeEntry;
-  /**
-   * Get the node at a specific path, asserting that it's a descendant node.
-   */
-  descendant: (root: Node$1, path: Path$1, schema: EditorSchema) => Descendant;
-  /**
-   * Return a generator of all the descendant node entries inside a root node.
-   */
-  descendants: (root: Node$1, schema: EditorSchema, options?: NodeDescendantsOptions) => Generator<NodeEntry<Descendant>, void, undefined>;
-  /**
-   * Return a generator of all the element nodes inside a root node. Each iteration
-   * will return an `ElementEntry` tuple consisting of `[Element, Path]`. If the
-   * root node is an element it will be included in the iteration as well.
-   */
-  elements: (root: Node$1, schema: EditorSchema, options?: NodeElementsOptions) => Generator<ElementEntry, void, undefined>;
   /**
    * Extract props from a Node.
    */
@@ -753,10 +678,6 @@ interface NodeInterface {
    * but you can pass the `reverse: true` option to go bottom-up.
    */
   levels: (root: Node$1, path: Path$1, schema: EditorSchema, options?: NodeLevelsOptions) => Generator<NodeEntry, void, undefined>;
-  /**
-   * Check if a node matches a set of props.
-   */
-  matches: (node: Node$1, props: Partial<Node$1>, schema: EditorSchema) => boolean;
   /**
    * Return a generator of all the node entries of a root node. Each entry is
    * returned as a `[Node, Path]` tuple, with the path referring to the node's
@@ -882,10 +803,6 @@ type TextOperation = InsertTextOperation | RemoveTextOperation;
 type BaseOperation = NodeOperation | SelectionOperation | TextOperation;
 type Operation = ExtendedType<'Operation', BaseOperation>;
 interface OperationInterface {
-  /**
-   * Check if a value is a `NodeOperation` object.
-   */
-  isNodeOperation: (value: any) => value is NodeOperation;
   /**
    * Check if a value is an `Operation` object.
    */
@@ -894,14 +811,6 @@ interface OperationInterface {
    * Check if a value is a list of `Operation` objects.
    */
   isOperationList: (value: any) => value is Operation[];
-  /**
-   * Check if a value is a `SelectionOperation` object.
-   */
-  isSelectionOperation: (value: any) => value is SelectionOperation;
-  /**
-   * Check if a value is a `TextOperation` object.
-   */
-  isTextOperation: (value: any) => value is TextOperation;
   /**
    * Invert an operation, returning a new operation that will exactly undo the
    * original when applied.
@@ -962,14 +871,6 @@ interface PathInterface {
    * [[Path.equals]] instead.
    */
   compare: (path: Path$1, another: Path$1) => -1 | 0 | 1;
-  /**
-   * Check if a path ends after one of the indexes in another.
-   */
-  endsAfter: (path: Path$1, another: Path$1) => boolean;
-  /**
-   * Check if a path ends at one of the indexes in another.
-   */
-  endsAt: (path: Path$1, another: Path$1) => boolean;
   /**
    * Check if a path ends before one of the indexes in another.
    */
@@ -994,10 +895,6 @@ interface PathInterface {
    * Check if a path is before another.
    */
   isBefore: (path: Path$1, another: Path$1) => boolean;
-  /**
-   * Check if a path is a child of another.
-   */
-  isChild: (path: Path$1, another: Path$1) => boolean;
   /**
    * Check if a path is equal to or an ancestor of another.
    */
@@ -1006,10 +903,6 @@ interface PathInterface {
    * Check if a path is a descendant of another.
    */
   isDescendant: (path: Path$1, another: Path$1) => boolean;
-  /**
-   * Check if a path is the parent of another.
-   */
-  isParent: (path: Path$1, another: Path$1) => boolean;
   /**
    * Check is a value implements the `Path` interface.
    */
@@ -1046,10 +939,6 @@ interface PathInterface {
    * Given a path, get the path to the previous sibling node.
    */
   previous: (path: Path$1) => Path$1;
-  /**
-   * Get a path relative to an ancestor.
-   */
-  relative: (path: Path$1, ancestor: Path$1) => Path$1;
   /**
    * Transform a path by an operation.
    */
@@ -1171,10 +1060,6 @@ interface RangeInterface {
    * Check if a range includes a path, a point or part of another range.
    */
   includes: (range: Range, target: Path$1 | Point | Range) => boolean;
-  /**
-   * Check if a range includes another range.
-   */
-  surrounds: (range: Range, target: Range) => boolean;
   /**
    * Get the intersection of a range with another.
    */
@@ -1256,21 +1141,6 @@ interface TextInterface {
    * Check if a value implements the `Text` interface.
    */
   isText: (value: any, schema: EditorSchema) => value is Text$1;
-  /**
-   * Check if a value is a list of `Text` objects.
-   */
-  isTextList: (value: any, schema: EditorSchema) => value is Text$1[];
-  /**
-   * Check if some props are a partial of Text.
-   */
-  isTextProps: (props: any) => props is Partial<Text$1>;
-  /**
-   * Check if an text matches set of properties.
-   *
-   * Note: this is for matching custom properties, and it does not ensure that
-   * the `text` property are two nodes equal.
-   */
-  matches: (text: Text$1, props: Partial<Text$1>) => boolean;
   /**
    * Get the leaves for a text node given decorations.
    */
@@ -1302,27 +1172,6 @@ interface NodeTransforms {
    * at the specified location or (if not defined) the current selection or (if not defined) the end of the document.
    */
   insertNodes: <T extends Node$1>(editor: Editor$1, nodes: Node$1 | Node$1[], options?: NodeInsertNodesOptions<T>) => void;
-  /**
-   * Merge a node at a location with the previous node of the same depth,
-   * removing any empty containing nodes after the merge if necessary.
-   */
-  mergeNodes: <T extends Node$1>(editor: Editor$1, options?: {
-    at?: Location;
-    match?: NodeMatch<T>;
-    mode?: RangeMode;
-    hanging?: boolean;
-    voids?: boolean;
-  }) => void;
-  /**
-   * Move the nodes at a location to a new location.
-   */
-  moveNodes: <T extends Node$1>(editor: Editor$1, options: {
-    at?: Location;
-    match?: NodeMatch<T>;
-    mode?: MaximizeMode;
-    to: Path$1;
-    voids?: boolean;
-  }) => void;
   /**
    * Remove the nodes at a specific location in the document.
    */
@@ -1333,17 +1182,6 @@ interface NodeTransforms {
     hanging?: boolean;
     voids?: boolean;
   }) => void;
-  /**
-   * Split the nodes at a specific location.
-   */
-  splitNodes: <T extends Node$1>(editor: Editor$1, options?: {
-    at?: Location;
-    match?: NodeMatch<T>;
-    mode?: RangeMode;
-    always?: boolean;
-    height?: number;
-    voids?: boolean;
-  }) => void;
 }
 declare const NodeTransforms: NodeTransforms;
 interface SelectionCollapseOptions {
@@ -1445,7 +1283,6 @@ interface DOMEditor extends BaseEditor {
   elementToNode: WeakMap<HTMLElement, Node$1>;
   nodeToElement: WeakMap<Node$1, HTMLElement>;
   nodeToKey: WeakMap<Node$1, Key>;
-  changeVersion: MutableRefObject<number>;
   readOnly: boolean;
   focused: boolean;
   composing: boolean;
@@ -1462,22 +1299,10 @@ interface DOMEditor extends BaseEditor {
   forceRender: (() => void) | null;
 }
 interface DOMEditorInterface {
-  /**
-   * Experimental and android specific: Get pending diffs
-   */
-  androidPendingDiffs: (editor: Editor$1) => TextDiff[] | undefined;
-  /**
-   * Experimental and android specific: Flush all pending diffs and cancel composition at the next possible time.
-   */
-  androidScheduleFlush: (editor: Editor$1) => void;
   /**
    * Blur the editor.
    */
   blur: (editor: Editor$1) => void;
-  /**
-   * Deselect the editor.
-   */
-  deselect: (editor: Editor$1) => void;
   /**
    * Find the DOM node that implements DocumentOrShadowRoot for the editor.
    */
@@ -1534,10 +1359,6 @@ interface DOMEditorInterface {
    * Check if the editor is focused.
    */
   isFocused: (editor: Editor$1) => boolean;
-  /**
-   * Check if the editor is in read-only mode.
-   */
-  isReadOnly: (editor: Editor$1) => boolean;
   /**
    * Check if the target is inside void and in an non-readonly editor.
    */
@@ -1591,20 +1412,6 @@ declare const DOMEditor: DOMEditorInterface;
 interface ChunkTree {
   type: 'root';
   children: ChunkDescendant[];
-  /**
-   * The keys of any Slate nodes that have been moved using move_node since the
-   * last render
-   *
-   * Detecting when a node has been moved to a different position in the
-   * children array is impossible to do efficiently while reconciling the chunk
-   * tree. This interferes with the reconciliation logic since it is treated as
-   * if the intermediate nodes were inserted and removed, causing them to be
-   * re-chunked unnecessarily.
-   *
-   * This set is used to detect when a node has been moved so that this case
-   * can be handled correctly and efficiently.
-   */
-  movedNodeKeys: Set<Key>;
   /**
    * The chunks whose descendants have been modified during the most recent
    * reconciliation