@byollm/protocol 0.1.0 → 0.1.1

package/README.md

@@ -1,109 +1,11 @@
-> **`alpha.15` is a breaking wire change, and it breaks daemons and relays —
-> not app authors.** If you call `app.enqueue(...)` and read results, nothing
-> in your code changes. If you run a daemon or an upstream, every package must
-> move together: a mixed pair refuses on both sides, because both ends parse
-> `.strict()`.
+<!-- release-note 0.1.1 -->
+> **`0.1.1` is documentation only — nothing to upgrade.** `PROTOCOL_VERSION`
+> is still `2`, so a 0.1.0 party and a 0.1.1 party talk to each other in both
+> directions. No dependency, schema, wire field or on-disk shape moved.
 >
-> What moved, all of it reconciling the frozen `byollm_009` with its code:
-> `JobStub` gains `site` (the site's identity key id) and loses
-> `audienceAllow`; `ResultRequest` gains `leaseId`; `HeartbeatResponse` loses
-> `leases`, which nothing read; `WireErrorCode` gains `not-ready`,
-> `clock-skew` and `forbidden`, and `403` is `forbidden` rather than
-> `unauthorized`. `RESULT_PROVENANCE` is superseded by
-> `PROVENANCE_NAMES_DEVICE`. See `byollm_009` Amendment A.>
-> **`alpha.16` is a breaking wire change — daemons and relays again, not app
-> authors.** `app.enqueue(...)` and reading results are unchanged. All five
-> packages move together: both ends parse `.strict()`, so a mixed pair
-> refuses.
->
-> What moved, all of it Tier 2 of `cloud_008`: `model`, `backendClass` and
-> `durationMs` come off `ResultRequest` and are sealed **inside** the result
-> envelope as `SealedOutcome = { outcome, ran }` — so a daemon can no longer
-> declare a model it did not sign, and a relay carries neither.
-> `HeartbeatResponse` loses `leases` (nothing read it) and now reports real
-> cancellations instead of an empty list. `WireErrorCode` gains `forbidden`
-> for 403, leaving `unauthorized` at exactly 401. The relay gained a
-> site-plane `cancel` endpoint, honours `stub.deadlineAt`, honours
-> `stub.audience`, and remembers a refusal.>
-> **`alpha.17` is additive** — no wire change. It exports `ReleaseReason`,
-> which `RoutingStore.releaseLeases` names and the package did not export, so
-> the interface was unimplementable outside this repo.>
-> **`alpha.18` is a breaking wire change — daemons and relays, not app
-> authors.** `app.enqueue(...)` and reading results are unchanged. All five
-> packages move together.
->
-> The **bearer token is gone**: off `PairPollResponse`, off the runner row,
-> off the daemon's pairings file, out of the adapter's schema. It was minted,
-> hashed and stored on two disks and never sent, looked up or compared —
-> `REQUESTS_SIGNED_NOT_BEARER` was enforced by signatures the whole time. If
-> you run the Supabase adapter, apply
-> `20260819000000_drop_runner_token.sql`; `byollm_approve_pairing` now takes
-> one argument. A pairings file written by an older daemon still loads.
->
-> `model`, `backendClass` and `durationMs` moved **inside** the sealed result
-> (`SealedOutcome = { outcome, ran }`), so a daemon cannot declare a model it
-> did not sign and a relay carries none of them. Writing a `RoutingStore`?
-> `releaseLeases` takes an optional `reason` and `complete` requires
-> `leaseId`, and **an implementation that ignores either still typechecks** —
-> run the store contract tests.>
-> **`alpha.19` is additive on the wire and a behaviour change in every
-> store.** `ResultResponse` gains an optional `duplicate`. Nothing is removed,
-> so an older daemon keeps working — but the *order* two rules are checked in
-> has changed, and a `RoutingStore` implementation must change with it.
->
-> `complete` now checks **terminal state before holder**, scoped to the device
-> that finished the job: a replay from that device is answered `duplicate:
-> true` with a 2xx, and anyone else gets exactly the refusal they would get
-> for a job that is not terminal. Previously `RESULT_IDEMPOTENT` held only
-> because the lease is nulled on success, so the holder check tripped first —
-> deleting the idempotency branch failed no test. Run the store contract
-> tests; the compiler cannot see this.
->
-> **`alpha.3` is a breaking change.** `BackendDescriptor.account` is gone —
-> read `cost` (`free` / `metered` / `subscription`) instead. Four new MUSTs
-> come with it; see `byollm_007`.
-
-<!-- release-note 0.1.0-alpha.21 -->
-> [!NOTE]
-> **`0.1.0-alpha.20` is not a complete release — do not pin it.** Four
-> packages published and `@byollm/server` did not: a Sigstore
-> transparency-log 409 on its provenance attestation. The workflow's
-> "already published" guard correctly refuses to resume a partial publish,
-> so `0.1.0-alpha.21` is that release, whole.
->
-> If you run the Supabase adapter, `alpha.21` needs
-> `20260819010000_completed_by_lease_id.sql`: alpha.19 shipped §3.6's
-> ordering without the column it stores the grant in.
-
-<!-- release-note 0.1.0-alpha.40 -->
-**`byollm start` — stop keeping a terminal open.** The daemon can now run
-under your computer's own supervisor and restart itself if it stops: a launchd
-agent on macOS, a `systemd --user` unit on Linux, a logon task on Windows. All
-user-level — no root, no system directories, and `byollm stop` takes it
-away. `byollm status` gained a line saying whether it is actually supervised
-right now, including the state that matters most: installed but not running,
-which looks fine from an app's dashboard and serves nothing.
-
-If you are running via `npx`, install properly first (`npm install -g
-byollm@latest`) — `install` refuses to supervise a copy in npx's cache, because
-npm deletes that directory and the service would fail at some later boot.
-
-<!-- release-note 0.1.0-alpha.41 -->
-**`onNoRunner` takes a string.** Your fallback answer is your own value, not
-wire data, and handing back a whole result record for it was ceremony — the
-README's own example got the shape wrong, which is how this was found.
-
-```ts
-const { outcome, fallback } = await job.result({
-  onNoRunner: () => runOnHostedModel(transcript),
-});
-```
-
-Whatever you return, `result()` labels it `fallback: true` — the stamp is
-applied by the wait, not taken from you, so an answer that did not run on
-somebody's device cannot be reported as though it did (`FALLBACK_LABELED`).
-Both delivery channels do it, polling and Supabase Realtime. Records still
-work; they just get labelled too.
+> This README used to open with a stack of release notes instead of with the
+> package. The history moved to `docs/release-notes/` and `CHANGELOG.md`,
+> where none of it was lost. Full note: `docs/release-notes/0.1.1.md`.
 
 # `@byollm/protocol`
 

package/dist/index.d.ts

@@ -186,11 +186,17 @@ declare function checkProtocolVersion(body: unknown): VersionRefusal | null;
  * starts meaning "the unstable one", and every user who followed this message
  * is pinned to prereleases with nothing to tell them.
  *
- * Note this is deliberately *not* the rule `scripts/check-site.mjs` enforces
- * on the docs, which requires `npx byollm@alpha`. That rule is about somebody
- * choosing to install a prerelease knowingly, with the warning in front of
- * them. This is an upgrade instruction handed to somebody who already has the
- * daemon and needs a newer one — a different question with a different answer.
+ * This once said `scripts/check-site.mjs` deliberately enforces the OPPOSITE
+ * on the docs — *"which requires `npx byollm@alpha`"* — and drew a careful
+ * distinction between choosing a prerelease knowingly and being handed an
+ * upgrade command. **That rule inverted at the flip and this paragraph did
+ * not.** check-site now refuses any pin but `@latest`, for the reason written
+ * beside it: *"the tag that moves first is reviewed last, so asking for it
+ * explicitly is asking for the build nobody has looked at yet."* Which is what
+ * this constant already said, so the distinction it drew no longer exists.
+ *
+ * Found sweeping B341 — the same decay as B336 and B339, a third time, and
+ * every one was prose left standing over a constant that moved beneath it.
  */
 declare const UPGRADE_COMMAND: "npm i -g byollm@latest";
 /** The path prefix all endpoints mount under. */