@lexical/table 0.12.6 → 0.13.0

package/LexicalTableSelection.d.ts

@@ -5,47 +5,48 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import type { LexicalEditor, NodeKey, TextFormatType } from 'lexical';
-import { type GridSelection } from './LexicalGridSelection';
-export type Cell = {
-    elem: HTMLElement;
-    highlighted: boolean;
-    hasBackgroundColor: boolean;
-    x: number;
-    y: number;
+import { BaseSelection, LexicalNode, NodeKey, PointType } from 'lexical';
+import { TableCellNode } from './LexicalTableCellNode';
+export type TableSelectionShape = {
+    fromX: number;
+    fromY: number;
+    toX: number;
+    toY: number;
 };
-export type Cells = Array<Array<Cell | undefined> | undefined>;
-export type Grid = {
-    cells: Cells;
-    columns: number;
-    rows: number;
+export type TableMapValueType = {
+    cell: TableCellNode;
+    startRow: number;
+    startColumn: number;
 };
-export declare class TableSelection {
-    focusX: number;
-    focusY: number;
-    listenersToRemove: Set<() => void>;
-    grid: Grid;
-    isHighlightingCells: boolean;
-    anchorX: number;
-    anchorY: number;
-    tableNodeKey: NodeKey;
-    anchorCell: Cell | null;
-    focusCell: Cell | null;
-    anchorCellNodeKey: NodeKey | null;
-    focusCellNodeKey: NodeKey | null;
-    editor: LexicalEditor;
-    gridSelection: GridSelection | null;
-    hasHijackedSelectionStyles: boolean;
-    constructor(editor: LexicalEditor, tableNodeKey: string);
-    getGrid(): Grid;
-    removeListeners(): void;
-    trackTableGrid(): void;
-    clearHighlight(): void;
-    enableHighlightStyle(): void;
-    disableHighlightStyle(): void;
-    updateTableGridSelection(selection: GridSelection | null): void;
-    setFocusCellForSelection(cell: Cell, ignoreStart?: boolean): void;
-    setAnchorCellForSelection(cell: Cell): void;
-    formatCells(type: TextFormatType): void;
-    clearText(): void;
+export type TableMapType = Array<Array<TableMapValueType>>;
+export declare class TableSelection implements BaseSelection {
+    tableKey: NodeKey;
+    anchor: PointType;
+    focus: PointType;
+    _cachedNodes: Array<LexicalNode> | null;
+    dirty: boolean;
+    constructor(tableKey: NodeKey, anchor: PointType, focus: PointType);
+    getStartEndPoints(): [PointType, PointType];
+    /**
+     * Returns whether the Selection is "backwards", meaning the focus
+     * logically precedes the anchor in the EditorState.
+     * @returns true if the Selection is backwards, false otherwise.
+     */
+    isBackward(): boolean;
+    getCachedNodes(): LexicalNode[] | null;
+    setCachedNodes(nodes: LexicalNode[] | null): void;
+    is(selection: null | BaseSelection): boolean;
+    set(tableKey: NodeKey, anchorCellKey: NodeKey, focusCellKey: NodeKey): void;
+    clone(): TableSelection;
+    isCollapsed(): boolean;
+    extract(): Array<LexicalNode>;
+    insertRawText(text: string): void;
+    insertText(): void;
+    insertNodes(nodes: Array<LexicalNode>): void;
+    getShape(): TableSelectionShape;
+    getNodes(): Array<LexicalNode>;
+    getTextContent(): string;
 }
+export declare function $isTableSelection(x: unknown): x is TableSelection;
+export declare function $createTableSelection(): TableSelection;
+export declare function $getChildrenRecursively(node: LexicalNode): Array<LexicalNode>;

package/LexicalTableSelectionHelpers.d.ts

@@ -5,24 +5,24 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import type { GridSelection } from './LexicalGridSelection';
 import type { TableNode } from './LexicalTableNode';
-import type { Cell, Grid } from './LexicalTableSelection';
+import type { TableDOMCell } from './LexicalTableObserver';
+import type { TableSelection } from './LexicalTableSelection';
 import type { LexicalEditor, LexicalNode, RangeSelection } from 'lexical';
-import { TableSelection } from './LexicalTableSelection';
+import { TableDOMTable, TableObserver } from './LexicalTableObserver';
 declare const LEXICAL_ELEMENT_KEY = "__lexicalTableSelection";
-export declare function applyTableHandlers(tableNode: TableNode, tableElement: HTMLTableElementWithWithTableSelectionState, editor: LexicalEditor, hasTabHandler: boolean): TableSelection;
-export type HTMLTableElementWithWithTableSelectionState = HTMLTableElement & Record<typeof LEXICAL_ELEMENT_KEY, TableSelection>;
-export declare function attachTableSelectionToTableElement(tableElement: HTMLTableElementWithWithTableSelectionState, tableSelection: TableSelection): void;
-export declare function getTableSelectionFromTableElement(tableElement: HTMLTableElementWithWithTableSelectionState): TableSelection | null;
-export declare function getCellFromTarget(node: Node): Cell | null;
+export declare function applyTableHandlers(tableNode: TableNode, tableElement: HTMLTableElementWithWithTableSelectionState, editor: LexicalEditor, hasTabHandler: boolean): TableObserver;
+export type HTMLTableElementWithWithTableSelectionState = HTMLTableElement & Record<typeof LEXICAL_ELEMENT_KEY, TableObserver>;
+export declare function attachTableObserverToTableElement(tableElement: HTMLTableElementWithWithTableSelectionState, tableObserver: TableObserver): void;
+export declare function getTableObserverFromTableElement(tableElement: HTMLTableElementWithWithTableSelectionState): TableObserver | null;
+export declare function getDOMCellFromTarget(node: Node): TableDOMCell | null;
 export declare function doesTargetContainText(node: Node): boolean;
-export declare function getTableGrid(tableElement: HTMLElement): Grid;
-export declare function $updateDOMForSelection(editor: LexicalEditor, grid: Grid, selection: GridSelection | RangeSelection | null): void;
-export declare function $forEachGridCell(grid: Grid, cb: (cell: Cell, lexicalNode: LexicalNode, cords: {
+export declare function getTable(tableElement: HTMLElement): TableDOMTable;
+export declare function $updateDOMForSelection(editor: LexicalEditor, table: TableDOMTable, selection: TableSelection | RangeSelection | null): void;
+export declare function $forEachTableCell(grid: TableDOMTable, cb: (cell: TableDOMCell, lexicalNode: LexicalNode, cords: {
     x: number;
     y: number;
 }) => void): void;
-export declare function $addHighlightStyleToTable(editor: LexicalEditor, tableSelection: TableSelection): void;
-export declare function $removeHighlightStyleToTable(editor: LexicalEditor, tableSelection: TableSelection): void;
+export declare function $addHighlightStyleToTable(editor: LexicalEditor, tableSelection: TableObserver): void;
+export declare function $removeHighlightStyleToTable(editor: LexicalEditor, tableObserver: TableObserver): void;
 export {};

package/LexicalTableUtils.d.ts

@@ -5,11 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import type { Grid } from './LexicalTableSelection';
+import type { TableMapType, TableMapValueType } from './LexicalTableSelection';
+import type { PointType } from 'lexical';
 import { LexicalNode } from 'lexical';
 import { InsertTableCommandPayloadHeaders } from '.';
 import { TableCellNode } from './LexicalTableCellNode';
 import { TableNode } from './LexicalTableNode';
+import { TableDOMTable } from './LexicalTableObserver';
 import { TableRowNode } from './LexicalTableRowNode';
 export declare function $createTableNodeWithDimensions(rowCount: number, columnCount: number, includeHeaders?: InsertTableCommandPayloadHeaders): TableNode;
 export declare function $getTableCellNodeFromLexicalNode(startingNode: LexicalNode): TableCellNode | null;
@@ -23,13 +25,21 @@ export type TableCellSiblings = {
     left: TableCellNode | null | undefined;
     right: TableCellNode | null | undefined;
 };
-export declare function $getTableCellSiblingsFromTableCellNode(tableCellNode: TableCellNode, grid: Grid): TableCellSiblings;
+export declare function $getTableCellSiblingsFromTableCellNode(tableCellNode: TableCellNode, table: TableDOMTable): TableCellSiblings;
 export declare function $removeTableRowAtIndex(tableNode: TableNode, indexToDelete: number): TableNode;
-export declare function $insertTableRow(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, rowCount: number, grid: Grid): TableNode;
+export declare function $insertTableRow(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, rowCount: number, table: TableDOMTable): TableNode;
 export declare function $insertTableRow__EXPERIMENTAL(insertAfter?: boolean): void;
-export declare function $insertTableColumn(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, columnCount: number, grid: Grid): TableNode;
+export declare function $insertTableColumn(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, columnCount: number, table: TableDOMTable): TableNode;
 export declare function $insertTableColumn__EXPERIMENTAL(insertAfter?: boolean): void;
 export declare function $deleteTableColumn(tableNode: TableNode, targetIndex: number): TableNode;
 export declare function $deleteTableRow__EXPERIMENTAL(): void;
 export declare function $deleteTableColumn__EXPERIMENTAL(): void;
 export declare function $unmergeCell(): void;
+export declare function $computeTableMap(grid: TableNode, cellA: TableCellNode, cellB: TableCellNode): [TableMapType, TableMapValueType, TableMapValueType];
+export declare function $getNodeTriplet(source: PointType | LexicalNode | TableCellNode): [TableCellNode, TableRowNode, TableNode];
+export declare function $getTableCellNodeRect(tableCellNode: TableCellNode): {
+    rowIndex: number;
+    columnIndex: number;
+    rowSpan: number;
+    colSpan: number;
+} | null;

package/index.d.ts

@@ -6,27 +6,18 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-import type { LexicalCommand } from 'lexical';
-export type { GridSelection, GridSelectionShape } from './LexicalGridSelection';
-export { $createGridSelection, $isGridSelection } from './LexicalGridSelection';
 export type { SerializedTableCellNode } from './LexicalTableCellNode';
 export { $createTableCellNode, $isTableCellNode, TableCellHeaderStates, TableCellNode, } from './LexicalTableCellNode';
+export type { InsertTableCommandPayload, InsertTableCommandPayloadHeaders, } from './LexicalTableCommands';
+export { INSERT_TABLE_COMMAND } from './LexicalTableCommands';
 export type { SerializedTableNode } from './LexicalTableNode';
-export { $createTableNode, $getElementGridForTableNode, $isTableNode, TableNode, } from './LexicalTableNode';
+export { $createTableNode, $getElementForTableNode, $isTableNode, TableNode, } from './LexicalTableNode';
+export type { TableDOMCell } from './LexicalTableObserver';
+export { TableObserver } from './LexicalTableObserver';
 export type { SerializedTableRowNode } from './LexicalTableRowNode';
 export { $createTableRowNode, $isTableRowNode, TableRowNode, } from './LexicalTableRowNode';
-export type { Cell } from './LexicalTableSelection';
-export { TableSelection } from './LexicalTableSelection';
+export type { TableSelection, TableSelectionShape, } from './LexicalTableSelection';
+export { $createTableSelection, $isTableSelection, } from './LexicalTableSelection';
 export type { HTMLTableElementWithWithTableSelectionState } from './LexicalTableSelectionHelpers';
-export { applyTableHandlers, getCellFromTarget, getTableSelectionFromTableElement, } from './LexicalTableSelectionHelpers';
-export { $createTableNodeWithDimensions, $deleteTableColumn, $deleteTableColumn__EXPERIMENTAL, $deleteTableRow__EXPERIMENTAL, $getTableCellNodeFromLexicalNode, $getTableColumnIndexFromTableCellNode, $getTableNodeFromLexicalNodeOrThrow, $getTableRowIndexFromTableCellNode, $getTableRowNodeFromTableCellNodeOrThrow, $insertTableColumn, $insertTableColumn__EXPERIMENTAL, $insertTableRow, $insertTableRow__EXPERIMENTAL, $removeTableRowAtIndex, $unmergeCell, } from './LexicalTableUtils';
-export type InsertTableCommandPayloadHeaders = Readonly<{
-    rows: boolean;
-    columns: boolean;
-}> | boolean;
-export type InsertTableCommandPayload = Readonly<{
-    columns: string;
-    rows: string;
-    includeHeaders?: InsertTableCommandPayloadHeaders;
-}>;
-export declare const INSERT_TABLE_COMMAND: LexicalCommand<InsertTableCommandPayload>;
+export { applyTableHandlers, getDOMCellFromTarget, getTableObserverFromTableElement, } from './LexicalTableSelectionHelpers';
+export { $computeTableMap, $createTableNodeWithDimensions, $deleteTableColumn, $deleteTableColumn__EXPERIMENTAL, $deleteTableRow__EXPERIMENTAL, $getNodeTriplet, $getTableCellNodeFromLexicalNode, $getTableCellNodeRect, $getTableColumnIndexFromTableCellNode, $getTableNodeFromLexicalNodeOrThrow, $getTableRowIndexFromTableCellNode, $getTableRowNodeFromTableCellNodeOrThrow, $insertTableColumn, $insertTableColumn__EXPERIMENTAL, $insertTableRow, $insertTableRow__EXPERIMENTAL, $removeTableRowAtIndex, $unmergeCell, } from './LexicalTableUtils';

package/package.json

@@ -8,13 +8,13 @@
     "table"
   ],
   "license": "MIT",
-  "version": "0.12.6",
+  "version": "0.13.0",
   "main": "LexicalTable.js",
   "peerDependencies": {
-    "lexical": "0.12.6"
+    "lexical": "0.13.0"
   },
   "dependencies": {
-    "@lexical/utils": "0.12.6"
+    "@lexical/utils": "0.13.0"
   },
   "repository": {
     "type": "git",

package/LexicalGridSelection.d.ts

@@ -1,34 +0,0 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- */
-import { BaseSelection, INTERNAL_PointSelection, LexicalNode, NodeKey, PointType } from 'lexical';
-export type GridSelectionShape = {
-    fromX: number;
-    fromY: number;
-    toX: number;
-    toY: number;
-};
-export declare class GridSelection extends INTERNAL_PointSelection {
-    gridKey: NodeKey;
-    constructor(gridKey: NodeKey, anchor: PointType, focus: PointType);
-    getCachedNodes(): LexicalNode[] | null;
-    setCachedNodes(nodes: LexicalNode[] | null): void;
-    is(selection: null | BaseSelection): boolean;
-    set(gridKey: NodeKey, anchorCellKey: NodeKey, focusCellKey: NodeKey): void;
-    clone(): GridSelection;
-    isCollapsed(): boolean;
-    extract(): Array<LexicalNode>;
-    insertRawText(text: string): void;
-    insertText(): void;
-    insertNodes(nodes: Array<LexicalNode>): void;
-    getShape(): GridSelectionShape;
-    getNodes(): Array<LexicalNode>;
-    getTextContent(): string;
-}
-export declare function $isGridSelection(x: unknown): x is GridSelection;
-export declare function $createGridSelection(): GridSelection;
-export declare function $getChildrenRecursively(node: LexicalNode): Array<LexicalNode>;