lexical 0.1.16 → 0.1.17

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Dominic Gannaway
+Copyright (c) Meta Platforms, Inc. and affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/Lexical.d.ts

@@ -8,6 +8,55 @@
 
 import {Class, $ReadOnly} from 'utility-types';
 
+/**
+ * LexicalCommands
+ */
+
+export type LexicalCommand<P> = $ReadOnly<{}>;
+
+export var SELECTION_CHANGE_COMMAND: LexicalCommand<void>;
+export var CLICK_COMMAND: LexicalCommand<MouseEvent>;
+export var DELETE_CHARACTER_COMMAND: LexicalCommand<boolean>;
+export var INSERT_LINE_BREAK_COMMAND: LexicalCommand<boolean>;
+export var INSERT_PARAGRAPH_COMMAND: LexicalCommand<void>;
+export var INSERT_TEXT_COMMAND: LexicalCommand<InputEvent | string>;
+export var PASTE_COMMAND: LexicalCommand<ClipboardEvent>;
+export var REMOVE_TEXT_COMMAND: LexicalCommand<void>;
+export var DELETE_WORD_COMMAND: LexicalCommand<boolean>;
+export var DELETE_LINE_COMMAND: LexicalCommand<boolean>;
+export var FORMAT_TEXT_COMMAND: LexicalCommand<TextFormatType>;
+export var UNDO_COMMAND: LexicalCommand<void>;
+export var REDO_COMMAND: LexicalCommand<void>;
+export var KEY_ARROW_RIGHT_COMMAND: LexicalCommand<KeyboardEvent>;
+export var KEY_ARROW_LEFT_COMMAND: LexicalCommand<KeyboardEvent>;
+export var KEY_ARROW_UP_COMMAND: LexicalCommand<KeyboardEvent>;
+export var KEY_ARROW_DOWN_COMMAND: LexicalCommand<KeyboardEvent>;
+export var KEY_ENTER_COMMAND: LexicalCommand<KeyboardEvent>;
+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 INDENT_CONTENT_COMMAND: LexicalCommand<void>;
+export var OUTDENT_CONTENT_COMMAND: LexicalCommand<void>;
+export var DROP_COMMAND: LexicalCommand<DragEvent>;
+export var FORMAT_ELEMENT_COMMAND: LexicalCommand<ElementFormatType>;
+export var DRAGSTART_COMMAND: LexicalCommand<DragEvent>;
+export var COPY_COMMAND: LexicalCommand<ClipboardEvent>;
+export var CUT_COMMAND: LexicalCommand<ClipboardEvent>;
+export var CLEAR_EDITOR_COMMAND: LexicalCommand<void>;
+export var CLEAR_HISTORY_COMMAND: LexicalCommand<void>;
+export var CAN_REDO_COMMAND: LexicalCommand<boolean>;
+export var CAN_UNDO_COMMAND: LexicalCommand<boolean>;
+export var FOCUS_COMMAND: LexicalCommand<FocusEvent>;
+export var BLUR_COMMAND: LexicalCommand<FocusEvent>;
+export var INSERT_TABLE_COMMAND: LexicalCommand<{
+  rows: string;
+  columns: string;
+}>;
+export var READ_ONLY_COMMAND: LexicalCommand<void>;
+
+export declare function createCommand<T>(): LexicalCommand<T>;
+
 /**
  * LexicalEditor
  */
@@ -29,21 +78,18 @@ type RootListener = (
 ) => void;
 type TextContentListener = (text: string) => void;
 type MutationListener = (nodes: Map<NodeKey, NodeMutation>) => void;
-type CommandListener = (
-  type: string,
-  payload: CommandPayload,
-  editor: LexicalEditor,
-) => boolean;
+type CommandListener<P> = (payload: P, editor: LexicalEditor) => boolean;
 export type ReadOnlyListener = (readOnly: boolean) => void;
 
-type CommandPayload = any;
+type InternalCommandListener = CommandListener<any>;
+
 type Listeners = {
   decorator: Set<DecoratorListener>;
   mutation: MutationListeners;
   textcontent: Set<TextContentListener>;
   root: Set<RootListener>;
   update: Set<UpdateListener>;
-  command: Array<Set<CommandListener>>;
+  command: Map<string, Array<Set<InternalCommandListener>>>;
 };
 type RegisteredNodes = Map<string, RegisteredNode>;
 type RegisteredNode = {
@@ -82,26 +128,25 @@ export declare class LexicalEditor {
   _key: string;
   _readOnly: boolean;
   isComposing(): boolean;
-  addListener(type: 'update', listener: UpdateListener): () => void;
-  addListener(type: 'root', listener: RootListener): () => void;
-  addListener(type: 'decorator', listener: DecoratorListener): () => void;
-  addListener(type: 'textcontent', listener: TextContentListener): () => void;
-  addListener(
-    type: 'command',
-    listener: CommandListener,
+  registerUpdateListener(listener: UpdateListener): () => void;
+  registerRootListener(listener: RootListener): () => void;
+  registerDecoratorListener(listener: DecoratorListener): () => void;
+  registerTextContentListener(listener: TextContentListener): () => void;
+  registerCommand<P>(
+    command: LexicalCommand<P>,
+    listener: CommandListener<P>,
     priority: CommandListenerPriority,
   ): () => void;
-  addListener(type: 'readonly', listener: ReadOnlyListener): () => void;
-  addListener(
-    type: 'mutation',
+  registerReadOnlyListener(listener: ReadOnlyListener): () => void;
+  registerMutationListener(
     klass: Class<LexicalNode>,
     listener: MutationListener,
   ): () => void;
-  addNodeTransform<T extends LexicalNode>(
+  registerNodeTransform<T extends LexicalNode>(
     klass: Class<T>,
     listener: Transform<T>,
   ): () => void;
-  execCommand(type: string, payload: CommandPayload): boolean;
+  dispatchCommand(type: string, payload: P): boolean;
   hasNodes(nodes: Array<Class<LexicalNode>>): boolean;
   getDecorators<X>(): Record<NodeKey, X>;
   getRootElement(): null | HTMLElement;
@@ -224,7 +269,7 @@ type JSONEditorState = {
   _nodeMap: Array<[NodeKey, LexicalNode]>;
   _selection: null | ParsedSelection;
 };
-export declare class EditorState {
+export interface EditorState {
   _nodeMap: NodeMap;
   _selection: null | RangeSelection | NodeSelection | GridSelection;
   _flushSync: boolean;
@@ -252,7 +297,10 @@ export type DOMConversionFn = (
   element: Node,
   parent?: Node,
 ) => DOMConversionOutput;
-export type DOMChildConversion = (lexicalNode: LexicalNode) => void;
+export type DOMChildConversion = (
+  lexicalNode: LexicalNode,
+  parentLexicalNode: ?(LexicalNode | null),
+) => ?(LexicalNode | void | null);
 export type DOMConversionMap = Record<
   NodeName,
   (node: Node) => DOMConversion | null