@onify/flow-extensions 10.0.0 → 10.0.1

package/README.md

@@ -7,6 +7,42 @@
 - `extensions`: Flow extensions
 - `extendFn`: extend function to pass to [serializer](https://github.com/paed01/moddle-context-serializer/blob/master/API.md)
 
+## `extensions(element, context)`
+
+Pass to the engine as `extensions: { onify: extensions }`. Returns an extension for elements with camunda extension data (`camunda:inputOutput`, properties, form data, execution listeners, connector, expression, or result variable).
+
+For elements without any such data it returns `undefined`, so bpmn-elements runs them without this extension. Combined with bpmn-elements `settings.assignOutput` (`'auto'` or `'id'`, >= 18.0.22) the engine then attaches its built-in output extension, e.g. a plain user task's signal payload is assigned to `environment.output`:
+
+```javascript
+import { EventEmitter } from 'node:events';
+import { Engine } from 'bpmn-engine';
+import { extensions } from '@onify/flow-extensions';
+
+const source = `
+<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL">
+  <process id="theProcess" isExecutable="true">
+    <startEvent id="start" />
+    <sequenceFlow id="to-task" sourceRef="start" targetRef="task" />
+    <userTask id="task" />
+  </process>
+</definitions>`;
+
+const listener = new EventEmitter();
+listener.once('wait', (task) => task.signal({ plain: 1 }));
+
+const engine = new Engine({
+  source,
+  listener,
+  settings: { assignOutput: 'auto' },
+  extensions: { onify: extensions },
+});
+
+engine.execute((err, instance) => {
+  if (err) throw err;
+  console.log(instance.environment.output); // { plain: 1 }
+});
+```
+
 # Examples
 
 ## Bpmn engine example

package/dist/OnifyElementExtensions.js

@@ -28,6 +28,13 @@ class OnifyElementExtensions {
     this._formatOnEnter = Boolean(format?.hasFormatting || properties || form || io?.input.length || io?.output.length);
     this._formatOnEnd = Boolean(properties || io?.output.length || format?.resultVariable);
   }
+  /**
+   * No camunda extension data to act on — the element runs without this extension
+   * @returns {boolean}
+   */
+  get isEmpty() {
+    return !this._formatOnEnter && !this._formatOnEnd && !this.extensions.listeners && !this.extensions.Service;
+  }
   activate(message) {
     const activity = this.activity;
     const executionListeners = this.extensions.listeners;

package/dist/index.js

@@ -27,7 +27,7 @@ var _OnifyTimerEventDefinition = require("./OnifyTimerEventDefinition.js");
  * Onify flow extensions factory, pass to the engine as `extensions: { onify: extensions }`
  * @param {import('bpmn-elements').ElementBase} element
  * @param {import('bpmn-elements').ContextInstance} context
- * @returns {import('bpmn-elements').IExtension}
+ * @returns {import('bpmn-elements').IExtension | undefined} undefined for an element without camunda extension data, letting bpmn-elements skip it (and e.g. attach its built-in `assignOutput` extension)
  */
 function extensions(element, context) {
   switch (element.type) {
@@ -40,7 +40,11 @@ function extensions(element, context) {
     case 'bpmn:BoundaryEvent':
       return new _OnifyBoundaryEventExtensions.OnifyBoundaryEventExtensions(element, context);
     default:
-      return new _OnifyElementExtensions.OnifyElementExtensions(element, context);
+      {
+        const elementExtensions = new _OnifyElementExtensions.OnifyElementExtensions(element, context);
+        if (elementExtensions.isEmpty) return undefined;
+        return elementExtensions;
+      }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onify/flow-extensions",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "description": "Onify Flow extensions",
   "type": "module",
   "module": "src/index.js",
@@ -53,7 +53,7 @@
     "@babel/register": "^7.23.7",
     "@eslint/js": "^10.0.1",
     "@types/node": "^26.2.0",
-    "bpmn-elements": "^18.0.1",
+    "bpmn-elements": "^18.0.22",
     "bpmn-elements-17": "npm:bpmn-elements@^17",
     "bpmn-elements-8-1": "npm:bpmn-elements@8.1",
     "bpmn-engine": "^26.0.0",

package/src/OnifyElementExtensions.js

@@ -19,6 +19,13 @@ export class OnifyElementExtensions {
     this._formatOnEnter = Boolean(format?.hasFormatting || properties || form || io?.input.length || io?.output.length);
     this._formatOnEnd = Boolean(properties || io?.output.length || format?.resultVariable);
   }
+  /**
+   * No camunda extension data to act on — the element runs without this extension
+   * @returns {boolean}
+   */
+  get isEmpty() {
+    return !this._formatOnEnter && !this._formatOnEnd && !this.extensions.listeners && !this.extensions.Service;
+  }
   activate(message) {
     const activity = this.activity;
     const executionListeners = this.extensions.listeners;

package/src/index.js

@@ -10,7 +10,7 @@ export { OnifyTimerEventDefinition } from './OnifyTimerEventDefinition.js';
  * Onify flow extensions factory, pass to the engine as `extensions: { onify: extensions }`
  * @param {import('bpmn-elements').ElementBase} element
  * @param {import('bpmn-elements').ContextInstance} context
- * @returns {import('bpmn-elements').IExtension}
+ * @returns {import('bpmn-elements').IExtension | undefined} undefined for an element without camunda extension data, letting bpmn-elements skip it (and e.g. attach its built-in `assignOutput` extension)
  */
 export function extensions(element, context) {
   switch (element.type) {
@@ -22,8 +22,11 @@ export function extensions(element, context) {
       return new OnifySubProcessExtensions(element, context);
     case 'bpmn:BoundaryEvent':
       return new OnifyBoundaryEventExtensions(element, context);
-    default:
-      return new OnifyElementExtensions(element, context);
+    default: {
+      const elementExtensions = new OnifyElementExtensions(element, context);
+      if (elementExtensions.isEmpty) return undefined;
+      return elementExtensions;
+    }
   }
 }
 

package/types/index.d.ts

@@ -2,8 +2,9 @@ declare module '@onify/flow-extensions' {
 	import type { SequenceFlow, TimerEventDefinition } from 'bpmn-elements';
 	/**
 	 * Onify flow extensions factory, pass to the engine as `extensions: { onify: extensions }`
-	 * */
-	export function extensions(element: import("bpmn-elements").ElementBase, context: import("bpmn-elements").ContextInstance): import("bpmn-elements").IExtension;
+	 * @returns undefined for an element without camunda extension data, letting bpmn-elements skip it (and e.g. attach its built-in `assignOutput` extension)
+	 */
+	export function extensions(element: import("bpmn-elements").ElementBase, context: import("bpmn-elements").ContextInstance): import("bpmn-elements").IExtension | undefined;
 	/**
 	 * Extend function for moddle-context-serializer, registers scripts and timers at serialize time
 	 * */

package/types/index.d.ts.map

@@ -47,6 +47,6 @@
 		null,
 		null
 	],
-	"mappings": ";;;;;iBAcgBA,UAAUA;;;;iBAoBVC,QAAQA;cC/BXC,iBAAiBA;;;;cCAjBC,yBAAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OCHzBC,cAAcA;;;;;;;;;;OAqDdC,aAAaA;;;;;;;;OCrDbC,MAAMA;;;;;;;;;;;;;OAoHNC,WAAWA;;;;;;;;;;;;;;;;;;OCpHXC,YAAYA;;;;;;;;;OCEZC,MAAMA;;;;;;;OCuHNC,kBAAkBA;;;;;;;;;;;;;;OAzDzBC,cAAcA;;;;;;;;;;;;;;;OAkDdC,kBAAkBA;;;;;OAlHlBC,QAAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCwEEC,WAAWA;cAAXA,WAAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+DXC,UAAUA;;;;cAAVA,UAAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6DVC,kBAAkBA;;;;cAAlBA,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA7LrBC,eAAeA;;;;cAuBfC,eAAeA;;;;cAuBfC,iBAAiBA;;;;;;OAhDxBC,UAAUA;OADVC,YAAYA",
+	"mappings": ";;;;;;iBAcgBA,UAAUA;;;;iBAuBVC,QAAQA;cClCXC,iBAAiBA;;;;cCAjBC,yBAAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OCHzBC,cAAcA;;;;;;;;;;OAqDdC,aAAaA;;;;;;;;OCrDbC,MAAMA;;;;;;;;;;;;;OAoHNC,WAAWA;;;;;;;;;;;;;;;;;;OCpHXC,YAAYA;;;;;;;;;OCEZC,MAAMA;;;;;;;OCuHNC,kBAAkBA;;;;;;;;;;;;;;OAzDzBC,cAAcA;;;;;;;;;;;;;;;OAkDdC,kBAAkBA;;;;;OAlHlBC,QAAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCwEEC,WAAWA;cAAXA,WAAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+DXC,UAAUA;;;;cAAVA,UAAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6DVC,kBAAkBA;;;;cAAlBA,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA7LrBC,eAAeA;;;;cAuBfC,eAAeA;;;;cAuBfC,iBAAiBA;;;;;;OAhDxBC,UAAUA;OADVC,YAAYA",
 	"ignoreList": []
 }