@modusoperandi/licit 0.1.10 → 0.13.3

package/dist/client/Licit.js

@@ -31,9 +31,7 @@ var _CollabConnector = _interopRequireDefault(require("./CollabConnector"));
 
 var _createEmptyEditorState = require("../createEmptyEditorState");
 
-var _createPopUp = _interopRequireDefault(require("../ui/createPopUp"));
-
-var _PopUpPosition = require("../ui/PopUpPosition");
+var _licitUiCommands = require("@modusoperandi/licit-ui-commands");
 
 var _AlertInfo = _interopRequireDefault(require("../ui/AlertInfo"));
 
@@ -59,30 +57,30 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 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.
+/**
+ * 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 {
   // This will be handy in updating document's content.
   // Flag to decide whether to skip shouldComponentUpdate
 
-  /**
-   * Provides access to prosemirror view.
+  /**
+   * Provides access to prosemirror view.
    */
   get editorView() {
     return this._editorView;
@@ -117,7 +115,7 @@ class Licit extends React.Component {
     _defineProperty(this, "setContent", function () {
       let content = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       // [FS] IRAD-1571 2021-09-27
-      // dispatch a transaction that MUST start from the view�s current state;
+      // dispatch a transaction that MUST start from the view’s current state;
       const editorState = _this._editorView.state;
       const {
         doc,
@@ -126,7 +124,10 @@ class Licit extends React.Component {
       let {
         tr
       } = editorState;
-      const document = schema.nodeFromJSON(content ? content : _createEmptyEditorState.EMPTY_DOC_JSON);
+      const document = schema.nodeFromJSON(content ? content : _createEmptyEditorState.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 = _prosemirrorState.TextSelection.create(doc, 0, doc.content.size);
 
@@ -144,10 +145,10 @@ class Licit extends React.Component {
       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.
+      /*
+       ** 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) {
@@ -173,7 +174,14 @@ class Licit extends React.Component {
 
         if (transaction.docChanged) {
           const docJson = transaction.doc.toJSON();
-          const isEmpty = this.isDocEmpty(docJson); // setCFlags is/was always the opposite of isEmpty.
+          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);
@@ -199,15 +207,11 @@ class Licit extends React.Component {
       } = 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(_prosemirrorState.TextSelection.create(doc, 0, doc.content.size));
-        dispatch(trx.scrollIntoView());
-      } // [FS] IRAD-1578 2021-09-27
+      const doc = state.doc;
+      const trx = tr.setSelection(_prosemirrorState.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);
@@ -322,7 +326,7 @@ class Licit extends React.Component {
 
     if (this._connector.updateSchema) {
       // Use known editorState to update schema.
-      this._connector.updateSchema(editorState.schema);
+      this._connector.updateSchema(editorState.schema, data);
     }
   } // [FS] IRAD-1578 2021-09-27
 
@@ -343,9 +347,9 @@ class Licit extends React.Component {
 
   showAlert() {
     const anchor = null;
-    this._popUp = (0, _createPopUp.default)(_AlertInfo.default, null, {
+    this._popUp = (0, _licitUiCommands.createPopUp)(_AlertInfo.default, null, {
       anchor,
-      position: _PopUpPosition.atViewportCenter,
+      position: _licitUiCommands.atViewportCenter,
       onClose: val => {
         if (this._popUp) {
           this._popUp = null;
@@ -422,45 +426,70 @@ class Licit extends React.Component {
     return node.attrs && node.attrs[attrName];
   }
 
+  hasDataChanged(nextData) {
+    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 ((0, _flatted.stringify)(this.state.data) !== (0, _flatted.stringify)(nextData)) {
+      const editorState = this._editorView.state;
+      const nextDoc = editorState.schema.nodeFromJSON(nextData ? nextData : _createEmptyEditorState.EMPTY_DOC_JSON);
+      dataChanged = !nextDoc.eq(editorState.doc);
+    }
+
+    return dataChanged;
+  }
+
+  changeContent(data) {
+    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, nextState) {
     // 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 ((0, _flatted.stringify)(this.state.data) !== (0, _flatted.stringify)(nextState.data)) {
-        const editorState = this._editorView.state;
-        const nextDoc = editorState.schema.nodeFromJSON(nextState.data ? nextState.data : _createEmptyEditorState.EMPTY_DOC_JSON);
-        dataChanged = !nextDoc.eq(editorState.doc);
-      }
-
-      if (dataChanged) {
-        // data changed, so update document content
-        this.setContent(nextState.data);
-      }
+      this.changeContent(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.default(editorState, setState, {
-          docID,
-          collabServiceURL
-        }, this._defaultEditorSchema, this._defaultEditorPlugins, // [FS] IRAD-1578 2021-09-27
-        this.onReady.bind(this)) : new _SimpleConnector.default(editorState, setState);
+        setTimeout(this.setDocID.bind(this, nextState), 1);
       }
     }
 
     return true;
   }
 
+  setDocID(nextState) {
+    // 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.default(editorState, setState, {
+      docID,
+      collabServiceURL
+    }, this._defaultEditorSchema, this._defaultEditorPlugins, // [FS] IRAD-1578 2021-09-27
+    this.onReady.bind(this)) : new _SimpleConnector.default(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() {
     const {
       editorState,
@@ -487,22 +516,8 @@ class Licit extends React.Component {
     });
   }
 
-  isDocEmpty(docJson) {
-    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
+  // [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];
 
@@ -567,20 +582,20 @@ class Licit extends React.Component {
   componentWillUnmount() {
     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.
+  /**
+   * 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.
    */