@orkestrel/workflow 0.0.1 → 0.0.2
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 +16 -5
- package/dist/src/core/index.cjs +1203 -418
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +1461 -420
- package/dist/src/core/index.d.ts +1461 -420
- package/dist/src/core/index.js +1194 -414
- package/dist/src/core/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,10 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
A typed workflow engine for the `@orkestrel` line — a serializable
|
|
4
4
|
`Workflow → Phase → Task` tree that a UI or an LLM authors as pure JSON, and
|
|
5
|
-
a
|
|
5
|
+
a PURE `WorkflowRunner` engine executes by COMPOSING the shipped substrate (a
|
|
6
6
|
per-phase `Runner`, `Abort`, `Timeout`, `Budget`, and a cooperative
|
|
7
7
|
cross-environment `Scheduler`) rather than re-implementing its own
|
|
8
|
-
concurrency / retry / abort machinery.
|
|
8
|
+
concurrency / retry / abort machinery. Each task's `run` is a plain
|
|
9
|
+
behavior-name string resolved once into a `handler`; wiring a task to a tool
|
|
10
|
+
or an agent is an opt-in `createToolFunction` / `createAgentFunction`
|
|
11
|
+
adapter composed into the caller's own `functions` registry.
|
|
9
12
|
|
|
10
13
|
## Install
|
|
11
14
|
|
|
@@ -23,13 +26,21 @@ npm install @orkestrel/workflow
|
|
|
23
26
|
## Status
|
|
24
27
|
|
|
25
28
|
Pre-release (`0.0.1`): the definition contract, the live entity tree, the
|
|
26
|
-
|
|
29
|
+
pure-engine runner (with a `run`-string / `handler` model, the opt-in
|
|
30
|
+
`createToolFunction` / `createAgentFunction` adapters, and the
|
|
27
31
|
depth/cycle-bounded agent-native recursion), the durable `WorkflowStore`
|
|
28
32
|
(in-memory + driver-pluggable), and the cooperative `Scheduler` (the
|
|
29
33
|
cross-environment default plus the browser and Node environment backends)
|
|
30
34
|
are all implemented and tested, but the public API is still unstable and
|
|
31
|
-
may change without notice.
|
|
32
|
-
|
|
35
|
+
may change without notice. The live tree also supports runtime-only
|
|
36
|
+
`pause` / `resume` / `wait` (at both the workflow and phase tiers) plus a
|
|
37
|
+
gated `add` / `remove` / `move` / `update` structural-mutation API
|
|
38
|
+
(pending-suffix positions, append-only on a running phase), a hard
|
|
39
|
+
`destroy` teardown alongside the runner's existing graceful `stop`, and a
|
|
40
|
+
`WorkflowRunnerInterface.execute` overload that drives an already-built,
|
|
41
|
+
caller-owned live tree instead of only building one from a definition. See
|
|
42
|
+
[guides/src/workflow.md](./guides/src/workflow.md) for the full documented
|
|
43
|
+
surface.
|
|
33
44
|
|
|
34
45
|
## Package
|
|
35
46
|
|