@agent-blueprint-protocol/verifier 1.0.0-rc.1 → 1.0.0-rc.2

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 CHANGED
@@ -2,6 +2,42 @@
2
2
 
3
3
  All notable public changes to `agent_blueprint_protocol` are documented here.
4
4
 
5
+ ## [1.0.0-rc.2] — 2026-11-11
6
+
7
+ Documentation corrections cover the README, npm package README, guides, Livebooks, and site. The npm package description states the verifier's checks.
8
+ The unused TypeScript `Context` type is no longer exported; no exported function
9
+ accepted it. Release tooling works for any candidate or final version.
10
+
11
+ The shipped registry contains only the protocol's federation registrations:
12
+ `io.github.baselabs/federation` (active) and `com.example/federation`
13
+ (deprecated), both critical and schema-pinned. Hosts that negotiated the five
14
+ earlier product example namespaces supply their own entries through the host
15
+ support registry and provide the schema documents they hold. Compiled entries
16
+ retain their criticality and schema pins under host overrides. The product
17
+ schema and product-specific projection fixture are removed.
18
+
19
+ The registry digest changes and verification-semantics version is now 3;
20
+ protocol revision remains 1. All six prior censuses, covering 0.3.0 through
21
+ 0.8.4 and 1.0.0-rc.1, are declared `diverged_by_registry_census`. In each,
22
+ `negotiation-estate-contract-valid` now denies `extension_unknown_critical`;
23
+ the digest-mismatch, schema-absent, and tier-bound cases deny the same code;
24
+ the criticality-conflict case becomes valid with the optional body quarantined;
25
+ and `extension-resolve-estate-deprecated-retained` changes from a deprecated
26
+ notice to unknown-optional quarantine. For 1.0.0-rc.1, the two
27
+ `*-deprecated-optional-notice` cases also report unknown-optional quarantine,
28
+ and `reconcile-deprecated-optional` changes its extension evidence from
29
+ retained to quarantined and removes it from the retained list. All other
30
+ prior-census projections remain equivalent. Compatibility replay checks these
31
+ changes against the registry difference, including composed imports.
32
+
33
+ Generic host registrations replace the earlier examples in the current corpus.
34
+ The corpus contains 626 cases, including 22 new host lifecycle and schema-pin
35
+ cases. Its digest is `sha-256:0B_9tnAAo05n3bWVvnIPDxFeqEr2XhJoDdaxNJv0_9A`;
36
+ the registry digest is `sha-256:hreDA2_XbV5J9geMJDDYG5BB42AGkh9jmQ9bqHe8kRk`.
37
+
38
+ The obsolete `verifier/RUNNER.md` redirect is removed from the repository and
39
+ the standalone archive. The runner contract is `spec/conformance/runner.md`.
40
+
5
41
  ## [1.0.0-rc.1] — 2026-11-11
6
42
 
7
43
  ### Breaking
package/README.md CHANGED
@@ -1,7 +1,8 @@
1
1
  # Agent Blueprint Protocol for TypeScript
2
2
 
3
3
  A typed, non-authorizing verifier library and conformance CLI. Node 24 or
4
- newer; zero runtime dependencies. The npm and Hex packages share one version.
4
+ newer; zero runtime dependencies. For Elixir, see
5
+ [agent_blueprint_protocol](https://hex.pm/packages/agent_blueprint_protocol).
5
6
  The specification is [published with the project](https://github.com/baselabs/agent_blueprint_protocol/blob/main/spec/protocol.md).
6
7
 
7
8
  ```sh
@@ -9,10 +10,7 @@ npm install @agent-blueprint-protocol/verifier
9
10
  npx @agent-blueprint-protocol/verifier --help
10
11
  ```
11
12
 
12
- For a candidate, append `@rc` to the install and npx package name. Stable
13
- releases use `latest`. A staged version is
14
- installable only after its npm approval. `npm view
15
- @agent-blueprint-protocol/verifier@rc version` identifies the live candidate.
13
+ Install the published package and run its CLI with `npx @agent-blueprint-protocol/verifier`. `npm view @agent-blueprint-protocol/verifier version` identifies the published package version.
16
14
 
17
15
  ## CLI
18
16
 
@@ -20,24 +18,24 @@ installable only after its npm approval. `npm view
20
18
  |---|---|
21
19
  | no arguments | run the embedded certified corpus |
22
20
  | `--corpus <dir>` | run an integrity-checked corpus, emit the aggregate report |
23
- | `--prior-corpus <dir>` | replay the prior census under current semantics |
21
+ | `--prior-corpus <dir>` | verify an earlier released corpus under this release's semantics |
24
22
  | `--results --corpus <dir>` | emit canonical per-case results |
25
23
  | `--serve --corpus <dir>` | speak the external execution protocol |
26
24
  | `--artifact <file>` | decode a Blueprint, Deployment, or federation envelope |
27
25
  | `--help`, `--version` | usage or package version |
28
26
  | `conformance run --corpus <dir> --results <file> -- <command...>` | drive and judge another implementation |
29
27
 
30
- Runner exits: 0 agreement/valid/help/version, 1 disagreement/invalid artifact,
31
- 2 usage/readability/integrity failure, 3 internal invariant failure. Corpus
32
- stderr states whether the digest matches the release-certified corpus.
33
- Readers reject symlinks and nonregular files and cap a tree at 1,000 entries
34
- and 5,000,000 bytes. Stdout reports and results are JCS without a trailing LF.
35
- Harness exits 10–19 identify handshake mismatch, duplicate, missing, extra,
36
- reordered, malformed, oversized, timeout, early-exit and disagreement outcomes
37
- in that order. The execution contract in the specification defines each.
28
+ Runner exit codes: 0 for agreement, a valid artifact, help, or version; 1 for disagreement or an invalid artifact; 2 for a usage, read, or corpus-integrity failure; 3 for an internal error. On a corpus run, standard error states whether the digest matches the release-certified corpus. Corpus readers reject symbolic links and non-regular files, and cap a corpus at 1,000 files and 5,000,000 bytes. Reports and results on standard output are JSON Canonicalization Scheme (JCS, RFC 8785) bytes without a trailing newline. Harness exit codes 10 to 19 mean, in order: handshake mismatch, duplicate, missing, extra, or reordered response, malformed line, oversized line, timeout, early exit, and disagreement. The execution contract in the specification defines each.
38
29
 
39
30
  ## Library
40
31
 
32
+ The shipped extension registry contains only the protocol's active and
33
+ deprecated federation registrations. Supply other namespaces through
34
+ `Support.registry`, including criticality, lifecycle state, and `schemaDigest`;
35
+ put held schema documents in `Support.schemas`. A host cannot change the
36
+ criticality or schema pin of a compiled entry. See the
37
+ [host registration examples](https://github.com/baselabs/agent_blueprint_protocol/blob/main/documentation/extensions.md#register-a-namespace-with-the-host).
38
+
41
39
  The package is ESM-only; `require()` is not supported.
42
40
  Only the package root and `package.json` are exported. Import has no command
43
41
  or filesystem side effects. Every function returns `Result<T>`:
@@ -45,6 +43,8 @@ or filesystem side effects. Every function returns `Result<T>`:
45
43
  `Uint8Array` and strings; consumers need no Node global declarations.
46
44
  `ErrorCode` is exhaustive, including `ceiling:<key>` denials.
47
45
 
46
+ Save [`examples/echo-blueprint.json`](https://github.com/baselabs/agent_blueprint_protocol/blob/main/examples/echo-blueprint.json) beside the script; the npm package does not include it.
47
+
48
48
  ```js
49
49
  // verify.mjs — run beside echo-blueprint.json
50
50
  import { readFileSync } from "node:fs";
@@ -53,10 +53,7 @@ const result = decodeBlueprint(readFileSync("echo-blueprint.json"));
53
53
  console.log(result.ok ? "valid" : result.error.code); // valid
54
54
  ```
55
55
 
56
- The following examples use canonical example bytes `blueprintBytes`,
57
- `deploymentBytes`, `envelopeBytes`, caller-supplied `keys` and `observed`,
58
- and integrity-checked corpus files `files`. They return evidence, never
59
- permission. Check `ok` before reading `value`.
56
+ The following examples assume canonical artifact bytes `blueprintBytes`, `deploymentBytes`, and `envelopeBytes`; caller-supplied `keys`, `observed`, `signatureEntry`, `requestedBounds`, `deploymentBounds`, and `hostBounds`; and `files`, a `Map` from corpus-relative path to file bytes. They return evidence, never permission. Check `ok` before reading `value`.
60
57
 
61
58
  ```ts
62
59
  import {
@@ -96,8 +93,7 @@ if (corpus.ok) {
96
93
 
97
94
  Decoded views expose read-only JSON `value`, `canonicalBytes`, and
98
95
  `contentDigest` (null for a federation envelope, whose commitment is a
99
- separate identity). `Support`, `Inputs`, `Observations`, `Observed`,
100
- `Context`, `PublicKey`, `BoundSet`, and decoder `Bounds` describe the
96
+ separate identity). `Support`, `Inputs`, `Observations`, `Observed`, `PublicKey`, `BoundSet`, and decoder `Bounds` describe the
101
97
  caller-supplied facts. `Evidence` includes typed checks, effective bounds,
102
98
  clamps, and a nonempty `not_verified` list. Unsigned artifacts succeed with
103
99
  signature verification explicitly unestablished; absent descriptor and
@@ -114,37 +110,21 @@ After a pass, add `--claim claim.json --implementation example-verifier
114
110
  --platform example-platform --date 2026-11-10` before `--`. A claim is unsigned
115
111
  and identifies the implementation, corpus, registry and results bytes. A
116
112
  non-certified corpus requires `--prior-corpus-digest <exact-digest>` to name
117
- the prior census explicitly. Publish the claim and exact results document
118
- beside source and the reproducible command. A public corpus pass proves
119
- neither honest computation nor behavior outside the census nor any host
120
- behavior. The kit includes the runner and execution contracts under `dist/spec/`.
113
+ the prior released corpus explicitly. Publish the claim and exact results
114
+ document beside source and the reproducible command. A public corpus pass
115
+ proves neither honest computation nor behavior outside the corpus nor any
116
+ host behavior. The package includes the runner and execution contracts under
117
+ `dist/spec/`.
121
118
 
122
- ## Import migration
119
+ ## Migrating from 0.8
123
120
 
124
- | Previous internal import and symbol | Package-root replacement |
125
- |---|---|
126
- | `dist/verifier/blueprint.js`: `decode` | `decodeBlueprint` |
127
- | `dist/verifier/deployment.js`: `decode` | `decodeDeployment` |
128
- | `dist/verifier/federation.js`: `decode` | `decodeFederationEnvelope` |
129
- | artifact modules: `canonicalBytes` | `canonicalBytes` |
130
- | `dist/verifier/negotiation.js`: `negotiate` | `negotiate` |
131
- | `dist/verifier/bounds_algebra.js`: `intersect` | `intersect` with a Sources object |
132
- | `dist/verifier/compatibility.js`: `verify` | `verifyCompatibility` |
133
- | `dist/verifier/signature.js`: `verify` | `verifySignature` |
134
- | `dist/verifier/corpus.js`: `load` | `loadCorpus` |
135
- | `dist/verifier/runner.js`: `run` | `runCorpus` |
136
- | `dist/verifier/report.js`: `build`, `toBytes` | `buildReport`, `buildResultsDocument` |
137
-
138
- Deep imports no longer resolve. Internal `{ok,v,e}` records become public
139
- `{ok,value,error}` results. `reconcile` and `federationMapping` are new root
140
- operations. Internal byte, schema and codec helpers have no supported deep
141
- import replacement. The package-root surface is the supported TypeScript API.
121
+ Deep imports from `dist/verifier/` no longer resolve; import from the package root. The [TypeScript guide](https://github.com/baselabs/agent_blueprint_protocol/blob/main/documentation/typescript.md#import-migration) maps each previous import to its replacement.
142
122
 
143
123
  ## Compatibility within 1.x
144
124
 
145
125
  Node 24 remains the runtime floor for all of 1.x; Node 26 is also supported.
146
126
  TypeScript 5.0.2 is the compiler floor. Packed declarations are checked at
147
- that floor and the current compiler with `moduleResolution: "nodenext"`,
127
+ that floor and at the TypeScript version used in CI with `moduleResolution: "nodenext"`,
148
128
  `skipLibCheck: false`, and no `@types/node` dependency.
149
129
 
150
130
  `ErrorCode` stays a closed union throughout 1.x, so exhaustive switches are
@@ -164,9 +144,8 @@ function deprecated(notice: Notice): boolean {
164
144
  }
165
145
  ```
166
146
 
167
- Elixir consumers match structs on the fields they use. Release-manifest
168
- readers ignore unknown additive members but reject unknown equivalence
169
- claims. Every unknown nonzero harness exit is failure. New revisions,
147
+ Release-manifest readers ignore unknown additive members but reject unknown
148
+ equivalence claims. Every unknown nonzero harness exit is failure. New revisions,
170
149
  profiles, execution versions, modes, and flags are opt-in; existing contracts
171
150
  and earlier corpus claims keep their meaning.
172
151