0.3.2. (#5)

Author: b4rtaz

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.2
+
+The `LoopActivityEventHandler` can return `void` or `Promise` now.
+
 ## 0.3.1
 
 This version adds a new feature to the `break` activity. Now it is possible to break a parent loop without specifying the name of the loop. The previous approach is still supported.
@@ -18,14 +22,14 @@ This version changes the syntax of all `create*Activity` functions. The first ar
 const fooActivity = createAtomActivity<FooStep, MyGlobalState, FooStateState>({
   stepType: 'foo',
   init: /* ... */,
-  handler: /* ... */,
-})
+  handler: /* ... */
+});
 
 // New syntax
 const fooActivity = createAtomActivity<FooStep, MyGlobalState, FooStateState>('foo', {
   init: /* ... */,
-  handler: /* ... */,
-})
+  handler: /* ... */
+});
 ```
 
 Additionally this version introduces the `createAtomActivityFromHandler` function. It allows to create an activity by very short syntax. This function creates an activity without the activity state.

machine/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "sequential-workflow-machine",
 	"description": "Powerful sequential workflow machine for frontend and backend applications.",
-	"version": "0.3.1",
+	"version": "0.3.2",
 	"type": "module",
 	"main": "./lib/esm/index.js",
 	"types": "./lib/index.d.ts",

machine/src/activities/loop-activity/loop-activity-node-builder.ts

@@ -48,7 +48,10 @@ export class LoopActivityNodeBuilder<TStep extends SequentialStep, TGlobalState,
 						src: catchUnhandledError(async (context: MachineContext<TGlobalState>) => {
 							if (this.config.onEnter) {
 								const internalState = activityStateProvider.get(context, nodeId);
-								this.config.onEnter(step, context.globalState, internalState.activityState);
+								const promise = this.config.onEnter(step, context.globalState, internalState.activityState);
+								if (promise) {
+									await promise;
+								}
 							}
 						}),
 						onDone: 'CONDITION',
@@ -95,7 +98,10 @@ export class LoopActivityNodeBuilder<TStep extends SequentialStep, TGlobalState,
 						src: catchUnhandledError(async (context: MachineContext<TGlobalState>) => {
 							if (this.config.onLeave) {
 								const internalState = activityStateProvider.get(context, nodeId);
-								this.config.onLeave(step, context.globalState, internalState.activityState);
+								const promise = this.config.onLeave(step, context.globalState, internalState.activityState);
+								if (promise) {
+									await promise;
+								}
 							}
 						}),
 						onDone: nextNodeTarget,

machine/src/activities/loop-activity/loop-activity.spec.ts

@@ -6,6 +6,7 @@ import { Definition, SequentialStep, Step } from 'sequential-workflow-model';
 
 interface TestGlobalState {
 	counter: number;
+	trace: string;
 }
 
 function createTaskStep(id: string): Step {
@@ -44,7 +45,24 @@ const activitySet = createActivitySet<TestGlobalState>([
 	createLoopActivity<SequentialStep, TestGlobalState>('loop', {
 		loopName: () => 'loop',
 		init: () => ({}),
+		onEnter: (_, globalState) => {
+			return new Promise(resolve => {
+				setTimeout(() => {
+					globalState.trace += '(onEnter)';
+					resolve();
+				}, 10);
+			});
+		},
+		onLeave: (_, globalState) => {
+			return new Promise(resolve => {
+				setTimeout(() => {
+					globalState.trace += '(onLeave)';
+					resolve();
+				}, 10);
+			});
+		},
 		condition: async (_, globalState) => {
+			globalState.trace += '(condition)';
 			return globalState.counter < 3;
 		}
 	})
@@ -58,7 +76,8 @@ describe('LoopActivity', () => {
 		const interpreter = machine
 			.create({
 				init: () => ({
-					counter: 0
+					counter: 0,
+					trace: ''
 				})
 			})
 			.start();
@@ -67,6 +86,7 @@ describe('LoopActivity', () => {
 			const globalState = interpreter.getSnapshot().globalState;
 
 			expect(globalState.counter).toBe(4);
+			expect(globalState.trace).toBe('(onEnter)(condition)(condition)(condition)(onLeave)');
 
 			done();
 		});

machine/src/activities/loop-activity/types.ts

@@ -7,7 +7,7 @@ export type LoopActivityEventHandler<TStep extends SequentialStep, TGlobalState,
 	step: TStep,
 	globalState: TGlobalState,
 	activityState: TActivityState
-) => void;
+) => Promise<void> | void;
 export type LoopActivityConditionHandler<TStep extends SequentialStep, TGlobalState, TActivityState> = (
 	step: TStep,
 	globalState: TGlobalState,