fix: fix remaining JSDoc and TS errors

lib/features/editor-actions/BpmnEditorActions.js

@@ -10,6 +10,10 @@ import {
   getBBox
 } from 'diagram-js/lib/util/Elements';
 
+/**
+ * @typedef {import('didi').Injector} Injector
+ */
+
 /**
  * Registers and executes BPMN specific editor actions.
  *

lib/features/grid-snapping/BpmnGridSnapping.js

@@ -1,5 +1,12 @@
 import { isAny } from '../modeling/util/ModelingUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ */
+
+/**
+ * @param {EventBus} eventBus
+ */
 export default function BpmnGridSnapping(eventBus) {
   eventBus.on([
     'create.init',

lib/features/grid-snapping/behavior/GridSnappingAutoPlaceBehavior.js

@@ -3,9 +3,19 @@ import { getNewShapePosition } from '../../auto-place/BpmnAutoPlaceUtil';
 import { getMid } from 'diagram-js/lib/layout/LayoutUtil';
 import { is } from '../../../util/ModelUtil';
 
-var HIGH_PRIORITY = 2000;
+/**
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('diagram-js/lib/features/grid-snapping/GridSnapping').default} GridSnapping
+ *
+ * @typedef {import('diagram-js/lib/util/Types').Axis} Axis
+ */
 
+var HIGH_PRIORITY = 2000;
 
+/**
+ * @param {EventBus} eventBus
+ * @param {GridSnapping} gridSnapping
+ */
 export default function GridSnappingAutoPlaceBehavior(eventBus, gridSnapping) {
   eventBus.on('autoPlace', HIGH_PRIORITY, function(context) {
     var source = context.source,
@@ -54,6 +64,11 @@ GridSnappingAutoPlaceBehavior.$inject = [
 
 // helpers //////////
 
+/**
+ * @param {Axis} axis
+ *
+ * @return {boolean}
+ */
 function isHorizontal(axis) {
   return axis === 'x';
 }

lib/features/grid-snapping/behavior/GridSnappingLayoutConnectionBehavior.js

@@ -8,11 +8,23 @@ import {
   assign
 } from 'min-dash';
 
+/**
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('diagram-js/lib/features/grid-snapping/GridSnapping').default} GridSnapping
+ * @typedef {import('../../modeling/Modeling').default} Modeling
+ *
+ * @typedef {import('diagram-js/lib/util/Types').Point} Point
+ */
+
 var HIGH_PRIORITY = 3000;
 
 
 /**
  * Snaps connections with Manhattan layout.
+ *
+ * @param {EventBus} eventBus
+ * @param {GridSnapping} gridSnapping
+ * @param {Modeling} modeling
  */
 export default function GridSnappingLayoutConnectionBehavior(eventBus, gridSnapping, modeling) {
   CommandInterceptor.call(this, eventBus);
@@ -53,9 +65,9 @@ inherits(GridSnappingLayoutConnectionBehavior, CommandInterceptor);
 /**
  * Snap middle segments of a given connection.
  *
- * @param {Array<Point>} waypoints
+ * @param {Point[]} waypoints
  *
- * @returns {Array<Point>}
+ * @return {Point[]}
  */
 GridSnappingLayoutConnectionBehavior.prototype.snapMiddleSegments = function(waypoints) {
   var gridSnapping = this._gridSnapping,
@@ -80,9 +92,9 @@ GridSnappingLayoutConnectionBehavior.prototype.snapMiddleSegments = function(way
 /**
  * Check whether a connection has a middle segments.
  *
- * @param {Array} waypoints
+ * @param {Point[]} waypoints
  *
- * @returns {boolean}
+ * @return {boolean}
  */
 function hasMiddleSegments(waypoints) {
   return waypoints.length > 3;
@@ -93,7 +105,7 @@ function hasMiddleSegments(waypoints) {
  *
  * @param {string} aligned
  *
- * @returns {boolean}
+ * @return {boolean}
  */
 function horizontallyAligned(aligned) {
   return aligned === 'h';
@@ -104,7 +116,7 @@ function horizontallyAligned(aligned) {
  *
  * @param {string} aligned
  *
- * @returns {boolean}
+ * @return {boolean}
  */
 function verticallyAligned(aligned) {
   return aligned === 'v';
@@ -113,9 +125,9 @@ function verticallyAligned(aligned) {
 /**
  * Get middle segments from a given connection.
  *
- * @param {Array} waypoints
+ * @param {Point[]} waypoints
  *
- * @returns {Array}
+ * @return {Point[]}
  */
 function snapSegment(gridSnapping, segmentStart, segmentEnd) {
 

lib/features/grid-snapping/behavior/GridSnappingParticipantBehavior.js

@@ -1,8 +1,18 @@
 import { is } from '../../../util/ModelUtil';
 
-var HIGHER_PRIORITY = 1750;
+/**
+ * @typedef {import('diagram-js/lib/core/Canvas').default} Canvas
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('diagram-js/lib/features/grid-snapping/GridSnapping').default} GridSnapping
+ */
 
+var HIGHER_PRIORITY = 1750;
 
+/**
+ * @param {Canvas} canvas
+ * @param {EventBus} eventBus
+ * @param {GridSnapping} gridSnapping
+ */
 export default function GridSnappingParticipantBehavior(canvas, eventBus, gridSnapping) {
   eventBus.on([
     'create.start',

lib/features/interaction-events/BpmnInteractionEvents.js

@@ -2,6 +2,14 @@ import { is } from '../../util/ModelUtil';
 
 import { isExpanded } from '../../util/DiUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('diagram-js/lib/features/interaction-events/InteractionEvents').default} InteractionEvents
+ *
+ * @typedef {import('../../model/Types').BpmnElement} BpmnElement
+ * @typedef {import('../../model/Types').BpmnShape} BpmnShape
+ */
+
 var LABEL_WIDTH = 30,
     LABEL_HEIGHT = 30;
 
@@ -26,22 +34,22 @@ export default function BpmnInteractionEvents(eventBus, interactionEvents) {
         gfx = context.gfx;
 
     if (is(element, 'bpmn:Lane')) {
-      return self.createParticipantHit(element, gfx);
+      return self._createParticipantHit(element, gfx);
     } else
 
     if (is(element, 'bpmn:Participant')) {
       if (isExpanded(element)) {
-        return self.createParticipantHit(element, gfx);
+        return self._createParticipantHit(element, gfx);
       } else {
-        return self.createDefaultHit(element, gfx);
+        return self._createDefaultHit(element, gfx);
       }
     } else
 
     if (is(element, 'bpmn:SubProcess')) {
       if (isExpanded(element)) {
-        return self.createSubProcessHit(element, gfx);
+        return self._createSubProcessHit(element, gfx);
       } else {
-        return self.createDefaultHit(element, gfx);
+        return self._createDefaultHit(element, gfx);
       }
     }
   });
@@ -53,8 +61,13 @@ BpmnInteractionEvents.$inject = [
   'interactionEvents'
 ];
 
-
-BpmnInteractionEvents.prototype.createDefaultHit = function(element, gfx) {
+/**
+ * @param {BpmnElement} element
+ * @param {SVGElement} gfx
+ *
+ * @return {boolean}
+ */
+BpmnInteractionEvents.prototype._createDefaultHit = function(element, gfx) {
   this._interactionEvents.removeHits(gfx);
 
   this._interactionEvents.createDefaultHit(element, gfx);
@@ -63,7 +76,13 @@ BpmnInteractionEvents.prototype.createDefaultHit = function(element, gfx) {
   return true;
 };
 
-BpmnInteractionEvents.prototype.createParticipantHit = function(element, gfx) {
+/**
+ * @param {BpmnShape} element
+ * @param {SVGElement} gfx
+ *
+ * @return {boolean}
+ */
+BpmnInteractionEvents.prototype._createParticipantHit = function(element, gfx) {
 
   // remove existing hits
   this._interactionEvents.removeHits(gfx);
@@ -90,7 +109,13 @@ BpmnInteractionEvents.prototype.createParticipantHit = function(element, gfx) {
   return true;
 };
 
-BpmnInteractionEvents.prototype.createSubProcessHit = function(element, gfx) {
+/**
+ * @param {BpmnShape} element
+ * @param {SVGElement} gfx
+ *
+ * @return {boolean}
+ */
+BpmnInteractionEvents.prototype._createSubProcessHit = function(element, gfx) {
 
   // remove existing hits
   this._interactionEvents.removeHits(gfx);

lib/features/keyboard/BpmnKeyboardBindings.js

@@ -2,6 +2,11 @@ import inherits from 'inherits-browser';
 
 import KeyboardBindings from 'diagram-js/lib/features/keyboard/KeyboardBindings';
 
+/**
+ * @typedef {import('didi').Injector} Injector
+ * @typedef {import('diagram-js/lib/features/editor-actions/EditorActions').default} EditorActions
+ * @typedef {import('diagram-js/lib/features/keyboard/Keyboard').default} Keyboard
+ */
 
 /**
  * BPMN 2.0 specific keyboard bindings.

lib/features/label-editing/LabelEditingPreview.js

@@ -14,13 +14,21 @@ import {
   translate
 } from 'diagram-js/lib/util/SvgTransformUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/core/Canvas').default} Canvas
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('../../draw/PathMap').default} PathMap
+ */
+
 var MARKER_HIDDEN = 'djs-element-hidden',
     MARKER_LABEL_HIDDEN = 'djs-label-hidden';
 
-
-export default function LabelEditingPreview(
-    eventBus, canvas, elementRegistry,
-    pathMap) {
+/**
+ * @param {EventBus} eventBus
+ * @param {Canvas} canvas
+ * @param {PathMap} pathMap
+ */
+export default function LabelEditingPreview(eventBus, canvas, pathMap) {
 
   var self = this;
 
@@ -124,12 +132,11 @@ export default function LabelEditingPreview(
 LabelEditingPreview.$inject = [
   'eventBus',
   'canvas',
-  'elementRegistry',
   'pathMap'
 ];
 
 
-// helpers ///////////////////
+// helpers //////////
 
 function getStrokeColor(element, defaultColor) {
   var di = getDi(element);