@modusoperandi/licit 0.1.10 → 0.13.3

package/src/client/Licit.js

@@ -1,578 +1,592 @@
-// @flow
-import { EditorState, TextSelection, Plugin } from 'prosemirror-state';
-import { Node } from 'prosemirror-model';
-import { Transform } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-import * as React from 'react';
-import ReactDOM from 'react-dom';
-import { stringify } from 'flatted';
-
-import convertFromJSON from '../convertFromJSON';
-import RichTextEditor from '../ui/RichTextEditor';
-import uuid from '../uuid';
-import SimpleConnector from './SimpleConnector';
-import CollabConnector from './CollabConnector';
-import { EMPTY_DOC_JSON } from '../createEmptyEditorState';
-import type { EditorRuntime } from '../Types';
-import createPopUp from '../ui/createPopUp';
-import { atViewportCenter } from '../ui/PopUpPosition';
-import AlertInfo from '../ui/AlertInfo';
-import { SetDocAttrStep } from '@modusoperandi/licit-doc-attrs-step';
-import './licit.css';
-import DefaultEditorPlugins from '../buildEditorPlugins';
-import { Schema } from 'prosemirror-model';
-import EditorMarks from '../EditorMarks';
-import EditorNodes from '../EditorNodes';
-
-const ATTR_OBJID = 'objectId';
-const ATTR_OBJMETADATA = 'objectMetaData';
-/**
- * LICIT properties:
- *  docID {string} [] Collaborative Doument ID
- *  collabServiceURL {string} [/collaboration-service] Collaboration Service URL
- *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
- *  width {string} [100%] Width of the editor.
- *  height {string} [100%] Height of the editor.
- *  readOnly {boolean} [false] To enable/disable editing mode.
- *  onChange {@callback} [null] Fires after each significant change.
- *      @param data {JSON} Modified document data.
- *  onReady {@callback} [null] Fires when the editor is fully ready.
- *      @param ref {LICIT} Rerefence of the editor.
- *  data {JSON} [null] Document data to be loaded into the editor.
- *  disabled {boolean} [false] Disable the editor.
- *  embedded {boolean} [false] Disable/Enable inline behaviour.
- *  plugins [plugins] External Plugins into the editor.
- */
-class Licit extends React.Component<any, any> {
-  _runtime: EditorRuntime;
-  _connector: any;
-  _clientID: string;
-  _editorView: EditorView; // This will be handy in updating document's content.
-  _skipSCU: boolean; // Flag to decide whether to skip shouldComponentUpdate
-  _defaultEditorSchema: Schema;
-  _defaultEditorPlugins: Array<Plugin>;
-  _devTools: Promise<any>;
-  _applyDevTools: any;
-
-  _popUp = null;
-
-  /**
-   * Provides access to prosemirror view.
-   */
-  get editorView(): EditorView {
-    return this._editorView;
-  }
-
-  constructor(props: any, context: any) {
-    super(props, context);
-    this.initialize(props);
-  }
-
-  initialize(props: any) {
-    this._clientID = uuid();
-    this._editorView = null;
-    this._skipSCU = true;
-
-    const noop = function () { };
-
-    // [FS] IRAD-981 2020-06-10
-    // Component's configurations.
-    // [FS] IRAD-1552 2021-08-26
-    // Collaboration server / client should allow string values for document identifiers.
-    const docID = props.docID || ''; // Empty means collaborative.
-    const collaborative = docID !== '';
-    // [FS] IRAD-1553 2021-08-26
-    // Configurable Collaboration Service URL.
-    const collabServiceURL = props.collabServiceURL || '/collaboration-service';
-    const debug = props.debug || false;
-    // Default width and height to undefined
-    const width = props.width || undefined;
-    const height = props.height || undefined;
-    const onChangeCB =
-      typeof props.onChange === 'function' ? props.onChange : noop;
-    const onReadyCB =
-      typeof props.onReady === 'function' ? props.onReady : noop;
-    const readOnly = props.readOnly || false;
-    const data = props.data || null;
-    const disabled = props.disabled || false;
-    const embedded = props.embedded || false; // [FS] IRAD-996 2020-06-30
-    // [FS] 2020-07-03
-    // Handle Image Upload from Angular App
-    const runtime = props.runtime || null;
-    const plugins = props.plugins || null;
-
-    this._defaultEditorSchema = new Schema({
-      nodes: EditorNodes,
-      marks: EditorMarks,
-    });
-    this._defaultEditorPlugins = new DefaultEditorPlugins(
-      this._defaultEditorSchema
-    ).get();
-
-    let editorState = convertFromJSON(
-      data,
-      null,
-      this._defaultEditorSchema,
-      plugins,
-      this._defaultEditorPlugins
-    );
-    // [FS] IRAD-1067 2020-09-19
-    // The editorState will return null if the doc Json is mal-formed
-    if (null === editorState) {
-      editorState = convertFromJSON(
-        EMPTY_DOC_JSON,
-        null,
-        this._defaultEditorSchema,
-        plugins,
-        this._defaultEditorPlugins
-      );
-      this.showAlert();
-    }
-
-    const setState = this.setState.bind(this);
-    this._connector = collaborative
-      ? new CollabConnector(
-        editorState,
-        setState,
-        {
-          docID,
-          collabServiceURL,
-        },
-        this._defaultEditorSchema,
-        this._defaultEditorPlugins,
-        // [FS] IRAD-1578 2021-09-27
-        this.onReady.bind(this)
-      )
-      : new SimpleConnector(editorState, setState);
-
-    // FS IRAD-989 2020-18-06
-    // updating properties should automatically render the changes
-
-    this.state = {
-      docID,
-      collabServiceURL,
-      data,
-      editorState,
-      width,
-      height,
-      readOnly,
-      onChangeCB,
-      onReadyCB,
-      debug,
-      disabled,
-      embedded,
-      runtime,
-    };
-
-    // FS IRAD-1040 2020-26-08
-    // Get the modified schema from editorstate and send it to collab server
-    if (this._connector.updateSchema) {
-      // Use known editorState to update schema.
-      this._connector.updateSchema(editorState.schema);
-    }
-  }
-
-  // [FS] IRAD-1578 2021-09-27
-  onReady(state: EditorState) {
-    const collabEditing = this.state.docID !== '';
-
-    if (collabEditing) {
-      this._editorView && this._editorView.focus();
-      if (this.state.onReadyCB) {
-        this.state.onReadyCB(this);
-      }
-    }
-  }
-
-  // [FS] IRAD-1067 2020-09-19
-  // Alert funtion to show document is corrupted
-  showAlert() {
-    const anchor = null;
-    this._popUp = createPopUp(AlertInfo, null, {
-      anchor,
-      position: atViewportCenter,
-      onClose: (val) => {
-        if (this._popUp) {
-          this._popUp = null;
-        }
-      },
-    });
-  }
-
-  resetCounters(transaction: Transform) {
-    for (let index = 1; index <= 10; index++) {
-      const counterVar = 'set-cust-style-counter-' + index;
-      const setCounterVal = window[counterVar];
-      if (setCounterVal) {
-        delete window[counterVar];
-      }
-    }
-    this.setCounterFlags(transaction, true);
-  }
-
-  setCounterFlags(transaction: Transform, reset: boolean) {
-    let modified = false;
-    let counterFlags = null;
-    const existingCFlags = transaction.doc.attrs.counterFlags;
-    if (reset && !existingCFlags) {
-      return;
-    }
-
-    for (let index = 1; index <= 10; index++) {
-      const counterVar = 'set-cust-style-counter-' + index;
-
-      const setCounterVal = window[counterVar];
-      if (setCounterVal) {
-        if (!counterFlags) {
-          counterFlags = {};
-        }
-        counterFlags[counterVar] = true;
-
-        if (!existingCFlags) {
-          modified = true;
-        }
-      }
-      if (!modified) {
-        if (existingCFlags) {
-          if (setCounterVal) {
-            modified = undefined == existingCFlags[counterVar];
-          } else {
-            modified = undefined != existingCFlags[counterVar];
-          }
-        } else {
-          modified = setCounterVal;
-        }
-      }
-    }
-
-    if (modified) {
-      const tr = this._editorView.state.tr.step(
-        new SetDocAttrStep('counterFlags', counterFlags)
-      );
-      this._editorView.dispatch(tr);
-    }
-  }
-
-  getDeletedArtifactIds() {
-    if (this._connector.getDeletedArtifactIds) {
-      this._connector.getDeletedArtifactIds(this.state.editorState.schema);
-    }
-  }
-
-  isNodeHasAttribute(node: Node, attrName: string) {
-    return node.attrs && node.attrs[attrName];
-  }
-
-  setContent = (content: any = {}): void => {
-    // [FS] IRAD-1571 2021-09-27
-    // dispatch a transaction that MUST start from the view�s current state;
-    const editorState = this._editorView.state;
-    const { doc, schema } = editorState;
-    let { tr } = editorState;
-    const document = schema.nodeFromJSON(content ? content : EMPTY_DOC_JSON);
-
-    const selection = TextSelection.create(doc, 0, doc.content.size);
-
-    tr = tr.setSelection(selection).replaceSelectionWith(document, false);
-    // [FS] IRAD-1092 2020-12-03
-    // set the value for object metadata  and objectId
-    tr = this.isNodeHasAttribute(document, ATTR_OBJMETADATA)
-      ? tr.step(
-        new SetDocAttrStep(ATTR_OBJMETADATA, document.attrs.objectMetaData)
-      )
-      : tr;
-    tr = this.isNodeHasAttribute(document, ATTR_OBJID)
-      ? tr.step(new SetDocAttrStep(ATTR_OBJID, document.attrs.objectId))
-      : tr;
-
-    this._skipSCU = true;
-    this._editorView.dispatch(tr);
-  };
-
-  shouldComponentUpdate(nextProps: any, nextState: any) {
-    // Only interested if properties are set from outside.
-    if (!this._skipSCU) {
-      this._skipSCU = false;
-      let dataChanged = false;
-
-      // [FS] IRAD-1571 2021-09-27
-      // dispatch a transaction that MUST start from the view�s current state;
-      // [FS] IRAD-1589 2021-10-04
-      // Do a proper circular JSON comparison.
-      if (stringify(this.state.data) !== stringify(nextState.data)) {
-        const editorState = this._editorView.state;
-        const nextDoc = editorState.schema.nodeFromJSON(
-          nextState.data ? nextState.data : EMPTY_DOC_JSON
-        );
-        dataChanged = !nextDoc.eq(editorState.doc);
-      }
-
-      if (dataChanged) {
-        // data changed, so update document content
-        this.setContent(nextState.data);
-      }
-
-      if (this.state.docID !== nextState.docID) {
-        // Collaborative mode changed
-        const collabEditing = nextState.docID !== '';
-        const editorState = this._editorView.state;
-        const setState = this.setState.bind(this);
-        const docID = nextState.docID || '';
-        const collabServiceURL =
-          nextState.collabServiceURL || '/collaboration-service';
-        // create new connector
-        this._connector = collabEditing
-          ? new CollabConnector(
-            editorState,
-            setState,
-            {
-              docID,
-              collabServiceURL,
-            },
-            this._defaultEditorSchema,
-            this._defaultEditorPlugins,
-            // [FS] IRAD-1578 2021-09-27
-            this.onReady.bind(this)
-          )
-          : new SimpleConnector(editorState, setState);
-      }
-    }
-
-    return true;
-  }
-
-  render(): React.Element<any> {
-    const {
-      editorState,
-      width,
-      height,
-      readOnly,
-      disabled,
-      embedded,
-      runtime,
-    } = this.state;
-    // [FS] IRAD-978 2020-06-05
-    // Using 100vw & 100vh (100% viewport) is not ideal for a component which is expected to be a part of a page,
-    // so changing it to 100%  width & height which will occupy the area relative to its parent.
-    return (
-      <RichTextEditor
-        disabled={disabled}
-        editorState={editorState}
-        embedded={embedded}
-        height={height}
-        onChange={this._onChange}
-        onReady={this._onReady}
-        readOnly={readOnly}
-        runtime={runtime}
-        width={width}
-      />
-    );
-  }
-
-  _onChange = (data: { state: EditorState, transaction: Transform }): void => {
-    const { transaction } = data;
-
-    /*
-     ** ProseMirror Debug Tool's Snapshot creates a new state and sets that to editor view's state.
-     ** This results in the connector's state as an orphan and thus transaction mismatch error.
-     ** To resolve check and update the connector's state to keep in sync.
-     */
-
-    if (this._editorView) {
-      const isSameState =
-        this._connector._editorState == this._editorView.state;
-      let invokeOnEdit = false;
-
-      if (!isSameState) {
-        this._connector._editorState = this._editorView.state;
-        invokeOnEdit = true;
-      } else {
-        // [FS] IRAD-1264 2021-03-19
-        // check if in non-collab mode.
-        if (!(this._connector instanceof CollabConnector)) {
-          invokeOnEdit = true;
-        }
-      }
-      if (invokeOnEdit) {
-        // [FS] IRAD-1236 2020-03-05
-        // Only need to call if there is any difference in collab mode OR always in non-collab mode.
-        this._connector.onEdit(transaction, this._editorView);
-      }
-
-      if (transaction.docChanged) {
-        const docJson = transaction.doc.toJSON();
-        const isEmpty = this.isDocEmpty(docJson);
-
-        // setCFlags is/was always the opposite of isEmpty.
-        if (isEmpty) {
-          this.resetCounters(transaction);
-        } else {
-          this.setCounterFlags(transaction, false);
-        }
-
-        // Changing 2nd parameter from boolean to object was not in any way
-        // backwards compatible. Any conditional logic placed on isEmpty was
-        // broken. Reverting that change, then adding view as a 3rd parameter.
-        this.state.onChangeCB(docJson, isEmpty, this._editorView);
-
-        this.closeOpenedPopupModels();
-      }
-    }
-  };
-
-  isDocEmpty(docJson: Object) {
-    let isEmpty = false;
-
-    if (docJson.content && docJson.content.length === 1) {
-      if (
-        !docJson.content[0].content ||
-        (docJson.content[0].content &&
-          // [FS] IRAD-1710 2022-03-04
-          // Empty if no content OR when the one & only text content is empty.
-          1 === docJson.content[0].content.length &&
-          'text' === docJson.content[0].content[0].type &&
-          docJson.content[0].content[0].text &&
-          '' === docJson.content[0].content[0].text)
-      ) {
-        isEmpty = true;
-      }
-    }
-    return isEmpty;
-  }
-
-  // [FS] IRAD-1173 2021-02-25
-  // Bug fix: Transaction mismatch error when a dialog is opened and keep typing.
-  closeOpenedPopupModels() {
-    const element = document.getElementsByClassName('czi-pop-up-element')[0];
-    if (element && element.parentElement) {
-      element.parentElement.removeChild(element);
-    }
-  }
-
-  _onReady = (editorView: EditorView): void => {
-    // [FS][06-APR-2020][IRAD-922]
-    // Showing focus in the editor.
-    const { state, dispatch } = editorView;
-    this._editorView = editorView;
-    const tr = state.tr;
-    const doc = state.doc;
-
-    // [FS] IRAD-1710 2022-03-04
-    if (!this.isDocEmpty(doc.toJSON())) {
-      const trx = tr.setSelection(
-        TextSelection.create(doc, 0, doc.content.size)
-      );
-      dispatch(trx.scrollIntoView());
-    }
-
-    // [FS] IRAD-1578 2021-09-27
-    // In collab mode, fire onRead only after getting the response from collab server.
-    if (this.state.onReadyCB && this.state.docID === '') {
-      editorView.focus();
-      this.state.onReadyCB(this);
-    }
-
-    this.initDevTool(this.state.debug, editorView);
-  };
-
-  initDevTool(debug: boolean, editorView: EditorView): void {
-    // [FS] IRAD-1575 2021-09-27
-    if (debug) {
-      if (!this._devTools) {
-        this._devTools = new Promise(async (resolve, reject) => {
-          try {
-            // Method is exported as both the default and named, Using named
-            // for clarity and future proofing.
-            const { applyDevTools } = await import('prosemirror-dev-tools');
-            // got the pm dev tools instance.
-            this._applyDevTools = applyDevTools;
-            // Attach debug tools to current editor instance.
-            this._applyDevTools(editorView);
-            resolve(() => {
-              // [FS] IRAD-1571 2021-10-08
-              // Prosemirror Dev Tools handles as if one only instance is used in a page and
-              // hence handling removal here gracefully.
-              const place = document.querySelector(
-                '.'.concat('__prosemirror-dev-tools__')
-              );
-              if (place) {
-                ReactDOM.unmountComponentAtNode(place);
-                place.innerHTML = '';
-              }
-            });
-          } catch (error) {
-            reject();
-          }
-        });
-      }
-
-      // Attach debug tools to current editor instance.
-      if (this._devTools && this._applyDevTools) {
-        this._applyDevTools(editorView);
-      }
-    }
-  }
-
-  destroyDevTool(): void {
-    // [FS] IRAD-1569 2021-09-15
-    // Unmount dev tools when component is destroyed,
-    // so that toggle effect is not occuring when the document is retrieved each time.
-    if (this._devTools) {
-      // Call the applyDevTools method again to trigger DOM removal
-      // prosemirror-dev-tools has outstanding pull-requests that affect
-      // dom removal. this may need to be addressed once those have been merged.
-      this._devTools.then((removeDevTools) => removeDevTools());
-    }
-  }
-
-  componentWillUnmount(): void {
-    this.destroyDevTool();
-  }
-
-  /**
-   * LICIT properties:
-   *  docID {number} [0] Collaborative Doument ID
-   *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
-   *  width {string} [100%] Width of the editor.
-   *  height {height} [100%] Height of the editor.
-   *  readOnly {boolean} [false] To enable/disable editing mode.
-   *  onChange {@callback} [null] Fires after each significant change.
-   *      @param data {JSON} Modified document data.
-   *  onReady {@callback} [null] Fires when the editor is fully ready.
-   *      @param ref {LICIT} Rerefence of the editor.
-   *  data {JSON} [null] Document data to be loaded into the editor.
-   *  disabled {boolean} [false] Disable the editor.
-   *  embedded {boolean} [false] Disable/Enable inline behaviour.
-   */
-  setProps = (props: any): void => {
-    // [FS] IRAD-1571 2021-10-08
-    // Since the debug lies outside the editor,
-    // any change to debug tool must be refreshed here.
-    if (this.state.debug !== props.debug) {
-      // change in debug flag.
-      if (props.debug) {
-        this.initDevTool(true, this._editorView);
-      } else {
-        this.destroyDevTool();
-      }
-    }
-
-    if (this.state.readOnly) {
-      // It should be possible to load content into the editor in readonly as well.
-      // It should not be necessary to make the component writable any time during the process
-      const propsCopy = {};
-      this._skipSCU = true;
-      Object.assign(propsCopy, props);
-      // make writable without content change
-      propsCopy.readOnly = false;
-      delete propsCopy.data;
-      this.setState(propsCopy);
-    }
-    // Need to go through shouldComponentUpdate lifecycle here, when updated from outside,
-    // so that content is modified gracefully using transaction so that undo/redo works too.
-    this._skipSCU = false;
-    this.setState(props);
-  };
-}
-
-export default Licit;
+// @flow
+import { EditorState, TextSelection, Plugin } from 'prosemirror-state';
+import { Node } from 'prosemirror-model';
+import { Transform } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+import * as React from 'react';
+import ReactDOM from 'react-dom';
+import { stringify } from 'flatted';
+
+import convertFromJSON from '../convertFromJSON';
+import RichTextEditor from '../ui/RichTextEditor';
+import uuid from '../uuid';
+import SimpleConnector from './SimpleConnector';
+import CollabConnector from './CollabConnector';
+import { EMPTY_DOC_JSON } from '../createEmptyEditorState';
+import type { EditorRuntime } from '../Types';
+import { createPopUp } from '@modusoperandi/licit-ui-commands';
+import { atViewportCenter } from '@modusoperandi/licit-ui-commands';
+import AlertInfo from '../ui/AlertInfo';
+import { SetDocAttrStep } from '@modusoperandi/licit-doc-attrs-step';
+import './licit.css';
+import DefaultEditorPlugins from '../buildEditorPlugins';
+import { Schema } from 'prosemirror-model';
+import EditorMarks from '../EditorMarks';
+import EditorNodes from '../EditorNodes';
+
+const ATTR_OBJID = 'objectId';
+const ATTR_OBJMETADATA = 'objectMetaData';
+/**
+ * LICIT properties:
+ *  docID {string} [] Collaborative Doument ID
+ *  collabServiceURL {string} [/collaboration-service] Collaboration Service URL
+ *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
+ *  width {string} [100%] Width of the editor.
+ *  height {string} [100%] Height of the editor.
+ *  readOnly {boolean} [false] To enable/disable editing mode.
+ *  onChange {@callback} [null] Fires after each significant change.
+ *      @param data {JSON} Modified document data.
+ *  onReady {@callback} [null] Fires when the editor is fully ready.
+ *      @param ref {LICIT} Rerefence of the editor.
+ *  data {JSON} [null] Document data to be loaded into the editor.
+ *  disabled {boolean} [false] Disable the editor.
+ *  embedded {boolean} [false] Disable/Enable inline behaviour.
+ *  plugins [plugins] External Plugins into the editor.
+ */
+class Licit extends React.Component<any, any> {
+  _runtime: EditorRuntime;
+  _connector: any;
+  _clientID: string;
+  _editorView: EditorView; // This will be handy in updating document's content.
+  _skipSCU: boolean; // Flag to decide whether to skip shouldComponentUpdate
+  _defaultEditorSchema: Schema;
+  _defaultEditorPlugins: Array<Plugin>;
+  _devTools: Promise<any>;
+  _applyDevTools: any;
+
+  _popUp = null;
+
+  /**
+   * Provides access to prosemirror view.
+   */
+  get editorView(): EditorView {
+    return this._editorView;
+  }
+
+  constructor(props: any, context: any) {
+    super(props, context);
+    this.initialize(props);
+  }
+
+  initialize(props: any) {
+    this._clientID = uuid();
+    this._editorView = null;
+    this._skipSCU = true;
+
+    const noop = function () {};
+
+    // [FS] IRAD-981 2020-06-10
+    // Component's configurations.
+    // [FS] IRAD-1552 2021-08-26
+    // Collaboration server / client should allow string values for document identifiers.
+    const docID = props.docID || ''; // Empty means collaborative.
+    const collaborative = docID !== '';
+    // [FS] IRAD-1553 2021-08-26
+    // Configurable Collaboration Service URL.
+    const collabServiceURL = props.collabServiceURL || '/collaboration-service';
+    const debug = props.debug || false;
+    // Default width and height to undefined
+    const width = props.width || undefined;
+    const height = props.height || undefined;
+    const onChangeCB =
+      typeof props.onChange === 'function' ? props.onChange : noop;
+    const onReadyCB =
+      typeof props.onReady === 'function' ? props.onReady : noop;
+    const readOnly = props.readOnly || false;
+    const data = props.data || null;
+    const disabled = props.disabled || false;
+    const embedded = props.embedded || false; // [FS] IRAD-996 2020-06-30
+    // [FS] 2020-07-03
+    // Handle Image Upload from Angular App
+    const runtime = props.runtime || null;
+    const plugins = props.plugins || null;
+
+    this._defaultEditorSchema = new Schema({
+      nodes: EditorNodes,
+      marks: EditorMarks,
+    });
+    this._defaultEditorPlugins = new DefaultEditorPlugins(
+      this._defaultEditorSchema
+    ).get();
+
+    let editorState = convertFromJSON(
+      data,
+      null,
+      this._defaultEditorSchema,
+      plugins,
+      this._defaultEditorPlugins
+    );
+    // [FS] IRAD-1067 2020-09-19
+    // The editorState will return null if the doc Json is mal-formed
+    if (null === editorState) {
+      editorState = convertFromJSON(
+        EMPTY_DOC_JSON,
+        null,
+        this._defaultEditorSchema,
+        plugins,
+        this._defaultEditorPlugins
+      );
+      this.showAlert();
+    }
+
+    const setState = this.setState.bind(this);
+    this._connector = collaborative
+      ? new CollabConnector(
+          editorState,
+          setState,
+          {
+            docID,
+            collabServiceURL,
+          },
+          this._defaultEditorSchema,
+          this._defaultEditorPlugins,
+          // [FS] IRAD-1578 2021-09-27
+          this.onReady.bind(this)
+        )
+      : new SimpleConnector(editorState, setState);
+
+    // FS IRAD-989 2020-18-06
+    // updating properties should automatically render the changes
+
+    this.state = {
+      docID,
+      collabServiceURL,
+      data,
+      editorState,
+      width,
+      height,
+      readOnly,
+      onChangeCB,
+      onReadyCB,
+      debug,
+      disabled,
+      embedded,
+      runtime,
+    };
+
+    // FS IRAD-1040 2020-26-08
+    // Get the modified schema from editorstate and send it to collab server
+    if (this._connector.updateSchema) {
+      // Use known editorState to update schema.
+      this._connector.updateSchema(editorState.schema, data);
+    }
+  }
+
+  // [FS] IRAD-1578 2021-09-27
+  onReady(state: EditorState) {
+    const collabEditing = this.state.docID !== '';
+
+    if (collabEditing) {
+      this._editorView && this._editorView.focus();
+      if (this.state.onReadyCB) {
+        this.state.onReadyCB(this);
+      }
+    }
+  }
+
+  // [FS] IRAD-1067 2020-09-19
+  // Alert funtion to show document is corrupted
+  showAlert() {
+    const anchor = null;
+    this._popUp = createPopUp(AlertInfo, null, {
+      anchor,
+      position: atViewportCenter,
+      onClose: (val) => {
+        if (this._popUp) {
+          this._popUp = null;
+        }
+      },
+    });
+  }
+
+  resetCounters(transaction: Transform) {
+    for (let index = 1; index <= 10; index++) {
+      const counterVar = 'set-cust-style-counter-' + index;
+      const setCounterVal = window[counterVar];
+      if (setCounterVal) {
+        delete window[counterVar];
+      }
+    }
+    this.setCounterFlags(transaction, true);
+  }
+
+  setCounterFlags(transaction: Transform, reset: boolean) {
+    let modified = false;
+    let counterFlags = null;
+    const existingCFlags = transaction.doc.attrs.counterFlags;
+    if (reset && !existingCFlags) {
+      return;
+    }
+
+    for (let index = 1; index <= 10; index++) {
+      const counterVar = 'set-cust-style-counter-' + index;
+
+      const setCounterVal = window[counterVar];
+      if (setCounterVal) {
+        if (!counterFlags) {
+          counterFlags = {};
+        }
+        counterFlags[counterVar] = true;
+
+        if (!existingCFlags) {
+          modified = true;
+        }
+      }
+      if (!modified) {
+        if (existingCFlags) {
+          if (setCounterVal) {
+            modified = undefined == existingCFlags[counterVar];
+          } else {
+            modified = undefined != existingCFlags[counterVar];
+          }
+        } else {
+          modified = setCounterVal;
+        }
+      }
+    }
+
+    if (modified) {
+      const tr = this._editorView.state.tr.step(
+        new SetDocAttrStep('counterFlags', counterFlags)
+      );
+      this._editorView.dispatch(tr);
+    }
+  }
+
+  getDeletedArtifactIds() {
+    if (this._connector.getDeletedArtifactIds) {
+      this._connector.getDeletedArtifactIds(this.state.editorState.schema);
+    }
+  }
+
+  isNodeHasAttribute(node: Node, attrName: string) {
+    return node.attrs && node.attrs[attrName];
+  }
+
+  setContent = (content: any = {}): void => {
+    // [FS] IRAD-1571 2021-09-27
+    // dispatch a transaction that MUST start from the view’s current state;
+    const editorState = this._editorView.state;
+    const { doc, schema } = editorState;
+    let { tr } = editorState;
+    const document = schema.nodeFromJSON(content ? content : EMPTY_DOC_JSON);
+
+    // [FS] IRAD-1593 2021-10-12
+    // Reset lastKeyCode since the content is set dynamically and so lastKeyCode is invalid now.
+    this._editorView.lastKeyCode = null;
+
+    const selection = TextSelection.create(doc, 0, doc.content.size);
+
+    tr = tr.setSelection(selection).replaceSelectionWith(document, false);
+    // [FS] IRAD-1092 2020-12-03
+    // set the value for object metadata  and objectId
+    tr = this.isNodeHasAttribute(document, ATTR_OBJMETADATA)
+      ? tr.step(
+          new SetDocAttrStep(ATTR_OBJMETADATA, document.attrs.objectMetaData)
+        )
+      : tr;
+    tr = this.isNodeHasAttribute(document, ATTR_OBJID)
+      ? tr.step(new SetDocAttrStep(ATTR_OBJID, document.attrs.objectId))
+      : tr;
+
+    this._skipSCU = true;
+    this._editorView.dispatch(tr);
+  };
+
+  hasDataChanged(nextData: any) {
+    let dataChanged = false;
+
+    // [FS] IRAD-1571 2021-09-27
+    // dispatch a transaction that MUST start from the view’s current state;
+    // [FS] IRAD-1589 2021-10-04
+    // Do a proper circular JSON comparison.
+    if (stringify(this.state.data) !== stringify(nextData)) {
+      const editorState = this._editorView.state;
+      const nextDoc = editorState.schema.nodeFromJSON(
+        nextData ? nextData : EMPTY_DOC_JSON
+      );
+      dataChanged = !nextDoc.eq(editorState.doc);
+    }
+
+    return dataChanged;
+  }
+
+  changeContent(data: any) {
+    if (this.hasDataChanged(data)) {
+      // FS IRAD-1592 2021-11-10
+      // Release here quickly, so that update doesn't care about at this point.
+      // data changed, so update document content
+      setTimeout(this.setContent.bind(this, data), 1);
+    }
+  }
+
+  shouldComponentUpdate(nextProps: any, nextState: any) {
+    // Only interested if properties are set from outside.
+    if (!this._skipSCU) {
+      this._skipSCU = false;
+
+      this.changeContent(nextState.data);
+
+      if (this.state.docID !== nextState.docID) {
+        setTimeout(this.setDocID.bind(this, nextState), 1);
+      }
+    }
+
+    return true;
+  }
+
+  setDocID(nextState: any) {
+    // Collaborative mode changed
+    const collabEditing = nextState.docID !== '';
+    const editorState = this._editorView.state;
+    const setState = this.setState.bind(this);
+    const docID = nextState.docID || '';
+    const collabServiceURL =
+      nextState.collabServiceURL || '/collaboration-service';
+
+    if (this._connector) {
+      this._connector.cleanUp();
+    }
+    // create new connector
+    this._connector = collabEditing
+      ? new CollabConnector(
+          editorState,
+          setState,
+          {
+            docID,
+            collabServiceURL,
+          },
+          this._defaultEditorSchema,
+          this._defaultEditorPlugins,
+          // [FS] IRAD-1578 2021-09-27
+          this.onReady.bind(this)
+        )
+      : new SimpleConnector(editorState, setState);
+
+    // FS IRAD-1592 2021-11-10
+    // Notify collab server
+    if (this._connector.updateSchema) {
+      // Use known editorState to update schema.
+      this._connector.updateSchema(editorState.schema);
+    }
+  }
+
+  render(): React.Element<any> {
+    const {
+      editorState,
+      width,
+      height,
+      readOnly,
+      disabled,
+      embedded,
+      runtime,
+    } = this.state;
+    // [FS] IRAD-978 2020-06-05
+    // Using 100vw & 100vh (100% viewport) is not ideal for a component which is expected to be a part of a page,
+    // so changing it to 100%  width & height which will occupy the area relative to its parent.
+    return (
+      <RichTextEditor
+        disabled={disabled}
+        editorState={editorState}
+        embedded={embedded}
+        height={height}
+        onChange={this._onChange}
+        onReady={this._onReady}
+        readOnly={readOnly}
+        runtime={runtime}
+        width={width}
+      />
+    );
+  }
+
+  _onChange = (data: { state: EditorState, transaction: Transform }): void => {
+    const { transaction } = data;
+
+    /*
+     ** ProseMirror Debug Tool's Snapshot creates a new state and sets that to editor view's state.
+     ** This results in the connector's state as an orphan and thus transaction mismatch error.
+     ** To resolve check and update the connector's state to keep in sync.
+     */
+
+    if (this._editorView) {
+      const isSameState =
+        this._connector._editorState == this._editorView.state;
+      let invokeOnEdit = false;
+
+      if (!isSameState) {
+        this._connector._editorState = this._editorView.state;
+        invokeOnEdit = true;
+      } else {
+        // [FS] IRAD-1264 2021-03-19
+        // check if in non-collab mode.
+        if (!(this._connector instanceof CollabConnector)) {
+          invokeOnEdit = true;
+        }
+      }
+      if (invokeOnEdit) {
+        // [FS] IRAD-1236 2020-03-05
+        // Only need to call if there is any difference in collab mode OR always in non-collab mode.
+        this._connector.onEdit(transaction, this._editorView);
+      }
+
+      if (transaction.docChanged) {
+        const docJson = transaction.doc.toJSON();
+        let isEmpty = false;
+
+        if (docJson.content && docJson.content.length === 1) {
+          if (
+            !docJson.content[0].content ||
+            (docJson.content[0].content &&
+              docJson.content[0].content[0].text &&
+              '' === docJson.content[0].content[0].text.trim())
+          ) {
+            isEmpty = true;
+          }
+        }
+
+        // setCFlags is/was always the opposite of isEmpty.
+        if (isEmpty) {
+          this.resetCounters(transaction);
+        } else {
+          this.setCounterFlags(transaction, false);
+        }
+
+        // Changing 2nd parameter from boolean to object was not in any way
+        // backwards compatible. Any conditional logic placed on isEmpty was
+        // broken. Reverting that change, then adding view as a 3rd parameter.
+        this.state.onChangeCB(docJson, isEmpty, this._editorView);
+
+        this.closeOpenedPopupModels();
+      }
+    }
+  };
+  // [FS] IRAD-1173 2021-02-25
+  // Bug fix: Transaction mismatch error when a dialog is opened and keep typing.
+  closeOpenedPopupModels() {
+    const element = document.getElementsByClassName('czi-pop-up-element')[0];
+    if (element && element.parentElement) {
+      element.parentElement.removeChild(element);
+    }
+  }
+
+  _onReady = (editorView: EditorView): void => {
+    // [FS][06-APR-2020][IRAD-922]
+    // Showing focus in the editor.
+    const { state, dispatch } = editorView;
+    this._editorView = editorView;
+    const tr = state.tr;
+    const doc = state.doc;
+    const trx = tr.setSelection(TextSelection.create(doc, 0, doc.content.size));
+    dispatch(trx.scrollIntoView());
+
+    // [FS] IRAD-1578 2021-09-27
+    // In collab mode, fire onRead only after getting the response from collab server.
+    if (this.state.onReadyCB && this.state.docID === '') {
+      editorView.focus();
+      this.state.onReadyCB(this);
+    }
+
+    this.initDevTool(this.state.debug, editorView);
+  };
+
+  initDevTool(debug: boolean, editorView: EditorView): void {
+    // [FS] IRAD-1575 2021-09-27
+    if (debug) {
+      if (!this._devTools) {
+        this._devTools = new Promise(async (resolve, reject) => {
+          try {
+            // Method is exported as both the default and named, Using named
+            // for clarity and future proofing.
+            const { applyDevTools } = await import('prosemirror-dev-tools');
+            // got the pm dev tools instance.
+            this._applyDevTools = applyDevTools;
+            // Attach debug tools to current editor instance.
+            this._applyDevTools(editorView);
+            resolve(() => {
+              // [FS] IRAD-1571 2021-10-08
+              // Prosemirror Dev Tools handles as if one only instance is used in a page and
+              // hence handling removal here gracefully.
+              const place = document.querySelector(
+                '.'.concat('__prosemirror-dev-tools__')
+              );
+              if (place) {
+                ReactDOM.unmountComponentAtNode(place);
+                place.innerHTML = '';
+              }
+            });
+          } catch (error) {
+            reject();
+          }
+        });
+      }
+
+      // Attach debug tools to current editor instance.
+      if (this._devTools && this._applyDevTools) {
+        this._applyDevTools(editorView);
+      }
+    }
+  }
+
+  destroyDevTool(): void {
+    // [FS] IRAD-1569 2021-09-15
+    // Unmount dev tools when component is destroyed,
+    // so that toggle effect is not occuring when the document is retrieved each time.
+    if (this._devTools) {
+      // Call the applyDevTools method again to trigger DOM removal
+      // prosemirror-dev-tools has outstanding pull-requests that affect
+      // dom removal. this may need to be addressed once those have been merged.
+      this._devTools.then((removeDevTools) => removeDevTools());
+    }
+  }
+
+  componentWillUnmount(): void {
+    this.destroyDevTool();
+  }
+
+  /**
+   * LICIT properties:
+   *  docID {number} [0] Collaborative Doument ID
+   *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
+   *  width {string} [100%] Width of the editor.
+   *  height {height} [100%] Height of the editor.
+   *  readOnly {boolean} [false] To enable/disable editing mode.
+   *  onChange {@callback} [null] Fires after each significant change.
+   *      @param data {JSON} Modified document data.
+   *  onReady {@callback} [null] Fires when the editor is fully ready.
+   *      @param ref {LICIT} Rerefence of the editor.
+   *  data {JSON} [null] Document data to be loaded into the editor.
+   *  disabled {boolean} [false] Disable the editor.
+   *  embedded {boolean} [false] Disable/Enable inline behaviour.
+   */
+  setProps = (props: any): void => {
+    // [FS] IRAD-1571 2021-10-08
+    // Since the debug lies outside the editor,
+    // any change to debug tool must be refreshed here.
+    if (this.state.debug !== props.debug) {
+      // change in debug flag.
+      if (props.debug) {
+        this.initDevTool(true, this._editorView);
+      } else {
+        this.destroyDevTool();
+      }
+    }
+
+    if (this.state.readOnly) {
+      // It should be possible to load content into the editor in readonly as well.
+      // It should not be necessary to make the component writable any time during the process
+      const propsCopy = {};
+      this._skipSCU = true;
+      Object.assign(propsCopy, props);
+      // make writable without content change
+      propsCopy.readOnly = false;
+      delete propsCopy.data;
+      this.setState(propsCopy);
+    }
+    // Need to go through shouldComponentUpdate lifecycle here, when updated from outside,
+    // so that content is modified gracefully using transaction so that undo/redo works too.
+    this._skipSCU = false;
+    this.setState(props);
+  };
+}
+
+export default Licit;