Update Plate types and APIs in slate-tables and slate-types

prezly · Jan 15, 2025 · f4d160e · f4d160e
1 parent b480364
commit f4d160e
Show file tree

Hide file tree

Showing 16 changed files with 76 additions and 75 deletions.
diff --git a/packages/slate-tables/src/TablesEditor.ts b/packages/slate-tables/src/TablesEditor.ts
@@ -1,12 +1,18 @@
-import type { SlateEditor, TElement, TText } from '@udecode/plate-common';
-import type { Location, Node } from 'slate';
+import {
+    NodeApi,
+    type Element,
+    type Location,
+    type Node,
+    type SlateEditor,
+    type Text,
+} from '@udecode/plate';
 
 import * as TableCommands from './commands';
 import { TableCellNode, TableRowNode, TableNode } from './nodes';
 import * as TableQueries from './queries';
 
 export interface TablesSchema {
-    createContentNode: () => TElement | TText;
+    createContentNode: () => Element | Text;
     createTableNode: (props: Partial<TableNode>) => TableNode;
     createTableRowNode: (props: Partial<TableRowNode>) => TableRowNode;
     createTableCellNode: (props: Partial<TableCellNode>) => TableCellNode;
@@ -51,6 +57,6 @@ export namespace TablesEditor {
     }
 
     export function isTablesEditor(editor: SlateEditor): editor is TablesEditor {
-        return typeof editor === 'object' && editor !== null && 'isTableCellNode' in editor;
+        return NodeApi.isEditor(editor) && 'isTableCellNode' in editor;
     }
 }
diff --git a/packages/slate-tables/src/commands/insertColumn.ts b/packages/slate-tables/src/commands/insertColumn.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location, Path } from 'slate';
+import { type Location, type Path, PathApi } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import { TableCellNode } from '../nodes';
@@ -25,24 +24,23 @@ export function insertColumn(
     let firstCellInNewColumnPath: Path | undefined = undefined;
 
     // As we insert cells one by one Slate calls normalization which insert empty cells
-    editor.withoutNormalizing(() => {
+    editor.tf.withoutNormalizing(() => {
         activeColumn.cells.forEach((columnCell, index) => {
-            const at = side === 'left' ? columnCell.path : Path.next(columnCell.path);
+            const at = side === 'left' ? columnCell.path : PathApi.next(columnCell.path);
 
             if (index === 0) {
                 firstCellInNewColumnPath = at;
             }
 
-            editor.insertNodes(TableCellNode.createTableCell(editor), { at });
+            editor.tf.insertNodes(TableCellNode.createTableCell(editor), { at });
         });
     });
 
-    editor.normalize();
-
-    focusEditor(editor);
+    editor.tf.normalize();
+    editor.tf.focus();
 
     if (firstCellInNewColumnPath) {
-        editor.select(firstCellInNewColumnPath);
+        editor.tf.select(firstCellInNewColumnPath);
     }
 
     return true;

diff --git a/packages/slate-tables/src/commands/insertRow.ts b/packages/slate-tables/src/commands/insertRow.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location, Path, Node } from 'slate';
+import { type Location, NodeApi, PathApi } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import { TableRowNode, TableCellNode } from '../nodes';
@@ -33,13 +32,17 @@ export function insertRow(
 
     const newRow = TableRowNode.createTableRow(editor, { children: cellsToAdd });
 
-    const at = side === 'bellow' ? Path.next(activeRow.path) : activeRow.path;
-    editor.insertNodes(newRow, { at });
+    const at = side === 'bellow' ? PathApi.next(activeRow.path) : activeRow.path;
+    editor.tf.insertNodes(newRow, { at });
+    editor.tf.focus();
 
-    focusEditor(editor);
+    const firstNode = NodeApi.first(editor, at);
+    if (!firstNode) {
+        return false;
+    }
 
-    const [, firstCellInNewRowPath] = Node.first(editor, at);
-    editor.select(firstCellInNewRowPath);
+    const [, firstCellInNewRowPath] = firstNode;
+    editor.tf.select(firstCellInNewRowPath);
 
     return true;
 }
diff --git a/packages/slate-tables/src/commands/insertTable.ts b/packages/slate-tables/src/commands/insertTable.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location } from 'slate';
+import { type Location } from '@udecode/plate';
 
 import { TableNode } from '../nodes';
 import type { TablesEditor } from '../TablesEditor';
@@ -13,11 +12,11 @@ export function insertTable(
         return false;
     }
 
-    editor.insertNodes(TableNode.createTable(editor, props), {
+    editor.tf.insertNodes(TableNode.createTable(editor, props), {
         at: location,
     });
 
-    focusEditor(editor);
+    editor.tf.focus();
 
     return true;
 }
diff --git a/packages/slate-tables/src/commands/removeColumn.ts b/packages/slate-tables/src/commands/removeColumn.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location } from 'slate';
+import { type Location } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import { TableCellNode } from '../nodes';
@@ -27,7 +26,7 @@ export function removeColumn(
     }
 
     // As we remove cells one by one Slate calls normalization which insert empty cells
-    editor.withoutNormalizing(() => {
+    editor.tf.withoutNormalizing(() => {
         activeColumn.cells.forEach((cell) => {
             if (TableCellNode.getCellColspan(cell.node) > 1) {
                 TableCellNode.update(
@@ -36,12 +35,12 @@ export function removeColumn(
                     cell.path,
                 );
             } else {
-                editor.removeNodes({ at: cell.path });
+                editor.tf.removeNodes({ at: cell.path });
             }
         });
     });
 
-    editor.normalize();
+    editor.tf.normalize();
 
     let anchorFocusColumn = activeColumn;
 
@@ -52,11 +51,11 @@ export function removeColumn(
     const firstCell = anchorFocusColumn.cells.at(0);
 
     if (firstCell) {
-        editor.select(firstCell.path);
-        editor.collapse({ edge: 'start' });
+        editor.tf.select(firstCell.path);
+        editor.tf.collapse({ edge: 'start' });
     }
 
-    focusEditor(editor);
+    editor.tf.focus();
 
     return true;
 }
diff --git a/packages/slate-tables/src/commands/removeRow.ts b/packages/slate-tables/src/commands/removeRow.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location } from 'slate';
+import { type Location } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import { TableCellNode } from '../nodes';
@@ -35,18 +34,18 @@ export function removeRow(
         }
     });
 
-    editor.removeNodes({ at: activeRow.path });
+    editor.tf.removeNodes({ at: activeRow.path });
 
     const anchorFocusRow = activeRow.rowBelow ?? activeRow;
 
     const firstCell = anchorFocusRow.rowAbove.cells.at(0);
 
     if (firstCell) {
-        editor.select(firstCell.path);
-        editor.collapse({ edge: 'start' });
+        editor.tf.select(firstCell.path);
+        editor.tf.collapse({ edge: 'start' });
     }
 
-    focusEditor(editor);
+    editor.tf.focus();
 
     return true;
 }
diff --git a/packages/slate-tables/src/commands/removeTable.ts b/packages/slate-tables/src/commands/removeTable.ts
@@ -1,5 +1,4 @@
-import { focusEditor } from '@udecode/plate-common/react';
-import { type Location } from 'slate';
+import { type Location } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import type { TablesEditor } from '../TablesEditor';
@@ -20,9 +19,9 @@ export function removeTable(
 
     const { matrix } = traverse;
 
-    focusEditor(editor);
+    editor.tf.focus();
 
-    editor.removeNodes({ at: matrix.path });
+    editor.tf.removeNodes({ at: matrix.path });
 
     return true;
 }
diff --git a/packages/slate-tables/src/core/withTablesCopyPasteBehavior.ts b/packages/slate-tables/src/core/withTablesCopyPasteBehavior.ts
@@ -1,5 +1,4 @@
-import { getNodeFragment } from '@udecode/plate-common';
-import { type Range, Path } from 'slate';
+import { NodeApi, type Path, PathApi, type Range } from '@udecode/plate';
 
 import { findParentCell } from '../queries';
 import type { TablesEditor } from '../TablesEditor';
@@ -15,14 +14,14 @@ export function withTablesCopyPasteBehavior<T extends TablesEditor>(editor: T):
                 const [cell, cellPath] = cellEntry;
                 const { focus, anchor } = editor.selection;
 
-                return getNodeFragment(cell, {
+                return NodeApi.fragment(cell, {
                     anchor: {
                         offset: anchor.offset,
-                        path: Path.relative(anchor.path, cellPath),
+                        path: PathApi.relative(anchor.path, cellPath),
                     },
                     focus: {
                         offset: focus.offset,
-                        path: Path.relative(focus.path, cellPath),
+                        path: PathApi.relative(focus.path, cellPath),
                     },
                 });
             }
@@ -35,5 +34,8 @@ export function withTablesCopyPasteBehavior<T extends TablesEditor>(editor: T):
 }
 
 function isRangeInside(selection: Range, path: Path) {
-    return Path.isCommon(path, selection.anchor.path) && Path.isCommon(path, selection.focus.path);
+    return (
+        PathApi.isCommon(path, selection.anchor.path) &&
+        PathApi.isCommon(path, selection.focus.path)
+    );
 }
diff --git a/packages/slate-tables/src/nodes/TableCellNode.ts b/packages/slate-tables/src/nodes/TableCellNode.ts
@@ -1,9 +1,8 @@
-import type { TElement } from '@udecode/plate-common';
-import type { Location } from 'slate';
+import { type Element, type Location } from '@udecode/plate';
 
 import type { TablesEditor } from '../TablesEditor';
 
-export interface TableCellNode extends TElement {
+export interface TableCellNode extends Element {
     rowspan?: number;
     colspan?: number;
 }
@@ -66,7 +65,7 @@ export namespace TableCellNode {
         props: Partial<Omit<TableCellNode, 'children'>>,
         location: Location,
     ) {
-        editor.setNodes<TableCellNode>(props, {
+        editor.tf.setNodes<TableCellNode>(props, {
             at: location,
             match: (node) => editor.isTableCellNode(node),
         });

diff --git a/packages/slate-tables/src/nodes/TableNode.ts b/packages/slate-tables/src/nodes/TableNode.ts
@@ -1,4 +1,4 @@
-import type { Element, Location } from 'slate';
+import { type Element, type Location } from '@udecode/plate';
 
 import { Traverse } from '../core';
 import type { TablesEditor } from '../TablesEditor';
@@ -36,7 +36,7 @@ export namespace TableNode {
         props: Partial<Omit<TableNode, 'children'>>,
         location: Location | undefined = editor.selection ?? undefined,
     ) {
-        editor.setNodes<TableNode>(props, {
+        editor.tf.setNodes<TableNode>(props, {
             at: location,
             match: (node) => editor.isTableNode(node),
         });
@@ -62,7 +62,7 @@ export namespace TableNode {
             ? traverse.matrix.node.header?.filter((h) => h !== headerType)
             : [...(traverse.matrix.node.header ?? []), headerType];
 
-        editor.setNodes<TableNode>(
+        editor.tf.setNodes<TableNode>(
             { header: newHeader },
             {
                 at: location,
@@ -72,7 +72,7 @@ export namespace TableNode {
 
         // When we mark text in cell as bold and then mark the first row as header the normalization is not called
         // and bold mark still present in cell content
-        editor.normalize({ force: true });
+        editor.tf.normalize({ force: true });
 
         return newHeader;
     }

diff --git a/packages/slate-tables/src/nodes/TableRowNode.ts b/packages/slate-tables/src/nodes/TableRowNode.ts
@@ -1,4 +1,4 @@
-import type { Element, Location } from 'slate';
+import { type Element, type Location } from '@udecode/plate';
 
 import type { TablesEditor } from '../TablesEditor';
 
@@ -28,7 +28,7 @@ export namespace TableRowNode {
         props: Partial<Omit<TableRowNode, 'children'>>,
         location: Location,
     ) {
-        editor.setNodes<TableRowNode>(props, {
+        editor.tf.setNodes<TableRowNode>(props, {
             at: location,
             match: (node) => editor.isTableRowNode(node),
         });

diff --git a/packages/slate-tables/src/queries/isHeaderCell.ts b/packages/slate-tables/src/queries/isHeaderCell.ts
@@ -1,5 +1,4 @@
-import { getLevels, isEditor as isEditorObject } from '@udecode/plate-common';
-import { Location } from 'slate';
+import { type Location, LocationApi, NodeApi } from '@udecode/plate';
 
 import type { TableCellNode, TableNode } from '../nodes';
 import { TablesEditor } from '../TablesEditor';
@@ -29,16 +28,16 @@ function findTableAndCellNodes(
     let tableNode: TableNode | undefined;
     let cellNode: TableCellNode | undefined;
 
-    const isEditor = isEditorObject(editorOrTable) && TablesEditor.isTablesEditor(editorOrTable);
-    const isLocation = Location.isLocation(locationOrCell);
+    const isEditor = NodeApi.isEditor(editorOrTable) && TablesEditor.isTablesEditor(editorOrTable);
+    const isLocation = LocationApi.isLocation(locationOrCell);
 
     if (isEditor || isLocation || locationOrCell === null) {
         if (isEditor) {
             const editor = editorOrTable;
             const location = locationOrCell ?? editor.selection;
 
-            if (Location.isLocation(location)) {
-                for (const [currentNodeToCheck] of getLevels(editor, { at: location })) {
+            if (LocationApi.isLocation(location)) {
+                for (const [currentNodeToCheck] of editor.api.levels({ at: location })) {
                     if (editor.isTableNode(currentNodeToCheck)) {
                         tableNode = currentNodeToCheck;
                     }

diff --git a/packages/slate-tables/src/withTables.ts b/packages/slate-tables/src/withTables.ts
@@ -1,4 +1,4 @@
-import type { SlateEditor } from '@udecode/plate-common';
+import type { SlateEditor } from '@udecode/plate';
 
 import type { TablesEditor, TablesSchema } from './TablesEditor';
 import { withNormalization } from './withNormalization';

diff --git a/packages/slate-types/src/nodes/ElementNode.ts b/packages/slate-types/src/nodes/ElementNode.ts
@@ -1,8 +1,8 @@
-import type { TElement } from '@udecode/plate-common';
+import type { Element } from '@udecode/plate';
 
 import { isObject } from './validation';
 
-export interface ElementNode extends TElement {
+export interface ElementNode extends Element {
     type: string;
 }
 

diff --git a/packages/slate-types/src/nodes/TableNode.ts b/packages/slate-types/src/nodes/TableNode.ts
@@ -1,5 +1,4 @@
-import type { TNode } from '@udecode/plate-common';
-import type { Node } from 'slate';
+import { type Node } from '@udecode/plate';
 
 import { type ElementNode, isElementNode } from './ElementNode';
 
@@ -27,14 +26,14 @@ export interface TableCellNode extends ElementNode {
     colspan?: number;
 }
 
-export function isTableNode(value: Node | TNode): value is TableNode {
+export function isTableNode(value: Node): value is TableNode {
     return isElementNode<TableNode>(value, TABLE_NODE_TYPE);
 }
 
-export function isTableCellNode(value: Node | TNode): value is TableCellNode {
+export function isTableCellNode(value: Node): value is TableCellNode {
     return isElementNode<TableCellNode>(value, TABLE_CELL_NODE_TYPE);
 }
 
-export function isTableRowNode(value: Node | TNode): value is TableRowNode {
+export function isTableRowNode(value: Node): value is TableRowNode {
     return isElementNode<TableRowNode>(value, TABLE_ROW_NODE_TYPE);
 }