bpmn-js 12.1.0 → 13.0.0

package/lib/util/LabelUtil.js

@@ -4,6 +4,13 @@ import {
 
 import { is } from './ModelUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/util/Types').Point} Point
+ * @typedef {import('diagram-js/lib/util/Types').Rect} Rect
+ *
+ * @typedef {import('../model/Types').Element} Element
+ * @typedef {import('../model/Types').ModdleElement} ModdleElement
+ */
 
 export var DEFAULT_LABEL_SIZE = {
   width: 90,
@@ -14,10 +21,11 @@ export var FLOW_LABEL_INDENT = 15;
 
 
 /**
- * Returns true if the given semantic has an external label
+ * Return true if the given semantic has an external label.
+ *
+ * @param {Element} semantic
  *
- * @param {BpmnElement} semantic
- * @return {boolean} true if has label
+ * @return {boolean}
  */
 export function isLabelExternal(semantic) {
   return is(semantic, 'bpmn:Event') ||
@@ -32,20 +40,22 @@ export function isLabelExternal(semantic) {
 }
 
 /**
- * Returns true if the given element has an external label
+ * Return true if the given element has an external label.
  *
- * @param {djs.model.shape} element
- * @return {boolean} true if has label
+ * @param {Element} element
+ *
+ * @return {boolean}
  */
 export function hasExternalLabel(element) {
   return isLabel(element.label);
 }
 
 /**
- * Get the position for sequence flow labels
+ * Get the position of a sequence flow label.
+ *
+ * @param  {Point[]} waypoints
  *
- * @param  {Array<Point>} waypoints
- * @return {Point} the label position
+ * @return {Point}
  */
 export function getFlowLabelPosition(waypoints) {
 
@@ -75,10 +85,11 @@ export function getFlowLabelPosition(waypoints) {
 
 
 /**
- * Get the middle of a number of waypoints
+ * Get the middle of a number of waypoints.
  *
- * @param  {Array<Point>} waypoints
- * @return {Point} the mid point
+ * @param  {Point[]} waypoints
+ *
+ * @return {Point}
  */
 export function getWaypointsMid(waypoints) {
 
@@ -93,7 +104,13 @@ export function getWaypointsMid(waypoints) {
   };
 }
 
-
+/**
+ * Get the middle of the external label of an element.
+ *
+ * @param {Element} element
+ *
+ * @return {Point}
+ */
 export function getExternalLabelMid(element) {
 
   if (element.waypoints) {
@@ -113,11 +130,13 @@ export function getExternalLabelMid(element) {
 
 
 /**
- * Returns the bounds of an elements label, parsed from the elements DI or
+ * Return the bounds of an elements label, parsed from the elements DI or
  * generated from its bounds.
  *
- * @param {BpmndDi} di
- * @param {djs.model.Base} element
+ * @param {ModdleElement} di
+ * @param {Element} element
+ *
+ * @return {Rect}
  */
 export function getExternalLabelBounds(di, element) {
 
@@ -151,6 +170,11 @@ export function getExternalLabelBounds(di, element) {
   }, size);
 }
 
+/**
+ * @param {Element} element
+ *
+ * @return {boolean}
+ */
 export function isLabel(element) {
   return element && !!element.labelTarget;
 }

package/lib/util/ModelUtil.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Is an element of the given BPMN type?
+ *
+ * @param  element
+ * @param  type
+ *
+ * @return
+ */
+export function is(element: Element | ModdleElement, type: string): boolean;
+
+/**
+ * Return true if element has any of the given types.
+ *
+ * @param element
+ * @param types
+ *
+ * @return
+ */
+export function isAny(element: Element | ModdleElement, types: string[]): boolean;
+
+/**
+ * Return the business object for a given element.
+ *
+ * @param element
+ *
+ * @return
+ */
+export function getBusinessObject(element: Element | ModdleElement): ModdleElement;
+
+/**
+ * Return the di object for a given element.
+ *
+ * @param element
+ *
+ * @return
+ */
+export function getDi(element: Element): ModdleElement;
+
+type Element = import('../model/Types').Element;
+type ModdleElement = import('../model/Types').ModdleElement;

package/lib/util/ModelUtil.js

@@ -2,11 +2,15 @@ import {
   some
 } from 'min-dash';
 
+/**
+ * @typedef { import('../model/Types').Element } Element
+ * @typedef { import('../model/Types').ModdleElement } ModdleElement
+ */
 
 /**
  * Is an element of the given BPMN type?
  *
- * @param  {djs.model.Base|ModdleElement} element
+ * @param  {Element|ModdleElement} element
  * @param  {string} type
  *
  * @return {boolean}
@@ -21,8 +25,8 @@ export function is(element, type) {
 /**
  * Return true if element has any of the given types.
  *
- * @param {djs.model.Base} element
- * @param {Array<string>} types
+ * @param {Element|ModdleElement} element
+ * @param {string[]} types
  *
  * @return {boolean}
  */
@@ -35,7 +39,7 @@ export function isAny(element, types) {
 /**
  * Return the business object for a given element.
  *
- * @param  {djs.model.Base|ModdleElement} element
+ * @param {Element|ModdleElement} element
  *
  * @return {ModdleElement}
  */
@@ -46,7 +50,7 @@ export function getBusinessObject(element) {
 /**
  * Return the di object for a given element.
  *
- * @param  {djs.model.Base} element
+ * @param {Element} element
  *
  * @return {ModdleElement}
  */

package/lib/util/PoweredByUtil.d.ts

@@ -0,0 +1,8 @@
+export function open(): void;
+export const BPMNIO_IMG: string;
+export namespace LOGO_STYLES {
+    const verticalAlign: string;
+}
+export namespace LINK_STYLES {
+    const color: string;
+}

package/lib/util/Types.js

@@ -0,0 +1,5 @@
+/**
+ * @typedef {Object} Colors
+ * @property {string} [fill]
+ * @property {string} [stroke]
+ */

package/lib/util/Types.ts

@@ -0,0 +1,4 @@
+export type Colors = {
+  fill?: string;
+  stroke?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-js",
-  "version": "12.1.0",
+  "version": "13.0.0",
   "description": "A bpmn 2.0 toolkit and web modeler",
   "main": "index.js",
   "files": [
@@ -13,7 +13,7 @@
     "!lib/**/*.spec.ts"
   ],
   "scripts": {
-    "all": "run-s lint test test:types distro test:distro",
+    "all": "run-s lint test generate-types distro test:distro",
     "lint": "eslint .",
     "format": "run-s format:markdown 'lint -- --fix'",
     "format:markdown": "remark . -qo",
@@ -24,10 +24,13 @@
     "test": "karma start test/config/karma.unit.js",
     "distro": "node tasks/build-distro.js",
     "collect-translations": "cross-env COLLECT_TRANSLATIONS=1 npm test",
+    "generate-types": "run-s generate-types:*",
+    "generate-types:generate": "del-cli \"lib/**/*.d.ts\" && npx bio-dts -r lib",
+    "generate-types:test": "tsc --noEmit --noImplicitAny",
     "test:distro": "node tasks/test-distro.js",
-    "test:types": "tsc",
     "postversion": "run-s distro test:distro",
-    "prepare": "run-s distro"
+    "prepare": "run-s distro",
+    "prepublishOnly": "run-s generate-types"
   },
   "repository": {
     "type": "git",
@@ -72,6 +75,7 @@
     "cpx": "^1.5.0",
     "cross-env": "^7.0.3",
     "del": "^6.0.0",
+    "del-cli": "^5.0.0",
     "eslint": "^8.22.0",
     "eslint-plugin-bpmn-io": "^1.0.0",
     "eslint-plugin-import": "^2.26.0",
@@ -98,12 +102,13 @@
     "rollup-plugin-license": "^3.0.0",
     "sinon": "^15.0.0",
     "sinon-chai": "^3.7.0",
+    "ts-expect": "^1.3.0",
     "typescript": "^5.0.0",
     "webpack": "^5.74.0"
   },
   "dependencies": {
     "bpmn-moddle": "^8.0.0",
-    "diagram-js": "^11.12.0",
+    "diagram-js": "^12.0.0",
     "diagram-js-direct-editing": "^2.0.0",
     "ids": "^1.0.0",
     "inherits-browser": "^0.1.0",

package/test/matchers/ConnectionMatchers.js

@@ -56,7 +56,7 @@ export default function(chai, utils) {
    *
    * expect(connection).to.have.diWaypoints([ { x: 100, y: 100 }, { x: 0, y: 0 } ]);
    *
-   * @param {Connection|Array<Point>} exp
+   * @param {Connection|Point[]} exp
    */
   Assertion.addMethod('diWaypoints', function(exp) {
     var obj = this._obj;

package/lib/icons/dist/append.svg

@@ -1 +0,0 @@
-data:image/svg+xml,data%3Aimage%2Fsvg%2Bxml%2C%253Csvg%2520xmlns%253D%2522http%253A%252F%252Fwww.w3.org%252F2000%252Fsvg%2522%2520width%253D%252222%2522%2520height%253D%252222%2522%2520viewBox%253D%25220%25200%25205.82%25205.82%2522%253E%253Cpath%2520d%253D%2522M1.3%25203.4c.3%25200%2520.5-.2.5-.5s-.2-.4-.5-.4c-.2%25200-.4.1-.4.4%25200%2520.3.2.5.4.5zm1.7%25200c.2%25200%2520.4-.2.4-.5s-.2-.4-.4-.4c-.3%25200-.5.1-.5.4%25200%2520.3.2.5.5.5zm1.6%25200c.2%25200%2520.4-.2.4-.5s-.2-.4-.4-.4c-.3%25200-.5.1-.5.4%25200%2520.3.2.5.5.5z%2522%252F%253E%253C%252Fsvg%253E

package/lib/icons/dist/connect-context-pad.svg

@@ -1 +0,0 @@
-data:image/svg+xml,data%3Aimage%2Fsvg%2Bxml%2C%253Csvg%2520xmlns%253D%2522http%253A%252F%252Fwww.w3.org%252F2000%252Fsvg%2522%2520viewBox%253D%25220%25200%25202048%25202048%2522%253E%253Cpath%2520d%253D%2522M2013.823%2520158.247%2520995.866%2520525.177l143.206%2520181.698L34.177%25201595.041l136.637%2520158.712%25201104.89-888.123%2520140.894%2520182.578Z%2522%252F%253E%253C%252Fsvg%253E

package/lib/icons/dist/connect-palette.svg

@@ -1 +0,0 @@
-data:image/svg+xml,data%3Aimage%2Fsvg%2Bxml%2C%253Csvg%2520xmlns%253D%2522http%253A%252F%252Fwww.w3.org%252F2000%252Fsvg%2522%2520viewBox%253D%25220%25200%25202048%25202048%2522%253E%253Cpath%2520d%253D%2522M2013.823%2520158.247%2520995.866%2520525.177l143.206%2520181.698L34.177%25201595.041l136.637%2520158.712%25201104.89-888.123%2520140.894%2520182.578Z%2522%252F%253E%253C%252Fsvg%253E

package/lib/icons/dist/create.svg

@@ -1 +0,0 @@
-data:image/svg+xml,data%3Aimage%2Fsvg%2Bxml%2C%253Csvg%2520xmlns%253D%2522http%253A%252F%252Fwww.w3.org%252F2000%252Fsvg%2522%2520width%253D%252246%2522%2520height%253D%252246%2522%2520viewBox%253D%2522-2%2520-2%25209.82%25209.82%2522%253E%253Cpath%2520d%253D%2522M1.3%25203.4c.3%25200%2520.5-.2.5-.5s-.2-.4-.5-.4c-.2%25200-.4.1-.4.4%25200%2520.3.2.5.4.5zm1.7%25200c.2%25200%2520.4-.2.4-.5s-.2-.4-.4-.4c-.3%25200-.5.1-.5.4%25200%2520.3.2.5.5.5zm1.6%25200c.2%25200%2520.4-.2.4-.5s-.2-.4-.4-.4c-.3%25200-.5.1-.5.4%25200%2520.3.2.5.5.5z%2522%252F%253E%253C%252Fsvg%253E