@orkestrel/scaffold 0.0.120 → 0.0.121
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/dist/bin/main.js +5 -5
- package/dist/bin/main.js.map +1 -1
- package/dist/host/claude/agents/orkestrel.md +26 -26
- package/dist/host/guides/agent.md +5 -5
- package/dist/host/guides/brief.md +7 -15
- package/dist/host/guides/browser.md +1 -1
- package/dist/host/guides/capture.md +2 -2
- package/dist/host/guides/console.md +4 -30
- package/dist/host/guides/guide.md +0 -1
- package/dist/host/guides/interpret.md +165 -182
- package/dist/host/guides/lsp.md +26 -51
- package/dist/host/guides/mcp.md +220 -276
- package/dist/host/guides/middleware.md +14 -22
- package/dist/host/guides/ollama.md +1 -3
- package/dist/host/guides/probe.md +71 -80
- package/dist/host/guides/program.md +26 -35
- package/dist/host/guides/qualifier.md +0 -6
- package/dist/host/guides/queue.md +0 -4
- package/dist/host/guides/rater.md +6 -12
- package/dist/host/guides/relation.md +0 -2
- package/dist/host/guides/scaffold.md +12 -8
- package/dist/host/guides/sea.md +47 -51
- package/dist/host/guides/server.md +15 -19
- package/dist/host/guides/terminal.md +0 -26
- package/dist/host/guides/toolbox.md +0 -10
- package/dist/host/guides/worker.md +57 -57
- package/dist/host/guides/workflow.md +13 -26
- package/dist/host/guides/workspace.md +15 -21
- package/dist/host/manifest.json +28 -448
- package/dist/src/core/index.cjs +7 -45
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.js +7 -45
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +10 -9
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +12 -8
- package/dist/src/server/index.d.ts +12 -8
- package/dist/src/server/index.js +10 -9
- package/dist/src/server/index.js.map +1 -1
- package/package.json +5 -5
|
@@ -44,57 +44,57 @@ Treat generated package identifiers, versions, layers, and dependency ranges as
|
|
|
44
44
|
| Package | Version | Layer | Runtime dependencies | Peer dependencies |
|
|
45
45
|
| ----------------------- | --------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
46
46
|
| `@orkestrel/abort` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
47
|
-
| `@orkestrel/agent` | `0.0.
|
|
48
|
-
| `@orkestrel/brief` | `0.0.
|
|
49
|
-
| `@orkestrel/browser` | `0.0.
|
|
47
|
+
| `@orkestrel/agent` | `0.0.34` | L5 | `@orkestrel/tool` `^0.0.21`, `@orkestrel/abort` `^0.0.15`, `@orkestrel/queue` `^0.0.19`, `@orkestrel/budget` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20`, `@orkestrel/workflow` `^0.0.25`, `@orkestrel/workspace` `^0.0.14` | |
|
|
48
|
+
| `@orkestrel/brief` | `0.0.14` | L4 | `@orkestrel/reason` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/interpret` `^0.0.19` | |
|
|
49
|
+
| `@orkestrel/browser` | `0.0.31` | L5 | `@orkestrel/mcp` `^0.0.41`, `@orkestrel/html` `^0.0.14`, `@orkestrel/pool` `^0.0.19`, `@orkestrel/tool` `^0.0.21`, `@orkestrel/codec` `^0.0.8`, `@orkestrel/router` `^0.0.19`, `@orkestrel/server` `^0.0.25`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/markdown` `^0.0.19`, `@orkestrel/websocket` `^0.0.17` | |
|
|
50
50
|
| `@orkestrel/budget` | `0.0.16` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
51
|
-
| `@orkestrel/capture` | `0.0.
|
|
51
|
+
| `@orkestrel/capture` | `0.0.3` | L3 | `@orkestrel/process` `^0.0.17`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21` | `vite` `^8.3.5`, `vitest` `^4.1.12 \|\| ^5.0.5`, `playwright` `^1.61.0`, `@vitest/browser-playwright` `^4.1.12 \|\| ^5.0.5` |
|
|
52
52
|
| `@orkestrel/codec` | `0.0.8` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
53
|
-
| `@orkestrel/console` | `0.0.
|
|
53
|
+
| `@orkestrel/console` | `0.0.18` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
54
54
|
| `@orkestrel/contract` | `0.0.21` | L0 | | |
|
|
55
55
|
| `@orkestrel/csv` | `0.0.12` | L2 | `@orkestrel/codec` `^0.0.8`, `@orkestrel/contract` `^0.0.21` | |
|
|
56
56
|
| `@orkestrel/database` | `0.0.20` | L2 | `@orkestrel/sqlite` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/indexeddb` `^0.0.16` | |
|
|
57
57
|
| `@orkestrel/emitter` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
58
58
|
| `@orkestrel/form` | `0.0.15` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
59
|
-
| `@orkestrel/guide` | `0.0.
|
|
59
|
+
| `@orkestrel/guide` | `0.0.29` | L3 | `@orkestrel/contract` `^0.0.21`, `@orkestrel/markdown` `^0.0.19` | |
|
|
60
60
|
| `@orkestrel/html` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
61
61
|
| `@orkestrel/indexeddb` | `0.0.16` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
62
|
-
| `@orkestrel/interpret` | `0.0.
|
|
62
|
+
| `@orkestrel/interpret` | `0.0.19` | L3 | `@orkestrel/reason` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/template` `^0.0.12` | |
|
|
63
63
|
| `@orkestrel/jsonrpc` | `0.0.1` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
64
|
-
| `@orkestrel/lsp` | `0.0.
|
|
64
|
+
| `@orkestrel/lsp` | `0.0.13` | L3 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/jsonrpc` `^0.0.1`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21` | |
|
|
65
65
|
| `@orkestrel/markdown` | `0.0.19` | L2 | `@orkestrel/html` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
66
|
-
| `@orkestrel/mcp` | `0.0.
|
|
67
|
-
| `@orkestrel/middleware` | `0.0.
|
|
66
|
+
| `@orkestrel/mcp` | `0.0.41` | L4 | `@orkestrel/sse` `^0.0.12`, `@orkestrel/tool` `^0.0.21`, `@orkestrel/codec` `^0.0.8`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/jsonrpc` `^0.0.1`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/websocket` `^0.0.17` | `@orkestrel/router` `^0.0.19`, `@orkestrel/server` `^0.0.25` |
|
|
67
|
+
| `@orkestrel/middleware` | `0.0.27` | L4 | `@orkestrel/abort` `^0.0.15`, `@orkestrel/budget` `^0.0.16`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21` | `@orkestrel/server` `^0.0.25`, `@orkestrel/database` `^0.0.20` |
|
|
68
68
|
| `@orkestrel/msg` | `0.0.15` | L2 | `@orkestrel/codec` `^0.0.8`, `@orkestrel/contract` `^0.0.21` | |
|
|
69
69
|
| `@orkestrel/ndjson` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
70
|
-
| `@orkestrel/ollama` | `0.0.
|
|
70
|
+
| `@orkestrel/ollama` | `0.0.28` | L6 | `@orkestrel/tool` `^0.0.21`, `@orkestrel/agent` `^0.0.34`, `@orkestrel/budget` `^0.0.16`, `@orkestrel/ndjson` `^0.0.14`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21` | |
|
|
71
71
|
| `@orkestrel/pool` | `0.0.19` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
72
|
-
| `@orkestrel/probe` | `0.0.
|
|
72
|
+
| `@orkestrel/probe` | `0.0.27` | L5 | `@orkestrel/lsp` `^0.0.13`, `@orkestrel/mcp` `^0.0.41`, `@orkestrel/pool` `^0.0.19`, `@orkestrel/tool` `^0.0.21`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/process` `^0.0.17`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21` | `vitest` `^4.1.12 \|\| ^5.0.5`, `typescript` `^6.0.3 \|\| ^7.0.2` |
|
|
73
73
|
| `@orkestrel/process` | `0.0.17` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
74
|
-
| `@orkestrel/program` | `0.0.
|
|
75
|
-
| `@orkestrel/qualifier` | `0.0.
|
|
76
|
-
| `@orkestrel/queue` | `0.0.
|
|
77
|
-
| `@orkestrel/rater` | `0.0.
|
|
74
|
+
| `@orkestrel/program` | `0.0.19` | L4 | `@orkestrel/rater` `^0.0.20`, `@orkestrel/reason` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/qualifier` `^0.0.20` | |
|
|
75
|
+
| `@orkestrel/qualifier` | `0.0.20` | L3 | `@orkestrel/reason` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
76
|
+
| `@orkestrel/queue` | `0.0.19` | L3 | `@orkestrel/abort` `^0.0.15`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
77
|
+
| `@orkestrel/rater` | `0.0.20` | L3 | `@orkestrel/reason` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
78
78
|
| `@orkestrel/reason` | `0.0.16` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
79
|
-
| `@orkestrel/relation` | `0.0.
|
|
79
|
+
| `@orkestrel/relation` | `0.0.18` | L3 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
80
80
|
| `@orkestrel/router` | `0.0.19` | L2 | `@orkestrel/abort` `^0.0.15`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
81
|
-
| `@orkestrel/scaffold` | `0.0.
|
|
82
|
-
| `@orkestrel/sea` | `0.0.
|
|
83
|
-
| `@orkestrel/server` | `0.0.
|
|
81
|
+
| `@orkestrel/scaffold` | `0.0.120` | L3 | `@orkestrel/console` `^0.0.17`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/markdown` `^0.0.19`, `@orkestrel/template` `^0.0.12` | |
|
|
82
|
+
| `@orkestrel/sea` | `0.0.21` | L3 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/process` `^0.0.17`, `@orkestrel/contract` `^0.0.21` | |
|
|
83
|
+
| `@orkestrel/server` | `0.0.25` | L3 | `@orkestrel/abort` `^0.0.15`, `@orkestrel/codec` `^0.0.8`, `@orkestrel/router` `^0.0.19`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21` | |
|
|
84
84
|
| `@orkestrel/sqlite` | `0.0.16` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
85
85
|
| `@orkestrel/sse` | `0.0.12` | L2 | `@orkestrel/codec` `^0.0.8`, `@orkestrel/contract` `^0.0.21` | |
|
|
86
|
-
| `@orkestrel/study` | `0.0.
|
|
86
|
+
| `@orkestrel/study` | `0.0.8` | L7 | `@orkestrel/tool` `^0.0.21`, `@orkestrel/abort` `^0.0.15`, `@orkestrel/agent` `^0.0.34`, `@orkestrel/budget` `^0.0.16`, `@orkestrel/ollama` `^0.0.28`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21` | |
|
|
87
87
|
| `@orkestrel/table` | `0.0.14` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
88
88
|
| `@orkestrel/template` | `0.0.12` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
89
|
-
| `@orkestrel/terminal` | `0.0.
|
|
89
|
+
| `@orkestrel/terminal` | `0.0.22` | L3 | `@orkestrel/sse` `^0.0.12`, `@orkestrel/form` `^0.0.15`, `@orkestrel/console` `^0.0.17`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
90
90
|
| `@orkestrel/test` | `0.0.32` | L1 | `@orkestrel/contract` `^0.0.21` | `vitest` `^4.1.12 \|\| ^5.0.5`, `playwright` `^1.64.1` |
|
|
91
91
|
| `@orkestrel/timeout` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.21` | |
|
|
92
92
|
| `@orkestrel/tool` | `0.0.21` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
93
|
-
| `@orkestrel/toolbox` | `0.0.
|
|
93
|
+
| `@orkestrel/toolbox` | `0.0.23` | L6 | `@orkestrel/form` `^0.0.15`, `@orkestrel/tool` `^0.0.21`, `@orkestrel/agent` `^0.0.34`, `@orkestrel/server` `^0.0.25`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20`, `@orkestrel/relation` `^0.0.18`, `@orkestrel/terminal` `^0.0.22`, `@orkestrel/workflow` `^0.0.25`, `@orkestrel/workspace` `^0.0.14` | |
|
|
94
94
|
| `@orkestrel/websocket` | `0.0.17` | L2 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21` | |
|
|
95
|
-
| `@orkestrel/worker` | `0.0.
|
|
96
|
-
| `@orkestrel/workflow` | `0.0.
|
|
97
|
-
| `@orkestrel/workspace` | `0.0.
|
|
95
|
+
| `@orkestrel/worker` | `0.0.19` | L4 | `@orkestrel/pool` `^0.0.19`, `@orkestrel/queue` `^0.0.19`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
96
|
+
| `@orkestrel/workflow` | `0.0.25` | L4 | `@orkestrel/abort` `^0.0.15`, `@orkestrel/queue` `^0.0.19`, `@orkestrel/budget` `^0.0.16`, `@orkestrel/emitter` `^0.0.14`, `@orkestrel/timeout` `^0.0.15`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
97
|
+
| `@orkestrel/workspace` | `0.0.14` | L3 | `@orkestrel/emitter` `^0.0.14`, `@orkestrel/contract` `^0.0.21`, `@orkestrel/database` `^0.0.20` | |
|
|
98
98
|
|
|
99
99
|
<!-- /orkestrel:catalog -->
|
|
100
100
|
|
|
@@ -695,7 +695,7 @@ The wire is strictly narrower than the domain on purpose. `providerRequestContra
|
|
|
695
695
|
|
|
696
696
|
The root holds the package's shared vocabulary: the message and judge value types, the role list, the judge abort error, the message and tool-call wire shapes with the message contract, and the cloner, helpers, and guards that more than one module reads.
|
|
697
697
|
|
|
698
|
-
Each module section lists its exports by kind file
|
|
698
|
+
Each module section lists its exports by kind file. Each guard reads an `unknown`, returns `false` off-shape, and never throws, and an error guard stays in its module's Errors table beside the error it narrows.
|
|
699
699
|
|
|
700
700
|
#### Types
|
|
701
701
|
|
|
@@ -935,7 +935,7 @@ The following table lists the helpers the providers module declares:
|
|
|
935
935
|
| `buildProviderResult` | function | `(content: string, thinking: string, tools: readonly ToolCall[], usage: TokenUsage \| undefined, truncated: boolean \| undefined) => ProviderResult` | Assembles a provider result with only populated optional fields. |
|
|
936
936
|
| `armReaderAbort` | function | `(reader: ReadableStreamDefaultReader<Uint8Array>, signal: AbortSignal \| undefined) => Promise<AbortController>` | Arms signal propagation to a byte reader and returns the controller that removes the listener. |
|
|
937
937
|
| `readFailure` | function | `(response: Response, prefix: string, signal: AbortSignal) => Promise<FailureRead>` | Reads a bounded HTTP failure excerpt and preserves an unreadable body's cause. |
|
|
938
|
-
| `
|
|
938
|
+
| `readBodyText` | function | `(body: ReadableStream<Uint8Array>, limit?: number, signal?: AbortSignal) => Promise<TextRead>` | Reads a UTF-8 prefix of a byte stream and cancels its remainder. |
|
|
939
939
|
| `readChunks` | function | `(body: ReadableStream<Uint8Array>, signal?: AbortSignal) => AsyncGenerator<string>` | Decodes UTF-8 chunks with a final flush and releases the stream on every exit. |
|
|
940
940
|
| `releaseReader` | function | `(reader: ReadableStreamDefaultReader<Uint8Array>) => Promise<void>` | Cancels a stream reader and releases its lock, swallowing a cancellation failure so the caller's own outcome stands. |
|
|
941
941
|
| `computeReading` | function | `(answer: JudgeAnswer) => Reading` | Derives the winner, its probability, the published confidence, and a score answer's expected level from a judge answer's distribution. |
|
|
@@ -1907,7 +1907,7 @@ These invariants hold across `src/core` ↔ `agent.md`:
|
|
|
1907
1907
|
- **`sanitizeUsage`.** `sanitizeToken` turns a non-finite or non-positive count into `0` and floors a positive fraction, and `sanitizeUsage` applies it to each field. The loop sanitizes a provider's usage and an abort partial's usage before charging or folding it.
|
|
1908
1908
|
- **`AgentError` — the concurrency guard.** `stream()` throws `AgentError` with code `CONCURRENCY` and `context: { agent }` synchronously when a run is in flight and the agent carries a `window`, or when the run's effective `budget` or `allowance` is an instance a live run holds; runs holding distinct instances with no `window` overlap. The refused run never starts either bound, so the live run stays bound to it. A `budget` or `allowance` that does not implement `BudgetInterface` throws `ContractError` with code `placement` before either bound starts. `isAgentError` narrows a caught value, and a `REGISTRY` error's `context` names the `category` and `name`.
|
|
1909
1909
|
- **`agentResultToJSON` — the portable `AgentResult` projection.** The helper accepts `unknown`, never throws, reads each structural field once, and returns a fresh exact `{ content, thinking?, usage?, partial, stop? }` `JSONValue`, or `undefined` for invalid input; a malformed `stop` refuses the whole value. Finite negative and fractional usage counts are preserved, and extra fields are dropped.
|
|
1910
|
-
- **The provider engine's request and stream.** The engine posts `JSON.stringify(encode(request))` to `url + (path ?? '')` with a JSON content type the `headers` hook can extend, decodes the body through `readChunks`, and feeds every framed record and the `finish` tail through `read`. A record whose `read` returns a `result` ends the call with that result, and with `strict: true` a stream that ends with no settled result throws `ProviderError` with code `PROTOCOL`. A non-OK body is read through `
|
|
1910
|
+
- **The provider engine's request and stream.** The engine posts `JSON.stringify(encode(request))` to `url + (path ?? '')` with a JSON content type the `headers` hook can extend, decodes the body through `readChunks`, and feeds every framed record and the `finish` tail through `read`. A record whose `read` returns a `result` ends the call with that result, and with `strict: true` a stream that ends with no settled result throws `ProviderError` with code `PROTOCOL`. A non-OK body is read through `readBodyText` to at most `MAX_ERROR_BODY_LENGTH` bytes and its remainder cancelled, and each reader releases its lock on every exit.
|
|
1911
1911
|
- **The wire shapes and the compiled contracts.** The shapes declare each JSON projection and the contracts compile them, each strictly narrower than its domain type, so a value JSON can't carry is refused rather than dropped and a `ToolContext` appears in no wire shape. `RelayProvider.encode` projects the request through `requestToRelay`, which reads each declared member as the request presents it: a getter runs, and an inherited declared member crosses. The clone of that projection uses property descriptors and consults no getter, prototype, or `toJSON` serializer; a non-JSON value is refused before fetching.
|
|
1912
1912
|
- **The relay protocol (`createRelay` / `RelayStream` / `RelayProvider`).** The request is a `POST` of one `providerRequestContract` document, and the response is newline-delimited `RelayFrame` records under `RELAY_CONTENT_TYPE`, written under backpressure, with every upstream failure reduced to `RELAY_PROVIDER_MESSAGE`. `authorize` is mandatory and runs before the body is read; the handler answers `401`, `413` at the byte `limit`, `400`, or `502` with no body, and the browser receives each as a `ProviderError` with code `HTTP`. An inbound abort, a client disconnecting included, cancels the upstream turn.
|
|
1913
1913
|
- **`ProviderError` and its codes.** `ProviderError` carries a `code` and, for `HTTP` alone, a `status`: `HTTP` reports a non-OK response as `provider error: <status>` with ` - <excerpt>` only when the error body had text, `PROTOCOL` a missing body, a refused record, or a `strict` stream with no settled result, and `PROVIDER` a relay `error` frame. A cancel throws `ProviderAbortError`, never `ProviderError`.
|
|
@@ -2753,7 +2753,7 @@ The following practices apply when you build on this package:
|
|
|
2753
2753
|
- **Run many durable agents with `createAgentQueue`** — describe each agent as a serializable `AgentJobInput` (names for the provider / tools / authority / scheduler, data for the rest), register the live pieces once in a `createAgentRegistry`, and enqueue the jobs. Persist them with a `store` so `restore()` re-runs outstanding work after a crash. Decide the partial policy up front — `partial: false` (default) retries a cancelled job, `true` accepts the partial.
|
|
2754
2754
|
- **Fan out sub-agents with `createAgentRunner`** — declare a parent job's sub-agents in its `children`; the runner spawns each through `controller.spawn` on the same bounded queue. Don't reach for the controller yourself — express fan-out as data on the job (it stays serializable) and let the runner spawn it.
|
|
2755
2755
|
- **Pull and push surfaces on the `Agent`, none elsewhere** — observe the `Agent` each way: pull the `AgentChunk` stream for per-token / per-thinking deltas + usage/tool chunks, or push `agent.emitter.on(...)` (`AgentEventMap`) for lifecycle + usage/tool/deny moments a fire-and-forget observer wants. A listener throw can never corrupt the loop (the emitter isolates it, routing it to the `error` option). Don't reach for an Emitter on the provider contract, the tool registry, the conversation store, the context, or the job layer — those stay event-free; and don't expect per-token `token` or `think` events (those stay the stream's job).
|
|
2756
|
-
- **Create and edit files through `@orkestrel/workspace`** — the file domain is that package's, and `AgentContext` borrows only its `
|
|
2756
|
+
- **Create and edit files through `@orkestrel/workspace`** — the file domain is that package's, and `AgentContext` borrows only its `isTextContent` / `isBinary` guards to decide a file's carrier. The rendering belongs to this package: the `## Workspace` fencing and the binary-plus-`image/` attachment are prompt policy that belongs here, not workspace helpers that belong there.
|
|
2757
2757
|
- **Judge the argument the model passed** — a tool handler that asks a judge about a model's tool call judges the argument that call carried, or its tool description says it judges a fixed input.
|
|
2758
2758
|
- **Write a refusal as the next step** — a refusal text a tool returns names the one next call and says nothing about who asked, because a reasoning model mid-task reads a refusal that addresses the user as a user turn.
|
|
2759
2759
|
- **Give the model both halves of a workspace** — `context.workspaces` is what it reads, rendered by carrier every turn, active-only and filtered by `scope.files`; the `createWorkspaceTool` published by `@orkestrel/toolbox` over that same registry is what it writes. For workspace editing, errors, and persistence, see [Workspace](workspace.md); for tool dispatch semantics, see [Tool](tool.md).
|
|
@@ -2776,7 +2776,7 @@ The following test files back this guide:
|
|
|
2776
2776
|
- [`tests/src/core/providers/AgentJudge.test.ts`](../tests/src/core/providers/AgentJudge.test.ts) — the judge engine's identity and request composition, refusals before inference, HTTP and protocol failures, header hook, and cancellation partials.
|
|
2777
2777
|
- [`tests/src/core/providers/SystemOneJudge.test.ts`](../tests/src/core/providers/SystemOneJudge.test.ts) — the System One wire against the bodies recorded on 2026-10-07.
|
|
2778
2778
|
- [`tests/src/core/providers/factories.test.ts`](../tests/src/core/providers/factories.test.ts) — the `createThinkSplitter` factory and the authorization, body-limit, malformed-body, and upstream-construction refusals of `createRelay`.
|
|
2779
|
-
- [`tests/src/core/providers/helpers.test.ts`](../tests/src/core/providers/helpers.test.ts) — `buildProviderResult`, `armReaderAbort`, `readFailure`, `
|
|
2779
|
+
- [`tests/src/core/providers/helpers.test.ts`](../tests/src/core/providers/helpers.test.ts) — `buildProviderResult`, `armReaderAbort`, `readFailure`, `readBodyText`, `readChunks`, `computeReading`, `buildJudgeResult`, `buildProviderHeaders`, `requestToRelay`, the System One helpers, and `releaseReader`.
|
|
2780
2780
|
- [`tests/src/core/providers/contracts.test.ts`](../tests/src/core/providers/contracts.test.ts) — the request, result, and relay-frame contracts' round trips, malformed paths, and non-JSON refusals.
|
|
2781
2781
|
- [`tests/src/core/providers/shapers.test.ts`](../tests/src/core/providers/shapers.test.ts) — the request, result, and relay wire shapes assignable to their domain types.
|
|
2782
2782
|
- [`tests/src/core/providers/validators.test.ts`](../tests/src/core/providers/validators.test.ts) — the System One guards `isSystemOneResponse` and `isSystemOneAnswer` over recorded, transliterated, and hostile envelopes.
|
|
@@ -91,8 +91,6 @@ pipeline at all.
|
|
|
91
91
|
|
|
92
92
|
### Types
|
|
93
93
|
|
|
94
|
-
A `Shape` cell holds an interface's data members as bare names in braces, `?` marking an optional member and `plus` introducing its call-signature members, and a type alias's own type literal with a union's arms escaped as `\|`.
|
|
95
|
-
|
|
96
94
|
| Name | Kind | Signature | Summary |
|
|
97
95
|
| ------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
98
96
|
| `TaskOperation` | type | `'create' \| 'refactor' \| 'debug' \| 'extract' \| 'migrate' \| 'explain' \| 'review' \| 'optimize' \| 'audit' \| 'test' \| 'document' \| 'plan'` | Names the closed vocabulary of what a brief asks for. |
|
|
@@ -139,8 +137,6 @@ check, met or missed, narrated by the reasoner.
|
|
|
139
137
|
|
|
140
138
|
### Constants
|
|
141
139
|
|
|
142
|
-
A `Shape` cell holds the constant's declared type.
|
|
143
|
-
|
|
144
140
|
| Name | Kind | Signature | Summary |
|
|
145
141
|
| ------------------------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
146
142
|
| `TASK_OPERATIONS` | const | `readonly TaskOperation[]` | Lists the `TaskOperation` values, frozen. |
|
|
@@ -212,13 +208,17 @@ try {
|
|
|
212
208
|
Throws are reserved for caller misuse: `assertBrief` and `snapshotBrief` throw `INVALID` on
|
|
213
209
|
data the contract refuses, and any method after `destroy()` throws `DESTROYED`. Blocking gaps
|
|
214
210
|
are not an error — the gate fails closed into an incomplete `Briefing` whose `failures` carry
|
|
215
|
-
a `BLOCKED` marker, mirroring interprets `
|
|
211
|
+
a `BLOCKED` marker, mirroring interprets `NO_RECIPE` visible-incomplete outcome.
|
|
216
212
|
|
|
217
213
|
Each code carries the `context` it can actually supply, and they are not uniform: `DRAFT_FAILED`
|
|
218
214
|
carries `{ stage, field }`, `GATE_FAILED` carries `{ stage, field, reasoning }`, `INVALID`
|
|
219
215
|
carries `{ field }` plus the offending value where the code has one — the hash on a
|
|
220
216
|
content-hash collision — and `DESTROYED` carries none.
|
|
221
217
|
|
|
218
|
+
A stage failure's `message` and its stage record's `error` carry the thrown value's message as
|
|
219
|
+
`errorToMessage`, from `@orkestrel/contract`, reads it: a thrown value that cannot be read, or
|
|
220
|
+
that reads as empty text, records `'unknown failure'`.
|
|
221
|
+
|
|
222
222
|
### Validators
|
|
223
223
|
|
|
224
224
|
Total guards composed from the `@orkestrel/contract` combinators. Adversarial input — junk,
|
|
@@ -236,8 +236,6 @@ guards the same way with `@orkestrel/interpret`'s published `isInterpretation`,
|
|
|
236
236
|
doors: the borrowed engine's return and a caller-supplied `interpretation`. A malformed value at
|
|
237
237
|
either door records `INTERPRET_FAILED` instead of throwing out of `compile`.
|
|
238
238
|
|
|
239
|
-
In a guard table a `Shape` cell holds the type the guard narrows to.
|
|
240
|
-
|
|
241
239
|
| Name | Kind | Signature | Summary |
|
|
242
240
|
| ----------------- | ----- | ---------------------- | ------------------------------------------------------------------------------------------------ |
|
|
243
241
|
| `isText` | const | `Guard<string>` | Checks whether the value is a string holding no line terminator, empty included. |
|
|
@@ -313,8 +311,6 @@ over the same values and fails the moment they diverge, and `createBriefContract
|
|
|
313
311
|
`ContractInterface<Brief>` return type makes the compiler prove `Infer<typeof briefShape>`
|
|
314
312
|
is exactly `Brief`.
|
|
315
313
|
|
|
316
|
-
A `Shape` cell holds the constant's declared type.
|
|
317
|
-
|
|
318
314
|
| Name | Kind | Signature | Summary |
|
|
319
315
|
| ---------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
320
316
|
| `textShape` | const | `StringShape` | Describes a single-line string of any length, including empty — the shape mirror of `isText`. |
|
|
@@ -492,7 +488,6 @@ consumes a whole and returns a derived view of it.
|
|
|
492
488
|
| `deriveTask` | function | `(intent: Intent, text: string, actions: Readonly<Record<string, TaskOperation>>, domains: Readonly<Record<string, TaskDomain>>) => Task \| undefined` | Derives a `Task` from an interprets `Intent` through the caller's vocabularies. |
|
|
493
489
|
| `deriveGivens` | function | `(entities: readonly Entity[]) => readonly Given[]` | Derives `Given[]` from an interprets `Entity[]`. |
|
|
494
490
|
| `deriveGaps` | function | `(ambiguities: readonly Ambiguity[]) => readonly Gap[]` | Derives `Gap[]` from an interprets `Ambiguity[]`. |
|
|
495
|
-
| `errorToMessage` | function | `(error: unknown) => string` | Renders a value thrown by a stage into a message. |
|
|
496
491
|
| `freezeDeep` | function | `<T>(value: T) => T` | Freezes a value and everything reachable from it. |
|
|
497
492
|
| `freezeBranch` | function | `<T>(value: T, seen: WeakSet<object>) => T` | Freezes one branch of a value graph, skipping what the visited set already holds. |
|
|
498
493
|
|
|
@@ -510,7 +505,6 @@ import {
|
|
|
510
505
|
deriveGivens,
|
|
511
506
|
deriveStatement,
|
|
512
507
|
deriveTask,
|
|
513
|
-
errorToMessage,
|
|
514
508
|
freezeDeep,
|
|
515
509
|
findBlockingGaps,
|
|
516
510
|
findUngrantedAuthority,
|
|
@@ -548,8 +542,6 @@ deriveTask(
|
|
|
548
542
|
) // { operation: 'migrate', domain: 'code', statement: 'Migrate the stores.' }
|
|
549
543
|
deriveGivens([{ name: 'count', value: 3, provenance: { category: 'extracted' }, confidence: 1 }]) // [{ category: 'extracted', name: 'count', value: '3' }]
|
|
550
544
|
deriveGaps([{ field: 'output', question: 'Diff or files?', candidates: [], required: true }])
|
|
551
|
-
errorToMessage(new Error('boom')) // 'boom'
|
|
552
|
-
errorToMessage(Object.create(null)) // 'an unreadable object was thrown' — never throws
|
|
553
545
|
freezeDeep({ outcomes: [{ rank: 1 }] }) // nested array frozen too, unlike Object.freeze
|
|
554
546
|
|
|
555
547
|
const leaf = () => 'ready'
|
|
@@ -934,7 +926,7 @@ const migrations = createBriefCompiler({
|
|
|
934
926
|
numbers: [3],
|
|
935
927
|
}),
|
|
936
928
|
},
|
|
937
|
-
|
|
929
|
+
recipes: [
|
|
938
930
|
{
|
|
939
931
|
id: 'migration',
|
|
940
932
|
name: 'Migration',
|
|
@@ -973,7 +965,7 @@ migration.brief !== undefined // true
|
|
|
973
965
|
migrations.destroy()
|
|
974
966
|
```
|
|
975
967
|
|
|
976
|
-
Drop the
|
|
968
|
+
Drop the recipes and the same call blocks instead, carrying interprets own question
|
|
977
969
|
(`Which domain and action did you mean?`) as a blocking gap. That is the design working, not
|
|
978
970
|
a defect: a contract built on a request the language pipeline could not resolve is exactly
|
|
979
971
|
what the gate exists to refuse. A caller who does not want interpretation omits `text` and
|
|
@@ -273,7 +273,7 @@ The core supplies the entities a browser session and an agent use. Its host-spec
|
|
|
273
273
|
| `BROWSER_DEFAULT_VIEWPORT_HEIGHT` | const | `720` | Sets the default viewport height, `720` pixels. |
|
|
274
274
|
| `BROWSER_DEFAULT_VIEWPORT_WIDTH` | const | `1280` | Sets the default viewport width, `1280` pixels. |
|
|
275
275
|
| `BROWSER_FRAME_WORLD_NAME` | const | `"__orkestrelBrowserFrame"` | Names the isolated world used for iframe evaluation, `'__orkestrelBrowserFrame'`. |
|
|
276
|
-
| `BROWSER_HAR_CREATOR` | const | `Readonly<{ name: "@orkestrel/browser"; version: "0.0.
|
|
276
|
+
| `BROWSER_HAR_CREATOR` | const | `Readonly<{ name: "@orkestrel/browser"; version: "0.0.31"; }>` | Names the tool identity embedded in HAR 1.2 documents. |
|
|
277
277
|
| `BROWSER_KEY_MODIFIERS` | const | `Readonly<Record<string, number>>` | Maps a canonical modifier name to its CDP Input modifier bit value. |
|
|
278
278
|
| `BROWSER_MOUSE_BUTTON_MASKS` | const | `Readonly<Record<BrowserMouseButton, number>>` | Maps each public mouse button to its CDP Input pressed-button bit value. |
|
|
279
279
|
| `BROWSER_NAVIGATION_REASONS` | const | `readonly BrowserNavigationReason[]` | Lists every CDP `Page.ClientNavigationReason` value a page accepts as a navigation's reason, as of Chromium 141; a page reads any other reason as undefined. |
|
|
@@ -194,7 +194,7 @@ Engine, runner, preflight, and contact-sheet contracts from [`types.ts`](../src/
|
|
|
194
194
|
| `CaptureOutcome` | interface | `{ project, variant, count }` | Carries one project's owner-bearing passed work count from a finished stage. |
|
|
195
195
|
| `CaptureRunPlan` | interface | `{ command, projects, selector, filter, case?, state?, final, directory, config }` | Carries everything every stage of one invocation shares. |
|
|
196
196
|
| `CaptureInvocationOptions` | interface | `{ command, root, requests, stdout, stderr, terminate?, ownership? }` | Configures one runner invocation's identity, workspace, and output. |
|
|
197
|
-
| `CaptureChildTerminationHandler` | type | `(child:
|
|
197
|
+
| `CaptureChildTerminationHandler` | type | `(child: DuplexInterface) => Promise<boolean>` | Terminates one supervised child and reports whether its exit was confirmed. |
|
|
198
198
|
| `CaptureInvocationInterface` | interface | `{ id, request, directory, signal, interrupted, attach(), release(), prepare(), holders(), publish(), retract(), launched(), spawn() }` | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
199
199
|
| `CaptureDiscoveryRequest` | interface | `{ version, phase, id, nonce, config, pid, args }` | Carries the request the runner publishes for the discovery child that reads its wrapper. |
|
|
200
200
|
| `CaptureHostEntry` | interface | `{ project, viewport? }` | Describes one wrapper project to the runner: its host declarations and, when it has one, its viewport. |
|
|
@@ -588,7 +588,7 @@ const request = readCaptureRequest({
|
|
|
588
588
|
request?.selector // 'pages:mail' when a runner is the parent, otherwise undefined
|
|
589
589
|
```
|
|
590
590
|
|
|
591
|
-
**Processes.** The runner spawns `process.execPath` with the installed `node_modules/vitest/vitest.mjs`, an argument array, and no shell. The child inherits the environment with every case-folded `capture` name removed and `CAPTURE_REQUESTS` set to the request directory, and a `capture` command, like discovery, sets exactly one `CAPTURE=1`. Each stage writes its own log and JSON report under `<requests>/runs/<id>/`, and the child's output is teed to the host's streams and the log. Each child runs through `@orkestrel/process` `
|
|
591
|
+
**Processes.** The runner spawns `process.execPath` with the installed `node_modules/vitest/vitest.mjs`, an argument array, and no shell. The child inherits the environment with every case-folded `capture` name removed and `CAPTURE_REQUESTS` set to the request directory, and a `capture` command, like discovery, sets exactly one `CAPTURE=1`. Each stage writes its own log and JSON report under `<requests>/runs/<id>/`, and the child's output is teed to the host's streams and the log. Each child runs through `@orkestrel/process` `createDuplex` with stdin closed immediately. Its byte output is decoded with `StringDecoder`, preserving split UTF-8, carriage returns, and missing final newlines, and the decoder is flushed at termination. A writer or log failure, or a session whose output did not drain before its observation bound, refuses the stage. An interrupt aborts the stage's signal and ends each child's tree: Windows tree termination, or POSIX `SIGTERM` followed by `SIGKILL` after a 250 ms grace. A pre-aborted invocation launches no child. The invocation then removes its request and releases its handlers.
|
|
592
592
|
|
|
593
593
|
**Host evidence (2026-10-28).** A real console Ctrl+C on Windows and a process-group SIGINT through the built executable on Linux each ended the stage tree, started no later stage, removed the request, and left the manifest bytes unchanged. The Windows reading uses a console-capable terminal; the POSIX automated case runs only where its process-group mechanism is available.
|
|
594
594
|
|