@orkestrel/scaffold 0.0.114 → 0.0.116

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.
Files changed (108) hide show
  1. package/dist/bin/main.js +137 -15
  2. package/dist/bin/main.js.map +1 -1
  3. package/dist/host/agents/orchestration.md +5 -3
  4. package/dist/host/agents/platforms/windows.md +1 -0
  5. package/dist/host/agents/skills/orkestrel-align/references/integration.md +1 -1
  6. package/dist/host/agents/skills/orkestrel-debrief/SKILL.md +4 -4
  7. package/dist/host/agents/skills/orkestrel-dispatch/SKILL.md +4 -1
  8. package/dist/host/agents/skills/orkestrel-falsify/SKILL.md +8 -2
  9. package/dist/host/agents/skills/orkestrel-harden/references/equivalence.md +1 -0
  10. package/dist/host/agents/skills/orkestrel-harden/references/hardening.md +1 -1
  11. package/dist/host/agents/skills/orkestrel-parallel/SKILL.md +1 -1
  12. package/dist/host/agents/skills/orkestrel-parallel/references/codex.md +1 -0
  13. package/dist/host/agents/skills/orkestrel-publish/references/wave.md +9 -3
  14. package/dist/host/claude/agents/analyst.md +1 -1
  15. package/dist/host/claude/agents/astra.md +2 -2
  16. package/dist/host/claude/agents/builder.md +4 -4
  17. package/dist/host/claude/agents/opus.md +3 -3
  18. package/dist/host/claude/agents/orkestrel.md +5 -7
  19. package/dist/host/claude/agents/planner.md +8 -2
  20. package/dist/host/claude/rules/campaign.md +2 -1
  21. package/dist/host/claude/rules/documentation.md +1 -0
  22. package/dist/host/claude/rules/names.md +3 -1
  23. package/dist/host/claude/rules/tests.md +7 -4
  24. package/dist/host/claude/rules/writing.md +1 -0
  25. package/dist/host/claude/skills/enterprise-bootstrap/SKILL.md +1 -2
  26. package/dist/host/claude/skills/orkestrel-align/SKILL.md +1 -1
  27. package/dist/host/claude/skills/orkestrel-build/SKILL.md +1 -2
  28. package/dist/host/claude/skills/orkestrel-debrief/SKILL.md +1 -2
  29. package/dist/host/claude/skills/orkestrel-dispatch/SKILL.md +1 -1
  30. package/dist/host/claude/skills/orkestrel-falsify/SKILL.md +1 -1
  31. package/dist/host/claude/skills/orkestrel-harden/SKILL.md +1 -1
  32. package/dist/host/claude/skills/orkestrel-journey/SKILL.md +1 -1
  33. package/dist/host/claude/skills/orkestrel-parallel/SKILL.md +1 -1
  34. package/dist/host/claude/skills/orkestrel-polish/SKILL.md +1 -2
  35. package/dist/host/claude/skills/orkestrel-publish/SKILL.md +1 -2
  36. package/dist/host/claude/skills/orkestrel-scout/SKILL.md +1 -1
  37. package/dist/host/codex/agents/analyst.toml +8 -5
  38. package/dist/host/codex/agents/astra.toml +4 -5
  39. package/dist/host/codex/agents/builder.toml +5 -5
  40. package/dist/host/codex/agents/opus.toml +3 -4
  41. package/dist/host/codex/agents/orkestrel.toml +2 -1
  42. package/dist/host/codex/agents/planner.toml +8 -5
  43. package/dist/host/codex/agents/reviewer.toml +5 -4
  44. package/dist/host/guides/abort.md +17 -17
  45. package/dist/host/guides/agent.md +445 -445
  46. package/dist/host/guides/brief.md +143 -143
  47. package/dist/host/guides/browser.md +731 -731
  48. package/dist/host/guides/budget.md +39 -39
  49. package/dist/host/guides/capture.md +298 -298
  50. package/dist/host/guides/console.md +109 -109
  51. package/dist/host/guides/contract.md +335 -335
  52. package/dist/host/guides/csv.md +30 -30
  53. package/dist/host/guides/database.md +163 -163
  54. package/dist/host/guides/emitter.md +17 -17
  55. package/dist/host/guides/form.md +99 -99
  56. package/dist/host/guides/guide.md +361 -183
  57. package/dist/host/guides/html.md +49 -49
  58. package/dist/host/guides/indexeddb.md +40 -40
  59. package/dist/host/guides/interpret.md +139 -139
  60. package/dist/host/guides/lsp.md +114 -114
  61. package/dist/host/guides/markdown.md +68 -68
  62. package/dist/host/guides/mcp.md +3745 -3745
  63. package/dist/host/guides/middleware.md +170 -170
  64. package/dist/host/guides/msg.md +95 -95
  65. package/dist/host/guides/ndjson.md +8 -8
  66. package/dist/host/guides/ollama.md +56 -56
  67. package/dist/host/guides/pool.md +21 -21
  68. package/dist/host/guides/probe.md +82 -82
  69. package/dist/host/guides/process.md +99 -99
  70. package/dist/host/guides/program.md +98 -96
  71. package/dist/host/guides/qualifier.md +70 -70
  72. package/dist/host/guides/queue.md +37 -37
  73. package/dist/host/guides/rater.md +38 -38
  74. package/dist/host/guides/reason.md +308 -308
  75. package/dist/host/guides/relation.md +50 -50
  76. package/dist/host/guides/router.md +58 -58
  77. package/dist/host/guides/scaffold.md +554 -419
  78. package/dist/host/guides/sea.md +128 -128
  79. package/dist/host/guides/server.md +100 -100
  80. package/dist/host/guides/sqlite.md +28 -28
  81. package/dist/host/guides/sse.md +20 -20
  82. package/dist/host/guides/study.md +444 -444
  83. package/dist/host/guides/table.md +82 -82
  84. package/dist/host/guides/template.md +41 -41
  85. package/dist/host/guides/terminal.md +121 -121
  86. package/dist/host/guides/test.md +273 -273
  87. package/dist/host/guides/timeout.md +18 -18
  88. package/dist/host/guides/tool.md +27 -27
  89. package/dist/host/guides/toolbox.md +166 -166
  90. package/dist/host/guides/websocket.md +54 -54
  91. package/dist/host/guides/worker.md +24 -24
  92. package/dist/host/guides/workflow.md +187 -187
  93. package/dist/host/guides/workspace.md +55 -55
  94. package/dist/host/manifest.json +93 -93
  95. package/dist/host/tests/setupPolicy.ts +5 -3
  96. package/dist/src/core/index.cjs +89 -3
  97. package/dist/src/core/index.cjs.map +1 -1
  98. package/dist/src/core/index.d.cts +229 -144
  99. package/dist/src/core/index.d.ts +229 -144
  100. package/dist/src/core/index.js +87 -4
  101. package/dist/src/core/index.js.map +1 -1
  102. package/dist/src/server/index.cjs +292 -66
  103. package/dist/src/server/index.cjs.map +1 -1
  104. package/dist/src/server/index.d.cts +188 -6
  105. package/dist/src/server/index.d.ts +188 -6
  106. package/dist/src/server/index.js +287 -69
  107. package/dist/src/server/index.js.map +1 -1
  108. package/package.json +4 -3
@@ -93,42 +93,42 @@ pipeline at all.
93
93
 
94
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
95
 
96
- | Type | Kind | Shape | Summary |
97
- | ------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
98
- | `TaskOperation` | type | `'create' \| 'refactor' \| 'debug' \| 'extract' \| 'migrate' \| 'explain' \| 'review' \| 'optimize' \| 'audit' \| 'test' \| 'document' \| 'plan'` | Names the closed vocabulary of what a brief asks for. |
99
- | `TaskDomain` | type | `'code' \| 'writing' \| 'research' \| 'analysis' \| 'design' \| 'data' \| 'ops' \| 'other'` | Names the closed vocabulary of the subject matter a brief operates on. |
100
- | `OutputFormat` | type | `'markdown' \| 'json' \| 'code' \| 'diff' \| 'prose'` | Names the closed vocabulary of deliverable shapes. |
101
- | `RiskSeverity` | type | `'low' \| 'medium' \| 'high'` | Names the closed vocabulary of risk severities. |
102
- | `BriefStage` | type | `'interpret' \| 'draft' \| 'gate' \| 'pin'` | Names the fixed compilation phases, in pipeline order. |
103
- | `BriefErrorCode` | type | `'INTERPRET_FAILED' \| 'DRAFT_FAILED' \| 'GATE_FAILED' \| 'PIN_FAILED' \| 'BLOCKED' \| 'INVALID' \| 'DESTROYED'` | Names the machine-readable reasons a `BriefError` carries. |
104
- | `Task` | interface | `{ operation, domain, statement }` | States what the brief asks for, in one imperative sentence. |
105
- | `Reference` | interface | `{ path, note }` | Represents one referenced path and why it is listed. |
106
- | `Manifest` | interface | `{ read, edit, locked, forbidden }` | Represents the disjoint file partitions of a brief. |
107
- | `Outcome` | interface | `{ rank, text, required }` | Represents one ranked outcome — a result, never a step. |
108
- | `Given` | interface | `{ category, name, value }` | Represents one context fact handed to the executor — a convention, a version, a constraint value. |
109
- | `Example` | interface | `{ input, output, note? }` | Represents one input to output exemplar — the ambiguity remover that leaves the least to interpret. |
110
- | `Citation` | interface | `{ name, url, note }` | Represents one external source — what it is called, where it lives, and why it is cited. |
111
- | `Gap` | interface | `{ field, question, blocking, candidates? }` | Represents one unknown the brief has not resolved. |
112
- | `Risk` | interface | `{ severity, text, mitigation }` | Represents one pre-empted risk and the mitigation that answers it. |
113
- | `Output` | interface | `{ format, sections?, include?, exclude? }` | Represents the closed shape of the deliverable. |
114
- | `Proof` | interface | `{ text, command }` | Represents one mechanical, transcript-provable check. |
115
- | `Brief` | interface | `{ task, authority, manifest, outcomes, rules, invariants, givens, examples, assumptions, citations, gaps, risks, output, proofs, trace?, hash? }` | Represents the closed execution contract — a rough request with every implicit decision resolved. |
116
- | `BriefInput` | interface | `{ text?, interpretation?, task?, authority?, manifest?, outcomes?, rules?, invariants?, givens?, examples?, assumptions?, citations?, gaps?, risks?, output?, proofs? }` | Represents one `compile()` input. |
117
- | `Briefing` | interface | `{ interpretation?, brief?, questions, verdict?, stages, failures, digest }` | Represents the full, replayable outcome of one `compile()` call. |
118
- | `Dispatch` | interface | `{ prompt, authority, read, edit, locked, forbidden }` | Represents the subagent projection of a brief. |
119
- | `InterpretStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `interpret` phase snapshot — raw text in, an `Interpretation` out. |
120
- | `DraftStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `draft` phase snapshot — the caller's input in, an unpinned `Brief` out. |
121
- | `GateStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `gate` phase snapshot — the readiness `Subject` in, the reasoner's verdict out. |
122
- | `PinStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `pin` phase snapshot — the drafted `Brief` in, the pinned `Brief` out. |
123
- | `BriefStageRecord` | type | `InterpretStageRecord \| DraftStageRecord \| GateStageRecord \| PinStageRecord` | Represents one pipeline phase, discriminated by `stage`. |
124
- | `BriefStageFailure` | interface | `{ stage, code, message }` | Represents a visible marker for a phase that failed. |
125
- | `BriefRecord` | interface | `{ id, brief, version, hash }` | Represents a versioned, content-hashed `Brief` inside a `BriefManagerInterface`. |
126
- | `BriefCompilerEventMap` | type | `{ compile, block, error, destroy }` | Declares the `BriefCompiler`'s push observation surface. |
127
- | `BriefCompilerOptions` | interface | `{ interpret?, reason?, actions?, domains?, on?, error? }` | Represents the input to `createBriefCompiler`. |
128
- | `BriefCompilerInterface` | interface | `{ emitter, interpret, reason } plus compile, gate, destroy` | Declares the compilation orchestrator contract. |
129
- | `BriefManagerEventMap` | type | `{ add, remove, destroy }` | Declares the `BriefManager`'s push observation surface. |
130
- | `BriefManagerOptions` | interface | `{ briefs?, on?, error? }` | Represents the input to `createBriefManager`. |
131
- | `BriefManagerInterface` | interface | `{ emitter, count } plus has, brief, briefs, add, remove, destroy` | Declares the brief registry contract. |
96
+ | Name | Kind | Signature | Summary |
97
+ | ------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
98
+ | `TaskOperation` | type | `'create' \| 'refactor' \| 'debug' \| 'extract' \| 'migrate' \| 'explain' \| 'review' \| 'optimize' \| 'audit' \| 'test' \| 'document' \| 'plan'` | Names the closed vocabulary of what a brief asks for. |
99
+ | `TaskDomain` | type | `'code' \| 'writing' \| 'research' \| 'analysis' \| 'design' \| 'data' \| 'ops' \| 'other'` | Names the closed vocabulary of the subject matter a brief operates on. |
100
+ | `OutputFormat` | type | `'markdown' \| 'json' \| 'code' \| 'diff' \| 'prose'` | Names the closed vocabulary of deliverable shapes. |
101
+ | `RiskSeverity` | type | `'low' \| 'medium' \| 'high'` | Names the closed vocabulary of risk severities. |
102
+ | `BriefStage` | type | `'interpret' \| 'draft' \| 'gate' \| 'pin'` | Names the fixed compilation phases, in pipeline order. |
103
+ | `BriefErrorCode` | type | `'INTERPRET_FAILED' \| 'DRAFT_FAILED' \| 'GATE_FAILED' \| 'PIN_FAILED' \| 'BLOCKED' \| 'INVALID' \| 'DESTROYED'` | Names the machine-readable reasons a `BriefError` carries. |
104
+ | `Task` | interface | `{ operation, domain, statement }` | States what the brief asks for, in one imperative sentence. |
105
+ | `Reference` | interface | `{ path, note }` | Represents one referenced path and why it is listed. |
106
+ | `Manifest` | interface | `{ read, edit, locked, forbidden }` | Represents the disjoint file partitions of a brief. |
107
+ | `Outcome` | interface | `{ rank, text, required }` | Represents one ranked outcome — a result, never a step. |
108
+ | `Given` | interface | `{ category, name, value }` | Represents one context fact handed to the executor — a convention, a version, a constraint value. |
109
+ | `Example` | interface | `{ input, output, note? }` | Represents one input to output exemplar — the ambiguity remover that leaves the least to interpret. |
110
+ | `Citation` | interface | `{ name, url, note }` | Represents one external source — what it is called, where it lives, and why it is cited. |
111
+ | `Gap` | interface | `{ field, question, blocking, candidates? }` | Represents one unknown the brief has not resolved. |
112
+ | `Risk` | interface | `{ severity, text, mitigation }` | Represents one pre-empted risk and the mitigation that answers it. |
113
+ | `Output` | interface | `{ format, sections?, include?, exclude? }` | Represents the closed shape of the deliverable. |
114
+ | `Proof` | interface | `{ text, command }` | Represents one mechanical, transcript-provable check. |
115
+ | `Brief` | interface | `{ task, authority, manifest, outcomes, rules, invariants, givens, examples, assumptions, citations, gaps, risks, output, proofs, trace?, hash? }` | Represents the closed execution contract — a rough request with every implicit decision resolved. |
116
+ | `BriefInput` | interface | `{ text?, interpretation?, task?, authority?, manifest?, outcomes?, rules?, invariants?, givens?, examples?, assumptions?, citations?, gaps?, risks?, output?, proofs? }` | Represents one `compile()` input. |
117
+ | `Briefing` | interface | `{ interpretation?, brief?, questions, verdict?, stages, failures, digest }` | Represents the full, replayable outcome of one `compile()` call. |
118
+ | `Dispatch` | interface | `{ prompt, authority, read, edit, locked, forbidden }` | Represents the subagent projection of a brief. |
119
+ | `InterpretStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `interpret` phase snapshot — raw text in, an `Interpretation` out. |
120
+ | `DraftStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `draft` phase snapshot — the caller's input in, an unpinned `Brief` out. |
121
+ | `GateStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `gate` phase snapshot — the readiness `Subject` in, the reasoner's verdict out. |
122
+ | `PinStageRecord` | interface | `{ stage, input, output?, error? }` | Records the `pin` phase snapshot — the drafted `Brief` in, the pinned `Brief` out. |
123
+ | `BriefStageRecord` | type | `InterpretStageRecord \| DraftStageRecord \| GateStageRecord \| PinStageRecord` | Represents one pipeline phase, discriminated by `stage`. |
124
+ | `BriefStageFailure` | interface | `{ stage, code, message }` | Represents a visible marker for a phase that failed. |
125
+ | `BriefRecord` | interface | `{ id, brief, version, hash }` | Represents a versioned, content-hashed `Brief` inside a `BriefManagerInterface`. |
126
+ | `BriefCompilerEventMap` | type | `{ readonly compile: readonly [briefing: Briefing]; readonly block: readonly [questions: readonly Gap[]]; readonly error: readonly [error: unknown]; readonly destroy: readonly []; }` | Declares the `BriefCompiler`'s push observation surface. |
127
+ | `BriefCompilerOptions` | interface | `{ interpret?, reason?, actions?, domains?, on?, error? }` | Represents the input to `createBriefCompiler`. |
128
+ | `BriefCompilerInterface` | interface | `{ emitter, interpret, reason, compile(), gate(), destroy() }` | Declares the compilation orchestrator contract. |
129
+ | `BriefManagerEventMap` | type | `{ readonly add: readonly [id: string]; readonly remove: readonly [id: string]; readonly destroy: readonly []; }` | Declares the `BriefManager`'s push observation surface. |
130
+ | `BriefManagerOptions` | interface | `{ briefs?, on?, error? }` | Represents the input to `createBriefManager`. |
131
+ | `BriefManagerInterface` | interface | `{ emitter, count, has(), brief(), briefs(), add(), remove(), destroy() }` | Declares the brief registry contract. |
132
132
 
133
133
  The `Briefing` deliberately carries cross-package payloads by their originating types:
134
134
  `interpretation` is an `@orkestrel/interpret` `Interpretation`, `verdict` is an
@@ -141,18 +141,18 @@ check, met or missed, narrated by the reasoner.
141
141
 
142
142
  A `Shape` cell holds the constant's declared type.
143
143
 
144
- | API | Kind | Shape | Summary |
145
- | ------------------------ | ----- | ----------------------------------- | ------------------------------------------------------------------------------- |
146
- | `TASK_OPERATIONS` | const | `readonly TaskOperation[]` | Lists the `TaskOperation` values, frozen. |
147
- | `TASK_DOMAINS` | const | `readonly TaskDomain[]` | Lists the `TaskDomain` values, frozen. |
148
- | `OUTPUT_FORMATS` | const | `readonly OutputFormat[]` | Lists the `OutputFormat` values, frozen. |
149
- | `RISK_SEVERITIES` | const | `readonly RiskSeverity[]` | Lists the `RiskSeverity` values, frozen. |
150
- | `INTERPRETATION_MEMBERS` | const | `readonly (keyof Interpretation)[]` | Lists every published `Interpretation` member name, frozen. |
151
- | `DEFAULT_BRIEF_TURNS` | const | `number` | Holds `16` — the default turn cap `briefToGoal` renders. |
152
- | `GATE_ID` | const | `string` | Holds `'gate'` — the id of the `buildGateDefinition()` logical definition. |
153
- | `LINE_BREAK_PATTERN` | const | `RegExp` | Matches every line terminator a brief field refuses. |
154
- | `SINGLE_LINE_PATTERN` | const | `RegExp` | Holds the positive form of `LINE_BREAK_PATTERN`, for a `stringShape` `pattern`. |
155
- | `BLANK_PATTERN` | const | `RegExp` | Matches a string of one or more spaces and nothing else. |
144
+ | Name | Kind | Signature | Summary |
145
+ | ------------------------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
146
+ | `TASK_OPERATIONS` | const | `readonly TaskOperation[]` | Lists the `TaskOperation` values, frozen. |
147
+ | `TASK_DOMAINS` | const | `readonly TaskDomain[]` | Lists the `TaskDomain` values, frozen. |
148
+ | `OUTPUT_FORMATS` | const | `readonly OutputFormat[]` | Lists the `OutputFormat` values, frozen. |
149
+ | `RISK_SEVERITIES` | const | `readonly RiskSeverity[]` | Lists the `RiskSeverity` values, frozen. |
150
+ | `INTERPRETATION_MEMBERS` | const | `readonly ("ambiguities" \| "confidence" \| "definition" \| "digest" \| "entities" \| "failures" \| "intent" \| "mappings" \| "normalized" \| "prompt" \| "stages" \| "subject" \| "text")[]` | Lists every published `Interpretation` member name, frozen. |
151
+ | `DEFAULT_BRIEF_TURNS` | const | `16` | Holds `16` — the default turn cap `briefToGoal` renders. |
152
+ | `GATE_ID` | const | `"gate"` | Holds `'gate'` — the id of the `buildGateDefinition()` logical definition. |
153
+ | `LINE_BREAK_PATTERN` | const | `RegExp` | Matches every line terminator a brief field refuses. |
154
+ | `SINGLE_LINE_PATTERN` | const | `RegExp` | Holds the positive form of `LINE_BREAK_PATTERN`, for a `stringShape` `pattern`. |
155
+ | `BLANK_PATTERN` | const | `RegExp` | Matches a string of one or more spaces and nothing else. |
156
156
 
157
157
  An interpretation the compiler reads is foreign data, and a class instance carries its contract
158
158
  on the prototype, so `BriefCompiler` materializes the members `INTERPRETATION_MEMBERS` names into
@@ -187,10 +187,10 @@ drift between the guard and the schema.
187
187
 
188
188
  ### Errors
189
189
 
190
- | API | Kind | Summary |
191
- | -------------- | -------- | --------------------------------------------------- |
192
- | `BriefError` | class | Represents the one error class this package throws. |
193
- | `isBriefError` | function | Narrows a caught value to a `BriefError`. |
190
+ | Name | Kind | Signature | Summary |
191
+ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
192
+ | `BriefError` | class | `new (code: BriefErrorCode, message: string, context?: Readonly<Record<string, unknown>>) => BriefError` | Represents the one error class this package throws. |
193
+ | `isBriefError` | function | `(value: unknown) => value is BriefError` | Narrows a caught value to a `BriefError`. |
194
194
 
195
195
  `BriefError` extends `Error` with a readonly `code` on the `BriefErrorCode` vocabulary and an
196
196
  optional readonly `context` record.
@@ -238,26 +238,26 @@ either door records `INTERPRET_FAILED` instead of throwing out of `compile`.
238
238
 
239
239
  In a guard table a `Shape` cell holds the type the guard narrows to.
240
240
 
241
- | API | Kind | Shape | Summary |
242
- | ----------------- | ----- | --------------- | ------------------------------------------------------------------------------------------------ |
243
- | `isText` | const | `string` | Checks whether the value is a string holding no line terminator, empty included. |
244
- | `isLine` | const | `string` | Checks whether the value is a non-empty string holding no line terminator. |
245
- | `isTaskOperation` | const | `TaskOperation` | Checks whether the value is one of the `TaskOperation` literals. |
246
- | `isTaskDomain` | const | `TaskDomain` | Checks whether the value is one of the `TaskDomain` literals. |
247
- | `isOutputFormat` | const | `OutputFormat` | Checks whether the value is one of the `OutputFormat` literals. |
248
- | `isRiskSeverity` | const | `RiskSeverity` | Checks whether the value is one of the `RiskSeverity` literals. |
249
- | `isTask` | const | `Task` | Checks whether the value is a well-formed `Task` — both vocabularies closed, statement one line. |
250
- | `isReference` | const | `Reference` | Checks whether the value is a well-formed `Reference` — both members required, both single-line. |
251
- | `isManifest` | const | `Manifest` | Checks whether the value is a well-formed `Manifest`. |
252
- | `isOutcome` | const | `Outcome` | Checks whether the value is a well-formed `Outcome` — `rank` a positive integer. |
253
- | `isGiven` | const | `Given` | Checks whether the value is a well-formed `Given` — its `value` may be empty but stays one line. |
254
- | `isExample` | const | `Example` | Checks whether the value is a well-formed `Example`. |
255
- | `isCitation` | const | `Citation` | Checks whether the value is a well-formed `Citation` — every member single-line. |
256
- | `isGap` | const | `Gap` | Checks whether the value is a well-formed `Gap`. |
257
- | `isRisk` | const | `Risk` | Checks whether the value is a well-formed `Risk` — `severity` on the closed vocabulary. |
258
- | `isOutput` | const | `Output` | Checks whether the value is a well-formed `Output` — `format` on the closed vocabulary. |
259
- | `isProof` | const | `Proof` | Checks whether the value is a well-formed `Proof`. |
260
- | `isBrief` | const | `Brief` | Checks whether the value satisfies the whole exact-record `Brief` contract. |
241
+ | Name | Kind | Signature | Summary |
242
+ | ----------------- | ----- | ---------------------- | ------------------------------------------------------------------------------------------------ |
243
+ | `isText` | const | `Guard<string>` | Checks whether the value is a string holding no line terminator, empty included. |
244
+ | `isLine` | const | `Guard<string>` | Checks whether the value is a non-empty string holding no line terminator. |
245
+ | `isTaskOperation` | const | `Guard<TaskOperation>` | Checks whether the value is one of the `TaskOperation` literals. |
246
+ | `isTaskDomain` | const | `Guard<TaskDomain>` | Checks whether the value is one of the `TaskDomain` literals. |
247
+ | `isOutputFormat` | const | `Guard<OutputFormat>` | Checks whether the value is one of the `OutputFormat` literals. |
248
+ | `isRiskSeverity` | const | `Guard<RiskSeverity>` | Checks whether the value is one of the `RiskSeverity` literals. |
249
+ | `isTask` | const | `Guard<Task>` | Checks whether the value is a well-formed `Task` — both vocabularies closed, statement one line. |
250
+ | `isReference` | const | `Guard<Reference>` | Checks whether the value is a well-formed `Reference` — both members required, both single-line. |
251
+ | `isManifest` | const | `Guard<Manifest>` | Checks whether the value is a well-formed `Manifest`. |
252
+ | `isOutcome` | const | `Guard<Outcome>` | Checks whether the value is a well-formed `Outcome` — `rank` a positive integer. |
253
+ | `isGiven` | const | `Guard<Given>` | Checks whether the value is a well-formed `Given` — its `value` may be empty but stays one line. |
254
+ | `isExample` | const | `Guard<Example>` | Checks whether the value is a well-formed `Example`. |
255
+ | `isCitation` | const | `Guard<Citation>` | Checks whether the value is a well-formed `Citation` — every member single-line. |
256
+ | `isGap` | const | `Guard<Gap>` | Checks whether the value is a well-formed `Gap`. |
257
+ | `isRisk` | const | `Guard<Risk>` | Checks whether the value is a well-formed `Risk` — `severity` on the closed vocabulary. |
258
+ | `isOutput` | const | `Guard<Output>` | Checks whether the value is a well-formed `Output` — `format` on the closed vocabulary. |
259
+ | `isProof` | const | `Guard<Proof>` | Checks whether the value is a well-formed `Proof`. |
260
+ | `isBrief` | const | `Guard<Brief>` | Checks whether the value satisfies the whole exact-record `Brief` contract. |
261
261
 
262
262
  ```ts
263
263
  import {
@@ -315,22 +315,22 @@ is exactly `Brief`.
315
315
 
316
316
  A `Shape` cell holds the constant's declared type.
317
317
 
318
- | API | Kind | Shape | Summary |
319
- | ---------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
320
- | `textShape` | const | `StringShape` | Describes a single-line string of any length, including empty — the shape mirror of `isText`. |
321
- | `lineShape` | const | `StringShape` | Describes a non-empty single-line string — the shape mirror of `isLine`. |
322
- | `taskShape` | const | `ObjectShape<{ operation, domain, statement }>` | Describes the `Task` shape — closed operation and domain vocabularies plus a non-empty statement. |
323
- | `referenceShape` | const | `ObjectShape<{ path, note }>` | Describes the `Reference` shape — a path and the note that justifies listing it. |
324
- | `manifestShape` | const | `ObjectShape<{ read, edit, locked, forbidden }>` | Describes the `Manifest` shape — disjoint reference partitions. |
325
- | `outcomeShape` | const | `ObjectShape<{ rank, text, required }>` | Describes the `Outcome` shape — a one-based rank, the result text, and whether it gates done. |
326
- | `givenShape` | const | `ObjectShape<{ category, name, value }>` | Describes the `Given` shape — one categorized context fact. |
327
- | `exampleShape` | const | `ObjectShape<{ input, output, note? }>` | Describes the `Example` shape — one input to output exemplar. |
328
- | `citationShape` | const | `ObjectShape<{ name, url, note }>` | Describes the `Citation` shape — a name, a locator, and why the source is cited. |
329
- | `gapShape` | const | `ObjectShape<{ field, question, blocking, candidates? }>` | Describes the `Gap` shape — an unknown, whether it blocks, and the candidates that would close it. |
330
- | `riskShape` | const | `ObjectShape<{ severity, text, mitigation }>` | Describes the `Risk` shape — a closed severity, the risk, and its mitigation. |
331
- | `outputShape` | const | `ObjectShape<{ format, sections?, include?, exclude? }>` | Describes the `Output` shape — a closed format plus its optional refinements. |
332
- | `proofShape` | const | `ObjectShape<{ text, command }>` | Describes the `Proof` shape — the claim and the command that settles it. |
333
- | `briefShape` | const | `ObjectShape<{ task, authority, manifest, outcomes, rules, invariants, givens, examples, assumptions, citations, gaps, risks, output, proofs, trace?, hash? }>` | Describes the whole `Brief` shape, section shapes composed. |
318
+ | Name | Kind | Signature | Summary |
319
+ | ---------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
320
+ | `textShape` | const | `StringShape` | Describes a single-line string of any length, including empty — the shape mirror of `isText`. |
321
+ | `lineShape` | const | `StringShape` | Describes a non-empty single-line string — the shape mirror of `isLine`. |
322
+ | `taskShape` | const | `import("@orkestrel/contract").ObjectShape<{ operation: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").TaskOperation[]>; domain: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").TaskDomain[]>; statement: StringShape; }, false>` | Describes the `Task` shape — closed operation and domain vocabularies plus a non-empty statement. |
323
+ | `referenceShape` | const | `import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>` | Describes the `Reference` shape — a path and the note that justifies listing it. |
324
+ | `manifestShape` | const | `import("@orkestrel/contract").ObjectShape<{ read: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; edit: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; locked: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; forbidden: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; }, false>` | Describes the `Manifest` shape — disjoint reference partitions. |
325
+ | `outcomeShape` | const | `import("@orkestrel/contract").ObjectShape<{ rank: import("@orkestrel/contract").NumberShape; text: StringShape; required: import("@orkestrel/contract").BooleanShape; }, false>` | Describes the `Outcome` shape — a one-based rank, the result text, and whether it gates done. |
326
+ | `givenShape` | const | `import("@orkestrel/contract").ObjectShape<{ category: StringShape; name: StringShape; value: StringShape; }, false>` | Describes the `Given` shape — one categorized context fact. |
327
+ | `exampleShape` | const | `import("@orkestrel/contract").ObjectShape<{ input: StringShape; output: StringShape; note: import("@orkestrel/contract").OptionalShape<StringShape>; }, false>` | Describes the `Example` shape — one input to output exemplar. |
328
+ | `citationShape` | const | `import("@orkestrel/contract").ObjectShape<{ name: StringShape; url: StringShape; note: StringShape; }, false>` | Describes the `Citation` shape — a name, a locator, and why the source is cited. |
329
+ | `gapShape` | const | `import("@orkestrel/contract").ObjectShape<{ field: StringShape; question: StringShape; blocking: import("@orkestrel/contract").BooleanShape; candidates: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; }, false>` | Describes the `Gap` shape — an unknown, whether it blocks, and the candidates that would close it. |
330
+ | `riskShape` | const | `import("@orkestrel/contract").ObjectShape<{ severity: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").RiskSeverity[]>; text: StringShape; mitigation: StringShape; }, false>` | Describes the `Risk` shape — a closed severity, the risk, and its mitigation. |
331
+ | `outputShape` | const | `import("@orkestrel/contract").ObjectShape<{ format: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").OutputFormat[]>; sections: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; include: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; exclude: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; }, false>` | Describes the `Output` shape — a closed format plus its optional refinements. |
332
+ | `proofShape` | const | `import("@orkestrel/contract").ObjectShape<{ text: StringShape; command: StringShape; }, false>` | Describes the `Proof` shape — the claim and the command that settles it. |
333
+ | `briefShape` | const | `import("@orkestrel/contract").ObjectShape<{ task: import("@orkestrel/contract").ObjectShape<{ operation: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").TaskOperation[]>; domain: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").TaskDomain[]>; statement: StringShape; }, false>; authority: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; manifest: import("@orkestrel/contract").ObjectShape<{ read: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; edit: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; locked: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; forbidden: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ path: StringShape; note: StringShape; }, false>>; }, false>; outcomes: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ rank: import("@orkestrel/contract").NumberShape; text: StringShape; required: import("@orkestrel/contract").BooleanShape; }, false>>; rules: import("@orkestrel/contract").ArrayShape<StringShape>; invariants: import("@orkestrel/contract").ArrayShape<StringShape>; givens: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ category: StringShape; name: StringShape; value: StringShape; }, false>>; examples: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ input: StringShape; output: StringShape; note: import("@orkestrel/contract").OptionalShape<StringShape>; }, false>>; assumptions: import("@orkestrel/contract").ArrayShape<StringShape>; citations: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ name: StringShape; url: StringShape; note: StringShape; }, false>>; gaps: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ field: StringShape; question: StringShape; blocking: import("@orkestrel/contract").BooleanShape; candidates: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; }, false>>; risks: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ severity: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").RiskSeverity[]>; text: StringShape; mitigation: StringShape; }, false>>; output: import("@orkestrel/contract").ObjectShape<{ format: import("@orkestrel/contract").LiteralShape<readonly import("./types.js").OutputFormat[]>; sections: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; include: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; exclude: import("@orkestrel/contract").OptionalShape<import("@orkestrel/contract").ArrayShape<StringShape>>; }, false>; proofs: import("@orkestrel/contract").ArrayShape<import("@orkestrel/contract").ObjectShape<{ text: StringShape; command: StringShape; }, false>>; trace: import("@orkestrel/contract").OptionalShape<StringShape>; hash: import("@orkestrel/contract").OptionalShape<StringShape>; }, false>` | Describes the whole `Brief` shape, section shapes composed. |
334
334
 
335
335
  ```ts
336
336
  import {
@@ -382,21 +382,21 @@ at the boundaries the data actually crosses: `parseBrief` on the way in, `snapsh
382
382
  every projection, and the gate before emission. Pass on-contract arguments, or check the
383
383
  result.
384
384
 
385
- | API | Kind | Summary |
386
- | --------------------- | -------- | -------------------------------------------------------------------------------------------- |
387
- | `buildTask` | function | Assembles a `Task` from an operation, a domain, and a statement. |
388
- | `buildReference` | function | Assembles a `Reference` from a path and the note that justifies listing it. |
389
- | `buildManifest` | function | Assembles a `Manifest`, defaulting every absent partition to an empty list. |
390
- | `buildOutcome` | function | Assembles an `Outcome` from a rank and its result text. |
391
- | `buildGiven` | function | Assembles a `Given` from a category, a name, and a value. |
392
- | `buildExample` | function | Assembles an `Example` from an exemplar input and its expected output. |
393
- | `buildCitation` | function | Assembles a `Citation` from a name, a URL, and the note that justifies citing it. |
394
- | `buildGap` | function | Assembles a `Gap` from the section it belongs to and the question that would close it. |
395
- | `buildRisk` | function | Assembles a `Risk` from a severity, what could go wrong, and the mitigation that answers it. |
396
- | `buildOutput` | function | Assembles an `Output` from a format plus its optional refinements. |
397
- | `buildProof` | function | Assembles a `Proof` from what the check settles and the command that settles it. |
398
- | `buildBrief` | function | Assembles a `Brief` from a `Task` plus section overrides. |
399
- | `buildGateDefinition` | function | Assembles the fail-closed readiness gate as a reasons `LogicalDefinition`. |
385
+ | Name | Kind | Signature | Summary |
386
+ | --------------------- | -------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
387
+ | `buildTask` | function | `(operation: TaskOperation, domain: TaskDomain, statement: string) => Task` | Assembles a `Task` from an operation, a domain, and a statement. |
388
+ | `buildReference` | function | `(path: string, note: string) => Reference` | Assembles a `Reference` from a path and the note that justifies listing it. |
389
+ | `buildManifest` | function | `(partitions?: Partial<Manifest>) => Manifest` | Assembles a `Manifest`, defaulting every absent partition to an empty list. |
390
+ | `buildOutcome` | function | `(rank: number, text: string, required?: boolean) => Outcome` | Assembles an `Outcome` from a rank and its result text. |
391
+ | `buildGiven` | function | `(category: string, name: string, value: string) => Given` | Assembles a `Given` from a category, a name, and a value. |
392
+ | `buildExample` | function | `(input: string, output: string, note?: string) => Example` | Assembles an `Example` from an exemplar input and its expected output. |
393
+ | `buildCitation` | function | `(name: string, url: string, note: string) => Citation` | Assembles a `Citation` from a name, a URL, and the note that justifies citing it. |
394
+ | `buildGap` | function | `(field: string, question: string, overrides?: Partial<Omit<Gap, 'field' \| 'question'>>) => Gap` | Assembles a `Gap` from the section it belongs to and the question that would close it. |
395
+ | `buildRisk` | function | `(severity: RiskSeverity, text: string, mitigation: string) => Risk` | Assembles a `Risk` from a severity, what could go wrong, and the mitigation that answers it. |
396
+ | `buildOutput` | function | `(format: OutputFormat, overrides?: Partial<Omit<Output, 'format'>>) => Output` | Assembles an `Output` from a format plus its optional refinements. |
397
+ | `buildProof` | function | `(text: string, command: string) => Proof` | Assembles a `Proof` from what the check settles and the command that settles it. |
398
+ | `buildBrief` | function | `(subject: Task, overrides?: Partial<Omit<Brief, 'task' \| 'trace' \| 'hash'>>) => Brief` | Assembles a `Brief` from a `Task` plus section overrides. |
399
+ | `buildGateDefinition` | function | `() => LogicalDefinition` | Assembles the fail-closed readiness gate as a reasons `LogicalDefinition`. |
400
400
 
401
401
  ```ts
402
402
  import {
@@ -467,34 +467,34 @@ Pure, exported utility functions — the referentially-transparent leaves behind
467
467
  `BriefCompiler` and the projection surface. Projections use the `{noun}To{Noun}` idiom: each
468
468
  consumes a whole and returns a derived view of it.
469
469
 
470
- | API | Kind | Summary |
471
- | ------------------------ | -------- | -------------------------------------------------------------------------------------- |
472
- | `briefToMarkdown` | function | Projects a brief into the copy-ready agent prompt. |
473
- | `briefToGoal` | function | Projects a brief into a `/goal` completion condition. |
474
- | `briefToDispatch` | function | Projects a brief into a subagent `Dispatch`. |
475
- | `briefToSubject` | function | Projects a brief into the reasons `Subject` of readiness measures the gate reads. |
476
- | `briefToHash` | function | Computes the canonical structural digest of a brief's content. |
477
- | `briefToTrace` | function | Renders the one-line census `pinBrief` stamps onto a brief. |
478
- | `briefToContent` | function | Renders the canonical text of exactly what a brief's hash describes. |
479
- | `findUnmetRules` | function | Lists the readiness rules a brief fails, computed directly from its own measures. |
480
- | `pinBrief` | function | Returns a fresh brief with `trace` and `hash` derived from its own content. |
481
- | `snapshotBrief` | function | Returns a deeply owned, deeply frozen copy of a brief, refusing anything off-contract. |
482
- | `captureValue` | function | Captures one stable, frozen view of a foreign contract value. |
483
- | `assertBrief` | function | Narrows unknown data to a `Brief`, throwing when it is off-contract. |
484
- | `exampleToLines` | function | Renders one exemplar as markdown lines. |
485
- | `validateBrief` | function | Runs the semantic pass over an already-shape-valid brief. |
486
- | `countSentences` | function | Counts the sentences a statement holds. |
487
- | `findBlockingGaps` | function | Lists the gaps that block emission. |
488
- | `findManifestOverlaps` | function | Lists the paths appearing in more than one manifest partition. |
489
- | `findUngrantedAuthority` | function | Lists the authority paths the manifest never grants access to. |
490
- | `findUnpairedGaps` | function | Lists the open gaps with no assumption to stand on. |
491
- | `deriveStatement` | function | Derives one imperative statement from free text. |
492
- | `deriveTask` | function | Derives a `Task` from an interprets `Intent` through the caller's vocabularies. |
493
- | `deriveGivens` | function | Derives `Given[]` from an interprets `Entity[]`. |
494
- | `deriveGaps` | function | Derives `Gap[]` from an interprets `Ambiguity[]`. |
495
- | `errorToMessage` | function | Renders a value thrown by a stage into a message. |
496
- | `freezeDeep` | function | Freezes a value and everything reachable from it. |
497
- | `freezeBranch` | function | Freezes one branch of a value graph, skipping what the visited set already holds. |
470
+ | Name | Kind | Signature | Summary |
471
+ | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
472
+ | `briefToMarkdown` | function | `(input: Brief) => string` | Projects a brief into the copy-ready agent prompt. |
473
+ | `briefToGoal` | function | `(input: Brief, turns?: number) => string` | Projects a brief into a `/goal` completion condition. |
474
+ | `briefToDispatch` | function | `(input: Brief) => Dispatch` | Projects a brief into a subagent `Dispatch`. |
475
+ | `briefToSubject` | function | `(source: Brief) => Subject` | Projects a brief into the reasons `Subject` of readiness measures the gate reads. |
476
+ | `briefToHash` | function | `(source: Brief) => string` | Computes the canonical structural digest of a brief's content. |
477
+ | `briefToTrace` | function | `(source: Brief) => string` | Renders the one-line census `pinBrief` stamps onto a brief. |
478
+ | `briefToContent` | function | `(source: Brief) => string` | Renders the canonical text of exactly what a brief's hash describes. |
479
+ | `findUnmetRules` | function | `(source: Brief) => readonly string[]` | Lists the readiness rules a brief fails, computed directly from its own measures. |
480
+ | `pinBrief` | function | `(source: Brief) => Brief` | Returns a fresh brief with `trace` and `hash` derived from its own content. |
481
+ | `snapshotBrief` | function | `(source: Brief) => Brief` | Returns a deeply owned, deeply frozen copy of a brief, refusing anything off-contract. |
482
+ | `captureValue` | function | `(source: unknown, members: readonly string[]) => unknown` | Captures one stable, frozen view of a foreign contract value. |
483
+ | `assertBrief` | function | `(value: unknown) => Brief` | Narrows unknown data to a `Brief`, throwing when it is off-contract. |
484
+ | `exampleToLines` | function | `(entry: Example) => readonly string[]` | Renders one exemplar as markdown lines. |
485
+ | `validateBrief` | function | `(source: Brief) => ReasonValidationResult` | Runs the semantic pass over an already-shape-valid brief. |
486
+ | `countSentences` | function | `(statement: string) => number` | Counts the sentences a statement holds. |
487
+ | `findBlockingGaps` | function | `(source: Brief) => readonly Gap[]` | Lists the gaps that block emission. |
488
+ | `findManifestOverlaps` | function | `(source: Brief) => readonly string[]` | Lists the paths appearing in more than one manifest partition. |
489
+ | `findUngrantedAuthority` | function | `(source: Brief) => readonly string[]` | Lists the authority paths the manifest never grants access to. |
490
+ | `findUnpairedGaps` | function | `(source: Brief) => readonly Gap[]` | Lists the open gaps with no assumption to stand on. |
491
+ | `deriveStatement` | function | `(text: string) => string \| undefined` | Derives one imperative statement from free text. |
492
+ | `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
+ | `deriveGivens` | function | `(entities: readonly Entity[]) => readonly Given[]` | Derives `Given[]` from an interprets `Entity[]`. |
494
+ | `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
+ | `freezeDeep` | function | `<T>(value: T) => T` | Freezes a value and everything reachable from it. |
497
+ | `freezeBranch` | function | `<T>(value: T, seen: WeakSet<object>) => T` | Freezes one branch of a value graph, skipping what the visited set already holds. |
498
498
 
499
499
  ```ts
500
500
  import {
@@ -580,9 +580,9 @@ grant as the same literal path the authority carries.
580
580
 
581
581
  ### Parsers
582
582
 
583
- | API | Kind | Summary |
584
- | ------------ | -------- | ------------------------------------ |
585
- | `parseBrief` | function | Parses a JSON string into a `Brief`. |
583
+ | Name | Kind | Signature | Summary |
584
+ | ------------ | -------- | --------------------------------------- | ------------------------------------ |
585
+ | `parseBrief` | function | `(value: string) => Brief \| undefined` | Parses a JSON string into a `Brief`. |
586
586
 
587
587
  ```ts
588
588
  import { parseBrief } from '@orkestrel/brief'
@@ -603,11 +603,11 @@ already own, and cross `snapshotBrief` when you want intake to own it for you.
603
603
 
604
604
  ### Factories
605
605
 
606
- | API | Kind | Summary |
607
- | --------------------- | -------- | ------------------------------------------------------------------------------------- |
608
- | `createBriefCompiler` | function | Creates a compilation orchestrator. |
609
- | `createBriefManager` | function | Creates a brief registry. |
610
- | `createBriefContract` | function | Compiles `briefShape` into a guard, parser, JSON Schema, and seeded generator bundle. |
606
+ | Name | Kind | Signature | Summary |
607
+ | --------------------- | -------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
608
+ | `createBriefCompiler` | function | `(options?: BriefCompilerOptions) => BriefCompilerInterface` | Creates a compilation orchestrator. |
609
+ | `createBriefManager` | function | `(options?: BriefManagerOptions) => BriefManagerInterface` | Creates a brief registry. |
610
+ | `createBriefContract` | function | `() => ContractInterface<Brief>` | Compiles `briefShape` into a guard, parser, JSON Schema, and seeded generator bundle. |
611
611
 
612
612
  Every entry here builds something. `assertBrief` constructs nothing — it returns its
613
613
  argument after the guard passes — so it is a helper, not a factory, and lives beside
@@ -641,10 +641,10 @@ created.
641
641
 
642
642
  ### Classes
643
643
 
644
- | API | Kind | Summary |
645
- | --------------- | ----- | --------------------------------------------------------------------------------------- |
646
- | `BriefCompiler` | class | Implements the compilation orchestrator — the `[interpret, draft, gate, pin]` pipeline. |
647
- | `BriefManager` | class | Implements the self-owning, versioned and content-hashed brief registry. |
644
+ | Name | Kind | Signature | Summary |
645
+ | --------------- | ----- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
646
+ | `BriefCompiler` | class | `new (options?: BriefCompilerOptions) => BriefCompilerInterface` | Implements the compilation orchestrator — the `[interpret, draft, gate, pin]` pipeline. |
647
+ | `BriefManager` | class | `new (options?: BriefManagerOptions) => BriefManagerInterface` | Implements the self-owning, versioned and content-hashed brief registry. |
648
648
 
649
649
  ## Methods
650
650