5minds · ElRaptorus · Feb 4, 2025 · Jul 31, 2024 · Aug 5, 2024 · Jun 28, 2024
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc b/.eslintrc
diff --git a/.github/workflows/CODE_SCANNING.yml b/.github/workflows/CODE_SCANNING.yml
@@ -9,7 +9,7 @@ on:
       - '**/*.md'
 
 jobs:
-  CodeQL-Build:
+  codeql-build:
     # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
     runs-on: ubuntu-latest
 

diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -2,5 +2,5 @@
   "pull-request-title-pattern": "chore: release v${version}",
   "changelog-sections": "[{\"type\":\"feat\",\"section\":\"Features\",\"hidden\":false},{\"type\":\"fix\",\"section\":\"Bug Fixes\",\"hidden\":false},{\"type\":\"deps\",\"section\":\"Dependency Updates\",\"hidden\":false}]",
   "changelog-type": "github",
-  ".": "17.9.1"
+  ".": "17.9.2"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,73 @@ All notable changes to [bpmn-js](https://github.com/bpmn-io/bpmn-js) are documen
 
 ___Note:__ Yet to be released changes appear here._
 
+## 18.1.2
+
+* `FIX`: canvas `autoFocus` must explicitly be enabled ([bpmn-io/diagram-js#956](https://github.com/bpmn-io/diagram-js/pull/956))
+* `FIX`: properly integrate `zoomscroll` with canvas focus ([bpmn-io/diagram-js#956](https://github.com/bpmn-io/diagram-js/pull/956))
+* `FIX`: properly integrate `movecanvas` with canvas focus ([bpmn-io/diagram-js#956](https://github.com/bpmn-io/diagram-js/pull/956))
+
+## 18.1.1
+
+* `FIX`: adjust search to prioritize start of word and exact matches ([bpmn-io/diagram-js#953](https://github.com/bpmn-io/diagram-js/pull/953))
+* `FIX`: ignore whitespace when searching ([bpmn-io/diagram-js#954](https://github.com/bpmn-io/diagram-js/pull/954))
+
+## 18.1.0
+
+* `FIX`: clear selection when opening search pad ([bpmn-io/diagram-js#947](https://github.com/bpmn-io/diagram-js/pull/947))
+* `FIX`: correct dangling selection after search pad interaction ([bpmn-io/diagram-js#947](https://github.com/bpmn-io/diagram-js/pull/947))
+* `DEPS`: update to `[email protected]`
+
+## 18.0.0
+
+* `FEAT`: remove `outline` from `Viewer` modules ([#2135](https://github.com/bpmn-io/bpmn-js/issues/2135))
+* `FEAT`: make `Canvas` a focusable element ([bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662))
+* `FEAT`: implicit keyboard binding ([bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662))
+* `FEAT`: integrate with global `search` ([#2235](https://github.com/bpmn-io/bpmn-js/pull/2235))
+* `FEAT`: integrate `popup-menu` with `search` ([bpmn-io/diagram-js#932](https://github.com/bpmn-io/diagram-js/pull/932))
+* `FEAT`: recognize modern `search` tokens in `search-pad` ([bpmn-io/diagram-js#932](https://github.com/bpmn-io/diagram-js/pull/932))
+* `FIX`: correctly handle duplicate entries and whitespace in `search` ([bpmn-io/diagram-js#932](https://github.com/bpmn-io/diagram-js/pull/932))
+* `FIX`: find `search` terms across all keys ([bpmn-io/diagram-js#932](https://github.com/bpmn-io/diagram-js/pull/932))
+* `FIX`: `search` always returns tokens for matched items ([bpmn-io/diagram-js#932](https://github.com/bpmn-io/diagram-js/pull/932))
+* `FIX`: prevent crash during label adjustment ([#2239](https://github.com/bpmn-io/bpmn-js/issues/2239))
+* `FIX`: keep existing loop characteristics when toggling through the replace menu ([#2251](https://github.com/bpmn-io/bpmn-js/pull/2251))
+* `FIX`: prevent covering multi selection with black box in `Viewer` ([#2135](https://github.com/bpmn-io/bpmn-js/issues/2135))
+* `FIX`: generate types for main entry ([`986e2bb`](https://github.com/bpmn-io/bpmn-js/commit/986e2bb51ea301e6e0df56f3606a27424fb90179))
+* `FIX`: correct handling of group name with whitespace only ([#2231](https://github.com/bpmn-io/bpmn-js/issues/2231))
+* `DEPS`: update to `bpmn-moddle@9` ([#2114](https://github.com/bpmn-io/bpmn-js/pull/2114))
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
+
+### Breaking Changes
+
+* Require `Node >= 20`
+* `Canvas` is now a focusable element and provides better support for native browser behaviors. Focus can be controlled with new `focus` and `restoreFocus` APIs ([bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662)).
+* Keyboard is now implicitly bound to canvas SVG element. Calls to `keyboard.bind` and `keyboard.bindTo` now result with a descriptive console error and have no effect ([bpmn-io/diagram-js#662](https://github.com/bpmn-io/diagram-js/pull/662)).
+
+## 17.11.1
+
+* `FIX`: handle searching elements without labels ([#2232](https://github.com/bpmn-io/bpmn-js/issues/2232), [#2234](https://github.com/bpmn-io/bpmn-js/pull/2234))
+
+## 17.11.0
+
+* `FEAT`: align search styles with other popups ([#2187](https://github.com/bpmn-io/bpmn-js/pull/2187))
+* `FEAT`: prioritize start of tokens in search results ([#2187](https://github.com/bpmn-io/bpmn-js/pull/2187))
+* `FIX`: do not commit viewport changes on `ESC` ([#2189](https://github.com/bpmn-io/bpmn-js/issues/2189), [#2187](https://github.com/bpmn-io/bpmn-js/pull/2187))
+* `DEPS`: update to `[email protected]`
+
+## 17.10.0
+
+* `CHORE`: correct various type hints ([#2228](https://github.com/bpmn-io/bpmn-js/issues/2228))
+* `FIX`: pasting compensation activity without boundary event ([#2070](https://github.com/bpmn-io/bpmn-js/issues/2070))
+* `FIX`: lane resize constraints for se and nw direction ([#2209](https://github.com/bpmn-io/bpmn-js/issues/2209))
+* `FIX`: auto place elements vertically in sub-processes ([#2127](https://github.com/bpmn-io/bpmn-js/issues/2127))
+* `FIX`: hide lane label during direct editing
+* `DEPS`: update to `[email protected]`
+
+## 17.9.2
+
+* `FIX`: keep direction when collapsing pools ([#2208](https://github.com/bpmn-io/bpmn-js/issues/2208))
+
 ## 17.9.1
 
 * `FIX`: show delete action for labels ([#2163](https://github.com/bpmn-io/bpmn-js/issues/2163))

diff --git a/README.md b/README.md
@@ -88,6 +88,8 @@ bpmn-js builds on top of a few powerful tools:
 * [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers
 * [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit
 
+It is an extensible toolkit, complemented by many [additional utilities](https://github.com/bpmn-io/awesome-bpmn-io). 
+
 ## License
 
 Use under the terms of the [bpmn.io license](http://bpmn.io/license).
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,59 @@
+import bpmnIoPlugin from 'eslint-plugin-bpmn-io';
+
+const files = {
+  ignored: [
+    'dist',
+    'coverage'
+  ],
+  build: [
+    'test/config/*.js',
+    'tasks/**/*.mjs',
+    '*.js',
+    '*.mjs'
+  ],
+  test: [
+    'test/**/*.js'
+  ]
+};
+
+export default [
+  {
+    ignores: files.ignored
+  },
+
+  // build
+  ...bpmnIoPlugin.configs.node.map(config => {
+
+    return {
+      ...config,
+      files: files.build
+    };
+  }),
+
+  // lib + test
+  ...bpmnIoPlugin.configs.browser.map(config => {
+
+    return {
+      ...config,
+      ignores: files.build
+    };
+  }),
+
+  // test
+  ...bpmnIoPlugin.configs.mocha.map(config => {
+
+    return {
+      ...config,
+      files: files.test,
+    };
+  }),
+  {
+    languageOptions: {
+      globals: {
+        sinon: true,
+        require: true
+      }
+    },
+    files: files.test
+  }
+];
diff --git a/index.js b/index.js
diff --git a/lib/.eslintrc b/lib/.eslintrc
diff --git a/lib/Modeler.js b/lib/Modeler.js
@@ -34,6 +34,7 @@ import ReplacePreviewModule from './features/replace-preview';
 import ResizeModule from 'diagram-js/lib/features/resize';
 import SnappingModule from './features/snapping';
 import SearchModule from './features/search';
+import OutlineModule from './features/outline';
 
 var initialDiagram =
   '<?xml version="1.0" encoding="UTF-8"?>' +
@@ -187,7 +188,8 @@ Modeler.prototype._modelingModules = [
   ReplacePreviewModule,
   ResizeModule,
   SnappingModule,
-  SearchModule
+  SearchModule,
+  OutlineModule
 ];
 
 

diff --git a/lib/Viewer.js b/lib/Viewer.js
@@ -2,7 +2,6 @@ import inherits from 'inherits-browser';
 
 import CoreModule from './core';
 import DrilldownModdule from './features/drilldown';
-import OutlineModule from './features/outline';
 import OverlaysModule from 'diagram-js/lib/features/overlays';
 import SelectionModule from 'diagram-js/lib/features/selection';
 import TranslateModule from 'diagram-js/lib/i18n/translate';
@@ -69,7 +68,6 @@ inherits(Viewer, BaseViewer);
 Viewer.prototype._modules = [
   CoreModule,
   DrilldownModdule,
-  OutlineModule,
   OverlaysModule,
   SelectionModule,
   TranslateModule

diff --git a/lib/draw/BpmnRenderer.js b/lib/draw/BpmnRenderer.js
@@ -93,6 +93,8 @@ var DEFAULT_OPACITY = 0.95,
 
 /**
  * @typedef { import('../model/Types').Element } Element
+ * @typedef { import('../model/Types').Shape } Shape
+ * @typedef { import('../model/Types').Connection } Connection
  */
 
 /**
@@ -2266,57 +2268,57 @@ BpmnRenderer.prototype.canRender = function(element) {
  * Draw shape into parentGfx.
  *
  * @param {SVGElement} parentGfx
- * @param {Element} element
+ * @param {Shape} shape
  * @param {Attrs} [attrs]
  *
  * @return {SVGElement} mainGfx
  */
-BpmnRenderer.prototype.drawShape = function(parentGfx, element, attrs = {}) {
-  var { type } = element;
+BpmnRenderer.prototype.drawShape = function(parentGfx, shape, attrs = {}) {
+  var { type } = shape;
 
   var handler = this._renderer(type);
 
-  return handler(parentGfx, element, attrs);
+  return handler(parentGfx, shape, attrs);
 };
 
 /**
  * Draw connection into parentGfx.
  *
  * @param {SVGElement} parentGfx
- * @param {Element} element
+ * @param {Connection} connection
  * @param {Attrs} [attrs]
  *
  * @return {SVGElement} mainGfx
  */
-BpmnRenderer.prototype.drawConnection = function(parentGfx, element, attrs = {}) {
-  var { type } = element;
+BpmnRenderer.prototype.drawConnection = function(parentGfx, connection, attrs = {}) {
+  var { type } = connection;
 
   var handler = this._renderer(type);
 
-  return handler(parentGfx, element, attrs);
+  return handler(parentGfx, connection, attrs);
 };
 
 /**
  * Get shape path.
  *
- * @param {Element} element
+ * @param {Shape} shape
  *
  * @return {string} path
  */
-BpmnRenderer.prototype.getShapePath = function(element) {
-  if (is(element, 'bpmn:Event')) {
-    return getCirclePath(element);
+BpmnRenderer.prototype.getShapePath = function(shape) {
+  if (is(shape, 'bpmn:Event')) {
+    return getCirclePath(shape);
   }
 
-  if (is(element, 'bpmn:Activity')) {
-    return getRoundRectPath(element, TASK_BORDER_RADIUS);
+  if (is(shape, 'bpmn:Activity')) {
+    return getRoundRectPath(shape, TASK_BORDER_RADIUS);
   }
 
-  if (is(element, 'bpmn:Gateway')) {
-    return getDiamondPath(element);
+  if (is(shape, 'bpmn:Gateway')) {
+    return getDiamondPath(shape);
   }
 
-  return getRectPath(element);
+  return getRectPath(shape);
 };
 
 /**

diff --git a/lib/features/align-elements/AlignElementsContextPadProvider.js b/lib/features/align-elements/AlignElementsContextPadProvider.js
@@ -12,7 +12,7 @@ import ICONS from './AlignElementsIcons';
  *
  * @typedef {import('../../model/Types').Element} Element
  * @typedef {import('diagram-js/lib/features/context-pad/ContextPad').ContextPadEntries} ContextPadEntries
- * @typedef {import('diagram-js/lib/features/context-pad/ContextPadProvider').default} ContextPadProvider
+ * @typedef {import('diagram-js/lib/features/context-pad/ContextPadProvider').default<Element>} ContextPadProvider
  */
 
 var LOW_PRIORITY = 900;

diff --git a/lib/features/append-preview/AppendPreview.js b/lib/features/append-preview/AppendPreview.js
@@ -10,7 +10,7 @@ const round = Math.round;
  * @typedef {import('diagram-js/lib/layout/ConnectionDocking').default} ConnectionDocking
  * @typedef {import('../modeling/ElementFactory').default} ElementFactory
  * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
- * @typedef {import('diagram-js/lib/layout/ManhattanLayout').default} ManhattanLayout
+ * @typedef {import('../modeling/BpmnLayouter').default} BpmnLayouter
  * @typedef {import('diagram-js/lib/features/rules/Rules').default} Rules
  *
  * @typedef {import('../../model/Types').Shape} Shape
@@ -23,7 +23,7 @@ const round = Math.round;
  * @param {ConnectionDocking} connectionDocking
  * @param {ElementFactory} elementFactory
  * @param {EventBus} eventBus
- * @param {ManhattanLayout} layouter
+ * @param {BpmnLayouter} layouter
  * @param {Rules} rules
  */
 export default function AppendPreview(complexPreview, connectionDocking, elementFactory, eventBus, layouter, rules) {

diff --git a/lib/features/auto-place/BpmnAutoPlace.js b/lib/features/auto-place/BpmnAutoPlace.js
@@ -2,20 +2,22 @@ import { getNewShapePosition } from './BpmnAutoPlaceUtil';
 
 /**
  * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ * @typedef {import('diagram-js/lib/core/ElementRegistry').default} ElementRegistry
  */
 
 /**
  * BPMN auto-place behavior.
  *
  * @param {EventBus} eventBus
+ * @param {ElementRegistry} elementRegistry
  */
-export default function AutoPlace(eventBus) {
+export default function AutoPlace(eventBus, elementRegistry) {
   eventBus.on('autoPlace', function(context) {
     var shape = context.shape,
         source = context.source;
 
-    return getNewShapePosition(source, shape);
+    return getNewShapePosition(source, shape, elementRegistry);
   });
 }
 
-AutoPlace.$inject = [ 'eventBus' ];
+AutoPlace.$inject = [ 'eventBus', 'elementRegistry' ];