@orkestrel/scaffold 0.0.120 → 0.0.122
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-dispatch/scripts/brief.js +57 -9
- package/dist/agents/skills/orkestrel-dispatch/scripts/chain.js +22 -2
- package/dist/agents/skills/orkestrel-publish/scripts/pins.js +5 -5
- package/dist/agents/skills/orkestrel-publish/scripts/wave.js +67 -5
- package/dist/bin/main.js +5 -5
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/orchestration.md +16 -11
- package/dist/host/agents/skills/orkestrel-dispatch/SKILL.md +4 -4
- package/dist/host/agents/skills/orkestrel-dispatch/references/launch.md +2 -1
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/brief.ts +65 -9
- package/dist/host/agents/skills/orkestrel-dispatch/scripts/chain.ts +28 -2
- package/dist/host/agents/skills/orkestrel-falsify/references/brief.md +2 -1
- package/dist/host/agents/skills/orkestrel-harden/SKILL.md +8 -8
- package/dist/host/agents/skills/orkestrel-harden/references/hardening.md +3 -3
- package/dist/host/agents/skills/orkestrel-parallel/SKILL.md +2 -2
- package/dist/host/agents/skills/orkestrel-publish/SKILL.md +10 -8
- package/dist/host/agents/skills/orkestrel-publish/references/release.md +2 -2
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +22 -8
- package/dist/host/agents/skills/orkestrel-publish/references/window.md +5 -1
- package/dist/host/agents/skills/orkestrel-publish/scripts/pins.ts +5 -5
- package/dist/host/agents/skills/orkestrel-publish/scripts/wave.ts +86 -7
- package/dist/host/claude/AGENTS.md +1 -1
- package/dist/host/claude/agents/analyst.md +1 -1
- package/dist/host/claude/agents/opus.md +7 -6
- package/dist/host/claude/agents/orkestrel.md +26 -26
- package/dist/host/claude/agents/planner.md +3 -3
- package/dist/host/claude/agents/reviewer.md +3 -3
- package/dist/host/claude/agents/verifier.md +1 -1
- package/dist/host/claude/rules/campaign.md +3 -2
- package/dist/host/claude/rules/names.md +13 -7
- package/dist/host/claude/rules/tests.md +1 -1
- package/dist/host/claude/rules/workspace.md +9 -0
- package/dist/host/claude/skills/orkestrel-harden/SKILL.md +1 -1
- package/dist/host/codex/agents/analyst.toml +2 -5
- package/dist/host/codex/agents/opus.toml +5 -3
- package/dist/host/codex/agents/planner.toml +6 -5
- package/dist/host/codex/agents/reviewer.toml +4 -7
- package/dist/host/codex/agents/verifier.toml +2 -2
- package/dist/host/dotfiles/gitignore +1 -2
- 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 +18 -9
- 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 +63 -483
- package/dist/host/tests/config.test.ts +7 -0
- package/dist/src/core/index.cjs +13 -46
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.js +13 -46
- 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
- /package/dist/host/agents/skills/orkestrel-parallel/references/{claude.md → claude-code.md} +0 -0
|
@@ -42,6 +42,11 @@ Use only the environments a project needs, and keep the root dependency model in
|
|
|
42
42
|
found at the same name.
|
|
43
43
|
- `package.json`'s `bin` key is the installed command name. The entry path is the value and does
|
|
44
44
|
not carry that name.
|
|
45
|
+
- Keep every ignored output at the workspace root or under `tmp/`, and write no `.gitignore`
|
|
46
|
+
pattern that reaches into a nested tracked folder. A path under a dot folder, such as
|
|
47
|
+
`.claude/worktrees/`, is exempt. When a tool writes its output inside a tracked folder by
|
|
48
|
+
default, point the tool's own setting at a directory under `tmp/`. A bare name or glob that
|
|
49
|
+
names a root-level tool output, such as `dist`, `tmp`, or `*.log`, is a root ignore.
|
|
45
50
|
|
|
46
51
|
## Aliases
|
|
47
52
|
|
|
@@ -166,6 +171,10 @@ environment axis is one project per src/app axis × environment, plus one per ex
|
|
|
166
171
|
- Give every browser project `test.browser.commands` from `configs/commands.ts`: each root factory
|
|
167
172
|
that names the Playwright provider reads the record, and a project that spreads another
|
|
168
173
|
factory's `test.browser`, as `appVue` and every `journey:<variant>` project do, keeps it.
|
|
174
|
+
- Give every browser project `test.browser.screenshotDirectory` from the one `screenshots`
|
|
175
|
+
binding the root configuration declares beside `browserOptions`, which resolves
|
|
176
|
+
`tmp/captures/screenshots` from the workspace root; each root factory that names the Playwright
|
|
177
|
+
provider reads it, and a project that spreads another factory's `test.browser` keeps it.
|
|
169
178
|
|
|
170
179
|
The workspace-proof axis is cross-cutting. Each proof covers the whole workspace rather than
|
|
171
180
|
one environment, so each is its own project:
|
|
@@ -5,6 +5,6 @@ description: Research, audit, refactor, implement, centralize, test, document, a
|
|
|
5
5
|
|
|
6
6
|
# Load the canonical workflow
|
|
7
7
|
|
|
8
|
-
Read `.agents/skills/orkestrel-harden/SKILL.md` completely, then read every reference it requires for the selected
|
|
8
|
+
Read `.agents/skills/orkestrel-harden/SKILL.md` completely, then read every reference it requires for the selected phases. Follow that canonical workflow before acting.
|
|
9
9
|
|
|
10
10
|
Apply `AGENTS.md` § Authority and loading.
|
|
@@ -8,11 +8,8 @@ Read the brief, AGENTS.md, the .claude/rules files whose paths match the subject
|
|
|
8
8
|
and the guide. For a code subject, read the actual diff and status the dispatch supplies; return
|
|
9
9
|
a deviation if either is missing.
|
|
10
10
|
|
|
11
|
-
Hold the lane the dispatch names and say which
|
|
12
|
-
|
|
13
|
-
seam or the assertion that cannot fail, the letter of the rules) or subjective (the requested
|
|
14
|
-
shape and voice are present, names and boundaries are coherent, the work sits at the right layer,
|
|
15
|
-
each concept earns its place, the guide matches the code).
|
|
11
|
+
Hold the lane the dispatch names and say which, under the lens .agents/orchestration.md § Roles
|
|
12
|
+
gives that lane: objective by default, subjective when the dispatch assigns it.
|
|
16
13
|
|
|
17
14
|
Try to falsify each numbered claim with a concrete input, state, or interleaving. Before
|
|
18
15
|
confirming a claim about a proof, name the mutation that would make the proof fail and whether the assertions
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
name = "opus"
|
|
2
|
-
description = "GPT-6 Astra implementation of one bounded subjective
|
|
2
|
+
description = "GPT-6 Astra implementation of one bounded unit, subjective by default (API shape, naming, ergonomics, guide voice) and objective when the dispatch names it. Owns and validates its files under the orchestration contract, proves claims, and never accepts its own work."
|
|
3
3
|
model = "gpt-6-astra"
|
|
4
4
|
model_reasoning_effort = "high"
|
|
5
5
|
sandbox_mode = "workspace-write"
|
|
6
6
|
developer_instructions = """
|
|
7
|
-
Implement one dispatched
|
|
7
|
+
Implement one dispatched unit on GPT-6 Astra and spawn nothing.
|
|
8
8
|
|
|
9
9
|
Read the brief, AGENTS.md, the rules whose paths match the owned files, the named skill, and the
|
|
10
|
-
guide.
|
|
10
|
+
guide. Hold the load the dispatch names and say which: subjective by default, objective when
|
|
11
|
+
.agents/orchestration.md § Benches records the Astra bench dark. Under the objective load, prove
|
|
12
|
+
every refusal and failure path the contract states. Follow AGENTS.md § Work loop: types first, prove the claim, implement, test, consolidate,
|
|
11
13
|
document. Select the instrument per AGENTS.md § Work loop and .claude/rules/quality.md § Instruments
|
|
12
14
|
and return the evidence that instrument produced.
|
|
13
15
|
|
|
@@ -1,17 +1,18 @@
|
|
|
1
1
|
name = "planner"
|
|
2
|
-
description = "Read-only GPT-6 Astra design of shape, naming, ergonomics, alternatives, and bounded units, or a consultation at a seam. Never implements or accepts."
|
|
2
|
+
description = "Read-only GPT-6 Astra design of shape, naming, ergonomics, alternatives, and bounded units, or a consultation at a seam, including the Fable 5.1 consultation on the engine the dispatch names. Never implements or accepts."
|
|
3
3
|
model = "gpt-6-astra"
|
|
4
4
|
model_reasoning_effort = "high"
|
|
5
5
|
sandbox_mode = "read-only"
|
|
6
6
|
developer_instructions = """
|
|
7
7
|
Design one dispatched unit or give a read-only consultation under .agents/orchestration.md
|
|
8
|
-
§ Sessions and consultation on GPT-6 Astra.
|
|
9
|
-
|
|
8
|
+
§ Sessions and consultation on GPT-6 Astra. Also carry the read-only consultation
|
|
9
|
+
.agents/orchestration.md § Engines admits for Claude Fable 5.1, on the engine the dispatch names.
|
|
10
|
+
Use read-only inspection commands. Never edit, run a mutating command, or spawn.
|
|
10
11
|
|
|
11
12
|
Read the brief, AGENTS.md, the rules whose paths match the subject, the named skill, the guide,
|
|
12
13
|
and the supplied distillate. Work from the brief alone; never look for or reconcile the other
|
|
13
|
-
lane's answer. Hold the lane the dispatch names and say which
|
|
14
|
-
|
|
14
|
+
lane's answer. Hold the lane the dispatch names and say which, under the lens
|
|
15
|
+
.agents/orchestration.md § Roles gives that lane.
|
|
15
16
|
|
|
16
17
|
For a consultation, follow .agents/orchestration.md § Sessions and consultation.
|
|
17
18
|
For a design, propose one design. Name each real alternative that a constraint favors and why the design
|
|
@@ -1,21 +1,18 @@
|
|
|
1
1
|
name = "reviewer"
|
|
2
|
-
description = "Read-only GPT-6 Astra review against numbered claims: design fit by default and correctness when assigned. Never edits or accepts."
|
|
2
|
+
description = "Read-only GPT-6 Astra review by default, on another engine when the dispatch names one, against numbered claims: design fit by default and correctness when assigned. Never edits or accepts."
|
|
3
3
|
model = "gpt-6-astra"
|
|
4
4
|
model_reasoning_effort = "high"
|
|
5
5
|
sandbox_mode = "read-only"
|
|
6
6
|
developer_instructions = """
|
|
7
|
-
Review one dispatched unit on GPT-6 Astra by trying to falsify its claims. Use read-only inspection
|
|
7
|
+
Review one dispatched unit on GPT-6 Astra by default, or on the engine the dispatch names, by trying to falsify its claims. Use read-only inspection
|
|
8
8
|
commands. Never edit, run a mutating command, or spawn. Use a clean context; never review work you wrote.
|
|
9
9
|
|
|
10
10
|
Read the claims file, the actual diff and git status --porcelain the dispatch supplies,
|
|
11
11
|
AGENTS.md, the rules whose paths match the changed files, the guide, and enough surrounding
|
|
12
12
|
source to judge. The diff and git status are required only for a code subject; return a deviation if that diff is missing.
|
|
13
13
|
|
|
14
|
-
Hold the lane the dispatch names and say which
|
|
15
|
-
|
|
16
|
-
its place, the guide matches the code. Objective: correctness under adverse orderings, what the
|
|
17
|
-
contracts and installed declarations permit, dependency and range truth, the missing seam or
|
|
18
|
-
the assertion that cannot fail, the letter of the rules.
|
|
14
|
+
Hold the lane the dispatch names and say which, under the lens .agents/orchestration.md § Roles
|
|
15
|
+
gives that lane.
|
|
19
16
|
|
|
20
17
|
Try to falsify each claim with a concrete input, state, or interleaving. Before confirming a
|
|
21
18
|
proof, name the mutation that would make it fail and whether its assertions distinguish it. Rule a
|
|
@@ -20,8 +20,8 @@ only after a changed condition or an explicit investigation request.
|
|
|
20
20
|
Never run a source-mutating gate (lint, format, or any --fix), or a build without the declarations
|
|
21
21
|
and holds .agents/orchestration.md § Permission floor requires. Never run git checkout, restore,
|
|
22
22
|
stash, reset, or clean; read a dirty tree as the expected state. Never install, commit, push,
|
|
23
|
-
publish, delete beyond what § Permission floor permits, or read a secret
|
|
24
|
-
|
|
23
|
+
publish, delete beyond what § Permission floor permits, or read a secret § Permission floor names,
|
|
24
|
+
whatever the dispatch says.
|
|
25
25
|
|
|
26
26
|
Return per gate: command, PASS or FAIL with exit code, excerpt and owning file on FAIL; overall
|
|
27
27
|
GREEN only when every gate passed; anomalies in one line each.
|
|
@@ -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
|
|
|
@@ -63,8 +63,6 @@ subclasses regardless of their `name`, and rejects transparent proxies and unbra
|
|
|
63
63
|
|
|
64
64
|
The style engine — text style as data, rendered by a swappable renderer (ANSI default; a browser `%c` renderer at the same seam).
|
|
65
65
|
|
|
66
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
67
|
-
|
|
68
66
|
| Name | Kind | Signature | Summary |
|
|
69
67
|
| ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
70
68
|
| `Color` | type | `'black' \| 'red' \| 'green' \| 'yellow' \| 'blue' \| 'magenta' \| 'cyan' \| 'white' \| 'brightBlack' \| 'brightRed' \| 'brightGreen' \| 'brightYellow' \| 'brightBlue' \| 'brightMagenta' \| 'brightCyan' \| 'brightWhite' \| 'default'` | Names a terminal color — the 8 standard base colors, their 8 bright variants, and `default` (the target's own default ink, emitting no color code). |
|
|
@@ -88,8 +86,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
88
86
|
|
|
89
87
|
Structured logging — the immutable `LogRecord` + the `entry` event are the transport seam; `Sink` is the one output primitive.
|
|
90
88
|
|
|
91
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
92
|
-
|
|
93
89
|
| Name | Kind | Signature | Summary |
|
|
94
90
|
| ------------------------ | --------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
95
91
|
| `LogLevel` | type | `'debug' \| 'info' \| 'warn' \| 'error'` | Names the severity level of a `LogRecord` — one coherent, ascending scale, `debug` < `info` < `warn` < `error`, that a `LoggerInterface` gates by threshold. |
|
|
@@ -111,16 +107,14 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
111
107
|
|
|
112
108
|
Narrative reporting — pure width-aware layout renderers + a lean `Reporter` front-end, over the same styler and sink substrate.
|
|
113
109
|
|
|
114
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
115
|
-
|
|
116
110
|
| Name | Kind | Signature | Summary |
|
|
117
111
|
| -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
118
|
-
| `Alignment` | type | `'left' \| 'center' \| 'right'` | Names the horizontal text alignment within a fixed-width cell — `left` / `center` / `right`, the conventional set a `
|
|
112
|
+
| `Alignment` | type | `'left' \| 'center' \| 'right'` | Names the horizontal text alignment within a fixed-width cell — `left` / `center` / `right`, the conventional set a `TableColumn` (and the box / separator title) aligns by. |
|
|
119
113
|
| `BorderStyle` | type | `'single' \| 'double' \| 'round' \| 'heavy'` | Names a box-drawing border style — `single` / `double` / `round` / `heavy`, the standard Unicode line weights the renderers frame with, each selecting a full junction set in `BORDER_CHARS`. |
|
|
120
114
|
| `BorderChars` | interface | `{ horizontal, vertical, topLeft, topRight, bottomLeft, bottomRight, cross, teeDown, teeUp, teeRight, teeLeft }` | Represents one complete box-drawing junction set for a `BorderStyle` — the edges, the corners, and the `T` / cross junctions the box and table renderers need to frame content and rule a table. |
|
|
121
115
|
| `SeparatorOptions` | interface | `{ title?, width?, fill?, styler?, style? }` | Configures `renderSeparator` — a horizontal rule, optionally carrying a centered title. Every key is optional. |
|
|
122
116
|
| `BoxOptions` | interface | `{ content, title?, padding?, border?, width?, styler?, style? }` | Configures `renderBox` — content framed in box-drawing characters. A `Reporter` supplies its own chrome style only when the caller gives neither `styler` nor `style`. |
|
|
123
|
-
| `
|
|
117
|
+
| `TableColumn` | interface | `{ label, align? }` | Represents one column of a `TableOptions` — its header label and how its cells align. |
|
|
124
118
|
| `TableOptions` | interface | `{ columns, rows, border?, styler?, style? }` | Configures `renderTable` — a bordered grid of columns + rows with per-column alignment and width-aware sizing. A `Reporter` supplies its own chrome style only when the caller gives neither `styler` nor `style`. |
|
|
125
119
|
| `TreeNode` | interface | `{ label, children? }` | Represents one node of a `TreeOptions` tree — a label plus optional children, recursively. |
|
|
126
120
|
| `TreeOptions` | interface | `{ root, border?, styler?, style? }` | Configures `renderTree` — a nested `TreeNode` tree drawn with box-drawing connectors. A `Reporter` supplies its own chrome style only when the caller gives neither `styler` nor `style`. |
|
|
@@ -150,8 +144,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
150
144
|
|
|
151
145
|
Console interception — take control of `console.*` on the read side; a buffered, mirroring, forwarding interceptor with a lifecycle.
|
|
152
146
|
|
|
153
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
154
|
-
|
|
155
147
|
| Name | Kind | Signature | Summary |
|
|
156
148
|
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
157
149
|
| `CaptureLevel` | type | `'log' \| 'info' \| 'warn' \| 'error' \| 'debug'` | Identifies one intercepted `console` method — `log` / `info` / `warn` / `error` / `debug`, the names a `CaptureInterface` patches and reports under. |
|
|
@@ -170,8 +162,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
170
162
|
|
|
171
163
|
The one error type the console layer throws — an internal invariant or unreachable-guard violation.
|
|
172
164
|
|
|
173
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
174
|
-
|
|
175
165
|
| Name | Kind | Signature | Summary |
|
|
176
166
|
| ------------------ | -------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
177
167
|
| `ConsoleErrorCode` | type | `'INVARIANT'` | Names the machine-readable error code a `ConsoleError` carries — `INVARIANT`, the only code the package throws. |
|
|
@@ -182,8 +172,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
182
172
|
|
|
183
173
|
Live activity animations — pure frame producers over the same styler and sink substrate; the line overwrite is the sink's job.
|
|
184
174
|
|
|
185
|
-
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 `\|`. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
186
|
-
|
|
187
175
|
| Name | Kind | Signature | Summary |
|
|
188
176
|
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
189
177
|
| `BarOptions` | interface | `{ current, total, width?, fill?, empty?, styler?, style? }` | Configures the pure `renderBar` renderer — a determinate progress bar string (`█████░░░░░ 50% (5/10)`), width-aware and styler-optional. |
|
|
@@ -201,8 +189,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
201
189
|
|
|
202
190
|
The SGR code data the ANSI renderer maps through, and the styler's color / attribute axes (`src/core`). All `Object.freeze`d data; the SGR numbers are the fixed ECMA-48 spec.
|
|
203
191
|
|
|
204
|
-
A `Shape` cell holds the constant's declared type.
|
|
205
|
-
|
|
206
192
|
| Name | Kind | Signature | Summary |
|
|
207
193
|
| ------------------ | ----- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
208
194
|
| `FOREGROUND_CODES` | const | `Readonly<Record<Exclude<Color, 'default'>, number>>` | Maps each `Color` to its SGR foreground parameter — the 8 base colors at 30–37 and their bright variants at 90–97. `default` is intentionally absent (it emits no code). |
|
|
@@ -224,8 +210,6 @@ A `Shape` cell holds the constant's declared type.
|
|
|
224
210
|
|
|
225
211
|
The level order + label colors, the box-drawing junction sets, status icons / colors, and default widths / glyphs (`src/core`). All `Object.freeze`d data; the box-drawing + braille glyphs are fixed Unicode. There is no separate tree-connector table: a tree derives its branch / corner / guide runs from the same `BORDER_CHARS` set a box or a table draws with, so a box, a table, and a tree all answer to one `border`.
|
|
226
212
|
|
|
227
|
-
A `Shape` cell holds the constant's declared type.
|
|
228
|
-
|
|
229
213
|
| Name | Kind | Signature | Summary |
|
|
230
214
|
| --------------------- | ----- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
231
215
|
| `LEVEL_SEVERITY` | const | `Readonly<Record<LogLevel, number>>` | Maps each `LogLevel` to its numeric severity — the ascending order the level gate compares through (`debug` 0 < `info` 1 < `warn` 2 < `error` 3). A record is kept when its level's severity is at or above the logger's threshold. The source of truth for level ordering. |
|
|
@@ -240,7 +224,7 @@ A `Shape` cell holds the constant's declared type.
|
|
|
240
224
|
| `DEFAULT_WIDTH` | const | `80` | Sets the default visible column width for the width-aware renderers — the separator rule and a `renderBox` with no explicit `width`, and the reporter's `section` rule. A sane terminal default (80 columns); a caller overrides it per-call or through `ReporterOptions.width`. |
|
|
241
225
|
| `DEFAULT_PADDING` | const | `1` | Sets the default horizontal padding inside a box's edges (`renderBox`) — one cell. |
|
|
242
226
|
| `DEFAULT_BORDER` | const | `BorderStyle` | Sets the default `BorderStyle` the box / table renderers frame with when none is given — `single`. |
|
|
243
|
-
| `DEFAULT_ALIGN` | const | `Alignment` | Sets the default cell `Alignment` a `
|
|
227
|
+
| `DEFAULT_ALIGN` | const | `Alignment` | Sets the default cell `Alignment` a `TableColumn` uses when none is given — `left`. |
|
|
244
228
|
| `SEPARATOR_FILL` | const | `"\u2500"` | Holds the default fill character `renderSeparator` draws its rule with — `─`. |
|
|
245
229
|
| `SEPARATOR_TITLE_GAP` | const | `" "` | Holds the single padding cell on each side of a separator's embedded title (`title`) — keeps the title from butting against the rule. One space. |
|
|
246
230
|
| `SECOND_MS` | const | `1000` | Sets the millisecond threshold at or above which `formatDuration` (and so `Reporter.timing`) switches from a `…ms` rendering to a `…s` (seconds, 2 d.p.) rendering — `1000`, exactly one second. |
|
|
@@ -249,8 +233,6 @@ A `Shape` cell holds the constant's declared type.
|
|
|
249
233
|
|
|
250
234
|
The intercepted-method set, the bounded-buffer cap, the level projection, and the spinner frames / bar glyphs / track width (`src/core`). All `Object.freeze`d data.
|
|
251
235
|
|
|
252
|
-
A `Shape` cell holds the constant's declared type.
|
|
253
|
-
|
|
254
236
|
| Name | Kind | Signature | Summary |
|
|
255
237
|
| -------------------------- | ----- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
256
238
|
| `CAPTURE_LEVELS` | const | `readonly CaptureLevel[]` | Lists every `CaptureLevel`, frozen — the `console.*` methods a `CaptureInterface` intercepts by default (and the source of truth for the capture-level axis; drives exhaustive tests). The universal console methods: `log`, `info`, `warn`, `error`, `debug`. |
|
|
@@ -266,8 +248,6 @@ A `Shape` cell holds the constant's declared type.
|
|
|
266
248
|
|
|
267
249
|
The browser `%c` console sink — translates the core's ANSI output into a `console.log('%c…', css)` call at the output boundary ([`src/browser`](../src/browser), surfaced through `@src/browser`). The core owns the `SinkInterface` contract + the style data model; this module owns only the browser-side translation.
|
|
268
250
|
|
|
269
|
-
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 `\|`. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to.
|
|
270
|
-
|
|
271
251
|
| Name | Kind | Signature | Summary |
|
|
272
252
|
| -------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
273
253
|
| `BrowserPalette` | interface | `{ color?, attribute? }` | Holds partial browser CSS overrides for the core color and attribute axes — a named `color` or `attribute` entry replaces only that entry, and every omission keeps its default. |
|
|
@@ -283,8 +263,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
283
263
|
|
|
284
264
|
The SGR → CSS translation data the browser sink maps ANSI runs through (`src/browser`). The number↔name mapping is derived from core's code maps, never re-hardcoded; the browser module reads core's `RESET_CODE` directly (no local re-export).
|
|
285
265
|
|
|
286
|
-
A `Shape` cell holds the constant's declared type.
|
|
287
|
-
|
|
288
266
|
| Name | Kind | Signature | Summary |
|
|
289
267
|
| --------------- | ----- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
290
268
|
| `COLOR_HEX` | const | `Readonly<Record<Exclude<Color, 'default'>, string>>` | Maps each named `Color` to its hex value — the 16 standard terminal colors a browser DevTools console renders the same `Color` names as. The source of truth for the browser color axis: the ANSI renderer maps a `Color` name to an SGR number, and this maps the same name to the CSS color the `%c` sink paints with, so a browser shows the same 16 colors a terminal does. |
|
|
@@ -296,8 +274,6 @@ A `Shape` cell holds the constant's declared type.
|
|
|
296
274
|
|
|
297
275
|
The server output backend — a TTY-aware `Sink` over the real `process` streams with a raw process-stream capture ([`src/server`](../src/server), surfaced through `@src/server`). The core owns the `SinkInterface` / `LogLevel` contracts + the `console` `Capture`; this module owns the server-only stream backend. Color detection lives here and only here: `inferStyled` reads the environment, `createServerSink` fixes each target's `styled` fact at construction, and nothing in core or the browser probes for color (the color-detection contract).
|
|
298
276
|
|
|
299
|
-
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 `\|`. An extended interface's name comes before `plus`, with the members it adds after. A function row's `Shape` cell holds its signature, and a guard row's the type it narrows to. A class row's `Shape` cell holds the interface it implements, or its constructor signature where it implements none.
|
|
300
|
-
|
|
301
277
|
| Name | Kind | Signature | Summary |
|
|
302
278
|
| ------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
303
279
|
| `StreamTargetInterface` | interface | `{ write(), isTTY?, columns? }` | Declares the minimal writable-stream shape the server sink and process capture address — exactly the slice of a Node `tty.WriteStream` / `process.stdout` they touch and no more. |
|
|
@@ -322,8 +298,6 @@ A `Shape` cell holds an interface's data members as bare names in braces, `?` ma
|
|
|
322
298
|
|
|
323
299
|
The default stream set, buffer cap, no-TTY column fallback, and the stream → log-level projection (`src/server`). All `Object.freeze`d data.
|
|
324
300
|
|
|
325
|
-
A `Shape` cell holds the constant's declared type.
|
|
326
|
-
|
|
327
301
|
| Name | Kind | Signature | Summary |
|
|
328
302
|
| ---------------------- | ----- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
329
303
|
| `STREAM_LEVELS` | const | `readonly StreamLevel[]` | Lists the process streams a `ProcessCaptureInterface` can intercept, in `stdout`-then-`stderr` order — the `StreamLevel` universe and the default configured set. |
|
|
@@ -335,7 +309,7 @@ A `Shape` cell holds the constant's declared type.
|
|
|
335
309
|
|
|
336
310
|
The public methods of each behavioral interface — one table per type, keyed by its backticked name, every call-signature member listed. Each type's `readonly` data members, for example `emitter` / `active` / `message` / `level` / `name` / `current` / `total` / `succeeded` / `columns`, stay in the preceding Surface rows and are not repeated here. Each implementing class implements its interface exactly, so this doubles as the per-instance method surface.
|
|
337
311
|
|
|
338
|
-
**Data-only / callable surfaces (no `## Methods` subsection).** `ServerSinkInterface` adds `styled` and `columns` data members to `SinkInterface` (its `write` is the inherited contract in the following `SinkInterface` table). Every `*Options` / `*EventMap` / `LogRecord` / `Style` / `Theme` / `ThemeStatus` / `BorderChars` / `
|
|
312
|
+
**Data-only / callable surfaces (no `## Methods` subsection).** `ServerSinkInterface` adds `styled` and `columns` data members to `SinkInterface` (its `write` is the inherited contract in the following `SinkInterface` table). Every `*Options` / `*EventMap` / `LogRecord` / `Style` / `Theme` / `ThemeStatus` / `BorderChars` / `TableColumn` / `TreeNode` / `StepPosition` / `ProgressReport` / `WriterSet` / `CapturedMessage` / `CapturedChunk` / `CaptureResult` / `BrowserPalette` / `ConsoleOutput` / `StyleAccumulator` / `StreamTargetInterface` row is a data / options shape with no behavioral methods.
|
|
339
313
|
|
|
340
314
|
#### `RendererInterface`
|
|
341
315
|
|