@disclosureos/schema 1.0.0 → 2.0.0-beta.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.
Files changed (26) hide show
  1. package/CHANGELOG.md +87 -0
  2. package/README.md +93 -1
  3. package/dist/experimental/v2/index.d.ts +1602 -0
  4. package/dist/experimental/v2/index.js +4532 -0
  5. package/dist/experimental/v2/index.js.map +1 -0
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.js +1 -1
  8. package/dist/index.js.map +1 -1
  9. package/package.json +45 -7
  10. package/schema/enriched-observation.schema.json +31 -2
  11. package/schema/experimental/acquisition-bindings-0.1.0.schema.json +127 -0
  12. package/schema/experimental/dataset-release-0.1.0.schema.json +279 -0
  13. package/schema/experimental/historical-testimony-selection-0.1.0.schema.json +102 -0
  14. package/schema/experimental/instrument-research-review-0.1.0.schema.json +627 -0
  15. package/schema/experimental/measurement-bindings-0.1.0.schema.json +199 -0
  16. package/schema/experimental/migration-compatibility-0.1.0.schema.json +189 -0
  17. package/schema/experimental/migration-legacy-scores-0.1.0.schema.json +116 -0
  18. package/schema/experimental/migration-resolution-0.1.0.schema.json +120 -0
  19. package/schema/experimental/migration-review-0.1.0.schema.json +223 -0
  20. package/schema/experimental/physical-sample-selection-0.1.0.schema.json +278 -0
  21. package/schema/experimental/profile-evaluation-0.1.0.schema.json +231 -0
  22. package/schema/experimental/profile-preparation-0.1.0.schema.json +177 -0
  23. package/schema/experimental/released-document-selection-0.1.0.schema.json +102 -0
  24. package/schema/experimental/reproduction-packet-0.1.0.schema.json +252 -0
  25. package/schema/experimental/research-evaluation-0.1.0.schema.json +174 -0
  26. package/schema/experimental/source-intake-0.1.0.schema.json +497 -0
package/CHANGELOG.md CHANGED
@@ -1,14 +1,101 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.0.0-beta.0
4
+
5
+ ### Major Changes
6
+
7
+ - Prepare the coordinated v2 beta package set. This prerelease packages the merged
8
+ experimental observation and claim contracts, acquisition and dataset exchange,
9
+ versioned evaluation, and bounded migration tooling for external consumer testing.
10
+ Existing root APIs and schema identities remain available; the new contracts keep
11
+ explicit `/experimental/v2` imports. Observables and origins retain their existing
12
+ catalogs within the pinned beta dependency graph. This is not a stable v2 release,
13
+ scientific certification, or publication of partner data. See
14
+ `docs/releases/2.0.0-beta.0.md` for package-specific scope and validation boundaries.
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+ - @disclosureos/records@2.0.0-beta.0
20
+ - @disclosureos/observables@2.0.0-beta.0
21
+ - @disclosureos/origins@2.0.0-beta.0
22
+ - @disclosureos/instruments@2.0.0-beta.0
23
+
3
24
  All notable changes to `@disclosureos/schema` are documented here. The format is
4
25
  based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project
5
26
  adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
27
 
28
+ ## Unreleased experimental work
29
+
30
+ - Add a bounded compatibility inventory and explicit, artifact-pinned sensor revision review without automatic measurement conversion.
31
+
32
+ - Add explicit standalone legacy score preservation plans and adapters, retaining historical versions and values separately from v2 evaluations.
33
+
34
+ - Add exact-ledger-pinned revision resolution plans with explicit select/defer decisions, preserved competing revisions and complete non-destructive planning reports.
35
+
36
+ - Add pinned migration review plans for explicit time/position mappings, preserved reviewer declarations and shared v2 validation. Reviewed candidates remain separate from imports and legacy evaluations.
37
+
38
+ - Add explicit profile-preparation plans and private bundle assembly from exact existing inputs, retaining profile failures and missingness without inventing source metadata.
39
+
40
+ - Add fixed provenance-profile evaluation receipts over exact history, selection, asset and dependency pins, with bounded local replay and independent payload-integrity checks. Failed and unchecked profile outcomes remain distinct from replay success.
41
+
42
+ - Add experimental collected-specimen provenance checks, explicit custody gaps, versioned selection schema and synthetic record fixture. Record hashes do not authenticate specimens, custody, composition or origin.
43
+
44
+ - Add experimental historical-testimony provenance checks, versioned selection schema, speaker/extractor traceability and non-blocking citation recommendations. Speaker identity, account accuracy and witness independence remain unchecked.
45
+
46
+ - Add selected released-document provenance with explicit release gaps, required byte/extraction checks and non-blocking citation recommendations. Assessment support and scientific eligibility remain unchecked.
47
+
48
+ - Add a fixed research-evaluation workflow with versioned input schema, exact-byte dependency pins and digest-bound computed-result receipts; failures remain failures and supplied implementation/environment execution remains unattested.
49
+
50
+ - Add opt-in research-completion guidance with required phase statuses, preserved early exits, and distinct missing versus rejected reviews and corrupt report bytes.
51
+
52
+ - Add opt-in documentation-completion checklists with explicit applicability, blocked prerequisites and actionable diagnostics, delegating to the unchanged documentary profile.
53
+
54
+ - Add experimental source intake with exact-byte local receipts, explicit unknown context and actionable gaps; CLI create, inspect and validate require no fabricated measurements or reviews.
55
+
56
+ - Add experimental dataset/session composition for pinned reproduction packets, with explicit membership, context conflict checks, and local dataset inspection/validation.
57
+
58
+ - Add exact-byte reproduction packets and independent TypeScript/Python synthetic control runners. Packet verification does not execute bundled code or certify scientific eligibility.
59
+
60
+ - Add the opt-in instrument research prerequisites profile, with purpose-specific calibration-use reviews, explicitly interpreted timing intervals, local report verification, and composed documentary and acquisition checks. Scientific eligibility remains unchecked.
61
+
62
+ - Add the opt-in v2 measurement bindings contract and single-channel capture profile, with local acquisition artifact verification. Existing contracts and package versions remain unchanged; scientific eligibility is not established by this profile.
63
+
64
+ ## 1.1.0
65
+
66
+ ### Minor Changes
67
+
68
+ - e6ff99c: Add the instruments layer: the UAP Sensor Manifest standard
69
+ (`@disclosureos/instruments@1.0.0`, first published alongside this release —
70
+ see its own changelog).
71
+
72
+ - **`@disclosureos/records`** — `SensorReading` gains optional `sensorRef`
73
+ (`"<org-slug>:<sensor-id>"`, with `sensorRef`/`isSensorRef`/`parseSensorRef`
74
+ helpers in `records/shared`); `SensorType` gains 18 instrument classes
75
+ (infrasonic/ultrasonic sensors, ADS-B receiver, RF spectrum analyzer, passive
76
+ radar, particle detector, atomic clock, GNSS receiver, fluxgate magnetometer,
77
+ air-quality sensor, barometer, lightning detector, IMU, EEG, GSR, pulse
78
+ oximeter, pupillometer, hardware RNG); `DetectionMethod` gains 7 methods
79
+ (particle, gnss, time_reference, chemical, inertial, physiological, pressure).
80
+ Records schema artifact bumped to `1.1.0`.
81
+ - **`@disclosureos/schema`** — composed enriched-observation artifact re-emitted
82
+ at `1.1.0` to carry the records changes.
83
+ - **`@disclosureos/cli`** — new `disclosureos manifest validate <path...>`
84
+ command (`--recursive`, `--json`) delegating to `validateSensorManifest`.
85
+
86
+ ### Patch Changes
87
+
88
+ - Updated dependencies [e6ff99c]
89
+ - @disclosureos/records@1.1.0
90
+ - @disclosureos/observables@1.0.1
91
+ - @disclosureos/origins@1.0.1
92
+
7
93
  ## 1.0.0
8
94
 
9
95
  Initial public release — the portable contract.
10
96
 
11
97
  ### Added
98
+
12
99
  - `composeObservationSchema()` — merges the records core and every registered slot
13
100
  schema into one enriched `Observation` JSON Schema, tightening the root to
14
101
  `additionalProperties: false` while preserving the `extensions` bag.
package/README.md CHANGED
@@ -9,7 +9,7 @@ The **portable contract** for DisclosureOS. It composes the slot-bearing package
9
9
  (the `origin` slot) — into one **enriched `Observation`** that means the same thing
10
10
  in TypeScript, JSON Schema, and any other language.
11
11
 
12
- DisclosureOS is a **five-part standard** (records → observables → origins → claims → scoring).
12
+ DisclosureOS is a **six-part standard** (records → observables → origins → claims → scoring → instruments).
13
13
  `schema` is the contract that *binds* records and the package-owned slots into one
14
14
  portable artifact. It is a supporting package, not another part of the standard. (Scoring
15
15
  consumes the enriched record, so it is not part of the composed schema.)
@@ -95,3 +95,95 @@ DisclosureOS-specific adapter.
95
95
  ## License
96
96
 
97
97
  MIT © [Disclosure Foundation](https://disclosure.org)
98
+
99
+ ## Experimental v2 documentary support
100
+
101
+ `@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
+
103
+ `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.
104
+
105
+ The experimental v2 entry point also exports `evaluateMeasurementBindings` and
106
+ `MeasurementBindingsSchema`. The single-channel profile links measurements to
107
+ acquisition-bound raw products, captured channels, and explicit nominal capture
108
+ times, then runs local acquisition artifact checks. It does not verify clock
109
+ uncertainty, artifact contents, or scientific eligibility. See the
110
+ [measurement bindings guide](../../docs/experimental/measurement-bindings.md).
111
+
112
+ `evaluateInstrumentResearchPrerequisites` composes the experimental documentary
113
+ and measurement profiles with declared calibration-use and timing reviews. Passing
114
+ means reviewed input documentation is present and consistent, not scientific
115
+ eligibility. See the [research prerequisites guide](../../docs/experimental/research-prerequisites.md).
116
+
117
+ `evaluateReproductionPacket` verifies exact-byte input inventories before composing
118
+ research prerequisites. It never executes bundled methods. See the
119
+ [reproduction packet guide](../../docs/experimental/reproduction-packet.md) for the
120
+ fixed TypeScript/Python synthetic control and the independent consumer's limits.
121
+
122
+ `evaluateDatasetRelease` groups pinned reproduction packets into explicit sessions,
123
+ checking membership, context identity, and nominal temporal containment. This first
124
+ profile requires member packet prerequisites and does not authorize publication.
125
+ See the [dataset release guide](../../docs/experimental/dataset-release.md).
126
+
127
+ `evaluateSourceIntake` and `SourceIntakeSchema` accept unassessed source-file
128
+ receipts with explicit unknown context. Identity validation does not establish
129
+ research eligibility. See the [source intake guide](../../docs/experimental/source-intake.md).
130
+
131
+ `evaluateDocumentationCompletion` explains the existing documentary profile with
132
+ per-assessment applicability, requirement status, blocked prerequisites and next
133
+ actions. It preserves validator diagnostics and computes no aggregate score.
134
+ See the [documentation completion guide](../../docs/experimental/documentation-completion.md).
135
+
136
+ The opt-in `evaluateInstrumentResearchCompletion` adds six required phase statuses and source-based next actions while preserving the research validator result. See the [research completion guide](../../docs/experimental/research-completion.md).
137
+
138
+ The experimental `evaluateResearchEvaluation` pins local packet/dependency bytes and hashes its computed research results. See [evaluation provenance](../../docs/experimental/evaluation-provenance.md) for unsigned receipt semantics and execution limits.
139
+
140
+ The experimental [released-document provenance profile](../../docs/experimental/released-documents.md) checks selected documentary sources and direct extractions with required and recommended groups, without imposing sensor requirements.
141
+
142
+ Experimental [historical-testimony provenance](../../docs/experimental/historical-testimony.md) checks selected account bytes, recording citations and direct extraction attribution without assigning credibility or requiring sensor data.
143
+
144
+ Experimental [physical-sample provenance](../../docs/experimental/physical-samples.md) checks collected-specimen declarations, custody continuity and cited record bytes without certifying material identity, composition or origin.
145
+
146
+ Experimental [provenance-profile receipts and replay](../../docs/experimental/profile-evaluation.md) pin inputs and reproduce the full released-document, testimony or collected-specimen result, including failed and unchecked outcomes.
147
+
148
+ Experimental [profile preparation](../../docs/experimental/profile-preparation.md) assembles exact existing inputs into a new private evaluation bundle, calculates byte pins and preserves failing or unchecked profile outcomes.
149
+
150
+ ### Experimental migration review plans
151
+
152
+ `MigrationReviewSchema`, `MigrationReview` and `migrationReviewJsonSchema` are available
153
+ from `/experimental/v2`. The schema validates the review plan structure, source pin
154
+ and attribution; the CLI additionally validates target values and references through
155
+ the v2 claim-history parser. See the
156
+ [review checkpoint](../../docs/experimental/migration-review.md).
157
+
158
+ ### Experimental migration resolution plans
159
+
160
+ `MigrationResolutionSchema`, `MigrationResolution` and `migrationResolutionJsonSchema`
161
+ are available from `/experimental/v2`. The schema validates plan structure; the CLI
162
+ checks exact ledger pins and identity/revision membership before reporting selections.
163
+ See the [resolution contract](../../docs/experimental/migration-resolution.md).
164
+
165
+ ### Historical score preservation plans (experimental)
166
+
167
+ `MigrationLegacyScoresSchema`, `MigrationLegacyScores` and
168
+ `migrationLegacyScoresJsonSchema` describe pinned standalone score inputs and declared
169
+ legacy observation associations. JSON Schema is available at
170
+ `@disclosureos/schema/experimental/v2/migration-legacy-scores/schema` and its `/0.1.0`
171
+ alias. Plan validation does not verify historical calculations or observation links.
172
+ See the [historical score adapter](../../docs/experimental/migration-legacy-scores.md).
173
+
174
+ ### Migration field dispositions and sensor revision review
175
+
176
+ `migrate compatibility legacy.json [sensor-review.json] --id namespace --json`
177
+ inventories mapped, retained-without-conversion and unresolved fields. Optional explicit
178
+ review pins an acquisition's manifest and supplied provenance without inferring
179
+ calibration or converting measurements. The review plan is exposed as
180
+ `MigrationCompatibilitySchema`, `MigrationCompatibility` and
181
+ `migrationCompatibilityJsonSchema` from `@disclosureos/schema/experimental/v2`.
182
+ See the [compatibility inventory contract](../../docs/experimental/migration-compatibility.md).
183
+
184
+ ## Experimental v2 migration and compatibility
185
+
186
+ Start with the [developer compatibility guide](../../docs/experimental/migration-guide.md)
187
+ for breaking changes, parser/version boundaries, supported migration workflows,
188
+ exit handling, profile differences and non-destructive local rollback. This is an
189
+ experimental checkout workflow; merging package changes does not deploy the Index.