DisclosureOS documentation · v2 Beta
Installation and availability
Install the published Beta 4 packages and choose the APIs your integration needs.
DisclosureOS is in beta. The published V2 packages are at 2.0.0-beta.4. All six documentation areas use this release, including laboratory records, sensor profiles, shared vocabulary references and provider scoring.
Start with one package
For your first integration, use Node.js 22 and npm. In your project directory, install the records package:
npm install --save-exact @disclosureos/records@2.0.0-beta.4Create and validate your first record →
The tutorial includes project setup, a complete example, its expected result and a deliberate error. No account or hosted service is required.
Use an exact version. The beta tag currently points to 2.0.0-beta.4; latest still points to V1. An install without a version selects latest. Commit your lockfile so your application can reproduce its dependency set.
Add packages as needed
You do not need to install all seven packages. Add each package at 2.0.0-beta.4 when the guide you are following calls for it.
| Package | Use it for |
|---|---|
@disclosureos/records | Observation documents, source relationships and attributed claim histories. |
@disclosureos/instruments | Equipment, recording sessions and capture conditions. |
@disclosureos/schema | Checks across supplied documents and supported source-file profiles. |
@disclosureos/cli | Command-line tasks, including source intake and dataset checks. Install as a development dependency. |
@disclosureos/observables | Revised characteristic definitions and shared vocabulary references. |
@disclosureos/origins | The origin catalog, immutable catalog snapshots and claim connections. |
@disclosureos/scoring | Provider scoring policies and results, comparisons and evaluation summaries. |
For example, to add equipment and cross-document checks:
npm install --save-exact @disclosureos/instruments@2.0.0-beta.4 @disclosureos/schema@2.0.0-beta.4For the dataset contribution exercise:
npm install --save-dev --save-exact @disclosureos/cli@2.0.0-beta.4The packages use ESM. Use a .mjs file, or configure your project for ESM. V2 document APIs use /experimental/v2 imports where the guide specifies them; catalog exports use their documented entry points. Copy the import from the relevant guide rather than adding that suffix to every package.
One release across the guides
Use 2.0.0-beta.4 for the documented record, instrument, observable, claim, origin and scoring APIs. The sensor-profile guides also provide optional instructions for rebuilding their synthetic data from the exact source revision used to create it. You do not need to build the standard from source to use these APIs.
The Document inspector checks supported observation, context, research-entity and claim-history documents, including material and laboratory records. It checks one document at a time. Sensor profiles, provider scores and external files require their package evaluators, as shown in the relevant guide.
The standalone showcase remains a React/Next.js application supplied as source. Its renderers are not a separately published npm component package. The renderer support guide identifies supported inputs and display limits.
Reproduce a retained example
A fixture's source revision records how its files were generated. Keep that revision when rebuilding the fixture, along with its retained documents and digests. Use the published packages for the guide's validation and reading examples. A successful check does not establish physical calibration or scientific validity.
Release identity
The Beta 4 verification receipt records the package fingerprints and canonical source revision fd2b451e694b4bcc383a25b362eeacaf94ac2fd3 used for that release. The portal inventory separately identifies this site's installed packages, retained example sources and hosted schemas.
Keep these identifiers separate:
- Package version: the npm release you install, such as
2.0.0-beta.4. - Source revision: the exact repository commit used to build a release or reproduce an example.
- Document or profile version: the format declared inside a document, such as observation
schemaVersion: "0.1.0". Use the value specified by that format, not the npm version. - Catalog revision: the immutable definition set selected by a vocabulary reference.
Experimental schema URNs identify formats; they are not downloadable HTTPS addresses. Obtain schema documents from the exports named in each field reference.