@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
@@ -55,300 +55,316 @@ Exported from `@orkestrel/scaffold`, and reachable from
55
55
 
56
56
  #### Types
57
57
 
58
- | Name | Kind | Summary |
59
- | ------------------- | ---- | ----------------------------------------------------------------------------------------------------------- |
60
- | `Artifact` | type | Represents one file in a plan, discriminated by how its content is produced and what scaffold claims of it. |
61
- | `Axis` | type | Names the workspace axis an extension occupies. |
62
- | `BuildFormat` | type | Names one module format a published library environment builds. |
63
- | `CatalogEntry` | type | Represents one package row of the fleet catalog. |
64
- | `CompileStage` | type | Names the compile phases, in the order they run. |
65
- | `CompilerEventMap` | type | Represents the compiler's observation channel. |
66
- | `HostFile` | type | Represents one vendored file read from the repository, beside the target bytes it answers for. |
67
- | `Drift` | type | Names how one target path compares to the artifact planned for it. |
68
- | `Environment` | type | Names one environment a generated workspace selects on its `src` or `app` axis. |
69
- | `Extension` | type | Represents an extension discriminated by its surface. |
70
- | `Finding` | type | Represents one drift verdict against a target path. |
71
- | `Framework` | type | Names a supported browser framework. |
72
- | `Group` | type | Names the artifact group a plan selects over. |
73
- | `Lookup` | type | Names how an upstream lookup resolved: found, missing, unmatched, or failed. |
74
- | `Mirror` | type | Represents one dependency guide fetched from upstream, beside the local mirror it answers for. |
75
- | `Origin` | type | Names how an artifact's content is produced. |
76
- | `Ownership` | type | Names what scaffold claims at an artifact's path. |
77
- | `Release` | type | Represents one declared dependency range measured against a registry release. |
78
- | `ScaffoldErrorCode` | type | Names the coded reasons a scaffold error is raised. |
79
- | `SetupRuntime` | type | Names the runtime a root setup proof requires. |
80
- | `Snapshot` | type | Holds exact lowercase hexadecimal target bytes keyed by artifact-relative path. |
81
- | `Surface` | type | Names the surface an extension extends. |
58
+ | Name | Kind | Signature | Summary |
59
+ | ------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
60
+ | `Artifact` | type | `HostArtifact \| HydratedArtifact \| ContentArtifact` | Represents one file in a plan, discriminated by how its content is produced and what scaffold claims of it. |
61
+ | `Axis` | type | `'src' \| 'app'` | Names the workspace axis an extension occupies. |
62
+ | `BuildFormat` | type | `'es' \| 'cjs'` | Names one module format a published library environment builds. |
63
+ | `CatalogEntry` | type | `{ readonly name: string; readonly lookup: 'found'; readonly version: string; readonly dependencies: readonly Dependency[]; readonly peers: readonly Dependency[]; readonly note?: never; } \| { readonly name: string; readonly lookup: 'missing' \| 'unmatched' \| 'failed'; readonly note: string; readonly version?: never; readonly dependencies?: never; readonly peers?: never; }` | Represents one package row of the fleet catalog. |
64
+ | `CompileStage` | type | `'draft' \| 'gate' \| 'pin'` | Names the compile phases, in the order they run. |
65
+ | `CompilerEventMap` | type | `{ readonly compile: readonly [result: CompileResult]; readonly audit: readonly [audit: Audit]; readonly block: readonly [questions: readonly Question[]]; readonly error: readonly [error: unknown]; readonly destroy: readonly []; }` | Represents the compiler's observation channel. |
66
+ | `HostFile` | type | `{ readonly path: string; readonly lookup: 'found'; readonly hex: string; readonly observed?: string; readonly note?: never; } \| { readonly path: string; readonly lookup: 'missing' \| 'unmatched' \| 'failed'; readonly note: string; readonly observed?: string; readonly hex?: never; }` | Represents one vendored file read from the repository, beside the target bytes it answers for. |
67
+ | `Drift` | type | `'aligned' \| 'stale' \| 'missing' \| 'foreign'` | Names how one target path compares to the artifact planned for it. |
68
+ | `Environment` | type | `'core' \| 'browser' \| 'server'` | Names one environment a generated workspace selects on its `src` or `app` axis. |
69
+ | `Extension` | type | `BrowserExtension \| StylesExtension` | Represents an extension discriminated by its surface. |
70
+ | `Finding` | type | `{ readonly path: string; readonly group: Group; readonly ownership: Ownership; readonly drift: 'stale'; readonly observed: string; } \| { readonly path: string; readonly group: Group; readonly ownership?: never; readonly drift: 'foreign'; readonly observed: string; } \| { readonly path: string; readonly group: Group; readonly ownership: Ownership; readonly drift: 'missing'; readonly observed?: never; } \| { readonly path: string; readonly group: Group; readonly ownership: Ownership; readonly drift: 'aligned'; readonly observed?: string; }` | Represents one drift verdict against a target path. |
71
+ | `Framework` | type | `'vue'` | Names a supported browser framework. |
72
+ | `Group` | type | `'manifest' \| 'configs' \| 'source' \| 'tests' \| 'guides' \| 'docs' \| 'orchestration'` | Names the artifact group a plan selects over. |
73
+ | `Lookup` | type | `'found' \| 'missing' \| 'unmatched' \| 'failed'` | Names how an upstream lookup resolved: found, missing, unmatched, or failed. |
74
+ | `Mirror` | type | `{ readonly name: string; readonly path: string; readonly lookup: 'found'; readonly content: string; readonly observed?: string; readonly note?: never; } \| { readonly name: string; readonly path: string; readonly lookup: 'missing' \| 'unmatched' \| 'failed'; readonly note: string; readonly observed?: string; readonly content?: never; }` | Represents one dependency guide fetched from upstream, beside the local mirror it answers for. |
75
+ | `Origin` | type | `'host' \| 'template' \| 'computed'` | Names how an artifact's content is produced. |
76
+ | `Ownership` | type | `'content' \| 'presence' \| 'birth'` | Names what scaffold claims at an artifact's path. |
77
+ | `Release` | type | `{ readonly name: string; readonly range: string; readonly lookup: 'found'; readonly latest: string; readonly major?: number; readonly note?: never; } \| { readonly name: string; readonly range: string; readonly lookup: 'missing' \| 'unmatched' \| 'failed'; readonly note: string; readonly major?: number; readonly latest?: never; }` | Represents one declared dependency range measured against a registry release. |
78
+ | `ScaffoldErrorCode` | type | `'INVALID' \| 'BLOCKED' \| 'DESTROYED' \| 'TARGET' \| 'WRITE' \| 'FETCH'` | Names the coded reasons a scaffold error is raised. |
79
+ | `SetupRuntime` | type | `'node' \| 'browser'` | Names the runtime a root setup proof requires. |
80
+ | `Snapshot` | type | `Readonly<Record<string, string>>` | Holds exact lowercase hexadecimal target bytes keyed by artifact-relative path. |
81
+ | `Surface` | type | `'browser' \| 'styles'` | Names the surface an extension extends. |
82
82
 
83
83
  #### Interfaces
84
84
 
85
- | Name | Kind | Summary |
86
- | ----------------------- | --------- | ------------------------------------------------------------------------------------------------- |
87
- | `AppDefinition` | interface | Describes the configuration and runtime-entry settings one private `app` environment contributes. |
88
- | `ArtifactBase` | interface | Describes the fields every planned file carries. |
89
- | `Audit` | interface | Represents the whole comparison of a plan against a target's current content. |
90
- | `Blueprint` | interface | Represents the closed, JSON-serializable workspace specification. |
91
- | `BrowserExtension` | interface | Represents a browser framework and its physically occupied axes. |
92
- | `CompileFailure` | interface | Represents the coded reason one compile stage failed. |
93
- | `CompileRecord` | interface | Holds the input and output snapshot of one compile stage. |
94
- | `CompilerInterface` | interface | Describes the compilation contract: pure, synchronous, and host-independent. |
95
- | `CompilerOptions` | interface | Represents the options for the compiler. |
96
- | `ContentArtifact` | interface | Represents a text file produced by the template or computed compilation path. |
97
- | `Dependency` | interface | Represents one runtime `@orkestrel/*` dependency of a generated workspace. |
98
- | `DependencyPinSet` | interface | Describes the runtime and development sections a range-writing operation may change. |
99
- | `FrameworkDefinition` | interface | Describes the tooling and package boundaries a browser framework contributes. |
100
- | `HostArtifact` | interface | Represents a file byte-copied from the vendored data root, planned before its bytes are read. |
101
- | `HydratedArtifact` | interface | Represents a vendored file whose exact bytes have been read, so its content can be compared. |
102
- | `ManifestDependencySet` | interface | Describes the runtime, development, and peer sections read from an existing package manifest. |
103
- | `ManifestEdit` | interface | Represents one in-place replacement of manifest text. |
104
- | `ManifestRegionSet` | interface | Describes the manifest regions a writing operation may change. |
105
- | `ManifestScript` | interface | Represents one manifest script a region-writing operation may replace. |
106
- | `ManifestToken` | interface | Represents one string or object brace found in manifest text. |
107
- | `Override` | interface | Represents one artifact override. |
108
- | `Plan` | interface | Holds the compiled, ordered artifact list and the selection it covers. |
109
- | `PlanSummary` | interface | Represents the tally of one plan by artifact origin. |
110
- | `Question` | interface | Represents one validation issue raised against a blueprint or a plan. |
111
- | `CompileResult` | interface | Represents the replayable outcome of one compile. |
112
- | `SrcDefinition` | interface | Describes the build and export settings one published `src` environment contributes. |
113
- | `StylesExtension` | interface | Represents a named sheet face under `src/<name>`. |
114
- | `ToolchainHold` | interface | Represents one foreign tool range required by a browser framework. |
115
- | `ViteMachinery` | interface | Names which host-specific pipelines a generated root Vite configuration carries. |
85
+ | Name | Kind | Signature | Summary |
86
+ | ----------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
87
+ | `AppDefinition` | interface | `{ configs, project, entry? }` | Describes the configuration and runtime-entry settings one private `app` environment contributes. |
88
+ | `ArtifactBase` | interface | `{ path, group, ownership, environment? }` | Describes the fields every planned file carries. |
89
+ | `ArtifactTemplateSet` | interface | `{ source, tests, docs, guides, orchestration }` | Represents the source, test, document, guide, and service template text. |
90
+ | `Audit` | interface | `{ findings, questions }` | Represents the whole comparison of a plan against a target's current content. |
91
+ | `Blueprint` | interface | `{ name, description?, keywords, src, app, extensions, styles, themes, dependencies, peers, extras, version, engines, overrides, bin, setup, guides, integration, conformance, tree, service, vendors, studies, global, showcase, journey, skills }` | Represents the closed, JSON-serializable workspace specification. |
92
+ | `BrowserExtension` | interface | `{ surface, name, axes }` | Represents a browser framework and its physically occupied axes. |
93
+ | `CompileFailure` | interface | `{ code, message }` | Represents the coded reason one compile stage failed. |
94
+ | `CompileRecord` | interface | `{ stage, input, output, failure? }` | Holds the input and output snapshot of one compile stage. |
95
+ | `CompilerInterface` | interface | `{ emitter, compile(), audit(), destroy() }` | Describes the compilation contract: pure, synchronous, and host-independent. |
96
+ | `CompilerOptions` | interface | `{ on?, error? }` | Represents the options for the compiler. |
97
+ | `ConfigTemplateSet` | interface | `{ root, factories, tsconfigs, vites, browsers, commands }` | Represents the configuration template text, grouped by the artifact each template builds. |
98
+ | `ContentArtifact` | interface | `{ origin, content, hex?, source? }` | Represents a text file produced by the template or computed compilation path. |
99
+ | `Dependency` | interface | `{ name, range, optional? }` | Represents one runtime `@orkestrel/*` dependency of a generated workspace. |
100
+ | `DependencyPinSet` | interface | `{ runtime, development }` | Describes the runtime and development sections a range-writing operation may change. |
101
+ | `FrameworkDefinition` | interface | `{ plugin, checker, suffixes, refused, dependencies }` | Describes the tooling and package boundaries a browser framework contributes. |
102
+ | `HostArtifact` | interface | `{ origin, ownership, source?, pointer?, hex?, content? }` | Represents a file byte-copied from the vendored data root, planned before its bytes are read. |
103
+ | `HydratedArtifact` | interface | `{ origin, ownership, source?, hex, content? }` | Represents a vendored file whose exact bytes have been read, so its content can be compared. |
104
+ | `ManifestDependencySet` | interface | `{ runtime, development, peer }` | Describes the runtime, development, and peer sections read from an existing package manifest. |
105
+ | `ManifestEdit` | interface | `{ start, end, text }` | Represents one in-place replacement of manifest text. |
106
+ | `ManifestRegionSet` | interface | `{ pins, scripts, additions?, overrides? }` | Describes the manifest regions a writing operation may change. |
107
+ | `ManifestScript` | interface | `{ name, command, accepted }` | Represents one manifest script a region-writing operation may replace. |
108
+ | `ManifestToken` | interface | `{ text, index, depth, value }` | Represents one string or object brace found in manifest text. |
109
+ | `Override` | interface | `{ path, content }` | Represents one artifact override. |
110
+ | `Plan` | interface | `{ blueprint, groups, artifacts, hash? }` | Holds the compiled, ordered artifact list and the selection it covers. |
111
+ | `PlanSummary` | interface | `{ name, src, app, groups, host, template, computed }` | Represents the tally of one plan by artifact origin. |
112
+ | `Question` | interface | `{ field, message, blocking, candidates? }` | Represents one validation issue raised against a blueprint or a plan. |
113
+ | `CompileResult` | interface | `{ plan?, questions, stages }` | Represents the replayable outcome of one compile. |
114
+ | `SrcDefinition` | interface | `{ configs, project, path, formats }` | Describes the build and export settings one published `src` environment contributes. |
115
+ | `StylesExtension` | interface | `{ surface, name }` | Represents a named sheet face under `src/<name>`. |
116
+ | `ToolchainHold` | interface | `{ framework, range, reason }` | Represents one foreign tool range required by a browser framework. |
117
+ | `ViteMachinery` | interface | `{ browser, frameworks, output, showcase }` | Names which host-specific pipelines a generated root Vite configuration carries. |
118
+
119
+ | Name | Kind | Signature | Summary |
120
+ | ------------------ | --------- | ------------------------------- | ---------------------------------------------------------------------------------------------- |
121
+ | `SurfaceCandidate` | interface | `{ conflicts }` | Represents a candidate checkout's claim with each name two or more of its environments export. |
122
+ | `SurfaceClaim` | interface | `{ owner, names }` | Represents one owner's bare exported names, including an empty candidate surface. |
123
+ | `SurfaceCollision` | interface | `{ name, owners }` | Represents a bare name claimed by distinct package owners. |
124
+ | `SurfaceConflict` | interface | `{ name, owner, environments }` | Represents a bare name one owner's barrels export from two or more of its environments. |
125
+ | `SurfaceFinding` | interface | `{ standing }` | Reports a collision's standing against the recorded owner set. |
116
126
 
117
127
  #### Constants
118
128
 
119
- | Name | Kind | Summary |
120
- | --------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
121
- | `APP_BROWSER_DEV_DEPENDENCIES` | const | Lists the development dependencies a private browser application adds. |
122
- | `APP_DEV_DEPENDENCIES` | const | Names the development dependency every private `app` environment adds. |
123
- | `APP_MATRIX` | const | Holds the configuration and runtime-entry settings each private `app` environment contributes, frozen. |
124
- | `APP_SERVER_DEV_DEPENDENCIES` | const | Lists the development dependencies a private server application adds. |
125
- | `ARTIFACT_TEMPLATES` | const | Holds formatter-stable template text for source, test, document, guide, and service artifacts. |
126
- | `AXES` | const | Lists the axes a browser extension may occupy, frozen. |
127
- | `BASE_DEV_DEPENDENCIES` | const | Holds the baseline tooling versions, before framework holds apply. |
128
- | `BIN_CONFIGS` | const | Lists the configuration files a workspace that ships its own executable adds, frozen. |
129
- | `BIN_ENTRY_PATH` | const | Names the executable entry whose presence makes a workspace `bin`. |
130
- | `BIN_OUTPUT_PATH` | const | Names the built executable a bin workspace's manifest command runs. |
131
- | `BROWSE_DEV_DEPENDENCIES` | const | Names the development dependency a browser or styles surface adds. |
132
- | `BROWSE_UPSTREAM` | const | Lists the packages `@orkestrel/browser` depends on at runtime, directly or transitively, frozen. |
133
- | `CAPTURE_DEV_DEPENDENCIES` | const | Names the development dependency a browser application's journey axis adds. |
134
- | `CAPTURE_UPSTREAM` | const | Lists the capture package and its fleet runtime dependency closure, frozen. |
135
- | `CANON_PATHS` | const | Lists the instruction-canon paths staged for reading rather than for a target, frozen. |
136
- | `CATALOG_AGENT_PATH` | const | Names the agent file whose marker-bounded package table the catalog verb alone owns. |
137
- | `CATALOG_END_MARKER` | const | Names the marker closing the package table inside `CATALOG_AGENT_PATH`. |
138
- | `CATALOG_START_MARKER` | const | Names the marker opening the package table inside `CATALOG_AGENT_PATH`. |
139
- | `CONFIG_TEMPLATES` | const | Holds formatter-stable template text for every configuration artifact. |
140
- | `CONFORMANCE_TEST_PATH` | const | Names the official-tooling drift proof whose presence makes a workspace `conformance`. |
141
- | `CONTROL_CHARACTER_PATTERN` | const | Matches the Unicode controls, formatting controls, and line and paragraph separators rejected in text. |
142
- | `DECLARATION_DEV_DEPENDENCIES` | const | Lists the development dependencies that roll declarations up for published source. |
143
- | `DEFAULT_ENGINES` | const | Names the `engines.node` range a workspace starts with. |
144
- | `DEFAULT_VERSION` | const | Names the version a workspace starts at. |
145
- | `DEPENDENCY_NAME_PATTERN` | const | Matches the runtime dependency name syntax: the `@orkestrel` scope and a bare name. |
146
- | `DISTRIBUTION_SETUP_PATH` | const | Names the content-owned harness imported by the generated distribution proof. |
147
- | `DISTRIBUTION_TEST_PATH` | const | Names the generated packed-package proof every publishing workspace is planned at. |
148
- | `ENGINES_PATTERN` | const | Matches the minimum-Node engine syntax a blueprint declares. |
149
- | `ENVIRONMENTS` | const | Lists the `Environment` values, frozen. |
150
- | `EXECUTABLE_PATHS` | const | Lists the vendored paths a target receives with its executable bit set, frozen. |
151
- | `EXTRA_RANGE_PATTERN` | const | Matches the registry-only semver subset accepted for a development extra's range. |
152
- | `FLOOR_RANGE_PATTERN` | const | Matches the exact `major.minor.patch` floor accepted for a foreign peer's range. |
153
- | `FOREIGN_NAME_PATTERN` | const | Matches the package name syntax for a dependency this package does not publish. |
154
- | `FRAMEWORKS` | const | Lists the supported browser frameworks, frozen. |
155
- | `FRAMEWORK_MATRIX` | const | Describes the tooling and package boundaries of each browser framework, frozen. |
156
- | `GLOBAL_SETUP_PATH` | const | Names the shared Vitest global-setup module whose presence makes a workspace `global`. |
157
- | `GROUPS` | const | Lists the `Group` values in plan order, frozen. |
158
- | `GUIDES_TEST_PATH` | const | Names the package-owned guide-parity entry used by `test:guides` and to select the `guides` project. |
159
- | `HEX_PATTERN` | const | Matches exact lowercase hexadecimal bytes: two digits per byte, and empty content is valid. |
160
- | `HOST_INVENTORY_PATH` | const | Names the repository-relative path where the committed vendored-file inventory is served. |
161
- | `HOST_PATHS` | const | Lists the paths a target receives from the vendored data root, frozen. |
162
- | `INTEGRATION_TEST_PATH` | const | Names the cross-environment composition proof whose presence makes a workspace `integration`. |
163
- | `INVALID_PATH_CHARACTER_PATTERN` | const | Matches the visible characters a target-relative path and a Markdown path cell both forbid. |
164
- | `JOURNEY_CONFIG_PATH` | const | Names the Vite wrapper whose presence makes a workspace `journey`. |
165
- | `MANIFEST_PATH` | const | Names the manifest path every compiler plan emits with birth ownership. |
166
- | `MAX_ARTIFACT_BYTES` | const | Caps the bytes accepted for one artifact. |
167
- | `MAX_ARTIFACT_HEX_LENGTH` | const | Caps the length of the hexadecimal string carrying one artifact's bytes. |
168
- | `MAX_AUDIT_FINDINGS` | const | Caps the findings one audit can produce from a bounded plan and snapshot. |
169
- | `MAX_COLLECTION_ITEMS` | const | Caps the items accepted in one public collection. |
170
- | `MAX_DEPENDENCY_NAME_LENGTH` | const | Sets the maximum dependency package name length, scope included, as the registry caps it. |
171
- | `MAX_MANIFEST_BYTES` | const | Caps the bytes accepted for one package or vendored-host manifest. |
172
- | `MAX_NAME_LENGTH` | const | Caps the bare workspace name length. |
173
- | `MAX_PATH_LENGTH` | const | Caps the length of one path, matching the longest a supported filesystem accepts. |
174
- | `MAX_RANGE_LENGTH` | const | Caps the length of one declared package range. |
175
- | `MAX_REGISTRY_BYTES` | const | Caps the decoded bytes accepted from one registry response. |
176
- | `MAX_SCRIPT_LENGTH` | const | Caps the length of one manifest script name or command. |
177
- | `MAX_TOTAL_ARTIFACT_BYTES` | const | Caps the bytes retained across one whole plan or audit. |
178
- | `MAX_TOTAL_REGISTRY_BYTES` | const | Caps the decoded bytes accepted across one registry-reading call. |
179
- | `MINIMUM_NODE_VERSION` | const | Names the oldest Node version the generated toolchain supports. |
180
- | `MINIMUM_NPM_VERSION` | const | Names the oldest npm version the generated toolchain supports. |
181
- | `NAME_PATTERN` | const | Matches the bare workspace name syntax: lowercase alphanumeric with hyphens, letter first. |
182
- | `ORCHESTRATION_PATH_NAMES` | const | Lists the exact root paths that wire an agent bench or own an orchestration directory, frozen. |
183
- | `ORCHESTRATION_PATH_PREFIXES` | const | Lists the path prefixes whose contents instruct or wire an agent, frozen. |
184
- | `ORKESTREL_RANGE_PATTERN` | const | Matches the exact caret-pinned pre-1.0 range accepted for an `@orkestrel/*` runtime dependency. |
185
- | `PRINT_WIDTH` | const | Caps the columns one emitted line may occupy, matching `printWidth` in `.oxfmtrc.json`. |
186
- | `REFERENCE_PATHS` | const | Lists the reference paths staged for offline reading, frozen. |
187
- | `RELEASE_PROOF_COMMAND` | const | Names the `prepublishOnly` row that runs the packed-package proof against a real registry. |
188
- | `RESERVED_SHEET_NAMES` | const | Lists the names a styles extension cannot occupy, frozen. |
189
- | `SEED_GUIDE_PATHS` | const | Lists the guide paths a generated workspace starts with, frozen. |
190
- | `SERVICE_SCRIPT_PATH` | const | Names the inventory skeleton a workspace with declared service vendors is given once. |
191
- | `SERVICE_SETUP_PATH` | const | Names the live-service readiness module whose presence makes a workspace `service`. |
192
- | `SERVICE_TEST_INCLUDE` | const | Names the include the live-service project covers, which is a directory rather than one proof. |
193
- | `SHEET_ENTRY_NAME` | const | Names the build entry beside each stylesheet marker. |
194
- | `SHOWCASE_CONFIG_PATH` | const | Names the Vite wrapper whose presence makes a workspace `showcase`. |
195
- | `SHOWCASE_DEV_DEPENDENCIES` | const | Names the tested dependency pair selected by the optional single-file showcase build. |
196
- | `SHOWCASE_OVERRIDES` | const | Names the scoped npm override required by the tested showcase plugin. |
197
- | `SHOWCASE_PAGES_PATH` | const | Names the physical showcase output directory. |
198
- | `SKILLS_CONFIG_PATH` | const | Names the TypeScript wrapper whose presence makes a workspace `skills`. |
199
- | `SOURCE_BROWSER_DEV_DEPENDENCIES` | const | Lists the development dependencies a published browser `src` environment adds. |
200
- | `SRC_MATRIX` | const | Holds the build and export settings each published `src` environment contributes, frozen. |
201
- | `STUDIES_TEST_INCLUDE` | const | Names the include the study project covers, where an exact-case `*.test.ts` file beneath `tests/studies`, outside any `node_modules` or `.git` directory, makes a workspace `studies`. |
202
- | `STYLES_DEV_DEPENDENCIES` | const | Lists the development dependencies the styles surface adds, frozen. |
203
- | `STYLES_ENTRY_PATH` | const | Names the base stylesheet marker. |
204
- | `SURFACES` | const | Lists the surfaces an extension may extend, frozen. |
205
- | `TAB_WIDTH` | const | Sets the columns one tab occupies when the formatter measures a line, matching `tabWidth`. |
206
- | `TARGET_SKILL_NAMES` | const | Lists the package-facing skills a target receives pointers for, frozen and alphabetical. |
207
- | `THEMES_BARREL_PATH` | const | Names the themes stylesheet marker. |
208
- | `THEMES_ENTRY_PATH` | const | Names the themes build entry marker. |
209
- | `TOOLCHAIN_HOLDS` | const | Holds foreign tool ranges required by selected browser frameworks, frozen. |
210
- | `TREE_TEST_PATH` | const | Names the real-tree proof whose presence makes a workspace `tree`. |
211
- | `VERSION_PATTERN` | const | Matches the exact `major.minor.patch` version syntax a blueprint declares. |
212
- | `WORKSPACE_DEV_ENGINES` | const | Holds the `devEngines` record every generated manifest carries. |
213
- | `WORKSPACE_OWNED_PATHS` | const | Lists the vendored paths whose present bytes belong to each workspace, frozen. |
129
+ | Name | Kind | Signature | Summary |
130
+ | --------------------------------- | ----- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
131
+ | `APP_BROWSER_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies a private browser application adds. |
132
+ | `APP_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the development dependency every private `app` environment adds. |
133
+ | `APP_MATRIX` | const | `Readonly<Record<Environment, AppDefinition>>` | Holds the configuration and runtime-entry settings each private `app` environment contributes, frozen. |
134
+ | `APP_SERVER_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies a private server application adds. |
135
+ | `ARTIFACT_TEMPLATES` | const | `ArtifactTemplateSet` | Holds formatter-stable template text for source, test, document, guide, and service artifacts. |
136
+ | `AXES` | const | `readonly Axis[]` | Lists the axes a browser extension may occupy, frozen. |
137
+ | `BASE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Holds the baseline tooling versions, before framework holds apply. |
138
+ | `BIN_CONFIGS` | const | `readonly string[]` | Lists the configuration files a workspace that ships its own executable adds, frozen. |
139
+ | `BIN_ENTRY_PATH` | const | `"src/bin/main.ts"` | Names the executable entry whose presence makes a workspace `bin`. |
140
+ | `BIN_OUTPUT_PATH` | const | `"dist/bin/main.js"` | Names the built executable a bin workspace's manifest command runs. |
141
+ | `BROWSE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the development dependency a browser or styles surface adds. |
142
+ | `BROWSE_UPSTREAM` | const | `readonly string[]` | Lists the packages `@orkestrel/browser` depends on at runtime, directly or transitively, frozen. |
143
+ | `CAPTURE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the development dependency a browser application's journey axis adds. |
144
+ | `CAPTURE_UPSTREAM` | const | `readonly string[]` | Lists the capture package and its fleet runtime dependency closure, frozen. |
145
+ | `CANON_PATHS` | const | `readonly string[]` | Lists the instruction-canon paths staged for reading rather than for a target, frozen. |
146
+ | `CATALOG_AGENT_PATH` | const | `".claude/agents/orkestrel.md"` | Names the agent file whose marker-bounded package table the catalog verb alone owns. |
147
+ | `CATALOG_END_MARKER` | const | `"<!-- /orkestrel:catalog -->"` | Names the marker closing the package table inside `CATALOG_AGENT_PATH`. |
148
+ | `CATALOG_START_MARKER` | const | `"<!-- orkestrel:catalog -->"` | Names the marker opening the package table inside `CATALOG_AGENT_PATH`. |
149
+ | `CONFIG_TEMPLATES` | const | `ConfigTemplateSet` | Holds formatter-stable template text for every configuration artifact. |
150
+ | `CONFORMANCE_TEST_PATH` | const | `"tests/conformance.test.ts"` | Names the official-tooling drift proof whose presence makes a workspace `conformance`. |
151
+ | `CONTROL_CHARACTER_PATTERN` | const | `RegExp` | Matches the Unicode controls, formatting controls, and line and paragraph separators rejected in text. |
152
+ | `DECLARATION_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies that roll declarations up for published source. |
153
+ | `DEFAULT_ENGINES` | const | `">=22.18.0"` | Names the `engines.node` range a workspace starts with. |
154
+ | `DEFAULT_VERSION` | const | `"0.0.1"` | Names the version a workspace starts at. |
155
+ | `DEPENDENCY_NAME_PATTERN` | const | `RegExp` | Matches the runtime dependency name syntax: the `@orkestrel` scope and a bare name. |
156
+ | `DISTRIBUTION_SETUP_PATH` | const | `"tests/setupDistribution.ts"` | Names the content-owned harness imported by the generated distribution proof. |
157
+ | `DISTRIBUTION_TEST_PATH` | const | `"tests/distribution.test.ts"` | Names the generated packed-package proof every publishing workspace is planned at. |
158
+ | `ENGINES_PATTERN` | const | `RegExp` | Matches the minimum-Node engine syntax a blueprint declares. |
159
+ | `ENVIRONMENTS` | const | `readonly Environment[]` | Lists the `Environment` values, frozen. |
160
+ | `EXECUTABLE_PATHS` | const | `readonly string[]` | Lists the vendored paths a target receives with its executable bit set, frozen. |
161
+ | `EXTRA_RANGE_PATTERN` | const | `RegExp` | Matches the registry-only semver subset accepted for a development extra's range. |
162
+ | `FLOOR_RANGE_PATTERN` | const | `RegExp` | Matches the exact `major.minor.patch` floor accepted for a foreign peer's range. |
163
+ | `FOREIGN_NAME_PATTERN` | const | `RegExp` | Matches the package name syntax for a dependency this package does not publish. |
164
+ | `FRAMEWORKS` | const | `readonly Framework[]` | Lists the supported browser frameworks, frozen. |
165
+ | `FRAMEWORK_MATRIX` | const | `Readonly<Record<Framework, FrameworkDefinition>>` | Describes the tooling and package boundaries of each browser framework, frozen. |
166
+ | `GLOBAL_SETUP_PATH` | const | `"tests/setupGlobal.ts"` | Names the shared Vitest global-setup module whose presence makes a workspace `global`. |
167
+ | `GROUPS` | const | `readonly Group[]` | Lists the `Group` values in plan order, frozen. |
168
+ | `GUIDES_TEST_PATH` | const | `"tests/guides.test.ts"` | Names the package-owned guide-parity entry used by `test:guides` and to select the `guides` project. |
169
+ | `HEX_PATTERN` | const | `RegExp` | Matches exact lowercase hexadecimal bytes: two digits per byte, and empty content is valid. |
170
+ | `HOST_INVENTORY_PATH` | const | `"host.json"` | Names the repository-relative path where the committed vendored-file inventory is served. |
171
+ | `HOST_PATHS` | const | `readonly string[]` | Lists the paths a target receives from the vendored data root, frozen. |
172
+ | `INTEGRATION_TEST_PATH` | const | `"tests/integration.test.ts"` | Names the cross-environment composition proof whose presence makes a workspace `integration`. |
173
+ | `INVALID_PATH_CHARACTER_PATTERN` | const | `RegExp` | Matches the visible characters a target-relative path and a Markdown path cell both forbid. |
174
+ | `JOURNEY_CONFIG_PATH` | const | `"configs/app/vite.journey.config.ts"` | Names the Vite wrapper whose presence makes a workspace `journey`. |
175
+ | `MANIFEST_PATH` | const | `"package.json"` | Names the manifest path every compiler plan emits with birth ownership. |
176
+ | `MAX_ARTIFACT_BYTES` | const | `5242880` | Caps the bytes accepted for one artifact. |
177
+ | `MAX_ARTIFACT_HEX_LENGTH` | const | `number` | Caps the length of the hexadecimal string carrying one artifact's bytes. |
178
+ | `MAX_AUDIT_FINDINGS` | const | `number` | Caps the findings one audit can produce from a bounded plan and snapshot. |
179
+ | `MAX_COLLECTION_ITEMS` | const | `1000` | Caps the items accepted in one public collection. |
180
+ | `MAX_DEPENDENCY_NAME_LENGTH` | const | `214` | Sets the maximum dependency package name length, scope included, as the registry caps it. |
181
+ | `MAX_MANIFEST_BYTES` | const | `1048576` | Caps the bytes accepted for one package or vendored-host manifest. |
182
+ | `MAX_NAME_LENGTH` | const | `203` | Caps the bare workspace name length. |
183
+ | `MAX_PATH_LENGTH` | const | `32767` | Caps the length of one path, matching the longest a supported filesystem accepts. |
184
+ | `MAX_RANGE_LENGTH` | const | `2048` | Caps the length of one declared package range. |
185
+ | `MAX_REGISTRY_BYTES` | const | `33554432` | Caps the decoded bytes accepted from one registry response. |
186
+ | `MAX_SCRIPT_LENGTH` | const | `4096` | Caps the length of one manifest script name or command. |
187
+ | `MAX_TOTAL_ARTIFACT_BYTES` | const | `104857600` | Caps the bytes retained across one whole plan or audit. |
188
+ | `MAX_TOTAL_REGISTRY_BYTES` | const | `100663296` | Caps the decoded bytes accepted across one registry-reading call. |
189
+ | `MINIMUM_NODE_VERSION` | const | `"22.18.0"` | Names the oldest Node version the generated toolchain supports. |
190
+ | `MINIMUM_NPM_VERSION` | const | `"11.6.0"` | Names the oldest npm version the generated toolchain supports. |
191
+ | `NAME_PATTERN` | const | `RegExp` | Matches the bare workspace name syntax: lowercase alphanumeric with hyphens, letter first. |
192
+ | `ORCHESTRATION_PATH_NAMES` | const | `readonly string[]` | Lists the exact root paths that wire an agent bench or own an orchestration directory, frozen. |
193
+ | `ORCHESTRATION_PATH_PREFIXES` | const | `readonly string[]` | Lists the path prefixes whose contents instruct or wire an agent, frozen. |
194
+ | `ORKESTREL_RANGE_PATTERN` | const | `RegExp` | Matches the exact caret-pinned pre-1.0 range accepted for an `@orkestrel/*` runtime dependency. |
195
+ | `PRINT_WIDTH` | const | `100` | Caps the columns one emitted line may occupy, matching `printWidth` in `.oxfmtrc.json`. |
196
+ | `REFERENCE_PATHS` | const | `readonly string[]` | Lists the reference paths staged for offline reading, frozen. |
197
+ | `RELEASE_PROOF_COMMAND` | const | `"npm run test:distribution -- --mode release"` | Names the `prepublishOnly` row that runs the packed-package proof against a real registry. |
198
+ | `RESERVED_SHEET_NAMES` | const | `readonly string[]` | Lists the names a styles extension cannot occupy, frozen. |
199
+ | `SEED_GUIDE_PATHS` | const | `readonly string[]` | Lists the guide paths a generated workspace starts with, frozen. |
200
+ | `SERVICE_SCRIPT_PATH` | const | `"scripts/service.sh"` | Names the inventory skeleton a workspace with declared service vendors is given once. |
201
+ | `SERVICE_SETUP_PATH` | const | `"tests/setupService.ts"` | Names the live-service readiness module whose presence makes a workspace `service`. |
202
+ | `SERVICE_TEST_INCLUDE` | const | `"tests/service/**/*.test.ts"` | Names the include the live-service project covers, which is a directory rather than one proof. |
203
+ | `SHEET_ENTRY_NAME` | const | `"sheet.ts"` | Names the build entry beside each stylesheet marker. |
204
+ | `SHOWCASE_CONFIG_PATH` | const | `"configs/app/vite.showcase.config.ts"` | Names the Vite wrapper whose presence makes a workspace `showcase`. |
205
+ | `SHOWCASE_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Names the tested dependency pair selected by the optional single-file showcase build. |
206
+ | `SHOWCASE_OVERRIDES` | const | `Readonly<Record<string, Readonly<Record<string, string>>>>` | Names the scoped npm override required by the tested showcase plugin. |
207
+ | `SHOWCASE_PAGES_PATH` | const | `"showcase"` | Names the physical showcase output directory. |
208
+ | `SKILLS_CONFIG_PATH` | const | `"configs/agents/tsconfig.skills.json"` | Names the TypeScript wrapper whose presence makes a workspace `skills`. |
209
+ | `SOURCE_BROWSER_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies a published browser `src` environment adds. |
210
+ | `SRC_MATRIX` | const | `Readonly<Record<Environment, SrcDefinition>>` | Holds the build and export settings each published `src` environment contributes, frozen. |
211
+ | `STUDIES_TEST_INCLUDE` | const | `"tests/studies/**/*.test.ts"` | Names the include the study project covers, where an exact-case `*.test.ts` file beneath `tests/studies`, outside any `node_modules` or `.git` directory, makes a workspace `studies`. |
212
+ | `STYLES_DEV_DEPENDENCIES` | const | `Readonly<Record<string, string>>` | Lists the development dependencies the styles surface adds, frozen. |
213
+ | `STYLES_ENTRY_PATH` | const | `"src/styles/index.scss"` | Names the base stylesheet marker. |
214
+ | `SURFACES` | const | `readonly Surface[]` | Lists the surfaces an extension may extend, frozen. |
215
+ | `TAB_WIDTH` | const | `2` | Sets the columns one tab occupies when the formatter measures a line, matching `tabWidth`. |
216
+ | `TARGET_SKILL_NAMES` | const | `readonly string[]` | Lists the package-facing skills a target receives pointers for, frozen and alphabetical. |
217
+ | `THEMES_BARREL_PATH` | const | `"src/styles/themes/index.scss"` | Names the themes stylesheet marker. |
218
+ | `THEMES_ENTRY_PATH` | const | `"src/styles/themes/sheet.ts"` | Names the themes build entry marker. |
219
+ | `TOOLCHAIN_HOLDS` | const | `Readonly<Record<string, ToolchainHold>>` | Holds foreign tool ranges required by selected browser frameworks, frozen. |
220
+ | `TREE_TEST_PATH` | const | `"tests/tree.test.ts"` | Names the real-tree proof whose presence makes a workspace `tree`. |
221
+ | `VERSION_PATTERN` | const | `RegExp` | Matches the exact `major.minor.patch` version syntax a blueprint declares. |
222
+ | `WORKSPACE_DEV_ENGINES` | const | `Readonly<{ packageManager: Readonly<{ name: "npm"; version: ">=11.6.0"; onFail: "error"; }>; }>` | Holds the `devEngines` record every generated manifest carries. |
223
+ | `WORKSPACE_OWNED_PATHS` | const | `readonly string[]` | Lists the vendored paths whose present bytes belong to each workspace, frozen. |
214
224
 
215
225
  #### Guards
216
226
 
217
- | Name | Kind | Summary |
218
- | -------------------- | -------- | --------------------------------------------------------------------------------- |
219
- | `isArtifact` | const | Narrows a value to an `Artifact`. |
220
- | `isAudit` | const | Narrows a value to an `Audit`. |
221
- | `isBlueprint` | const | Narrows a value to a `Blueprint`. |
222
- | `isBrowserExtension` | const | Narrows a value to a supported browser framework with distinct occupied axes. |
223
- | `isCatalogEntry` | const | Narrows a value to a `CatalogEntry`. |
224
- | `isCollection` | function | Narrows a value to an array within the limit one public collection accepts. |
225
- | `isCompilerHooks` | const | Narrows a value to the compiler's initial listener record. |
226
- | `isCompilerOptions` | const | Narrows a value to `CompilerOptions`. |
227
- | `isContent` | const | Narrows a value to text this package will accept as one artifact's content. |
228
- | `isDependency` | const | Narrows a value to a `Dependency`. |
229
- | `isDependencyName` | const | Narrows a value to the scoped package name a runtime dependency carries. |
230
- | `isEnvironment` | const | Narrows a value to one `Environment` a workspace may select. |
231
- | `isExtension` | const | Narrows a value to an extension of a supported surface. |
232
- | `isFinding` | const | Narrows a value to a `Finding`. |
233
- | `isGroup` | const | Narrows a value to one `Group` a plan selects over. |
234
- | `isGroups` | const | Narrows a value to a bounded group selection. |
235
- | `isHex` | const | Narrows a value to exact lowercase hexadecimal bytes within one artifact's limit. |
236
- | `isManifestScript` | const | Narrows a value to a `ManifestScript`. |
237
- | `isMirror` | const | Narrows a value to a `Mirror`. |
238
- | `isOverride` | const | Narrows a value to an `Override`. |
239
- | `isPath` | function | Narrows a value to a logical target-relative path. |
240
- | `isPlan` | const | Narrows a value to a `Plan`. |
241
- | `isQuestion` | const | Narrows a value to a `Question`. |
242
- | `isScaffoldError` | function | Narrows a caught value to a `ScaffoldError`. |
243
- | `isSheetName` | function | Narrows a value to a non-reserved sheet face name. |
244
- | `isSnapshot` | function | Narrows a value to a `Snapshot`. |
245
- | `isStylesExtension` | const | Narrows a value to a named non-reserved stylesheet face. |
246
- | `isSurface` | const | Narrows a value to a surface an extension can extend. |
227
+ | Name | Kind | Signature | Summary |
228
+ | -------------------- | -------- | ------------------------------------------------- | --------------------------------------------------------------------------------- |
229
+ | `isArtifact` | const | `Guard<Artifact>` | Narrows a value to an `Artifact`. |
230
+ | `isAudit` | const | `Guard<Audit>` | Narrows a value to an `Audit`. |
231
+ | `isBlueprint` | const | `Guard<Blueprint>` | Narrows a value to a `Blueprint`. |
232
+ | `isBrowserExtension` | const | `Guard<BrowserExtension>` | Narrows a value to a supported browser framework with distinct occupied axes. |
233
+ | `isCatalogEntry` | const | `Guard<CatalogEntry>` | Narrows a value to a `CatalogEntry`. |
234
+ | `isCollection` | function | `(value: unknown) => value is readonly unknown[]` | Narrows a value to an array within the limit one public collection accepts. |
235
+ | `isCompilerHooks` | const | `Guard<EmitterHooks<CompilerEventMap>>` | Narrows a value to the compiler's initial listener record. |
236
+ | `isCompilerOptions` | const | `Guard<CompilerOptions>` | Narrows a value to `CompilerOptions`. |
237
+ | `isContent` | const | `Guard<string>` | Narrows a value to text this package will accept as one artifact's content. |
238
+ | `isDependency` | const | `Guard<Dependency>` | Narrows a value to a `Dependency`. |
239
+ | `isDependencyName` | const | `Guard<string>` | Narrows a value to the scoped package name a runtime dependency carries. |
240
+ | `isEnvironment` | const | `Guard<Environment>` | Narrows a value to one `Environment` a workspace may select. |
241
+ | `isExtension` | const | `Guard<Extension>` | Narrows a value to an extension of a supported surface. |
242
+ | `isFinding` | const | `Guard<Finding>` | Narrows a value to a `Finding`. |
243
+ | `isGroup` | const | `Guard<Group>` | Narrows a value to one `Group` a plan selects over. |
244
+ | `isGroups` | const | `Guard<readonly Group[]>` | Narrows a value to a bounded group selection. |
245
+ | `isHex` | const | `Guard<string>` | Narrows a value to exact lowercase hexadecimal bytes within one artifact's limit. |
246
+ | `isManifestScript` | const | `Guard<ManifestScript>` | Narrows a value to a `ManifestScript`. |
247
+ | `isMirror` | const | `Guard<Mirror>` | Narrows a value to a `Mirror`. |
248
+ | `isOverride` | const | `Guard<Override>` | Narrows a value to an `Override`. |
249
+ | `isPath` | function | `(value: unknown) => value is string` | Narrows a value to a logical target-relative path. |
250
+ | `isPlan` | const | `Guard<Plan>` | Narrows a value to a `Plan`. |
251
+ | `isQuestion` | const | `Guard<Question>` | Narrows a value to a `Question`. |
252
+ | `isScaffoldError` | function | `(value: unknown) => value is ScaffoldError` | Narrows a caught value to a `ScaffoldError`. |
253
+ | `isSheetName` | function | `(value: unknown) => value is string` | Narrows a value to a non-reserved sheet face name. |
254
+ | `isSnapshot` | function | `(value: unknown) => value is Snapshot` | Narrows a value to a `Snapshot`. |
255
+ | `isStylesExtension` | const | `Guard<StylesExtension>` | Narrows a value to a named non-reserved stylesheet face. |
256
+ | `isSurface` | const | `Guard<Surface>` | Narrows a value to a surface an extension can extend. |
247
257
 
248
258
  #### Parsers
249
259
 
250
- | Name | Kind | Summary |
251
- | ---------------------- | -------- | --------------------------------------------------------------------------- |
252
- | `parseBlueprint` | function | Coerces an untrusted value to a `Blueprint`. |
253
- | `parseCompilerOptions` | function | Coerces an untrusted value to `CompilerOptions`. |
254
- | `parseExtension` | function | Coerces an extension value or a `surface:name` selection into an extension. |
255
- | `parseGroups` | function | Coerces an untrusted value to a group selection. |
256
- | `parseSnapshot` | function | Coerces an untrusted value to a `Snapshot`. |
260
+ | Name | Kind | Signature | Summary |
261
+ | ---------------------- | -------- | --------------------------------------------------- | --------------------------------------------------------------------------- |
262
+ | `parseBlueprint` | function | `(value: unknown) => Blueprint \| undefined` | Coerces an untrusted value to a `Blueprint`. |
263
+ | `parseCompilerOptions` | function | `(value: unknown) => CompilerOptions \| undefined` | Coerces an untrusted value to `CompilerOptions`. |
264
+ | `parseExtension` | function | `(value: unknown) => Extension \| undefined` | Coerces an extension value or a `surface:name` selection into an extension. |
265
+ | `parseGroups` | function | `(value: unknown) => readonly Group[] \| undefined` | Coerces an untrusted value to a group selection. |
266
+ | `parseSnapshot` | function | `(value: unknown) => Snapshot \| undefined` | Coerces an untrusted value to a `Snapshot`. |
257
267
 
258
268
  #### Helpers
259
269
 
260
- | Name | Kind | Summary |
261
- | --------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
262
- | `artifactToFinding` | function | Projects one planned artifact and the bytes found at its path into a verdict. |
263
- | `artifactToHex` | function | Projects an artifact to the exact bytes it claims, as hexadecimal. |
264
- | `bytesToHex` | function | Encodes bytes as exact lowercase hexadecimal text. |
265
- | `catalogToLayers` | function | Projects a catalog into the layers it publishes in. |
266
- | `cloneValue` | function | Snapshots an untrusted value into exact JSON data the caller owns. |
267
- | `compareVersions` | function | Compares two versions by their numeric components. |
268
- | `computeBytes` | function | Counts the UTF-8 bytes text encodes to. |
269
- | `computeHash` | function | Computes the deterministic content identity of text. |
270
- | `computeTotal` | function | Computes the sum of a list of numbers. |
271
- | `contentToHex` | function | Encodes text as the exact lowercase hexadecimal form of its UTF-8 bytes. |
272
- | `extractRangeMajor` | function | Extracts the major component of an admitted dependency range. |
273
- | `extractVersion` | function | Extracts the major, minor, and patch components of an exact version. |
274
- | `inferDrift` | function | Infers how one target path compares to the artifact planned for it. |
275
- | `inferGroup` | function | Infers the `Group` a path belongs to. |
276
- | `isCanonPath` | function | Checks whether a path belongs to the instruction canon a target reads rather than holds. |
277
- | `isDeferredPath` | function | Checks whether another surface owns the vendored bytes at a path. |
278
- | `isFloorPath` | function | Checks whether a destination's floor bytes survive a live overlay. |
279
- | `isRetainedPath` | function | Checks whether another surface owns a target's present bytes at a path. |
280
- | `iterateAnswers` | function | Yields the answer to each value of a source and ends after the first refused answer. |
281
- | `manifestToDependencies` | function | Projects a package manifest's text to the `@orkestrel/*` packages each dependency section declares. |
282
- | `manifestToName` | function | Projects a package manifest's text to its own name. |
283
- | `matchesDriftReachability` | function | Tests whether `inferDrift` could have produced a finding for an ownership. |
284
- | `matchesEngines` | function | Tests whether a declared engines floor is at or above the supported minimum. |
285
- | `matchesOrchestrationPath` | function | Tests whether a path instructs or wires an agent rather than the toolchain. |
286
- | `matchesPrintWidth` | function | Tests whether one emitted line fits the vendored formatter width. |
287
- | `matchesRange` | function | Tests whether a declared range already admits a published version. |
288
- | `nameToGuide` | function | Derives the guide mirror path a package name answers for. |
289
- | `planToSummary` | function | Projects a plan into its tally by artifact origin. |
290
- | `renderSkillPointer` | function | Renders the `SKILL.md` pointer a target carries in place of a canonical skill. |
291
- | `scanManifestTokens` | function | Scans manifest text for its strings and object braces, in order. |
292
- | `selectGroups` | function | Selects the groups a compile covers, in plan order. |
293
- | `selectHostPaths` | function | Selects the host paths a named workspace vendors. |
294
- | `serializeTypeScriptString` | function | Serializes one string as a single-quoted TypeScript literal. |
295
- | `srcToRoot` | function | Selects the single published environment a package root points at. |
270
+ | Name | Kind | Signature | Summary |
271
+ | --------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
272
+ | `artifactToFinding` | function | `(artifact: Artifact, observed?: string) => Finding` | Projects one planned artifact and the bytes found at its path into a verdict. |
273
+ | `artifactToHex` | function | `(artifact: Artifact) => string \| undefined` | Projects an artifact to the exact bytes it claims, as hexadecimal. |
274
+ | `bytesToHex` | function | `(bytes: Uint8Array) => string` | Encodes bytes as exact lowercase hexadecimal text. |
275
+ | `catalogToLayers` | function | `(entries: readonly CatalogEntry[]) => ReadonlyArray<readonly string[]>` | Projects a catalog into the layers it publishes in. |
276
+ | `cloneValue` | function | `(value: unknown) => JSONValue \| undefined` | Snapshots an untrusted value into exact JSON data the caller owns. |
277
+ | `compareVersions` | function | `(left: string, right: string) => number` | Compares two versions by their numeric components. |
278
+ | `computeBytes` | function | `(content: string) => number` | Counts the UTF-8 bytes text encodes to. |
279
+ | `computeHash` | function | `(text: string) => string` | Computes the deterministic content identity of text. |
280
+ | `computeTotal` | function | `(values: readonly number[]) => number` | Computes the sum of a list of numbers. |
281
+ | `contentToHex` | function | `(content: string) => string` | Encodes text as the exact lowercase hexadecimal form of its UTF-8 bytes. |
282
+ | `extractRangeMajor` | function | `(range: string) => number \| undefined` | Extracts the major component of an admitted dependency range. |
283
+ | `extractVersion` | function | `(version: string) => readonly [major: number, minor: number, patch: number] \| undefined` | Extracts the major, minor, and patch components of an exact version. |
284
+ | `inferDrift` | function | `(artifact: Artifact, observed?: string) => Exclude<Drift, 'foreign'>` | Infers how one target path compares to the artifact planned for it. |
285
+ | `inferGroup` | function | `(path: string) => Group` | Infers the `Group` a path belongs to. |
286
+ | `isCanonPath` | function | `(path: string) => boolean` | Checks whether a path belongs to the instruction canon a target reads rather than holds. |
287
+ | `isDeferredPath` | function | `(path: string) => boolean` | Checks whether another surface owns the vendored bytes at a path. |
288
+ | `isFloorPath` | function | `(path: string) => boolean` | Checks whether a destination's floor bytes survive a live overlay. |
289
+ | `isRetainedPath` | function | `(path: string) => boolean` | Checks whether another surface owns a target's present bytes at a path. |
290
+ | `iterateAnswers` | function | `<TValue, TAnswer>(source: Iterable<TValue>, answer: (value: TValue) => TAnswer \| undefined) => Generator<TAnswer \| undefined, void, undefined>` | Yields the answer to each value of a source and ends after the first refused answer. |
291
+ | `manifestToDependencies` | function | `(manifest: string) => ManifestDependencySet` | Projects a package manifest's text to the `@orkestrel/*` packages each dependency section declares. |
292
+ | `manifestToName` | function | `(manifest: string) => string \| undefined` | Projects a package manifest's text to its own name. |
293
+ | `matchesDriftReachability` | function | `(ownership: Ownership, finding: Finding) => boolean` | Tests whether `inferDrift` could have produced a finding for an ownership. |
294
+ | `matchesEngines` | function | `(engines: string) => boolean` | Tests whether a declared engines floor is at or above the supported minimum. |
295
+ | `matchesOrchestrationPath` | function | `(path: string) => boolean` | Tests whether a path instructs or wires an agent rather than the toolchain. |
296
+ | `matchesPrintWidth` | function | `(line: string) => boolean` | Tests whether one emitted line fits the vendored formatter width. |
297
+ | `matchesRange` | function | `(range: string, latest: string) => boolean` | Tests whether a declared range already admits a published version. |
298
+ | `nameToGuide` | function | `(name: string) => string` | Derives the guide mirror path a package name answers for. |
299
+ | `planToSummary` | function | `(plan: Plan) => PlanSummary` | Projects a plan into its tally by artifact origin. |
300
+ | `renderSkillPointer` | function | `(canonical: string, name: string) => string \| undefined` | Renders the `SKILL.md` pointer a target carries in place of a canonical skill. |
301
+ | `scanManifestTokens` | function | `(text: string) => readonly ManifestToken[] \| undefined` | Scans manifest text for its strings and object braces, in order. |
302
+ | `selectGroups` | function | `(groups?: readonly Group[]) => readonly Group[]` | Selects the groups a compile covers, in plan order. |
303
+ | `selectHostPaths` | function | `(paths: readonly string[], name: string) => readonly string[]` | Selects the host paths a named workspace vendors. |
304
+ | `serializeTypeScriptString` | function | `(value: string) => string` | Serializes one string as a single-quoted TypeScript literal. |
305
+ | `srcToRoot` | function | `(src: readonly Environment[]) => Environment \| undefined` | Selects the single published environment a package root points at. |
306
+
307
+ | Name | Kind | Signature | Summary |
308
+ | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
309
+ | `collectSurfaceCollisions` | function | `(claims: readonly SurfaceClaim[]) => readonly SurfaceCollision[]` | Collects bare names claimed by distinct owners in sorted order. |
310
+ | `collectSurfaceConflicts` | function | `(owner: string, exports: Readonly<Record<string, readonly string[]>>) => readonly SurfaceConflict[]` | Collects the bare names one owner exports from two or more of its environments. |
311
+ | `compareSurfaceCollisions` | function | `(collisions: readonly SurfaceCollision[], record: readonly SurfaceCollision[]) => readonly SurfaceFinding[]` | Compares collisions with the record and reports errors, recorded subsets, and closures. |
296
312
 
297
313
  #### Compilers
298
314
 
299
- | Name | Kind | Summary |
300
- | ----------------------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
301
- | `applyOverrides` | function | Replaces the content of every drafted artifact an override names. |
302
- | `artifactsToQuestions` | function | Measures a drafted artifact list against the laws a whole plan decides. |
303
- | `blueprintToConfigArtifacts` | function | Compiles every artifact in the `configs` group. |
304
- | `blueprintToDevDependencies` | function | Projects a blueprint into the development dependencies its manifest declares. |
305
- | `blueprintToToolchainHolds` | function | Projects a blueprint into the toolchain holds its browser frameworks require. |
306
- | `blueprintToDocumentArtifacts` | function | Compiles the generated workspace's root documentation. |
307
- | `blueprintToExports` | function | Projects published environments and sheets into the manifest export map. |
308
- | `blueprintToFaces` | function | Projects a blueprint into browser extensions restricted to occupied browser axes. |
309
- | `blueprintToGuideArtifacts` | function | Compiles the generated workspace's guide index. |
310
- | `blueprintToHostArtifacts` | function | Compiles the vendored host artifacts a workspace plans. |
311
- | `blueprintToMachinery` | function | Derives the host-specific machinery a generated root Vite configuration carries. |
312
- | `blueprintToManifest` | function | Compiles a blueprint into its `package.json` content. |
313
- | `blueprintToManifestOverrides` | function | Projects the scoped npm overrides required by a selected browser showcase. |
314
- | `blueprintToOrchestrationArtifacts` | function | Compiles the blueprint-dependent orchestration artifacts. |
315
- | `blueprintToQuestions` | function | Measures a blueprint against every law its own fields decide. |
316
- | `blueprintToRootTsconfig` | function | Compiles the root TypeScript configuration for a blueprint. |
317
- | `blueprintToProjects` | function | Projects a blueprint into the project labels its root Vitest configuration registers. |
318
- | `blueprintToOptimizedDependencies` | function | Compiles the browser projects' pre-bundled dependency list for a blueprint. |
319
- | `blueprintToRootVite` | function | Compiles the root Vite and Vitest configuration for a blueprint. |
320
- | `blueprintToScripts` | function | Projects a blueprint into the scripts its manifest declares. |
321
- | `blueprintToSheets` | function | Projects a blueprint into its validated sheet-face names in stable order. |
322
- | `blueprintToSourceArtifacts` | function | Compiles every artifact in the `source` group. |
323
- | `blueprintToTestArtifacts` | function | Compiles every artifact in the `tests` group that is not vendored from the host. |
324
- | `blueprintToWritableScripts` | function | Projects a blueprint into the manifest scripts a region write may replace. |
325
- | `dependenciesToQuestions` | function | Measures one declared package list against the name and range syntax it accepts. |
326
- | `insertManifestDependencies` | function | Inserts dependencies a package manifest does not declare into the section each one names. |
327
- | `insertManifestSection` | function | Inserts dependencies into one section of package manifest text. |
328
- | `overridesToQuestions` | function | Measures a blueprint's overrides against the artifacts drafted for it. |
329
- | `pathToCondition` | function | Builds one `exports` condition block for a built environment. |
330
- | `planToFindings` | function | Compares a plan against a target's current content. |
331
- | `planToHash` | function | Computes a plan's content identity. |
332
- | `replaceManifestRanges` | function | Replaces the runtime and development dependency ranges in package manifest text, and never a peer range. |
333
- | `replaceManifestOverride` | function | Replaces one npm override leaf in manifest text, inserting its absent ancestors. |
334
- | `replaceManifestOverrides` | function | Replaces selected npm override leaves while preserving every byte outside the edited path. |
335
- | `replaceManifestScripts` | function | Replaces named script values in package manifest text. |
336
- | `replacePlanRanges` | function | Replaces dependency ranges in a plan's manifest and recomputes its identity. |
337
- | `srcToEntry` | function | Projects a published selection into the manifest's entry fields. |
338
- | `srcToExports` | function | Projects a published selection into the manifest's `exports` map. |
315
+ | Name | Kind | Signature | Summary |
316
+ | ----------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
317
+ | `applyOverrides` | function | `(artifacts: readonly Artifact[], overrides: readonly Override[]) => readonly Artifact[]` | Replaces the content of every drafted artifact an override names. |
318
+ | `artifactsToQuestions` | function | `(artifacts: readonly Artifact[]) => readonly Question[]` | Measures a drafted artifact list against the laws a whole plan decides. |
319
+ | `blueprintToConfigArtifacts` | function | `(blueprint: Blueprint) => readonly Artifact[]` | Compiles every artifact in the `configs` group. |
320
+ | `blueprintToDevDependencies` | function | `(blueprint: Blueprint) => Readonly<Record<string, string>>` | Projects a blueprint into the development dependencies its manifest declares. |
321
+ | `blueprintToToolchainHolds` | function | `(blueprint: Blueprint) => Readonly<Record<string, ToolchainHold>>` | Projects a blueprint into the toolchain holds its browser frameworks require. |
322
+ | `blueprintToDocumentArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's root documentation. |
323
+ | `blueprintToExports` | function | `(blueprint: Blueprint) => Readonly<Record<string, unknown>>` | Projects published environments and sheets into the manifest export map. |
324
+ | `blueprintToFaces` | function | `(blueprint: Blueprint) => readonly BrowserExtension[]` | Projects a blueprint into browser extensions restricted to occupied browser axes. |
325
+ | `blueprintToGuideArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the generated workspace's guide index. |
326
+ | `blueprintToHostArtifacts` | function | `(blueprint: Blueprint) => readonly Artifact[]` | Compiles the vendored host artifacts a workspace plans. |
327
+ | `blueprintToMachinery` | function | `(blueprint: Blueprint) => ViteMachinery` | Derives the host-specific machinery a generated root Vite configuration carries. |
328
+ | `blueprintToManifest` | function | `(blueprint: Blueprint) => string` | Compiles a blueprint into its `package.json` content. |
329
+ | `blueprintToManifestOverrides` | function | `(blueprint: Blueprint) => Readonly<Record<string, Readonly<Record<string, string>>>>` | Projects the scoped npm overrides required by a selected browser showcase. |
330
+ | `blueprintToOrchestrationArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles the blueprint-dependent orchestration artifacts. |
331
+ | `blueprintToQuestions` | function | `(blueprint: Blueprint) => readonly Question[]` | Measures a blueprint against every law its own fields decide. |
332
+ | `blueprintToRootTsconfig` | function | `(blueprint: Blueprint) => string` | Compiles the root TypeScript configuration for a blueprint. |
333
+ | `blueprintToProjects` | function | `(blueprint: Blueprint) => readonly string[]` | Projects a blueprint into the project labels its root Vitest configuration registers. |
334
+ | `blueprintToOptimizedDependencies` | function | `(blueprint: Blueprint) => string` | Compiles the browser projects' pre-bundled dependency list for a blueprint. |
335
+ | `blueprintToRootVite` | function | `(blueprint: Blueprint) => string` | Compiles the root Vite and Vitest configuration for a blueprint. |
336
+ | `blueprintToScripts` | function | `(blueprint: Blueprint) => Readonly<Record<string, string>>` | Projects a blueprint into the scripts its manifest declares. |
337
+ | `blueprintToSheets` | function | `(blueprint: Blueprint) => readonly string[]` | Projects a blueprint into its validated sheet-face names in stable order. |
338
+ | `blueprintToSourceArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles every artifact in the `source` group. |
339
+ | `blueprintToTestArtifacts` | function | `(blueprint: Blueprint) => readonly ContentArtifact[]` | Compiles every artifact in the `tests` group that is not vendored from the host. |
340
+ | `blueprintToWritableScripts` | function | `(blueprint: Blueprint) => readonly ManifestScript[]` | Projects a blueprint into the manifest scripts a region write may replace. |
341
+ | `dependenciesToQuestions` | function | `(dependencies: readonly Dependency[], field: string, name: RegExp, range: RegExp) => readonly Question[]` | Measures one declared package list against the name and range syntax it accepts. |
342
+ | `insertManifestDependencies` | function | `(manifest: string, additions: DependencyPinSet) => string \| undefined` | Inserts dependencies a package manifest does not declare into the section each one names. |
343
+ | `insertManifestSection` | function | `(manifest: string, section: 'dependencies' \| 'devDependencies', dependencies: readonly Dependency[], present: boolean) => string \| undefined` | Inserts dependencies into one section of package manifest text. |
344
+ | `overridesToQuestions` | function | `(overrides: readonly Override[], artifacts: readonly Artifact[]) => readonly Question[]` | Measures a blueprint's overrides against the artifacts drafted for it. |
345
+ | `pathToCondition` | function | `(path: string, formats: readonly BuildFormat[]) => Readonly<Record<string, unknown>>` | Builds one `exports` condition block for a built environment. |
346
+ | `planToFindings` | function | `(plan: Plan, current: Snapshot) => readonly Finding[]` | Compares a plan against a target's current content. |
347
+ | `planToHash` | function | `(plan: Plan) => string \| undefined` | Computes a plan's content identity. |
348
+ | `replaceManifestRanges` | function | `(manifest: string, pins: DependencyPinSet) => string \| undefined` | Replaces the runtime and development dependency ranges in package manifest text, and never a peer range. |
349
+ | `replaceManifestOverride` | function | `(manifest: string, path: readonly string[], range: string) => string \| undefined` | Replaces one npm override leaf in manifest text, inserting its absent ancestors. |
350
+ | `replaceManifestOverrides` | function | `(manifest: string, overrides: Readonly<Record<string, Readonly<Record<string, string>>>>) => string \| undefined` | Replaces selected npm override leaves while preserving every byte outside the edited path. |
351
+ | `replaceManifestScripts` | function | `(manifest: string, scripts: readonly ManifestScript[]) => string \| undefined` | Replaces named script values in package manifest text. |
352
+ | `replacePlanRanges` | function | `(plan: Plan, pins: DependencyPinSet) => Plan \| undefined` | Replaces dependency ranges in a plan's manifest and recomputes its identity. |
353
+ | `srcToEntry` | function | `(src: readonly Environment[]) => { readonly main: string; readonly module: string; readonly types?: string; }` | Projects a published selection into the manifest's entry fields. |
354
+ | `srcToExports` | function | `(src: readonly Environment[]) => Readonly<Record<string, unknown>>` | Projects a published selection into the manifest's `exports` map. |
339
355
 
340
356
  #### Factories
341
357
 
342
- | Name | Kind | Summary |
343
- | ----------------- | -------- | ---------------------------------------------------------------------------------- |
344
- | `createBlueprint` | function | Constructs a `Blueprint` from a name and the fields that differ from the defaults. |
358
+ | Name | Kind | Signature | Summary |
359
+ | ----------------- | -------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
360
+ | `createBlueprint` | function | `(name: string, input?: Partial<Omit<Blueprint, 'name'>>) => Blueprint` | Constructs a `Blueprint` from a name and the fields that differ from the defaults. |
345
361
 
346
362
  #### Classes
347
363
 
348
- | Name | Kind | Summary |
349
- | --------------- | ----- | -------------------------------------------------------------------------------------- |
350
- | `Compiler` | class | Represents the compile spine: draft, gate, pin, run in that order over a blueprint. |
351
- | `ScaffoldError` | class | Represents the one error this package throws, carrying the coded reason it was raised. |
364
+ | Name | Kind | Signature | Summary |
365
+ | --------------- | ----- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
366
+ | `Compiler` | class | `new (options?: CompilerOptions) => CompilerInterface` | Represents the compile spine: draft, gate, pin, run in that order over a blueprint. |
367
+ | `ScaffoldError` | class | `new (code: ScaffoldErrorCode, message: string, context?: unknown) => ScaffoldError` | Represents the one error this package throws, carrying the coded reason it was raised. |
352
368
 
353
369
  ### Server
354
370
 
@@ -357,152 +373,152 @@ Exported from `@orkestrel/scaffold/server`, and reachable from
357
373
 
358
374
  #### Types
359
375
 
360
- | Name | Kind | Summary |
361
- | ---------------------- | ---- | ----------------------------------------------------- |
362
- | `MaterializerEventMap` | type | Represents the materializer's observation channel. |
363
- | `UpstreamEventMap` | type | Represents the upstream reader's observation channel. |
376
+ | Name | Kind | Signature | Summary |
377
+ | ---------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
378
+ | `MaterializerEventMap` | type | `{ readonly write: readonly [path: string]; readonly remove: readonly [path: string]; readonly finish: readonly [result: MaterializeResult]; readonly error: readonly [error: unknown]; readonly destroy: readonly []; }` | Represents the materializer's observation channel. |
379
+ | `UpstreamEventMap` | type | `{ readonly release: readonly [release: Release]; readonly mirror: readonly [mirror: Mirror]; readonly file: readonly [file: HostFile]; readonly error: readonly [error: unknown]; readonly destroy: readonly []; }` | Represents the upstream reader's observation channel. |
380
+ | `SurfaceLoader` | type | `(specifier: string) => unknown` | Loads a module by specifier for validated surface reflection. |
364
381
 
365
382
  #### Interfaces
366
383
 
367
- | Name | Kind | Summary |
368
- | ------------------------ | --------- | ------------------------------------------------------------------------------------------------- |
369
- | `BytesReadResult` | interface | Reports the outcome of one bounded read whose body is taken as exact bytes. |
370
- | `Host` | interface | Represents a whole vendored host supplied as a value: the membership beside the bytes filling it. |
371
- | `HostInventory` | interface | Represents the committed vendored-file inventory as one call's reads are decided against. |
372
- | `HostManifest` | interface | Represents the complete vendored-host inventory. |
373
- | `HostStageOptions` | interface | Configures the committed inventory baseline and staging reports. |
374
- | `ManifestEntry` | interface | Represents one file record of the vendored host's manifest. |
375
- | `MaterializeResult` | interface | Reports the outcome of one mutation of a target. |
376
- | `MaterializerInterface` | interface | Describes the mutation contract: the package's only filesystem writer. |
377
- | `MaterializerOptions` | interface | Represents the options for the materializer. |
378
- | `ReadAllowanceInterface` | interface | Describes the byte allowance one upstream call spends across every read it makes. |
379
- | `SurfaceCollision` | interface | Represents a Surface name claimed by distinct package guides. |
380
- | `TextReadResult` | interface | Reports the outcome of one bounded read whose body is taken as text. |
381
- | `Worktree` | interface | Describes what git reports about a target's working tree. |
382
- | `UpstreamInterface` | interface | Describes the upstream contract: the package's only network reader, and it never writes. |
383
- | `UpstreamOptions` | interface | Represents the options for the upstream reader. |
384
- | `WriteAnchor` | interface | Represents one physical directory identity captured across a write transaction. |
385
- | `WriteDirectoryResult` | interface | Reports the final directory anchor of a write transaction and the subset one call created. |
386
- | `WriteExpectation` | interface | Represents one destination snapshot captured before a write and required to survive it. |
387
- | `WritePrecondition` | interface | Describes the narrower caller-observed destination state a write transaction must still match. |
388
-
389
- The inventory contracts carry these data members.
390
-
391
- | Member | Contract |
392
- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
393
- | `HostManifest.surface` | Required readonly `SurfaceCollision[]`, sorted by name; each collision has distinct sorted owners and is included in the manifest digest. |
394
- | `HostStageOptions.inventory` | Optional checkout-relative inventory path. Default: `HOST_INVENTORY_PATH` (`host.json`). |
395
- | `HostStageOptions.establish` | Optional boolean. If `true`, an absent inventory establishes the baseline; if `false`, staging refuses it. Default: `false`. |
396
- | `HostStageOptions.report` | Optional callback receiving the baseline location or its absence. Default: no reporting. |
384
+ | Name | Kind | Signature | Summary |
385
+ | ------------------------ | --------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
386
+ | `BytesReadResult` | interface | `{ lookup, hex, note, unreachable? }` | Reports the outcome of one bounded read whose body is taken as exact bytes. |
387
+ | `Host` | interface | `{ manifest, bytes }` | Represents a whole vendored host supplied as a value: the membership beside the bytes filling it. |
388
+ | `HostInventory` | interface | `{ lookup, digests, duplicates, note, surface, unreachable? }` | Represents the committed vendored-file inventory as one call's reads are decided against. |
389
+ | `HostManifest` | interface | `{ entries, roots, surface, digest }` | Represents the complete vendored-host inventory. |
390
+ | `HostStageOptions` | interface | `{ inventory?, establish?, report? }` | Configures the committed inventory baseline and staging reports. |
391
+ | `ManifestEntry` | interface | `{ storage, destination, executable, digest }` | Represents one file record of the vendored host's manifest. |
392
+ | `MaterializeResult` | interface | `{ target, written, skipped, removed }` | Reports the outcome of one mutation of a target. |
393
+ | `MaterializerInterface` | interface | `{ emitter, audit(), materialize(), repair(), mirror(), catalog(), declare(), remove(), destroy() }` | Describes the mutation contract: the package's only filesystem writer. |
394
+ | `MaterializerOptions` | interface | `{ host?, on?, error? }` | Represents the options for the materializer. |
395
+ | `ReadAllowanceInterface` | interface | `{ remaining, spend() }` | Describes the byte allowance one upstream call spends across every read it makes. |
396
+ | `SurfaceModule` | interface | `{ createGuide, createSource, extractSourceLines }` | Describes the guide module functions required by surface reflection. |
397
+ | `TextReadResult` | interface | `{ lookup, content, note, unreachable? }` | Reports the outcome of one bounded read whose body is taken as text. |
398
+ | `Worktree` | interface | `{ tracked, dirty }` | Describes what git reports about a target's working tree. |
399
+ | `UpstreamInterface` | interface | `{ emitter, lookup(), fetch(), read(), catalog(), inventory(), destroy() }` | Describes the upstream contract: the package's only network reader, and it never writes. |
400
+ | `UpstreamOptions` | interface | `{ repository?, registry?, concurrency?, retries?, limit?, budget?, on?, error? }` | Represents the options for the upstream reader. |
401
+ | `WriteAnchor` | interface | `{ path, device, inode }` | Represents one physical directory identity captured across a write transaction. |
402
+ | `WriteDirectoryResult` | interface | `{ anchor, created }` | Reports the final directory anchor of a write transaction and the subset one call created. |
403
+ | `WriteExpectation` | interface | `{ path, shape, device?, inode?, modified?, size?, digest? }` | Represents one destination snapshot captured before a write and required to survive it. |
404
+ | `WritePrecondition` | interface | `{ path, shape, digest? }` | Describes the narrower caller-observed destination state a write transaction must still match. |
397
405
 
398
406
  #### Constants
399
407
 
400
- | Name | Kind | Summary |
401
- | ----------------------------------- | ----- | ----------------------------------------------------------------------------------------------------- |
402
- | `BRANCH_PATTERN` | const | Matches the Git branch syntax the repository endpoint accepts. |
403
- | `DEFAULT_BRANCH` | const | Holds the repository branch a raw content read addresses when a caller names none. |
404
- | `DEFAULT_REGISTRY_BASE` | const | Holds the registry a version read addresses when a caller names none. |
405
- | `DEFAULT_REPOSITORY_BASE` | const | Holds the raw content host a repository read addresses when a caller names none. |
406
- | `DEFAULT_UPSTREAM_CONCURRENCY` | const | Sets the simultaneous upstream requests a reader opens with, under `MAX_UPSTREAM_CONCURRENCY`. |
407
- | `DEFAULT_UPSTREAM_RETRIES` | const | Sets the retries one upstream request is given when a caller names none. |
408
- | `DEFAULT_UPSTREAM_TIMEOUT` | const | Sets the timeout one upstream request is given when a caller names none, in milliseconds. |
409
- | `DIGEST_PATTERN` | const | Matches the exact SHA-256 syntax a digest is stated in: sixty-four lowercase hexadecimal digits. |
410
- | `DRIVE_PATTERN` | const | Matches the drive prefix a Windows host path may open with. |
411
- | `INVALID_SEGMENT_CHARACTER_PATTERN` | const | Matches the visible characters no host path segment may carry. |
412
- | `MANIFEST_NAME` | const | Reserves the metadata name a staged vendored host writes at its own root. |
413
- | `MAX_BRANCH_LENGTH` | const | Caps the characters one repository branch may carry. |
414
- | `MAX_ENDPOINT_LENGTH` | const | Caps the characters one caller-supplied upstream endpoint may carry. |
415
- | `MAX_INVENTORY_PATHS` | const | Caps the paths one target's working-tree inventory may report. |
416
- | `MAX_PATH_DEPTH` | const | Caps the segments one host path may carry. |
417
- | `MAX_PATH_SEGMENT_BYTES` | const | Caps the UTF-8 bytes one host path segment may encode to. |
418
- | `MAX_UPSTREAM_CONCURRENCY` | const | Caps the simultaneous upstream requests. |
419
- | `MAX_UPSTREAM_RETRIES` | const | Caps the retries one upstream request may be given after a transport fault. |
420
- | `MAX_UPSTREAM_TIMEOUT` | const | Caps the timeout one upstream request may be given, in milliseconds. |
421
- | `ORKESTREL_SCOPE` | const | Names the npm scope and repository owner the fleet's packages and sources are published under. |
422
- | `PACKUMENT_MEDIA_TYPE` | const | Names the media type that selects the registry's abbreviated packument. |
423
- | `RESERVED_SEGMENT_PATTERN` | const | Matches the Windows device names that stay reserved even when an extension follows. |
424
- | `SCAFFOLD_REPOSITORY` | const | Names the repository this package's own vendored files are served from. |
425
- | `UNREADABLE_VERSION_NOTE` | const | Holds the note a release carries when its packument names no readable version under the `latest` tag. |
408
+ | Name | Kind | Signature | Summary |
409
+ | ----------------------------------- | ----- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
410
+ | `BRANCH_PATTERN` | const | `RegExp` | Matches the Git branch syntax the repository endpoint accepts. |
411
+ | `DEFAULT_BRANCH` | const | `"main"` | Holds the repository branch a raw content read addresses when a caller names none. |
412
+ | `DEFAULT_REGISTRY_BASE` | const | `"https://registry.npmjs.org"` | Holds the registry a version read addresses when a caller names none. |
413
+ | `DEFAULT_REPOSITORY_BASE` | const | `"https://raw.githubusercontent.com"` | Holds the raw content host a repository read addresses when a caller names none. |
414
+ | `DEFAULT_UPSTREAM_CONCURRENCY` | const | `6` | Sets the simultaneous upstream requests a reader opens with, under `MAX_UPSTREAM_CONCURRENCY`. |
415
+ | `DEFAULT_UPSTREAM_RETRIES` | const | `0` | Sets the retries one upstream request is given when a caller names none. |
416
+ | `DEFAULT_UPSTREAM_TIMEOUT` | const | `10000` | Sets the timeout one upstream request is given when a caller names none, in milliseconds. |
417
+ | `DIGEST_PATTERN` | const | `RegExp` | Matches the exact SHA-256 syntax a digest is stated in: sixty-four lowercase hexadecimal digits. |
418
+ | `DRIVE_PATTERN` | const | `RegExp` | Matches the drive prefix a Windows host path may open with. |
419
+ | `INVALID_SEGMENT_CHARACTER_PATTERN` | const | `RegExp` | Matches the visible characters no host path segment may carry. |
420
+ | `MANIFEST_NAME` | const | `"manifest.json"` | Reserves the metadata name a staged vendored host writes at its own root. |
421
+ | `MAX_BRANCH_LENGTH` | const | `255` | Caps the characters one repository branch may carry. |
422
+ | `MAX_ENDPOINT_LENGTH` | const | `2048` | Caps the characters one caller-supplied upstream endpoint may carry. |
423
+ | `MAX_INVENTORY_PATHS` | const | `100000` | Caps the paths one target's working-tree inventory may report. |
424
+ | `MAX_PATH_DEPTH` | const | `64` | Caps the segments one host path may carry. |
425
+ | `MAX_PATH_SEGMENT_BYTES` | const | `255` | Caps the UTF-8 bytes one host path segment may encode to. |
426
+ | `MAX_UPSTREAM_CONCURRENCY` | const | `64` | Caps the simultaneous upstream requests. |
427
+ | `MAX_UPSTREAM_RETRIES` | const | `5` | Caps the retries one upstream request may be given after a transport fault. |
428
+ | `MAX_UPSTREAM_TIMEOUT` | const | `300000` | Caps the timeout one upstream request may be given, in milliseconds. |
429
+ | `ORKESTREL_SCOPE` | const | `"orkestrel"` | Names the npm scope and repository owner the fleet's packages and sources are published under. |
430
+ | `PACKUMENT_MEDIA_TYPE` | const | `"application/vnd.npm.install-v1+json"` | Names the media type that selects the registry's abbreviated packument. |
431
+ | `RESERVED_SEGMENT_PATTERN` | const | `RegExp` | Matches the Windows device names that stay reserved even when an extension follows. |
432
+ | `SCAFFOLD_REPOSITORY` | const | `"scaffold"` | Names the repository this package's own vendored files are served from. |
433
+ | `UNREADABLE_VERSION_NOTE` | const | `"the answer carries no readable latest version"` | Holds the note a release carries when its packument names no readable version under the `latest` tag. |
426
434
 
427
435
  #### Guards
428
436
 
429
- | Name | Kind | Summary |
430
- | ----------------------- | -------- | ----------------------------------------------------------------------------------- |
431
- | `isBranch` | const | Narrows a value to a Git branch the repository endpoint accepts. |
432
- | `isCatalogEntries` | const | Narrows a value to a bounded list of fleet catalog rows. |
433
- | `isDependencies` | const | Narrows a value to a bounded list of declared runtime dependencies. |
434
- | `isDependencyNames` | const | Narrows a value to a bounded list of `@orkestrel` package names. |
435
- | `isDigest` | const | Narrows a value to one exact SHA-256 digest. |
436
- | `isEndpoint` | const | Narrows a value to a bounded upstream endpoint. |
437
- | `isFilesystemPath` | function | Narrows a value to a path naming a location on this host. |
438
- | `isHost` | const | Narrows a value to one `Host`. |
439
- | `isHostManifest` | const | Narrows a value to one `HostManifest`. |
440
- | `isInventory` | function | Narrows a value to a working-tree inventory within the limit one target may report. |
441
- | `isManifestEntry` | const | Narrows a value to one `ManifestEntry`. |
442
- | `isManifestRegionSet` | const | Narrows a value to one `ManifestRegionSet`. |
443
- | `isMaterializerHooks` | const | Narrows a value to the materializer's initial listener record. |
444
- | `isMaterializerOptions` | const | Narrows a value to `MaterializerOptions`. |
445
- | `isMirrors` | const | Narrows a value to a bounded list of fetched guide mirrors. |
446
- | `isPaths` | const | Narrows a value to a bounded list of target-relative paths. |
447
- | `isWorktree` | const | Narrows a value to a `Worktree`. |
448
- | `isTimeout` | const | Narrows a value to a per-request timeout in milliseconds. |
449
- | `isUpstreamHooks` | const | Narrows a value to the upstream reader's initial listener record. |
450
- | `isUpstreamOptions` | const | Narrows a value to `UpstreamOptions`. |
437
+ | Name | Kind | Signature | Summary |
438
+ | ----------------------- | -------- | ------------------------------------------------- | ----------------------------------------------------------------------------------- |
439
+ | `isBranch` | const | `Guard<string>` | Narrows a value to a Git branch the repository endpoint accepts. |
440
+ | `isCatalogEntries` | const | `Guard<readonly CatalogEntry[]>` | Narrows a value to a bounded list of fleet catalog rows. |
441
+ | `isDependencies` | const | `Guard<readonly Dependency[]>` | Narrows a value to a bounded list of declared runtime dependencies. |
442
+ | `isDependencyNames` | const | `Guard<readonly string[]>` | Narrows a value to a bounded list of `@orkestrel` package names. |
443
+ | `isDigest` | const | `Guard<string>` | Narrows a value to one exact SHA-256 digest. |
444
+ | `isEndpoint` | const | `Guard<string>` | Narrows a value to a bounded upstream endpoint. |
445
+ | `isFilesystemPath` | function | `(value: unknown) => value is string` | Narrows a value to a path naming a location on this host. |
446
+ | `isHost` | const | `Guard<Host>` | Narrows a value to one `Host`. |
447
+ | `isHostManifest` | const | `Guard<HostManifest>` | Narrows a value to one `HostManifest`. |
448
+ | `isInventory` | function | `(value: unknown) => value is readonly unknown[]` | Narrows a value to a working-tree inventory within the limit one target may report. |
449
+ | `isManifestEntry` | const | `Guard<ManifestEntry>` | Narrows a value to one `ManifestEntry`. |
450
+ | `isManifestRegionSet` | const | `Guard<ManifestRegionSet>` | Narrows a value to one `ManifestRegionSet`. |
451
+ | `isMaterializerHooks` | const | `Guard<EmitterHooks<MaterializerEventMap>>` | Narrows a value to the materializer's initial listener record. |
452
+ | `isMaterializerOptions` | const | `Guard<MaterializerOptions>` | Narrows a value to `MaterializerOptions`. |
453
+ | `isMirrors` | const | `Guard<readonly Mirror[]>` | Narrows a value to a bounded list of fetched guide mirrors. |
454
+ | `isPaths` | const | `Guard<readonly string[]>` | Narrows a value to a bounded list of target-relative paths. |
455
+ | `isSurfaceModule` | function | `(value: unknown) => value is SurfaceModule` | Narrows a value to the callable guide functions surface reflection requires. |
456
+ | `isWorktree` | const | `Guard<Worktree>` | Narrows a value to a `Worktree`. |
457
+ | `isTimeout` | const | `Guard<number>` | Narrows a value to a per-request timeout in milliseconds. |
458
+ | `isUpstreamHooks` | const | `Guard<EmitterHooks<UpstreamEventMap>>` | Narrows a value to the upstream reader's initial listener record. |
459
+ | `isUpstreamOptions` | const | `Guard<UpstreamOptions>` | Narrows a value to `UpstreamOptions`. |
451
460
 
452
461
  #### Helpers
453
462
 
454
- | Name | Kind | Summary |
455
- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
456
- | `climbRealPath` | function | Climbs from an absolute path to its deepest existing ancestor and resolves it through every link. |
457
- | `collectIndexed` | function | Places each result at the index its entry names, in a fresh array. |
458
- | `computeDigest` | function | Computes the SHA-256 digest of text. |
459
- | `computeFileDigest` | function | Computes the SHA-256 digest of one file's exact bytes. |
460
- | `computeManifestDigest` | function | Computes the digest of a vendored host's declared membership. |
461
- | `decodeHexText` | function | Decodes exact bytes stated in hexadecimal as strict UTF-8 text. |
462
- | `filesToHost` | function | Assembles a whole vendored host from live files and the installed floor. |
463
- | `hexToDigest` | function | Projects exact bytes stated in hexadecimal to their SHA-256 digest. |
464
- | `isExactCaseFile` | function | Tests whether a path is a physical file with exact on-disk casing. |
465
- | `isPhysicalDirectory` | function | Tests whether a path is a physical directory this package will read or write into. |
466
- | `isPhysicalFile` | function | Tests whether a path is a physical file this package will read or replace. |
467
- | `isVacant` | function | Tests whether a target is safe to write a fresh workspace into. |
468
- | `listAncestors` | function | Lists a path followed by each directory above it, nearest first. |
469
- | `listCanonPaths` | function | Lists the canon paths a target holds, filtered to a plan's groups. |
470
- | `listDirectories` | function | Lists a directory's descendant directories as sorted root-relative paths. |
471
- | `listFiles` | function | Lists a directory's files as sorted root-relative paths. |
472
- | `matchesAnchor` | function | Tests whether a path still holds the captured directory identity. |
473
- | `matchesExecutablePath` | function | Tests whether a vendored path is one a target receives executable. |
474
- | `matchesExpectation` | function | Tests whether a destination still holds what was captured of it. |
475
- | `matchesGitPath` | function | Tests whether a path addresses a target's own repository metadata. |
476
- | `matchesMissingPath` | function | Tests whether a caught filesystem error reports an absent path. |
477
- | `matchesPrecondition` | function | Tests whether a destination still matches the narrower state a caller observed. |
478
- | `matchesProtectedPath` | function | Tests whether a target-relative path is one no verb may delete. |
479
- | `matchesSensitivePath` | function | Tests whether a path names local configuration or a credential. |
480
- | `pathToStorage` | function | Projects a target-relative path to the storage name a vendored host holds it under. |
481
- | `pruneEmptiedDirectories` | function | Removes every directory one set of deletions emptied. |
482
- | `readAnchor` | function | Captures one directory's physical identity. |
483
- | `readExpectation` | function | Captures what one destination holds before a write. |
484
- | `readFileHex` | function | Reads one contained file as its exact bytes in lowercase hexadecimal. |
485
- | `readFileText` | function | Reads one contained file as bounded UTF-8 text. |
486
- | `readHostFloor` | function | Reads the installed vendored host floor as a value. |
487
- | `readHostManifest` | function | Reads a vendored host's manifest, when it carries one. |
488
- | `readManifestEntry` | function | Derives one vendored-host manifest entry from a file in a checkout. |
489
- | `readSnapshot` | function | Reads a target's current bytes at the paths a plan claims. |
490
- | `readSurfaceBaseline` | function | Reads the Surface collision baseline from a committed inventory. |
491
- | `readSurfaceCollisions` | function | Reads bare Surface names claimed by distinct package guides. |
492
- | `resolveContainedPath` | function | Resolves a root-relative path and refuses one that leaves its root. |
493
- | `resolveRealPath` | function | Resolves a path through the real filesystem, keeping the part that does not exist yet. |
494
- | `stageBytes` | function | Stages the named destinations of a value host into a private root. |
495
- | `stageHost` | function | Stages a vendored host root from a real checkout. |
496
- | `stageInventory` | function | Stages the committed inventory of the files a vendored host carries. |
463
+ | Name | Kind | Signature | Summary |
464
+ | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
465
+ | `climbRealPath` | function | `(current: string, pending: readonly string[], depth: number) => string \| undefined` | Climbs from an absolute path to its deepest existing ancestor and resolves it through every link. |
466
+ | `collectIndexed` | function | `<TResult>(entries: ReadonlyArray<readonly [number, TResult]>) => readonly TResult[]` | Places each result at the index its entry names, in a fresh array. |
467
+ | `computeDigest` | function | `(content: string) => string` | Computes the SHA-256 digest of text. |
468
+ | `computeFileDigest` | function | `(path: string) => string \| undefined` | Computes the SHA-256 digest of one file's exact bytes. |
469
+ | `computeManifestDigest` | function | `(entries: readonly ManifestEntry[], roots: readonly string[], surface: readonly SurfaceCollision[]) => string` | Computes the digest of a vendored host's declared membership. |
470
+ | `decodeHexText` | function | `(hex: string) => string \| undefined` | Decodes exact bytes stated in hexadecimal as strict UTF-8 text. |
471
+ | `filesToHost` | function | `(files: readonly HostFile[], floor: Host) => Host \| undefined` | Assembles a whole vendored host from live files and the installed floor. |
472
+ | `hexToDigest` | function | `(hex: string) => string` | Projects exact bytes stated in hexadecimal to their SHA-256 digest. |
473
+ | `isExactCaseFile` | function | `(path: string) => boolean` | Tests whether a path is a physical file with exact on-disk casing. |
474
+ | `isPhysicalDirectory` | function | `(path: string) => boolean` | Tests whether a path is a physical directory this package will read or write into. |
475
+ | `isPhysicalFile` | function | `(path: string) => boolean` | Tests whether a path is a physical file this package will read or replace. |
476
+ | `isVacant` | function | `(target: string) => boolean` | Tests whether a target is safe to write a fresh workspace into. |
477
+ | `listAncestors` | function | `(path: string, limit?: number) => readonly string[]` | Lists a path followed by each directory above it, nearest first. |
478
+ | `listCanonPaths` | function | `(target: string, groups: readonly Group[]) => readonly string[]` | Lists the canon paths a target holds, filtered to a plan's groups. |
479
+ | `listDirectories` | function | `(root: string) => readonly string[]` | Lists a directory's descendant directories as sorted root-relative paths. |
480
+ | `listFiles` | function | `(root: string) => readonly string[]` | Lists a directory's files as sorted root-relative paths. |
481
+ | `matchesAnchor` | function | `(anchor: WriteAnchor) => boolean` | Tests whether a path still holds the captured directory identity. |
482
+ | `matchesExecutablePath` | function | `(path: string) => boolean` | Tests whether a vendored path is one a target receives executable. |
483
+ | `matchesExpectation` | function | `(expectation: WriteExpectation) => boolean` | Tests whether a destination still holds what was captured of it. |
484
+ | `matchesGitPath` | function | `(path: string) => boolean` | Tests whether a path addresses a target's own repository metadata. |
485
+ | `matchesMissingPath` | function | `(error: unknown) => boolean` | Tests whether a caught filesystem error reports an absent path. |
486
+ | `matchesPrecondition` | function | `(precondition: WritePrecondition) => boolean` | Tests whether a destination still matches the narrower state a caller observed. |
487
+ | `matchesProtectedPath` | function | `(path: string) => boolean` | Tests whether a target-relative path is one no verb may delete. |
488
+ | `matchesSensitivePath` | function | `(path: string) => boolean` | Tests whether a path names local configuration or a credential. |
489
+ | `pathToStorage` | function | `(path: string) => string` | Projects a target-relative path to the storage name a vendored host holds it under. |
490
+ | `pruneEmptiedDirectories` | function | `(target: string, removed: readonly string[]) => readonly string[]` | Removes every directory one set of deletions emptied. |
491
+ | `readAnchor` | function | `(path: string) => WriteAnchor \| undefined` | Captures one directory's physical identity. |
492
+ | `readExpectation` | function | `(path: string) => WriteExpectation \| undefined` | Captures what one destination holds before a write. |
493
+ | `readFileHex` | function | `(root: string, path: string, limit?: number) => string \| undefined` | Reads one contained file as its exact bytes in lowercase hexadecimal. |
494
+ | `readFileText` | function | `(root: string, path: string, limit?: number) => string \| undefined` | Reads one contained file as bounded UTF-8 text. |
495
+ | `readHostFloor` | function | `(root?: string) => Host` | Reads the installed vendored host floor as a value. |
496
+ | `readHostManifest` | function | `(host: string, name?: string) => HostManifest \| undefined` | Reads a vendored host's manifest, when it carries one. |
497
+ | `readManifestEntry` | function | `(destination: string, source: string) => ManifestEntry \| undefined` | Derives one vendored-host manifest entry from a file in a checkout. |
498
+ | `readSnapshot` | function | `(target: string, paths: readonly string[]) => Snapshot` | Reads a target's current bytes at the paths a plan claims. |
499
+ | `readSurfaceBaseline` | function | `(root: string, name?: string) => readonly SurfaceCollision[] \| undefined` | Reads the Surface collision baseline from a committed inventory. |
500
+ | `readSurfaceCollisions` | function | `(root: string) => ReadonlyMap<string, readonly string[]>` | Reads bare Surface names claimed by distinct package guides. |
501
+ | `readSurfaceClaims` | function | `(root: string, loader?: SurfaceLoader) => readonly SurfaceClaim[]` | Reads each immediate package guide's bare names under its file owner. |
502
+ | `readSurfaceCandidate` | function | `(root: string, loader?: SurfaceLoader) => SurfaceCandidate` | Reads a checkout's combined guide and barrel claims under its manifest owner. |
503
+ | `readSurfaceFile` | function | `(root: string \| Host, owner: string, label: string, loader?: SurfaceLoader) => SurfaceClaim \| undefined` | Reads one owner's `guides/<owner>.md` under a root, or from a verified host value, as a claim. |
504
+ | `readSurfaceGuide` | function | `(text: string, owner: string, source: string, loader?: SurfaceLoader) => SurfaceClaim` | Reads one guide's claims and reports parser refusals with its owner and source. |
505
+ | `readSurfaceModule` | function | `(loader?: SurfaceLoader) => SurfaceModule` | Loads and validates the guide functions required by surface reflection. |
506
+ | `readSurfaceRecord` | function | `(root: string) => readonly SurfaceCollision[]` | Reads a data root's verified collision record. |
507
+ | `resolveHostRoot` | function | `() => string` | Resolves the bundled host root from the executing module's location. |
508
+ | `resolveContainedPath` | function | `(root: string, path: string) => string \| undefined` | Resolves a root-relative path and refuses one that leaves its root. |
509
+ | `resolveRealPath` | function | `(path: string) => string \| undefined` | Resolves a path through the real filesystem, keeping the part that does not exist yet. |
510
+ | `stageBytes` | function | `(host: Host, root: string, destinations: readonly string[]) => readonly ManifestEntry[]` | Stages the named destinations of a value host into a private root. |
511
+ | `stageHost` | function | `(checkout: string, host: string, options?: HostStageOptions) => readonly ManifestEntry[]` | Stages a vendored host root from a real checkout. |
512
+ | `stageInventory` | function | `(checkout: string, path?: string) => HostManifest` | Stages the committed inventory of the files a vendored host carries. |
497
513
 
498
514
  #### Classes
499
515
 
500
- | Name | Kind | Summary |
501
- | ------------------ | ----- | --------------------------------------------------------------------------------------------- |
502
- | `Materializer` | class | Represents the mutation spine: read the vendored host, re-derive the target, stage, swap. |
503
- | `ReadAllowance` | class | Represents the byte allowance one upstream call spends across every read it makes. |
504
- | `Upstream` | class | Represents the reading spine: one bounded, unauthenticated, redirect-free request per answer. |
505
- | `WriteTransaction` | class | Represents one staged, reversible mutation of one target directory. |
516
+ | Name | Kind | Signature | Summary |
517
+ | ------------------ | ----- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
518
+ | `Materializer` | class | `new (options?: MaterializerOptions) => MaterializerInterface` | Represents the mutation spine: read the vendored host, re-derive the target, stage, swap. |
519
+ | `ReadAllowance` | class | `new (budget: number) => ReadAllowanceInterface` | Represents the byte allowance one upstream call spends across every read it makes. |
520
+ | `Upstream` | class | `new (options?: UpstreamOptions) => UpstreamInterface` | Represents the reading spine: one bounded, unauthenticated, redirect-free request per answer. |
521
+ | `WriteTransaction` | class | `new (target: string, paths: readonly string[], preconditions?: readonly WritePrecondition[]) => WriteTransaction` | Represents one staged, reversible mutation of one target directory. |
506
522
 
507
523
  ## Methods
508
524
 
@@ -541,13 +557,14 @@ publishes no interface and is documented directly.
541
557
 
542
558
  #### `UpstreamInterface`
543
559
 
544
- | Method | Summary |
545
- | --------- | ------------------------------------------------------------------------------------------- |
546
- | `lookup` | Looks up the highest release each declared range admits. |
547
- | `fetch` | Fetches each named package's guide, beside the local mirror it answers for. |
548
- | `read` | Reads each named vendored file from the repository, beside the target bytes it answers for. |
549
- | `catalog` | Catalogs the published fleet from the registry's organization package list. |
550
- | `destroy` | Tears the reader down, aborting every request in flight. Teardown is idempotent. |
560
+ | Method | Summary |
561
+ | ----------- | ------------------------------------------------------------------------------------------- |
562
+ | `lookup` | Looks up the highest release each declared range admits. |
563
+ | `fetch` | Fetches each named package's guide, beside the local mirror it answers for. |
564
+ | `read` | Reads each named vendored file from the repository, beside the target bytes it answers for. |
565
+ | `catalog` | Catalogs the published fleet from the registry's organization package list. |
566
+ | `inventory` | Reads the verified upstream inventory and its collision record. |
567
+ | `destroy` | Tears the reader down, aborting every request in flight. Teardown is idempotent. |
551
568
 
552
569
  #### `WriteTransaction`
553
570
 
@@ -562,13 +579,14 @@ publishes no interface and is documented directly.
562
579
 
563
580
  ## Command line
564
581
 
565
- Authority is the verb's: every verb except `audit` writes when it is typed, and no
582
+ Authority is the verb's: `audit` and `surface` read without writing, and no
566
583
  option grants a write.
567
584
 
568
585
  | Verb | Writes |
569
586
  | ----------- | ------------------------------------------------------------------------------------------ |
570
587
  | `new` | A whole workspace, into a target that holds nothing the plan would collide with |
571
588
  | `audit` | Nothing |
589
+ | `surface` | Nothing |
572
590
  | `repair` | Each planned path the target is missing or has let drift, and the range and script regions |
573
591
  | `catalog` | The package table, the guide mirrors, and the range region |
574
592
  | `overwrite` | Everything `repair` and `catalog` write, deletions, and missing planned dependencies |
@@ -603,7 +621,7 @@ A value `Host` can carry live host-owned bytes beside installed floor bytes for
603
621
  catalog paths. Each surface still contributes one baseline. Deferred paths are presence-only, and
604
622
  repair never writes their floor bytes.
605
623
 
606
- Every verb's machine-readable result carries `provenance`. The record names only the remote
624
+ Every verb that reads upstream carries `provenance` in its machine-readable result. The record names only the remote
607
625
  surfaces that the verb read. A host supplied by the `--from` option is absent because it comes from
608
626
  a local path.
609
627
 
@@ -616,6 +634,8 @@ scaffold <verb> [options]
616
634
  scaffold a workspace
617
635
  scaffold audit [--groups <list>] [--offline] [--from <path>] [--target <path>] [--json]
618
636
  report how the target compares to its plan, writing nothing
637
+ scaffold surface [<checkout>...] [--offline] [--from <path>] [--target <path>] [--json]
638
+ report fleet name collisions against the recorded baseline, writing nothing
619
639
  scaffold repair [--groups <list>] [--offline] [--from <path>] [--target <path>] [--json]
620
640
  write each planned path the target is missing or has let drift
621
641
  scaffold catalog [--all] [--from <path>] [--target <path>] [--json]
@@ -652,8 +672,8 @@ An option a verb does not list is refused by name rather than parsed and ignored
652
672
  one exception, because it replaces the run rather than modifying it: a command line carrying
653
673
  `--help` anywhere prints the whole reference and exits `0` before the line is read as a command, so
654
674
  no verb has to list it. Without the `--offline` option, every verb reaches the registry, and none of
655
- them invents a range when the read produces no answer. Dependency floors states what each verb reads
656
- and what it does then.
675
+ them invents a range when the read produces no answer. `surface` given `--from` reads that root
676
+ alone. Dependency floors states what each verb reads and what it does then.
657
677
 
658
678
  At their defaults, online runs contact `registry.npmjs.org` for scoped package packuments and the
659
679
  `/-/org/orkestrel/package` membership path. They contact `raw.githubusercontent.com` for guide
@@ -686,6 +706,108 @@ script on that basis.
686
706
  its whole condition, and scaffold writes `tests/distribution.test.ts` itself rather than waiting for
687
707
  you to. Limits states what makes that one proof generable when the others are not.
688
708
 
709
+ ### Check fleet names
710
+
711
+ Run `scaffold surface` before publishing a candidate checkout. The command reads every owner's
712
+ `## Surface` claims, groups the bare names that distinct owners claim into collisions, and compares
713
+ them with the collision record. It reads each source the way `catalog` does, from the freshest one
714
+ down to the bundled floor, and stops at the first that answers:
715
+
716
+ | Reading | Sources, freshest first |
717
+ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
718
+ | Membership | Every candidate, then the registry's organization list through `Upstream.catalog`, or the data root's catalog table when that read fails |
719
+ | Claims | The candidate's working tree, then the owner's guide on `main` through `Upstream.fetch`, then the data root's `guides/<owner>.md` |
720
+ | Record | A `--from` root's `manifest.json` or `host.json`, then scaffold's `host.json` on `main` through `Upstream.inventory`, then the bundled record |
721
+
722
+ An owner that no claim source answers for is `unread`, never an owner claiming nothing. The
723
+ registry's published package copy is in no order. `--offline` reads the bundled guides, catalog
724
+ table, and record without a request. `--from <path>` reads that root alone, without a request. A
725
+ missing or malformed record refuses the run. The bundled root and a built root, one carrying
726
+ `manifest.json`, are read through their verified inventory: a floor guide the inventory does not
727
+ declare is unread, and a declared file whose bytes do not match its digest refuses the run. A
728
+ checkout root without `manifest.json` is read by path.
729
+
730
+ The membership read is the first registry request, and the record read through
731
+ `Upstream.inventory` is the first repository request. When either produces no HTTP response, the
732
+ command reads nothing further and refuses with `FETCH`. A request produces no HTTP response when
733
+ `fetch` rejects before the response headers arrive: the host name does not resolve, the connection
734
+ is refused, the TLS handshake fails, the connection is reset or closed, or the timeout expires.
735
+ `URL` is the request's address and `CAUSE` the transport note, such as
736
+ `TypeError: fetch failed (ECONNREFUSED)`:
737
+
738
+ ```text
739
+ Surface registry is unreachable from this host: the organization package list at URL produced no answer: CAUSE. Use --offline to check against the bundled guides.
740
+ Surface repository is unreachable from this host: the vendored inventory at URL produced no answer: CAUSE. Use --offline to check against the bundled guides.
741
+ ```
742
+
743
+ A response that arrives is an answer rather than an outage, whatever follows it: an HTTP failure, a
744
+ malformed body, and a reset or timeout after the response headers arrive each leave that reading to
745
+ its floor source, and the run continues. The command gives each upstream read one attempt.
746
+
747
+ Each positional checkout contributes its `guides/<owner>.md` names together with every barrel
748
+ surface reflected from its immediate `src/<environment>` directories. Its package manifest names
749
+ the owner, with the `@orkestrel/` scope removed. The `--target` directory defaults to the working
750
+ directory and joins the candidates when it holds `package.json`. Candidates that share an owner
751
+ contribute their combined names, and candidate claims replace every other source for that owner,
752
+ including when the candidate claims no names. A name a candidate's barrels export from two or more
753
+ of its `src/<environment>` directories is a conflict: export it once from `src/core`, or give each
754
+ environment's export a distinct name. The record never holds a conflict, so a conflict fails every
755
+ run that reads its owner as a candidate.
756
+
757
+ A candidate refuses, naming its path, when its manifest is unreadable, when it has neither its guide
758
+ nor `src/`, when its guide exists but is not UTF-8 text within the artifact bound, or when a
759
+ TypeScript source under `src/` cannot be read. Only `.ts` files under `src/` are read, so a binary
760
+ asset there is ignored. A barrel holding a statement other than `export * from './module.js'`
761
+ refuses with the statement named, because the reflection follows nothing else and an incomplete
762
+ reading never reports clean. When `@orkestrel/guide` refuses a guide from any source, the command
763
+ refuses with `TARGET`, naming the owner and the source and carrying the parser's message.
764
+
765
+ Compare unpublished candidates together with this command:
766
+
767
+ ```sh
768
+ scaffold surface ../router ../server --from . --json
769
+ ```
770
+
771
+ The comparison uses the bare identifier, case included, across declaration keywords and
772
+ environments. A name claimed by distinct owners is a collision. A collision absent from the record,
773
+ or carrying an owner absent from its recorded owner set, has `error` standing. A collision with the
774
+ same or fewer owners has `recorded` standing. A recorded name that no longer collides has `closed`
775
+ standing, so a release can shrink the record.
776
+
777
+ The command returns `1` when a collision has `error` standing, a candidate carries a conflict, or
778
+ an owner is unread. A run without
779
+ `--offline` or `--from` also returns `1` when membership fell to the floor catalog table, any
780
+ owner fell to the floor guide, or the record fell to the floor inventory. Every other completed run returns `0`, and malformed arguments return `2`.
781
+
782
+ The human report names membership when it fell to the floor catalog table, with the failure the
783
+ registry read reported, then each owner that fell to the floor guide, each unread owner, the record
784
+ when it fell to the floor inventory, each `error` collision with its owners, and each conflict
785
+ with its owner and environments, then prints the recorded and closed counts. The `--json` option
786
+ emits one value with `owners`, `collisions`, `conflicts`, and `provenance`. Each owner carries `owner`, `source` (`candidate`, `live`, `floor`, or `unread`), and
787
+ `names` unless it is unread. Each collision carries `name`, `owners`, and `standing`, sorted by
788
+ name, including closed entries with their recorded owners. Each conflict carries `name`, `owner`,
789
+ and `environments`, sorted by name within each candidate. `provenance.membership` names the
790
+ package list's baseline, `provenance.guides` is `live` only when no owner fell to the floor, and
791
+ `provenance.record` names the record's baseline; a `--from` run reports none of them. The command changes no files.
792
+
793
+ The core `SurfaceClaim` interface carries `owner` and `names`. `SurfaceCollision` carries `name`
794
+ and `owners`; `SurfaceFinding` adds `standing`. `SurfaceConflict` carries `name`, `owner`, and
795
+ `environments`, and `SurfaceCandidate` adds `conflicts` to a claim. `collectSurfaceCollisions`
796
+ deduplicates owners, `compareSurfaceCollisions` applies the record, and `collectSurfaceConflicts`
797
+ finds the names one owner exports from more than one environment. `readSurfaceClaims` reads
798
+ immediate package guides, excluding the README index. `readSurfaceCandidate` adds live barrel names
799
+ and the candidate's conflicts. `readSurfaceFile` reads
800
+ one owner's guide file under a root, and `readSurfaceGuide` parses guide text from any source.
801
+ `readSurfaceRecord` reads a data root's record, and `resolveHostRoot` resolves the bundled root.
802
+ `readSurfaceModule` loads `@orkestrel/guide` lazily and narrows it with `isSurfaceModule`; every
803
+ reader takes an optional `SurfaceLoader` that resolves the module, and requires the package in
804
+ scaffold's resolution path when none is supplied. Importing the server entry alone does not load
805
+ it.
806
+
807
+ The executable's `SurfaceCommand` interface carries `verb: 'surface'`, positional `checkouts`,
808
+ and the optional `offline`, `from`, `target`, and `json` members. The parser refuses other verbs'
809
+ options.
810
+
689
811
  ### Reading a target
690
812
 
691
813
  `audit`, `repair`, `catalog`, and `overwrite` derive the blueprint from the target itself. The name
@@ -963,13 +1085,14 @@ deletion.
963
1085
  `--json` replaces the report with one JSON value on standard output. Warnings and refusals go to
964
1086
  standard error, so a piped value is never polluted.
965
1087
 
966
- | Verb | Value |
967
- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
968
- | `new` | `MaterializeResult` — `target`, `written`, `skipped`, `removed` — plus `provenance` |
969
- | `audit` | `Audit` — `findings` and `questions` — plus `releases` and `provenance`; findings carry `ownership` |
970
- | `repair` | `MaterializeResult` plus `audit`, the terminal audit taken after the write, `releases`, and `provenance` |
971
- | `catalog` | `MaterializeResult` plus `mirrors`, `provenance`, optional `membership` with `entries`, `dropped`, and `releases`, and an explanatory `note` on a partial run |
972
- | `overwrite` | The `catalog` value plus `audit`, top-level `releases` from its version read, `additions`, and `lifts`; `note` explains a partial run |
1088
+ | Verb | Value |
1089
+ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1090
+ | `new` | `MaterializeResult` — `target`, `written`, `skipped`, `removed` — plus `provenance` |
1091
+ | `audit` | `Audit` — `findings` and `questions` — plus `releases` and `provenance`; findings carry `ownership` |
1092
+ | `surface` | `owners` with each owner's `source`, `collisions` with each entry's `standing` (`error`, `recorded`, or `closed`), and `provenance` with `guides` and `record` |
1093
+ | `repair` | `MaterializeResult` plus `audit`, the terminal audit taken after the write, `releases`, and `provenance` |
1094
+ | `catalog` | `MaterializeResult` plus `mirrors`, `provenance`, optional `membership` with `entries`, `dropped`, and `releases`, and an explanatory `note` on a partial run |
1095
+ | `overwrite` | The `catalog` value plus `audit`, top-level `releases` from its version read, `additions`, and `lifts`; `note` explains a partial run |
973
1096
 
974
1097
  The `membership` entity is present only when the catalog read completes. Its `entries` holds the
975
1098
  package table, `dropped` names packages the preceding table carried that the registry no longer
@@ -2102,6 +2225,18 @@ generating a workspace with no network receives.
2102
2225
 
2103
2226
  ## Vendored data root
2104
2227
 
2228
+ The inventory contracts carry these data members.
2229
+
2230
+ | Member | Contract |
2231
+ | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
2232
+ | `HostInventory.surface` | Required readonly `SurfaceCollision[]`: the verified record when `lookup` is `found`, and an empty collection otherwise. |
2233
+ | `HostInventory.unreachable` | Optional boolean, `true` only when the inventory request produced no HTTP response. |
2234
+ | `TextReadResult.unreachable` | Optional boolean, `true` only when the request produced no HTTP response. The same member sits on `BytesReadResult`. |
2235
+ | `HostManifest.surface` | Required readonly `SurfaceCollision[]`, sorted by name; each collision has distinct sorted owners and is included in the manifest digest. |
2236
+ | `HostStageOptions.inventory` | Optional checkout-relative inventory path. Default: `HOST_INVENTORY_PATH` (`host.json`). |
2237
+ | `HostStageOptions.establish` | Optional boolean. If `true`, an absent inventory establishes the baseline; if `false`, staging refuses it. Default: `false`. |
2238
+ | `HostStageOptions.report` | Optional callback receiving the baseline location or its absence. Default: no reporting. |
2239
+
2105
2240
  The vendored data root is the shared file set, staged into the published package as plain data.
2106
2241
  Staging walks `HOST_PATHS`, `CANON_PATHS`, and `REFERENCE_PATHS`, and a release ships what those
2107
2242
  lists name.