bpmn-engine 26.0.1 → 26.0.2

package/lib/index.cjs

@@ -177,7 +177,7 @@ const kTypeResolver = Symbol.for('type resolver');
 
 /**
  * BPMN 2.0 execution engine.
- * @param {import('types').BpmnEngineOptions} [options]
+ * @param {import('bpmn-engine').BpmnEngineOptions} [options]
  */
 function Engine(options) {
   if (!(this instanceof Engine)) return new Engine(options);
@@ -266,7 +266,7 @@ Object.defineProperties(Engine.prototype, {
 
 /**
  * Execute the loaded definitions.
- * @param {import('types').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
  * @param {(err: Error, execution?: Execution) => void} [callback]
  * @returns {Promise<Execution>}
  */
@@ -292,8 +292,8 @@ Engine.prototype.stop = function stop() {
 
 /**
  * Recover engine from saved state.
- * @param {import('types').BpmnEngineExecutionState | null} savedState
- * @param {import('types').BpmnEngineOptions} [recoverOptions]
+ * @param {import('bpmn-engine').BpmnEngineExecutionState | null} savedState
+ * @param {import('bpmn-engine').BpmnEngineOptions} [recoverOptions]
  * @returns {Engine}
  */
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
@@ -343,7 +343,7 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
 
 /**
  * Resume execution from a previously recovered state.
- * @param {import('types').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
  * @param {(err: Error, execution?: Execution) => void} [callback]
  * @returns {Promise<Execution>}
  */
@@ -370,7 +370,7 @@ Engine.prototype.resume = async function resume(...args) {
 
 /**
  * Add a pre-serialized source context to the engine.
- * @param {{ sourceContext: import('types').SerializableContext }} [options]
+ * @param {{ sourceContext: import('moddle-context-serializer').SerializableContext }} [options]
  */
 Engine.prototype.addSource = function addSource(options) {
   if (!options?.sourceContext) return;
@@ -380,7 +380,7 @@ Engine.prototype.addSource = function addSource(options) {
 };
 
 /**
- * @param {import('types').BpmnEngineExecuteOptions} [executeOptions]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [executeOptions]
  * @returns {Promise<import('bpmn-elements').Definition[]>}
  */
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -397,7 +397,7 @@ Engine.prototype.getDefinitionById = async function getDefinitionById(id) {
   return (await this.getDefinitions()).find((d) => d.id === id);
 };
 
-/** @returns {Promise<import('types').BpmnEngineExecutionState>} */
+/** @returns {Promise<import('bpmn-engine').BpmnEngineExecutionState>} */
 Engine.prototype.getState = async function getState() {
   const execution = this.execution;
   if (execution) return execution.getState();
@@ -408,7 +408,7 @@ Engine.prototype.getState = async function getState() {
 
 /**
  * @template R
- * @param {import('types').BpmnEngineEvent} eventName
+ * @param {import('bpmn-engine').BpmnEngineEvent} eventName
  * @returns {Promise<R>}
  */
 Engine.prototype.waitFor = function waitFor(eventName) {
@@ -478,7 +478,7 @@ Engine.prototype._getModdleContext = function getModdleContext(source) {
 /**
  * @param {Engine} engine
  * @param {any[]} definitions
- * @param {import('types').BpmnEngineExecuteOptions} [options]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [options]
  * @param {boolean} [isRecovered]
  */
 function Execution(engine, definitions, options, isRecovered = false) {
@@ -755,7 +755,7 @@ Execution.prototype._saveOutput = function saveOutput(output) {
   }
 };
 
-/** @returns {import('types').BpmnEngineExecutionState} */
+/** @returns {import('bpmn-engine').BpmnEngineExecutionState} */
 Execution.prototype.getState = function getState() {
   const definitions = [];
   for (const definition of this.definitions) {
@@ -797,7 +797,7 @@ Execution.prototype.getPostponed = function getPostponed() {
 };
 
 /**
- * @param {import('types').BpmnMessage} [payload]
+ * @param {import('bpmn-engine').BpmnMessage} [payload]
  * @param {{ ignoreSameDefinition?: boolean }} [signalOptions]
  */
 Execution.prototype.signal = function signal(payload, signalOptions) {
@@ -807,7 +807,7 @@ Execution.prototype.signal = function signal(payload, signalOptions) {
   }
 };
 
-/** @param {import('types').BpmnMessage} [payload] */
+/** @param {import('bpmn-engine').BpmnMessage} [payload] */
 Execution.prototype.cancelActivity = function cancelActivity(payload) {
   for (const definition of this[kExecuting]) {
     definition.cancelActivity(payload);
@@ -816,7 +816,7 @@ Execution.prototype.cancelActivity = function cancelActivity(payload) {
 
 /**
  * @template T
- * @param {import('types').BpmnEngineEvent} eventName
+ * @param {import('bpmn-engine').BpmnEngineEvent} eventName
  * @returns {Promise<T>}
  */
 Execution.prototype.waitFor = function waitFor(...args) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmn-engine",
   "description": "BPMN 2.0 execution engine. Open source javascript workflow engine.",
-  "version": "26.0.1",
+  "version": "26.0.2",
   "type": "module",
   "module": "./src/index.js",
   "main": "./lib/index.cjs",
@@ -32,13 +32,13 @@
   ],
   "scripts": {
     "test": "mocha -p -R @bonniernews/hot-bev",
-    "posttest": "npm run lint && npm run toc && npm run dist",
+    "posttest": "npm run lint && npm run toc && npm run dist && npm run test:md",
     "lint": "eslint . --cache && prettier . -c --cache",
     "wintest": "mocha",
     "cov:html": "c8 -r html -r text mocha -p -R @bonniernews/hot-bev",
     "test:lcov": "c8 -r lcov mocha && npm run lint",
     "toc": "node scripts/generate-api-toc ./docs/API.md,./docs/Examples.md",
-    "test-md": "texample ./docs/API.md,./docs/Examples.md,./docs/Upgrade.md",
+    "test:md": "texample ./docs/API.md,./docs/Examples.md,./docs/Upgrade.md -c .mocharc.json",
     "dist": "rollup -c",
     "prepack": "npm run dist"
   },
@@ -58,9 +58,6 @@
     }
   ],
   "overrides": {
-    "c8": {
-      "yargs": "^18.0.0"
-    },
     "mocha": {
       "yargs": "^18.0.0"
     }
@@ -70,24 +67,28 @@
     "@eslint/js": "^10.0.1",
     "@rollup/plugin-commonjs": "^29.0.0",
     "@types/bpmn-moddle": "^10.0.0",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^20.19.40",
     "bent": "^7.3.12",
-    "bpmn-elements": "^18.0.0",
+    "bpmn-elements": "^18.0.15",
     "bpmn-moddle": "^9.0.4",
     "bpmn-moddle-10": "npm:bpmn-moddle@^10.0.0",
-    "c8": "^11.0.0",
+    "c8": "^12.0.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^6.2.0",
     "chronokinesis": "^8.0.0",
     "debug": "^4.4.3",
     "eslint": "^10.5.0",
     "globals": "^17.6.0",
-    "moddle-context-serializer": "^6.0.0",
     "mocha": "^11.0.1",
     "mocha-cakes-2": "^3.3.0",
+    "moddle-context-serializer": "^6.0.0",
+    "nock": "^14.0.17",
     "prettier": "^3.2.5",
     "rollup": "^4.10.0",
-    "texample": "^1.0.2"
+    "texample": "^1.0.2",
+    "typescript": "^7.0.2"
   },
   "peerDependencies": {
     "bpmn-elements": ">=18",

package/src/index.js

@@ -31,7 +31,7 @@ export { JavaScripts };
 
 /**
  * BPMN 2.0 execution engine.
- * @param {import('types').BpmnEngineOptions} [options]
+ * @param {import('bpmn-engine').BpmnEngineOptions} [options]
  */
 export function Engine(options) {
   if (!(this instanceof Engine)) return new Engine(options);
@@ -120,7 +120,7 @@ Object.defineProperties(Engine.prototype, {
 
 /**
  * Execute the loaded definitions.
- * @param {import('types').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
  * @param {(err: Error, execution?: Execution) => void} [callback]
  * @returns {Promise<Execution>}
  */
@@ -146,8 +146,8 @@ Engine.prototype.stop = function stop() {
 
 /**
  * Recover engine from saved state.
- * @param {import('types').BpmnEngineExecutionState | null} savedState
- * @param {import('types').BpmnEngineOptions} [recoverOptions]
+ * @param {import('bpmn-engine').BpmnEngineExecutionState | null} savedState
+ * @param {import('bpmn-engine').BpmnEngineOptions} [recoverOptions]
  * @returns {Engine}
  */
 Engine.prototype.recover = function recover(savedState, recoverOptions) {
@@ -197,7 +197,7 @@ Engine.prototype.recover = function recover(savedState, recoverOptions) {
 
 /**
  * Resume execution from a previously recovered state.
- * @param {import('types').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions | ((err: Error, execution?: Execution) => void)} [optionsOrCallback]
  * @param {(err: Error, execution?: Execution) => void} [callback]
  * @returns {Promise<Execution>}
  */
@@ -224,7 +224,7 @@ Engine.prototype.resume = async function resume(...args) {
 
 /**
  * Add a pre-serialized source context to the engine.
- * @param {{ sourceContext: import('types').SerializableContext }} [options]
+ * @param {{ sourceContext: import('moddle-context-serializer').SerializableContext }} [options]
  */
 Engine.prototype.addSource = function addSource(options) {
   if (!options?.sourceContext) return;
@@ -234,7 +234,7 @@ Engine.prototype.addSource = function addSource(options) {
 };
 
 /**
- * @param {import('types').BpmnEngineExecuteOptions} [executeOptions]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [executeOptions]
  * @returns {Promise<import('bpmn-elements').Definition[]>}
  */
 Engine.prototype.getDefinitions = function getDefinitions(executeOptions) {
@@ -251,7 +251,7 @@ Engine.prototype.getDefinitionById = async function getDefinitionById(id) {
   return (await this.getDefinitions()).find((d) => d.id === id);
 };
 
-/** @returns {Promise<import('types').BpmnEngineExecutionState>} */
+/** @returns {Promise<import('bpmn-engine').BpmnEngineExecutionState>} */
 Engine.prototype.getState = async function getState() {
   const execution = this.execution;
   if (execution) return execution.getState();
@@ -262,7 +262,7 @@ Engine.prototype.getState = async function getState() {
 
 /**
  * @template R
- * @param {import('types').BpmnEngineEvent} eventName
+ * @param {import('bpmn-engine').BpmnEngineEvent} eventName
  * @returns {Promise<R>}
  */
 Engine.prototype.waitFor = function waitFor(eventName) {
@@ -332,7 +332,7 @@ Engine.prototype._getModdleContext = function getModdleContext(source) {
 /**
  * @param {Engine} engine
  * @param {any[]} definitions
- * @param {import('types').BpmnEngineExecuteOptions} [options]
+ * @param {import('bpmn-engine').BpmnEngineExecuteOptions} [options]
  * @param {boolean} [isRecovered]
  */
 export function Execution(engine, definitions, options, isRecovered = false) {
@@ -609,7 +609,7 @@ Execution.prototype._saveOutput = function saveOutput(output) {
   }
 };
 
-/** @returns {import('types').BpmnEngineExecutionState} */
+/** @returns {import('bpmn-engine').BpmnEngineExecutionState} */
 Execution.prototype.getState = function getState() {
   const definitions = [];
   for (const definition of this.definitions) {
@@ -651,7 +651,7 @@ Execution.prototype.getPostponed = function getPostponed() {
 };
 
 /**
- * @param {import('types').BpmnMessage} [payload]
+ * @param {import('bpmn-engine').BpmnMessage} [payload]
  * @param {{ ignoreSameDefinition?: boolean }} [signalOptions]
  */
 Execution.prototype.signal = function signal(payload, signalOptions) {
@@ -661,7 +661,7 @@ Execution.prototype.signal = function signal(payload, signalOptions) {
   }
 };
 
-/** @param {import('types').BpmnMessage} [payload] */
+/** @param {import('bpmn-engine').BpmnMessage} [payload] */
 Execution.prototype.cancelActivity = function cancelActivity(payload) {
   for (const definition of this[kExecuting]) {
     definition.cancelActivity(payload);
@@ -670,7 +670,7 @@ Execution.prototype.cancelActivity = function cancelActivity(payload) {
 
 /**
  * @template T
- * @param {import('types').BpmnEngineEvent} eventName
+ * @param {import('bpmn-engine').BpmnEngineEvent} eventName
  * @returns {Promise<T>}
  */
 Execution.prototype.waitFor = function waitFor(...args) {

package/types/index.d.ts

@@ -2,7 +2,7 @@ declare module 'bpmn-engine' {
   import type { EventEmitter } from 'node:events';
   import type { Broker } from 'smqp';
   import type { Definitions as BpmnModdleDefinitions } from 'bpmn-moddle';
-  import type { ExtendFn, SerializableContext, ResolverFn } from 'moddle-context-serializer';
+  import type { ExtendFn, SerializableContext, TypeResolverExtender } from 'moddle-context-serializer';
   import type {
     ActivityStatus,
     Definition,
@@ -16,7 +16,7 @@ declare module 'bpmn-engine' {
     Script,
   } from 'bpmn-elements';
 
-  export type BpmnEngineEvent = 'error' | 'stop' | 'end';
+  export type BpmnEngineEvent = 'error' | 'stop' | 'end' | 'wait';
 
   export type BpmnActivityEvent =
     | 'activity.enter'
@@ -49,16 +49,17 @@ declare module 'bpmn-engine' {
 
   export interface BpmnEngineOptions extends BpmnEngineExecuteOptions {
     name?: string;
-    source?: string;
+    source?: string | Buffer;
     sourceContext?: SerializableContext;
     elements?: Record<string, any>;
-    typeResolver?: ResolverFn;
+    typeResolver?: TypeResolverExtender;
     extendFn?: ExtendFn;
     moddleOptions?: any;
     moddleContext?: BpmnModdleDefinitions;
     Logger?: (scope: string) => ILogger;
     scripts?: IScripts;
     disableDummyScript?: boolean;
+    listener?: EventEmitter | IListenerEmitter;
     [x: string]: any;
   }
 
@@ -69,19 +70,19 @@ declare module 'bpmn-engine' {
   }
 
   export interface BpmnEngineExecutionState {
-    name: string;
-    engineVersion: string;
-    state: BpmnEngineRunningStatus;
-    stopped: boolean;
-    environment: EnvironmentState;
-    definitions: BpmnEngineDefinitionState[];
+    name?: string;
+    engineVersion?: string;
+    state?: BpmnEngineRunningStatus;
+    stopped?: boolean;
+    environment?: EnvironmentState;
+    definitions?: BpmnEngineDefinitionState[];
   }
 
   export function Engine(options?: BpmnEngineOptions): Engine;
   export class Engine extends EventEmitter {
     constructor(options?: BpmnEngineOptions);
     options: BpmnEngineOptions;
-    readonly name: string;
+    name: string;
     readonly broker: Broker;
     readonly logger: ILogger;
     readonly environment: Environment;
@@ -99,7 +100,7 @@ declare module 'bpmn-engine' {
     getDefinitions(executeOptions?: BpmnEngineExecuteOptions): Promise<Definition[]>;
     getState(): Promise<BpmnEngineExecutionState>;
 
-    recover(savedState: BpmnEngineExecutionState | null, recoverOptions?: BpmnEngineOptions): Engine;
+    recover(savedState?: BpmnEngineExecutionState | null, recoverOptions?: BpmnEngineOptions): Engine;
 
     resume(): Promise<Execution>;
     resume(options: BpmnEngineExecuteOptions): Promise<Execution>;
@@ -143,11 +144,15 @@ declare module 'bpmn-engine' {
     waitFor<R>(eventName: BpmnEngineEvent): Promise<R>;
   }
 
-  export class JavaScripts implements IScripts {
-    constructor(disableDummy?: boolean);
+  export interface JavaScripts extends IScripts {
     register(activity: any): Script | undefined;
-    getScript(language: string, identifier: { id: string; [x: string]: any }): Script;
+    getScript(language: string, identifier: { id: string; [x: string]: any }): Script | undefined;
   }
+  export const JavaScripts: {
+    new (disableDummy?: boolean): JavaScripts;
+    /** callable without new */
+    (disableDummy?: boolean): JavaScripts;
+  };
 
   export default Engine;
 }

package/types/interfaces.d.ts

@@ -1,80 +0,0 @@
-import type { EventEmitter } from 'node:events';
-import type { Definitions as BpmnModdleDefinitions } from 'bpmn-moddle';
-import type { ExtendFn, SerializableContext, ResolverFn } from 'moddle-context-serializer';
-import type { ActivityStatus, ElementBroker, EnvironmentOptions, EnvironmentState, IScripts, Script, ILogger } from 'bpmn-elements';
-
-export type { SerializableContext };
-
-export type BpmnEngineEvent = 'error' | 'stop' | 'end';
-
-export type BpmnActivityEvent =
-  | 'activity.enter'
-  | 'activity.start'
-  | 'activity.wait'
-  | 'wait'
-  | 'activity.end'
-  | 'activity.leave'
-  | 'activity.stop'
-  | 'activity.throw'
-  | 'activity.error';
-
-export type BpmnSequenceFlowEvent = 'flow.take' | 'flow.discard' | 'flow.looped';
-
-export type BpmnEngineRunningStatus = 'idle' | 'running' | 'stopped' | 'error';
-
-export interface BpmnMessage {
-  id?: string;
-  executionId?: string;
-  [name: string]: any;
-}
-
-export interface IListenerEmitter {
-  emit(eventName: string, ...args: any[]): void;
-}
-
-export interface BpmnEngineExecuteOptions extends EnvironmentOptions {
-  listener?: EventEmitter | IListenerEmitter;
-}
-
-export interface BpmnEngineOptions extends BpmnEngineExecuteOptions {
-  name?: string;
-  source?: string;
-  sourceContext?: SerializableContext;
-  elements?: Record<string, any>;
-  typeResolver?: ResolverFn;
-  extendFn?: ExtendFn;
-  moddleOptions?: any;
-  moddleContext?: BpmnModdleDefinitions;
-  Logger?: (scope: string) => ILogger;
-  scripts?: IScripts;
-  disableDummyScript?: boolean;
-  [x: string]: any;
-}
-
-export interface BpmnEngineDefinitionState {
-  state: string;
-  source?: string;
-  [x: string]: any;
-}
-
-export interface BpmnEngineExecutionState {
-  name: string;
-  engineVersion: string;
-  state: BpmnEngineRunningStatus;
-  stopped: boolean;
-  environment: EnvironmentState;
-  definitions: BpmnEngineDefinitionState[];
-}
-
-export type {
-  ActivityStatus,
-  BpmnModdleDefinitions,
-  ElementBroker,
-  EnvironmentOptions,
-  EnvironmentState,
-  ExtendFn,
-  ILogger,
-  IScripts,
-  ResolverFn,
-  Script,
-};