@modusoperandi/licit 1.4.2 → 1.4.6

package/ui/Editor.js.flow

@@ -1,281 +1,281 @@
-// @flow
-
-import cx from 'classnames';
-import { Schema } from 'prosemirror-model';
-import { EditorState, Transaction } from 'prosemirror-state';
-import { Transform } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-import * as React from 'react';
-import webfontloader from 'webfontloader';
-
-import {
-  exportJSON,
-  registerEditorView,
-  registeryKeys,
-  releaseEditorView,
-} from '../CZIProseMirror.js';
-import { BOOKMARK, LIST_ITEM } from '../NodeNames.js';
-import WebFontLoader from '../WebFontLoader.js';
-import { preLoadFonts } from '../FontTypeMarkSpec.js';
-import createEmptyEditorState from '../createEmptyEditorState.js';
-import normalizeHTML from '../normalizeHTML.js';
-import BookmarkNodeView from './BookmarkNodeView.js';
-import CustomEditorView from './CustomEditorView.js';
-import CustomNodeView from './CustomNodeView.js';
-import ListItemNodeView from './ListItemNodeView.js';
-import handleEditorDrop from './handleEditorDrop.js';
-import handleEditorKeyDown from './handleEditorKeyDown.js';
-import handleEditorPaste from './handleEditorPaste.js';
-import uuid from './uuid.js';
-import type { EditorRuntime } from '../Types.js';
-
-export type EditorProps = {
-  autoFocus?: ?boolean,
-  disabled?: ?boolean,
-  dispatchTransaction?: ?(tr: Transform) => void,
-  editorState?: ?EditorState,
-  embedded?: ?boolean,
-  onBlur?: ?() => void,
-  onChange?: ?(state: EditorState) => void,
-  onReady?: ?(view: EditorView) => void,
-  // Mapping for custom node views.
-  nodeViews?: ?{ [nodeName: string]: CustomNodeView },
-  placeholder?: ?(string | React.Element<any>),
-  readOnly?: ?boolean,
-  runtime?: ?EditorRuntime,
-  transformPastedHTML?: (html: string) => string,
-};
-
-// Export utilities for debugging.
-window.CZIProseMirror = {
-  exportJSON,
-  registeryKeys,
-};
-
-const AUTO_FOCUS_DELAY = 350;
-
-// Default custom node views.
-export const DEFAULT_NODE_VIEWS = Object.freeze({
-  [BOOKMARK]: BookmarkNodeView,
-  [LIST_ITEM]: ListItemNodeView,
-});
-
-const EDITOR_EMPTY_STATE = Object.freeze(createEmptyEditorState());
-
-// Monkey patch the `scrollIntoView` mathod of 'Transaction'.
-// Why this is necessary?
-// It appears that promse-mirror does call `scrollIntoView` extensively
-// from many of the built-in transformations, thus cause unwanted page
-// scrolls. To make the behavior more manageable, this patched method asks
-// developer to explicitly use `scrollIntoView(true)` to enforce page scroll.
-const scrollIntoView = Transaction.prototype.scrollIntoView;
-const scrollIntoViewPatched = function (forced: boolean): Transaction {
-  if (forced && scrollIntoView) {
-    return scrollIntoView.call(this);
-  } else {
-    return this;
-  }
-};
-Transaction.prototype.scrollIntoView = scrollIntoViewPatched;
-
-// Sets the implementation so that `FontTypeMarkSpec` can load custom fonts.
-WebFontLoader.setImplementation(webfontloader);
-// FS IRAD-988 2020-06-18
-preLoadFonts();
-
-const handleDOMEvents = {
-  drop: handleEditorDrop,
-  keydown: handleEditorKeyDown,
-  paste: handleEditorPaste,
-};
-
-function bindNodeView(NodeView: CustomNodeView): Function {
-  return (node, view, getPos, decorations) => {
-    return new NodeView(node, view, getPos, decorations);
-  };
-}
-
-function getSchema(editorState: ?EditorState): Schema {
-  return editorState ? editorState.schema : EDITOR_EMPTY_STATE.schema;
-}
-
-class Editor extends React.PureComponent<any, any> {
-  static EDITOR_EMPTY_STATE = EDITOR_EMPTY_STATE;
-
-  _autoFocusTimer = 0;
-  _id = uuid();
-  _editorView = null;
-
-  props: EditorProps;
-
-  state = {
-    isPrinting: false,
-  };
-
-  static defaultProps = {
-    transformPastedHTML: normalizeHTML,
-  };
-
-  componentDidMount(): void {
-    const {
-      onReady,
-      editorState,
-      readOnly,
-      runtime,
-      placeholder,
-      disabled,
-      dispatchTransaction,
-      nodeViews,
-      transformPastedHTML,
-    } = this.props;
-
-    const editorNode = document.getElementById(this._id);
-    if (editorNode) {
-      const effectiveNodeViews = {
-        ...DEFAULT_NODE_VIEWS,
-        ...nodeViews
-      };
-      const boundNodeViews = {};
-      const schema = getSchema(editorState);
-      const { nodes } = schema;
-
-      Object.keys(effectiveNodeViews).forEach((nodeName) => {
-        const nodeView = effectiveNodeViews[nodeName];
-        // Only valid and supported node views should be used.
-        if (nodes[nodeName]) {
-          boundNodeViews[nodeName] = bindNodeView(nodeView);
-        }
-      });
-
-      // Reference: http://prosemirror.net/examples/basic/
-      const view = (this._editorView = new CustomEditorView(editorNode, {
-        dispatchTransaction,
-        editable: this._isEditable,
-        nodeViews: boundNodeViews,
-        state: editorState || EDITOR_EMPTY_STATE,
-        transformPastedHTML,
-        handleDOMEvents,
-      }));
-
-      view.runtime = runtime;
-      view.placeholder = placeholder;
-      view.readOnly = !!readOnly;
-      view.disabled = !!disabled;
-      view.updateState(editorState || EDITOR_EMPTY_STATE);
-
-      // Expose the view to CZIProseMirror so developer could debug it.
-      registerEditorView(this._id, view);
-      this.onEditorReady(view, onReady);
-    }
-
-    window.addEventListener('beforeprint', this._onPrintStart, false);
-    window.addEventListener('afterprint', this._onPrintEnd, false);
-  }
-
-  onEditorReady(view: EditorView, onReady: Function) {
-    onReady?.(view);
-    this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
-    this._autoFocusTimer = this.props.autoFocus
-      ? setTimeout(this.focus, AUTO_FOCUS_DELAY)
-      : 0;
-  }
-
-  componentDidUpdate(prevProps: EditorProps): void {
-    const view = this._editorView;
-    if (view) {
-      const prevSchema = getSchema(prevProps.editorState);
-      const currSchema = getSchema(this.props.editorState);
-      if (prevSchema !== currSchema) {
-        // schema should never change.
-        // TODO: re-create the editor view if schema changed.
-        console.error('editor schema changed.');
-      }
-
-      const {
-        runtime,
-        editorState,
-        placeholder,
-        readOnly,
-        disabled,
-      } = this.props;
-      const { isPrinting } = this.state;
-      const state = editorState || EDITOR_EMPTY_STATE;
-      view.runtime = runtime;
-      view.placeholder = placeholder;
-      view.readOnly = !!readOnly || isPrinting;
-      view.disabled = !!disabled;
-      view.updateState(state);
-
-      this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
-      this._autoFocusTimer =
-        !prevProps.autoFocus && this.props.autoFocus
-          ? setTimeout(this.focus, AUTO_FOCUS_DELAY)
-          : 0;
-    }
-  }
-
-  componentWillUnmount(): void {
-    this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
-    this._editorView?.destroy();
-    this._editorView = null;
-    releaseEditorView(this._id);
-    window.removeEventListener('beforeprint', this._onPrintStart, false);
-    window.removeEventListener('afterprint', this._onPrintEnd, false);
-  }
-
-  render(): React.Element<any> {
-    const { embedded, readOnly } = this.props;
-    const className = cx('prosemirror-editor-wrapper', { embedded, readOnly });
-    return (
-      <div
-        className={className}
-        data-czi-prosemirror-editor-id={this._id}
-        id={this._id}
-        onBlur={this._onBlur}
-      />
-    );
-  }
-
-  _onBlur = (): void => {
-    const { onBlur } = this.props;
-    const view = this._editorView;
-    if (view && !view.disabled && !view.readOnly && onBlur) {
-      onBlur();
-    }
-  };
-
-  focus = (): void => {
-    const view = this._editorView;
-    if (view && !view.disabled && !view.readOnly) {
-      view.focus();
-    }
-  };
-  // [FS-AFQ][20-FEB-2020]
-  // Collaboration
-  _dispatchTransaction = (transaction: Transform): void => {
-    const { editorState, readOnly, onChange } = this.props;
-    if (readOnly === true || !onChange) {
-      return;
-    }
-    onChange({
-      transaction,
-      state: editorState || EDITOR_EMPTY_STATE,
-    });
-  };
-
-  _isEditable = (): boolean => {
-    const { disabled, readOnly } = this.props;
-    const { isPrinting } = this.state;
-    return !isPrinting && !!this._editorView && !readOnly && !disabled;
-  };
-
-  _onPrintStart = (): void => {
-    this.setState({ isPrinting: true });
-  };
-
-  _onPrintEnd = (): void => {
-    this.setState({ isPrinting: false });
-  };
-}
-
-export default Editor;
+// @flow
+
+import cx from 'classnames';
+import { Schema } from 'prosemirror-model';
+import { EditorState, Transaction } from 'prosemirror-state';
+import { Transform } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+import * as React from 'react';
+import webfontloader from 'webfontloader';
+
+import {
+  exportJSON,
+  registerEditorView,
+  registeryKeys,
+  releaseEditorView,
+} from '../CZIProseMirror.js';
+import { BOOKMARK, LIST_ITEM } from '../NodeNames.js';
+import WebFontLoader from '../WebFontLoader.js';
+import { preLoadFonts } from '../FontTypeMarkSpec.js';
+import createEmptyEditorState from '../createEmptyEditorState.js';
+import normalizeHTML from '../normalizeHTML.js';
+import BookmarkNodeView from './BookmarkNodeView.js';
+import CustomEditorView from './CustomEditorView.js';
+import CustomNodeView from './CustomNodeView.js';
+import ListItemNodeView from './ListItemNodeView.js';
+import handleEditorDrop from './handleEditorDrop.js';
+import handleEditorKeyDown from './handleEditorKeyDown.js';
+import handleEditorPaste from './handleEditorPaste.js';
+import uuid from './uuid.js';
+import type { EditorRuntime } from '../Types.js';
+
+export type EditorProps = {
+  autoFocus?: ?boolean,
+  disabled?: ?boolean,
+  dispatchTransaction?: ?(tr: Transform) => void,
+  editorState?: ?EditorState,
+  embedded?: ?boolean,
+  onBlur?: ?() => void,
+  onChange?: ?(state: EditorState) => void,
+  onReady?: ?(view: EditorView) => void,
+  // Mapping for custom node views.
+  nodeViews?: ?{ [nodeName: string]: CustomNodeView },
+  placeholder?: ?(string | React.Element<any>),
+  readOnly?: ?boolean,
+  runtime?: ?EditorRuntime,
+  transformPastedHTML?: (html: string) => string,
+};
+
+// Export utilities for debugging.
+window.CZIProseMirror = {
+  exportJSON,
+  registeryKeys,
+};
+
+const AUTO_FOCUS_DELAY = 350;
+
+// Default custom node views.
+export const DEFAULT_NODE_VIEWS = Object.freeze({
+  [BOOKMARK]: BookmarkNodeView,
+  [LIST_ITEM]: ListItemNodeView,
+});
+
+const EDITOR_EMPTY_STATE = Object.freeze(createEmptyEditorState());
+
+// Monkey patch the `scrollIntoView` mathod of 'Transaction'.
+// Why this is necessary?
+// It appears that promse-mirror does call `scrollIntoView` extensively
+// from many of the built-in transformations, thus cause unwanted page
+// scrolls. To make the behavior more manageable, this patched method asks
+// developer to explicitly use `scrollIntoView(true)` to enforce page scroll.
+const scrollIntoView = Transaction.prototype.scrollIntoView;
+const scrollIntoViewPatched = function (forced: boolean): Transaction {
+  if (forced && scrollIntoView) {
+    return scrollIntoView.call(this);
+  } else {
+    return this;
+  }
+};
+Transaction.prototype.scrollIntoView = scrollIntoViewPatched;
+
+// Sets the implementation so that `FontTypeMarkSpec` can load custom fonts.
+WebFontLoader.setImplementation(webfontloader);
+// FS IRAD-988 2020-06-18
+preLoadFonts();
+
+const handleDOMEvents = {
+  drop: handleEditorDrop,
+  keydown: handleEditorKeyDown,
+  paste: handleEditorPaste,
+};
+
+function bindNodeView(NodeView: CustomNodeView): Function {
+  return (node, view, getPos, decorations) => {
+    return new NodeView(node, view, getPos, decorations);
+  };
+}
+
+function getSchema(editorState: ?EditorState): Schema {
+  return editorState ? editorState.schema : EDITOR_EMPTY_STATE.schema;
+}
+
+class Editor extends React.PureComponent<any, any> {
+  static EDITOR_EMPTY_STATE = EDITOR_EMPTY_STATE;
+
+  _autoFocusTimer = 0;
+  _id = uuid();
+  _editorView = null;
+
+  props: EditorProps;
+
+  state = {
+    isPrinting: false,
+  };
+
+  static defaultProps = {
+    transformPastedHTML: normalizeHTML,
+  };
+
+  componentDidMount(): void {
+    const {
+      onReady,
+      editorState,
+      readOnly,
+      runtime,
+      placeholder,
+      disabled,
+      dispatchTransaction,
+      nodeViews,
+      transformPastedHTML,
+    } = this.props;
+
+    const editorNode = document.getElementById(this._id);
+    if (editorNode) {
+      const effectiveNodeViews = {
+        ...DEFAULT_NODE_VIEWS,
+        ...nodeViews
+      };
+      const boundNodeViews = {};
+      const schema = getSchema(editorState);
+      const { nodes } = schema;
+
+      Object.keys(effectiveNodeViews).forEach((nodeName) => {
+        const nodeView = effectiveNodeViews[nodeName];
+        // Only valid and supported node views should be used.
+        if (nodes[nodeName]) {
+          boundNodeViews[nodeName] = bindNodeView(nodeView);
+        }
+      });
+
+      // Reference: http://prosemirror.net/examples/basic/
+      const view = (this._editorView = new CustomEditorView(editorNode, {
+        dispatchTransaction,
+        editable: this._isEditable,
+        nodeViews: boundNodeViews,
+        state: editorState || EDITOR_EMPTY_STATE,
+        transformPastedHTML,
+        handleDOMEvents,
+      }));
+
+      view.runtime = runtime;
+      view.placeholder = placeholder;
+      view.readOnly = !!readOnly;
+      view.disabled = !!disabled;
+      view.updateState(editorState || EDITOR_EMPTY_STATE);
+
+      // Expose the view to CZIProseMirror so developer could debug it.
+      registerEditorView(this._id, view);
+      this.onEditorReady(view, onReady);
+    }
+
+    window.addEventListener('beforeprint', this._onPrintStart, false);
+    window.addEventListener('afterprint', this._onPrintEnd, false);
+  }
+
+  onEditorReady(view: EditorView, onReady: Function) {
+    onReady?.(view);
+    this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
+    this._autoFocusTimer = this.props.autoFocus
+      ? setTimeout(this.focus, AUTO_FOCUS_DELAY)
+      : 0;
+  }
+
+  componentDidUpdate(prevProps: EditorProps): void {
+    const view = this._editorView;
+    if (view) {
+      const prevSchema = getSchema(prevProps.editorState);
+      const currSchema = getSchema(this.props.editorState);
+      if (prevSchema !== currSchema) {
+        // schema should never change.
+        // TODO: re-create the editor view if schema changed.
+        console.error('editor schema changed.');
+      }
+
+      const {
+        runtime,
+        editorState,
+        placeholder,
+        readOnly,
+        disabled,
+      } = this.props;
+      const { isPrinting } = this.state;
+      const state = editorState || EDITOR_EMPTY_STATE;
+      view.runtime = runtime;
+      view.placeholder = placeholder;
+      view.readOnly = !!readOnly || isPrinting;
+      view.disabled = !!disabled;
+      view.updateState(state);
+
+      this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
+      this._autoFocusTimer =
+        !prevProps.autoFocus && this.props.autoFocus
+          ? setTimeout(this.focus, AUTO_FOCUS_DELAY)
+          : 0;
+    }
+  }
+
+  componentWillUnmount(): void {
+    this._autoFocusTimer && clearTimeout(this._autoFocusTimer);
+    this._editorView?.destroy();
+    this._editorView = null;
+    releaseEditorView(this._id);
+    window.removeEventListener('beforeprint', this._onPrintStart, false);
+    window.removeEventListener('afterprint', this._onPrintEnd, false);
+  }
+
+  render(): React.Element<any> {
+    const { embedded, readOnly } = this.props;
+    const className = cx('prosemirror-editor-wrapper', { embedded, readOnly });
+    return (
+      <div
+        className={className}
+        data-czi-prosemirror-editor-id={this._id}
+        id={this._id}
+        onBlur={this._onBlur}
+      />
+    );
+  }
+
+  _onBlur = (): void => {
+    const { onBlur } = this.props;
+    const view = this._editorView;
+    if (view && !view.disabled && !view.readOnly && onBlur) {
+      onBlur();
+    }
+  };
+
+  focus = (): void => {
+    const view = this._editorView;
+    if (view && !view.disabled && !view.readOnly) {
+      view.focus();
+    }
+  };
+  // [FS-AFQ][20-FEB-2020]
+  // Collaboration
+  _dispatchTransaction = (transaction: Transform): void => {
+    const { editorState, readOnly, onChange } = this.props;
+    if (readOnly === true || !onChange) {
+      return;
+    }
+    onChange({
+      transaction,
+      state: editorState || EDITOR_EMPTY_STATE,
+    });
+  };
+
+  _isEditable = (): boolean => {
+    const { disabled, readOnly } = this.props;
+    const { isPrinting } = this.state;
+    return !isPrinting && !!this._editorView && !readOnly && !disabled;
+  };
+
+  _onPrintStart = (): void => {
+    this.setState({ isPrinting: true });
+  };
+
+  _onPrintEnd = (): void => {
+    this.setState({ isPrinting: false });
+  };
+}
+
+export default Editor;