@examind/block-types 0.1.18

package/types/lexical/table/LexicalTableSelection.ts

@@ -0,0 +1,74 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+import { BaseSelection, LexicalNode, NodeKey, PointType, TextFormatType } from './../';
+import { TableCellNode } from './LexicalTableCellNode';
+import { TableNode } from './LexicalTableNode';
+export type TableSelectionShape = {
+    fromX: number;
+    fromY: number;
+    toX: number;
+    toY: number;
+};
+export type TableMapValueType = {
+    cell: TableCellNode;
+    startRow: number;
+    startColumn: number;
+};
+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];
+    /**
+     * {@link $createTableSelection} unfortunately makes it very easy to create
+     * nonsense selections, so we have a method to see if the selection probably
+     * makes sense.
+     *
+     * @returns true if the TableSelection is (probably) valid
+     */
+    isValid(): boolean;
+    /**
+     * 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;
+    /**
+     * Returns whether the provided TextFormatType is present on the Selection.
+     * This will be true if any paragraph in table cells has the specified format.
+     *
+     * @param type the TextFormatType to check for.
+     * @returns true if the provided format is currently toggled on on the Selection, false otherwise.
+     */
+    hasFormat(type: TextFormatType): boolean;
+    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 $createTableSelectionFrom(tableNode: TableNode, anchorCell: TableCellNode, focusCell: TableCellNode): TableSelection;
+/**
+ * Depth first visitor
+ * @param node The starting node
+ * @param $visit The function to call for each node. If the function returns false, then children of this node will not be explored
+ */
+export declare function $visitRecursively(node: LexicalNode, $visit: (childNode: LexicalNode) => boolean | undefined | void): void;

package/types/lexical/table/LexicalTableSelectionHelpers.ts

@@ -0,0 +1,40 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+import type { TableCellNode } from './LexicalTableCellNode';
+import type { TableDOMCell } from './LexicalTableObserver';
+import type { TableSelection } from './LexicalTableSelection';
+import type { EditorState, LexicalEditor, LexicalNode, RangeSelection } from './../';
+import { TableNode } from './LexicalTableNode';
+import { TableDOMTable, TableObserver } from './LexicalTableObserver';
+declare const LEXICAL_ELEMENT_KEY = "__lexicalTableSelection";
+export declare function isHTMLTableElement(el: unknown): el is HTMLTableElement;
+export declare function getTableElement<T extends HTMLElement | null>(tableNode: TableNode, dom: T): HTMLTableElementWithWithTableSelectionState | (T & null);
+export declare function getEditorWindow(editor: LexicalEditor): Window | null;
+export declare function $findParentTableCellNodeInTable(tableNode: LexicalNode, node: LexicalNode | null): TableCellNode | null;
+export declare function applyTableHandlers(tableNode: TableNode, element: HTMLElement, editor: LexicalEditor, hasTabHandler: boolean): TableObserver;
+export type HTMLTableElementWithWithTableSelectionState = HTMLTableElement & {
+    [LEXICAL_ELEMENT_KEY]?: TableObserver | undefined;
+};
+export declare function detachTableObserverFromTableElement(tableElement: HTMLTableElementWithWithTableSelectionState, tableObserver: TableObserver): void;
+export declare function attachTableObserverToTableElement(tableElement: HTMLTableElementWithWithTableSelectionState, tableObserver: TableObserver): void;
+export declare function getTableObserverFromTableElement(tableElement: HTMLTableElementWithWithTableSelectionState): TableObserver | null;
+export declare function getDOMCellFromTarget(node: null | Node): TableDOMCell | null;
+export declare function getDOMCellInTableFromTarget(table: HTMLTableElementWithWithTableSelectionState, node: null | Node): TableDOMCell | null;
+export declare function doesTargetContainText(node: Node): boolean;
+export declare function getTable(tableNode: TableNode, dom: 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: TableObserver): void;
+export declare function $removeHighlightStyleToTable(editor: LexicalEditor, tableObserver: TableObserver): void;
+export declare function $findCellNode(node: LexicalNode): null | TableCellNode;
+export declare function $findTableNode(node: LexicalNode): null | TableNode;
+export declare function $getObserverCellFromCellNodeOrThrow(tableObserver: TableObserver, tableCellNode: TableCellNode): TableDOMCell;
+export declare function $getNearestTableCellInTableFromDOMNode(tableNode: TableNode, startingDOM: Node, editorState?: EditorState): TableCellNode | null;
+export {};

package/types/lexical/table/LexicalTableUtils.ts

@@ -0,0 +1,112 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+import type { TableMapType, TableMapValueType } from './LexicalTableSelection';
+import type { PointType } from './../';
+import { LexicalNode } from './../';
+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;
+export declare function $getTableRowNodeFromTableCellNodeOrThrow(startingNode: LexicalNode): TableRowNode;
+export declare function $getTableNodeFromLexicalNodeOrThrow(startingNode: LexicalNode): TableNode;
+export declare function $getTableRowIndexFromTableCellNode(tableCellNode: TableCellNode): number;
+export declare function $getTableColumnIndexFromTableCellNode(tableCellNode: TableCellNode): number;
+export type TableCellSiblings = {
+    above: TableCellNode | null | undefined;
+    below: TableCellNode | null | undefined;
+    left: TableCellNode | null | undefined;
+    right: TableCellNode | null | undefined;
+};
+export declare function $getTableCellSiblingsFromTableCellNode(tableCellNode: TableCellNode, table: TableDOMTable): TableCellSiblings;
+export declare function $removeTableRowAtIndex(tableNode: TableNode, indexToDelete: number): TableNode;
+/**
+ * @deprecated This function does not support merged cells. Use {@link $insertTableRowAtSelection} or {@link $insertTableRowAtNode} instead.
+ */
+export declare function $insertTableRow(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, rowCount: number, table: TableDOMTable): TableNode;
+/**
+ * Inserts a table row before or after the current focus cell node,
+ * taking into account any spans. If successful, returns the
+ * inserted table row node.
+ */
+export declare function $insertTableRowAtSelection(insertAfter?: boolean): TableRowNode | null;
+/**
+ * @deprecated renamed to {@link $insertTableRowAtSelection}
+ */
+export declare const $insertTableRow__EXPERIMENTAL: typeof $insertTableRowAtSelection;
+/**
+ * Inserts a table row before or after the given cell node,
+ * taking into account any spans. If successful, returns the
+ * inserted table row node.
+ */
+export declare function $insertTableRowAtNode(cellNode: TableCellNode, insertAfter?: boolean): TableRowNode | null;
+/**
+ * @deprecated This function does not support merged cells. Use {@link $insertTableColumnAtSelection} or {@link $insertTableColumnAtNode} instead.
+ */
+export declare function $insertTableColumn(tableNode: TableNode, targetIndex: number, shouldInsertAfter: boolean | undefined, columnCount: number, table: TableDOMTable): TableNode;
+/**
+ * Inserts a column before or after the current focus cell node,
+ * taking into account any spans. If successful, returns the
+ * first inserted cell node.
+ */
+export declare function $insertTableColumnAtSelection(insertAfter?: boolean): TableCellNode | null;
+/**
+ * @deprecated renamed to {@link $insertTableColumnAtSelection}
+ */
+export declare const $insertTableColumn__EXPERIMENTAL: typeof $insertTableColumnAtSelection;
+/**
+ * Inserts a column before or after the given cell node,
+ * taking into account any spans. If successful, returns the
+ * first inserted cell node.
+ */
+export declare function $insertTableColumnAtNode(cellNode: TableCellNode, insertAfter?: boolean, shouldSetSelection?: boolean): TableCellNode | null;
+/**
+ * @deprecated This function does not support merged cells. Use {@link $deleteTableColumnAtSelection} instead.
+ */
+export declare function $deleteTableColumn(tableNode: TableNode, targetIndex: number): TableNode;
+export declare function $deleteTableRowAtSelection(): void;
+/**
+ * @deprecated renamed to {@link $deleteTableRowAtSelection}
+ */
+export declare const $deleteTableRow__EXPERIMENTAL: typeof $deleteTableRowAtSelection;
+export declare function $deleteTableColumnAtSelection(): void;
+/**
+ * @deprecated renamed to {@link $deleteTableColumnAtSelection}
+ */
+export declare const $deleteTableColumn__EXPERIMENTAL: typeof $deleteTableColumnAtSelection;
+export declare function $mergeCells(cellNodes: TableCellNode[]): TableCellNode | null;
+export declare function $unmergeCell(): void;
+export declare function $unmergeCellNode(cellNode: TableCellNode): void;
+export declare function $computeTableMap(tableNode: TableNode, cellA: TableCellNode, cellB: TableCellNode): [TableMapType, TableMapValueType, TableMapValueType];
+export declare function $computeTableMapSkipCellCheck(tableNode: TableNode, cellA: null | TableCellNode, cellB: null | TableCellNode): [
+    tableMap: TableMapType,
+    cellAValue: TableMapValueType | null,
+    cellBValue: TableMapValueType | null
+];
+export declare function $getNodeTriplet(source: PointType | LexicalNode | TableCellNode): [TableCellNode, TableRowNode, TableNode];
+export interface TableCellRectBoundary {
+    minColumn: number;
+    minRow: number;
+    maxColumn: number;
+    maxRow: number;
+}
+export interface TableCellRectSpans {
+    topSpan: number;
+    leftSpan: number;
+    rightSpan: number;
+    bottomSpan: number;
+}
+export declare function $computeTableCellRectSpans(map: TableMapType, boundary: TableCellRectBoundary): TableCellRectSpans;
+export declare function $computeTableCellRectBoundary(map: TableMapType, cellAMap: TableMapValueType, cellBMap: TableMapValueType): TableCellRectBoundary;
+export declare function $getTableCellNodeRect(tableCellNode: TableCellNode): {
+    rowIndex: number;
+    columnIndex: number;
+    rowSpan: number;
+    colSpan: number;
+} | null;

package/types/lexical/table/constants.ts

@@ -0,0 +1,8 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+export declare const PIXEL_VALUE_REG_EXP: RegExp;
+export declare const COLUMN_WIDTH = 75;

package/types/lexical/table/index.ts

@@ -0,0 +1,16 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+export * from './LexicalTableCellNode';
+export * from './LexicalTableCommands';
+export * from './LexicalTableNode';
+export * from './LexicalTableObserver';
+export * from './LexicalTablePluginHelpers';
+export * from './LexicalTableRowNode';
+export * from './LexicalTableSelection';
+export * from './LexicalTableSelectionHelpers';
+export * from './LexicalTableUtils';
+export * from './constants';