fix ignored options.extendFn

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 22.0.1
+
+- for a number of years the `extendFn` option has been accepted, but never passed to moddle-context-serializer. Now it is
+- fix type declaration for options `extendFn` and `TypeResolver`
+- type declare that a generic listener instance with an emit function works just as well as a full blown new EventEmitter
+
 # 22.0.0
 
 Performance tweaks.

docs/API.md

@@ -1,6 +1,6 @@
 <!-- version -->
 
-# 22.0.0 API Reference
+# 22.0.1 API Reference
 
 <!-- versionstop -->
 

lib/index.cjs

@@ -412,7 +412,7 @@ Engine.prototype._serializeSource = async function serializeSource(source) {
 };
 
 Engine.prototype._serializeModdleContext = function serializeModdleContext(moddleContext) {
-  return serializer(moddleContext, this[kTypeResolver]);
+  return serializer(moddleContext, this[kTypeResolver], this.options.extendFn);
 };
 
 Engine.prototype._getModdleContext = function getModdleContext(source) {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "22.0.0",
+  "version": "22.0.1",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",

src/index.js

@@ -266,7 +266,7 @@ Engine.prototype._serializeSource = async function serializeSource(source) {
 };
 
 Engine.prototype._serializeModdleContext = function serializeModdleContext(moddleContext) {
-  return serializer(moddleContext, this[kTypeResolver]);
+  return serializer(moddleContext, this[kTypeResolver], this.options.extendFn);
 };
 
 Engine.prototype._getModdleContext = function getModdleContext(source) {

test/feature/extend-feature.js

@@ -251,6 +251,45 @@ Feature('extending behaviour', () => {
     });
   });
 
+  Scenario('Extend function option', () => {
+    let engine, source;
+    Given('a bpmn source', () => {
+      source = `
+      <definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+        <process id="theProcess" isExecutable="true">
+          <scriptTask id="task1">
+            <script>Placeholder</script>
+          </scriptTask>
+        </process>
+      </definitions>`;
+    });
+
+    const fnCalls = [];
+    And('an engine loaded with extendFn', () => {
+      engine = Engine({
+        name: 'Scripts feature',
+        source,
+        extendFn(...args) {
+          fnCalls.push(args);
+        },
+      });
+    });
+
+    let api;
+    When('source is executed', async () => {
+      api = await engine.execute();
+    });
+
+    Then('engine comletes run', () => {
+      expect(api.state).to.equal('idle');
+    });
+
+    And('extendFn has been called', () => {
+      expect(fnCalls.length).to.be.above(0);
+    });
+  });
+
   Scenario('End event with extension (issue #25)', () => {
     let source;
     Given('a source with extension elements on end event', () => {

types/bpmn-engine.d.ts

@@ -3,7 +3,11 @@
 
 import { EventEmitter } from 'node:events';
 import { Definitions as BpmnModdleDefinitions } from 'bpmn-moddle';
-import { extendFn, SerializableContext } from 'moddle-context-serializer';
+import {
+  extendFn,
+  SerializableContext,
+  TypeResolver,
+} from 'moddle-context-serializer';
 import {
   ActivityStatus,
   ElementBroker,
@@ -68,8 +72,12 @@ declare module 'bpmn-engine' {
     [name: string]: any;
   }
 
+  export interface IListenerEmitter {
+    emit(eventName: string, ...args: any[]): void;
+  }
+
   export interface BpmnEngineExecuteOptions extends EnvironmentOptions {
-    listener?: EventEmitter;
+    listener?: EventEmitter | IListenerEmitter;
   }
 
   export interface BpmnEngineOptions extends BpmnEngineExecuteOptions {
@@ -89,15 +97,20 @@ declare module 'bpmn-engine' {
      * optional override of BPMN Elements behaviors, defaults to bpmn-elements
      */
     elements?: Record<string, any>;
+    /**
+     * Passed to moddle-context-serializer as TypeResolver
+     */
+    typeResolver?: typeof TypeResolver;
     /**
      * Passed to moddle-context-serializer as extendFn
      */
-    typeResolver?: extendFn;
+    extendFn?: extendFn;
     /**
      * optional bpmn-moddle options to be passed to bpmn-moddle
      */
     moddleOptions?: any;
     moddleContext?: BpmnModdleDefinitions;
+    [x: string]: any;
   }
 
   const enum BpmnEngineRunningStatus {