@orkestrel/scaffold 0.0.115 → 0.0.117
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bin/main.js +138 -16
- package/dist/bin/main.js.map +1 -1
- package/dist/host/agents/skills/orkestrel-publish/references/wave.md +1 -1
- package/dist/host/claude/agents/orkestrel.md +2 -2
- package/dist/host/claude/rules/names.md +3 -1
- package/dist/host/guides/abort.md +17 -17
- package/dist/host/guides/agent.md +445 -445
- package/dist/host/guides/brief.md +143 -143
- package/dist/host/guides/browser.md +731 -731
- package/dist/host/guides/budget.md +39 -39
- package/dist/host/guides/capture.md +298 -298
- package/dist/host/guides/console.md +109 -109
- package/dist/host/guides/contract.md +335 -335
- package/dist/host/guides/csv.md +30 -30
- package/dist/host/guides/database.md +163 -163
- package/dist/host/guides/emitter.md +17 -17
- package/dist/host/guides/form.md +99 -99
- package/dist/host/guides/guide.md +368 -183
- package/dist/host/guides/html.md +49 -49
- package/dist/host/guides/indexeddb.md +40 -40
- package/dist/host/guides/interpret.md +139 -139
- package/dist/host/guides/lsp.md +114 -114
- package/dist/host/guides/markdown.md +68 -68
- package/dist/host/guides/mcp.md +3745 -3745
- package/dist/host/guides/middleware.md +170 -170
- package/dist/host/guides/msg.md +95 -95
- package/dist/host/guides/ndjson.md +8 -8
- package/dist/host/guides/ollama.md +56 -56
- package/dist/host/guides/pool.md +21 -21
- package/dist/host/guides/probe.md +82 -82
- package/dist/host/guides/process.md +99 -99
- package/dist/host/guides/program.md +98 -96
- package/dist/host/guides/qualifier.md +70 -70
- package/dist/host/guides/queue.md +37 -37
- package/dist/host/guides/rater.md +38 -38
- package/dist/host/guides/reason.md +308 -308
- package/dist/host/guides/relation.md +50 -50
- package/dist/host/guides/router.md +58 -58
- package/dist/host/guides/scaffold.md +558 -419
- package/dist/host/guides/sea.md +128 -128
- package/dist/host/guides/server.md +100 -100
- package/dist/host/guides/sqlite.md +28 -28
- package/dist/host/guides/sse.md +20 -20
- package/dist/host/guides/study.md +444 -444
- package/dist/host/guides/table.md +82 -82
- package/dist/host/guides/template.md +41 -41
- package/dist/host/guides/terminal.md +121 -121
- package/dist/host/guides/test.md +273 -273
- package/dist/host/guides/timeout.md +18 -18
- package/dist/host/guides/tool.md +27 -27
- package/dist/host/guides/toolbox.md +166 -166
- package/dist/host/guides/websocket.md +54 -54
- package/dist/host/guides/worker.md +24 -24
- package/dist/host/guides/workflow.md +187 -187
- package/dist/host/guides/workspace.md +55 -55
- package/dist/host/manifest.json +55 -55
- package/dist/host/tests/setupPolicy.ts +5 -3
- package/dist/src/core/index.cjs +90 -4
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +229 -144
- package/dist/src/core/index.d.ts +229 -144
- package/dist/src/core/index.js +88 -5
- package/dist/src/core/index.js.map +1 -1
- package/dist/src/server/index.cjs +295 -66
- package/dist/src/server/index.cjs.map +1 -1
- package/dist/src/server/index.d.cts +193 -6
- package/dist/src/server/index.d.ts +193 -6
- package/dist/src/server/index.js +290 -69
- package/dist/src/server/index.js.map +1 -1
- package/package.json +5 -4
|
@@ -29,61 +29,61 @@ isCapturePath('../escape.png') // false
|
|
|
29
29
|
|
|
30
30
|
Protocol shapes from [`types.ts`](../src/core/types.ts).
|
|
31
31
|
|
|
32
|
-
| Name | Kind | Summary |
|
|
33
|
-
| -------------------------- | --------- | --------------------------------------------------------------------------------------------- |
|
|
34
|
-
| `CaptureErrorCode` | type | Names one condition axis a capture failure carries. |
|
|
35
|
-
| `CaptureErrorContext` | type | Carries structured facts about a capture failure beside its message. |
|
|
36
|
-
| `CaptureErrorOptions` | interface | Configures one capture failure's condition, optional context, and optional cause. |
|
|
37
|
-
| `CaptureSelection` | interface | Carries the selection fields a request and a parking check read. |
|
|
38
|
-
| `CaptureIdentity` | interface | Identifies one runner invocation's producing stage and configuration. |
|
|
39
|
-
| `CaptureRequest` | interface | Carries a runner request through Vitest's provided-context protocol. |
|
|
40
|
-
| `CaptureSources` | interface | Attributes product ownership and behavioral inputs separately. |
|
|
41
|
-
| `CaptureDigest` | interface | Records declared patterns, expanded file hashes, and their combined digest. |
|
|
42
|
-
| `CaptureDestination` | interface | Identifies one required output pair and its declaring case. |
|
|
43
|
-
| `CaptureDeclaration` | interface | Preserves a collected case's full behavioral declaration. |
|
|
44
|
-
| `CaptureEntry` | interface | Records an emitted destination and its producing case duration. |
|
|
45
|
-
| `CaptureArtifact` | interface | Names the journey artifact a final case wrote and the SHA-256 of its bytes. |
|
|
46
|
-
| `CaptureRun` | interface | Records collected declarations, successful observations, and emitted output separately. |
|
|
47
|
-
| `CaptureReceipt` | interface | Binds a complete registry reading to its report and input hashes. |
|
|
48
|
-
| `CaptureRegistry` | interface | Collects validated registry receipts and their required output pairs. |
|
|
49
|
-
| `CaptureLookup` | interface | Binds a state-to-case lookup to its registry, inputs, and passing run. |
|
|
50
|
-
| `CaptureStamp` | interface | Stamps one emitted frame with execution, source, image, and registry provenance. |
|
|
51
|
-
| `CaptureManifest` | interface | Holds the registry, frame stamps, and validated case lookups in one document. |
|
|
52
|
-
| `CaptureStatus` | type | Names the primary freshness classification of a required or discovered frame. |
|
|
53
|
-
| `CaptureFreshness` | interface | Reports a frame's freshness classification and every supporting reason. |
|
|
54
|
-
| `CaptureWarning` | interface | Identifies changed behavioral inputs and conservatively affected cases. |
|
|
55
|
-
| `CaptureCollectionReceipt` | interface | Binds a successful full collection to the unchanged complete anchor and exact evidence bytes. |
|
|
56
|
-
| `CaptureStoredManifest` | interface | Extends the image manifest with independently authenticated collection evidence. |
|
|
57
|
-
| `CaptureLookupJournal` | interface | Binds capture-free lookup publication to the exact manifest it supplements. |
|
|
58
|
-
| `CaptureViewport` | interface | Declares a host viewport's name and pixel geometry without inferring it from a file name. |
|
|
59
|
-
| `CaptureBox` | interface | Describes a logged viewport box a journey artifact records for pixel sampling. |
|
|
60
|
-
| `CaptureAssertion` | interface | Carries the owner-bearing projection of a Vitest JSON assertion. |
|
|
61
|
-
| `CaptureReport` | interface | Holds validated reporter assertions without copying Vitest's unrelated wire members. |
|
|
32
|
+
| Name | Kind | Signature | Summary |
|
|
33
|
+
| -------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
|
|
34
|
+
| `CaptureErrorCode` | type | `(typeof CAPTURE_ERROR_CODES)[number]` | Names one condition axis a capture failure carries. |
|
|
35
|
+
| `CaptureErrorContext` | type | `Readonly<Record<string, unknown>>` | Carries structured facts about a capture failure beside its message. |
|
|
36
|
+
| `CaptureErrorOptions` | interface | `{ code, context?, cause? }` | Configures one capture failure's condition, optional context, and optional cause. |
|
|
37
|
+
| `CaptureSelection` | interface | `{ selector, case?, state? }` | Carries the selection fields a request and a parking check read. |
|
|
38
|
+
| `CaptureIdentity` | interface | `{ id, stage, pid, config }` | Identifies one runner invocation's producing stage and configuration. |
|
|
39
|
+
| `CaptureRequest` | interface | `{ version, command, variants, args }` | Carries a runner request through Vitest's provided-context protocol. |
|
|
40
|
+
| `CaptureSources` | interface | `{ own, shared, tests }` | Attributes product ownership and behavioral inputs separately. |
|
|
41
|
+
| `CaptureDigest` | interface | `{ patterns, files, digest }` | Records declared patterns, expanded file hashes, and their combined digest. |
|
|
42
|
+
| `CaptureDestination` | interface | `{ portfolio, state, scope, part, section?, variant, project, file, case, sources }` | Identifies one required output pair and its declaring case. |
|
|
43
|
+
| `CaptureDeclaration` | interface | `{ case, owner, variant, eligible, states }` | Preserves a collected case's full behavioral declaration. |
|
|
44
|
+
| `CaptureEntry` | interface | `{ duration }` | Records an emitted destination and its producing case duration. |
|
|
45
|
+
| `CaptureArtifact` | interface | `{ file, digest }` | Names the journey artifact a final case wrote and the SHA-256 of its bytes. |
|
|
46
|
+
| `CaptureRun` | interface | `{ version, identity?, request?, variant, time, complete, reference, artifact?, declarations, registry, passed, observed, entries }` | Records collected declarations, successful observations, and emitted output separately. |
|
|
47
|
+
| `CaptureReceipt` | interface | `{ version, variant, time, report, inputs, declarations, registry, complete }` | Binds a complete registry reading to its report and input hashes. |
|
|
48
|
+
| `CaptureRegistry` | interface | `{ version, receipts, entries, digest }` | Collects validated registry receipts and their required output pairs. |
|
|
49
|
+
| `CaptureLookup` | interface | `{ registry, variant, case, owner, states, inputs, run }` | Binds a state-to-case lookup to its registry, inputs, and passing run. |
|
|
50
|
+
| `CaptureStamp` | interface | `{ identity, time, commit, dirty, own, shared, tests, image, registry }` | Stamps one emitted frame with execution, source, image, and registry provenance. |
|
|
51
|
+
| `CaptureManifest` | interface | `{ version, registry, entries, lookups }` | Holds the registry, frame stamps, and validated case lookups in one document. |
|
|
52
|
+
| `CaptureStatus` | type | `'current' \| (typeof CAPTURE_STATUS_PRECEDENCE)[number]` | Names the primary freshness classification of a required or discovered frame. |
|
|
53
|
+
| `CaptureFreshness` | interface | `{ file, state, variant, status, reasons }` | Reports a frame's freshness classification and every supporting reason. |
|
|
54
|
+
| `CaptureWarning` | interface | `{ files, cases }` | Identifies changed behavioral inputs and conservatively affected cases. |
|
|
55
|
+
| `CaptureCollectionReceipt` | interface | `{ project, registry, variant, inputs, run, report }` | Binds a successful full collection to the unchanged complete anchor and exact evidence bytes. |
|
|
56
|
+
| `CaptureStoredManifest` | interface | `{ collections? }` | Extends the image manifest with independently authenticated collection evidence. |
|
|
57
|
+
| `CaptureLookupJournal` | interface | `{ collections?, version, manifest?, inputs, lookups }` | Binds capture-free lookup publication to the exact manifest it supplements. |
|
|
58
|
+
| `CaptureViewport` | interface | `{ name, width, height }` | Declares a host viewport's name and pixel geometry without inferring it from a file name. |
|
|
59
|
+
| `CaptureBox` | interface | `{ x, y, width, height }` | Describes a logged viewport box a journey artifact records for pixel sampling. |
|
|
60
|
+
| `CaptureAssertion` | interface | `{ status, duration? }` | Carries the owner-bearing projection of a Vitest JSON assertion. |
|
|
61
|
+
| `CaptureReport` | interface | `{ start, end, assertions }` | Holds validated reporter assertions without copying Vitest's unrelated wire members. |
|
|
62
62
|
|
|
63
63
|
### Constants
|
|
64
64
|
|
|
65
65
|
From [`constants.ts`](../src/core/constants.ts).
|
|
66
66
|
|
|
67
|
-
| Name | Kind | Summary |
|
|
68
|
-
| --------------------------- | ----- | --------------------------------------------------------------------------------------------- |
|
|
69
|
-
| `CAPTURE_ERROR_CODES` | const | Lists the condition axes a capture failure carries, in the order the executable reports them. |
|
|
70
|
-
| `CAPTURE_ERROR_BRAND` | const | Keys the global brand a capture error carries, so a duplicate installation recognizes it. |
|
|
71
|
-
| `CAPTURE_STATUS_PRECEDENCE` | const | Lists the non-current freshness classifications from highest precedence to lowest. |
|
|
72
|
-
| `CAPTURE_REQUEST_PREFIX` | const | Names the file prefix of a runner request, completed by the runner's process id and `.json`. |
|
|
73
|
-
| `CAPTURE_VERSION` | const | Holds the protocol version every request, record, receipt, registry, and manifest declares. |
|
|
74
|
-
| `CAPTURE_PNG_SIGNATURE` | const | Holds the eight bytes every PNG file opens with. |
|
|
75
|
-
| `CAPTURE_REGISTRY_FILE` | const | Names the default accepted complete-run registry file inside a portfolio directory. |
|
|
76
|
-
| `CAPTURE_MANIFEST_FILE` | const | Names the default image-stamp manifest file inside a portfolio directory. |
|
|
77
|
-
| `CAPTURE_LOOKUPS_FILE` | const | Names the default lookup journal file inside a portfolio directory. |
|
|
67
|
+
| Name | Kind | Signature | Summary |
|
|
68
|
+
| --------------------------- | ----- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
69
|
+
| `CAPTURE_ERROR_CODES` | const | `readonly ["USAGE", "SELECTION", "HOST", "STAGE", "EVIDENCE", "CONTAINMENT"]` | Lists the condition axes a capture failure carries, in the order the executable reports them. |
|
|
70
|
+
| `CAPTURE_ERROR_BRAND` | const | `unique symbol` | Keys the global brand a capture error carries, so a duplicate installation recognizes it. |
|
|
71
|
+
| `CAPTURE_STATUS_PRECEDENCE` | const | `readonly ["duplicate", "orphan", "missing", "unstamped", "stale-shared", "stale-own"]` | Lists the non-current freshness classifications from highest precedence to lowest. |
|
|
72
|
+
| `CAPTURE_REQUEST_PREFIX` | const | `"journey-selection"` | Names the file prefix of a runner request, completed by the runner's process id and `.json`. |
|
|
73
|
+
| `CAPTURE_VERSION` | const | `1` | Holds the protocol version every request, record, receipt, registry, and manifest declares. |
|
|
74
|
+
| `CAPTURE_PNG_SIGNATURE` | const | `readonly [137, 80, 78, 71, 13, 10, 26, 10]` | Holds the eight bytes every PNG file opens with. |
|
|
75
|
+
| `CAPTURE_REGISTRY_FILE` | const | `"registry.json"` | Names the default accepted complete-run registry file inside a portfolio directory. |
|
|
76
|
+
| `CAPTURE_MANIFEST_FILE` | const | `"manifest.json"` | Names the default image-stamp manifest file inside a portfolio directory. |
|
|
77
|
+
| `CAPTURE_LOOKUPS_FILE` | const | `"lookups.json"` | Names the default lookup journal file inside a portfolio directory. |
|
|
78
78
|
|
|
79
79
|
### Errors
|
|
80
80
|
|
|
81
81
|
From [`errors.ts`](../src/core/errors.ts). The executable maps a `USAGE` condition to exit 64 and every other condition to exit 1.
|
|
82
82
|
|
|
83
|
-
| Name | Kind | Summary |
|
|
84
|
-
| ---------------- | -------- | ---------------------------------------------------------- |
|
|
85
|
-
| `CaptureError` | class | Reports one capture failure under a stable condition axis. |
|
|
86
|
-
| `isCaptureError` | function | Checks whether an unknown value is a capture error. |
|
|
83
|
+
| Name | Kind | Signature | Summary |
|
|
84
|
+
| ---------------- | -------- | --------------------------------------------------------------------- | ---------------------------------------------------------- |
|
|
85
|
+
| `CaptureError` | class | `new (message: string, options: CaptureErrorOptions) => CaptureError` | Reports one capture failure under a stable condition axis. |
|
|
86
|
+
| `isCaptureError` | function | `(value: unknown) => value is CaptureError` | Checks whether an unknown value is a capture error. |
|
|
87
87
|
|
|
88
88
|
The error guard accepts branded subclasses and errors from another installed copy. Its context may be absent, an object, or a callable object, including a class instance. It requires an own brand whose value is the tested error itself, so it refuses a transparent proxy and a plain branded object. It does not require an exact error name.
|
|
89
89
|
|
|
@@ -91,284 +91,284 @@ The error guard accepts branded subclasses and errors from another installed cop
|
|
|
91
91
|
|
|
92
92
|
Total guards from [`validators.ts`](../src/core/validators.ts). Each returns `false` for a value that throws on read, a cycle, or a non-record, and never throws.
|
|
93
93
|
|
|
94
|
-
| Name | Kind | Summary |
|
|
95
|
-
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
|
|
96
|
-
| `isCapturePath` | function | Checks whether a serialized path stays within the portable relative-path vocabulary. |
|
|
97
|
-
| `isCapturePattern` | function | Checks whether a native glob declaration uses relative portable path segments. |
|
|
98
|
-
| `isCaptureSegment` | function | Checks whether a protocol identity can occupy one portable path segment. |
|
|
99
|
-
| `isCaptureSelector` | function | Checks whether an owner selector uses canonical colon-separated segments. |
|
|
100
|
-
| `isCaptureHash` | function | Checks whether a value is a SHA-256 hexadecimal digest. |
|
|
101
|
-
| `isCaptureHashes` | function | Checks whether a file-hash map has portable keys and valid digests. |
|
|
102
|
-
| `isCaptureSources` | function | Checks whether source attribution separates own, shared, and behavioral patterns. |
|
|
103
|
-
| `isCaptureIdentity` | function | Checks whether an execution identity carries its required authorization fields. |
|
|
104
|
-
| `isCaptureRequest` | function | Checks whether a request has the supported version and complete execution identity. |
|
|
105
|
-
| `isCaptureDeclaration` | function | Checks whether a collected declaration preserves its full owner and state population. |
|
|
106
|
-
| `isCaptureDestination` | function | Checks whether a destination supplies canonical identity and source attribution fields. |
|
|
107
|
-
| `isCaptureEntry` | function | Checks whether an emitted entry includes a finite nonnegative case duration. |
|
|
108
|
-
| `isCaptureArtifact` | function | Checks whether a record names its journey artifact by portable path and SHA-256 digest. |
|
|
109
|
-
| `isCaptureRun` | function | Checks whether a final record preserves declarations, observations, and output separately. |
|
|
110
|
-
| `isCaptureDigest` | function | Checks whether a shared-source digest retains both patterns and expanded file hashes. |
|
|
111
|
-
| `isCaptureReceipt` | function | Checks whether a complete-run receipt binds the report, inputs, and declaration registry. |
|
|
112
|
-
| `isCaptureRegistry` | function | Checks whether a registry document retains its receipts and required output pairs. |
|
|
113
|
-
| `isCaptureLookup` | function | Checks whether a lookup binds a passing case to its full run record and input hashes. |
|
|
114
|
-
| `isCaptureLookupJournal` | function | Checks the separate lookup journal and its optional predecessor manifest digest. |
|
|
115
|
-
| `isCaptureStamp` | function | Checks whether a stamp binds an emitted image to source and execution provenance. |
|
|
116
|
-
| `isCaptureManifest` | function | Checks whether an inherited manifest has the supported schema without discarding malformed rows. |
|
|
117
|
-
| `isCaptureCollection` | function | Checks whether collection evidence pins complete input membership and both external artifacts. |
|
|
118
|
-
| `isCaptureStoredManifest` | function | Checks optional collection metadata without upgrading historical image evidence. |
|
|
119
|
-
| `isCaptureGeometry` | function | Checks the host's declared viewport without deriving geometry from an output name. |
|
|
120
|
-
| `isCaptureBox` | function | Checks a journey artifact's recorded sampling box. |
|
|
94
|
+
| Name | Kind | Signature | Summary |
|
|
95
|
+
| ------------------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
96
|
+
| `isCapturePath` | function | `(value: unknown) => value is string` | Checks whether a serialized path stays within the portable relative-path vocabulary. |
|
|
97
|
+
| `isCapturePattern` | function | `(value: unknown) => value is string` | Checks whether a native glob declaration uses relative portable path segments. |
|
|
98
|
+
| `isCaptureSegment` | function | `(value: unknown) => value is string` | Checks whether a protocol identity can occupy one portable path segment. |
|
|
99
|
+
| `isCaptureSelector` | function | `(value: unknown) => value is string` | Checks whether an owner selector uses canonical colon-separated segments. |
|
|
100
|
+
| `isCaptureHash` | function | `(value: unknown) => value is string` | Checks whether a value is a SHA-256 hexadecimal digest. |
|
|
101
|
+
| `isCaptureHashes` | function | `(value: unknown) => value is Readonly<Record<string, string>>` | Checks whether a file-hash map has portable keys and valid digests. |
|
|
102
|
+
| `isCaptureSources` | function | `(value: unknown) => value is CaptureSources` | Checks whether source attribution separates own, shared, and behavioral patterns. |
|
|
103
|
+
| `isCaptureIdentity` | function | `(value: unknown) => value is CaptureIdentity` | Checks whether an execution identity carries its required authorization fields. |
|
|
104
|
+
| `isCaptureRequest` | function | `(value: unknown) => value is CaptureRequest` | Checks whether a request has the supported version and complete execution identity. |
|
|
105
|
+
| `isCaptureDeclaration` | function | `(value: unknown) => value is CaptureDeclaration` | Checks whether a collected declaration preserves its full owner and state population. |
|
|
106
|
+
| `isCaptureDestination` | function | `(value: unknown) => value is CaptureDestination` | Checks whether a destination supplies canonical identity and source attribution fields. |
|
|
107
|
+
| `isCaptureEntry` | function | `(value: unknown) => value is CaptureEntry` | Checks whether an emitted entry includes a finite nonnegative case duration. |
|
|
108
|
+
| `isCaptureArtifact` | function | `(value: unknown) => value is CaptureArtifact` | Checks whether a record names its journey artifact by portable path and SHA-256 digest. |
|
|
109
|
+
| `isCaptureRun` | function | `(value: unknown) => value is CaptureRun` | Checks whether a final record preserves declarations, observations, and output separately. |
|
|
110
|
+
| `isCaptureDigest` | function | `(value: unknown) => value is CaptureDigest` | Checks whether a shared-source digest retains both patterns and expanded file hashes. |
|
|
111
|
+
| `isCaptureReceipt` | function | `(value: unknown) => value is CaptureReceipt` | Checks whether a complete-run receipt binds the report, inputs, and declaration registry. |
|
|
112
|
+
| `isCaptureRegistry` | function | `(value: unknown) => value is CaptureRegistry` | Checks whether a registry document retains its receipts and required output pairs. |
|
|
113
|
+
| `isCaptureLookup` | function | `(value: unknown) => value is CaptureLookup` | Checks whether a lookup binds a passing case to its full run record and input hashes. |
|
|
114
|
+
| `isCaptureLookupJournal` | function | `(value: unknown) => value is CaptureLookupJournal` | Checks the separate lookup journal and its optional predecessor manifest digest. |
|
|
115
|
+
| `isCaptureStamp` | function | `(value: unknown) => value is CaptureStamp` | Checks whether a stamp binds an emitted image to source and execution provenance. |
|
|
116
|
+
| `isCaptureManifest` | function | `(value: unknown) => value is CaptureManifest` | Checks whether an inherited manifest has the supported schema without discarding malformed rows. |
|
|
117
|
+
| `isCaptureCollection` | function | `(value: unknown) => value is CaptureCollectionReceipt` | Checks whether collection evidence pins complete input membership and both external artifacts. |
|
|
118
|
+
| `isCaptureStoredManifest` | function | `(value: unknown) => value is CaptureStoredManifest` | Checks optional collection metadata without upgrading historical image evidence. |
|
|
119
|
+
| `isCaptureGeometry` | function | `(value: unknown) => value is CaptureViewport` | Checks the host's declared viewport without deriving geometry from an output name. |
|
|
120
|
+
| `isCaptureBox` | function | `(value: unknown) => value is CaptureBox` | Checks a journey artifact's recorded sampling box. |
|
|
121
121
|
|
|
122
122
|
### Helpers
|
|
123
123
|
|
|
124
124
|
Pure leaves from [`helpers.ts`](../src/core/helpers.ts). A helper that refuses a document throws a `CaptureError` with the `EVIDENCE` condition.
|
|
125
125
|
|
|
126
|
-
| Name | Kind | Summary |
|
|
127
|
-
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
|
|
128
|
-
| `describeCaptureError` | function | Describes a caught failure as one reportable line. |
|
|
129
|
-
| `collectCaptureDuplicates` | function | Finds repeated identities before a keyed collection could discard them. |
|
|
130
|
-
| `requireCaptureUnique` | function | Refuses duplicate declarations or portable storage-key collisions before indexing. |
|
|
131
|
-
| `matchesCaptureMembers` | function | Compares complete populations without erasing duplicates. |
|
|
132
|
-
| `matchesCaptureSelector` | function | Compares an owner with an explicit selector at colon boundaries. |
|
|
133
|
-
| `resolveCaptureOwner` | function | Builds the canonical owner from a destination's registry identity. |
|
|
134
|
-
| `resolveCaptureKey` | function | Builds a manifest identity independently of the physical image path. |
|
|
135
|
-
| `describeCaptureDestination` | function | Serializes a destination's identity and attribution in a deterministic field order. |
|
|
136
|
-
| `describeCaptureIdentity` | function | Serializes only the registry's execution and output identity, independent of input revisions. |
|
|
137
|
-
| `describeCaptureDeclaration` | function | Serializes a complete behavioral declaration without dropping eligibility or states. |
|
|
138
|
-
| `describeCaptureRequest` | function | Serializes every request field, retaining the exact argv order. |
|
|
139
|
-
| `collectCaptureChanges` | function | Names every changed, added, or removed file in hash populations. |
|
|
140
|
-
| `resolveLookupKey` | function | Builds the stable case identity used to merge separate lookup receipts. |
|
|
141
|
-
| `readCaptureReport` | function | Reads successful Vitest JSON output and validates every owner-bearing assertion. |
|
|
142
|
-
| `validateCaptureRun` | function | Validates declaration, reporter, observation, completeness, and output-projection agreement. |
|
|
143
|
-
| `resolveCaptureStatus` | function | Chooses the primary classification while retaining all findings separately. |
|
|
144
|
-
| `readCaptureDirty` | function | Reads Git's NUL-delimited porcelain paths without treating spaces or quoted names as separators. |
|
|
145
|
-
| `validateCaptureReceipt` | function | Validates a complete receipt against full reporter declarations and eligible output coverage. |
|
|
126
|
+
| Name | Kind | Signature | Summary |
|
|
127
|
+
| ---------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
128
|
+
| `describeCaptureError` | function | `(error: unknown) => string` | Describes a caught failure as one reportable line. |
|
|
129
|
+
| `collectCaptureDuplicates` | function | `(values: readonly string[], folded?: boolean) => readonly string[]` | Finds repeated identities before a keyed collection could discard them. |
|
|
130
|
+
| `requireCaptureUnique` | function | `(values: readonly string[], label: string, folded?: boolean) => void` | Refuses duplicate declarations or portable storage-key collisions before indexing. |
|
|
131
|
+
| `matchesCaptureMembers` | function | `(left: readonly string[], right: readonly string[]) => boolean` | Compares complete populations without erasing duplicates. |
|
|
132
|
+
| `matchesCaptureSelector` | function | `(owner: string, selector: string) => boolean` | Compares an owner with an explicit selector at colon boundaries. |
|
|
133
|
+
| `resolveCaptureOwner` | function | `(entry: CaptureDestination) => string` | Builds the canonical owner from a destination's registry identity. |
|
|
134
|
+
| `resolveCaptureKey` | function | `(entry: CaptureDestination) => string` | Builds a manifest identity independently of the physical image path. |
|
|
135
|
+
| `describeCaptureDestination` | function | `(entry: CaptureDestination) => string` | Serializes a destination's identity and attribution in a deterministic field order. |
|
|
136
|
+
| `describeCaptureIdentity` | function | `(entry: CaptureDestination) => string` | Serializes only the registry's execution and output identity, independent of input revisions. |
|
|
137
|
+
| `describeCaptureDeclaration` | function | `(entry: CaptureDeclaration) => string` | Serializes a complete behavioral declaration without dropping eligibility or states. |
|
|
138
|
+
| `describeCaptureRequest` | function | `(request: CaptureRequest) => string` | Serializes every request field, retaining the exact argv order. |
|
|
139
|
+
| `collectCaptureChanges` | function | `(previous: Readonly<Record<string, string>>, current: Readonly<Record<string, string>>) => readonly string[]` | Names every changed, added, or removed file in hash populations. |
|
|
140
|
+
| `resolveLookupKey` | function | `(lookup: Pick<CaptureLookup, 'variant' \| 'case'>) => string` | Builds the stable case identity used to merge separate lookup receipts. |
|
|
141
|
+
| `readCaptureReport` | function | `(value: unknown) => CaptureReport` | Reads successful Vitest JSON output and validates every owner-bearing assertion. |
|
|
142
|
+
| `validateCaptureRun` | function | `(run: CaptureRun, report: CaptureReport, project: string) => void` | Validates declaration, reporter, observation, completeness, and output-projection agreement. |
|
|
143
|
+
| `resolveCaptureStatus` | function | `(statuses: readonly CaptureStatus[]) => CaptureStatus` | Chooses the primary classification while retaining all findings separately. |
|
|
144
|
+
| `readCaptureDirty` | function | `(output: string) => readonly string[]` | Reads Git's NUL-delimited porcelain paths without treating spaces or quoted names as separators. |
|
|
145
|
+
| `validateCaptureReceipt` | function | `(receipt: CaptureReceipt, report: CaptureReport) => void` | Validates a complete receipt against full reporter declarations and eligible output coverage. |
|
|
146
146
|
|
|
147
147
|
### Server types
|
|
148
148
|
|
|
149
149
|
Engine, runner, preflight, and contact-sheet contracts from [`types.ts`](../src/server/types.ts).
|
|
150
150
|
|
|
151
|
-
| Name | Kind | Summary |
|
|
152
|
-
| -------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
-
| `CaptureCommand` | type | Names one command the runner executes: a journey, a frame capture, or a stale reading. |
|
|
154
|
-
| `CapturePortfolioRoot` | interface | Supplies a host-authorized physical portfolio root without repeating its states or variants. |
|
|
155
|
-
| `CaptureHashHandler` | type | Digests the exact bytes of one file reading and returns the lowercase hexadecimal digest. |
|
|
156
|
-
| `CaptureIntegrityOptions` | interface | Configures the engine's workspace and separate evidence documents. |
|
|
157
|
-
| `CaptureStageProject` | interface | Supplies one selected project's expected final record and bounded input population. |
|
|
158
|
-
| `CaptureParsedArguments` | type | Carries the typed values and tokens of a strictly parsed capture command line. |
|
|
159
|
-
| `CaptureExecutionResult` | interface | Carries the supervised child outcome without treating a signal as a successful exit. |
|
|
160
|
-
| `CaptureExecutionHandler` | type | Executes the runner's child after the engine captures its input snapshot. |
|
|
161
|
-
| `CaptureStageOptions` | interface | Binds a stage transaction to its exact request, projects, reporter, and process boundary. |
|
|
162
|
-
| `CaptureFileSnapshot` | interface | Records one physical file's bytes and native modification readings at a stage boundary. |
|
|
163
|
-
| `CaptureProjectSnapshot` | interface | Preserves one project's declared patterns and sorted expansion before execution. |
|
|
164
|
-
| `CaptureSnapshot` | interface | Holds a stage boundary's input populations and existing output identities. |
|
|
165
|
-
| `CaptureProjectResult` | interface | Reports validated project evidence, retaining empty successful selections explicitly. |
|
|
166
|
-
| `CaptureStageResult` | interface | Reports the successful stage's committed stamps and validated lookup evidence. |
|
|
167
|
-
| `CaptureReadOptions` | interface | Selects a declaration population without requiring current images or passing state lookups. |
|
|
168
|
-
| `CaptureStaleOptions` | interface | Selects a freshness population and names the producing variants the host wrapper declares. |
|
|
169
|
-
| `CaptureCheckOptions` | interface | Selects required output pairs and attributable extras for a freshness reading. |
|
|
170
|
-
| `CaptureReadResult` | interface | Returns the exact current declaration destinations and their complete-anchor identity. |
|
|
171
|
-
| `CaptureCheckResult` | interface | Reports the exact judged population, every mismatch reason, and conservative test warnings. |
|
|
172
|
-
| `CaptureLookupOptions` | interface | Requests a state-to-case resolution before the runner starts any selected project. |
|
|
173
|
-
| `CaptureLookupResult` | interface | Resolves one declaring case and its actual output pairs with their passing evidence. |
|
|
174
|
-
| `CaptureRunEvidence` | interface | Binds a decoded run record to the physical file whose digest authenticated it. |
|
|
175
|
-
| `CaptureDirectoryResult` | interface | Carries one physical-directory ancestry while enumerating logical portfolio paths. |
|
|
176
|
-
| `CaptureEvidence` | interface | Carries accepted registry anchors and separately persisted passing run evidence. |
|
|
177
|
-
| `CaptureCollectionEvidence` | interface | Carries the authenticated external record beside its collection receipt. |
|
|
178
|
-
| `CaptureReceiptInput` | interface | Supplies a verifier's actual process outcome and exact reporter bytes for registry import. |
|
|
179
|
-
| `CaptureIntegrityInterface` | interface | Defines the shared stage transaction, freshness reading, and state resolution engine. |
|
|
180
|
-
| `CaptureProject` | interface | Preserves the wrapper's host declarations, including optional uniform scopes, for consumers. |
|
|
181
|
-
| `CaptureRunnerOptions` | interface | Configures one runner invocation: its command, its workspace, and the command line it reads. |
|
|
182
|
-
| `CaptureRunnerArguments` | interface | Carries parsed runner arguments while leaving omitted selectors available to the usage diagnostic. |
|
|
183
|
-
| `CaptureRunnerInterface` | interface | Drives selected owners through one journey stage or staged frame captures. |
|
|
184
|
-
| `CaptureChange` | interface | Classifies one changed Git path against accepted source attribution. |
|
|
185
|
-
| `CaptureChangePlan` | interface | Holds changed paths and the stable owner selection reduced by ancestry. |
|
|
186
|
-
| `CaptureOwnerOutcome` | interface | Records one changed owner's exit and whether an execution child started. |
|
|
187
|
-
| `CaptureWriteHandler` | type | Writes one chunk of runner output to the stream the host chooses. |
|
|
188
|
-
| `CaptureCLIOptions` | interface | Configures the executable's workspace and its report and diagnostic writers. |
|
|
189
|
-
| `CaptureCLIInterface` | interface | Runs capture command lines through injected output writers. |
|
|
190
|
-
| `CaptureIntegrityHandler` | type | Creates the integrity engine the runner reads and stamps through, from the options it derives. |
|
|
191
|
-
| `CaptureStagePlan` | interface | Names one planned stage and the variants it runs in one Vitest process. |
|
|
192
|
-
| `CaptureArgumentsOptions` | interface | Configures the Vitest argument list one stage spawns with. |
|
|
193
|
-
| `CaptureRequestOptions` | interface | Configures how a wrapper reads the runner's request for its own Vitest process. |
|
|
194
|
-
| `CaptureOutcome` | interface | Carries one project's owner-bearing passed work count from a finished stage. |
|
|
195
|
-
| `CaptureRunPlan` | interface | Carries everything every stage of one invocation shares. |
|
|
196
|
-
| `CaptureInvocationOptions` | interface | Configures one runner invocation's identity, workspace, and output. |
|
|
197
|
-
| `CaptureChildTerminationHandler` | type | Terminates one supervised child and reports whether its exit was confirmed. |
|
|
198
|
-
| `CaptureInvocationInterface` | interface | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
199
|
-
| `CaptureDiscoveryRequest` | interface | Carries the request the runner publishes for the discovery child that reads its wrapper. |
|
|
200
|
-
| `CaptureHostEntry` | interface | Describes one wrapper project to the runner: its host declarations and, when it has one, its viewport. |
|
|
201
|
-
| `CaptureHostDescription` | interface | Carries the description a wrapper writes back to the runner that discovered it. |
|
|
202
|
-
| `CaptureDescriptionExpectation` | interface | Names what a description must echo for the runner to accept it. |
|
|
203
|
-
| `CaptureDiscoveryOptions` | interface | Configures how a wrapper answers the runner's discovery request. |
|
|
204
|
-
| `CaptureDiscoveryRunOptions` | interface | Configures one discovery: the workspace, the wrapper, the invocation that owns the child, and its bounds. |
|
|
205
|
-
| `CaptureDiscoveryInterface` | interface | Reads a consumer's wrapper by running its installed Vitest in discovery mode. |
|
|
206
|
-
| `CapturePicture` | interface | Carries a decoded RGB image for the image checks and the contact sheets. |
|
|
207
|
-
| `CaptureReaderOptions` | interface | Configures a read-only capture consumer using the wrapper's host declarations. |
|
|
208
|
-
| `CaptureProducer` | interface | Declares the viewport one wrapper project produces beside the project's own name. |
|
|
209
|
-
| `CaptureReaderDefaults` | interface | Supplies the wrapper path, the journey artifact directory, and the request directory a reader command line falls back to. |
|
|
210
|
-
| `CaptureReaderSelection` | interface | Returns a reader's authenticated selection, uniform scopes, and engine for pixel classification. |
|
|
211
|
-
| `CaptureArtifactResult` | interface | Carries a judged run record and the verified text of the journey artifact it names. |
|
|
212
|
-
| `CaptureJudgedRecord` | interface | Names the run record a judged frame's stamp points at and the case that stamped it. |
|
|
213
|
-
| `CaptureJudgedFrame` | interface | Pairs a judged frame with its verified artifact, when one was read, and its coverage issues. |
|
|
214
|
-
| `CaptureDecodedImage` | interface | Records one selected image's real bytes, geometry, and canonical destination. |
|
|
215
|
-
| `CaptureImageResult` | interface | Retains source geometry and a bounded sheet thumbnail after a full frame has been judged. |
|
|
216
|
-
| `CaptureOwnership` | interface | Identifies the process and invocation that own a request directory. |
|
|
217
|
-
| `CaptureOwnershipHost` | interface | Supplies the filesystem and liveness boundary for ownership arbitration. |
|
|
218
|
-
| `CapturePngLimits` | interface | Bounds a PNG's decoded pixels, side length, and encoded bytes. |
|
|
219
|
-
| `CaptureCheckFrame` | interface | Carries one judged frame to a host check: its destination, its decoded pixels, and its artifact. |
|
|
220
|
-
| `CaptureCheckHandler` | type | Reads one judged frame against a host rule and returns the issues it finds, none when it passes. |
|
|
221
|
-
| `CapturePreflightResult` | interface | Reports selected image checks without upgrading their engine freshness classifications. |
|
|
222
|
-
| `CapturePreflightInterface` | interface | Reads the selected population's frames and reports their freshness, mixed observations, and coverage. |
|
|
223
|
-
| `CaptureSheetOptions` | interface | Carries a contact-sheet output request separately from the population selection. |
|
|
224
|
-
| `CaptureSheetCell` | interface | Holds one contact-sheet cell: a frame's destination, its shrunk picture, and what the sheet reports about it. |
|
|
225
|
-
| `CaptureSheetGroup` | interface | Holds the cells of one portfolio, owner, and state side by side as one composite picture. |
|
|
226
|
-
| `CaptureSheetRow` | interface | Holds a pair of groups side by side as one composite picture. |
|
|
227
|
-
| `CaptureSheetPage` | interface | Holds one written sheet: its file name, the rows it stacks, and the composite picture. |
|
|
228
|
-
| `CaptureReaderCommand` | interface | Carries parsed reader arguments and an optional contact-sheet output directory. |
|
|
229
|
-
| `CaptureSheetsInterface` | interface | Composes exactly the authenticated sparse state and output pairs for iteration review. |
|
|
230
|
-
| `CaptureRegistryArguments` | interface | Carries the parsed registry command line: the wrapper, the variants to refresh, and the mode. |
|
|
231
|
-
| `CaptureRegistrarOptions` | interface | Configures one registry refresh: its workspace, wrapper default, request directory, and command line. |
|
|
232
|
-
| `CaptureRegistrarInterface` | interface | Refreshes the accepted registry from one complete capture-free journey per producing variant. |
|
|
233
|
-
| `CaptureInputHandler` | type | Reads a contained input through an owning operation's file snapshot memo. |
|
|
234
|
-
| `CaptureRetractionHandler` | type | Removes one invocation's published request during shutdown. |
|
|
235
|
-
| `CaptureTerminationHandler` | type | Begins one independent child termination only after request removal has been attempted. |
|
|
151
|
+
| Name | Kind | Signature | Summary |
|
|
152
|
+
| -------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
+
| `CaptureCommand` | type | `CaptureRequest['command'] \| 'stale'` | Names one command the runner executes: a journey, a frame capture, or a stale reading. |
|
|
154
|
+
| `CapturePortfolioRoot` | interface | `{ portfolio, directory, scoped }` | Supplies a host-authorized physical portfolio root without repeating its states or variants. |
|
|
155
|
+
| `CaptureHashHandler` | type | `(bytes: Uint8Array) => string` | Digests the exact bytes of one file reading and returns the lowercase hexadecimal digest. |
|
|
156
|
+
| `CaptureIntegrityOptions` | interface | `{ inputs, root, directory, manifest, registry, lookups, portfolios, hash? }` | Configures the engine's workspace and separate evidence documents. |
|
|
157
|
+
| `CaptureStageProject` | interface | `{ name, variant, record, inputs }` | Supplies one selected project's expected final record and bounded input population. |
|
|
158
|
+
| `CaptureParsedArguments` | type | `{ readonly [Key in keyof ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>]: Readonly<ReturnType<typeof parseArgs<{ readonly options: Options; readonly tokens: true; readonly strict: true; readonly allowPositionals: true; }>>[Key]>; }` | Carries the typed values and tokens of a strictly parsed capture command line. |
|
|
159
|
+
| `CaptureExecutionResult` | interface | `{ code, signal, pid?, expired? }` | Carries the supervised child outcome without treating a signal as a successful exit. |
|
|
160
|
+
| `CaptureExecutionHandler` | type | `() => Promise<CaptureExecutionResult>` | Executes the runner's child after the engine captures its input snapshot. |
|
|
161
|
+
| `CaptureStageOptions` | interface | `{ request, projects, report, execute, signal? }` | Binds a stage transaction to its exact request, projects, reporter, and process boundary. |
|
|
162
|
+
| `CaptureFileSnapshot` | interface | `{ file, image, changed }` | Records one physical file's bytes and native modification readings at a stage boundary. |
|
|
163
|
+
| `CaptureProjectSnapshot` | interface | `{ project, inputs }` | Preserves one project's declared patterns and sorted expansion before execution. |
|
|
164
|
+
| `CaptureSnapshot` | interface | `{ time, projects, files }` | Holds a stage boundary's input populations and existing output identities. |
|
|
165
|
+
| `CaptureProjectResult` | interface | `{ project, variant, record, declarations, passed }` | Reports validated project evidence, retaining empty successful selections explicitly. |
|
|
166
|
+
| `CaptureStageResult` | interface | `{ request, projects, entries, lookups, duration }` | Reports the successful stage's committed stamps and validated lookup evidence. |
|
|
167
|
+
| `CaptureReadOptions` | interface | `{ variants?, portfolio? }` | Selects a declaration population without requiring current images or passing state lookups. |
|
|
168
|
+
| `CaptureStaleOptions` | interface | `{ declared? }` | Selects a freshness population and names the producing variants the host wrapper declares. |
|
|
169
|
+
| `CaptureCheckOptions` | interface | `{ variants, portfolio? }` | Selects required output pairs and attributable extras for a freshness reading. |
|
|
170
|
+
| `CaptureReadResult` | interface | `{ registry, entries }` | Returns the exact current declaration destinations and their complete-anchor identity. |
|
|
171
|
+
| `CaptureCheckResult` | interface | `{ required, entries, warnings, duration }` | Reports the exact judged population, every mismatch reason, and conservative test warnings. |
|
|
172
|
+
| `CaptureLookupOptions` | interface | `{ state, variants, portfolio? }` | Requests a state-to-case resolution before the runner starts any selected project. |
|
|
173
|
+
| `CaptureLookupResult` | interface | `{ case, entries, lookups }` | Resolves one declaring case and its actual output pairs with their passing evidence. |
|
|
174
|
+
| `CaptureRunEvidence` | interface | `{ file, run }` | Binds a decoded run record to the physical file whose digest authenticated it. |
|
|
175
|
+
| `CaptureDirectoryResult` | interface | `{ directory, ancestors }` | Carries one physical-directory ancestry while enumerating logical portfolio paths. |
|
|
176
|
+
| `CaptureEvidence` | interface | `{ registry, collections, manifest?, lookups, runs }` | Carries accepted registry anchors and separately persisted passing run evidence. |
|
|
177
|
+
| `CaptureCollectionEvidence` | interface | `{ receipt }` | Carries the authenticated external record beside its collection receipt. |
|
|
178
|
+
| `CaptureReceiptInput` | interface | `{ receipt, report, outcome, capped }` | Supplies a verifier's actual process outcome and exact reporter bytes for registry import. |
|
|
179
|
+
| `CaptureIntegrityInterface` | interface | `{ changed(), read(), stamp(), check(), lookup() }` | Defines the shared stage transaction, freshness reading, and state resolution engine. |
|
|
180
|
+
| `CaptureProject` | interface | `{ name, variant, tags, variants, directory, record, inputs, final, first, uniform?, portfolios, standalone }` | Preserves the wrapper's host declarations, including optional uniform scopes, for consumers. |
|
|
181
|
+
| `CaptureRunnerOptions` | interface | `{ command, root, config, requests, argv, stdout?, stderr?, integrity?, deadline? }` | Configures one runner invocation: its command, its workspace, and the command line it reads. |
|
|
182
|
+
| `CaptureRunnerArguments` | interface | `{ selector?, changed?, plan?, config, variants, case?, state?, portfolio? }` | Carries parsed runner arguments while leaving omitted selectors available to the usage diagnostic. |
|
|
183
|
+
| `CaptureRunnerInterface` | interface | `{ execute() }` | Drives selected owners through one journey stage or staged frame captures. |
|
|
184
|
+
| `CaptureChange` | interface | `{ path, classification, owners }` | Classifies one changed Git path against accepted source attribution. |
|
|
185
|
+
| `CaptureChangePlan` | interface | `{ changes, owners }` | Holds changed paths and the stable owner selection reduced by ancestry. |
|
|
186
|
+
| `CaptureOwnerOutcome` | interface | `{ owner, code, ran }` | Records one changed owner's exit and whether an execution child started. |
|
|
187
|
+
| `CaptureWriteHandler` | type | `(text: string) => unknown` | Writes one chunk of runner output to the stream the host chooses. |
|
|
188
|
+
| `CaptureCLIOptions` | interface | `{ root?, stdout?, stderr? }` | Configures the executable's workspace and its report and diagnostic writers. |
|
|
189
|
+
| `CaptureCLIInterface` | interface | `{ execute() }` | Runs capture command lines through injected output writers. |
|
|
190
|
+
| `CaptureIntegrityHandler` | type | `(options: CaptureIntegrityOptions) => CaptureIntegrityInterface` | Creates the integrity engine the runner reads and stamps through, from the options it derives. |
|
|
191
|
+
| `CaptureStagePlan` | interface | `{ name, variants }` | Names one planned stage and the variants it runs in one Vitest process. |
|
|
192
|
+
| `CaptureArgumentsOptions` | interface | `{ entry, config, report, projects, filter, case?, final, mode?, titles? }` | Configures the Vitest argument list one stage spawns with. |
|
|
193
|
+
| `CaptureRequestOptions` | interface | `{ ppid, argv, directory?, config, owners, variants }` | Configures how a wrapper reads the runner's request for its own Vitest process. |
|
|
194
|
+
| `CaptureOutcome` | interface | `{ project, variant, count }` | Carries one project's owner-bearing passed work count from a finished stage. |
|
|
195
|
+
| `CaptureRunPlan` | interface | `{ command, projects, selector, filter, case?, state?, final, directory, config }` | Carries everything every stage of one invocation shares. |
|
|
196
|
+
| `CaptureInvocationOptions` | interface | `{ command, root, requests, stdout, stderr, terminate?, ownership? }` | Configures one runner invocation's identity, workspace, and output. |
|
|
197
|
+
| `CaptureChildTerminationHandler` | type | `(child: SessionInterface) => Promise<boolean>` | Terminates one supervised child and reports whether its exit was confirmed. |
|
|
198
|
+
| `CaptureInvocationInterface` | interface | `{ id, request, directory, signal, interrupted, attach(), release(), prepare(), holders(), publish(), retract(), launched(), spawn() }` | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
199
|
+
| `CaptureDiscoveryRequest` | interface | `{ version, phase, id, nonce, config, pid, args }` | Carries the request the runner publishes for the discovery child that reads its wrapper. |
|
|
200
|
+
| `CaptureHostEntry` | interface | `{ project, viewport? }` | Describes one wrapper project to the runner: its host declarations and, when it has one, its viewport. |
|
|
201
|
+
| `CaptureHostDescription` | interface | `{ version, id, nonce, config, parent, pid, projects }` | Carries the description a wrapper writes back to the runner that discovered it. |
|
|
202
|
+
| `CaptureDescriptionExpectation` | interface | `{ id, nonce, config, parent, pid }` | Names what a description must echo for the runner to accept it. |
|
|
203
|
+
| `CaptureDiscoveryOptions` | interface | `{ ppid, argv, directory?, config, projects }` | Configures how a wrapper answers the runner's discovery request. |
|
|
204
|
+
| `CaptureDiscoveryRunOptions` | interface | `{ root, config, invocation, mode?, deadline? }` | Configures one discovery: the workspace, the wrapper, the invocation that owns the child, and its bounds. |
|
|
205
|
+
| `CaptureDiscoveryInterface` | interface | `{ describe() }` | Reads a consumer's wrapper by running its installed Vitest in discovery mode. |
|
|
206
|
+
| `CapturePicture` | interface | `{ width, height, pixels }` | Carries a decoded RGB image for the image checks and the contact sheets. |
|
|
207
|
+
| `CaptureReaderOptions` | interface | `{ root, config, selection, journeys, checks?, requests?, deadline?, stdout?, stderr? }` | Configures a read-only capture consumer using the wrapper's host declarations. |
|
|
208
|
+
| `CaptureProducer` | interface | `{ project }` | Declares the viewport one wrapper project produces beside the project's own name. |
|
|
209
|
+
| `CaptureReaderDefaults` | interface | `{ config, journeys, requests? }` | Supplies the wrapper path, the journey artifact directory, and the request directory a reader command line falls back to. |
|
|
210
|
+
| `CaptureReaderSelection` | interface | `{ integrity, population, variants, directory, uniform? }` | Returns a reader's authenticated selection, uniform scopes, and engine for pixel classification. |
|
|
211
|
+
| `CaptureArtifactResult` | interface | `{ record, run, file, text }` | Carries a judged run record and the verified text of the journey artifact it names. |
|
|
212
|
+
| `CaptureJudgedRecord` | interface | `{ record, case }` | Names the run record a judged frame's stamp points at and the case that stamped it. |
|
|
213
|
+
| `CaptureJudgedFrame` | interface | `{ entry, artifact, issues }` | Pairs a judged frame with its verified artifact, when one was read, and its coverage issues. |
|
|
214
|
+
| `CaptureDecodedImage` | interface | `{ entry, picture, digest, size }` | Records one selected image's real bytes, geometry, and canonical destination. |
|
|
215
|
+
| `CaptureImageResult` | interface | `{ picture, thumbnail }` | Retains source geometry and a bounded sheet thumbnail after a full frame has been judged. |
|
|
216
|
+
| `CaptureOwnership` | interface | `{ pid, id }` | Identifies the process and invocation that own a request directory. |
|
|
217
|
+
| `CaptureOwnershipHost` | interface | `{ platform, read, write, link, remove, alive }` | Supplies the filesystem and liveness boundary for ownership arbitration. |
|
|
218
|
+
| `CapturePngLimits` | interface | `{ pixels, side, bytes }` | Bounds a PNG's decoded pixels, side length, and encoded bytes. |
|
|
219
|
+
| `CaptureCheckFrame` | interface | `{ entry, picture, artifact }` | Carries one judged frame to a host check: its destination, its decoded pixels, and its artifact. |
|
|
220
|
+
| `CaptureCheckHandler` | type | `(frame: CaptureCheckFrame) => readonly string[]` | Reads one judged frame against a host rule and returns the issues it finds, none when it passes. |
|
|
221
|
+
| `CapturePreflightResult` | interface | `{ mixed, variants, directory, selection, freshness, images, issues }` | Reports selected image checks without upgrading their engine freshness classifications. |
|
|
222
|
+
| `CapturePreflightInterface` | interface | `{ read(), check(), execute() }` | Reads the selected population's frames and reports their freshness, mixed observations, and coverage. |
|
|
223
|
+
| `CaptureSheetOptions` | interface | `{ reader, output }` | Carries a contact-sheet output request separately from the population selection. |
|
|
224
|
+
| `CaptureSheetCell` | interface | `{ entry, picture, source, factor, clipped, freshness }` | Holds one contact-sheet cell: a frame's destination, its shrunk picture, and what the sheet reports about it. |
|
|
225
|
+
| `CaptureSheetGroup` | interface | `{ identity, cells, picture }` | Holds the cells of one portfolio, owner, and state side by side as one composite picture. |
|
|
226
|
+
| `CaptureSheetRow` | interface | `{ groups, picture }` | Holds a pair of groups side by side as one composite picture. |
|
|
227
|
+
| `CaptureSheetPage` | interface | `{ file, rows, picture }` | Holds one written sheet: its file name, the rows it stacks, and the composite picture. |
|
|
228
|
+
| `CaptureReaderCommand` | interface | `{ reader, output? }` | Carries parsed reader arguments and an optional contact-sheet output directory. |
|
|
229
|
+
| `CaptureSheetsInterface` | interface | `{ execute() }` | Composes exactly the authenticated sparse state and output pairs for iteration review. |
|
|
230
|
+
| `CaptureRegistryArguments` | interface | `{ config, variants, mode? }` | Carries the parsed registry command line: the wrapper, the variants to refresh, and the mode. |
|
|
231
|
+
| `CaptureRegistrarOptions` | interface | `{ root, config, requests, argv, stdout?, stderr?, deadline? }` | Configures one registry refresh: its workspace, wrapper default, request directory, and command line. |
|
|
232
|
+
| `CaptureRegistrarInterface` | interface | `{ execute() }` | Refreshes the accepted registry from one complete capture-free journey per producing variant. |
|
|
233
|
+
| `CaptureInputHandler` | type | `(file: string) => string \| undefined` | Reads a contained input through an owning operation's file snapshot memo. |
|
|
234
|
+
| `CaptureRetractionHandler` | type | `() => void` | Removes one invocation's published request during shutdown. |
|
|
235
|
+
| `CaptureTerminationHandler` | type | `() => Promise<boolean>` | Begins one independent child termination only after request removal has been attempted. |
|
|
236
236
|
|
|
237
237
|
### Server constants
|
|
238
238
|
|
|
239
239
|
The runner's names and bounds from [`constants.ts`](../src/server/constants.ts).
|
|
240
240
|
|
|
241
|
-
| Name | Kind | Summary |
|
|
242
|
-
| ------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
243
|
-
| `CAPTURE_COMMAND_NAMES` | const | Names the executable subcommand each runner command answers to. |
|
|
244
|
-
| `CAPTURE_COMMAND_OPTIONS` | const | Defines each command's frozen options for Node's standard argument parser. |
|
|
245
|
-
| `CAPTURE_EXIT` | const | Holds the exit status each runner outcome maps to. |
|
|
246
|
-
| `CAPTURE_OWNER_FILE` | const | Names the exclusive workspace invocation marker. |
|
|
247
|
-
| `CAPTURE_REFUSAL_LIMIT` | const | Caps each refusal population so hostile records cannot flood a terminal or agent context. |
|
|
248
|
-
| `CAPTURE_STAGES` | const | Names the selected journey stage and the narrow and remaining frame stages. |
|
|
249
|
-
| `CAPTURE_TAG_OPERATORS` | const | Lists the words a tag name can never be, because a tag filter reads them as operators. |
|
|
250
|
-
| `CAPTURE_OWNER_PREFIX` | const | Names the tag prefix that marks a case's owner path and each ancestor of it. |
|
|
251
|
-
| `CAPTURE_FLAG` | const | Names the environment variable that turns frame capture on for a Vitest child. |
|
|
252
|
-
| `CAPTURE_FLAG_VALUE` | const | Holds the one value of the capture variable that turns frame capture on. |
|
|
253
|
-
| `CAPTURE_VITEST_ENTRY` | const | Names the repository-relative path of the Vitest entry the runner spawns through Node. |
|
|
254
|
-
| `CAPTURE_RUNS_DIRECTORY` | const | Names the directory beneath a portfolio or request directory that holds one invocation's records. |
|
|
255
|
-
| `CAPTURE_SURVIVORS_FILE` | const | Names the create-only child record beneath an invocation's run directory. |
|
|
256
|
-
| `CAPTURE_MINIMUM_IMAGE` | const | Holds the byte count under which an image is too small to be a real frame. |
|
|
257
|
-
| `CAPTURE_REPORT_LINES` | const | Names the first word of the line a reader prints, followed by its JSON report. |
|
|
258
|
-
| `CAPTURE_SHEET` | const | Holds the contact-sheet geometry: how wide a cell shrinks toward, how tall it may grow, the mark that stands in for an unreadable image, the gap between neighbors, and how many cells, rows, and pairs a row and a sheet hold. |
|
|
259
|
-
| `CAPTURE_SHEET_FILES` | const | Names the contact-sheet files: the sheet prefix and digits, and the two index documents. |
|
|
260
|
-
| `CAPTURE_REGISTRY_STAGE` | const | Names the stage each producing variant's complete journey runs in, ahead of the variant's name. |
|
|
261
|
-
| `CAPTURE_REGISTRY_LINE` | const | Names the first word of the line the registry refresh prints, followed by its JSON summary. |
|
|
262
|
-
| `CAPTURE_REQUESTS_FLAG` | const | Names the environment variable that carries the absolute request directory to a Vitest child. |
|
|
263
|
-
| `CAPTURE_DISCOVERY` | const | Holds the discovery exchange's fixed names and bound. |
|
|
264
|
-
| `CAPTURE_SUBCOMMANDS` | const | Names the executable's subcommands in the order its usage text lists them. |
|
|
265
|
-
| `CAPTURE_DEFAULTS` | const | Holds the repository-relative paths the executable falls back to when the command line names none. |
|
|
266
|
-
| `CAPTURE_USAGE` | const | Holds the usage text the executable prints when it is given no subcommand or an unknown one. |
|
|
267
|
-
| `CAPTURE_PNG_LIMITS` | const | Bounds decoded image memory, row metadata, and PNG input bytes independently of untrusted headers. |
|
|
268
|
-
| `CAPTURE_OWNER_TIMEOUT` | const | Bounds a synchronous ownership retry sequence in milliseconds, including host contention. |
|
|
269
|
-
| `CAPTURE_OWNER_BACKOFF` | const | Yields between ownership probes in milliseconds so filesystem contention can settle. |
|
|
270
|
-
| `CAPTURE_MESSAGE_LIMIT` | const | Bounds external diagnostic text while retaining the number of omitted characters. |
|
|
241
|
+
| Name | Kind | Signature | Summary |
|
|
242
|
+
| ------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
243
|
+
| `CAPTURE_COMMAND_NAMES` | const | `Readonly<{ readonly journey: 'journey'; readonly capture: 'frames'; readonly stale: 'stale'; }>` | Names the executable subcommand each runner command answers to. |
|
|
244
|
+
| `CAPTURE_COMMAND_OPTIONS` | const | `Readonly<{ readonly journey: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; }>; readonly capture: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; changed: Readonly<{ type: "string"; }>; plan: Readonly<{ type: "boolean"; }>; }>; readonly stale: Readonly<{ config: Readonly<{ type: "string"; }>; variant: Readonly<{ type: "string"; multiple: true; }>; case: Readonly<{ type: "string"; }>; state: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; }>; readonly preflight: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; }>; readonly sheets: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; state: Readonly<{ type: "string"; }>; case: Readonly<{ type: "string"; }>; portfolio: Readonly<{ type: "string"; }>; config: Readonly<{ type: "string"; }>; journeys: Readonly<{ type: "string"; }>; checks: Readonly<{ type: "string"; }>; output: Readonly<{ type: "string"; }>; }>; readonly registry: Readonly<{ variant: Readonly<{ type: "string"; multiple: true; }>; config: Readonly<{ type: "string"; }>; mode: Readonly<{ type: "string"; }>; }>; }>` | Defines each command's frozen options for Node's standard argument parser. |
|
|
245
|
+
| `CAPTURE_EXIT` | const | `Readonly<{ readonly passed: 0; readonly failed: 1; readonly usage: 64; }>` | Holds the exit status each runner outcome maps to. |
|
|
246
|
+
| `CAPTURE_OWNER_FILE` | const | `".capture-owner"` | Names the exclusive workspace invocation marker. |
|
|
247
|
+
| `CAPTURE_REFUSAL_LIMIT` | const | `16` | Caps each refusal population so hostile records cannot flood a terminal or agent context. |
|
|
248
|
+
| `CAPTURE_STAGES` | const | `Readonly<{ readonly selected: 'selected'; readonly first: 'narrow'; readonly rest: 'rest'; }>` | Names the selected journey stage and the narrow and remaining frame stages. |
|
|
249
|
+
| `CAPTURE_TAG_OPERATORS` | const | `readonly string[]` | Lists the words a tag name can never be, because a tag filter reads them as operators. |
|
|
250
|
+
| `CAPTURE_OWNER_PREFIX` | const | `"owner:"` | Names the tag prefix that marks a case's owner path and each ancestor of it. |
|
|
251
|
+
| `CAPTURE_FLAG` | const | `"CAPTURE"` | Names the environment variable that turns frame capture on for a Vitest child. |
|
|
252
|
+
| `CAPTURE_FLAG_VALUE` | const | `"1"` | Holds the one value of the capture variable that turns frame capture on. |
|
|
253
|
+
| `CAPTURE_VITEST_ENTRY` | const | `"node_modules/vitest/vitest.mjs"` | Names the repository-relative path of the Vitest entry the runner spawns through Node. |
|
|
254
|
+
| `CAPTURE_RUNS_DIRECTORY` | const | `"runs"` | Names the directory beneath a portfolio or request directory that holds one invocation's records. |
|
|
255
|
+
| `CAPTURE_SURVIVORS_FILE` | const | `"survivors.json"` | Names the create-only child record beneath an invocation's run directory. |
|
|
256
|
+
| `CAPTURE_MINIMUM_IMAGE` | const | `4000` | Holds the byte count under which an image is too small to be a real frame. |
|
|
257
|
+
| `CAPTURE_REPORT_LINES` | const | `Readonly<{ readonly preflight: 'READER'; readonly sheets: 'SHEETS'; }>` | Names the first word of the line a reader prints, followed by its JSON report. |
|
|
258
|
+
| `CAPTURE_SHEET` | const | `Readonly<{ readonly cell: 320; readonly limit: 400; readonly mark: Readonly<{ width: 160; height: 20; present: 220; absent: 20; }>; readonly gap: 12; readonly pairs: 2; readonly rows: 4; }>` | Holds the contact-sheet geometry: how wide a cell shrinks toward, how tall it may grow, the mark that stands in for an unreadable image, the gap between neighbors, and how many cells, rows, and pairs a row and a sheet hold. |
|
|
259
|
+
| `CAPTURE_SHEET_FILES` | const | `Readonly<{ readonly prefix: 'sheet-'; readonly digits: 3; readonly index: 'index.json'; readonly notes: 'index.md'; }>` | Names the contact-sheet files: the sheet prefix and digits, and the two index documents. |
|
|
260
|
+
| `CAPTURE_REGISTRY_STAGE` | const | `"registry"` | Names the stage each producing variant's complete journey runs in, ahead of the variant's name. |
|
|
261
|
+
| `CAPTURE_REGISTRY_LINE` | const | `"REGISTRY"` | Names the first word of the line the registry refresh prints, followed by its JSON summary. |
|
|
262
|
+
| `CAPTURE_REQUESTS_FLAG` | const | `"CAPTURE_REQUESTS"` | Names the environment variable that carries the absolute request directory to a Vitest child. |
|
|
263
|
+
| `CAPTURE_DISCOVERY` | const | `Readonly<{ readonly phase: 'discover'; readonly description: 'description.json'; readonly arguments: readonly string[]; readonly deadline: 60000; }>` | Holds the discovery exchange's fixed names and bound. |
|
|
264
|
+
| `CAPTURE_SUBCOMMANDS` | const | `readonly string[]` | Names the executable's subcommands in the order its usage text lists them. |
|
|
265
|
+
| `CAPTURE_DEFAULTS` | const | `Readonly<{ readonly config: 'configs/app/vite.journey.config.ts'; readonly requests: 'tmp/capture'; readonly journeys: 'tmp/journey'; }>` | Holds the repository-relative paths the executable falls back to when the command line names none. |
|
|
266
|
+
| `CAPTURE_USAGE` | const | `string` | Holds the usage text the executable prints when it is given no subcommand or an unknown one. |
|
|
267
|
+
| `CAPTURE_PNG_LIMITS` | const | `Readonly<{ readonly pixels: number; readonly side: 131072; readonly bytes: number; }>` | Bounds decoded image memory, row metadata, and PNG input bytes independently of untrusted headers. |
|
|
268
|
+
| `CAPTURE_OWNER_TIMEOUT` | const | `1000` | Bounds a synchronous ownership retry sequence in milliseconds, including host contention. |
|
|
269
|
+
| `CAPTURE_OWNER_BACKOFF` | const | `10` | Yields between ownership probes in milliseconds so filesystem contention can settle. |
|
|
270
|
+
| `CAPTURE_MESSAGE_LIMIT` | const | `1024` | Bounds external diagnostic text while retaining the number of omitted characters. |
|
|
271
271
|
|
|
272
272
|
### Server helpers
|
|
273
273
|
|
|
274
274
|
Leaves from [`helpers.ts`](../src/server/helpers.ts): hashing, digests, registry import, flag reading, the PNG codec, the runner's parsing, and the few reads and writes of the filesystem the runner and the registry refresh make (`resolveCaptureWrapperProject`, `answerCaptureDiscovery`, `readCaptureInputs`, `readCaptureRunning`, `readCaptureRequest`, `writeCaptureDocument`). A helper that refuses an image or a receipt throws a `CaptureError` with the `EVIDENCE` condition.
|
|
275
275
|
|
|
276
|
-
| Name | Kind | Summary |
|
|
277
|
-
| ------------------------------ | -------- | --------------------------------------------------------------------------------------------------------- |
|
|
278
|
-
| `computeCaptureHash` | function | Hashes exact source or image bytes with SHA-256. |
|
|
279
|
-
| `normalizeSlashes` | function | Normalizes a host path to forward slashes. |
|
|
280
|
-
| `buildCaptureDigest` | function | Computes the digest of both pattern declarations and expanded path and hash membership. |
|
|
281
|
-
| `buildCaptureLookupJournal` | function | Stores each distinct lookup input population once in a manifest-bound journal. |
|
|
282
|
-
| `readCaptureLookups` | function | Resolves journal lookup references after verifying each stored input population's digest. |
|
|
283
|
-
| `computeRegistryDigest` | function | Computes the registry identity from its authenticated receipts and exact output population. |
|
|
284
|
-
| `buildCaptureRegistry` | function | Imports complete receipts only after their actual exits and exact report bytes validate. |
|
|
285
|
-
| `matchesCaptureSignature` | function | Checks whether bytes open with the eight-byte PNG signature. |
|
|
286
|
-
| `predictCaptureByte` | function | Computes the PNG Paeth predictor used by both image readers. |
|
|
287
|
-
| `readCaptureChunks` | function | Reads PNG compressed-data chunks while refusing truncated or corrupt image bytes. |
|
|
288
|
-
| `unfilterCaptureRow` | function | Reconstructs one filtered PNG scanline from its filter byte and the row above. |
|
|
289
|
-
| `inflateCaptureStream` | function | Inflates a PNG's compressed stream, refusing one that is corrupt or longer than declared. |
|
|
290
|
-
| `decodeCapturePicture` | function | Decodes the eight-bit, non-interlaced PNGs the capture readers consume. |
|
|
291
|
-
| `encodeCaptureWord` | function | Encodes an unsigned 32-bit integer as four big-endian bytes. |
|
|
292
|
-
| `encodeCaptureChunk` | function | Encodes one checked PNG chunk for contact-sheet output. |
|
|
293
|
-
| `encodeCapturePicture` | function | Encodes an RGB picture using the contact-sheet writer's native PNG format. |
|
|
294
|
-
| `shrinkCapturePicture` | function | Scales a picture with an exact area average and clips its displayed height. |
|
|
295
|
-
| `composeCapturePictures` | function | Composes pictures on the contact-sheet gray background. |
|
|
296
|
-
| `readCaptureRequestOwner` | function | Reads the process id that a request file, or its temporary sibling, names. |
|
|
297
|
-
| `resolveCaptureRelative` | function | Resolves a path to the slash-separated form the evidence documents store, relative to a root. |
|
|
298
|
-
| `escapeCapturePattern` | function | Escapes every regular-expression metacharacter so a case name matches only itself. |
|
|
299
|
-
| `buildCaptureFilter` | function | Builds the tag expression that selects an owner population, and its capture tags for frames. |
|
|
300
|
-
| `resolveCaptureStages` | function | Plans one selected journey stage or narrow and remaining frame stages. |
|
|
301
|
-
| `resolveCaptureVariants` | function | Resolves selected producing variants in declaration order and requires their projects. |
|
|
302
|
-
| `buildCaptureChangePlan` | function | Classifies changed paths through accepted patterns and reduces owners by ancestry. |
|
|
303
|
-
| `renderCaptureCommand` | function | Renders an exact owner command with the selected variants and filters in host shell syntax. |
|
|
304
|
-
| `buildCaptureArguments` | function | Builds the exact Node argument array that spawns one Vitest stage. |
|
|
305
|
-
| `readCaptureOptions` | function | Parses standard option tokens and refuses empty values, terminators, and repeated single options. |
|
|
306
|
-
| `readCaptureArguments` | function | Reads the runner's command line into one selector, its flags, and the resolved wrapper path. |
|
|
307
|
-
| `readCapturePortfolios` | function | Reads the physical portfolio roots a wrapper declares and refuses a malformed or repeated root. |
|
|
308
|
-
| `readCaptureProject` | function | Reads one wrapper project's host declarations from its Vitest test configuration. |
|
|
309
|
-
| `describeCapturePortfolios` | function | Describes a project's portfolio roots as comparable lines, primary roots apart from standalone ones. |
|
|
310
|
-
| `requireCaptureProjects` | function | Refuses a wrapper project set whose members repeat or disagree on a host declaration. |
|
|
311
|
-
| `describeCaptureSelectorFault` | function | Describes why a selector names nothing the wrapper declares, naming the first unknown segment. |
|
|
312
|
-
| `buildCaptureRequestRefusal` | function | Builds the refusal a wrapper raises for a request file it cannot accept as its parent's. |
|
|
313
|
-
| `readCaptureRequest` | function | Reads and validates the request the runner wrote for the wrapper process that is its child. |
|
|
314
|
-
| `readCaptureReaderArguments` | function | Reads a reader's command line into its selection, its flags, and the resolved paths. |
|
|
315
|
-
| `readCaptureViewport` | function | Reads the viewport a wrapper project's producing variant declares. |
|
|
316
|
-
| `buildCaptureIntegrityOptions` | function | Derives the integrity engine's options from a wrapper project's host declarations. |
|
|
317
|
-
| `scanCaptureFrames` | function | Reports a portfolio, owner, and viewport whose frames mix cropped, viewport-sized, and page-sized images. |
|
|
318
|
-
| `collectCaptureIdentical` | function | Groups the selected images whose bytes are identical. |
|
|
319
|
-
| `collectCaptureErrors` | function | Finds the journey artifact lines that report an uncaught, unhandled, or logged error. |
|
|
320
|
-
| `readCaptureRunning` | function | Checks whether a process with this id is running, counting one the caller may not signal. |
|
|
321
|
-
| `resolveCaptureWrapperProject` | function | Resolves one entry of a wrapper's project list to the project it declares. |
|
|
322
|
-
| `readCaptureEntry` | function | Reads one wrapper project, as the description file holds it, into its host declarations and viewport. |
|
|
323
|
-
| `resolveCaptureRequests` | function | Resolves the directory that holds the runner's request files for the process that reads them. |
|
|
324
|
-
| `buildCaptureDiscoveryConfig` | function | Builds the empty Node configuration a wrapper returns once it has answered a discovery request. |
|
|
325
|
-
| `readCaptureDescription` | function | Accepts the description a wrapper wrote only when it answers this exchange and no other. |
|
|
326
|
-
| `answerCaptureDiscovery` | function | Answers the runner's discovery request from the wrapper, before the wrapper does any other work. |
|
|
327
|
-
| `readCaptureRegistryArguments` | function | Reads the registry command line into the wrapper path, the variants to refresh, and the mode. |
|
|
328
|
-
| `readCaptureInputs` | function | Reads the bounded input population a project declares, as file paths and content hashes. |
|
|
329
|
-
| `writeCaptureDocument` | function | Writes one JSON document atomically, so a reader sees the old bytes or the new and never a part. |
|
|
330
|
-
| `readCaptureAncestor` | function | Finds the nearest existing path without following a dangling link. |
|
|
331
|
-
| `resolveCapturePhysical` | function | Resolves an existing path or its nearest existing ancestor to its physical destination. |
|
|
332
|
-
| `requireCaptureContained` | function | Validates a physical destination against a physical root before any read or write. |
|
|
333
|
-
| `resolveCaptureSheetIdentity` | function | Names a sheet group by portfolio, owner, and state independently of its output variant. |
|
|
334
|
-
| `splitCapturePages` | function | Splits a list into consecutive pages with at most the requested size. |
|
|
335
|
-
| `matchesCaptureFile` | function | Compares file content, size, modification time, and change time across two snapshots. |
|
|
336
|
-
| `mergeCaptureLookups` | function | Merges unique lookup populations with incoming identities replacing inherited ones. |
|
|
337
|
-
| `describeCaptureFault` | function | Describes a refusal with its key path, bounded preview, correction, and member differences. |
|
|
338
|
-
| `resolveCaptureExit` | function | Maps usage refusals to exit 64 and every other failure to exit 1. |
|
|
339
|
-
| `requireCaptureArgument` | function | Validates a supplied path argument before work and classifies an outside value as usage. |
|
|
340
|
-
| `matchesCaptureTransient` | function | Recognizes filesystem contention codes that ownership arbitration can retry. |
|
|
341
|
-
| `settleCaptureShutdown` | function | Settles independent request removal and child termination without hiding either failure. |
|
|
342
|
-
| `describeCaptureMembers` | function | Describes a bounded member population and the number omitted from its preview. |
|
|
343
|
-
| `describeCaptureOutput` | function | Caps external diagnostic text and names the number of omitted characters. |
|
|
344
|
-
| `requireCaptureSelection` | function | Refuses unknown command selections from the wrapper before authenticating disk evidence. |
|
|
345
|
-
| `readCaptureVariants` | function | Reads output variant candidates without authenticating or accepting registry evidence. |
|
|
346
|
-
| `readCaptureImage` | function | Reads an image only after its opened file's size is inside the compressed-byte budget. |
|
|
347
|
-
| `readCaptureSeparator` | function | Reads the installed workspace Vitest's exact title separator, refusing unsupported majors. |
|
|
348
|
-
| `readCaptureTitles` | function | Reads original title segments from the accepted registry's authenticated JSON reporter files. |
|
|
349
|
-
| `requireCaptureImageSize` | function | Refuses compressed image bytes before file reads or chunk-buffer allocation. |
|
|
276
|
+
| Name | Kind | Signature | Summary |
|
|
277
|
+
| ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
278
|
+
| `computeCaptureHash` | function | `(bytes: string \| Uint8Array) => string` | Hashes exact source or image bytes with SHA-256. |
|
|
279
|
+
| `normalizeSlashes` | function | `(path: string) => string` | Normalizes a host path to forward slashes. |
|
|
280
|
+
| `buildCaptureDigest` | function | `(patterns: readonly string[], files: Readonly<Record<string, string>>) => CaptureDigest` | Computes the digest of both pattern declarations and expanded path and hash membership. |
|
|
281
|
+
| `buildCaptureLookupJournal` | function | `(lookups: readonly CaptureLookup[], collections: readonly CaptureCollectionReceipt[], manifest?: string) => CaptureLookupJournal` | Stores each distinct lookup input population once in a manifest-bound journal. |
|
|
282
|
+
| `readCaptureLookups` | function | `(journal: CaptureLookupJournal) => readonly CaptureLookup[]` | Resolves journal lookup references after verifying each stored input population's digest. |
|
|
283
|
+
| `computeRegistryDigest` | function | `(registry: Pick<CaptureRegistry, 'version' \| 'receipts' \| 'entries'>) => string` | Computes the registry identity from its authenticated receipts and exact output population. |
|
|
284
|
+
| `buildCaptureRegistry` | function | `(inputs: readonly CaptureReceiptInput[]) => CaptureRegistry` | Imports complete receipts only after their actual exits and exact report bytes validate. |
|
|
285
|
+
| `matchesCaptureSignature` | function | `(bytes: Uint8Array) => boolean` | Checks whether bytes open with the eight-byte PNG signature. |
|
|
286
|
+
| `predictCaptureByte` | function | `(left: number, up: number, corner: number) => number` | Computes the PNG Paeth predictor used by both image readers. |
|
|
287
|
+
| `readCaptureChunks` | function | `(bytes: Buffer, offset?: number) => readonly Buffer[]` | Reads PNG compressed-data chunks while refusing truncated or corrupt image bytes. |
|
|
288
|
+
| `unfilterCaptureRow` | function | `(filter: number, line: Uint8Array, above: Uint8Array \| undefined, channels: number) => Uint8Array` | Reconstructs one filtered PNG scanline from its filter byte and the row above. |
|
|
289
|
+
| `inflateCaptureStream` | function | `(data: Buffer, length: number) => Buffer` | Inflates a PNG's compressed stream, refusing one that is corrupt or longer than declared. |
|
|
290
|
+
| `decodeCapturePicture` | function | `(bytes: Buffer) => CapturePicture` | Decodes the eight-bit, non-interlaced PNGs the capture readers consume. |
|
|
291
|
+
| `encodeCaptureWord` | function | `(value: number) => Buffer` | Encodes an unsigned 32-bit integer as four big-endian bytes. |
|
|
292
|
+
| `encodeCaptureChunk` | function | `(name: string, data: Buffer) => Buffer` | Encodes one checked PNG chunk for contact-sheet output. |
|
|
293
|
+
| `encodeCapturePicture` | function | `(picture: CapturePicture, compressed?: boolean) => Buffer` | Encodes an RGB picture using the contact-sheet writer's native PNG format. |
|
|
294
|
+
| `shrinkCapturePicture` | function | `(picture: CapturePicture, factor: number, limit: number) => CapturePicture` | Scales a picture with an exact area average and clips its displayed height. |
|
|
295
|
+
| `composeCapturePictures` | function | `(pictures: readonly CapturePicture[], vertical: boolean, gap?: number) => CapturePicture` | Composes pictures on the contact-sheet gray background. |
|
|
296
|
+
| `readCaptureRequestOwner` | function | `(name: string) => number \| undefined` | Reads the process id that a request file, or its temporary sibling, names. |
|
|
297
|
+
| `resolveCaptureRelative` | function | `(root: string, target: string) => string` | Resolves a path to the slash-separated form the evidence documents store, relative to a root. |
|
|
298
|
+
| `escapeCapturePattern` | function | `(text: string) => string` | Escapes every regular-expression metacharacter so a case name matches only itself. |
|
|
299
|
+
| `buildCaptureFilter` | function | `(command: CaptureCommand, selector: string, selectors: readonly string[]) => string` | Builds the tag expression that selects an owner population, and its capture tags for frames. |
|
|
300
|
+
| `resolveCaptureStages` | function | `(variants: readonly string[], first: string, command: CaptureRequest['command']) => readonly CaptureStagePlan[]` | Plans one selected journey stage or narrow and remaining frame stages. |
|
|
301
|
+
| `resolveCaptureVariants` | function | `(selected: readonly string[], projects: readonly CaptureProject[]) => readonly string[]` | Resolves selected producing variants in declaration order and requires their projects. |
|
|
302
|
+
| `buildCaptureChangePlan` | function | `(paths: readonly string[], entries: readonly CaptureDestination[]) => CaptureChangePlan` | Classifies changed paths through accepted patterns and reduces owners by ancestry. |
|
|
303
|
+
| `renderCaptureCommand` | function | `(command: CaptureCommand \| 'registry', parsed: CaptureRunnerArguments, selector: string \| undefined, root: string) => string` | Renders an exact owner command with the selected variants and filters in host shell syntax. |
|
|
304
|
+
| `buildCaptureArguments` | function | `(options: CaptureArgumentsOptions) => readonly string[]` | Builds the exact Node argument array that spawns one Vitest stage. |
|
|
305
|
+
| `readCaptureOptions` | function | `<Options extends ParseArgsOptionsConfig>(argv: readonly string[], options: Options, usage: string) => CaptureParsedArguments<Options>` | Parses standard option tokens and refuses empty values, terminators, and repeated single options. |
|
|
306
|
+
| `readCaptureArguments` | function | `(argv: readonly string[], command: CaptureCommand, root: string, fallback: string) => CaptureRunnerArguments` | Reads the runner's command line into one selector, its flags, and the resolved wrapper path. |
|
|
307
|
+
| `readCapturePortfolios` | function | `(value: unknown, subject: string) => readonly CapturePortfolioRoot[]` | Reads the physical portfolio roots a wrapper declares and refuses a malformed or repeated root. |
|
|
308
|
+
| `readCaptureProject` | function | `(test: unknown) => CaptureProject` | Reads one wrapper project's host declarations from its Vitest test configuration. |
|
|
309
|
+
| `describeCapturePortfolios` | function | `(project: Pick<CaptureProject, 'portfolios' \| 'standalone'>) => readonly string[]` | Describes a project's portfolio roots as comparable lines, primary roots apart from standalone ones. |
|
|
310
|
+
| `requireCaptureProjects` | function | `(projects: readonly CaptureProject[]) => CaptureProject` | Refuses a wrapper project set whose members repeat or disagree on a host declaration. |
|
|
311
|
+
| `describeCaptureSelectorFault` | function | `(selector: string, selectors: readonly string[]) => string \| undefined` | Describes why a selector names nothing the wrapper declares, naming the first unknown segment. |
|
|
312
|
+
| `buildCaptureRequestRefusal` | function | `(file: string, cause?: unknown) => CaptureError` | Builds the refusal a wrapper raises for a request file it cannot accept as its parent's. |
|
|
313
|
+
| `readCaptureRequest` | function | `(options: CaptureRequestOptions) => CaptureRequest \| undefined` | Reads and validates the request the runner wrote for the wrapper process that is its child. |
|
|
314
|
+
| `readCaptureReaderArguments` | function | `(argv: readonly string[], root: string, defaults: CaptureReaderDefaults, command?: 'preflight' \| 'sheets') => CaptureReaderCommand` | Reads a reader's command line into its selection, its flags, and the resolved paths. |
|
|
315
|
+
| `readCaptureViewport` | function | `(test: unknown) => CaptureViewport` | Reads the viewport a wrapper project's producing variant declares. |
|
|
316
|
+
| `buildCaptureIntegrityOptions` | function | `(root: string, project: CaptureProject, standalone?: CapturePortfolioRoot) => CaptureIntegrityOptions` | Derives the integrity engine's options from a wrapper project's host declarations. |
|
|
317
|
+
| `scanCaptureFrames` | function | `(images: readonly CaptureImageResult[], producers: readonly CaptureProducer[]) => readonly string[]` | Reports a portfolio, owner, and viewport whose frames mix cropped, viewport-sized, and page-sized images. |
|
|
318
|
+
| `collectCaptureIdentical` | function | `(images: readonly CaptureImageResult[]) => ReadonlyArray<readonly string[]>` | Groups the selected images whose bytes are identical. |
|
|
319
|
+
| `collectCaptureErrors` | function | `(file: string, text: string) => readonly string[]` | Finds the journey artifact lines that report an uncaught, unhandled, or logged error. |
|
|
320
|
+
| `readCaptureRunning` | function | `(pid: number) => boolean` | Checks whether a process with this id is running, counting one the caller may not signal. |
|
|
321
|
+
| `resolveCaptureWrapperProject` | function | `(input: unknown) => Promise<unknown>` | Resolves one entry of a wrapper's project list to the project it declares. |
|
|
322
|
+
| `readCaptureEntry` | function | `(value: unknown) => CaptureHostEntry` | Reads one wrapper project, as the description file holds it, into its host declarations and viewport. |
|
|
323
|
+
| `resolveCaptureRequests` | function | `(directory?: string) => string` | Resolves the directory that holds the runner's request files for the process that reads them. |
|
|
324
|
+
| `buildCaptureDiscoveryConfig` | function | `() => { readonly test: { readonly include: string[]; readonly passWithNoTests: boolean; readonly watch: boolean; }; }` | Builds the empty Node configuration a wrapper returns once it has answered a discovery request. |
|
|
325
|
+
| `readCaptureDescription` | function | `(value: unknown, expected: CaptureDescriptionExpectation) => CaptureHostDescription` | Accepts the description a wrapper wrote only when it answers this exchange and no other. |
|
|
326
|
+
| `answerCaptureDiscovery` | function | `(options: CaptureDiscoveryOptions) => Promise<boolean>` | Answers the runner's discovery request from the wrapper, before the wrapper does any other work. |
|
|
327
|
+
| `readCaptureRegistryArguments` | function | `(argv: readonly string[], root: string, fallback: string) => CaptureRegistryArguments` | Reads the registry command line into the wrapper path, the variants to refresh, and the mode. |
|
|
328
|
+
| `readCaptureInputs` | function | `(root: string, patterns: readonly string[], hash?: CaptureHashHandler, read?: CaptureInputHandler) => Readonly<Record<string, string>>` | Reads the bounded input population a project declares, as file paths and content hashes. |
|
|
329
|
+
| `writeCaptureDocument` | function | `(path: string, value: unknown, signal?: AbortSignal) => void` | Writes one JSON document atomically, so a reader sees the old bytes or the new and never a part. |
|
|
330
|
+
| `readCaptureAncestor` | function | `(path: string) => string` | Finds the nearest existing path without following a dangling link. |
|
|
331
|
+
| `resolveCapturePhysical` | function | `(path: string) => string` | Resolves an existing path or its nearest existing ancestor to its physical destination. |
|
|
332
|
+
| `requireCaptureContained` | function | `(root: string, path: string) => string` | Validates a physical destination against a physical root before any read or write. |
|
|
333
|
+
| `resolveCaptureSheetIdentity` | function | `(entry: CaptureDestination) => string` | Names a sheet group by portfolio, owner, and state independently of its output variant. |
|
|
334
|
+
| `splitCapturePages` | function | `<T>(entries: readonly T[], size: number) => ReadonlyArray<readonly T[]>` | Splits a list into consecutive pages with at most the requested size. |
|
|
335
|
+
| `matchesCaptureFile` | function | `(previous: CaptureFileSnapshot, current: CaptureFileSnapshot \| undefined) => boolean` | Compares file content, size, modification time, and change time across two snapshots. |
|
|
336
|
+
| `mergeCaptureLookups` | function | `(previous: readonly CaptureLookup[], lookups: readonly CaptureLookup[]) => readonly CaptureLookup[]` | Merges unique lookup populations with incoming identities replacing inherited ones. |
|
|
337
|
+
| `describeCaptureFault` | function | `(path: string, value: unknown, expected: string, candidates?: readonly string[], required?: readonly string[], allowed?: readonly string[]) => string` | Describes a refusal with its key path, bounded preview, correction, and member differences. |
|
|
338
|
+
| `resolveCaptureExit` | function | `(error: unknown) => number` | Maps usage refusals to exit 64 and every other failure to exit 1. |
|
|
339
|
+
| `requireCaptureArgument` | function | `(root: string, path: string, flag: string) => string` | Validates a supplied path argument before work and classifies an outside value as usage. |
|
|
340
|
+
| `matchesCaptureTransient` | function | `(error: unknown, platform?: NodeJS.Platform) => boolean` | Recognizes filesystem contention codes that ownership arbitration can retry. |
|
|
341
|
+
| `settleCaptureShutdown` | function | `(retract: CaptureRetractionHandler, terminations: readonly CaptureTerminationHandler[]) => Promise<readonly unknown[]>` | Settles independent request removal and child termination without hiding either failure. |
|
|
342
|
+
| `describeCaptureMembers` | function | `(members: readonly string[]) => string` | Describes a bounded member population and the number omitted from its preview. |
|
|
343
|
+
| `describeCaptureOutput` | function | `(output: string) => string` | Caps external diagnostic text and names the number of omitted characters. |
|
|
344
|
+
| `requireCaptureSelection` | function | `(selector: string, variants: readonly string[], projects: readonly CaptureProject[], outputs?: readonly string[], portfolio?: string) => void` | Refuses unknown command selections from the wrapper before authenticating disk evidence. |
|
|
345
|
+
| `readCaptureVariants` | function | `(root: string, file: string) => readonly string[]` | Reads output variant candidates without authenticating or accepting registry evidence. |
|
|
346
|
+
| `readCaptureImage` | function | `(file: string) => Buffer` | Reads an image only after its opened file's size is inside the compressed-byte budget. |
|
|
347
|
+
| `readCaptureSeparator` | function | `(entry: string) => string` | Reads the installed workspace Vitest's exact title separator, refusing unsupported majors. |
|
|
348
|
+
| `readCaptureTitles` | function | `(root: string, file: string, selector?: string) => Readonly<Record<string, readonly string[]>>` | Reads original title segments from the accepted registry's authenticated JSON reporter files. |
|
|
349
|
+
| `requireCaptureImageSize` | function | `(size: number) => void` | Refuses compressed image bytes before file reads or chunk-buffer allocation. |
|
|
350
350
|
|
|
351
351
|
### Server classes and factories
|
|
352
352
|
|
|
353
353
|
The integrity engine from [`CaptureIntegrity.ts`](../src/server/CaptureIntegrity.ts) and its factory from [`factories.ts`](../src/server/factories.ts).
|
|
354
354
|
|
|
355
|
-
| Name | Kind | Summary |
|
|
356
|
-
| ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------ |
|
|
357
|
-
| `CaptureIntegrity` | class | Validates capture transactions, freshness, and state lookup against real filesystem evidence. |
|
|
358
|
-
| `createCaptureIntegrity` | function | Creates the integrity engine bound to an explicit workspace and host portfolio mapping. |
|
|
359
|
-
| `CaptureRunner` | class | Drives selected owners through one journey stage or staged frame captures. |
|
|
360
|
-
| `CaptureInvocation` | class | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
361
|
-
| `CaptureDiscovery` | class | Reads a consumer's wrapper by running the consumer's installed Vitest in discovery mode. |
|
|
362
|
-
| `createCaptureDiscovery` | function | Creates the discovery that reads a consumer's wrapper through the consumer's own Vitest. |
|
|
363
|
-
| `createCaptureRunner` | function | Creates the runner that drives owner-selected journeys for one command line. |
|
|
364
|
-
| `CapturePreflight` | class | Reads the selected population's frames and reports their freshness, mixed observations, and coverage. |
|
|
365
|
-
| `CaptureSheets` | class | Composes exactly the authenticated sparse state and output pairs for iteration review. |
|
|
366
|
-
| `createCapturePreflight` | function | Creates the preflight that judges the selected frames' freshness, mixed observations, and coverage. |
|
|
367
|
-
| `createCaptureSheets` | function | Creates the contact-sheet writer for the selected frames. |
|
|
368
|
-
| `CaptureRegistrar` | class | Refreshes the accepted registry from one complete capture-free journey per producing variant. |
|
|
369
|
-
| `createCaptureRegistrar` | function | Creates the registry refresh that runs each producing variant's complete journey and publishes the registry. |
|
|
370
|
-
| `CaptureCLI` | class | Dispatches capture commands and maps usage and evidence refusals to their exit codes. |
|
|
371
|
-
| `createCaptureCLI` | function | Creates the executable's command dispatcher over a workspace and injected writers. |
|
|
355
|
+
| Name | Kind | Signature | Summary |
|
|
356
|
+
| ------------------------ | -------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
|
357
|
+
| `CaptureIntegrity` | class | `new (options: CaptureIntegrityOptions) => CaptureIntegrityInterface` | Validates capture transactions, freshness, and state lookup against real filesystem evidence. |
|
|
358
|
+
| `createCaptureIntegrity` | function | `(options: CaptureIntegrityOptions) => CaptureIntegrityInterface` | Creates the integrity engine bound to an explicit workspace and host portfolio mapping. |
|
|
359
|
+
| `CaptureRunner` | class | `new (options: CaptureRunnerOptions) => CaptureRunnerInterface` | Drives selected owners through one journey stage or staged frame captures. |
|
|
360
|
+
| `CaptureInvocation` | class | `new (options: CaptureInvocationOptions) => CaptureInvocationInterface` | Owns one runner invocation's identity, request file, children, and interruption. |
|
|
361
|
+
| `CaptureDiscovery` | class | `new (options: CaptureDiscoveryRunOptions) => CaptureDiscoveryInterface` | Reads a consumer's wrapper by running the consumer's installed Vitest in discovery mode. |
|
|
362
|
+
| `createCaptureDiscovery` | function | `(options: CaptureDiscoveryRunOptions) => CaptureDiscoveryInterface` | Creates the discovery that reads a consumer's wrapper through the consumer's own Vitest. |
|
|
363
|
+
| `createCaptureRunner` | function | `(options: CaptureRunnerOptions) => CaptureRunnerInterface` | Creates the runner that drives owner-selected journeys for one command line. |
|
|
364
|
+
| `CapturePreflight` | class | `new (options: CaptureReaderOptions) => CapturePreflightInterface` | Reads the selected population's frames and reports their freshness, mixed observations, and coverage. |
|
|
365
|
+
| `CaptureSheets` | class | `new (options: CaptureSheetOptions) => CaptureSheetsInterface` | Composes exactly the authenticated sparse state and output pairs for iteration review. |
|
|
366
|
+
| `createCapturePreflight` | function | `(options: CaptureReaderOptions) => CapturePreflightInterface` | Creates the preflight that judges the selected frames' freshness, mixed observations, and coverage. |
|
|
367
|
+
| `createCaptureSheets` | function | `(options: CaptureSheetOptions) => CaptureSheetsInterface` | Creates the contact-sheet writer for the selected frames. |
|
|
368
|
+
| `CaptureRegistrar` | class | `new (options: CaptureRegistrarOptions) => CaptureRegistrarInterface` | Refreshes the accepted registry from one complete capture-free journey per producing variant. |
|
|
369
|
+
| `createCaptureRegistrar` | function | `(options: CaptureRegistrarOptions) => CaptureRegistrarInterface` | Creates the registry refresh that runs each producing variant's complete journey and publishes the registry. |
|
|
370
|
+
| `CaptureCLI` | class | `new (options?: CaptureCLIOptions) => CaptureCLIInterface` | Dispatches capture commands and maps usage and evidence refusals to their exit codes. |
|
|
371
|
+
| `createCaptureCLI` | function | `(options?: CaptureCLIOptions) => CaptureCLIInterface` | Creates the executable's command dispatcher over a workspace and injected writers. |
|
|
372
372
|
|
|
373
373
|
## Methods
|
|
374
374
|
|