@disclosureos/schema 2.0.0-beta.3 → 2.0.0-beta.4
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 +87 -0
- package/README.md +78 -7
- package/dist/experimental/v2/index.d.ts +4425 -81
- package/dist/experimental/v2/index.js +7952 -334
- package/dist/experimental/v2/index.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +34 -6
- package/schema/enriched-observation.schema.json +16 -16
- package/schema/experimental/archival-case-presentation-0.1.0.schema.json +742 -0
- package/schema/experimental/case-presentation-0.1.0.schema.json +431 -0
- package/schema/experimental/context-case-presentation-0.1.0.schema.json +697 -0
- package/schema/experimental/lidar-point-cloud-profile-0.1.0.schema.json +416 -0
- package/schema/experimental/material-case-presentation-0.1.0.schema.json +802 -0
- package/schema/experimental/passive-sonar-profile-0.1.0.schema.json +238 -0
- package/schema/experimental/product-source-selection-0.1.0.schema.json +673 -0
- package/schema/experimental/radar-profile-0.1.0.schema.json +1232 -0
- package/schema/experimental/satellite-raster-profile-0.1.0.schema.json +406 -0
- package/schema/experimental/secondary-radar-profile-0.1.0.schema.json +154 -0
- package/schema/experimental/sonar-profile-0.1.0.schema.json +197 -0
- package/schema/experimental/steered-radar-profile-0.1.0.schema.json +214 -0
- package/schema/experimental/testimony-case-presentation-0.1.0.schema.json +682 -0
- package/schema/experimental/vocabulary-bindings-0.1.0.schema.json +167 -0
- package/schema/experimental/vocabulary-catalog-0.1.0.schema.json +155 -0
- package/schema/experimental/vocabulary-term-reference-0.1.0.schema.json +61 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,92 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.0.0-beta.4
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- Revise the V2 observable definitions and support vocabulary directly, and add shared catalog, immutable revision and term references with supplied-byte validation. Keep the chosen term separate from the subject under review and its supporting sources. Export full observable and attributed OCS origin catalogs with retained methodological context. Update enriched-observation and scoring consumers to the revised definitions. This breaks earlier beta definition and support assumptions; it does not establish an anomalous origin or turn a reported characteristic into a confirmed assessment.
|
|
8
|
+
|
|
9
|
+
### Minor Changes
|
|
10
|
+
|
|
11
|
+
- ebec21d: Add a versioned archival-case presentation and approved public projection preserving edition-specific pages, release/declassification declarations, selected custody links and gaps, legacy hash scope, and attributed edition review. Reuse internal snapshot capture without changing the testimony contract. No source authenticity or publication authorization is inferred from hashes.
|
|
12
|
+
- 0b00be3: Add an unreleased case-claim-history contract with exact case/entity/field and
|
|
13
|
+
directed relationship subjects, scoped assertion and observation inputs, and
|
|
14
|
+
attributable revision history. Resolve supplied case and observation snapshots
|
|
15
|
+
without inferring scientific truth, a preferred reviewer or lifecycle changes.
|
|
16
|
+
Hold npm publication and version bumps for coordinated V2 completion.
|
|
17
|
+
- 9580e62: Add an unreleased case-links contract for attributable context, research-entity
|
|
18
|
+
and source-intake associations. Resolve exact case/observation/document snapshots
|
|
19
|
+
and optional entity/field or inventory targets without inferring full supplement
|
|
20
|
+
conformance, raw-artifact authenticity or publication authorization.
|
|
21
|
+
Hold npm publication and version bumps for coordinated V2 completion.
|
|
22
|
+
- 0b30518: Add the experimental product source selection contract, JSON Schema, byte-verified
|
|
23
|
+
evaluator and dependency-free reference reader for contiguous numerical arrays,
|
|
24
|
+
CSV row partitions and declared constant-rate video frame intervals. Preserve
|
|
25
|
+
separate calibration, scientific and media-decoding status. Publication remains
|
|
26
|
+
deferred to the coordinated V2 release.
|
|
27
|
+
- 559eac9: Add an unreleased case-record contract for pinned observation scope, sourced
|
|
28
|
+
chronology and grouping, investigation reports and response declarations.
|
|
29
|
+
Check local graph cycles and supplied observation references without inferring
|
|
30
|
+
object identity, scientific corroboration, source authenticity or publication
|
|
31
|
+
permission. Hold npm publication and version bumps for coordinated V2 completion.
|
|
32
|
+
- 0370447: Add a versioned context-case presentation envelope and approved public projection linking selected context fields, ambient measurements, separate products and contextual assessments. Preserve the existing case-presentation contract. The new public payload is version 0.2.0. Publication and real-data activation remain application responsibilities.
|
|
33
|
+
- 5a686c1: Add unreleased laboratory analysis and result entities with explicit specimen,
|
|
34
|
+
measurement and report references, and attributable material-review claims.
|
|
35
|
+
Validate supplied entity and specimen-selection snapshots without inferring
|
|
36
|
+
scientific validity, source-report authenticity or physical custody completeness.
|
|
37
|
+
Hold npm publication and version bumps for the coordinated V2 completion release.
|
|
38
|
+
- 3b75904: Add an optional static lidar point-cloud profile with reusable source reader, strict acquisition bindings, complete pulse availability and return groups, declared local coordinates, normalized intensity and attributed classifications. Include a deterministic fictional source packet, portable JSON Schema, conformance tests and documentation. No LAS decoder or physical-accuracy certification is implied.
|
|
39
|
+
- c894a08: Add an explicitly approved public material and laboratory case presentation with specimen-scoped results, declared lineage and custody, attributed review inputs, and consistent public outputs. Capture referenced specimen-selection snapshots before asynchronous validation.
|
|
40
|
+
- 11bf318: Add an optional single-hydrophone pressure and reproducible spectral-density profile. Public schemas, source readers and evaluation bind pressure and retention masks to exact acquisition products and derived Hann-windowed spectra, preserving unavailable samples separately from zero. The synthetic source packet demonstrates source-window selection, spectral units, complete processing lineage and numerical reproduction without claiming physical calibration or localization.
|
|
41
|
+
- 0319e40: Add an unreleased case presentation contract and an explicitly approved public
|
|
42
|
+
projection for narrative, citations, selected case assessments and attachments.
|
|
43
|
+
Generate renderer data, JSON, Markdown, search and metadata from the same allowlist.
|
|
44
|
+
Application authorization, asset delivery and revocation remain integration requirements.
|
|
45
|
+
Hold package version bumps and npm publication for coordinated V2 completion.
|
|
46
|
+
- 4ace4ea: Add an optional V2 rotating-radar profile over existing observation, acquisition
|
|
47
|
+
and source-selection contracts. Validate source bytes, scan/dwell semantics,
|
|
48
|
+
threshold detections, declared localization, track associations, position
|
|
49
|
+
covariance and separation from synthetic truth. Include a dependency-free reader,
|
|
50
|
+
portable JSON Schema and deterministic fixed, airborne and shipborne scanning examples.
|
|
51
|
+
Moving platforms retain one pose per dwell, declare beam reference and optional
|
|
52
|
+
slant-to-plane projection, and validate motion compensation and conditional uncertainty. Passing validation does
|
|
53
|
+
not establish physical calibration or tracking performance. Publication remains
|
|
54
|
+
deferred to the coordinated V2 release.
|
|
55
|
+
|
|
56
|
+
Add separate optional steered-radar and cooperative secondary-radar profiles,
|
|
57
|
+
public dependency-free readers, package-exported portable schemas and complete
|
|
58
|
+
reproducible examples. Steered arrays retain arbitrary beam schedules and
|
|
59
|
+
per-dwell processing availability. Secondary reports preserve Mode A codes,
|
|
60
|
+
nullable Mode C pressure altitude, invalid receptions and exact reply lineage
|
|
61
|
+
without inventing reflected power, geometric height or verified identity.
|
|
62
|
+
|
|
63
|
+
Allow retained header-only CSV layouts for legitimate empty outcomes while
|
|
64
|
+
rejecting row selection, partition and sample mappings into empty tables.
|
|
65
|
+
|
|
66
|
+
Add optional fixed-site preprocessing with independently retained reference power,
|
|
67
|
+
reproducible background means and residual arrays, and explicit detector-policy
|
|
68
|
+
exclusions that preserve the raw capture. Add source-backed local site geometry
|
|
69
|
+
and complete ground and civilian airport surface examples. Validate acquisition
|
|
70
|
+
identity, time, axes, arithmetic, detector inputs and synthetic-truth separation.
|
|
71
|
+
These declarations do not imply physical coverage or identify detected objects.
|
|
72
|
+
|
|
73
|
+
- e19a897: Add an optional multispectral satellite raster profile with explicit projected pixel geometry, per-band scaling and missing values, attributed pixel quality, exact retained source selections and quality-gated NDVI. Include a dependency-free reader, strict acquisition and byte-integrity evaluation, portable schema, deterministic fictional packet and conformance tests. This does not certify physical calibration or decode GeoTIFF/COG products.
|
|
74
|
+
- 6f74e57: Add an optional monostatic active-sonar envelope profile with a portable schema, dependency-free source reader, exact cell selection and a validator over existing observation, acquisition and source-layout contracts. The profile declares assumed sound speed and two-way distance conversion, preserves receive availability separately from zero amplitude, and includes a reproducible synthetic example. Validation does not certify propagation accuracy, physical calibration, bathymetry or object identity.
|
|
75
|
+
- e7c3d0f: Add an explicitly approved testimony-case public projection for selected pseudonym, event quarter, recorded accounts and attributed qualification review. Keep recording dates, missing wording and unknown independence distinct. No raw research entities, private identities, source URIs or review notes enter public outputs. Existing presentation contracts remain unchanged.
|
|
76
|
+
|
|
77
|
+
### Patch Changes
|
|
78
|
+
|
|
79
|
+
- Updated dependencies [0b00be3]
|
|
80
|
+
- Updated dependencies [9580e62]
|
|
81
|
+
- Updated dependencies [559eac9]
|
|
82
|
+
- Updated dependencies [5a686c1]
|
|
83
|
+
- Updated dependencies [813ee2c]
|
|
84
|
+
- Updated dependencies
|
|
85
|
+
- @disclosureos/records@2.0.0-beta.4
|
|
86
|
+
- @disclosureos/observables@2.0.0-beta.4
|
|
87
|
+
- @disclosureos/origins@2.0.0-beta.4
|
|
88
|
+
- @disclosureos/instruments@2.0.0-beta.4
|
|
89
|
+
|
|
3
90
|
## 2.0.0-beta.3
|
|
4
91
|
|
|
5
92
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# @disclosureos/schema
|
|
2
2
|
|
|
3
|
+
Connect supplied documents, inspect exact source selections and validate specialized instrument products. Use portable JSON Schemas and evaluators with explicit limits.
|
|
4
|
+
|
|
5
|
+
This README describes the **2.0.0-beta.4** API. Use one exact package version
|
|
6
|
+
throughout an application. Check [availability](https://os.disclosure.org/v2/docs/installation)
|
|
7
|
+
before installing; a source branch or packed candidate is not proof of npm
|
|
8
|
+
publication. For a candidate that is not yet published, use the verified local
|
|
9
|
+
tarballs. See the [release notes](https://github.com/disclosurefoundation/disclosureos/blob/codex/beta4-release-closure/docs/releases/2.0.0-beta.4.md)
|
|
10
|
+
for scope and verification. Avoid unversioned installs, which can select a different
|
|
11
|
+
API generation through `latest`.
|
|
12
|
+
|
|
13
|
+
## V2 entry point
|
|
14
|
+
|
|
15
|
+
Start with `@disclosureos/schema/experimental/v2`. It includes acquisition and measurement bindings, research evaluation, case projections, product-source selection, vocabulary bindings and radar, sonar, lidar and satellite profiles. JSON Schema exports identify their own document versions. The root `parseEnrichedObservation` API is the earlier composition format.
|
|
16
|
+
|
|
17
|
+
[Implementation guide](https://os.disclosure.org/v2/docs/worked-example) · [Availability](https://os.disclosure.org/v2/docs/installation) · [Example viewer](https://os.disclosure.org/showcase)
|
|
18
|
+
|
|
19
|
+
## Choose a package version
|
|
20
|
+
|
|
21
|
+
Once this version is available in the registry, install it explicitly:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
npm install --save-exact @disclosureos/schema@2.0.0-beta.4
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Use the same exact release for all DisclosureOS packages. Before publication,
|
|
28
|
+
review a verified source checkout or its locally packed artifacts. Packages are
|
|
29
|
+
ESM; Node.js 22 is the documented getting-started runtime.
|
|
30
|
+
|
|
31
|
+
## Additional API reference
|
|
32
|
+
|
|
33
|
+
<details>
|
|
34
|
+
<summary>Earlier composition APIs and detailed source-workflow reference</summary>
|
|
35
|
+
|
|
36
|
+
The following reference retains earlier APIs and source checkpoints. It is not the
|
|
37
|
+
V2 first-record tutorial. Installation commands here describe the candidate API
|
|
38
|
+
set; use the availability guidance above until that version is published.
|
|
39
|
+
|
|
3
40
|
[](https://opensource.org/licenses/MIT)
|
|
4
41
|
|
|
5
42
|
The **portable contract** for DisclosureOS. It composes the slot-bearing packages —
|
|
@@ -9,10 +46,6 @@ The **portable contract** for DisclosureOS. It composes the slot-bearing package
|
|
|
9
46
|
(the `origin` slot) — into one **enriched `Observation`** that means the same thing
|
|
10
47
|
in TypeScript, JSON Schema, and any other language.
|
|
11
48
|
|
|
12
|
-
DisclosureOS is a **six-part standard** (records → observables → origins → claims → scoring → instruments).
|
|
13
|
-
`schema` is the contract that *binds* records and the package-owned slots into one
|
|
14
|
-
portable artifact. It is a supporting package, not another part of the standard. (Scoring
|
|
15
|
-
consumes the enriched record, so it is not part of the composed schema.)
|
|
16
49
|
|
|
17
50
|
> ESM-only. CommonJS consumers can load it with a dynamic `import()`.
|
|
18
51
|
|
|
@@ -41,12 +74,12 @@ that gap with three things:
|
|
|
41
74
|
> with `pnpm --filter @disclosureos/examples golden-path`.
|
|
42
75
|
>
|
|
43
76
|
> **Migrating an existing dataset?** See [`examples/migration-path.ts`](../../examples/migration-path.ts)
|
|
44
|
-
> and the [onboarding workspace](https://os.disclosure.org/
|
|
77
|
+
> and the [onboarding workspace](https://os.disclosure.org/v2/inspect).
|
|
45
78
|
|
|
46
79
|
## Install
|
|
47
80
|
|
|
48
81
|
```bash
|
|
49
|
-
pnpm add @disclosureos/schema @disclosureos/records @disclosureos/observables @disclosureos/origins zod
|
|
82
|
+
pnpm add @disclosureos/schema@2.0.0-beta.4 @disclosureos/records@2.0.0-beta.4 @disclosureos/observables@2.0.0-beta.4 @disclosureos/origins@2.0.0-beta.4 zod
|
|
50
83
|
```
|
|
51
84
|
|
|
52
85
|
## Quickstart
|
|
@@ -61,7 +94,7 @@ const observation: EnrichedObservation = {
|
|
|
61
94
|
status: 'published',
|
|
62
95
|
createdAt: '2020-01-01T00:00:00Z',
|
|
63
96
|
updatedAt: '2020-01-01T00:00:00Z',
|
|
64
|
-
observableAssessments: { technology: {
|
|
97
|
+
observableAssessments: { technology: { apparent_hover: [{ level: 'confirmed', confidence: 1 }] } },
|
|
65
98
|
origin: [{ primaryHypothesis: '1.1.3', confidence: 0.9 }],
|
|
66
99
|
};
|
|
67
100
|
|
|
@@ -98,6 +131,18 @@ MIT © [Disclosure Foundation](https://disclosure.org)
|
|
|
98
131
|
|
|
99
132
|
## Experimental v2 documentary support
|
|
100
133
|
|
|
134
|
+
### Rotating radar products
|
|
135
|
+
|
|
136
|
+
The optional [rotating radar profile](docs/radar-profile.md) gives retained scans,
|
|
137
|
+
detections and estimated tracks shared semantics over the existing observation,
|
|
138
|
+
acquisition-context and product-source-selection contracts. It verifies source
|
|
139
|
+
bytes, dwell timing, detection localization, associations, covariance and declared
|
|
140
|
+
processing lineage. The [scanning example](../../examples/radar-scanning) supplies
|
|
141
|
+
reproducible synthetic data with a separate truth oracle. Passing the profile does
|
|
142
|
+
not certify scientific performance or physical calibration.
|
|
143
|
+
|
|
144
|
+
### Documentary and acquisition profiles
|
|
145
|
+
|
|
101
146
|
`@disclosureos/schema/experimental/v2` exports `evaluateAssessmentDocumentation` for records-owned claim histories. See the [profile contract and runnable synthetic example](../../docs/experimental/assessment-documentation.md). It checks declared support and supplied byte hashes, not scientific adequacy; existing v1 APIs and artifacts remain unchanged.
|
|
102
147
|
|
|
103
148
|
`evaluateAcquisitionBindings` additionally checks explicit raw-product/source mappings to instrument acquisition context and verifies supplied artifact hashes and lengths. See the [binding contract and local example](../../docs/experimental/acquisition-bindings.md). This is independent of assessment-documentation eligibility and does not authenticate physical instruments.
|
|
@@ -210,3 +255,29 @@ entries. A successful supplied-document check does not authenticate source
|
|
|
210
255
|
artifacts, complete custody or certify a scientific profile.
|
|
211
256
|
See the [contract guide](../../docs/c2/archival.md) and
|
|
212
257
|
[worked example](../../examples/v2/archival-editions-demo/README.md).
|
|
258
|
+
# Product source selections (source candidate)
|
|
259
|
+
|
|
260
|
+
The experimental V2 entry point exports `ProductSourceSelectionSchema`,
|
|
261
|
+
`evaluateProductSourceSelection` and the dependency-free
|
|
262
|
+
`readProductSourceSelection` reader. This additive contract binds array elements,
|
|
263
|
+
CSV rows and declared video frame intervals to exact observation-product bytes.
|
|
264
|
+
See [the contract and limitations](../../docs/experimental/product-source-selection.md).
|
|
265
|
+
This addition has not been published to npm.
|
|
266
|
+
|
|
267
|
+
### Active sonar echo envelopes
|
|
268
|
+
|
|
269
|
+
The optional [sonar profile](docs/sonar-profile.md) binds retained monostatic normalized envelopes and receive masks to an acquisition, the source delay/time axes, and a declared constant assumed sound speed. Public readers preserve unavailable samples separately from measured zero; the evaluator checks source integrity and declared meaning. A passed check does not certify physical calibration, propagation accuracy, depth or object identity. The [active sonar example](../../examples/sonar-active) includes a reproducible source packet. These additions are on the V2 development branch; package publication is separate.
|
|
270
|
+
|
|
271
|
+
### Passive sonar pressure and spectra
|
|
272
|
+
|
|
273
|
+
The optional [passive sonar profile](docs/passive-sonar-profile.md) binds a single pressure channel and its retention mask to a reproducible, one-sided spectral-density product. Public readers expose the exact input window and selected output cell; the evaluator checks acquisition lineage, hashes, missing-window behavior and numerical reproduction. The [passive sonar example](../../examples/sonar-passive) includes its waveform, spectra, masks and executable methods. It supplies no bearing, range or identity and does not certify physical calibration. These additions are source candidates; publication is separate.
|
|
274
|
+
|
|
275
|
+
### Static lidar returns and pulse availability
|
|
276
|
+
|
|
277
|
+
The optional [lidar point-cloud profile](docs/lidar-profile.md) binds a local discrete-return cloud to a complete raster pulse ledger, with exact row selection, complete return groups, normalized amplitude and declared class annotations. The [lidar example](../../examples/lidar-point-cloud) retains authored terrain, roof and vegetation returns alongside no-return and unavailable cells. The evaluator verifies source integrity and declared local geometry; it does not certify calibration, classification accuracy, geographic registration or empty space. This is a source candidate, with publication held separately.
|
|
278
|
+
|
|
279
|
+
### Multispectral satellite raster
|
|
280
|
+
|
|
281
|
+
The optional [satellite raster profile](docs/satellite-raster-profile.md) binds a projected grid, retained optical band values and attributed pixel quality to exact source and acquisition artifacts. The reusable reader exposes scaled reflectance, pixel footprints, source byte offsets and quality-gated NDVI. The [fictional raster example](../../examples/satellite-raster) retains six bands, cloud and shadow annotations, missing pixels and numerical edge cases. Passing checks do not certify calibration, atmospheric correction, quality accuracy or geographic registration. No satellite-format decoder is implied; publication remains held separately.
|
|
282
|
+
|
|
283
|
+
</details>
|