bpmn-elements 17.3.0 → 18.0.0

package/src/tasks/SubProcess.js

@@ -1,11 +1,16 @@
-import Activity from '../activity/Activity.js';
-import ProcessExecution from '../process/ProcessExecution.js';
+import { Activity } from '../activity/Activity.js';
+import { ProcessExecution } from '../process/ProcessExecution.js';
 import { cloneContent } from '../messageHelper.js';
 
-const kExecutions = Symbol.for('executions');
-const kOnExecutionCompleted = Symbol.for('execution completed handler');
+const K_EXECUTIONS = Symbol.for('executions');
+const K_ON_EXECUTION_COMPLETED = Symbol.for('execution completed handler');
 
-export default function SubProcess(activityDef, context) {
+/**
+ * Sub process
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
+export function SubProcess(activityDef, context) {
   const triggeredByEvent = activityDef.behaviour && activityDef.behaviour.triggeredByEvent;
   const subProcess = new Activity(SubProcessBehaviour, { ...activityDef, isSubProcess: true, triggeredByEvent }, context);
 
@@ -26,10 +31,16 @@ export default function SubProcess(activityDef, context) {
   }
 }
 
+/**
+ * Sub process behaviour
+ * @param {import('#types').Activity} activity
+ * @param {import('#types').ContextInstance} context
+ */
 export function SubProcessBehaviour(activity, context) {
   const { id, type, behaviour } = activity;
   this.id = id;
   this.type = type;
+  /** @type {import('./LoopCharacteristics.js').LoopCharacteristics | undefined} */
   this.loopCharacteristics =
     behaviour.loopCharacteristics && new behaviour.loopCharacteristics.Behaviour(activity, behaviour.loopCharacteristics);
   this.activity = activity;
@@ -38,23 +49,26 @@ export function SubProcessBehaviour(activity, context) {
   this.broker = activity.broker;
   this.executionId = undefined;
 
-  this[kExecutions] = new Set();
-  this[kOnExecutionCompleted] = this._onExecutionCompleted.bind(this);
+  this[K_EXECUTIONS] = new Set();
+  this[K_ON_EXECUTION_COMPLETED] = this._onExecutionCompleted.bind(this);
 }
 
-Object.defineProperties(SubProcessBehaviour.prototype, {
-  execution: {
-    get() {
-      return [...this[kExecutions]][0];
-    },
+Object.defineProperty(SubProcessBehaviour.prototype, 'execution', {
+  get() {
+    return [...this[K_EXECUTIONS]][0];
   },
-  executions: {
-    get() {
-      return [...this[kExecutions]];
-    },
+});
+
+Object.defineProperty(SubProcessBehaviour.prototype, 'executions', {
+  get() {
+    return [...this[K_EXECUTIONS]];
   },
 });
 
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
   const { isRootScope, executionId } = executeMessage.content;
 
@@ -73,7 +87,7 @@ SubProcessBehaviour.prototype.execute = function execute(executeMessage) {
 
 SubProcessBehaviour.prototype.getState = function getState() {
   const states = [];
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     const state = pe.getState();
     state.environment = pe.environment.getState();
     states.push(state);
@@ -91,7 +105,7 @@ SubProcessBehaviour.prototype.getState = function getState() {
 SubProcessBehaviour.prototype.recover = function recover(state) {
   if (!state) return;
 
-  const executions = this[kExecutions];
+  const executions = this[K_EXECUTIONS];
 
   const loopCharacteristics = this.loopCharacteristics;
   if (loopCharacteristics && state.executions) {
@@ -117,7 +131,7 @@ SubProcessBehaviour.prototype.recover = function recover(state) {
 
 SubProcessBehaviour.prototype.getPostponed = function getPostponed() {
   let postponed = [];
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     postponed = postponed.concat(pe.getPostponed());
   }
   return postponed;
@@ -137,7 +151,7 @@ SubProcessBehaviour.prototype._upsertExecution = function upsertExecution(execut
   const subContext = this.context.clone(subEnvironment, this.activity);
 
   execution = new ProcessExecution(this.activity, subContext);
-  this[kExecutions].add(execution);
+  this[K_EXECUTIONS].add(execution);
 
   this._addListeners(executionId);
 
@@ -145,7 +159,7 @@ SubProcessBehaviour.prototype._upsertExecution = function upsertExecution(execut
 };
 
 SubProcessBehaviour.prototype._addListeners = function addListeners(executionId) {
-  this.broker.subscribeTmp('subprocess-execution', `execution.#.${executionId}`, this[kOnExecutionCompleted], {
+  this.broker.subscribeTmp('subprocess-execution', `execution.#.${executionId}`, this[K_ON_EXECUTION_COMPLETED], {
     noAck: true,
     consumerTag: `_sub-process-execution-${executionId}`,
   });
@@ -182,7 +196,7 @@ SubProcessBehaviour.prototype._onExecutionCompleted = function onExecutionComple
 SubProcessBehaviour.prototype._completeExecution = function completeExecution(completeRoutingKey, content) {
   if (this.loopCharacteristics) {
     const execution = this._getExecutionById(content.executionId);
-    this[kExecutions].delete(execution);
+    this[K_EXECUTIONS].delete(execution);
   }
 
   this.broker.publish('execution', completeRoutingKey, cloneContent(content));
@@ -206,7 +220,7 @@ SubProcessBehaviour.prototype.getApi = function getApi(apiMessage) {
 };
 
 SubProcessBehaviour.prototype._getExecutionById = function getExecutionById(executionId) {
-  for (const pe of this[kExecutions]) {
+  for (const pe of this[K_EXECUTIONS]) {
     if (pe.executionId === executionId) return pe;
   }
 };

package/src/tasks/Task.js

@@ -1,19 +1,33 @@
-import Activity from '../activity/Activity.js';
+import { Activity } from '../activity/Activity.js';
 import { cloneContent } from '../messageHelper.js';
 
-export default function Task(activityDef, context) {
+/**
+ * Task
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
+export function Task(activityDef, context) {
   return new Activity(TaskBehaviour, activityDef, context);
 }
 
+/**
+ * Task behaviour
+ * @param {import('#types').Activity} activity
+ */
 export function TaskBehaviour(activity) {
   const { id, type, behaviour, broker } = activity;
   this.id = id;
   this.type = type;
+  /** @type {import('./LoopCharacteristics.js').LoopCharacteristics | undefined} */
   this.loopCharacteristics =
     behaviour.loopCharacteristics && new behaviour.loopCharacteristics.Behaviour(activity, behaviour.loopCharacteristics);
   this.broker = broker;
 }
 
+/**
+ * @param {import('#types').ElementBrokerMessage} executeMessage
+ * @returns {void}
+ */
 TaskBehaviour.prototype.execute = function execute(executeMessage) {
   const executeContent = executeMessage.content;
   const loopCharacteristics = this.loopCharacteristics;

package/src/tasks/Transaction.js

@@ -1,6 +1,10 @@
-import SubProcess from './SubProcess.js';
-
-export default function Transaction(activityDef, context) {
+import { SubProcess } from './SubProcess.js';
+/**
+ * Transaction
+ * @param {import('moddle-context-serializer').Activity} activityDef
+ * @param {import('#types').ContextInstance} context
+ */
+export function Transaction(activityDef, context) {
   const transaction = { type: 'transaction', ...activityDef, isTransaction: true };
   const activity = SubProcess(transaction, context);
   return activity;

package/src/tasks/index.js

@@ -1,12 +1,11 @@
-import CallActivity, { CallActivityBehaviour } from './CallActivity.js';
-import ReceiveTask, { ReceiveTaskBehaviour } from './ReceiveTask.js';
-import ScriptTask, { ScriptTaskBehaviour } from './ScriptTask.js';
-import ServiceTask, { ServiceTaskBehaviour } from './ServiceTask.js';
-import SignalTask, { SignalTaskBehaviour } from './SignalTask.js';
-import SubProcess, { SubProcessBehaviour } from './SubProcess.js';
-import Task, { TaskBehaviour } from './Task.js';
-import Transaction from './Transaction.js';
-
+import { CallActivity, CallActivityBehaviour } from './CallActivity.js';
+import { ReceiveTask, ReceiveTaskBehaviour } from './ReceiveTask.js';
+import { ScriptTask, ScriptTaskBehaviour } from './ScriptTask.js';
+import { ServiceTask, ServiceTaskBehaviour } from './ServiceTask.js';
+import { SignalTask, SignalTaskBehaviour } from './SignalTask.js';
+import { SubProcess, SubProcessBehaviour } from './SubProcess.js';
+import { Task, TaskBehaviour } from './Task.js';
+import { Transaction } from './Transaction.js';
 export {
   CallActivity,
   CallActivityBehaviour,

package/types/bundle-errors.d.ts

@@ -0,0 +1 @@
+export * from '../src/error/Errors.js';

package/types/bundle.d.ts

@@ -0,0 +1,97 @@
+// Hand-written entry for dts-buddy. Re-exports the runtime classes once each
+// and the shared interfaces in one place so the emitted bundle has a single
+// declaration per name (no `_1` aliases, no per-module duplicates).
+//
+// Submodule type entries (`bpmn-elements/events`, `…/tasks`, etc.) are
+// emitted as trivial re-export blocks by `scripts/build-types.js`, so every
+// public name needs a home here.
+export * from './interfaces.js';
+
+export { Activity } from '../src/activity/Activity.js';
+export { ActivityExecution } from '../src/activity/ActivityExecution.js';
+export { BpmnErrorActivity as BpmnError } from '../src/error/BpmnError.js';
+export { Context } from '../src/Context.js';
+export { Definition } from '../src/definition/Definition.js';
+export { DefinitionExecution } from '../src/definition/DefinitionExecution.js';
+export { DummyActivity as Dummy } from '../src/activity/Dummy.js';
+export { DummyActivity as TextAnnotation } from '../src/activity/Dummy.js';
+export { DummyActivity as Group } from '../src/activity/Dummy.js';
+export { DummyActivity as Category } from '../src/activity/Dummy.js';
+export { Environment } from '../src/Environment.js';
+export { EnvironmentDataObject as DataObject } from '../src/io/EnvironmentDataObject.js';
+export { EnvironmentDataStore as DataStore } from '../src/io/EnvironmentDataStore.js';
+export { EnvironmentDataStoreReference as DataStoreReference } from '../src/io/EnvironmentDataStoreReference.js';
+export { Escalation } from '../src/activity/Escalation.js';
+export { IoSpecification as InputOutputSpecification } from '../src/io/InputOutputSpecification.js';
+export { Lane } from '../src/process/Lane.js';
+export { LoopCharacteristics as MultiInstanceLoopCharacteristics } from '../src/tasks/LoopCharacteristics.js';
+export { Message } from '../src/activity/Message.js';
+export { Process } from '../src/process/Process.js';
+export { Properties } from '../src/io/Properties.js';
+export { ServiceImplementation } from '../src/tasks/ServiceImplementation.js';
+export { Signal } from '../src/activity/Signal.js';
+export { StandardLoopCharacteristics } from '../src/tasks/StandardLoopCharacteristics.js';
+
+export { Association, MessageFlow, SequenceFlow } from '../src/flows/index.js';
+export {
+  BoundaryEvent,
+  BoundaryEventBehaviour,
+  EndEvent,
+  EndEventBehaviour,
+  IntermediateCatchEvent,
+  IntermediateCatchEventBehaviour,
+  IntermediateThrowEvent,
+  IntermediateThrowEventBehaviour,
+  StartEvent,
+  StartEventBehaviour,
+} from '../src/events/index.js';
+export {
+  EventBasedGateway,
+  EventBasedGatewayBehaviour,
+  ExclusiveGateway,
+  ExclusiveGatewayBehaviour,
+  InclusiveGateway,
+  InclusiveGatewayBehaviour,
+  ParallelGateway,
+  ParallelGatewayBehaviour,
+} from '../src/gateways/index.js';
+// dts-buddy collapses multi-aliased exports to a single name (the last in source
+// order), so the canonical name must come *after* its aliases — otherwise the
+// alias wins and the root module loses the canonical name that the
+// `bpmn-elements/tasks` re-export depends on.
+export {
+  CallActivity,
+  CallActivityBehaviour,
+  ReceiveTask,
+  ReceiveTaskBehaviour,
+  ServiceTask as BusinessRuleTask,
+  ServiceTask as SendTask,
+  ServiceTask,
+  ServiceTaskBehaviour,
+  ScriptTask,
+  ScriptTaskBehaviour,
+  SignalTask as ManualTask,
+  SignalTask as UserTask,
+  SignalTask,
+  SignalTaskBehaviour,
+  SubProcess as AdHocSubProcess,
+  SubProcess,
+  SubProcessBehaviour,
+  Task,
+  TaskBehaviour,
+  Transaction,
+} from '../src/tasks/index.js';
+export {
+  CancelEventDefinition,
+  CompensateEventDefinition,
+  ConditionalEventDefinition,
+  EscalationEventDefinition,
+  ErrorEventDefinition,
+  LinkEventDefinition,
+  MessageEventDefinition,
+  SignalEventDefinition,
+  TerminateEventDefinition,
+  TimerEventDefinition,
+} from '../src/eventDefinitions/index.js';
+
+export { ActivityError, RunError } from '../src/error/Errors.js';