TypeBoxをプロトコルの唯一の真実のソースに

最終更新：2026-01-10

TypeBoxはTypeScriptファーストのスキーマライブラリです。Gateway WebSocketプロトコル（ハンドシェイク、リクエスト/レスポンス、サーバーイベント）の定義に使用しています。これらのスキーマがランタイムバリデーション、JSON Schemaエクスポート、macOSアプリ向けのSwiftコード生成を駆動します。真実のソースは1つだけ。あとはすべて生成されます。

上位レベルのプロトコルのコンテキストについては、Gatewayアーキテクチャから始めてください。

メンタルモデル（30秒で理解）

Gateway WSメッセージはすべて3種類のフレームのいずれかです：

  • Request：{ type: "req", id, method, params }
  • Response：{ type: "res", id, ok, payload | error }
  • Event：{ type: "event", event, payload, seq?, stateVersion? }

最初のフレームはconnectリクエストでなければなりません。その後、クライアントはメソッドの呼び出し（例：health、send、chat.send）やイベントの購読（例：presence、tick、agent）が可能です。

接続フロー（最小構成）：

Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|

主なメソッドとイベント：

カテゴリ例備考
Coreconnect, health, statusconnectが最初でなければならない
Messagingsend, poll, agent, agent.wait副作用のあるものはidempotencyKeyが必要
Chatchat.history, chat.send, chat.abort, chat.injectWebChatで使用
Sessionssessions.list, sessions.patch, sessions.deleteセッション管理
Nodesnode.list, node.invoke, node.pair.*Gateway WS＋ノードアクション
Eventstick, presence, agent, chat, health, shutdownサーバープッシュ

正式なリストはsrc/gateway/server.ts（METHODS、EVENTS）にあります。

スキーマの場所

  • ソース：src/gateway/protocol/schema.ts
  • ランタイムバリデータ（AJV）：src/gateway/protocol/index.ts
  • サーバーハンドシェイク＋メソッドディスパッチ：src/gateway/server.ts
  • ノードクライアント：src/gateway/client.ts
  • 生成されたJSON Schema：dist/protocol.schema.json
  • 生成されたSwiftモデル：apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

現在のパイプライン

  • pnpm protocol:gen
    • JSON Schema（draft-07）をdist/protocol.schema.jsonに出力
  • pnpm protocol:gen:swift
    • SwiftのGatewayモデルを生成
  • pnpm protocol:check
    • 両方のジェネレータを実行し、出力がコミットされているか検証

ランタイムでのスキーマ利用方法

  • サーバーサイド：受信フレームはすべてAJVでバリデーションされる。ハンドシェイクはConnectParamsにマッチするconnectリクエストのみを受け付ける。
  • クライアントサイド：JSクライアントがイベントフレームとレスポンスフレームを使用前にバリデーションする。
  • メソッドサーフェス：Gatewayはhello-okでサポートされるmethodsとeventsを通知する。

フレームの例

Connect（最初のメッセージ）：

{
  "type": "req",
  "id": "c1",
  "method": "connect",
  "params": {
    "minProtocol": 2,
    "maxProtocol": 2,
    "client": {
      "id": "openclaw-macos",
      "displayName": "macos",
      "version": "1.0.0",
      "platform": "macos 15.1",
      "mode": "ui",
      "instanceId": "A1B2"
    }
  }
}

Hello-okレスポンス：

{
  "type": "res",
  "id": "c1",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 2,
    "server": { "version": "dev", "connId": "ws-1" },
    "features": { "methods": ["health"], "events": ["tick"] },
    "snapshot": {
      "presence": [],
      "health": {},
      "stateVersion": { "presence": 0, "health": 0 },
      "uptimeMs": 0
    },
    "policy": { "maxPayload": 1048576, "maxBufferedBytes": 1048576, "tickIntervalMs": 30000 }
  }
}

リクエスト＋レスポンス：

{ "type": "req", "id": "r1", "method": "health" }
{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }

イベント：

{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

最小クライアント（Node.js）

最小限の実用フロー：connect + health。

import { WebSocket } from "ws";

const ws = new WebSocket("ws://127.0.0.1:18789");

ws.on("open", () => {
  ws.send(
    JSON.stringify({
      type: "req",
      id: "c1",
      method: "connect",
      params: {
        minProtocol: 3,
        maxProtocol: 3,
        client: {
          id: "cli",
          displayName: "example",
          version: "dev",
          platform: "node",
          mode: "cli",
        },
      },
    }),
  );
});

ws.on("message", (data) => {
  const msg = JSON.parse(String(data));
  if (msg.type === "res" && msg.id === "c1" && msg.ok) {
    ws.send(JSON.stringify({ type: "req", id: "h1", method: "health" }));
  }
  if (msg.type === "res" && msg.id === "h1") {
    console.log("health:", msg.payload);
    ws.close();
  }
});

実践例：メソッドをエンドツーエンドで追加する

例：{ ok: true, text }を返す新しいsystem.echoリクエストを追加する。

  1. スキーマ（真実のソース）

src/gateway/protocol/schema.tsに追加：

export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);

ProtocolSchemasに追加し、型をエクスポート：

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,
export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. バリデーション

src/gateway/protocol/index.tsでAJVバリデータをエクスポート：

export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. サーバー動作

src/gateway/server-methods/system.tsにハンドラを追加：

export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};

src/gateway/server-methods.tsに登録（すでにsystemHandlersをマージ済み）し、src/gateway/server.tsのMETHODSに"system.echo"を追加。

  1. 再生成
pnpm protocol:check
  1. テストとドキュメント

src/gateway/server.*.test.tsにサーバーテストを追加し、ドキュメントにメソッドを記載。

Swiftコード生成の動作

Swiftジェネレータは以下を出力します：

  • req、res、event、unknownケースを持つGatewayFrame列挙型
  • 厳密に型付けされたペイロード構造体/列挙型
  • ErrorCodeの値とGATEWAY_PROTOCOL_VERSION

前方互換性のため、未知のフレームタイプは生ペイロードとして保持されます。

バージョニングと互換性

  • PROTOCOL_VERSIONはsrc/gateway/protocol/schema.tsにある。
  • クライアントはminProtocol + maxProtocolを送信し、サーバーは不一致を拒否する。
  • Swiftモデルは古いクライアントを壊さないよう、未知のフレームタイプを保持する。

スキーマのパターンと規約

  • ほとんどのオブジェクトは厳密なペイロードのためにadditionalProperties: falseを使用。
  • IDやメソッド/イベント名のデフォルトはNonEmptyString。
  • トップレベルのGatewayFrameはtypeでディスクリミネーターを使用。
  • 副作用のあるメソッドは通常paramsにidempotencyKeyを必要とする（例：send、poll、agent、chat.send）。
  • agentはランタイム生成のオーケストレーションコンテキスト（例：サブエージェント/cronタスク完了ハンドオフ）のためにオプションのinternalEventsを受け付ける。内部APIサーフェスとして扱うこと。

ライブスキーマJSON

生成されたJSON Schemaはリポジトリのdist/protocol.schema.jsonにあります。公開されている生ファイルは通常以下で入手可能です：

スキーマを変更する場合

  1. TypeBoxスキーマを更新する。
  2. pnpm protocol:checkを実行する。
  3. 再生成されたスキーマとSwiftモデルをコミットする。
arrow_back
前へ
Date Time
次へ
Markdown Formatting
arrow_forward