0.3.1. (#4)

* 0.3.1.

Author: b4rtaz

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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.
+
+```ts
+createBreakActivity<BreakStep>('break', {
+  loopName: (step) => -1,
+  // ...
+});
+```
+
 ## 0.3.0
 
 This version changes the syntax of all `create*Activity` functions. The first argument is the step type, the second argument is the configuration.

machine/package.json

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

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

@@ -26,8 +26,8 @@ export class BreakActivityNodeBuilder<TStep extends Step, TGlobalState, TActivit
 		});
 		const nodeId = getStepNodeId(step.id);
 
-		const loopName = this.config.loopName(step);
-		const leaveNodeTarget = getLoopStack(buildingContext).getNodeTarget(loopName);
+		const loopNameOrIndex = this.config.loopName(step);
+		const leaveNodeTarget = getLoopStack(buildingContext).getNodeTarget(loopNameOrIndex);
 
 		return {
 			id: nodeId,

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

@@ -12,7 +12,7 @@ export type BreakActivityHandler<TStep extends Step, TGlobalState, TActivityStat
 export type BreakActivityHandlerResult = void | InterruptResult | BreakResult;
 
 export interface BreakActivityConfig<TStep extends Step, TGlobalState, TActivityState extends object> {
-	loopName: (step: TStep) => string;
+	loopName: (step: TStep) => string | -1;
 	init: ActivityStateInitializer<TStep, TGlobalState, TActivityState>;
 	handler: BreakActivityHandler<TStep, TGlobalState, TActivityState>;
 }

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

@@ -0,0 +1,56 @@
+import { LoopStack } from './loop-stack';
+
+describe('LoopStack', () => {
+	describe('when stack contains 3 loops', () => {
+		let stack: LoopStack;
+
+		beforeEach(() => {
+			stack = new LoopStack();
+			stack.push('loop1', 'leave1');
+			stack.push('loop2', 'leave2');
+			stack.push('loop3', 'leave3');
+		});
+
+		it('returns proper target when argument is name', () => {
+			expect(stack.getNodeTarget('loop1')).toBe('leave1');
+			expect(stack.getNodeTarget('loop2')).toBe('leave2');
+			expect(stack.getNodeTarget('loop3')).toBe('leave3');
+		});
+
+		it('returns proper target when argument is name', () => {
+			expect(stack.getNodeTarget(-1)).toBe('leave3');
+		});
+
+		it('throws error when index is 0', () => {
+			expect(() => stack.getNodeTarget(0 as unknown as -1)).toThrowError('Index 0 is not supported');
+		});
+
+		it('throws error when index is 1', () => {
+			expect(() => stack.getNodeTarget(1 as unknown as -1)).toThrowError('Index 1 is not supported');
+		});
+
+		it('throws error when name is not found', () => {
+			expect(() => stack.getNodeTarget('foo')).toThrowError('Loop "foo" not found');
+		});
+
+		it('pop() removes last item', () => {
+			expect(stack.getCurrentName()).toBe('loop3');
+
+			stack.pop();
+			expect(stack.getCurrentName()).toBe('loop2');
+
+			stack.pop();
+			expect(stack.getCurrentName()).toBe('loop1');
+
+			stack.pop();
+			expect(stack.getCurrentName()).toBe(null);
+		});
+	});
+
+	describe('when stack is empty', () => {
+		it('throws error when index is -1', () => {
+			const stack = new LoopStack();
+			expect(() => stack.getNodeTarget(-1)).toThrowError('Cannot find any parent loop');
+		});
+	});
+});

machine/src/activities/loop-stack.ts

@@ -34,10 +34,26 @@ export class LoopStack {
 		this.stack.pop();
 	}
 
-	public getNodeTarget(name: string): string {
-		const item = this.stack.find(item => item.name === name);
-		if (!item) {
-			throw new Error(`Loop with name "${name}" not found`);
+	public getCurrentName(): string | null {
+		const item = this.stack[this.stack.length - 1];
+		return item ? item.name : null;
+	}
+
+	public getNodeTarget(nameOrIndex: string | -1): string {
+		let item: LoopStackItem | undefined;
+		if (typeof nameOrIndex === 'number') {
+			if (nameOrIndex !== -1) {
+				throw new Error(`Index ${nameOrIndex} is not supported`);
+			}
+			item = this.stack[this.stack.length - 1];
+			if (!item) {
+				throw new Error('Cannot find any parent loop');
+			}
+		} else {
+			item = this.stack.find(item => item.name === nameOrIndex);
+			if (!item) {
+				throw new Error(`Loop "${nameOrIndex}" not found`);
+			}
 		}
 		return item.leaveNodeTarget;
 	}