bpmnlint 11.15.0 → 12.1.0

package/lib/types.d.ts

@@ -1,81 +1,20 @@
-export type ModdleElement = any;
-
-export interface Reporter {
-
-  report(id: string, message: string): void;
-
-  report(id: string, message: string, path: string[]): void;
-
-  report(id: string, message: string, context: {
-    path?: string[],
-    [key: string]: any
-  }) : void;
-}
-
-export interface Resolver {
-
-  resolveRule(pkg: string, ruleName: string): Promise<RuleFactory> | RuleFactory,
-
-  resolveConfig(pkg: string, configName: string): Promise<Config> | Config;
-}
-
-export type EnterFn = (element: ModdleElement, reporter: Reporter) => boolean | void;
-
-export type LeaveFn = (element: ModdleElement, reporter: Reporter) => void;
-
-export type CheckDefinition = EnterFn | {
-  enter: EnterFn
-} | {
-  leave: LeaveFn
-} | {
-  enter: EnterFn,
-  leave: LeaveFn
-};
-
-export type RuleDefinition = {
-  meta?: {
-    documentation?: {
-      url?: string
-    }
-  },
-  check: CheckDefinition
-};
-
-export type RuleFactory = (ruleOptions?: any) => RuleDefinition;
-
-export type ReportingCategoryMap = {
-  0: 'off',
-  1: 'warn',
-  2: 'error',
-  3: 'info'
-};
-
-export type ReportingCategoryIndex = keyof ReportingCategoryMap;
-export type ReportingCategory = ReportingCategoryMap[ReportingCategoryIndex];
-
-export type RuleErrorCategory = 'rule-error';
-
-export type RuleConfig =
-  ReportingCategoryIndex |
-  ReportingCategory |
-  [ ReportingCategoryIndex, config?: any ] |
-  [ ReportingCategory, config?: any ];
-
-export type RuleConfigs = Record<string, RuleConfig>;
-
-export type Config = {
-  extends?: string | string[],
-  rules?: RuleConfigs
-};
-
-export type TransformRuleFn = (
-  rule: RuleDefinition,
-  options: { pkg: string, ruleName: string }
-) => RuleDefinition;
-
-export type Report = {
-  id?: string,
-  path?: string[],
-  message: string,
-  [key: string]: any
-};
+export type {
+  ModdleElement,
+  Product,
+  Reporter,
+  Resolver,
+  EnterFn,
+  LeaveFn,
+  CheckDefinition,
+  RuleDefinition,
+  RuleFactory,
+  ReportingCategoryMap,
+  ReportingCategoryIndex,
+  ReportingCategory,
+  RuleErrorCategory,
+  RuleConfig,
+  RuleConfigs,
+  Config,
+  TransformRuleFn,
+  Report
+} from '@bpmn-io/lint-core/lib/types';

package/package.json

@@ -1,8 +1,47 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "11.15.0",
+  "version": "12.1.0",
   "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./lib/index": "./lib/index.js",
+    "./lib/index.js": "./lib/index.js",
+    "./lib/linter": "./lib/linter.js",
+    "./lib/linter.js": "./lib/linter.js",
+    "./lib/resolver/helper": "./lib/resolver/helper.js",
+    "./lib/resolver/helper.js": "./lib/resolver/helper.js",
+    "./lib/resolver/node-resolver": "./lib/resolver/node-resolver.js",
+    "./lib/resolver/node-resolver.js": "./lib/resolver/node-resolver.js",
+    "./lib/resolver/static-resolver": "./lib/resolver/static-resolver.js",
+    "./lib/resolver/static-resolver.js": "./lib/resolver/static-resolver.js",
+    "./lib/support/compile-config": "./lib/support/compile-config.js",
+    "./lib/support/compile-config.js": "./lib/support/compile-config.js",
+    "./lib/test-rule": "./lib/test-rule.js",
+    "./lib/test-rule.js": "./lib/test-rule.js",
+    "./lib/testers/helper": "./lib/testers/helper.js",
+    "./lib/testers/helper.js": "./lib/testers/helper.js",
+    "./lib/traverse": "./lib/traverse.js",
+    "./lib/traverse.js": "./lib/traverse.js",
+    "./bin/bpmnlint": "./bin/bpmnlint.js",
+    "./bin/bpmnlint.js": "./bin/bpmnlint.js",
+    "./lib/testers/rule-tester": {
+      "types": "./lib/testers/rule-tester.d.ts",
+      "default": "./lib/testers/rule-tester.js"
+    },
+    "./lib/testers/rule-tester.js": {
+      "types": "./lib/testers/rule-tester.d.ts",
+      "default": "./lib/testers/rule-tester.js"
+    },
+    "./lib/types": {
+      "types": "./lib/types.d.ts"
+    },
+    "./rules/*.js": "./rules/*.js",
+    "./rules/*": "./rules/*.js",
+    "./config/*.js": "./config/*.js",
+    "./config/*": "./config/*.js",
+    "./package.json": "./package.json"
+  },
   "keywords": [
     "bpmnlint",
     "bpmn",
@@ -23,7 +62,7 @@
     }
   ],
   "engines": {
-    "node": ">= 20"
+    "node": ">= 24"
   },
   "license": "MIT",
   "scripts": {
@@ -40,16 +79,10 @@
     "bpmnlint": "./bin/bpmnlint.js"
   },
   "dependencies": {
-    "@bpmn-io/moddle-utils": "^0.3.0",
-    "ansi-colors": "^4.1.3",
+    "@bpmn-io/lint-core": "^0.1.0",
     "bpmn-moddle": "^10.1.0",
     "bpmnlint-utils": "^1.1.1",
-    "cli-table": "^0.3.11",
-    "color-support": "^1.1.3",
-    "min-dash": "^5.1.0",
-    "mri": "^1.2.0",
-    "pluralize": "^8.0.0",
-    "tiny-glob": "^0.2.9"
+    "min-dash": "^5.1.0"
   },
   "devDependencies": {
     "@bpmn-io/bpmnlint-generate-docs-images": "^1.2.0",

package/rules/fake-join.js

@@ -1,4 +1,9 @@
 const {
+  groupBy
+} = require('min-dash');
+
+const {
+  is,
   isAny
 } = require('bpmnlint-utils');
 
@@ -9,7 +14,9 @@ const {
 
 /**
  * A rule that checks that no fake join is modeled by attempting
- * to give a task or event join semantics.
+ * to give an element join semantics, i.e. a task or event with
+ * multiple incoming flows, or a link catch event targeted by
+ * multiple link throw events.
  *
  * Users should model a parallel joining gateway
  * to achieve the desired behavior.
@@ -20,6 +27,10 @@ module.exports = function() {
 
   function check(node, reporter) {
 
+    if (is(node, 'bpmn:FlowElementsContainer')) {
+      checkLinks(node, reporter);
+    }
+
     if (!isAny(node, [
       'bpmn:Activity',
       'bpmn:Event'
@@ -34,8 +45,46 @@ module.exports = function() {
     }
   }
 
+  function checkLinks(container, reporter) {
+
+    const links = (container.flowElements || []).filter(isLinkEvent);
+
+    // links are resolved by name, per scope
+    const names = groupBy(links.filter(getLinkName), getLinkName);
+
+    for (const [ name, events ] of Object.entries(names)) {
+      const throwEvents = events.filter(event => is(event, 'bpmn:ThrowEvent'));
+      const catchEvents = events.filter(event => is(event, 'bpmn:CatchEvent'));
+
+      // ignore ambiguous catch
+      if (throwEvents.length > 1 && catchEvents.length === 1) {
+        reporter.report(
+          catchEvents[0].id,
+          `Link throw events with link name <${ name }> do not join`
+        );
+      }
+    }
+  }
+
   return annotateRule('fake-join', {
     check
   });
 
-};
+};
+
+
+// helpers /////////////////
+
+function isLinkEvent(node) {
+  return is(node, 'bpmn:Event') && !!getLinkDefinition(node);
+}
+
+function getLinkDefinition(linkEvent) {
+  return (linkEvent.eventDefinitions || []).find(
+    definition => is(definition, 'bpmn:LinkEventDefinition')
+  );
+}
+
+function getLinkName(linkEvent) {
+  return getLinkDefinition(linkEvent).name;
+}