@orkestrel/scaffold 0.0.113 → 0.0.114
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/agents/skills/orkestrel-publish/scripts/wave.js +83 -16
- package/dist/bin/main.js +71 -23
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/skills/orkestrel-publish/SKILL.md +7 -7
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +22 -8
- package/dist/host/agents/skills/orkestrel-publish/scripts/wave.ts +150 -49
- package/dist/host/claude/agents/orkestrel.md +53 -53
- package/dist/host/claude/rules/tests.md +6 -4
- package/dist/host/claude/rules/workspace.md +28 -28
- package/dist/host/guides/agent.md +13 -13
- package/dist/host/guides/brief.md +4 -0
- package/dist/host/guides/browser.md +162 -44
- package/dist/host/guides/budget.md +1 -1
- package/dist/host/guides/capture.md +4 -0
- package/dist/host/guides/console.md +13 -0
- package/dist/host/guides/contract.md +38 -3
- package/dist/host/guides/csv.md +5 -0
- package/dist/host/guides/database.md +58 -8
- package/dist/host/guides/form.md +17 -0
- package/dist/host/guides/guide.md +36 -33
- package/dist/host/guides/html.md +72 -44
- package/dist/host/guides/indexeddb.md +4 -0
- package/dist/host/guides/lsp.md +49 -8
- package/dist/host/guides/markdown.md +146 -1
- package/dist/host/guides/mcp.md +117 -22
- package/dist/host/guides/middleware.md +194 -26
- package/dist/host/guides/msg.md +9 -5
- package/dist/host/guides/pool.md +8 -1
- package/dist/host/guides/probe.md +13 -1
- package/dist/host/guides/process.md +102 -90
- package/dist/host/guides/program.md +4 -0
- package/dist/host/guides/qualifier.md +4 -0
- package/dist/host/guides/rater.md +4 -0
- package/dist/host/guides/reason.md +6 -4
- package/dist/host/guides/relation.md +4 -0
- package/dist/host/guides/scaffold.md +32 -14
- package/dist/host/guides/server.md +29 -13
- package/dist/host/guides/sqlite.md +6 -0
- package/dist/host/guides/sse.md +6 -0
- package/dist/host/guides/study.md +473 -473
- package/dist/host/guides/table.md +3 -0
- package/dist/host/guides/template.md +3 -0
- package/dist/host/guides/test.md +38 -20
- package/dist/host/guides/tool.md +3 -0
- package/dist/host/guides/toolbox.md +21 -0
- package/dist/host/guides/websocket.md +3 -1
- package/dist/host/guides/workflow.md +103 -11
- package/dist/host/guides/workspace.md +4 -0
- package/dist/host/manifest.json +47 -47
- package/dist/host/tests/config.test.ts +7 -13
- package/dist/src/core/index.cjs +20 -28
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +7 -7
- package/dist/src/core/index.d.ts +7 -7
- package/dist/src/core/index.js +20 -28
- package/dist/src/core/index.js.map +1 -1
- package/package.json +12 -12
|
@@ -43,59 +43,59 @@ so network-controlled descriptions never enter agent instruction context.
|
|
|
43
43
|
|
|
44
44
|
<!-- orkestrel:catalog -->
|
|
45
45
|
|
|
46
|
-
| Package | Version | Layer | Runtime dependencies
|
|
47
|
-
| ----------------------- | --------- | ----- |
|
|
48
|
-
| `@orkestrel/abort` | `0.0.
|
|
49
|
-
| `@orkestrel/agent` | `0.0.
|
|
50
|
-
| `@orkestrel/brief` | `0.0.
|
|
51
|
-
| `@orkestrel/browser` | `0.0.
|
|
52
|
-
| `@orkestrel/budget` | `0.0.
|
|
53
|
-
| `@orkestrel/capture` | `0.0.
|
|
54
|
-
| `@orkestrel/codec` | `0.0.
|
|
55
|
-
| `@orkestrel/console` | `0.0.
|
|
56
|
-
| `@orkestrel/contract` | `0.0.
|
|
57
|
-
| `@orkestrel/csv` | `0.0.
|
|
58
|
-
| `@orkestrel/database` | `0.0.
|
|
59
|
-
| `@orkestrel/emitter` | `0.0.
|
|
60
|
-
| `@orkestrel/form` | `0.0.
|
|
61
|
-
| `@orkestrel/guide` | `0.0.
|
|
62
|
-
| `@orkestrel/html` | `0.0.
|
|
63
|
-
| `@orkestrel/indexeddb` | `0.0.
|
|
64
|
-
| `@orkestrel/interpret` | `0.0.
|
|
65
|
-
| `@orkestrel/lsp` | `0.0.
|
|
66
|
-
| `@orkestrel/markdown` | `0.0.
|
|
67
|
-
| `@orkestrel/mcp` | `0.0.
|
|
68
|
-
| `@orkestrel/middleware` | `0.0.
|
|
69
|
-
| `@orkestrel/msg` | `0.0.
|
|
70
|
-
| `@orkestrel/ndjson` | `0.0.
|
|
71
|
-
| `@orkestrel/ollama` | `0.0.
|
|
72
|
-
| `@orkestrel/pool` | `0.0.
|
|
73
|
-
| `@orkestrel/probe` | `0.0.
|
|
74
|
-
| `@orkestrel/process` | `0.0.
|
|
75
|
-
| `@orkestrel/program` | `0.0.
|
|
76
|
-
| `@orkestrel/qualifier` | `0.0.
|
|
77
|
-
| `@orkestrel/queue` | `0.0.
|
|
78
|
-
| `@orkestrel/rater` | `0.0.
|
|
79
|
-
| `@orkestrel/reason` | `0.0.
|
|
80
|
-
| `@orkestrel/relation` | `0.0.
|
|
81
|
-
| `@orkestrel/router` | `0.0.
|
|
82
|
-
| `@orkestrel/scaffold` | `0.0.
|
|
83
|
-
| `@orkestrel/sea` | `0.0.
|
|
84
|
-
| `@orkestrel/server` | `0.0.
|
|
85
|
-
| `@orkestrel/sqlite` | `0.0.
|
|
86
|
-
| `@orkestrel/sse` | `0.0.
|
|
87
|
-
| `@orkestrel/study` | `0.0.
|
|
88
|
-
| `@orkestrel/table` | `0.0.
|
|
89
|
-
| `@orkestrel/template` | `0.0.
|
|
90
|
-
| `@orkestrel/terminal` | `0.0.
|
|
91
|
-
| `@orkestrel/test` | `0.0.
|
|
92
|
-
| `@orkestrel/timeout` | `0.0.
|
|
93
|
-
| `@orkestrel/tool` | `0.0.
|
|
94
|
-
| `@orkestrel/toolbox` | `0.0.
|
|
95
|
-
| `@orkestrel/websocket` | `0.0.
|
|
96
|
-
| `@orkestrel/worker` | `0.0.
|
|
97
|
-
| `@orkestrel/workflow` | `0.0.
|
|
98
|
-
| `@orkestrel/workspace` | `0.0.
|
|
46
|
+
| Package | Version | Layer | Runtime dependencies | Peer dependencies |
|
|
47
|
+
| ----------------------- | --------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
48
|
+
| `@orkestrel/abort` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
49
|
+
| `@orkestrel/agent` | `0.0.33` | L5 | `@orkestrel/tool` `^0.0.20`, `@orkestrel/abort` `^0.0.14`, `@orkestrel/queue` `^0.0.18`, `@orkestrel/budget` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19`, `@orkestrel/workflow` `^0.0.24`, `@orkestrel/workspace` `^0.0.13` | |
|
|
50
|
+
| `@orkestrel/brief` | `0.0.13` | L4 | `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/interpret` `^0.0.18` | |
|
|
51
|
+
| `@orkestrel/browser` | `0.0.30` | L5 | `@orkestrel/mcp` `^0.0.40`, `@orkestrel/html` `^0.0.13`, `@orkestrel/pool` `^0.0.18`, `@orkestrel/tool` `^0.0.20`, `@orkestrel/codec` `^0.0.7`, `@orkestrel/router` `^0.0.18`, `@orkestrel/server` `^0.0.24`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/markdown` `^0.0.18`, `@orkestrel/websocket` `^0.0.16` | |
|
|
52
|
+
| `@orkestrel/budget` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
53
|
+
| `@orkestrel/capture` | `0.0.2` | L3 | `@orkestrel/process` `^0.0.16`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | `vite` `^8.3.5`, `vitest` `^4.1.12 \|\| ^5.0.5`, `playwright` `^1.61.0`, `@vitest/browser-playwright` `^4.1.12 \|\| ^5.0.5` |
|
|
54
|
+
| `@orkestrel/codec` | `0.0.7` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
55
|
+
| `@orkestrel/console` | `0.0.17` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
56
|
+
| `@orkestrel/contract` | `0.0.20` | L0 | | |
|
|
57
|
+
| `@orkestrel/csv` | `0.0.11` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
58
|
+
| `@orkestrel/database` | `0.0.19` | L2 | `@orkestrel/sqlite` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/indexeddb` `^0.0.15` | |
|
|
59
|
+
| `@orkestrel/emitter` | `0.0.13` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
60
|
+
| `@orkestrel/form` | `0.0.14` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
61
|
+
| `@orkestrel/guide` | `0.0.26` | L3 | `@orkestrel/contract` `^0.0.20`, `@orkestrel/markdown` `^0.0.18` | |
|
|
62
|
+
| `@orkestrel/html` | `0.0.13` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
63
|
+
| `@orkestrel/indexeddb` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
64
|
+
| `@orkestrel/interpret` | `0.0.18` | L3 | `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/template` `^0.0.11` | |
|
|
65
|
+
| `@orkestrel/lsp` | `0.0.12` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20` | |
|
|
66
|
+
| `@orkestrel/markdown` | `0.0.18` | L2 | `@orkestrel/html` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
67
|
+
| `@orkestrel/mcp` | `0.0.40` | L4 | `@orkestrel/sse` `^0.0.11`, `@orkestrel/tool` `^0.0.20`, `@orkestrel/codec` `^0.0.7`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/websocket` `^0.0.16` | `@orkestrel/router` `^0.0.18`, `@orkestrel/server` `^0.0.24` |
|
|
68
|
+
| `@orkestrel/middleware` | `0.0.26` | L4 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/budget` `^0.0.15`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | `@orkestrel/server` `^0.0.24`, `@orkestrel/database` `^0.0.19` |
|
|
69
|
+
| `@orkestrel/msg` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
70
|
+
| `@orkestrel/ndjson` | `0.0.13` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
71
|
+
| `@orkestrel/ollama` | `0.0.27` | L6 | `@orkestrel/tool` `^0.0.20`, `@orkestrel/agent` `^0.0.33`, `@orkestrel/budget` `^0.0.15`, `@orkestrel/ndjson` `^0.0.13`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20` | |
|
|
72
|
+
| `@orkestrel/pool` | `0.0.18` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
73
|
+
| `@orkestrel/probe` | `0.0.26` | L5 | `@orkestrel/lsp` `^0.0.12`, `@orkestrel/mcp` `^0.0.40`, `@orkestrel/pool` `^0.0.18`, `@orkestrel/tool` `^0.0.20`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | `vitest` `^4.1.12 \|\| ^5.0.5`, `typescript` `^6.0.3 \|\| ^7.0.2` |
|
|
74
|
+
| `@orkestrel/process` | `0.0.16` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
75
|
+
| `@orkestrel/program` | `0.0.18` | L4 | `@orkestrel/rater` `^0.0.19`, `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/qualifier` `^0.0.19` | |
|
|
76
|
+
| `@orkestrel/qualifier` | `0.0.19` | L3 | `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
77
|
+
| `@orkestrel/queue` | `0.0.18` | L3 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
78
|
+
| `@orkestrel/rater` | `0.0.19` | L3 | `@orkestrel/reason` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
79
|
+
| `@orkestrel/reason` | `0.0.15` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
80
|
+
| `@orkestrel/relation` | `0.0.17` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
81
|
+
| `@orkestrel/router` | `0.0.18` | L2 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
82
|
+
| `@orkestrel/scaffold` | `0.0.113` | L3 | `@orkestrel/console` `^0.0.16`, `@orkestrel/emitter` `^0.0.12`, `@orkestrel/process` `^0.0.15`, `@orkestrel/contract` `^0.0.19`, `@orkestrel/markdown` `^0.0.17`, `@orkestrel/template` `^0.0.10` | |
|
|
83
|
+
| `@orkestrel/sea` | `0.0.20` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/process` `^0.0.16`, `@orkestrel/contract` `^0.0.20` | |
|
|
84
|
+
| `@orkestrel/server` | `0.0.24` | L3 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/codec` `^0.0.7`, `@orkestrel/router` `^0.0.18`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | |
|
|
85
|
+
| `@orkestrel/sqlite` | `0.0.15` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
86
|
+
| `@orkestrel/sse` | `0.0.11` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
87
|
+
| `@orkestrel/study` | `0.0.7` | L7 | `@orkestrel/tool` `^0.0.20`, `@orkestrel/abort` `^0.0.14`, `@orkestrel/agent` `^0.0.33`, `@orkestrel/budget` `^0.0.15`, `@orkestrel/ollama` `^0.0.27`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20` | |
|
|
88
|
+
| `@orkestrel/table` | `0.0.13` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
89
|
+
| `@orkestrel/template` | `0.0.11` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
90
|
+
| `@orkestrel/terminal` | `0.0.21` | L3 | `@orkestrel/sse` `^0.0.11`, `@orkestrel/form` `^0.0.14`, `@orkestrel/console` `^0.0.17`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
91
|
+
| `@orkestrel/test` | `0.0.31` | L1 | `@orkestrel/contract` `^0.0.20` | `vitest` `^4.1.12 \|\| ^5.0.5`, `playwright` `^1.64.1` |
|
|
92
|
+
| `@orkestrel/timeout` | `0.0.14` | L1 | `@orkestrel/contract` `^0.0.20` | |
|
|
93
|
+
| `@orkestrel/tool` | `0.0.20` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
94
|
+
| `@orkestrel/toolbox` | `0.0.22` | L6 | `@orkestrel/form` `^0.0.14`, `@orkestrel/tool` `^0.0.20`, `@orkestrel/agent` `^0.0.33`, `@orkestrel/server` `^0.0.24`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19`, `@orkestrel/relation` `^0.0.17`, `@orkestrel/terminal` `^0.0.21`, `@orkestrel/workflow` `^0.0.24`, `@orkestrel/workspace` `^0.0.13` | |
|
|
95
|
+
| `@orkestrel/websocket` | `0.0.16` | L2 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20` | |
|
|
96
|
+
| `@orkestrel/worker` | `0.0.18` | L4 | `@orkestrel/pool` `^0.0.18`, `@orkestrel/queue` `^0.0.18`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
97
|
+
| `@orkestrel/workflow` | `0.0.24` | L4 | `@orkestrel/abort` `^0.0.14`, `@orkestrel/queue` `^0.0.18`, `@orkestrel/budget` `^0.0.15`, `@orkestrel/emitter` `^0.0.13`, `@orkestrel/timeout` `^0.0.14`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
98
|
+
| `@orkestrel/workspace` | `0.0.13` | L3 | `@orkestrel/emitter` `^0.0.13`, `@orkestrel/contract` `^0.0.20`, `@orkestrel/database` `^0.0.19` | |
|
|
99
99
|
|
|
100
100
|
<!-- /orkestrel:catalog -->
|
|
101
101
|
|
|
@@ -166,12 +166,14 @@ A test that spawns a process, packs, installs, or drives a real build is a proof
|
|
|
166
166
|
|
|
167
167
|
- Give it its own Vitest project with its own setup and timeout.
|
|
168
168
|
- Keep it out of the default run where the workspace has a gate that can hold it.
|
|
169
|
-
`.claude/rules/workspace.md` fixes
|
|
169
|
+
`.claude/rules/workspace.md` fixes where each isolated project runs, and that placement
|
|
170
170
|
differs between a publishing and a `private: true` workspace.
|
|
171
|
-
-
|
|
172
|
-
- Put
|
|
171
|
+
- Use `distribution` and `service` as the fixed expensive-proof projects.
|
|
172
|
+
- Put a study's proofs under `tests/studies/` in the `studies` project, which
|
|
173
|
+
`.claude/rules/workspace.md` § Test project matrix places.
|
|
174
|
+
- Put in `studies` only the proofs the `@orkestrel/study` engine drives. Place a slow end-to-end proof of
|
|
173
175
|
the package's own features that no study engine drives, such as its built executable run against
|
|
174
|
-
a fixture workspace,
|
|
176
|
+
a fixture workspace, as an integration test under § Cross-cutting proofs. Place it by the scope it
|
|
175
177
|
composes:
|
|
176
178
|
- Put a proof that crosses environments in `tests/integration.test.ts`, which the `integration`
|
|
177
179
|
project runs from `test`.
|
|
@@ -184,7 +184,7 @@ one environment, so each is its own project:
|
|
|
184
184
|
| `distribution` | `tests/distribution.test.ts` | The packed package installs and resolves through its public exports | `prepublishOnly`; absent when private |
|
|
185
185
|
| `integration` | `tests/integration.test.ts` | The package's features work together end to end across environments | `test` |
|
|
186
186
|
| `service` | `tests/service/**/*.test.ts` | The live external services this package drives, driven for real | `prepublishOnly`; `test` when private |
|
|
187
|
-
| `studies` | `tests/studies/**/*.test.ts` |
|
|
187
|
+
| `studies` | `tests/studies/**/*.test.ts` | Run the study proofs the `@orkestrel/study` engine drives. | Run `npm run test:studies` on demand. |
|
|
188
188
|
|
|
189
189
|
- Define the Node `setup` project when `global` selects its seeded proof or a root file matches
|
|
190
190
|
`tests/setup*.test.ts`, exact-case, other than `tests/setupBrowser.test.ts` and
|
|
@@ -209,18 +209,18 @@ one environment, so each is its own project:
|
|
|
209
209
|
from its application project, and run `test:journey` and one `test:journey:<framework>` per
|
|
210
210
|
app-side browser extension after the application projects in `test`.
|
|
211
211
|
|
|
212
|
-
`conformance`, `tree`, `integration`, `distribution`, `studies`, and `service`
|
|
213
|
-
subjects
|
|
212
|
+
Keep `conformance`, `tree`, `integration`, `distribution`, `studies`, and `service` as separate
|
|
213
|
+
subjects.
|
|
214
214
|
Keep `conformance` in `test`: measure this package against an installed official artifact, and start
|
|
215
215
|
any server the proof drives itself. Keep `tree` in `test`: read the real tree in Node and drive no
|
|
216
216
|
build, install, or service. Keep `integration` in `test` whatever its cost: compose the workspace's public
|
|
217
217
|
surfaces without packing, installing, or driving an external service. In a publishing workspace,
|
|
218
|
-
run `distribution
|
|
219
|
-
`distribution`,
|
|
220
|
-
proof, and drive the real service with `tests/setupService.ts`, longer timeouts, and no file
|
|
218
|
+
run `distribution` and `service` from `prepublishOnly`: pack and install the package in
|
|
219
|
+
`distribution`, and drive the real service with `tests/setupService.ts`, longer timeouts, and no file
|
|
221
220
|
parallelism in `service`. In a `private: true` workspace, never declare `prepublishOnly`; omit
|
|
222
|
-
`distribution`, reach `
|
|
223
|
-
|
|
221
|
+
`distribution`, reach `service` from `test`, and retain each isolated project's configuration.
|
|
222
|
+
In both kinds of workspace, run `studies` on demand through `npm run test:studies` alone.
|
|
223
|
+
Keep `test:studies` out of every gate and chain.
|
|
224
224
|
|
|
225
225
|
One project sits on neither axis. `probe` includes `tmp/probes/**/*.test.ts` so an agent can run a
|
|
226
226
|
throwaway instrument against real sources, aliases and setup. Declare no proof there. Keep the
|
|
@@ -292,26 +292,26 @@ Build/check config alignment:
|
|
|
292
292
|
|
|
293
293
|
## Script intent
|
|
294
294
|
|
|
295
|
-
| Script | Contract
|
|
296
|
-
| ---------------------------- |
|
|
297
|
-
| `dev` | Browser development entry
|
|
298
|
-
| `build` | Build configured library/application targets
|
|
299
|
-
| `serve` / `serve:build` | Run built server / build then run
|
|
300
|
-
| `showcase` | Showcase dev server of the base mode
|
|
301
|
-
| `showcase:<framework>` | Showcase dev server of that framework's mode
|
|
302
|
-
| `build:showcase` | Build `showcase/browser.html`
|
|
303
|
-
| `build:showcase:<framework>` | Build `showcase/<framework>.html`
|
|
304
|
-
| `lint` | `oxlint --config .oxlintrc.json --fix .`; separate from typecheck
|
|
305
|
-
| `lint:check` | Non-mutating whole-tree lint gate
|
|
306
|
-
| `check` | Comprehensive root typecheck plus configured isolation scopes
|
|
307
|
-
| `check:<scope>` | On-demand environment-isolation pass
|
|
308
|
-
| `format` | Format all files
|
|
309
|
-
| `format:check` | Non-mutating whole-tree format gate
|
|
310
|
-
| `test` | Environment projects plus non-isolated cross-cutting proofs
|
|
311
|
-
| `clean` | Remove `dist/`
|
|
312
|
-
| `copy <from> <to>` | Copy while creating parent directories
|
|
313
|
-
| `prepublishOnly` | Publishing workspaces only: the gate chain, then isolated proofs
|
|
314
|
-
| `prepack` | Publishing workspaces only: rebuild `dist/` so a pack ships current output
|
|
295
|
+
| Script | Contract |
|
|
296
|
+
| ---------------------------- | ---------------------------------------------------------------------------- |
|
|
297
|
+
| `dev` | Browser development entry |
|
|
298
|
+
| `build` | Build configured library/application targets |
|
|
299
|
+
| `serve` / `serve:build` | Run built server / build then run |
|
|
300
|
+
| `showcase` | Showcase dev server of the base mode |
|
|
301
|
+
| `showcase:<framework>` | Showcase dev server of that framework's mode |
|
|
302
|
+
| `build:showcase` | Build `showcase/browser.html` |
|
|
303
|
+
| `build:showcase:<framework>` | Build `showcase/<framework>.html` |
|
|
304
|
+
| `lint` | `oxlint --config .oxlintrc.json --fix .`; separate from typecheck |
|
|
305
|
+
| `lint:check` | Non-mutating whole-tree lint gate |
|
|
306
|
+
| `check` | Comprehensive root typecheck plus configured isolation scopes |
|
|
307
|
+
| `check:<scope>` | On-demand environment-isolation pass |
|
|
308
|
+
| `format` | Format all files |
|
|
309
|
+
| `format:check` | Non-mutating whole-tree format gate |
|
|
310
|
+
| `test` | Environment projects plus non-isolated cross-cutting proofs |
|
|
311
|
+
| `clean` | Remove `dist/` |
|
|
312
|
+
| `copy <from> <to>` | Copy while creating parent directories |
|
|
313
|
+
| `prepublishOnly` | Publishing workspaces only: the gate chain, then the isolated release proofs |
|
|
314
|
+
| `prepack` | Publishing workspaces only: rebuild `dist/` so a pack ships current output |
|
|
315
315
|
|
|
316
316
|
- In a publishing workspace, `prepublishOnly` runs `build:showcase` and every
|
|
317
317
|
`build:showcase:<framework>` script after `npm run build`.
|
|
@@ -742,7 +742,7 @@ The following table lists the errors the root declares and the guards that narro
|
|
|
742
742
|
| API | Kind | Summary |
|
|
743
743
|
| ------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
744
744
|
| `JudgeAbortError` | class | Reports a judge call cancelled by the caller's signal or its deadline, carrying the `JudgeResult` merged from the calls that completed before the cancel and the machine-readable `code` `'ABORT'`. |
|
|
745
|
-
| `isJudgeAbortError` | function | Narrows a caught value to a `JudgeAbortError` through
|
|
745
|
+
| `isJudgeAbortError` | function | Narrows a caught value to a `JudgeAbortError` through its identity brand and declared members, so a `catch` can recover its `partial` result. |
|
|
746
746
|
|
|
747
747
|
#### Shapes and contracts
|
|
748
748
|
|
|
@@ -862,11 +862,11 @@ The following table lists the errors the providers module declares and the guard
|
|
|
862
862
|
| API | Kind | Summary |
|
|
863
863
|
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
864
864
|
| `ProviderAbortError` | class | Reports a provider stream cancelled mid-flight by its bound signal — thrown by the `stream` method of a `ProviderInterface`, carrying the `ProviderResult` assembled from whatever streamed before the cancel and the machine-readable `code` `'ABORT'`. |
|
|
865
|
-
| `isProviderAbortError` | function | Narrows an unknown caught value to a `ProviderAbortError` through
|
|
865
|
+
| `isProviderAbortError` | function | Narrows an unknown caught value to a `ProviderAbortError` through its identity brand and declared members, so a `catch` can recover its `partial` result. |
|
|
866
866
|
| `ProviderError` | class | Reports a coded provider failure with its HTTP status and underlying cause when available. |
|
|
867
|
-
| `isProviderError` | function | Narrows a caught value to the provider failure class through
|
|
867
|
+
| `isProviderError` | function | Narrows a caught value to the provider failure class through its identity brand and declared members. |
|
|
868
868
|
| `JudgeError` | class | Reports a coded judge failure with its HTTP status and underlying cause when available. |
|
|
869
|
-
| `isJudgeError` | function | Narrows a caught value to the judge failure class through
|
|
869
|
+
| `isJudgeError` | function | Narrows a caught value to the judge failure class through its identity brand and declared members. |
|
|
870
870
|
|
|
871
871
|
#### Shapes and contracts
|
|
872
872
|
|
|
@@ -998,7 +998,7 @@ The following table lists the errors the conversations module declares and the g
|
|
|
998
998
|
| API | Kind | Summary |
|
|
999
999
|
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1000
1000
|
| `ConversationError` | class | Reports a conversation with no `ConversationSummaryHandler` to fold its messages with, a `sections` cap below `1`, a `keep` that is not a nonnegative safe integer, or a judgment or judge request that JSON cannot carry — thrown by the `compact()` method of a `ConversationInterface`, its construction, or its judgment store, carrying the machine-readable `code` `'SUMMARIZER' \| 'SECTIONS' \| 'JUDGMENT' \| 'KEEP'`. |
|
|
1001
|
-
| `isConversationError` | function | Narrows an unknown caught value to a `ConversationError` through
|
|
1001
|
+
| `isConversationError` | function | Narrows an unknown caught value to a `ConversationError` through its identity brand and declared members, so a `catch` can branch on its `code`. |
|
|
1002
1002
|
|
|
1003
1003
|
#### Factories
|
|
1004
1004
|
|
|
@@ -1148,7 +1148,7 @@ The following table lists the types the agents module declares:
|
|
|
1148
1148
|
| `AgentTurn` | interface | `{ content, thinking, usage, spent, messages, ending, partial, futile, estimate, interrupted, truncated }` | Holds what one agent loop turn contributed to its run and how the turn ended — the readonly record the loop appends for each turn, from which the run derives its `AgentRunResult`. |
|
|
1149
1149
|
| `AgentStop` | type | `{ layer: 'meter' \| 'budget', id, max, consumed, estimate?, usage? } \| { layer: 'model', id, estimate?, usage? }` | Represents why one of a run's three allowed failure layers stopped it — the meter's estimate allowance, the cost budget, or the model's own token limit — with the readings that layer crossed. |
|
|
1150
1150
|
| `AgentErrorCode` | type | `'CONCURRENCY' \| 'LIMIT' \| 'REGISTRY' \| 'WINDOW'` | Names the machine-readable agent concurrency, limit, registry, and window failures. |
|
|
1151
|
-
| `MessageMeasure` | interface | `{ id, role, content,
|
|
1151
|
+
| `MessageMeasure` | interface | `{ id, role, content, uniform, calls, thinking, images }` | Holds the disjoint estimate components of one message, in heuristic estimate units. |
|
|
1152
1152
|
| `RequestMeasure` | interface | `{ messages, tools, schema }` | Holds the disjoint estimate components of one provider request, in heuristic estimate units. |
|
|
1153
1153
|
| `ChannelInterface` | interface | `{} plus push, close, fail, drain` | Buffers values in an unbounded async channel — a producer writes them in (`push`) and ends it (`close` / `fail`) regardless of consumption, while a consumer reads them back live through `drain`. |
|
|
1154
1154
|
| `StreamInterface` | interface | `{ events, result } plus abort` | Pairs a live event stream with the eventual settled result and a cancel — the generic pull/streaming handle a long-running operation hands back. |
|
|
@@ -1185,9 +1185,9 @@ The following table lists the errors the agents module declares and the guards t
|
|
|
1185
1185
|
| API | Kind | Summary |
|
|
1186
1186
|
| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1187
1187
|
| `AgentJobError` | class | Reports an `AgentInterface` run that ended `AgentResult.partial` under a `partial` policy of `false` (the default) — thrown by an agent-job handler (a `createAgentQueue` / `createAgentRunner` job), carrying the partial `AgentResult` so the failure stays inspectable, and the machine-readable `code` `'PARTIAL'`. |
|
|
1188
|
-
| `isAgentJobError` | function | Narrows an unknown caught value to an `AgentJobError` through
|
|
1188
|
+
| `isAgentJobError` | function | Narrows an unknown caught value to an `AgentJobError` through its identity brand and declared members, so a `catch` can recover its `partial` result. |
|
|
1189
1189
|
| `AgentError` | class | Reports a run sharing accounting with a live run, a `limit` that is not a nonnegative safe integer, a name absent from a registry pool, or a strict run whose request exceeds its window. Agent construction, the `stream` and `generate` methods, and registry accessors throw synchronously, before returning a handle or promise; a `'WINDOW'` refusal rejects the run's `result` instead. Await the call inside `try`/`catch` to catch it. |
|
|
1190
|
-
| `isAgentError` | function | Narrows an unknown caught value to an `AgentError` through
|
|
1190
|
+
| `isAgentError` | function | Narrows an unknown caught value to an `AgentError` through its identity brand and declared members, so a `catch` can branch on its `code`. |
|
|
1191
1191
|
|
|
1192
1192
|
#### Factories
|
|
1193
1193
|
|
|
@@ -1326,7 +1326,7 @@ The following table lists the types the ledger declares, each with its shape:
|
|
|
1326
1326
|
| `GaugeCall` | interface | `{ estimate, prompt?, completion?, thinking?, tools }` | Carries one agent call as the gauge reads it. |
|
|
1327
1327
|
| `GaugeOptions` | interface | `{ scale, overhead, capacity, predict?, replay? }` | Configures a gauge: its starting price of a prompt and the context capacity it measures against. |
|
|
1328
1328
|
| `GaugeInterface` | interface | `{ scale, overhead } plus rate, remainder, reserve, room, observe` | Prices prompts in tokens and measures the room a request has left. |
|
|
1329
|
-
| `
|
|
1329
|
+
| `LedgerPlanGroup` | type | `1 \| 2 \| 3` | Names a briefing source's planning group: a topic match, an off-topic rule or correction, or a name match. |
|
|
1330
1330
|
| `LedgerErrorCode` | type | `'REQUEST' \| 'THRESHOLD' \| 'SHARE' \| 'CAPACITY' \| 'LIMIT' \| 'TOPIC' \| 'LOOKUP' \| 'GAUGE' \| 'REFERENCE'` | Names the machine-readable conditions a `LedgerError` error reports. |
|
|
1331
1331
|
|
|
1332
1332
|
#### Constants
|
|
@@ -1353,10 +1353,10 @@ The following table lists the constants that hold the ledger's categories, recor
|
|
|
1353
1353
|
|
|
1354
1354
|
The following table lists the error the ledger raises and the guard that narrows it:
|
|
1355
1355
|
|
|
1356
|
-
| API | Kind | Summary
|
|
1357
|
-
| --------------- | -------- |
|
|
1358
|
-
| `LedgerError` | class | Reports an invalid ledger configuration, failed calibration, or unowned request selection, carrying the machine-readable `code`.
|
|
1359
|
-
| `isLedgerError` | function | Narrows an unknown caught value to a `LedgerError` through
|
|
1356
|
+
| API | Kind | Summary |
|
|
1357
|
+
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1358
|
+
| `LedgerError` | class | Reports an invalid ledger configuration, failed calibration, or unowned request selection, carrying the machine-readable `code`. |
|
|
1359
|
+
| `isLedgerError` | function | Narrows an unknown caught value to a `LedgerError` through its identity brand and declared members, so a `catch` can branch on its `code`. |
|
|
1360
1360
|
|
|
1361
1361
|
#### Factories
|
|
1362
1362
|
|
|
@@ -195,6 +195,10 @@ drift between the guard and the schema.
|
|
|
195
195
|
`BriefError` extends `Error` with a readonly `code` on the `BriefErrorCode` vocabulary and an
|
|
196
196
|
optional readonly `context` record.
|
|
197
197
|
|
|
198
|
+
The guard recognizes the shared brand across package copies, accepts subclasses,
|
|
199
|
+
and refuses transparent proxies and unbranded look-alikes. It accepts class and
|
|
200
|
+
callable contexts that satisfy the declared context type.
|
|
201
|
+
|
|
198
202
|
```ts
|
|
199
203
|
import { BriefError, isBriefError } from '@orkestrel/brief'
|
|
200
204
|
|