my-frontend-observer 0.6.0 → 0.7.0
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/CHANGELOG.md +79 -0
- package/README.md +43 -4
- package/dist/application/externalReferencePersistenceService.d.ts +75 -0
- package/dist/application/externalReferencePersistenceService.js +182 -0
- package/dist/application/externalReferencePersistenceService.js.map +1 -0
- package/dist/application/referenceFidelityEvaluationService.d.ts +28 -0
- package/dist/application/referenceFidelityEvaluationService.js +45 -0
- package/dist/application/referenceFidelityEvaluationService.js.map +1 -0
- package/dist/artifacts/externalReferenceArtifactReader.d.ts +18 -0
- package/dist/artifacts/externalReferenceArtifactReader.js +35 -0
- package/dist/artifacts/externalReferenceArtifactReader.js.map +1 -0
- package/dist/artifacts/externalReferenceArtifactWriter.d.ts +44 -0
- package/dist/artifacts/externalReferenceArtifactWriter.js +77 -0
- package/dist/artifacts/externalReferenceArtifactWriter.js.map +1 -0
- package/dist/cli.js +844 -0
- package/dist/cli.js.map +1 -1
- package/dist/domain/boundedAgentContext.d.ts +52 -0
- package/dist/domain/boundedAgentContext.js +44 -1
- package/dist/domain/boundedAgentContext.js.map +1 -1
- package/dist/domain/boundedAgentContextIdentity.d.ts +16 -6
- package/dist/domain/boundedAgentContextIdentity.js +22 -6
- package/dist/domain/boundedAgentContextIdentity.js.map +1 -1
- package/dist/domain/boundedAgentContextProjection.d.ts +11 -0
- package/dist/domain/boundedAgentContextProjection.js +32 -4
- package/dist/domain/boundedAgentContextProjection.js.map +1 -1
- package/dist/domain/comparison.d.ts +23 -1
- package/dist/domain/comparison.js +27 -1
- package/dist/domain/comparison.js.map +1 -1
- package/dist/domain/comparisonEngine.d.ts +34 -6
- package/dist/domain/comparisonEngine.js +48 -8
- package/dist/domain/comparisonEngine.js.map +1 -1
- package/dist/domain/diagnostics.d.ts +1 -1
- package/dist/domain/diagnostics.js +16 -0
- package/dist/domain/diagnostics.js.map +1 -1
- package/dist/domain/explicitState.d.ts +40 -0
- package/dist/domain/explicitState.js +54 -0
- package/dist/domain/explicitState.js.map +1 -0
- package/dist/domain/externalReference.d.ts +158 -0
- package/dist/domain/externalReference.js +167 -0
- package/dist/domain/externalReference.js.map +1 -0
- package/dist/domain/externalReferenceApplicability.d.ts +43 -0
- package/dist/domain/externalReferenceApplicability.js +52 -0
- package/dist/domain/externalReferenceApplicability.js.map +1 -0
- package/dist/domain/externalReferenceCompatibility.d.ts +40 -0
- package/dist/domain/externalReferenceCompatibility.js +48 -0
- package/dist/domain/externalReferenceCompatibility.js.map +1 -0
- package/dist/domain/externalReferenceFidelity.d.ts +141 -0
- package/dist/domain/externalReferenceFidelity.js +413 -0
- package/dist/domain/externalReferenceFidelity.js.map +1 -0
- package/dist/domain/externalReferenceIdentity.d.ts +38 -0
- package/dist/domain/externalReferenceIdentity.js +70 -0
- package/dist/domain/externalReferenceIdentity.js.map +1 -0
- package/dist/domain/externalReferenceImage.d.ts +35 -0
- package/dist/domain/externalReferenceImage.js +160 -0
- package/dist/domain/externalReferenceImage.js.map +1 -0
- package/dist/domain/externalReferenceRegionRelationships.d.ts +63 -0
- package/dist/domain/externalReferenceRegionRelationships.js +98 -0
- package/dist/domain/externalReferenceRegionRelationships.js.map +1 -0
- package/dist/domain/externalReferenceRegions.d.ts +65 -0
- package/dist/domain/externalReferenceRegions.js +105 -0
- package/dist/domain/externalReferenceRegions.js.map +1 -0
- package/dist/domain/externalReferenceRequirementIdentity.d.ts +12 -0
- package/dist/domain/externalReferenceRequirementIdentity.js +35 -0
- package/dist/domain/externalReferenceRequirementIdentity.js.map +1 -0
- package/dist/domain/externalReferenceRequirements.d.ts +215 -0
- package/dist/domain/externalReferenceRequirements.js +401 -0
- package/dist/domain/externalReferenceRequirements.js.map +1 -0
- package/dist/domain/externalReferenceRuntimeBinding.d.ts +146 -0
- package/dist/domain/externalReferenceRuntimeBinding.js +183 -0
- package/dist/domain/externalReferenceRuntimeBinding.js.map +1 -0
- package/dist/domain/identity.d.ts +11 -8
- package/dist/domain/identity.js +12 -8
- package/dist/domain/identity.js.map +1 -1
- package/dist/domain/referenceCorrectionIdentity.d.ts +40 -0
- package/dist/domain/referenceCorrectionIdentity.js +77 -0
- package/dist/domain/referenceCorrectionIdentity.js.map +1 -0
- package/dist/domain/referenceCorrectionWorkflow.d.ts +160 -0
- package/dist/domain/referenceCorrectionWorkflow.js +165 -0
- package/dist/domain/referenceCorrectionWorkflow.js.map +1 -0
- package/dist/domain/referenceFidelityProjection.d.ts +65 -0
- package/dist/domain/referenceFidelityProjection.js +135 -0
- package/dist/domain/referenceFidelityProjection.js.map +1 -0
- package/dist/domain/relationships.d.ts +43 -1
- package/dist/domain/relationships.js +15 -6
- package/dist/domain/relationships.js.map +1 -1
- package/dist/domain/schema.js +6 -0
- package/dist/domain/schema.js.map +1 -1
- package/dist/index.d.ts +39 -4
- package/dist/index.js +21 -2
- package/dist/index.js.map +1 -1
- package/dist/request/request.d.ts +12 -0
- package/dist/request/request.js +12 -0
- package/dist/request/request.js.map +1 -1
- package/docs/ARCHITECTURE.md +271 -11
- package/docs/CI_CD.md +50 -0
- package/docs/COMMANDS.md +187 -0
- package/docs/CONTRACTS.md +1347 -12
- package/docs/CURRENT_STATE.md +451 -13
- package/docs/PROJECT_DESCRIPTION.md +513 -88
- package/docs/PROJECT_MILESTONES.md +550 -97
- package/docs/PROJECT_OVERVIEW.md +56 -14
- package/docs/QUICKSTART.md +6 -0
- package/docs/RELEASE.md +28 -21
- package/docs/ROADMAP.md +238 -99
- package/docs/SECURITY.md +80 -4
- package/docs/WORKFLOWS.md +358 -23
- package/docs/reports/v0.7-bounded-fidelity-context-prompt7.md +243 -0
- package/docs/reports/v0.7-implementation-completeness-documentation-reconciliation.md +497 -0
- package/docs/reports/v0.7-pre-release-readiness.md +337 -0
- package/docs/reports/v0.7-reference-binding-prompt5.md +223 -0
- package/docs/reports/v0.7-reference-compatibility-prompt4.md +234 -0
- package/docs/reports/v0.7-reference-correction-workflow-prompt8.md +222 -0
- package/docs/reports/v0.7-reference-fidelity-prompt6.md +216 -0
- package/docs/reports/v0.7-reference-foundation-prompt1.md +151 -0
- package/docs/reports/v0.7-reference-regions-prompt2.md +195 -0
- package/docs/reports/v0.7-reference-requirements-prompt3.md +217 -0
- package/docs/reports/v0.7-release-prep.md +423 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,84 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.7.0 - 2026-09-06
|
|
4
|
+
|
|
5
|
+
End-to-End Coding-Agent Frontend Change Review.
|
|
6
|
+
|
|
7
|
+
- External-reference artifact and lifecycle: `import-reference`/
|
|
8
|
+
`approve-reference` persist an externally supplied PNG/JPEG/WebP
|
|
9
|
+
design-reference image (header-only format/dimension detection - no
|
|
10
|
+
decode, no OCR, no computer vision) through an explicit two-state
|
|
11
|
+
(`imported`/`approved`) lifecycle. Supersession is represented only as a
|
|
12
|
+
forward pointer to a newer artifact - an existing persisted artifact's own
|
|
13
|
+
manifest is never rewritten.
|
|
14
|
+
- Explicit reference regions and geometry relationships: user/configuration-
|
|
15
|
+
authored rectangles over the reference image, related to each other
|
|
16
|
+
through the same six geometry-only relationship families (horizontal
|
|
17
|
+
order, vertical order, area overlap, relative width, geometric fit,
|
|
18
|
+
vertical sequencing) already used for runtime targets - derived on demand,
|
|
19
|
+
never persisted.
|
|
20
|
+
- Selected design requirements and tolerance semantics: explicit,
|
|
21
|
+
never-inferred requirements over region properties, region-to-region
|
|
22
|
+
relationships, and derived two-region measurements, reusing v0.5's
|
|
23
|
+
requested/expected-dependent/protected/preserved categories directly.
|
|
24
|
+
Three reference-owned tolerance kinds (`exact`/`absolute-reference-px`/
|
|
25
|
+
`percent`) stay distinct from runtime CSS-pixel comparison tolerances.
|
|
26
|
+
- Reference-evidence adequacy: `adequate`/`partial`/`inadequate` reporting on
|
|
27
|
+
whether a reference's own definition actually supports its selected
|
|
28
|
+
requirements, independent of any runtime target or candidate.
|
|
29
|
+
- Explicit applicability and candidate-state compatibility: a shared, closed
|
|
30
|
+
state model (`theme`/`applicationState`/`authenticatedState`, plus an
|
|
31
|
+
applicable CSS-pixel `viewport`) declares which runtime frontend state a
|
|
32
|
+
reference represents. `evaluateReferenceCandidateCompatibility` and
|
|
33
|
+
`observe`'s new `--state-file` reuse v0.4's comparability vocabulary to
|
|
34
|
+
determine whether a reference and a candidate describe the same state -
|
|
35
|
+
an undeclared dimension is never fabricated as a match or a mismatch.
|
|
36
|
+
- Explicit reference-region-to-runtime-target binding: fidelity evaluation
|
|
37
|
+
requires an explicit `{referenceRegion, runtimeTarget}` declaration for
|
|
38
|
+
every region a requirement depends on - never inferred from geometry,
|
|
39
|
+
matching names, or source code.
|
|
40
|
+
- Structured reference-vs-candidate fidelity evaluation: `evaluate-
|
|
41
|
+
reference-fidelity --reference --candidate [--bindings-file] [--enforce]`
|
|
42
|
+
evaluates every selected requirement against live candidate evidence
|
|
43
|
+
through one explicit reference-image-pixel-to-CSS-pixel coordinate scale,
|
|
44
|
+
producing an honest `not-evaluated`/`pass`/`fail` result that never
|
|
45
|
+
fabricates a verdict past a blocked reference-adequacy or
|
|
46
|
+
reference/candidate-compatibility gate.
|
|
47
|
+
- Bounded fidelity integration with v0.6 agent context: `projectBoundedAgentContext`
|
|
48
|
+
gained an optional `fidelity` input so fidelity mismatches compete for the
|
|
49
|
+
same bounded required/permitted-target allocation and adequacy machinery
|
|
50
|
+
v0.5 contract clauses already use - a `not-evaluated` fidelity always
|
|
51
|
+
degrades adequacy rather than being silently reported as "no problems".
|
|
52
|
+
- End-to-end external-reference correction workflow: the programmatic,
|
|
53
|
+
library-only `prepareReferenceCorrection`/`reviewReferenceCorrectionAttempt`
|
|
54
|
+
compose reference fidelity, v0.4 comparison, and v0.5 contract evaluation
|
|
55
|
+
into one overall result - matching the reference is necessary but never
|
|
56
|
+
sufficient, so a candidate that visually satisfies the reference while
|
|
57
|
+
regressing an active protected/preserved contract clause still resolves to
|
|
58
|
+
overall `FAIL`. Neither function edits target source, launches a browser,
|
|
59
|
+
or calls a remote AI provider; an external implementation actor (a human
|
|
60
|
+
or a coding agent) makes the actual change between review attempts.
|
|
61
|
+
- Real-browser regression protection: a dedicated Chromium-driven test
|
|
62
|
+
proves a full success correction, a protected-regression case, a
|
|
63
|
+
two-attempt correction iteration against the same baseline, and an
|
|
64
|
+
incompatible-viewport blocking case, all against a disposable,
|
|
65
|
+
repository-local fixture copy the observer itself never edits.
|
|
66
|
+
- Three new public CLI commands (`import-reference`, `approve-reference`,
|
|
67
|
+
`evaluate-reference-fidelity`) and a complete new programmatic export
|
|
68
|
+
surface (`src/index.ts`) for the reference/region/requirement/
|
|
69
|
+
applicability/compatibility/binding/fidelity/correction-workflow types and
|
|
70
|
+
functions. External-reference schema is `1.0.0`, independent of the
|
|
71
|
+
observation, comparison, frontend-contract, evaluation, and
|
|
72
|
+
bounded-agent-context schema versions, none of which changed.
|
|
73
|
+
- Cross-platform packed-candidate validation: the pre-version-bump
|
|
74
|
+
implementation candidate tarball `my-frontend-observer-0.6.0.tgz`
|
|
75
|
+
(SHA-256 `0347b1f3cfd5d311e13b405c0c2fbc2f507e250cb63223d58b4d2d31df029414`)
|
|
76
|
+
was hash-verified and proven on Windows, Linux, and macOS, including an
|
|
77
|
+
installed-package smoke of every new v0.7 CLI command and programmatic
|
|
78
|
+
export alongside every pre-existing v0.1-v0.6 packed behavior, before this
|
|
79
|
+
release's version bump - see
|
|
80
|
+
`docs/reports/v0.7-pre-release-readiness.md`.
|
|
81
|
+
|
|
3
82
|
## 0.6.0 - 2026-08-19
|
|
4
83
|
|
|
5
84
|
Bounded Agent Context and Native my-dev-kit Ecosystem Integration.
|
package/README.md
CHANGED
|
@@ -6,8 +6,9 @@ in [docs/PROJECT_DESCRIPTION.md](docs/PROJECT_DESCRIPTION.md).
|
|
|
6
6
|
|
|
7
7
|
## Current status
|
|
8
8
|
|
|
9
|
-
`v0.
|
|
10
|
-
|
|
9
|
+
`v0.7.0`, End-to-End Coding-Agent Frontend Change Review, is the current
|
|
10
|
+
published release. It builds on `v0.6.0`, Bounded Agent Context and Native
|
|
11
|
+
my-dev-kit Ecosystem Integration, and `v0.5.0`, Executable Frontend
|
|
11
12
|
Contracts and Explicit Change Scope: `my-frontend-observer observe` launches a real,
|
|
12
13
|
sandboxed Chromium browser, enforces a loopback-only safety policy, captures
|
|
13
14
|
a viewport screenshot plus bounded page/target evidence, and persists it as
|
|
@@ -132,6 +133,43 @@ exported from `src/index.ts` (bounded-agent-context schema `1.0.0`). See
|
|
|
132
133
|
[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for how it fits the existing
|
|
133
134
|
pipeline.
|
|
134
135
|
|
|
136
|
+
### External-reference correction workflow (v0.7.0)
|
|
137
|
+
|
|
138
|
+
`import-reference` and
|
|
139
|
+
`approve-reference` persist an externally supplied design-reference image
|
|
140
|
+
(with optional regions, selected requirements/tolerances, and applicability
|
|
141
|
+
state); `evaluate-reference-fidelity --reference --candidate
|
|
142
|
+
[--bindings-file] [--enforce]` compares an already-persisted candidate
|
|
143
|
+
observation against it, gated by reference adequacy, reference/candidate
|
|
144
|
+
compatibility, and explicit region-to-target bindings:
|
|
145
|
+
|
|
146
|
+
```powershell
|
|
147
|
+
my-frontend-observer import-reference design.png --output references --regions-file regions.json --requirements-file requirements.json --applicability-file applicability.json
|
|
148
|
+
my-frontend-observer approve-reference --reference references/<id> --output references
|
|
149
|
+
my-frontend-observer evaluate-reference-fidelity --reference references/<approved-id> --candidate observations/<id> --bindings-file bindings.json
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
(From a source checkout, use `node dist/cli.js import-reference ...` etc.
|
|
153
|
+
instead.)
|
|
154
|
+
|
|
155
|
+
`import-reference`/`approve-reference`/`evaluate-reference-fidelity` never
|
|
156
|
+
launch a browser or edit any file outside their own declared output
|
|
157
|
+
location; `evaluate-reference-fidelity` persists nothing. A programmatic,
|
|
158
|
+
library-only correction-workflow coordinator
|
|
159
|
+
(`prepareReferenceCorrection`/`reviewReferenceCorrectionAttempt`, exported
|
|
160
|
+
from `src/index.ts`, no CLI command) composes the full cycle - reference
|
|
161
|
+
fidelity (reused unchanged) plus canonical v0.4 comparison and v0.5 contract
|
|
162
|
+
evaluation - into one overall result: matching the reference is necessary
|
|
163
|
+
but never sufficient, so a candidate that visually satisfies the reference
|
|
164
|
+
while regressing an active protected/preserved contract clause still
|
|
165
|
+
resolves to overall `FAIL`. my-frontend-observer never edits target source
|
|
166
|
+
itself; an external implementation actor (a human or a coding agent, never
|
|
167
|
+
this package) makes the actual source change between review attempts. See
|
|
168
|
+
[docs/CONTRACTS.md](docs/CONTRACTS.md) and
|
|
169
|
+
[docs/WORKFLOWS.md](docs/WORKFLOWS.md) for the exact contract and workflow,
|
|
170
|
+
and [docs/CURRENT_STATE.md](docs/CURRENT_STATE.md) for the full
|
|
171
|
+
implementation record.
|
|
172
|
+
|
|
135
173
|
Validation:
|
|
136
174
|
|
|
137
175
|
```powershell
|
|
@@ -139,6 +177,7 @@ npm run typecheck
|
|
|
139
177
|
npm run lint
|
|
140
178
|
npm test
|
|
141
179
|
npm run test:browser
|
|
180
|
+
npm run test:security
|
|
142
181
|
npm run build
|
|
143
182
|
npm run check:docs
|
|
144
183
|
```
|
|
@@ -149,8 +188,8 @@ Planning authorities:
|
|
|
149
188
|
intent and responsibility boundaries.
|
|
150
189
|
- [Project Milestones](docs/PROJECT_MILESTONES.md): complete ordered capability
|
|
151
190
|
design and cross-milestone rules.
|
|
152
|
-
- [ROADMAP](docs/ROADMAP.md): version-level requirements; v0.1-v0.
|
|
153
|
-
released
|
|
191
|
+
- [ROADMAP](docs/ROADMAP.md): version-level requirements; v0.1-v0.7 are
|
|
192
|
+
released; v0.8+ remain future.
|
|
154
193
|
- [Current State](docs/CURRENT_STATE.md): retained scaffold and release state.
|
|
155
194
|
|
|
156
195
|
No sibling ecosystem repository is a runtime dependency of the retained
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import type { Diagnostic } from '../domain/diagnostics.js';
|
|
2
|
+
import type { ReferenceRegion } from '../domain/externalReferenceRegions.js';
|
|
3
|
+
import type { RawReferenceRequirement, ReferenceRequirementAdequacy } from '../domain/externalReferenceRequirements.js';
|
|
4
|
+
import type { ExternalReferenceApplicability } from '../domain/externalReferenceApplicability.js';
|
|
5
|
+
import type { WriteExternalReferenceArtifactOptions } from '../artifacts/externalReferenceArtifactWriter.js';
|
|
6
|
+
export interface ImportExternalReferenceOptions {
|
|
7
|
+
outputLocation: string;
|
|
8
|
+
cwd?: WriteExternalReferenceArtifactOptions['cwd'];
|
|
9
|
+
label?: string;
|
|
10
|
+
/** Root directory of a prior external-reference artifact this import explicitly supersedes. */
|
|
11
|
+
supersedesReferenceRoot?: string;
|
|
12
|
+
/** v0.7 Prompt 2: explicit, user/configuration-authored reference-image regions. Identity-bearing when present - see externalReferenceIdentity.ts. */
|
|
13
|
+
regions?: ReferenceRegion[];
|
|
14
|
+
/** v0.7 Prompt 3: explicit, user/configuration-selected design requirements over `regions` above. Raw (not yet identified) authored input - see domain/externalReferenceRequirements.ts#RawReferenceRequirement. Identity-bearing when present. */
|
|
15
|
+
requirements?: RawReferenceRequirement[];
|
|
16
|
+
/** v0.7 Prompt 4: the runtime frontend state (applicable viewport/theme/application-state/authenticated-state) this reference is intended to represent. Identity-bearing when present. */
|
|
17
|
+
applicability?: ExternalReferenceApplicability;
|
|
18
|
+
}
|
|
19
|
+
export interface ApproveExternalReferenceOptions {
|
|
20
|
+
outputLocation: string;
|
|
21
|
+
cwd?: WriteExternalReferenceArtifactOptions['cwd'];
|
|
22
|
+
/** Root directory of a prior external-reference artifact this approval explicitly supersedes. */
|
|
23
|
+
supersedesReferenceRoot?: string;
|
|
24
|
+
}
|
|
25
|
+
export type ApplicationImportExternalReferenceResult = {
|
|
26
|
+
ok: true;
|
|
27
|
+
referenceId: string;
|
|
28
|
+
referenceRequestId: string;
|
|
29
|
+
artifactRoot: string;
|
|
30
|
+
manifestPath: string;
|
|
31
|
+
imagePath: string;
|
|
32
|
+
regionCount: number;
|
|
33
|
+
requirementCount: number;
|
|
34
|
+
adequacy: ReferenceRequirementAdequacy;
|
|
35
|
+
hasApplicability: boolean;
|
|
36
|
+
} | {
|
|
37
|
+
ok: false;
|
|
38
|
+
diagnostics: Diagnostic[];
|
|
39
|
+
};
|
|
40
|
+
export type ApplicationApproveExternalReferenceResult = {
|
|
41
|
+
ok: true;
|
|
42
|
+
referenceId: string;
|
|
43
|
+
referenceRequestId: string;
|
|
44
|
+
artifactRoot: string;
|
|
45
|
+
manifestPath: string;
|
|
46
|
+
regionCount: number;
|
|
47
|
+
requirementCount: number;
|
|
48
|
+
adequacy: ReferenceRequirementAdequacy;
|
|
49
|
+
hasApplicability: boolean;
|
|
50
|
+
} | {
|
|
51
|
+
ok: false;
|
|
52
|
+
diagnostics: Diagnostic[];
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* The one canonical application-level "import" use case: validates the raw
|
|
56
|
+
* image bytes through the existing pure image-format/dimension boundary
|
|
57
|
+
* (`domain/externalReferenceImage.ts`), resolves an optional explicit
|
|
58
|
+
* supersession target through the existing reader, computes identity through
|
|
59
|
+
* the existing identity module, and persists exactly once through the
|
|
60
|
+
* existing writer. Never approves the result - the persisted artifact's
|
|
61
|
+
* `lifecycle.state` is always `'imported'`, regardless of a supplied label or
|
|
62
|
+
* supersession target (see behavior-model.txt INV-007).
|
|
63
|
+
*/
|
|
64
|
+
export declare function importExternalReference(imageBytes: Uint8Array, options: ImportExternalReferenceOptions): Promise<ApplicationImportExternalReferenceResult>;
|
|
65
|
+
/**
|
|
66
|
+
* The one canonical application-level "approval" use case, mirroring
|
|
67
|
+
* `application/frontendContractPersistenceService.ts#approveAndPersistBaseline`'s
|
|
68
|
+
* shape: reads the target through the existing reader, refuses to approve
|
|
69
|
+
* anything not currently in the `'imported'` lifecycle state, resolves an
|
|
70
|
+
* optional explicit supersession target through the same reader, and
|
|
71
|
+
* persists a brand-new artifact instance - never mutating the imported
|
|
72
|
+
* artifact's own manifest - carrying a `sourceReference` back to it instead
|
|
73
|
+
* of a second copy of the image bytes.
|
|
74
|
+
*/
|
|
75
|
+
export declare function approveExternalReference(importedArtifactRoot: string, options: ApproveExternalReferenceOptions): Promise<ApplicationApproveExternalReferenceResult>;
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { DIAGNOSTIC_SEVERITY } from '../domain/diagnostics.js';
|
|
4
|
+
import { deriveCompletion } from '../domain/completion.js';
|
|
5
|
+
import { getProducerInfo } from '../domain/schema.js';
|
|
6
|
+
import { detectExternalReferenceImageFormat, readExternalReferenceImageDimensions, isValidExternalReferenceImageDimensions, fileExtensionForFormat, EXTERNAL_REFERENCE_MAX_IMAGE_BYTES, } from '../domain/externalReferenceImage.js';
|
|
7
|
+
import { EXTERNAL_REFERENCE_ARTIFACT_KIND, EXTERNAL_REFERENCE_SCHEMA_VERSION, isImportedExternalReferenceArtifact } from '../domain/externalReference.js';
|
|
8
|
+
import { buildExternalReferenceRequestIdentity, buildExternalReferenceInstanceIdentity } from '../domain/externalReferenceIdentity.js';
|
|
9
|
+
import { isValidReferenceRegions } from '../domain/externalReferenceRegions.js';
|
|
10
|
+
import { isValidRawReferenceRequirement, buildReferenceRequirement, isValidReferenceRequirements, deriveReferenceRequirementAdequacy } from '../domain/externalReferenceRequirements.js';
|
|
11
|
+
import { isValidExternalReferenceApplicability } from '../domain/externalReferenceApplicability.js';
|
|
12
|
+
import { normalizeOutputLocation } from '../request/paths.js';
|
|
13
|
+
import { writeExternalReferenceArtifact } from '../artifacts/externalReferenceArtifactWriter.js';
|
|
14
|
+
import { EXTERNAL_REFERENCE_MANIFEST_FILENAME } from '../artifacts/externalReferenceArtifactWriter.js';
|
|
15
|
+
import { readExternalReferenceArtifact } from '../artifacts/externalReferenceArtifactReader.js';
|
|
16
|
+
function failure(code, message) {
|
|
17
|
+
return { ok: false, diagnostics: [{ code, severity: DIAGNOSTIC_SEVERITY[code], message }] };
|
|
18
|
+
}
|
|
19
|
+
async function resolveSupersedesReferenceId(supersedesReferenceRoot) {
|
|
20
|
+
if (supersedesReferenceRoot === undefined)
|
|
21
|
+
return { ok: true };
|
|
22
|
+
const read = await readExternalReferenceArtifact(path.join(supersedesReferenceRoot, EXTERNAL_REFERENCE_MANIFEST_FILENAME));
|
|
23
|
+
if (!read.ok)
|
|
24
|
+
return failure('reference-not-found', `supersedesReferenceRoot: ${read.reason}`);
|
|
25
|
+
return { ok: true, referenceId: read.artifact.referenceId };
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The one canonical application-level "import" use case: validates the raw
|
|
29
|
+
* image bytes through the existing pure image-format/dimension boundary
|
|
30
|
+
* (`domain/externalReferenceImage.ts`), resolves an optional explicit
|
|
31
|
+
* supersession target through the existing reader, computes identity through
|
|
32
|
+
* the existing identity module, and persists exactly once through the
|
|
33
|
+
* existing writer. Never approves the result - the persisted artifact's
|
|
34
|
+
* `lifecycle.state` is always `'imported'`, regardless of a supplied label or
|
|
35
|
+
* supersession target (see behavior-model.txt INV-007).
|
|
36
|
+
*/
|
|
37
|
+
export async function importExternalReference(imageBytes, options) {
|
|
38
|
+
const format = detectExternalReferenceImageFormat(imageBytes);
|
|
39
|
+
if (format === undefined)
|
|
40
|
+
return failure('unsupported-image-format', 'the supplied bytes do not match any supported reference image format (png, jpeg, webp)');
|
|
41
|
+
if (imageBytes.length > EXTERNAL_REFERENCE_MAX_IMAGE_BYTES) {
|
|
42
|
+
return failure('image-too-large', `reference image is ${imageBytes.length} bytes, exceeding the maximum of ${EXTERNAL_REFERENCE_MAX_IMAGE_BYTES} bytes`);
|
|
43
|
+
}
|
|
44
|
+
const dimensions = readExternalReferenceImageDimensions(imageBytes, format);
|
|
45
|
+
if (dimensions === undefined || !isValidExternalReferenceImageDimensions(dimensions)) {
|
|
46
|
+
return failure('invalid-image-dimensions', 'the supplied reference image header does not contain valid, bounded dimensions');
|
|
47
|
+
}
|
|
48
|
+
if (options.regions !== undefined) {
|
|
49
|
+
const regionsValidation = isValidReferenceRegions(options.regions, dimensions.width, dimensions.height);
|
|
50
|
+
if (!regionsValidation.valid)
|
|
51
|
+
return failure('invalid-reference-region', regionsValidation.reason);
|
|
52
|
+
}
|
|
53
|
+
let requirements;
|
|
54
|
+
if (options.requirements !== undefined) {
|
|
55
|
+
const built = [];
|
|
56
|
+
for (const raw of options.requirements) {
|
|
57
|
+
const rawValidation = isValidRawReferenceRequirement(raw);
|
|
58
|
+
if (!rawValidation.valid)
|
|
59
|
+
return failure('invalid-reference-requirement', rawValidation.reason);
|
|
60
|
+
built.push(buildReferenceRequirement(raw));
|
|
61
|
+
}
|
|
62
|
+
const collectionValidation = isValidReferenceRequirements(built, options.regions ?? []);
|
|
63
|
+
if (!collectionValidation.valid)
|
|
64
|
+
return failure('invalid-reference-requirement', collectionValidation.reason);
|
|
65
|
+
requirements = built;
|
|
66
|
+
}
|
|
67
|
+
if (options.applicability !== undefined) {
|
|
68
|
+
const applicabilityValidation = isValidExternalReferenceApplicability(options.applicability);
|
|
69
|
+
if (!applicabilityValidation.valid)
|
|
70
|
+
return failure('invalid-reference-applicability', applicabilityValidation.reason);
|
|
71
|
+
}
|
|
72
|
+
const supersedes = await resolveSupersedesReferenceId(options.supersedesReferenceRoot);
|
|
73
|
+
if (!supersedes.ok)
|
|
74
|
+
return supersedes;
|
|
75
|
+
const normalizedOutput = normalizeOutputLocation(options.outputLocation);
|
|
76
|
+
if (!normalizedOutput.ok)
|
|
77
|
+
return { ok: false, diagnostics: [normalizedOutput.diagnostic] };
|
|
78
|
+
const imageSha256 = createHash('sha256').update(imageBytes).digest('hex');
|
|
79
|
+
const referenceRequestId = buildExternalReferenceRequestIdentity(imageSha256, format, dimensions.width, dimensions.height, supersedes.referenceId, options.regions, requirements, options.applicability);
|
|
80
|
+
const referenceId = buildExternalReferenceInstanceIdentity(referenceRequestId);
|
|
81
|
+
const artifact = {
|
|
82
|
+
artifactKind: EXTERNAL_REFERENCE_ARTIFACT_KIND,
|
|
83
|
+
schemaVersion: EXTERNAL_REFERENCE_SCHEMA_VERSION,
|
|
84
|
+
referenceRequestId,
|
|
85
|
+
referenceId,
|
|
86
|
+
producer: getProducerInfo(),
|
|
87
|
+
provenance: { importedAt: new Date().toISOString(), ...(options.label === undefined ? {} : { label: options.label }) },
|
|
88
|
+
image: {
|
|
89
|
+
path: `reference.${fileExtensionForFormat(format)}`,
|
|
90
|
+
format,
|
|
91
|
+
width: dimensions.width,
|
|
92
|
+
height: dimensions.height,
|
|
93
|
+
byteLength: imageBytes.length,
|
|
94
|
+
sha256: imageSha256,
|
|
95
|
+
},
|
|
96
|
+
lifecycle: { state: 'imported' },
|
|
97
|
+
...(supersedes.referenceId === undefined ? {} : { supersedesReferenceId: supersedes.referenceId }),
|
|
98
|
+
...(options.regions === undefined ? {} : { regions: options.regions }),
|
|
99
|
+
...(requirements === undefined ? {} : { requirements }),
|
|
100
|
+
...(options.applicability === undefined ? {} : { applicability: options.applicability }),
|
|
101
|
+
diagnostics: [],
|
|
102
|
+
completion: deriveCompletion([], 'post-capture'),
|
|
103
|
+
};
|
|
104
|
+
const persisted = await writeExternalReferenceArtifact(artifact, imageBytes, normalizedOutput.value, options.cwd === undefined ? {} : { cwd: options.cwd });
|
|
105
|
+
if (!persisted.ok)
|
|
106
|
+
return { ok: false, diagnostics: persisted.diagnostics };
|
|
107
|
+
return {
|
|
108
|
+
ok: true,
|
|
109
|
+
referenceId: artifact.referenceId,
|
|
110
|
+
referenceRequestId: artifact.referenceRequestId,
|
|
111
|
+
artifactRoot: persisted.artifactRoot,
|
|
112
|
+
manifestPath: persisted.manifestPath,
|
|
113
|
+
imagePath: persisted.imagePath,
|
|
114
|
+
regionCount: artifact.regions?.length ?? 0,
|
|
115
|
+
requirementCount: artifact.requirements?.length ?? 0,
|
|
116
|
+
adequacy: deriveReferenceRequirementAdequacy(artifact.regions ?? [], artifact.requirements ?? []),
|
|
117
|
+
hasApplicability: artifact.applicability !== undefined,
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* The one canonical application-level "approval" use case, mirroring
|
|
122
|
+
* `application/frontendContractPersistenceService.ts#approveAndPersistBaseline`'s
|
|
123
|
+
* shape: reads the target through the existing reader, refuses to approve
|
|
124
|
+
* anything not currently in the `'imported'` lifecycle state, resolves an
|
|
125
|
+
* optional explicit supersession target through the same reader, and
|
|
126
|
+
* persists a brand-new artifact instance - never mutating the imported
|
|
127
|
+
* artifact's own manifest - carrying a `sourceReference` back to it instead
|
|
128
|
+
* of a second copy of the image bytes.
|
|
129
|
+
*/
|
|
130
|
+
export async function approveExternalReference(importedArtifactRoot, options) {
|
|
131
|
+
const read = await readExternalReferenceArtifact(path.join(importedArtifactRoot, EXTERNAL_REFERENCE_MANIFEST_FILENAME));
|
|
132
|
+
if (!read.ok)
|
|
133
|
+
return failure('reference-not-found', read.reason);
|
|
134
|
+
if (!isImportedExternalReferenceArtifact(read.artifact)) {
|
|
135
|
+
return failure('invalid-request', `external-reference artifact "${read.artifact.referenceId}" is not in the "imported" lifecycle state; only a freshly imported reference can be approved`);
|
|
136
|
+
}
|
|
137
|
+
const imported = read.artifact;
|
|
138
|
+
const supersedes = await resolveSupersedesReferenceId(options.supersedesReferenceRoot);
|
|
139
|
+
if (!supersedes.ok)
|
|
140
|
+
return supersedes;
|
|
141
|
+
const normalizedOutput = normalizeOutputLocation(options.outputLocation);
|
|
142
|
+
if (!normalizedOutput.ok)
|
|
143
|
+
return { ok: false, diagnostics: [normalizedOutput.diagnostic] };
|
|
144
|
+
const referenceId = buildExternalReferenceInstanceIdentity(imported.referenceRequestId);
|
|
145
|
+
const artifact = {
|
|
146
|
+
artifactKind: EXTERNAL_REFERENCE_ARTIFACT_KIND,
|
|
147
|
+
schemaVersion: EXTERNAL_REFERENCE_SCHEMA_VERSION,
|
|
148
|
+
referenceRequestId: imported.referenceRequestId,
|
|
149
|
+
referenceId,
|
|
150
|
+
producer: getProducerInfo(),
|
|
151
|
+
provenance: { importedAt: imported.provenance.importedAt, ...(imported.provenance.label === undefined ? {} : { label: imported.provenance.label }) },
|
|
152
|
+
sourceReference: {
|
|
153
|
+
referenceId: imported.referenceId,
|
|
154
|
+
referenceRequestId: imported.referenceRequestId,
|
|
155
|
+
producer: imported.producer,
|
|
156
|
+
schemaVersion: imported.schemaVersion,
|
|
157
|
+
image: imported.image,
|
|
158
|
+
},
|
|
159
|
+
lifecycle: { state: 'approved', approvedAt: new Date().toISOString() },
|
|
160
|
+
...(supersedes.referenceId === undefined ? {} : { supersedesReferenceId: supersedes.referenceId }),
|
|
161
|
+
...(imported.regions === undefined ? {} : { regions: imported.regions }),
|
|
162
|
+
...(imported.requirements === undefined ? {} : { requirements: imported.requirements }),
|
|
163
|
+
...(imported.applicability === undefined ? {} : { applicability: imported.applicability }),
|
|
164
|
+
diagnostics: [],
|
|
165
|
+
completion: deriveCompletion([], 'post-capture'),
|
|
166
|
+
};
|
|
167
|
+
const persisted = await writeExternalReferenceArtifact(artifact, undefined, normalizedOutput.value, options.cwd === undefined ? {} : { cwd: options.cwd });
|
|
168
|
+
if (!persisted.ok)
|
|
169
|
+
return { ok: false, diagnostics: persisted.diagnostics };
|
|
170
|
+
return {
|
|
171
|
+
ok: true,
|
|
172
|
+
referenceId: artifact.referenceId,
|
|
173
|
+
referenceRequestId: artifact.referenceRequestId,
|
|
174
|
+
artifactRoot: persisted.artifactRoot,
|
|
175
|
+
manifestPath: persisted.manifestPath,
|
|
176
|
+
regionCount: artifact.regions?.length ?? 0,
|
|
177
|
+
requirementCount: artifact.requirements?.length ?? 0,
|
|
178
|
+
adequacy: deriveReferenceRequirementAdequacy(artifact.regions ?? [], artifact.requirements ?? []),
|
|
179
|
+
hasApplicability: artifact.applicability !== undefined,
|
|
180
|
+
};
|
|
181
|
+
}
|
|
182
|
+
//# sourceMappingURL=externalReferencePersistenceService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"externalReferencePersistenceService.js","sourceRoot":"","sources":["../../src/application/externalReferencePersistenceService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EACL,kCAAkC,EAClC,oCAAoC,EACpC,uCAAuC,EACvC,sBAAsB,EACtB,kCAAkC,GACnC,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,mCAAmC,EAAE,MAAM,gCAAgC,CAAC;AAC1J,OAAO,EAAE,qCAAqC,EAAE,sCAAsC,EAAE,MAAM,wCAAwC,CAAC;AAEvI,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAEhF,OAAO,EAAE,8BAA8B,EAAE,yBAAyB,EAAE,4BAA4B,EAAE,kCAAkC,EAAE,MAAM,4CAA4C,CAAC;AAEzL,OAAO,EAAE,qCAAqC,EAAE,MAAM,6CAA6C,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,8BAA8B,EAAE,MAAM,iDAAiD,CAAC;AAEjG,OAAO,EAAE,oCAAoC,EAAE,MAAM,iDAAiD,CAAC;AACvG,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AAoDhG,SAAS,OAAO,CAAC,IAAwB,EAAE,OAAe;IACxD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;AAC9F,CAAC;AAED,KAAK,UAAU,4BAA4B,CAAC,uBAA2C;IACrF,IAAI,uBAAuB,KAAK,SAAS;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,MAAM,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,oCAAoC,CAAC,CAAC,CAAC;IAC3H,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,OAAO,CAAC,qBAAqB,EAAE,4BAA4B,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/F,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;AAC9D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,UAAsB,EAAE,OAAuC;IAC3G,MAAM,MAAM,GAAG,kCAAkC,CAAC,UAAU,CAAC,CAAC;IAC9D,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,0BAA0B,EAAE,wFAAwF,CAAC,CAAC;IAE/J,IAAI,UAAU,CAAC,MAAM,GAAG,kCAAkC,EAAE,CAAC;QAC3D,OAAO,OAAO,CAAC,iBAAiB,EAAE,sBAAsB,UAAU,CAAC,MAAM,oCAAoC,kCAAkC,QAAQ,CAAC,CAAC;IAC3J,CAAC;IAED,MAAM,UAAU,GAAG,oCAAoC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5E,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,uCAAuC,CAAC,UAAU,CAAC,EAAE,CAAC;QACrF,OAAO,OAAO,CAAC,0BAA0B,EAAE,gFAAgF,CAAC,CAAC;IAC/H,CAAC;IAED,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QACxG,IAAI,CAAC,iBAAiB,CAAC,KAAK;YAAE,OAAO,OAAO,CAAC,0BAA0B,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED,IAAI,YAAwD,CAAC;IAC7D,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,KAAK,GAAmC,EAAE,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACvC,MAAM,aAAa,GAAG,8BAA8B,CAAC,GAAG,CAAC,CAAC;YAC1D,IAAI,CAAC,aAAa,CAAC,KAAK;gBAAE,OAAO,OAAO,CAAC,+BAA+B,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;YAChG,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,oBAAoB,GAAG,4BAA4B,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,oBAAoB,CAAC,KAAK;YAAE,OAAO,OAAO,CAAC,+BAA+B,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC9G,YAAY,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,uBAAuB,GAAG,qCAAqC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC7F,IAAI,CAAC,uBAAuB,CAAC,KAAK;YAAE,OAAO,OAAO,CAAC,iCAAiC,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACxH,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,4BAA4B,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACvF,IAAI,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,UAAU,CAAC;IAEtC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACzE,IAAI,CAAC,gBAAgB,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;IAE3F,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1E,MAAM,kBAAkB,GAAG,qCAAqC,CAC9D,WAAW,EACX,MAAM,EACN,UAAU,CAAC,KAAK,EAChB,UAAU,CAAC,MAAM,EACjB,UAAU,CAAC,WAAW,EACtB,OAAO,CAAC,OAAO,EACf,YAAY,EACZ,OAAO,CAAC,aAAa,CACtB,CAAC;IACF,MAAM,WAAW,GAAG,sCAAsC,CAAC,kBAAkB,CAAC,CAAC;IAE/E,MAAM,QAAQ,GAAsC;QAClD,YAAY,EAAE,gCAAgC;QAC9C,aAAa,EAAE,iCAAiC;QAChD,kBAAkB;QAClB,WAAW;QACX,QAAQ,EAAE,eAAe,EAAE;QAC3B,UAAU,EAAE,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QACtH,KAAK,EAAE;YACL,IAAI,EAAE,aAAa,sBAAsB,CAAC,MAAM,CAAC,EAAE;YACnD,MAAM;YACN,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,UAAU,EAAE,UAAU,CAAC,MAAM;YAC7B,MAAM,EAAE,WAAW;SACpB;QACD,SAAS,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE;QAChC,GAAG,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC;QAClG,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;QACtE,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;QACvD,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC;QACxF,WAAW,EAAE,EAAE;QACf,UAAU,EAAE,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC;KACjD,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,8BAA8B,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5J,IAAI,CAAC,SAAS,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;IAE5E,OAAO;QACL,EAAE,EAAE,IAAI;QACR,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;QAC/C,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,SAAS,EAAE,SAAS,CAAC,SAAU;QAC/B,WAAW,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;QAC1C,gBAAgB,EAAE,QAAQ,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC;QACpD,QAAQ,EAAE,kCAAkC,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,EAAE,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;QACjG,gBAAgB,EAAE,QAAQ,CAAC,aAAa,KAAK,SAAS;KACvD,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,oBAA4B,EAAE,OAAwC;IACnH,MAAM,IAAI,GAAG,MAAM,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,oCAAoC,CAAC,CAAC,CAAC;IACxH,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,IAAI,CAAC,mCAAmC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,OAAO,OAAO,CACZ,iBAAiB,EACjB,gCAAgC,IAAI,CAAC,QAAQ,CAAC,WAAW,+FAA+F,CACzJ,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAE/B,MAAM,UAAU,GAAG,MAAM,4BAA4B,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACvF,IAAI,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,UAAU,CAAC;IAEtC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACzE,IAAI,CAAC,gBAAgB,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;IAE3F,MAAM,WAAW,GAAG,sCAAsC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAExF,MAAM,QAAQ,GAAsC;QAClD,YAAY,EAAE,gCAAgC;QAC9C,aAAa,EAAE,iCAAiC;QAChD,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;QAC/C,WAAW;QACX,QAAQ,EAAE,eAAe,EAAE;QAC3B,UAAU,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE;QACpJ,eAAe,EAAE;YACf,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;YAC/C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,aAAa,EAAE,QAAQ,CAAC,aAAa;YACrC,KAAK,EAAE,QAAQ,CAAC,KAAK;SACtB;QACD,SAAS,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;QACtE,GAAG,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC;QAClG,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxE,GAAG,CAAC,QAAQ,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC;QACvF,GAAG,CAAC,QAAQ,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC1F,WAAW,EAAE,EAAE;QACf,UAAU,EAAE,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC;KACjD,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,8BAA8B,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC3J,IAAI,CAAC,SAAS,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;IAE5E,OAAO;QACL,EAAE,EAAE,IAAI;QACR,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;QAC/C,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,WAAW,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;QAC1C,gBAAgB,EAAE,QAAQ,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC;QACpD,QAAQ,EAAE,kCAAkC,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,EAAE,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;QACjG,gBAAgB,EAAE,QAAQ,CAAC,aAAa,KAAK,SAAS;KACvD,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { EvaluateReferenceCandidateFidelityOptions, ReferenceCandidateFidelityEvaluation } from '../domain/externalReferenceFidelity.js';
|
|
2
|
+
import type { ReferenceRuntimeBindingDeclaration } from '../domain/externalReferenceRuntimeBinding.js';
|
|
3
|
+
import type { Diagnostic } from '../domain/diagnostics.js';
|
|
4
|
+
export type EvaluateReferenceFidelityOptions = EvaluateReferenceCandidateFidelityOptions;
|
|
5
|
+
export type ApplicationReferenceFidelityResult = {
|
|
6
|
+
ok: true;
|
|
7
|
+
evaluation: ReferenceCandidateFidelityEvaluation;
|
|
8
|
+
} | {
|
|
9
|
+
ok: false;
|
|
10
|
+
diagnostics: Diagnostic[];
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* The canonical CLI-facing orchestration for Prompt 6, mirroring
|
|
14
|
+
* `comparisonService.ts#compareAndPersistFromArtifactRoots`'s exact shape:
|
|
15
|
+
* reads one already-persisted `ExternalReferenceArtifact` and one already-
|
|
16
|
+
* persisted `ObservationArtifact` by their root directories through the
|
|
17
|
+
* existing readers, then delegates to the pure
|
|
18
|
+
* `evaluateReferenceCandidateFidelity` exactly once. A thin wrapper only -
|
|
19
|
+
* artifact reading stays owned by `artifacts/`, evaluation semantics stay
|
|
20
|
+
* owned by `domain/externalReferenceFidelity.ts`. Kept in `application/`
|
|
21
|
+
* (not `artifacts/`) so `src/cli.ts` can depend on it without importing the
|
|
22
|
+
* artifacts layer directly, matching every other command's import-boundary
|
|
23
|
+
* convention. Never launches a browser, never re-resolves targets, and -
|
|
24
|
+
* deliberately, per this prompt's persistence decision - never persists
|
|
25
|
+
* anything: the caller receives the structured in-memory evaluation result
|
|
26
|
+
* directly.
|
|
27
|
+
*/
|
|
28
|
+
export declare function evaluateReferenceCandidateFidelityFromArtifactRoots(referenceRoot: string, candidateRoot: string, bindingDeclarations: readonly ReferenceRuntimeBindingDeclaration[], options?: EvaluateReferenceFidelityOptions): Promise<ApplicationReferenceFidelityResult>;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { readExternalReferenceArtifact } from '../artifacts/externalReferenceArtifactReader.js';
|
|
3
|
+
import { EXTERNAL_REFERENCE_MANIFEST_FILENAME } from '../artifacts/externalReferenceArtifactWriter.js';
|
|
4
|
+
import { readObservationArtifact } from '../artifacts/artifactReader.js';
|
|
5
|
+
import { MANIFEST_FILENAME as OBSERVATION_MANIFEST_FILENAME } from '../artifacts/artifactWriter.js';
|
|
6
|
+
import { evaluateReferenceCandidateFidelity } from '../domain/externalReferenceFidelity.js';
|
|
7
|
+
import { DIAGNOSTIC_SEVERITY } from '../domain/diagnostics.js';
|
|
8
|
+
/**
|
|
9
|
+
* The canonical CLI-facing orchestration for Prompt 6, mirroring
|
|
10
|
+
* `comparisonService.ts#compareAndPersistFromArtifactRoots`'s exact shape:
|
|
11
|
+
* reads one already-persisted `ExternalReferenceArtifact` and one already-
|
|
12
|
+
* persisted `ObservationArtifact` by their root directories through the
|
|
13
|
+
* existing readers, then delegates to the pure
|
|
14
|
+
* `evaluateReferenceCandidateFidelity` exactly once. A thin wrapper only -
|
|
15
|
+
* artifact reading stays owned by `artifacts/`, evaluation semantics stay
|
|
16
|
+
* owned by `domain/externalReferenceFidelity.ts`. Kept in `application/`
|
|
17
|
+
* (not `artifacts/`) so `src/cli.ts` can depend on it without importing the
|
|
18
|
+
* artifacts layer directly, matching every other command's import-boundary
|
|
19
|
+
* convention. Never launches a browser, never re-resolves targets, and -
|
|
20
|
+
* deliberately, per this prompt's persistence decision - never persists
|
|
21
|
+
* anything: the caller receives the structured in-memory evaluation result
|
|
22
|
+
* directly.
|
|
23
|
+
*/
|
|
24
|
+
export async function evaluateReferenceCandidateFidelityFromArtifactRoots(referenceRoot, candidateRoot, bindingDeclarations, options = {}) {
|
|
25
|
+
const referenceRead = await readExternalReferenceArtifact(path.join(referenceRoot, EXTERNAL_REFERENCE_MANIFEST_FILENAME));
|
|
26
|
+
if (!referenceRead.ok) {
|
|
27
|
+
return {
|
|
28
|
+
ok: false,
|
|
29
|
+
diagnostics: [{ code: 'invalid-request', severity: DIAGNOSTIC_SEVERITY['invalid-request'], message: `--reference external-reference artifact: ${referenceRead.reason}` }],
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
const candidateRead = await readObservationArtifact(path.join(candidateRoot, OBSERVATION_MANIFEST_FILENAME));
|
|
33
|
+
if (!candidateRead.ok) {
|
|
34
|
+
return {
|
|
35
|
+
ok: false,
|
|
36
|
+
diagnostics: [{ code: 'invalid-request', severity: DIAGNOSTIC_SEVERITY['invalid-request'], message: `--candidate observation artifact: ${candidateRead.reason}` }],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
const result = evaluateReferenceCandidateFidelity(referenceRead.artifact, candidateRead.artifact, bindingDeclarations, options);
|
|
40
|
+
if (!result.ok) {
|
|
41
|
+
return { ok: false, diagnostics: [{ code: 'invalid-request', severity: DIAGNOSTIC_SEVERITY['invalid-request'], message: result.reason }] };
|
|
42
|
+
}
|
|
43
|
+
return { ok: true, evaluation: result.evaluation };
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=referenceFidelityEvaluationService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"referenceFidelityEvaluationService.js","sourceRoot":"","sources":["../../src/application/referenceFidelityEvaluationService.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AAChG,OAAO,EAAE,oCAAoC,EAAE,MAAM,iDAAiD,CAAC;AACvG,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,iBAAiB,IAAI,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACpG,OAAO,EAAE,kCAAkC,EAAE,MAAM,wCAAwC,CAAC;AAI5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAM/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,mDAAmD,CACvE,aAAqB,EACrB,aAAqB,EACrB,mBAAkE,EAClE,UAA4C,EAAE;IAE9C,MAAM,aAAa,GAAG,MAAM,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,oCAAoC,CAAC,CAAC,CAAC;IAC1H,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;QACtB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,4CAA4C,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC;SAC1K,CAAC;IACJ,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,6BAA6B,CAAC,CAAC,CAAC;IAC7G,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;QACtB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,qCAAqC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC;SACnK,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,kCAAkC,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAChI,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;IAC7I,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC;AACrD,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { ExternalReferenceArtifact } from '../domain/externalReference.js';
|
|
2
|
+
export type ReadExternalReferenceArtifactResult = {
|
|
3
|
+
ok: true;
|
|
4
|
+
artifact: ExternalReferenceArtifact;
|
|
5
|
+
} | {
|
|
6
|
+
ok: false;
|
|
7
|
+
reason: string;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Narrow canonical reader counterpart to
|
|
11
|
+
* `externalReferenceArtifactWriter.ts#writeExternalReferenceArtifact`: reads
|
|
12
|
+
* one `manifest.json`, parses it, and validates it through the same
|
|
13
|
+
* `isValidExternalReferenceArtifact` structural gate the writer itself uses -
|
|
14
|
+
* never a second validator. Read-only: never mutates the file, never resolves
|
|
15
|
+
* the sibling image file's bytes (an 'imported' manifest's `image.path` field
|
|
16
|
+
* is returned as-is for the caller to resolve if it needs the bytes).
|
|
17
|
+
*/
|
|
18
|
+
export declare function readExternalReferenceArtifact(manifestPath: string): Promise<ReadExternalReferenceArtifactResult>;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { readFile } from 'node:fs/promises';
|
|
2
|
+
import { isValidExternalReferenceArtifact } from '../domain/externalReference.js';
|
|
3
|
+
/**
|
|
4
|
+
* Narrow canonical reader counterpart to
|
|
5
|
+
* `externalReferenceArtifactWriter.ts#writeExternalReferenceArtifact`: reads
|
|
6
|
+
* one `manifest.json`, parses it, and validates it through the same
|
|
7
|
+
* `isValidExternalReferenceArtifact` structural gate the writer itself uses -
|
|
8
|
+
* never a second validator. Read-only: never mutates the file, never resolves
|
|
9
|
+
* the sibling image file's bytes (an 'imported' manifest's `image.path` field
|
|
10
|
+
* is returned as-is for the caller to resolve if it needs the bytes).
|
|
11
|
+
*/
|
|
12
|
+
export async function readExternalReferenceArtifact(manifestPath) {
|
|
13
|
+
let raw;
|
|
14
|
+
try {
|
|
15
|
+
raw = await readFile(manifestPath, 'utf8');
|
|
16
|
+
}
|
|
17
|
+
catch (err) {
|
|
18
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
19
|
+
return { ok: false, reason: `failed to read external-reference artifact manifest at "${manifestPath}": ${message}` };
|
|
20
|
+
}
|
|
21
|
+
let parsed;
|
|
22
|
+
try {
|
|
23
|
+
parsed = JSON.parse(raw);
|
|
24
|
+
}
|
|
25
|
+
catch (err) {
|
|
26
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
27
|
+
return { ok: false, reason: `external-reference artifact manifest at "${manifestPath}" is not valid JSON: ${message}` };
|
|
28
|
+
}
|
|
29
|
+
const validation = isValidExternalReferenceArtifact(parsed);
|
|
30
|
+
if (!validation.valid) {
|
|
31
|
+
return { ok: false, reason: `external-reference artifact manifest at "${manifestPath}" failed structural validation: ${validation.reason}` };
|
|
32
|
+
}
|
|
33
|
+
return { ok: true, artifact: parsed };
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=externalReferenceArtifactReader.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"externalReferenceArtifactReader.js","sourceRoot":"","sources":["../../src/artifacts/externalReferenceArtifactReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAIlF;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAC,YAAoB;IACtE,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,2DAA2D,YAAY,MAAM,OAAO,EAAE,EAAE,CAAC;IACvH,CAAC;IAED,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,4CAA4C,YAAY,wBAAwB,OAAO,EAAE,EAAE,CAAC;IAC1H,CAAC;IAED,MAAM,UAAU,GAAG,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC5D,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,4CAA4C,YAAY,mCAAmC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;IAC/I,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAmC,EAAE,CAAC;AACrE,CAAC"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { ExternalReferenceArtifact } from '../domain/externalReference.js';
|
|
2
|
+
import type { Diagnostic } from '../domain/diagnostics.js';
|
|
3
|
+
export declare const EXTERNAL_REFERENCE_MANIFEST_FILENAME = "manifest.json";
|
|
4
|
+
/**
|
|
5
|
+
* Observer-owned result of persisting one ExternalReferenceArtifact. Mirrors
|
|
6
|
+
* PersistedObservationResult/PersistedComparisonResult's shape but is its own
|
|
7
|
+
* type: an 'imported' artifact's directory has one owned image file; an
|
|
8
|
+
* 'approved' artifact's directory has only manifest.json.
|
|
9
|
+
*/
|
|
10
|
+
export type PersistedExternalReferenceResult = {
|
|
11
|
+
ok: true;
|
|
12
|
+
artifactRoot: string;
|
|
13
|
+
manifestPath: string;
|
|
14
|
+
imagePath?: string;
|
|
15
|
+
} | {
|
|
16
|
+
ok: false;
|
|
17
|
+
diagnostics: Diagnostic[];
|
|
18
|
+
};
|
|
19
|
+
export interface WriteExternalReferenceArtifactOptions {
|
|
20
|
+
/** Base directory that `outputLocation` is resolved against. Defaults to `process.cwd()`. */
|
|
21
|
+
cwd?: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Persists one already-assembled, already-validated ExternalReferenceArtifact
|
|
25
|
+
* as one portable artifact directory: `<outputLocation>/<referenceId>/`.
|
|
26
|
+
* For an 'imported' artifact (which owns its reference image), `imageBytes`
|
|
27
|
+
* is required and is written before manifest.json, mirroring
|
|
28
|
+
* `artifacts/artifactWriter.ts#writeObservationArtifact`'s media-before-manifest
|
|
29
|
+
* discipline. For an 'approved' artifact (which only ever carries a
|
|
30
|
+
* `sourceReference` back to the imported artifact that owns the image - see
|
|
31
|
+
* `domain/externalReference.ts`), no image bytes are written at all, mirroring
|
|
32
|
+
* `artifacts/comparisonArtifactWriter.ts#writeComparisonArtifact`'s
|
|
33
|
+
* manifest-only, no-media-copy persistence.
|
|
34
|
+
*
|
|
35
|
+
* `referenceId` is guaranteed fresh per persisted instance (see
|
|
36
|
+
* `domain/externalReferenceIdentity.ts#buildExternalReferenceInstanceIdentity`'s
|
|
37
|
+
* "never collides" contract), so each write targets its own unique
|
|
38
|
+
* subdirectory; an existing directory at that path is treated as a genuine
|
|
39
|
+
* collision and rejected rather than overwritten - no persisted evidence,
|
|
40
|
+
* imported or approved, is ever destructively replaced. Writing happens in a
|
|
41
|
+
* sibling temporary directory first, and the whole temporary directory is
|
|
42
|
+
* only exposed under its real name via one atomic rename.
|
|
43
|
+
*/
|
|
44
|
+
export declare function writeExternalReferenceArtifact(artifact: ExternalReferenceArtifact, imageBytes: Uint8Array | undefined, outputLocation: string, options?: WriteExternalReferenceArtifactOptions): Promise<PersistedExternalReferenceResult>;
|