feat: Version 2 (#13)

BREAKING CHANGE: The library has been significantly expanded and now implements full functionality needed to implement and run workflows:

- Support for work items and nested workflows
- Ability to listen to changes to the state (which allows implementation of persisted state)

Most of the previous features are available, some names might be changed.

.cspell.json

@@ -9,25 +9,33 @@
     "Coverable",
     "degit",
     "esbuild",
+    "ESWI",
     "fixedsize",
     "Gilleland",
     "gjuchault",
     "graphviz",
     "millis",
     "nminusr",
+    "OCAI",
+    "OCOI",
     "octocat",
     "omarking",
+    "Persistable",
     "Postset",
     "premarked",
     "qname",
     "rankdir",
     "remeda",
+    "rimbu",
     "rmrf",
     "socio",
     "tasquencer",
+    "Unfinalized",
+    "WAWIT",
     "WFOJ",
     "wfojnet",
-    "wsts"
+    "wsts",
+    "WWAIT"
   ],
   "flagWords": [],
   "ignorePaths": [

.eslintrc.json

@@ -35,6 +35,7 @@
     "@typescript-eslint/no-this-alias": "off",
     "@typescript-eslint/prefer-return-this-type": "off",
     "@typescript-eslint/no-unnecessary-condition": "off",
+    "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-unused-vars": [
       "error", // or "error"
       {

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,28 +4,29 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. 
-2. 
-3. 
+
+1.
+2.
+3.
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. Ubuntu 22.04, macOS 11.4]
- - Node version [e.g 16.4.2]
- - Code Version [e.g. 1.1.0]
+**Desktop (please exit the following information):**
+
+- OS: [e.g. Ubuntu 22.04, macOS 11.4]
+- Node version [e.g 16.4.2]
+- Code Version [e.g. 1.1.0]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/checks.yml

@@ -14,8 +14,8 @@ jobs:
       cancel-in-progress: true
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: volta-cli/action@v1
+      - uses: actions/checkout@v4
+      - uses: volta-cli/action@v4
       - run: npm ci
 
       - name: Dependencies audit
@@ -34,4 +34,4 @@ jobs:
         run: npm run spell:check
 
       - name: Test
-        run: npm run test
+        run: npm run test

README.md

@@ -8,16 +8,17 @@ A BPM library for Node based on the concepts from https://yawlfoundation.github.
 Example:
 
 ```typescript
-Builder.workflow<{
+const workflowDefinition = Builder.workflow<{
   shouldBookFlight: boolean;
   shouldBookCar: boolean;
-}>('or-split-and-or-join')
+}>()
+  .withName('or-split-join')
   .startCondition('start')
-  .task('register', (t) => t.withSplitType('or'))
-  .task('book_flight')
-  .task('book_hotel')
-  .task('book_car')
-  .task('pay', (t) => t.withJoinType('or'))
+  .task('register', Builder.emptyTask().withSplitType('or'))
+  .task('book_flight', Builder.emptyTask())
+  .task('book_hotel', Builder.emptyTask())
+  .task('book_car', Builder.emptyTask())
+  .task('pay', Builder.emptyTask().withJoinType('or'))
   .endCondition('end')
   .connectCondition('start', (to) => to.task('register'))
   .connectTask('register', (to) =>

package.json

@@ -12,12 +12,12 @@
   "types": "./build/src/index.d.ts",
   "license": "MIT",
   "engines": {
-    "node": "^18.16.0",
-    "npm": "^9.5.1"
+    "node": "^18.17.1",
+    "npm": "^9.6.7"
   },
   "volta": {
-    "node": "18.16.1",
-    "npm": "9.5.1"
+    "node": "18.17.1",
+    "npm": "9.6.7"
   },
   "publishConfig": {
     "access": "public"
@@ -73,9 +73,9 @@
     "vitest": "^0.32.4"
   },
   "dependencies": {
-    "@effect/match": "^0.38.0",
-    "big-integer": "^1.6.51",
-    "effect": "^2.0.0-next.45",
-    "mutative": "^0.5.0"
+    "effect": "^2.0.0-next.54",
+    "mutative": "^0.7.1",
+    "nanoid": "^5.0.3",
+    "type-fest": "^4.8.2"
   }
 }