lexical 0.2.1 → 0.2.4

package/Lexical.d.ts

@@ -36,6 +36,7 @@ export var KEY_BACKSPACE_COMMAND: LexicalCommand<KeyboardEvent>;
 export var KEY_ESCAPE_COMMAND: LexicalCommand<KeyboardEvent>;
 export var KEY_DELETE_COMMAND: LexicalCommand<KeyboardEvent>;
 export var KEY_TAB_COMMAND: LexicalCommand<KeyboardEvent>;
+export var KEY_MODIFIER_COMMAND: LexicalCommand<KeyboardEvent>;
 export var INDENT_CONTENT_COMMAND: LexicalCommand<void>;
 export var OUTDENT_CONTENT_COMMAND: LexicalCommand<void>;
 export var DROP_COMMAND: LexicalCommand<DragEvent>;
@@ -53,7 +54,6 @@ export var INSERT_TABLE_COMMAND: LexicalCommand<{
   rows: string;
   columns: string;
 }>;
-export var READ_ONLY_COMMAND: LexicalCommand<void>;
 
 export declare function createCommand<T>(): LexicalCommand<T>;
 
@@ -145,7 +145,7 @@ export declare class LexicalEditor {
     klass: Class<T>,
     listener: Transform<T>,
   ): () => void;
-  dispatchCommand(type: string, payload: P): boolean;
+  dispatchCommand<P>(type: string, payload: P): boolean;
   hasNodes(nodes: Array<Class<LexicalNode>>): boolean;
   getDecorators<X>(): Record<NodeKey, X>;
   getRootElement(): null | HTMLElement;
@@ -222,17 +222,12 @@ export type EditorConfig<EditorContext> = {
   context: EditorContext;
   disableEvents?: boolean;
 };
-export type CommandListenerEditorPriority = 0;
-export type CommandListenerLowPriority = 1;
-export type CommandListenerNormalPriority = 2;
-export type CommandListenerHighPriority = 3;
-export type CommandListenerCriticalPriority = 4;
-type CommandListenerPriority =
-  | CommandListenerEditorPriority
-  | CommandListenerLowPriority
-  | CommandListenerNormalPriority
-  | CommandListenerHighPriority
-  | CommandListenerCriticalPriority;
+export type CommandListenerPriority = 0 | 1 | 2 | 3 | 4;
+export const COMMAND_PRIORITY_EDITOR = 0;
+export const COMMAND_PRIORITY_LOW = 1;
+export const COMMAND_PRIORITY_NORMAL = 2;
+export const COMMAND_PRIORITY_HIGH = 3;
+export const COMMAND_PRIORITY_CRITICAL = 4;
 export type IntentionallyMarkedAsDirtyElement = boolean;
 export function createEditor<EditorContext>(editorConfig?: {
   namespace?: string;
@@ -298,8 +293,8 @@ export type DOMConversionFn = (
 ) => DOMConversionOutput;
 export type DOMChildConversion = (
   lexicalNode: LexicalNode,
-  parentLexicalNode: ?(LexicalNode | null),
-) => ?(LexicalNode | void | null);
+  parentLexicalNode: LexicalNode | null,
+) => LexicalNode | void | null;
 export type DOMConversionMap = Record<
   NodeName,
   (node: Node) => DOMConversion | null
@@ -311,7 +306,7 @@ export type DOMConversionOutput = {
   node: LexicalNode | null;
 };
 export type DOMExportOutput = {
-  after?: (generatedElement: ?HTMLElement) => ?HTMLElement;
+  after?: (generatedElement: HTMLElement | null) => HTMLElement | null;
   element: HTMLElement | null;
 };
 export type NodeKey = string;
@@ -366,7 +361,7 @@ export declare class LexicalNode {
     dom: HTMLElement,
     config: EditorConfig<EditorContext>,
   ): boolean;
-  remove(): void;
+  remove(preserveEmptyParent?: boolean): void;
   replace<N extends LexicalNode>(replaceWith: N): N;
   insertAfter(nodeToInsert: LexicalNode): LexicalNode;
   insertBefore(nodeToInsert: LexicalNode): LexicalNode;
@@ -440,7 +435,9 @@ export declare class GridSelection {
   getNodes(): Array<LexicalNode>;
   getTextContent(): string;
 }
-export function $isGridSelection(x: unknown | null | undefined): boolean;
+export function $isGridSelection(
+  x: unknown | null | undefined,
+): x is GridSelection;
 export declare class NodeSelection {
   _nodes: Set<NodeKey>;
   dirty: boolean;
@@ -457,7 +454,9 @@ export declare class NodeSelection {
   getNodes(): Array<LexicalNode>;
   getTextContent(): string;
 }
-export function $isNodeSelection(x: unknown | null | undefined): boolean;
+export function $isNodeSelection(
+  x: unknown | null | undefined,
+): x is NodeSelection;
 export declare class RangeSelection {
   anchor: PointType;
   focus: PointType;
@@ -539,7 +538,9 @@ declare class _Point {
 export function $createRangeSelection(): RangeSelection;
 export function $createNodeSelection(): NodeSelection;
 export function $createGridSelection(): GridSelection;
-export function $isRangeSelection(x: unknown | null | undefined): boolean;
+export function $isRangeSelection(
+  x: unknown | null | undefined,
+): x is RangeSelection;
 export function $getSelection():
   | null
   | RangeSelection
@@ -569,8 +570,8 @@ export declare class TextNode extends LexicalNode {
   __style: string;
   __mode: 0 | 1 | 2 | 3;
   __detail: number;
-  getType(): string;
-  clone(node: any): TextNode;
+  static getType(): string;
+  static clone(node: any): TextNode;
   constructor(text: string, key?: NodeKey);
   getFormat(): number;
   getStyle(): string;
@@ -617,29 +618,33 @@ export declare class TextNode extends LexicalNode {
   mergeWithSibling(target: TextNode): TextNode;
 }
 export function $createTextNode(text?: string): TextNode;
-export function $isTextNode(node: LexicalNode | null | undefined): boolean;
+export function $isTextNode(
+  node: LexicalNode | null | undefined,
+): node is TextNode;
 
 /**
  * LexicalLineBreakNode
  */
 export declare class LineBreakNode extends LexicalNode {
-  getType(): string;
-  clone(node: LineBreakNode): LineBreakNode;
+  static getType(): string;
+  static clone(node: LineBreakNode): LineBreakNode;
   constructor(key?: NodeKey);
   getTextContent(): '\n';
   createDOM(): HTMLElement;
   updateDOM(): false;
 }
 export function $createLineBreakNode(): LineBreakNode;
-export function $isLineBreakNode(node: LexicalNode | null | undefined): boolean;
+export function $isLineBreakNode(
+  node: LexicalNode | null | undefined,
+): node is LineBreakNode;
 
 /**
  * LexicalRootNode
  */
 export declare class RootNode extends ElementNode {
   __cachedText: null | string;
-  getType(): string;
-  clone(): RootNode;
+  static getType(): string;
+  static clone(): RootNode;
   constructor();
   getTextContent(includeInert?: boolean, includeDirectionless?: false): string;
   select(): RangeSelection;
@@ -651,7 +656,9 @@ export declare class RootNode extends ElementNode {
   append(...nodesToAppend: Array<LexicalNode>): ElementNode;
   canBeEmpty(): false;
 }
-export function $isRootNode(node: LexicalNode | null | undefined): boolean;
+export function $isRootNode(
+  node: LexicalNode | null | undefined,
+): node is RootNode;
 
 /**
  * LexicalElementNode
@@ -707,7 +714,9 @@ export declare class ElementNode extends LexicalNode {
     nodesToInsert: Array<LexicalNode>,
   ): ElementNode;
 }
-export function $isElementNode(node: LexicalNode | null | undefined): boolean;
+export function $isElementNode(
+  node: LexicalNode | null | undefined,
+): node is ElementNode;
 
 /**
  * LexicalDecoratorNode
@@ -716,15 +725,18 @@ export declare class DecoratorNode<X> extends LexicalNode {
   constructor(key?: NodeKey);
   decorate(editor: LexicalEditor): X;
   isIsolated(): boolean;
+  isTopLevel(): boolean;
 }
-export function $isDecoratorNode(node: LexicalNode | null | undefined): boolean;
+export function $isDecoratorNode(
+  node: LexicalNode | null | undefined,
+): node is DecoratorNode<unknown>;
 
 /**
  * LexicalHorizontalRuleNode
  */
 export declare class HorizontalRuleNode extends LexicalNode {
-  getType(): string;
-  clone(node: HorizontalRuleNode): HorizontalRuleNode;
+  static getType(): string;
+  static clone(node: HorizontalRuleNode): HorizontalRuleNode;
   constructor(key?: NodeKey);
   createDOM(): HTMLElement;
   updateDOM(): false;
@@ -747,16 +759,24 @@ export declare class ParagraphNode extends ElementNode {
   collapseAtStart(): boolean;
 }
 export function $createParagraphNode(): ParagraphNode;
-export function $isParagraphNode(node: LexicalNode | null | undefined): boolean;
+export function $isParagraphNode(
+  node: LexicalNode | null | undefined,
+): node is ParagraphNode;
 export declare class GridNode extends ElementNode {}
-export function $isGridNode(node: LexicalNode | null | undefined): boolean;
+export function $isGridNode(
+  node: LexicalNode | null | undefined,
+): node is GridNode;
 export declare class GridRowNode extends ElementNode {}
-export function $isGridRowNode(node: LexicalNode | null | undefined): boolean;
+export function $isGridRowNode(
+  node: LexicalNode | null | undefined,
+): node is GridRowNode;
 export declare class GridCellNode extends ElementNode {
   __colSpan: number;
   constructor(colSpan: number, key?: NodeKey);
 }
-export function $isGridCellNode(node: LexicalNode | null | undefined): boolean;
+export function $isGridCellNode(
+  node: LexicalNode | null | undefined,
+): node is GridCellNode;
 
 /**
  * LexicalUtils