@disclosureos/instruments 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 +12 -0
- package/README.md +41 -18
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @disclosureos/instruments
|
|
2
2
|
|
|
3
|
+
## 2.0.0-beta.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [0b00be3]
|
|
8
|
+
- Updated dependencies [9580e62]
|
|
9
|
+
- Updated dependencies [559eac9]
|
|
10
|
+
- Updated dependencies [5a686c1]
|
|
11
|
+
- Updated dependencies [813ee2c]
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
- @disclosureos/records@2.0.0-beta.4
|
|
14
|
+
|
|
3
15
|
## 2.0.0-beta.3
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# @disclosureos/instruments
|
|
2
2
|
|
|
3
|
+
Describe the equipment and capture context behind a measurement, including exact manifest revisions, instrument instances, deployments, timing and calibration context.
|
|
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
|
+
Use `parseAcquisitionContext` from `@disclosureos/instruments/experimental/v2` for V2 captures. Sensor manifests remain available from the package root. Radar, sonar, lidar and satellite product profiles and readers live in `@disclosureos/schema/experimental/v2`. The Sensor Manifest originated with a contribution from ELDÆON.
|
|
16
|
+
|
|
17
|
+
[Implementation guide](https://os.disclosure.org/v2/docs/instruments) · [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/instruments@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 **UAP Sensor Manifest** — a per-sensor specification standard for detection
|
|
@@ -11,22 +48,6 @@ different organizations are comparable, replicable, and verifiable.
|
|
|
11
48
|
Proposed by [ELDÆON](https://github.com/disclosurefoundation/disclosureos/pull/5)
|
|
12
49
|
and promoted into the framework as a foundation package.
|
|
13
50
|
|
|
14
|
-
DisclosureOS is a **six-part standard**. Each part answers one question about an
|
|
15
|
-
observation; `@disclosureos/schema` binds the package-owned pieces into one portable
|
|
16
|
-
contract (a single TS type + JSON Schema + non-stripping parse).
|
|
17
|
-
|
|
18
|
-
| Part | Package surface | Question it answers |
|
|
19
|
-
|---|---|---|
|
|
20
|
-
| **Records** | `@disclosureos/records` | *What was observed?* |
|
|
21
|
-
| **Observables** | `@disclosureos/observables` | *What anomalous characteristics did it show?* |
|
|
22
|
-
| **Origins** | `@disclosureos/origins` | *What might explain it?* |
|
|
23
|
-
| **Claims** | `@disclosureos/records/shared` | *Who assessed it, why, and on what evidence?* |
|
|
24
|
-
| **Scoring** | `@disclosureos/scoring` | *How complete / compelling is the case?* |
|
|
25
|
-
| **Instruments** | `@disclosureos/instruments` | *What hardware produced the data?* |
|
|
26
|
-
|
|
27
|
-
Supporting packages: **`@disclosureos/schema`** (the portable contract that composes the
|
|
28
|
-
package-owned pieces), **`@disclosureos/cli`** (tooling), and
|
|
29
|
-
**`@disclosureos/examples`** (the runnable golden path). *(You are here: **Instruments**.)*
|
|
30
51
|
|
|
31
52
|
> **See it end to end.** [`examples/golden-path.ts`](../../examples/golden-path.ts)
|
|
32
53
|
> takes one observation through every part — including a sensor manifest cited via
|
|
@@ -79,7 +100,7 @@ The functional hardware context `SensorReading` deliberately does not carry:
|
|
|
79
100
|
## Install
|
|
80
101
|
|
|
81
102
|
```bash
|
|
82
|
-
pnpm add @disclosureos/instruments zod
|
|
103
|
+
pnpm add @disclosureos/instruments@2.0.0-beta.4 zod
|
|
83
104
|
```
|
|
84
105
|
|
|
85
106
|
## Usage
|
|
@@ -112,7 +133,7 @@ formatSensorManifest(manifest); // "ELDÆON — 1 sensor across 1 modality"
|
|
|
112
133
|
Validate manifest files from the command line:
|
|
113
134
|
|
|
114
135
|
```bash
|
|
115
|
-
pnpm dlx @disclosureos/cli manifest validate ./manifests/eldaeon-sensors.json
|
|
136
|
+
pnpm dlx @disclosureos/cli@2.0.0-beta.4 manifest validate ./manifests/eldaeon-sensors.json
|
|
116
137
|
```
|
|
117
138
|
|
|
118
139
|
## JSON Schema
|
|
@@ -133,3 +154,5 @@ MIT © Disclosure Foundation
|
|
|
133
154
|
## Experimental acquisition context
|
|
134
155
|
|
|
135
156
|
`@disclosureos/instruments/experimental/v2` adds pinned manifest, deployment, and channel-calibration history with explicit unresolved states. See the [contract and synthetic example](../../docs/experimental/acquisition-context.md). This additive metadata contract does not change the v1 manifest or certify scientific validity.
|
|
157
|
+
|
|
158
|
+
</details>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@disclosureos/instruments",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.4",
|
|
4
4
|
"description": "UAP Sensor Manifest — per-sensor specification standard for detection hardware in the DisclosureOS ecosystem",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
],
|
|
81
81
|
"dependencies": {
|
|
82
82
|
"zod": "4.4.3",
|
|
83
|
-
"@disclosureos/records": "2.0.0-beta.
|
|
83
|
+
"@disclosureos/records": "2.0.0-beta.4"
|
|
84
84
|
},
|
|
85
85
|
"devDependencies": {
|
|
86
86
|
"@types/node": "^20",
|