reorganization to support SSR for component library in docusaurus

platform/core/.webpack/webpack.prod.js

@@ -33,5 +33,15 @@ module.exports = (env, argv) => {
       libraryTarget: 'umd',
       filename: pkg.main,
     },
+    externals: [
+      {
+        'cornerstone-math': {
+          commonjs: 'cornerstone-math',
+          commonjs2: 'cornerstone-math',
+          amd: 'cornerstone-math',
+          root: 'cornerstoneMath',
+        },
+      },
+    ],
   });
 };

platform/core/package.json

@@ -32,6 +32,7 @@
   "peerDependencies": {
     "cornerstone-core": "^2.3.0",
     "cornerstone-tools": "5.1.2",
+    "cornerstone-math": "0.1.9",
     "cornerstone-wado-image-loader": "^3.1.2",
     "dicom-parser": "^1.8.3"
   },
@@ -43,10 +44,8 @@
     "lodash.merge": "^4.6.1",
     "lodash.clonedeep": "^4.5.0",
     "moment": "^2.24.0",
-    "mousetrap": "^1.6.5",
     "query-string": "^6.14.0",
     "object-hash": "2.1.1",
-    "cornerstone-math": "0.1.9",
     "validate.js": "^0.12.0"
   },
   "devDependencies": {

platform/core/src/classes/HotkeysManager.js

@@ -1,6 +1,6 @@
 import objectHash from 'object-hash';
-import hotkeys from './../utils/hotkeys';
 import log from './../log.js';
+import hotkeys from './../utils/hotkeys';
 
 /**
  *
@@ -26,6 +26,8 @@ export class HotkeysManager {
 
     this._servicesManager = servicesManager;
     this._commandsManager = commandsManager;
+
+    hotkeys.initialize();
   }
 
   /**
@@ -163,25 +165,40 @@ export class HotkeysManager {
    * @param {String} extension
    * @returns {undefined}
    */
-  registerHotkeys({ commandName, commandOptions = {}, keys, label, isEditable } = {}, extension) {
+  registerHotkeys(
+    { commandName, commandOptions = {}, keys, label, isEditable } = {},
+    extension
+  ) {
     if (!commandName) {
       throw new Error(`No command was defined for hotkey "${keys}"`);
     }
 
     const commandHash = objectHash({ commandName, commandOptions });
-    const options = Object.keys(commandOptions).length ? JSON.stringify(commandOptions) : 'no';
+    const options = Object.keys(commandOptions).length
+      ? JSON.stringify(commandOptions)
+      : 'no';
     const previouslyRegisteredDefinition = this.hotkeyDefinitions[commandHash];
 
     if (previouslyRegisteredDefinition) {
       const previouslyRegisteredKeys = previouslyRegisteredDefinition.keys;
       this._unbindHotkeys(commandName, previouslyRegisteredKeys);
-      log.info(`[hotkeys] Unbinding ${commandName} with ${options} options from ${previouslyRegisteredKeys}`);
+      log.info(
+        `[hotkeys] Unbinding ${commandName} with ${options} options from ${previouslyRegisteredKeys}`
+      );
     }
 
     // Set definition & bind
-    this.hotkeyDefinitions[commandHash] = { commandName, commandOptions, keys, label, isEditable };
+    this.hotkeyDefinitions[commandHash] = {
+      commandName,
+      commandOptions,
+      keys,
+      label,
+      isEditable,
+    };
     this._bindHotkeys(commandName, commandOptions, keys);
-    log.info(`[hotkeys] Binding ${commandName} with ${options} options to ${keys}`);
+    log.info(
+      `[hotkeys] Binding ${commandName} with ${options} options to ${keys}`
+    );
   }
 
   /**

platform/core/src/utils/hotkeys/index.js

@@ -1,8 +0,0 @@
-import Mousetrap from 'mousetrap';
-import pausePlugin from './pausePlugin';
-import recordPlugin from './recordPlugin';
-
-recordPlugin(Mousetrap);
-pausePlugin(Mousetrap);
-
-export default Mousetrap;

platform/core/src/utils/hotkeys/pausePlugin.js

@@ -1,32 +0,0 @@
-/**
- * adds a pause and unpause method to Mousetrap
- * this allows you to enable or disable keyboard shortcuts
- * without having to reset Mousetrap and rebind everything
- *
- * https://github.com/ccampbell/mousetrap/blob/master/plugins/pause/mousetrap-pause.js
- */
-export default function(Mousetrap) {
-  var _originalStopCallback = Mousetrap.prototype.stopCallback;
-
-  Mousetrap.prototype.stopCallback = function(e, element, combo) {
-    var self = this;
-
-    if (self.paused) {
-      return true;
-    }
-
-    return _originalStopCallback.call(self, e, element, combo);
-  };
-
-  Mousetrap.prototype.pause = function() {
-    var self = this;
-    self.paused = true;
-  };
-
-  Mousetrap.prototype.unpause = function() {
-    var self = this;
-    self.paused = false;
-  };
-
-  Mousetrap.init();
-}

platform/core/src/utils/hotkeys/recordPlugin.js

@@ -1,218 +0,0 @@
-/**
- * This extension allows you to record a sequence using Mousetrap.
- * {@link https://craig.is/killing/mice}
- *
- * @author Dan Tao <daniel.tao@gmail.com>
- */
-export default function (Mousetrap) {
-  /**
-   * the sequence currently being recorded
-   *
-   * @type {Array}
-   */
-  var _recordedSequence = [],
-    /**
-     * a callback to invoke after recording a sequence
-     *
-     * @type {Function|null}
-     */
-    _recordedSequenceCallback = null,
-    /**
-     * a list of all of the keys currently held down
-     *
-     * @type {Array}
-     */
-    _currentRecordedKeys = [],
-    /**
-     * temporary state where we remember if we've already captured a
-     * character key in the current combo
-     *
-     * @type {boolean}
-     */
-    _recordedCharacterKey = false,
-    /**
-     * a handle for the timer of the current recording
-     *
-     * @type {null|number}
-     */
-    _recordTimer = null,
-    /**
-     * the original handleKey method to override when Mousetrap.record() is
-     * called
-     *
-     * @type {Function}
-     */
-    _origHandleKey = Mousetrap.prototype.handleKey;
-
-  /**
-   * handles a character key event
-   *
-   * @param {string} character
-   * @param {Array} modifiers
-   * @param {Event} e
-   * @returns void
-   */
-  function _handleKey(character, modifiers, e) {
-    var self = this;
-
-    if (!self.recording) {
-      _origHandleKey.apply(self, arguments);
-      return;
-    }
-
-    // remember this character if we're currently recording a sequence
-    if (e.type == 'keydown') {
-      if (character.length === 1 && _recordedCharacterKey) {
-        _recordCurrentCombo();
-      }
-
-      for (let i = 0; i < modifiers.length; ++i) {
-        _recordKey(modifiers[i]);
-      }
-      _recordKey(character);
-
-      // once a key is released, all keys that were held down at the time
-      // count as a keypress
-    } else if (e.type == 'keyup' && _currentRecordedKeys.length > 0) {
-      _recordCurrentCombo();
-    }
-  }
-
-  /**
-   * marks a character key as held down while recording a sequence
-   *
-   * @param {string} key
-   * @returns void
-   */
-  function _recordKey(key) {
-    // one-off implementation of Array.indexOf, since IE6-9 don't support it
-    for (let i = 0; i < _currentRecordedKeys.length; ++i) {
-      if (_currentRecordedKeys[i] === key) {
-        return;
-      }
-    }
-
-    _currentRecordedKeys.push(key);
-
-    if (key.length === 1) {
-      _recordedCharacterKey = true;
-    }
-  }
-
-  /**
-   * marks whatever key combination that's been recorded so far as finished
-   * and gets ready for the next combo
-   *
-   * @returns void
-   */
-  function _recordCurrentCombo() {
-    _recordedSequence.push(_currentRecordedKeys);
-    _currentRecordedKeys = [];
-    _recordedCharacterKey = false;
-    _finishRecording();
-  }
-
-  /**
-   * ensures each combo in a sequence is in a predictable order and formats
-   * key combos to be '+'-delimited
-   *
-   * modifies the sequence in-place
-   *
-   * @param {Array} sequence
-   * @returns void
-   */
-  function _normalizeSequence(sequence) {
-    for (let i = 0; i < sequence.length; ++i) {
-      sequence[i].sort(function (x, y) {
-        // modifier keys always come first, in alphabetical order
-        if (x.length > 1 && y.length === 1) {
-          return -1;
-        } else if (x.length === 1 && y.length > 1) {
-          return 1;
-        }
-
-        // character keys come next (list should contain no duplicates,
-        // so no need for equality check)
-        return x > y ? 1 : -1;
-      });
-
-      sequence[i] = sequence[i].join('+');
-    }
-  }
-
-  /**
-   * finishes the current recording, passes the recorded sequence to the stored
-   * callback, and sets Mousetrap.handleKey back to its original function
-   *
-   * @returns void
-   */
-  function _finishRecording() {
-    if (_recordedSequenceCallback) {
-      _normalizeSequence(_recordedSequence);
-      _recordedSequenceCallback(_recordedSequence);
-    }
-
-    // reset all recorded state
-    _recordedSequence = [];
-    _recordedSequenceCallback = null;
-    _currentRecordedKeys = [];
-  }
-
-  /**
-   * called to set a 1 second timeout on the current recording
-   *
-   * this is so after each key press in the sequence the recording will wait for
-   * 1 more second before executing the callback
-   *
-   * @returns void
-   */
-  function _restartRecordTimer() {
-    clearTimeout(_recordTimer);
-    _recordTimer = setTimeout(_finishRecording, 1000);
-  }
-
-  /**
-   * records the next sequence and passes it to a callback once it's
-   * completed
-   *
-   * @param {Function} callback
-   * @returns void
-   */
-  Mousetrap.prototype.record = function (callback) {
-    var self = this;
-    self.recording = true;
-    _recordedSequenceCallback = function () {
-      self.recording = false;
-      callback.apply(self, arguments);
-    };
-  };
-
-  /**
-   * stop recording
-   *
-   * @param {Function} callback
-   * @returns void
-   */
-  Mousetrap.prototype.stopRecord = function () {
-    var self = this;
-    self.recording = false;
-  };
-
-  /**
-   * start recording
-   *
-   * @param {Function} callback
-   * @returns void
-   */
-  Mousetrap.prototype.startRecording = function () {
-    var self = this;
-    self.recording = true;
-  };
-
-  Mousetrap.prototype.handleKey = function () {
-    var self = this;
-    _handleKey.apply(self, arguments);
-  };
-
-  Mousetrap.init();
-}