@byollm/protocol 0.1.2 → 0.1.4

package/README.md

@@ -1,5 +1,5 @@
 <!-- release-note 0.1.1 -->
-> **`0.1.2` is documentation only — nothing to upgrade.** `PROTOCOL_VERSION`
+> **`0.1.4` 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.
 >

package/dist/index.d.ts

@@ -45,7 +45,16 @@ export { C as CONSOLE_FRAME_VERSION, a as CONSOLE_MAX_DATA_BYTES, b as ConsoleBy
  * unchanged by the move.
  */
 /**
- * The hub fence, verbatim — ruled by Todd, 2026-09-04.
+ * The hub fence, verbatim — ruled by Todd, 2026-10-22 (#4058), replacing the
+ * 2026-09-04 wording.
+ *
+ * It says what the hub sees and stops there. The old sentence opened "sees
+ * only what routing and metering need", and that opening is why the sentence
+ * was ruled three times: a justification fails every new fact that serves
+ * neither — the device that did each job is kept for the team card, not for
+ * routing (which has it in Valkey) or billing (unchanged). Without it, the
+ * fence is the mapping below: a column that fits a clause is a release, and
+ * one that fits none is a ruling.
  *
  * Asserted whole rather than by keyword wherever it is checked: "close
  * enough" is not a standard a page about what we can see gets to use, and a
@@ -976,6 +985,55 @@ declare const ABOUT_SHORT_LEDE = "BYOLLM \u2013 Bring Your Own LLM \u2013 lets y
 declare const ABOUT_SHORT_TAIL = "Sites can charge you less because you bring your own \u2013 see why that matters \u2192. Teams can optionally share the free or metered services on their devices with people they name. Personal subscriptions are never shared.";
 /** Both halves, for a surface that wants the paragraph entire. */
 declare const ABOUT_SHORT = "BYOLLM \u2013 Bring Your Own LLM \u2013 lets you use your own AI on websites you authorize. A small program installed on your machine lets you use your own models and subscriptions on any BYOLLM-integrated site, including new models the moment you get access \u2013 no site updates required. BYOLLM Cloud connects sites to your devices with end-to-end encryption, so no one, including us, can see your data.\n\nSites can charge you less because you bring your own \u2013 see why that matters \u2192. Teams can optionally share the free or metered services on their devices with people they name. Personal subscriptions are never shared.";
+/** Who a prompt is for, which is also which path it sets up. */
+type AgentPromptAudience = "user" | "developer" | "operator";
+/** One "paste this into your agent" prompt. */
+interface AgentPrompt {
+    /** Stable, for anchors: `agent-<id>` on byo-llm.com. */
+    readonly id: string;
+    readonly title: string;
+    readonly audience: AgentPromptAudience;
+    /** Verbatim, line breaks included — what the copy button copies. */
+    readonly prompt: string;
+}
+/** The heading every surface shows above the prompts. */
+declare const AGENT_PROMPTS_HEADING = "You already have an AI. Hand it this.";
+/** The one line under it. */
+declare const AGENT_PROMPTS_LEDE = "Paste the prompt into whatever you use \u2014 Claude, ChatGPT, Codex, Cursor, a local model \u2014 and it does the setup, stopping where a step needs you.";
+/** Set up my computer, add BYOLLM to my site, run my own relay — in that order. */
+declare const AGENT_PROMPTS: readonly AgentPrompt[];
+
+/**
+ * What BYOLLM does not do yet — one list, rendered on every surface.
+ *
+ * Todd, 2026-10-06: the sites did not call out the limits the way the
+ * open-sourcing post did. The post's sentence is the source of the words; this
+ * is the source of the list. The README's "Not yet", byo-llm.com's "What it
+ * doesn't do yet" and byollm.cloud render from here, and a test on each
+ * surface fails when its copy and this disagree.
+ *
+ * Hand-written beside `about.ts` rather than inside it, because that file is
+ * generated from the ABOUT markdown and this one derives from code.
+ */
+interface NotYet {
+    /** The missing thing, phrased so "no …" reads as a sentence. */
+    readonly what: string;
+    /** What that means for you, when the name alone does not say. */
+    readonly detail?: string;
+}
+/** What BYOLLM does not do yet, in the post's order. */
+declare const NOT_YET: readonly NotYet[];
+declare const NOT_YET_LEDE = "Things we know are limiting right now:";
+declare const NOT_YET_TAIL = "We have plans for every one of these, and we are building in public.";
+/** The list as one paragraph — the post's sentence, from the list. */
+declare function notYetSentence(list?: readonly NotYet[]): string;
+/**
+ * One entry as a list line: "Streaming — a result comes back whole".
+ *
+ * Every list surface renders this, so the README, byo-llm.com and
+ * byollm.cloud cannot each phrase an entry their own way.
+ */
+declare function notYetLine({ what, detail }: NotYet): string;
 
 /**
  * Its members, for anything that has to report what it accepts.
@@ -2984,4 +3042,4 @@ declare const MUST_IDS: readonly ("PAIR_ONE_USER" | "PAIR_INTERACTIVE" | "PAIR_C
 /** Every MUST verified a particular way. */
 declare function mustsVerifiedBy(kind: MustVerification): MustId[];
 
-export { ABOUT, ABOUT_SHORT, ABOUT_SHORT_LEDE, ABOUT_SHORT_TAIL, AUDIENCES, Audience, BACKENDS, BACKEND_CLASSES, BACKEND_IDS, BackendClass, BackendCost, type BackendDescriptor, type BackendId, BackendIdSchema, CLOCK_ATTRIBUTION_MS, CLOCK_SKEW_WARN_MS, Capability, CapabilityMatrix, ChatMessage, ChatPayload, ClaimRequest, ClaimResponse, ClaimedJob, ClaimedStub, DEFAULT_ROUTING, DeliveredResult, ENDPOINTS, ERROR_STATUS, type Endpoint, type FenceClause, FetchRequest, FetchResponse, type FloorRefusal, GRANT_CONTEXT, GRANT_MAX_AGE_MS, GRANT_SIGNED_FIELDS, GeneratePayload, type GrantClaims, GrantRef, type GrantRefusal, HUB_FENCE, HUB_FENCE_CLAUSES, HeartbeatRequest, HeartbeatResponse, JOB_KINDS, JobKind, JobOutcome, JobPayload, JobRefused, JobResultCanceled, JobResultError, JobResultOk, JobState, JobStub, KindedPayload, Lease, MAX_CLOCK_SKEW_MS, MAX_ENVELOPE_BYTES, MAX_PURPOSES, MAX_SUCCESSION_CHAIN, MIN_PROTOCOL_VERSION, MUSTS, MUST_IDS, Manifest, type MatchDaemon, type MatchJob, MatchRefusal, type MatchResult, type Must, type MustEnforcer, type MustId, type MustVerification, type MustVerifiedBy, OFFER_SCOPES, OfferScope, PAYLOAD_LIMITS, PROTOCOL_PREFIX, PROTOCOL_VERSION, PairPollRequest, PairPollResponse, PairRequest, PairStartRequest, PairStartResponse, type PayloadFor, PublicIdentity, Purpose, PurposeRouting, REFUSAL_MESSAGES, REFUSAL_TEXT, RESERVED_PURPOSE, RETIREMENT_WINDOW_MS, RefusalReason, ReleaseRequest, ReleaseResponse, RequestSignature, ResultDisposition, ResultProvenance, ResultRequest, ResultResponse, RunMetadata, SIZE_CLASSES, SIZE_CLASS_LIMITS, SUCCESSION_CONTEXT, SUPPORTED_PROTOCOL_VERSIONS, SealedOutcome, type SignatureFailure, SignedGrant, SizeClass, type SpendConsent, type StopReason, StopReasonSchema, StoredKeys, Succession, type SuccessionFailure, type SuccessionWalk, TERMINAL_STATES, UPDATE_OFFER_SINCE, UPGRADE_COMMAND, type VersionRefusal, WireError, WireErrorCode, WithheldKind, backendDescriptor, backendName, canTransition, canonicalRequest, checkDaemonFloor, checkProtocolVersion, classifyCost, compareVersions, declaredVersion, describeBytes, effectiveOfferScope, envelopeBytes, grantStatement, isBackendId, isCloudTaggedModel, isJobKind, isLocalHost, isTerminal, kindsOf, matchAudience, mayOfferUpdate, mentionsWireField, mustsVerifiedBy, payloadTextLength, provenanceFor, resolveCost, routingOf, signGrant, signRequest, signSiteRequest, signSuccession, singlePurposeManifest, sizeClassCeiling, sizeClassOf, successionStatement, tooLargeMessage, updateOfferFor, verifyGrant, verifyLink, verifyRequest, verifySiteRequest, walkSuccession, withoutComments };
+export { ABOUT, ABOUT_SHORT, ABOUT_SHORT_LEDE, ABOUT_SHORT_TAIL, AGENT_PROMPTS, AGENT_PROMPTS_HEADING, AGENT_PROMPTS_LEDE, AUDIENCES, type AgentPrompt, type AgentPromptAudience, Audience, BACKENDS, BACKEND_CLASSES, BACKEND_IDS, BackendClass, BackendCost, type BackendDescriptor, type BackendId, BackendIdSchema, CLOCK_ATTRIBUTION_MS, CLOCK_SKEW_WARN_MS, Capability, CapabilityMatrix, ChatMessage, ChatPayload, ClaimRequest, ClaimResponse, ClaimedJob, ClaimedStub, DEFAULT_ROUTING, DeliveredResult, ENDPOINTS, ERROR_STATUS, type Endpoint, type FenceClause, FetchRequest, FetchResponse, type FloorRefusal, GRANT_CONTEXT, GRANT_MAX_AGE_MS, GRANT_SIGNED_FIELDS, GeneratePayload, type GrantClaims, GrantRef, type GrantRefusal, HUB_FENCE, HUB_FENCE_CLAUSES, HeartbeatRequest, HeartbeatResponse, JOB_KINDS, JobKind, JobOutcome, JobPayload, JobRefused, JobResultCanceled, JobResultError, JobResultOk, JobState, JobStub, KindedPayload, Lease, MAX_CLOCK_SKEW_MS, MAX_ENVELOPE_BYTES, MAX_PURPOSES, MAX_SUCCESSION_CHAIN, MIN_PROTOCOL_VERSION, MUSTS, MUST_IDS, Manifest, type MatchDaemon, type MatchJob, MatchRefusal, type MatchResult, type Must, type MustEnforcer, type MustId, type MustVerification, type MustVerifiedBy, NOT_YET, NOT_YET_LEDE, NOT_YET_TAIL, type NotYet, OFFER_SCOPES, OfferScope, PAYLOAD_LIMITS, PROTOCOL_PREFIX, PROTOCOL_VERSION, PairPollRequest, PairPollResponse, PairRequest, PairStartRequest, PairStartResponse, type PayloadFor, PublicIdentity, Purpose, PurposeRouting, REFUSAL_MESSAGES, REFUSAL_TEXT, RESERVED_PURPOSE, RETIREMENT_WINDOW_MS, RefusalReason, ReleaseRequest, ReleaseResponse, RequestSignature, ResultDisposition, ResultProvenance, ResultRequest, ResultResponse, RunMetadata, SIZE_CLASSES, SIZE_CLASS_LIMITS, SUCCESSION_CONTEXT, SUPPORTED_PROTOCOL_VERSIONS, SealedOutcome, type SignatureFailure, SignedGrant, SizeClass, type SpendConsent, type StopReason, StopReasonSchema, StoredKeys, Succession, type SuccessionFailure, type SuccessionWalk, TERMINAL_STATES, UPDATE_OFFER_SINCE, UPGRADE_COMMAND, type VersionRefusal, WireError, WireErrorCode, WithheldKind, backendDescriptor, backendName, canTransition, canonicalRequest, checkDaemonFloor, checkProtocolVersion, classifyCost, compareVersions, declaredVersion, describeBytes, effectiveOfferScope, envelopeBytes, grantStatement, isBackendId, isCloudTaggedModel, isJobKind, isLocalHost, isTerminal, kindsOf, matchAudience, mayOfferUpdate, mentionsWireField, mustsVerifiedBy, notYetLine, notYetSentence, payloadTextLength, provenanceFor, resolveCost, routingOf, signGrant, signRequest, signSiteRequest, signSuccession, singlePurposeManifest, sizeClassCeiling, sizeClassOf, successionStatement, tooLargeMessage, updateOfferFor, verifyGrant, verifyLink, verifyRequest, verifySiteRequest, walkSuccession, withoutComments };

package/dist/index.js

@@ -22,18 +22,29 @@ import {
 } from "./chunk-J3HTAGMX.js";
 
 // src/hub-fence.ts
-var HUB_FENCE = "byollm.cloud sees only what routing and metering need: which devices and sites are connected, each job's kind, size, and outcome, and timestamps. Never prompts, never answers, never credentials.";
+var HUB_FENCE = "byollm.cloud sees who asked, which devices and sites are connected, which device did each job, and each job's kind, size, outcome and time. Never prompts, never answers, never credentials.";
 var HUB_FENCE_CLAUSES = Object.freeze([
   {
-    says: "which devices and sites are connected",
-    covers: Object.freeze(["owner_id", "site_id", "member_id"])
+    says: "who asked",
+    covers: Object.freeze(["owner_id", "member_id"])
   },
+  /*
+   * The pair row's device owner — the hub's one row per (requester, device
+   * owner), #4058's shape (c). Ruled into "devices and sites"; the clause runs
+   * on through "which device did each job" because that is the phrase the
+   * column makes true, and a clause that stopped short would map the column
+   * to words that do not mention it.
+   */
   {
-    says: "each job's kind, size, and outcome",
+    says: "which devices and sites are connected, which device did each job",
+    covers: Object.freeze(["site_id", "served_by_owner_id"])
+  },
+  {
+    says: "each job's kind, size, outcome",
     covers: Object.freeze(["kind", "size_class", "disposition", "bytes"])
   },
   {
-    says: "and timestamps",
+    says: "and time",
     covers: Object.freeze(["at", "month", "updated_at"])
   },
   /*
@@ -2157,6 +2168,59 @@ var ABOUT_SHORT_TAIL = "Sites can charge you less because you bring your own \u2
 var ABOUT_SHORT = `${ABOUT_SHORT_LEDE}
 
 ${ABOUT_SHORT_TAIL}`;
+var AGENT_PROMPTS_HEADING = "You already have an AI. Hand it this.";
+var AGENT_PROMPTS_LEDE = "Paste the prompt into whatever you use \u2014 Claude, ChatGPT, Codex, Cursor, a local model \u2014 and it does the setup, stopping where a step needs you.";
+var AGENT_PROMPTS = [
+  {
+    "id": "computer",
+    "title": "Set up my computer",
+    "audience": "user",
+    "prompt": "Set up BYOLLM on my computer so websites I approve can use the AI I already\nhave. Some steps need me at the keyboard: tell me exactly what to type, then\nwait. First I open Terminal (Mac) or PowerShell (Windows). Run\n`node --version`; if it fails or is below 22.14, I install the LTS version\nof Node.js \u2014 the free program BYOLLM runs on \u2014 from https://nodejs.org and\nreopen the window. Then run `npm install -g byollm@latest`. Then I run\n`byollm setup` myself, because it asks questions: it finds what I have\n(Ollama, MLX or llama.cpp here, or my Claude Pro/Max or Codex sign-in \u2014\nsubscriptions stay mine, never shared) and pairs with byollm.cloud. When it\nprints a pairing code and fingerprint, STOP: I approve it at\nhttps://dashboard.byollm.cloud/devices and check the fingerprint matches.\nThen run `byollm status` and `byollm services`, fix anything they name, and\n`byollm start` if it is not running. Finish by having me press Connect at\nhttps://test.byollm.cloud. Reference:\nhttps://docs.byollm.cloud/#what-is-byollm and\nhttps://docs.byollm.cloud/#keep-daemon-running. Don't guess commands:\n`byollm --help` is the authority."
+  },
+  {
+    "id": "site",
+    "title": "Add BYOLLM to my site",
+    "audience": "developer",
+    "prompt": 'Add BYOLLM to this project so my users bring their own AI. Install\n`@byollm/server`, generate site keys once with\n`npx --package @byollm/server keygen` and put them in env (never in the\nrepo), mount the handler at `/byollm` (not under `/api` \u2014 the daemon pairs\nwith an origin), and add one `enqueue` with a timeout and a no-runner path \u2014\nnever a bare await. Then register the site at https://dashboard.byollm.cloud\nand add the Connect button exactly as https://docs.byollm.cloud/#embed says:\nthe iframe gets `site`, `state` and `return`, the page posts\n`{ byollm: "hello" }` first, and the return page posts\n`{ byollm: "connected" }` and closes. Job states and why an answer stopped:\nhttps://docs.byollm.cloud/#job-states and\nhttps://docs.byollm.cloud/#stop-reason. Test against\nhttps://test.byollm.cloud\'s flow before you tell me it works. STOP and ask\nme for anything that needs my dashboard login.'
+  },
+  {
+    "id": "relay",
+    "title": "Run my own relay",
+    "audience": "operator",
+    "prompt": "Stand up my own BYOLLM relay instead of byollm.cloud. Use `@byollm/relay`\nand `@byollm/control-plane` from npm \u2014 one replica on the built-in memory\nstore, or give the relay a shared `RoutingStore` to run more \u2014 and prove it\nwith `@byollm/conformance`\n(`npx --package @byollm/conformance byollm-certify <target>`) before\npointing any daemon at it: a server is byollm-compatible when the kit\npasses. Then pair a daemon with `byollm connect <my relay origin>`. The\nrelay never sees prompts (https://docs.byollm.cloud/#what-we-see) and that\nmust stay true in my deployment. Reference:\nhttps://github.com/oftomorrowinc/byollm#packages. STOP and ask me before\nanything that costs money or opens a port to the internet."
+  }
+];
+
+// src/not-yet.ts
+var and = (items) => items.length < 2 ? items.join("") : `${items.slice(0, -1).join(", ")} and ${items.slice(-1).join("")}`;
+function notYetFor(kinds) {
+  return Object.freeze([
+    { what: "tool use" },
+    { what: "access to your local files" },
+    { what: "streaming", detail: "a result comes back whole" },
+    {
+      what: `job kinds beyond ${and(kinds)}`,
+      detail: "no embeddings or images yet"
+    },
+    {
+      what: "jobs while your device is offline",
+      detail: "your device has to be online for your jobs to run"
+    }
+  ]);
+}
+var NOT_YET = notYetFor(JobKind.options);
+var NOT_YET_LEDE = "Things we know are limiting right now:";
+var NOT_YET_TAIL = "We have plans for every one of these, and we are building in public.";
+function notYetSentence(list = NOT_YET) {
+  const items = list.map(
+    ({ what, detail }) => `no ${what}${detail ? ` (${detail})` : ""}`
+  );
+  return `${NOT_YET_LEDE} ${and(items)}. ${NOT_YET_TAIL}`;
+}
+function notYetLine({ what, detail }) {
+  const head = what.charAt(0).toUpperCase() + what.slice(1);
+  return detail ? `${head} \u2014 ${detail}` : head;
+}
 
 // src/signing.ts
 import { createHash as createHash2 } from "crypto";
@@ -2729,6 +2793,9 @@ export {
   ABOUT_SHORT,
   ABOUT_SHORT_LEDE,
   ABOUT_SHORT_TAIL,
+  AGENT_PROMPTS,
+  AGENT_PROMPTS_HEADING,
+  AGENT_PROMPTS_LEDE,
   AUDIENCES,
   Audience,
   BACKENDS,
@@ -2795,6 +2862,9 @@ export {
   MUST_IDS,
   Manifest,
   MatchRefusal,
+  NOT_YET,
+  NOT_YET_LEDE,
+  NOT_YET_TAIL,
   OFFER_SCOPES,
   OfferScope,
   PAYLOAD_LIMITS,
@@ -2874,6 +2944,8 @@ export {
   mayOfferUpdate,
   mentionsWireField,
   mustsVerifiedBy,
+  notYetLine,
+  notYetSentence,
   open,
   payloadTextLength,
   provenanceFor,