koishi-plugin-dynamic-bot 0.0.0-dev

package/AGENTS.md

@@ -0,0 +1,6 @@
+# koishi/
+
+Koishi **Plugin**：执行 DBK，调用已有 `ctx.bots`。不要实现 `Adapter` / `Bot` 去反向连接 dynamic-bot。
+只做生成类型 ↔ `h()` / `session`。不要解析命令、不要 `session.send` 业务回复、不要在这里保存平台 Token 或 OneBot 连接（仍归 Koishi Adapter 配置，含 `adapter-onebot`）。
+`bot.status`：`ONLINE` → `READY`，`CONNECT`/`RECONNECT` → `CONNECTING`，其余 → `UNAVAILABLE`。不要用 `isActive`。
+`targets.list` 在无嵌套 `channel.list` 的 bot 上可以不完整（典型 Telegram），必须设置 incomplete。

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "koishi-plugin-dynamic-bot",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/incubator4/dynamic-bot-koishi"
+  },
+  "version": "0.0.0-dev",
+  "license": "Apache-2.0",
+  "contributors": [
+    "AresWang <incubator4@outlook.com>"
+  ],
+  "description": "dynamic-bot Koishi gateway (DBK)",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "peerDependencies": {
+    "koishi": "^4.18.7"
+  },
+  "dependencies": {
+    "@bufbuild/protobuf": "^2.12.1"
+  },
+  "koishi": {
+    "description": {
+      "zh": "将 Koishi 已连接账号作为 dynamic-bot 的消息出口",
+      "en": "Expose connected Koishi bots as a dynamic-bot message gateway"
+    },
+    "service": {
+      "required": [
+        "server",
+        "http"
+      ]
+    }
+  }
+}

package/src/dbk/avatar.ts

@@ -0,0 +1,58 @@
+const AVATAR_KEYS = [
+  "avatar",
+  "avatarUrl",
+  "avatar_url",
+  "icon",
+  "iconUrl",
+  "icon_url",
+  "photoUrl",
+  "photo_url",
+] as const;
+
+/** First non-empty avatar URI among Satori/Koishi-shaped objects. */
+export function pickAvatar(...sources: unknown[]): string {
+  for (const source of sources) {
+    const value = avatarFrom(source);
+    if (value) return value;
+  }
+  return "";
+}
+
+function avatarFrom(source: unknown): string {
+  if (typeof source === "string") return sanitize(source);
+  if (!source || typeof source !== "object") return "";
+  const rec = source as Record<string, unknown>;
+  const nested = rec.user && typeof rec.user === "object"
+    ? rec.user as Record<string, unknown>
+    : undefined;
+  for (const obj of [nested, rec]) {
+    if (!obj) continue;
+    for (const key of AVATAR_KEYS) {
+      const value = sanitize(obj[key]);
+      if (value) return value;
+    }
+  }
+  return photoUri(rec.photo);
+}
+
+function photoUri(photo: unknown): string {
+  if (typeof photo === "string") return sanitize(photo);
+  if (!photo || typeof photo !== "object") return "";
+  const rec = photo as Record<string, unknown>;
+  for (const key of ["url", "big", "small", "src"] as const) {
+    const value = sanitize(rec[key]);
+    if (value) return value;
+  }
+  return "";
+}
+
+function sanitize(value: unknown): string {
+  if (typeof value !== "string") return "";
+  const trimmed = value.trim();
+  if (!trimmed) return "";
+  // Telegram file_id is a token without a URI scheme or path; skip it.
+  if (!/^(https?:|data:|file:|\/\/)/i.test(trimmed) && !trimmed.includes("/")) {
+    return "";
+  }
+  return trimmed;
+}

package/src/dbk/bots.ts

@@ -0,0 +1,261 @@
+import { create } from "@bufbuild/protobuf";
+import type { Bot, Context } from "koishi";
+import { BotStatus, TargetKind } from "../gen/dbk/v1/common_pb";
+import { BotSchema, type Bot as DbkBot } from "../gen/dbk/v1/rpc_pb";
+
+/** Koishi/Satori `Status`: OFFLINE=0 ONLINE=1 CONNECT=2 DISCONNECT=3 RECONNECT=4 */
+const KOISHI_STATUS_ONLINE = 1;
+const KOISHI_STATUS_CONNECT = 2;
+const KOISHI_STATUS_RECONNECT = 4;
+
+const SATORI_MESSAGE_DELETE = "message.delete";
+const SATORI_GUILD_LIST = "guild.list";
+const SATORI_CHANNEL_LIST = "channel.list";
+const SATORI_GUILD_GET = "guild.get";
+const SATORI_CHANNEL_GET = "channel.get";
+const SATORI_FRIEND_LIST = "friend.list";
+const SATORI_USER_GET = "user.get";
+const SATORI_USER_CHANNEL_CREATE = "user.channel.create";
+
+export const BotFeature = {
+  MESSAGE_RECALL: "message.recall",
+  MESSAGE_FORWARD: "message.forward",
+  MENTION_ALL: "mention.all",
+  TARGETS_LIST: "targets.list",
+  TARGET_USER: "target.user",
+  TARGET_GROUP: "target.group",
+  TARGET_CHANNEL: "target.channel",
+  TARGET_THREAD: "target.thread",
+} as const;
+
+const TARGET_KIND_FEATURES: ReadonlyArray<readonly [TargetKind, string]> = [
+  [TargetKind.USER, BotFeature.TARGET_USER],
+  [TargetKind.GROUP, BotFeature.TARGET_GROUP],
+  [TargetKind.CHANNEL, BotFeature.TARGET_CHANNEL],
+  [TargetKind.THREAD, BotFeature.TARGET_THREAD],
+];
+
+const THREAD_METHODS = [
+  "getThreadList",
+  "listActiveThreads",
+  "listPublicArchivedThreads",
+  "listPrivateArchivedThreads",
+  "startThread",
+  "startThreadFromMessage",
+  "startThreadWithoutMessage",
+  "createThread",
+] as const;
+
+/** Native merged-forward APIs (OneBot / NapCat style). Discord thread-forwards do not count. */
+const MERGED_FORWARD_METHODS = [
+  "send_group_forward_msg",
+  "send_private_forward_msg",
+  "send_forward_msg",
+  "upload_forward_msg",
+  "sendGroupForwardMsg",
+  "sendPrivateForwardMsg",
+  "sendForwardMsg",
+  "uploadForwardMsg",
+  "sendGroupForwardMessage",
+  "sendPrivateForwardMessage",
+  "sendForwardMessage",
+  "sendMergeForward",
+  "send_merge_forward",
+] as const;
+
+export function listBots(ctx: Pick<Context, "bots">): DbkBot[] {
+  return ctx.bots.filter((bot) => !bot.hidden).map(toDbkBot);
+}
+
+export function toDbkBot(bot: Bot): DbkBot {
+  const platform = bot.platform ?? "";
+  const selfId = bot.selfId ?? "";
+  return create(BotSchema, {
+    botKey: platform && selfId ? `${platform}:${selfId}` : "",
+    platform,
+    selfId,
+    name: bot.user?.name || bot.user?.nick || "",
+    avatar: bot.user?.avatar || "",
+    status: toDbkBotStatus(bot.status),
+    features: botFeatures(bot),
+  });
+}
+
+export function toDbkBotStatus(status: number): BotStatus {
+  switch (status) {
+    case KOISHI_STATUS_ONLINE:
+      return BotStatus.READY;
+    case KOISHI_STATUS_CONNECT:
+    case KOISHI_STATUS_RECONNECT:
+      return BotStatus.CONNECTING;
+    default:
+      return BotStatus.UNAVAILABLE;
+  }
+}
+
+export function botFeatures(bot: Bot): string[] {
+  const features: string[] = [];
+  if (canRecall(bot)) features.push(BotFeature.MESSAGE_RECALL);
+  if (canMergedForward(bot)) features.push(BotFeature.MESSAGE_FORWARD);
+  if (canMentionAll(bot)) features.push(BotFeature.MENTION_ALL);
+  if (canListTargets(bot)) features.push(BotFeature.TARGETS_LIST);
+  for (const kind of botTargetKinds(bot)) {
+    const feature = targetKindFeature(kind);
+    if (feature) features.push(feature);
+  }
+  return features;
+}
+
+export function botTargetKinds(bot: Bot): TargetKind[] {
+  const kinds: TargetKind[] = [];
+  const nested = hasNestedChannels(bot);
+  const guilds = hasGuildSurface(bot);
+  if (canDirectMessage(bot)) kinds.push(TargetKind.USER);
+  if (nested) {
+    kinds.push(TargetKind.CHANNEL);
+    kinds.push(TargetKind.THREAD);
+  } else if (guilds) {
+    kinds.push(TargetKind.GROUP);
+    kinds.push(TargetKind.CHANNEL);
+  }
+  if (hasThreadSurface(bot) && !kinds.includes(TargetKind.THREAD)) {
+    kinds.push(TargetKind.THREAD);
+  }
+  return kinds;
+}
+
+export function targetKindFeature(kind: TargetKind): string | undefined {
+  return TARGET_KIND_FEATURES.find(([value]) => value === kind)?.[1];
+}
+
+/** Nested `channel.list` under a guild: Discord/KOOK-style servers, not sendable GROUP. */
+export function hasNestedChannels(bot: Bot): boolean {
+  return hasBotMethod(bot, "getChannelList") || satoriFeatures(bot).includes(SATORI_CHANNEL_LIST);
+}
+
+/** Guild/chat list or get, including flat adapters where the guild is the sendable target. */
+export function hasGuildSurface(bot: Bot): boolean {
+  return (
+    hasBotMethod(bot, "getGuildList")
+    || hasBotMethod(bot, "getGuild")
+    || satoriFeatures(bot).includes(SATORI_GUILD_LIST)
+    || satoriFeatures(bot).includes(SATORI_GUILD_GET)
+  );
+}
+
+export function canListDirectUsers(bot: Bot): boolean {
+  return (
+    hasBotMethod(bot, "getFriendList")
+    || hasBotMethod(bot, "getUserList")
+    || satoriFeatures(bot).includes(SATORI_FRIEND_LIST)
+  );
+}
+
+function canDirectMessage(bot: Bot): boolean {
+  return (
+    canListDirectUsers(bot)
+    || hasBotMethod(bot, "getUser")
+    || hasBotMethod(bot, "createDirectChannel")
+    || satoriFeatures(bot).includes(SATORI_USER_GET)
+    || satoriFeatures(bot).includes(SATORI_USER_CHANNEL_CREATE)
+    || looksDirectMessageOnly(bot)
+  );
+}
+
+function hasThreadSurface(bot: Bot): boolean {
+  if (THREAD_METHODS.some((name) => hasBotMethod(bot, name) || hasInternalMethod(bot, name))) {
+    return true;
+  }
+  return satoriFeatures(bot).some((feature) => feature.includes("thread"));
+}
+
+function canRecall(bot: Bot): boolean {
+  return hasBotMethod(bot, "deleteMessage") || satoriFeatures(bot).includes(SATORI_MESSAGE_DELETE);
+}
+
+function canListTargets(bot: Bot): boolean {
+  return (
+    hasBotMethod(bot, "getGuildList")
+    || hasBotMethod(bot, "getChannelList")
+    || hasBotMethod(bot, "getGuild")
+    || hasBotMethod(bot, "getChannel")
+    || satoriFeatures(bot).some((feature) => (
+      feature === SATORI_GUILD_LIST
+      || feature === SATORI_CHANNEL_LIST
+      || feature === SATORI_GUILD_GET
+      || feature === SATORI_CHANNEL_GET
+    ))
+  );
+}
+
+function canMentionAll(bot: Bot): boolean {
+  if (encoderHandlesMentionAll(bot)) return true;
+  if (hasGuildOrChannelSurface(bot)) return true;
+  // Unsure and not a group-looking adapter: still declare unless it looks DM-only.
+  return !looksDirectMessageOnly(bot);
+}
+
+function canMergedForward(bot: Bot): boolean {
+  return MERGED_FORWARD_METHODS.some((name) => hasBotMethod(bot, name) || hasInternalMethod(bot, name));
+}
+
+function hasGuildOrChannelSurface(bot: Bot): boolean {
+  return canListTargets(bot)
+    || hasBotMethod(bot, "getGuildMember")
+    || hasBotMethod(bot, "getGuildMemberList");
+}
+
+function looksDirectMessageOnly(bot: Bot): boolean {
+  if (hasGuildOrChannelSurface(bot)) return false;
+  const Encoder = messageEncoder(bot);
+  if (Encoder && !encoderHandlesMentionAll(bot)) {
+    // Encoder exists, cannot at-all, and there is no guild/channel API.
+    return true;
+  }
+  return false;
+}
+
+function encoderHandlesMentionAll(bot: Bot): boolean {
+  const visit = messageEncoder(bot)?.prototype?.visit;
+  if (typeof visit !== "function") return false;
+  try {
+    const src = Function.prototype.toString.call(visit);
+    return /type\s*===\s*['"]all['"]/.test(src)
+      || /['"]all['"]\s*===\s*(?:attrs\.)?type/.test(src)
+      || /id\s*===\s*['"]all['"]/.test(src)
+      || /['"]all['"]\s*===\s*(?:attrs\.)?id/.test(src)
+      || /@everyone/.test(src)
+      || /atall/i.test(src);
+  } catch {
+    return false;
+  }
+}
+
+function messageEncoder(bot: Bot): { prototype?: { visit?: unknown } } | undefined {
+  return (bot.constructor as { MessageEncoder?: { prototype?: { visit?: unknown } } }).MessageEncoder;
+}
+
+function satoriFeatures(bot: Bot): string[] {
+  const features = (bot as Bot & { features?: unknown }).features;
+  if (!Array.isArray(features)) return [];
+  return features.filter((item): item is string => typeof item === "string");
+}
+
+function hasInternalMethod(bot: Bot, name: string): boolean {
+  return hasBotMethod((bot as Bot & { internal?: object }).internal, name);
+}
+
+function hasBotMethod(target: object | null | undefined, name: string): boolean {
+  if (!target) return false;
+  const value = (target as Record<string, unknown>)[name];
+  return typeof value === "function" && !looksUnimplemented(value);
+}
+
+function looksUnimplemented(fn: Function): boolean {
+  try {
+    const src = Function.prototype.toString.call(fn);
+    return /not implemented|NotImplementedError/i.test(src);
+  } catch {
+    return false;
+  }
+}

package/src/dbk/codec.ts

@@ -0,0 +1,55 @@
+import { create, fromBinary, fromJsonString, toBinary, toJsonString, type DescMessage, type MessageShape } from "@bufbuild/protobuf";
+import { ErrorCode } from "../gen/dbk/v1/common_pb";
+import { FrameSchema, type Frame } from "../gen/dbk/v1/frame_pb";
+import { DbkRpcError } from "./error";
+import type { DbkEncoding } from "./protocol";
+
+export function encodeFrame(frame: Frame, encoding: DbkEncoding): Uint8Array | string {
+  if (encoding === "json") {
+    return toJsonString(FrameSchema, frame);
+  }
+  return toBinary(FrameSchema, frame);
+}
+
+export function decodeFrame(data: Uint8Array | string, encoding: DbkEncoding): Frame {
+  if (encoding === "json") {
+    const text = typeof data === "string" ? data : new TextDecoder().decode(data);
+    return fromJsonString(FrameSchema, text);
+  }
+  if (typeof data === "string") {
+    throw new DbkRpcError(ErrorCode.PROTOCOL, "DBK only accepts protobuf binary frames");
+  }
+  return fromBinary(FrameSchema, data);
+}
+
+export function encodePayload<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>): Uint8Array {
+  return toBinary(schema, message);
+}
+
+export function decodePayload<Desc extends DescMessage>(schema: Desc, bytes: Uint8Array): MessageShape<Desc> {
+  return fromBinary(schema, bytes);
+}
+
+export function createFrame(init: Parameters<typeof create<typeof FrameSchema>>[1]): Frame {
+  return create(FrameSchema, init);
+}
+
+export function toBytes(data: unknown): Uint8Array {
+  if (data instanceof Uint8Array) return data;
+  if (data instanceof ArrayBuffer) return new Uint8Array(data);
+  if (ArrayBuffer.isView(data)) {
+    return new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
+  }
+  if (Array.isArray(data)) {
+    const chunks = data.map((part) => toBytes(part));
+    const total = chunks.reduce((sum, chunk) => sum + chunk.byteLength, 0);
+    const out = new Uint8Array(total);
+    let offset = 0;
+    for (const chunk of chunks) {
+      out.set(chunk, offset);
+      offset += chunk.byteLength;
+    }
+    return out;
+  }
+  throw new DbkRpcError(ErrorCode.PROTOCOL, "DBK frame is not binary");
+}

package/src/dbk/error.ts

@@ -0,0 +1,11 @@
+import { ErrorCode } from "../gen/dbk/v1/common_pb";
+
+export class DbkRpcError extends Error {
+  readonly code: ErrorCode;
+
+  constructor(code: ErrorCode, detail: string) {
+    super(detail);
+    this.name = "DbkRpcError";
+    this.code = code;
+  }
+}