@byok-sdk/protocol

中文文档
0.40.0发布于 2026/11/08MITTypeScriptES Module近 30 天下载 4.7万

BYOK SDK wire protocol: envelope schema, message types, and codec helpers

原始使用文档

@byok-sdk/protocol

The frozen v1 BYOK device wire contract: envelope schemas, message payloads, codecs, version negotiation, and golden fixtures.

provider-profile-binding is an additive v1 capability for exact device-local BYOK routing. Its byok-profile selection contains only profileRef, canonical decimal profileRevision, SHA-256 profileHash, modelId, and bounded requiredCapabilities. Endpoint, auth configuration, and credential material remain outside the protocol.

An Agent offer's dispatchSelection is the optional strict dual-lane target contract: subscription selects Claude/Codex + model, while BYOK selects Pi + provider + model. When present it is authoritative and runtime disagreement fails closed. Servers send it only to a daemon advertising the dispatch-selection capability, preventing an older v1 peer from stripping the additive field and silently executing a runtime-only offer.

import { encodeEnvelope, decodeEnvelope } from '@byok-sdk/protocol';

MIT licensed. Node.js 24.22.1 or newer.

Runtime dependencies and size budgets: entry dependency contract.

版本与发布记录

@byok-sdk/protocol 共发布 63 个版本,首次发布于 2026/08/09;过去 12 个月发布了 63 个版本。

版本发布日期距今
0.40.0latest2026/11/08今天
0.39.02026/11/072 天前
0.38.02026/11/054 天前
0.37.02026/11/044 天前
0.36.02026/11/035 天前
0.35.02026/11/026 天前

其他发布通道:beta → 0.8.0-beta.0,rc → 0.27.0-rc.2。

关于 @byok-sdk/protocol 的常见问题

@byok-sdk/protocol 是什么?

BYOK SDK wire protocol: envelope schema, message types, and codec helpers

如何安装 @byok-sdk/protocol?

在项目目录运行 npm install @byok-sdk/protocol,或使用 pnpm add / yarn add / bun add。

@byok-sdk/protocol 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@byok-sdk/protocol 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@byok-sdk/protocol 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.22.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@byok-sdk/protocol 可以商用吗?

@byok-sdk/protocol 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@byok-sdk/protocol 的下载量有多少?

根据 npm 官方下载统计,@byok-sdk/protocol 在 2026/10/09 – 2026/11/07 这 30 天内被下载 47,451 次,日均约 1,582 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@byok-sdk/protocol 还在维护吗?

最新版本 0.40.0 发布于 2026/11/08(今天);至今共发布 63 个版本,其中过去 12 个月发布了 63 个;首次发布于 2026/08/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。