0.1.4. (#1)

Author: b4rtaz

.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: main
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Build
+    runs-on: ${{matrix.os}}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18
+      - name: Install
+        run: yarn install
+      - name: Build
+        run: yarn build
+      - name: Prettier
+        run: yarn prettier
+      - name: Tests
+        run: yarn test:single

CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.1.4
+
+* Added the `forEach()` method to the `DefinitionWalker` class.
+* The `getParents()` method of the `DefinitionWalker` class accepts a `stepId` argument.

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "sequential-workflow-model",
 	"description": "Extendable data model of sequential workflow.",
-	"version": "0.1.3",
+	"version": "0.1.4",
 	"homepage": "https://nocode-js.com/",
 	"author": {
 		"name": "NoCode JS",
@@ -43,11 +43,11 @@
 	},
 	"devDependencies": {
 		"typescript": "^4.9.5",
-		"rollup-plugin-dts": "^5.2.0",
-		"rollup-plugin-typescript2": "^0.34.1",
-		"rollup": "^3.18.0",
+		"rollup-plugin-dts": "^5.3.0",
+		"rollup-plugin-typescript2": "^0.35.0",
+		"rollup": "^3.25.3",
 		"prettier": "^2.8.8",
-		"@types/jest": "^29.5.1",
+		"@types/jest": "^29.5.2",
 		"jest": "^29.5.0",
 		"ts-jest": "^29.1.0"
 	},

src/definition-walker/definition-walker.spec.ts

@@ -27,8 +27,8 @@ describe('DefinitionWalker', () => {
 	}
 
 	const taskFoo = createTask('foo');
-	const ifAlfa = createIf('beta', taskFoo);
-	const ifBeta = createIf('alfa', ifAlfa);
+	const ifAlfa = createIf('alfa', taskFoo);
+	const ifBeta = createIf('beta', ifAlfa);
 	const loop = {
 		componentType: 'container',
 		id: 'loop',
@@ -98,6 +98,13 @@ describe('DefinitionWalker', () => {
 			const parents = walker.getParents(definition, definition.sequence);
 			expect(parents.length).toEqual(0);
 		});
+
+		it('returns parents when passed stepId', () => {
+			const parents = walker.getParents(definition, 'ifbeta');
+			expect(parents.length).toEqual(2);
+			expect(parents[0]).toBe(loop);
+			expect(parents[1]).toBe(ifBeta);
+		});
 	});
 
 	describe('findById', () => {
@@ -108,17 +115,79 @@ describe('DefinitionWalker', () => {
 
 		it('returns task step', () => {
 			const found = walker.findById(definition, taskFoo.id);
-			expect(found).toEqual(taskFoo);
+			expect(found).toBe(taskFoo);
 		});
 
 		it('returns container step', () => {
 			const found = walker.findById(definition, loop.id);
-			expect(found).toEqual(loop);
+			expect(found).toBe(loop);
 		});
 
 		it('returns switch step', () => {
 			const found = walker.findById(definition, ifBeta.id);
-			expect(found).toEqual(ifBeta);
+			expect(found).toBe(ifBeta);
+		});
+	});
+
+	describe('forEach', () => {
+		it('iterates over defition', () => {
+			let count = 0;
+
+			walker.forEach(definition, (step, index, parent) => {
+				switch (count) {
+					case 0:
+						expect(step).toBe(definition.sequence[0]);
+						expect(index).toBe(0);
+						expect(parent).toBe(definition.sequence);
+						break;
+					case 1:
+						expect(step).toBe((definition.sequence[0] as BranchedStep).branches['false'][0]);
+						break;
+					case 2:
+						expect(step).toBe(loop);
+						break;
+					case 3:
+						expect(step).toBe(ifBeta);
+						expect(index).toBe(0);
+						expect(parent).toBe(loop.sequence);
+						break;
+					case 4:
+						expect(step).toBe(ifAlfa);
+						break;
+					case 5:
+						expect(step).toBe(taskFoo);
+						break;
+				}
+				count++;
+			});
+
+			expect(count).toEqual(6);
+		});
+
+		it('iterates over sequence', () => {
+			const steps: Step[] = [];
+
+			walker.forEach(loop.sequence, step => {
+				steps.push(step);
+			});
+
+			expect(steps.length).toEqual(3);
+			expect(steps[0]).toBe(ifBeta);
+			expect(steps[1]).toBe(ifAlfa);
+			expect(steps[2]).toBe(taskFoo);
+		});
+
+		it('stops when callback returns false', () => {
+			let count = 0;
+
+			walker.forEach(definition, () => {
+				count++;
+				if (count === 2) {
+					return false;
+				}
+			});
+
+			expect(count).toEqual(2);
 		});
 	});
 });

src/definition-walker/definition-walker.ts

@@ -26,6 +26,8 @@ type StepWithParentSequenceOrName = StepWithParentSequence | string;
 
 export type StepChildrenResolver = (step: Step) => StepChildren | null;
 
+export type StepForEachCallback = (step: Step, index: number, parentSequence: Sequence) => void | boolean;
+
 export class DefinitionWalker {
 	private readonly resolvers: StepChildrenResolver[];
 
@@ -34,7 +36,8 @@ export class DefinitionWalker {
 	}
 
 	/**
-	 * Returns children of the step.
+	 * Returns children of the step. If the step doesn't have children, returns null.
+	 * @param step The step.
 	 */
 	public getChildren(step: Step): StepChildren | null {
 		const count = this.resolvers.length;
@@ -47,10 +50,24 @@ export class DefinitionWalker {
 		return null;
 	}
 
-	public getParents(definition: Definition, needle: Sequence | Step): StepOrName[] {
+	/**
+	 * Returns the parents of the step or the sequence.
+	 * @param definition The definition.
+	 * @param needle The step, stepId or sequence to find.
+	 * @returns The parents of the step or the sequence.
+	 */
+	public getParents(definition: Definition, needle: Sequence | Step | string): StepOrName[] {
 		const result: StepWithParentSequenceOrName[] = [];
-		const searchSequence = Array.isArray(needle) ? needle : null;
-		const searchStepId = !searchSequence ? (needle as Step).id : null;
+
+		let searchSequence: Sequence | null = null;
+		let searchStepId: string | null = null;
+		if (Array.isArray(needle)) {
+			searchSequence = needle;
+		} else if (typeof needle === 'string') {
+			searchStepId = needle;
+		} else {
+			searchStepId = needle.id;
+		}
 
 		if (this.find(definition.sequence, searchSequence, searchStepId, result)) {
 			result.reverse();
@@ -87,6 +104,11 @@ export class DefinitionWalker {
 		return this.getParentSequence(definition, stepId).step;
 	}
 
+	public forEach(sequenceOrDefinition: Sequence | Definition, callback: StepForEachCallback) {
+		const sequence = Array.isArray(sequenceOrDefinition) ? sequenceOrDefinition : sequenceOrDefinition.sequence;
+		this.iterate(sequence, callback);
+	}
+
 	private find(
 		sequence: Sequence,
 		needSequence: Sequence | null,
@@ -139,4 +161,45 @@ export class DefinitionWalker {
 		}
 		return false;
 	}
+
+	private iterate(sequence: Sequence, callback: StepForEachCallback): boolean {
+		const count = sequence.length;
+		for (let index = 0; index < count; index++) {
+			const step = sequence[index];
+			if (callback(step, index, sequence) === false) {
+				return false;
+			}
+
+			const children = this.getChildren(step);
+			if (children) {
+				switch (children.type) {
+					case StepChildrenType.sequence:
+						{
+							const childSequence = children.items as Sequence;
+							if (this.iterate(childSequence, callback) === false) {
+								return false;
+							}
+						}
+						break;
+
+					case StepChildrenType.branches:
+						{
+							const branches = children.items as Branches;
+							const branchNames = Object.keys(branches);
+							for (const branchName of branchNames) {
+								const parentSequence = branches[branchName];
+								if (this.iterate(parentSequence, callback) === false) {
+									return false;
+								}
+							}
+						}
+						break;
+
+					default:
+						throw new Error(`Step children type ${children.type} is not supported`);
+				}
+			}
+		}
+		return true;
+	}
 }

yarn.lock

@@ -637,10 +637,10 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
-"@types/jest@^29.5.1":
-  version "29.5.1"
-  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.1.tgz#83c818aa9a87da27d6da85d3378e5a34d2f31a47"
-  integrity sha512-tEuVcHrpaixS36w7hpsfLBLpjtMRJUE09/MHXn923LOVojDwyC14cWcfc0rDs0VEfUyYmt/+iX1kxxp+gZMcaQ==
+"@types/jest@^29.5.2":
+  version "29.5.2"
+  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.2.tgz#86b4afc86e3a8f3005b297ed8a72494f89e6395b"
+  integrity sha512-mSoZVJF5YzGVCk+FsDxzDuH7s+SCkzrgKZzf0Z0T2WudhBUPoF6ktoTPC4R0ZoCPCV5xUvuU6ias5NvxcBcMMg==
   dependencies:
     expect "^29.0.0"
     pretty-format "^29.0.0"
@@ -1734,10 +1734,10 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
-magic-string@^0.29.0:
-  version "0.29.0"
-  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.29.0.tgz#f034f79f8c43dba4ae1730ffb5e8c4e084b16cf3"
-  integrity sha512-WcfidHrDjMY+eLjlU+8OvwREqHwpgCeKVBUpQ3OhYYuvfaYCUgcbuBzappNzZvg/v8onU3oQj+BYpkOJe9Iw4Q==
+magic-string@^0.30.0:
+  version "0.30.0"
+  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.30.0.tgz#fd58a4748c5c4547338a424e90fa5dd17f4de529"
+  integrity sha512-LA+31JYDJLs82r2ScLrlz1GjSgu66ZV518eyWT+S8VhyQn/JL0u9MeBOvQMGYiPk1DBiSN9DDMOcXvigJZaViQ==
   dependencies:
     "@jridgewell/sourcemap-codec" "^1.4.13"
 
@@ -1972,30 +1972,30 @@ resolve@^1.20.0:
     path-parse "^1.0.7"
     supports-preserve-symlinks-flag "^1.0.0"
 
-rollup-plugin-dts@^5.2.0:
-  version "5.2.0"
-  resolved "https://registry.yarnpkg.com/rollup-plugin-dts/-/rollup-plugin-dts-5.2.0.tgz#1970edb69cfa3ead285ff4289d8fe273b87a5af3"
-  integrity sha512-B68T/haEu2MKcz4kNUhXB8/h5sq4gpplHAJIYNHbh8cp4ZkvzDvNca/11KQdFrB9ZeKucegQIotzo5T0JUtM8w==
+rollup-plugin-dts@^5.3.0:
+  version "5.3.0"
+  resolved "https://registry.yarnpkg.com/rollup-plugin-dts/-/rollup-plugin-dts-5.3.0.tgz#80a95988002f188e376f6db3b7e2f53679168957"
+  integrity sha512-8FXp0ZkyZj1iU5klkIJYLjIq/YZSwBoERu33QBDxm/1yw5UU4txrEtcmMkrq+ZiKu3Q4qvPCNqc3ovX6rjqzbQ==
   dependencies:
-    magic-string "^0.29.0"
+    magic-string "^0.30.0"
   optionalDependencies:
     "@babel/code-frame" "^7.18.6"
 
-rollup-plugin-typescript2@^0.34.1:
-  version "0.34.1"
-  resolved "https://registry.yarnpkg.com/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.34.1.tgz#c457f155a71d133c142689213fce78694e30d0be"
-  integrity sha512-P4cHLtGikESmqi1CA+tdMDUv8WbQV48mzPYt77TSTOPJpERyZ9TXdDgjSDix8Fkqce6soYz3+fa4lrC93IEkcw==
+rollup-plugin-typescript2@^0.35.0:
+  version "0.35.0"
+  resolved "https://registry.yarnpkg.com/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.35.0.tgz#a84fb4e802b919613f31552c69c3415101b547c1"
+  integrity sha512-szcIO9hPUx3PhQl91u4pfNAH2EKbtrXaES+m163xQVE5O1CC0ea6YZV/5woiDDW3CR9jF2CszPrKN+AFiND0bg==
   dependencies:
     "@rollup/pluginutils" "^4.1.2"
     find-cache-dir "^3.3.2"
     fs-extra "^10.0.0"
     semver "^7.3.7"
     tslib "^2.4.0"
 
-rollup@^3.18.0:
-  version "3.18.0"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-3.18.0.tgz#2354ba63ba66d6a09c652c3ea0dbcd9dad72bbde"
-  integrity sha512-J8C6VfEBjkvYPESMQYxKHxNOh4A5a3FlP+0BETGo34HEcE4eTlgCrO2+eWzlu2a/sHs2QUkZco+wscH7jhhgWg==
+rollup@^3.25.3:
+  version "3.25.3"
+  resolved "https://registry.yarnpkg.com/rollup/-/rollup-3.25.3.tgz#f9a8986f0f244bcfde2208da91ba46b8fd252551"
+  integrity sha512-ZT279hx8gszBj9uy5FfhoG4bZx8c+0A1sbqtr7Q3KNWIizpTdDEPZbV2xcbvHsnFp4MavCQYZyzApJ+virB8Yw==
   optionalDependencies:
     fsevents "~2.3.2"