nestrs-workflows 1.7.1

Durable workflows for nestrs — NestJS @nestjs/workflows parity.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# nestrs-workflows

Durable multi-step workflows for [nestrs](https://crates.io/crates/nestrs) — NestJS `@nestjs/workflows` analogue.

Persist step results, resume after process restart, and park for **human approval**. Combine with [`nestrs-locks`](https://crates.io/crates/nestrs-locks) for single-runner steppers and [`nestrs-outbox`](https://crates.io/crates/nestrs-outbox) for side effects.

## Install

```toml
[dependencies]
nestrs-workflows = "1.7.1"
```

Or via the umbrella (also enables `outbox` + `locks`):

```toml
nestrs = { version = "1.7.1", features = ["workflows"] }
```

## Register

```rust
use nestrs_workflows::{WorkflowsModule, WorkflowsOptions};

#[module(imports = [WorkflowsModule::register(WorkflowsOptions::default())])]
struct AppModule;
```

## Lifecycle

```text
start → complete_step → … → wait_for_approval → approve → complete_step → …
```

```rust
use nestrs_workflows::WorkflowsService;
use serde_json::json;
use std::sync::Arc;

async fn order_flow(svc: Arc<WorkflowsService>) {
    let inst = svc.start("order.fulfill", json!({ "id": 1 })).await;
    svc.complete_step(&inst.id, "charge", json!({ "ok": true }))
        .await
        .unwrap();

    svc.wait_for_approval(&inst.id).await.unwrap();
    // later, from an admin handler:
    svc.approve(&inst.id).await.unwrap();

    svc.complete_step(&inst.id, "ship", json!({ "carrier": "DHL" }))
        .await
        .unwrap();
}
```

A new `WorkflowsService` sharing the same `WorkflowStore` resumes from persisted state after a logical restart.

### Status

| `WorkflowStatus` | Meaning |
|------------------|---------|
| `Running` | Active steps |
| `WaitingApproval` | Parked until `approve` |
| `Completed` | Finished |
| `Failed` | Terminal failure |

## Surface

- `WorkflowsModule` / `WorkflowsOptions` / `WorkflowsService`
- `WorkflowInstance`, `WorkflowStatus`
- `InMemoryWorkflowStore` / `WorkflowStore` trait

## Docs

- Guide: [Workflows](https://github.com/Joshyahweh/nestrs/blob/main/mintlify-docs/ecosystem/workflows.mdx)
- Hub: [Reliability](https://github.com/Joshyahweh/nestrs/blob/main/mintlify-docs/guides/reliability.mdx)
- rustdoc: <https://docs.rs/nestrs-workflows/1.7.1>
- Lab: `cargo run -p lab --bin lab9_nestjs12`

## License

MIT OR Apache-2.0.