@workplane/dbos 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Optional DBOS durability layer for the workplane server. Wraps store operations in durable DBOS workflows so the control plane survives process crashes and replays in-flight operations.
|
|
4
4
|
|
|
5
|
+
The core server does **not** import this package unless `WORKPLANE_USE_DBOS=true`. Without it, workflows run as plain async calls against Postgres (`VanillaWorkflows`).
|
|
6
|
+
|
|
5
7
|
## Install
|
|
6
8
|
|
|
7
9
|
```bash
|
|
@@ -13,7 +15,9 @@ npm install @workplane/dbos @workplane/types @dbos-inc/dbos-sdk
|
|
|
13
15
|
Enable by setting `WORKPLANE_USE_DBOS=true` before starting the workplane server — no code changes needed. The server dynamically imports this package and swaps `VanillaWorkflows` for `DbosWorkflows`.
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
|
-
|
|
18
|
+
export DATABASE_URL=postgres://... # required by the server either way
|
|
19
|
+
export WORKPLANE_USE_DBOS=true
|
|
20
|
+
workplane-server
|
|
17
21
|
```
|
|
18
22
|
|
|
19
23
|
## Programmatic use
|
|
@@ -31,5 +35,10 @@ await workflows.launch({
|
|
|
31
35
|
|
|
32
36
|
## Requirements
|
|
33
37
|
|
|
34
|
-
|
|
38
|
+
Only when DBOS is enabled:
|
|
39
|
+
|
|
40
|
+
- Postgres — DBOS system tables (same `DATABASE_URL` as the workplane app schema by default)
|
|
35
41
|
- `DBOS_APPLICATION_NAME` env var (optional, defaults to `workplane-server`)
|
|
42
|
+
- `DBOS_CONDUCTOR_KEY` — optional; for DBOS Cloud observability
|
|
43
|
+
|
|
44
|
+
When DBOS is disabled, none of the above apply beyond the server's normal Postgres requirement for task/run state.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workplane/dbos",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
29
|
"@dbos-inc/dbos-sdk": "^4.18.10",
|
|
30
|
-
"@workplane/types": "0.
|
|
30
|
+
"@workplane/types": "0.4.0"
|
|
31
31
|
},
|
|
32
32
|
"scripts": {
|
|
33
33
|
"build": "tsup"
|