@byok-sdk/protocol 0.26.1 → 0.27.0

package/dist/wire-additions.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The one table of receiver-capability gates and wire additions
+ * (docs/protocol.md "Freeze rule").
+ *
+ * A v3 change takes exactly one of three paths: a version bump, a gated
+ * addition, or a strip-safe addition. Envelope and HTTP rows have explicit
+ * kinds. The last two are declared here.
+ *
+ * - `gated`: the sender must not emit the surface unless the receiver
+ *   durably advertised `capability`. A field entry applies when the payload
+ *   carries the field (and, with `value`, when the field equals it); a type
+ *   entry applies to every message of that type. Server-to-daemon surfaces
+ *   are gated by a device flag, daemon-to-server surfaces by a server flag.
+ * - `strip-safe`: an optional field an older receiver drops without changing
+ *   what it executes or acknowledges.
+ *
+ * v3 baseline: every v3 decoder reads every surface v2 had, so the v2
+ * strip-safe rows and the v2 `result-document` gate are gone. The device
+ * gates kept below name capabilities a daemon advertises only when it is
+ * configured for them (Agent home, egress, input preparation, provisioning,
+ * memory intents and so on): they gate on the receiver's configuration. The
+ * server-advertised `approval_resolved` gate is kept as the daemon's sending
+ * condition for `task.approval_resolved`. No v3 release has been
+ * published, so no row is proven against a published v3 decoder yet
+ * (`src/__tests__/compat.test.ts`).
+ *
+ * Senders derive their admission flags from {@link requiredReceiverCapabilities}
+ * and nowhere else, so a gate cannot exist in one place and be missing in
+ * another. This module imports no runtime code (types only) so it stays free
+ * of zod.
+ */
+import type { MessageType } from './messages';
+import type { CapabilityFlag } from './version';
+type HttpWireSurface = 'ChallengeRequest' | 'ChallengeResponse' | 'TokenRequest' | 'TokenResponse' | 'EventsPollQuery' | 'EventsPollResponse' | 'MessagesSendRequest' | 'MessagesSendResponse';
+export type WireAddition = {
+    readonly kind: 'envelope';
+    readonly rule: 'gated';
+    readonly surface: MessageType;
+    readonly field?: string;
+    readonly value?: string;
+    readonly capability: CapabilityFlag;
+    readonly advertisedBy: 'device' | 'server';
+} | {
+    readonly kind: 'envelope';
+    readonly rule: 'strip-safe';
+    readonly surface: MessageType;
+    readonly field: string;
+} | {
+    readonly kind: 'http';
+    readonly rule: 'strip-safe';
+    readonly surface: HttpWireSurface;
+    readonly field: string;
+};
+export declare const WIRE_ADDITIONS: readonly WireAddition[];
+/**
+ * Every capability the receiver must have durably advertised before a sender
+ * may emit this message. Deduplicated, in table order. A sender refuses (before
+ * creating the task or appending to the mailbox) when any is missing.
+ */
+export declare function requiredReceiverCapabilities(type: MessageType, payload: unknown): CapabilityFlag[];
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byok-sdk/protocol",
-  "version": "0.26.1",
+  "version": "0.27.0",
   "description": "BYOK SDK wire protocol: envelope schema, message types, and codec helpers",
   "type": "module",
   "license": "MIT",
@@ -26,9 +26,9 @@
       "import": "./dist/index.js"
     },
     "./package.json": "./package.json",
-    "./input-preparation-version": {
-      "types": "./dist/input-preparation-version.d.ts",
-      "import": "./dist/input-preparation-version.js"
+    "./constants": {
+      "types": "./dist/constants.d.ts",
+      "import": "./dist/constants.js"
     }
   },
   "files": [
@@ -48,6 +48,10 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
+    "@cfworker/json-schema": "4.1.1",
     "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "byok-protocol-previous": "https://registry.npmjs.org/@byok-sdk/protocol/-/protocol-0.26.1.tgz"
   }
 }

package/dist/input-preparation-version.d.ts

@@ -1,12 +0,0 @@
-/**
- * The ONE version of the input-preparation contract, shared by this relay wire
- * (the `agent.input.preparation` payload and the completion receipt summary)
- * and by the device-local request, receipt and artifact
- * (`@byok-sdk/client`'s `INPUT_PREPARATION_VERSION`, which is this value).
- *
- * The relay wire carries no version field of its own, so a version change is
- * made visible where admission actually happens: in the capability token
- * below. See `INPUT_PREPARATION_VERSION` in the client for what each version
- * changed.
- */
-export declare const INPUT_PREPARATION_WIRE_VERSION: 9;

package/dist/input-preparation-version.js

@@ -1,6 +0,0 @@
-// src/input-preparation-version.ts
-var INPUT_PREPARATION_WIRE_VERSION = 9;
-
-export { INPUT_PREPARATION_WIRE_VERSION };
-//# sourceMappingURL=input-preparation-version.js.map
-//# sourceMappingURL=input-preparation-version.js.map

package/dist/input-preparation-version.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/input-preparation-version.ts"],"names":[],"mappings":";AAWO,IAAM,8BAAA,GAAiC","file":"input-preparation-version.js","sourcesContent":["/**\n * The ONE version of the input-preparation contract, shared by this relay wire\n * (the `agent.input.preparation` payload and the completion receipt summary)\n * and by the device-local request, receipt and artifact\n * (`@byok-sdk/client`'s `INPUT_PREPARATION_VERSION`, which is this value).\n *\n * The relay wire carries no version field of its own, so a version change is\n * made visible where admission actually happens: in the capability token\n * below. See `INPUT_PREPARATION_VERSION` in the client for what each version\n * changed.\n */\nexport const INPUT_PREPARATION_WIRE_VERSION = 9 as const;\n"]}