TypeBox

TypeBox, TypeScript öncelikli bir şema kütüphanesidir. Bunu Gateway WebSocket protokolünü (el sıkışma, istek/yanıt, sunucu olayları) tanımlamak için kullanıyoruz. Bu şemalar, macOS uygulaması için çalışma zamanı doğrulamasını, JSON Schema dışa aktarımını ve Swift kod üretimini yönlendirir. Tek doğruluk kaynağı; geri kalan her şey üretilir.

Daha üst düzey protokol bağlamını istiyorsanız Gateway mimarisi ile başlayın.

Zihinsel model (30 saniye)

Her Gateway WS iletisi üç çerçeveden biridir:

• İstek: { type: "req", id, method, params }
• Yanıt: { type: "res", id, ok, payload | error }
• Olay: { type: "event", event, payload, seq?, stateVersion? }

İlk çerçeve mutlaka bir connect isteği olmalıdır. Bundan sonra istemciler yöntemleri çağırabilir (örn. health, send, chat.send) ve olaylara abone olabilir (örn. presence, tick, agent).

Bağlantı akışı (en az):

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

Yaygın yöntemler + olaylar:

Yetkili olarak duyurulan keşif envanteri src/gateway/server-methods-list.ts içinde yaşar (listGatewayMethods, GATEWAY_EVENTS).

Şemaların bulunduğu yer

• Kaynak: src/gateway/protocol/schema.ts
• Çalışma zamanı doğrulayıcıları (AJV): src/gateway/protocol/index.ts
• Duyurulan özellik/keşif kayıt defteri: src/gateway/server-methods-list.ts
• Sunucu el sıkışması + yöntem dağıtımı: src/gateway/server.impl.ts
• Node istemcisi: src/gateway/client.ts
• Üretilmiş JSON Schema: dist/protocol.schema.json
• Üretilmiş Swift modelleri: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Mevcut işlem hattı

• pnpm protocol:gen
  • JSON Schema'yı (draft-07) dist/protocol.schema.json konumuna yazar
• pnpm protocol:gen:swift
  • Swift gateway modellerini üretir
• pnpm protocol:check
  • iki üreteci de çalıştırır ve çıktının commit edildiğini doğrular

Şemaların çalışma zamanında nasıl kullanıldığı

• Sunucu tarafı: gelen her çerçeve AJV ile doğrulanır. El sıkışma yalnızca parametreleri ConnectParams ile eşleşen bir connect isteğini kabul eder.
• İstemci tarafı: JS istemcisi olay ve yanıt çerçevelerini kullanmadan önce doğrular.
• Özellik keşfi: Gateway, listGatewayMethods() ve GATEWAY_EVENTS üzerinden hello-ok içinde korumacı bir features.methods ve features.events listesi gönderir.
• Bu keşif listesi, coreGatewayHandlers içindeki çağrılabilir her yardımcının üretilmiş bir dökümü değildir; bazı yardımcı RPC'ler, duyurulan özellik listesinde numaralandırılmadan src/gateway/server-methods/*.ts içinde uygulanır.

Örnek çerçeveler

Bağlanma (ilk ileti):

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

Hello-ok yanıtı:

{  "type": "res",  "id": "c1",  "ok": true,  "payload": {    "type": "hello-ok",    "protocol": 4,    "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 }  }}

İstek + yanıt:

{ "type": "req", "id": "r1", "method": "health" }

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

Olay:

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

En küçük istemci (Node.js)

En küçük kullanışlı akış: bağlanma + sağlık denetimi.

 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: 4,        maxProtocol: 4,        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();  }});

Çalışılmış örnek: bir yöntemi uçtan uca ekleme

Örnek: { ok: true, text } döndüren yeni bir system.echo isteği ekleyin.

1. Şema (doğruluk kaynağı)

src/gateway/protocol/schema.ts dosyasına ekleyin:

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

İkisini de ProtocolSchemas içine ekleyin ve türleri dışa aktarın:

  SystemEchoParams: SystemEchoParamsSchema,  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;

2. Doğrulama

src/gateway/protocol/index.ts içinde bir AJV doğrulayıcısı dışa aktarın:

export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);

3. Sunucu davranışı

src/gateway/server-methods/system.ts içinde bir işleyici ekleyin:

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

Bunu src/gateway/server-methods.ts içinde kaydedin (zaten systemHandlers ile birleştirir), ardından src/gateway/server-methods-list.ts içindeki listGatewayMethods girdisine "system.echo" ekleyin.

Yöntem operatör veya node istemcileri tarafından çağrılabiliyorsa, kapsam zorlaması ve hello-ok özellik duyurusu hizalı kalsın diye bunu ayrıca src/gateway/method-scopes.ts içinde sınıflandırın.

4. Yeniden üretme

pnpm protocol:check

5. Testler + belgeler

src/gateway/server.*.test.ts içinde bir sunucu testi ekleyin ve yöntemi belgelerde not edin.

Swift kod üretimi davranışı

Swift üreteci şunları yayar:

• req, res, event ve unknown durumlarına sahip GatewayFrame enum'u
• Güçlü türlendirilmiş payload struct'ları/enum'ları
• ErrorCode değerleri, GATEWAY_PROTOCOL_VERSION ve GATEWAY_MIN_PROTOCOL_VERSION

Bilinmeyen çerçeve türleri, ileriye dönük uyumluluk için ham payload'lar olarak korunur.

Sürümleme + uyumluluk

• PROTOCOL_VERSION, src/gateway/protocol/version.ts içinde yaşar.
• İstemciler minProtocol + maxProtocol gönderir; sunucu, mevcut protokolünü içermeyen aralıkları reddeder.
• Swift modelleri, eski istemcileri bozmamak için bilinmeyen çerçeve türlerini korur.

Şema kalıpları ve kuralları

• Çoğu nesne, sıkı payload'lar için additionalProperties: false kullanır.
• NonEmptyString, kimlikler ve yöntem/olay adları için varsayılandır.
• Üst düzey GatewayFrame, type üzerinde bir ayrıştırıcı kullanır.
• Yan etkileri olan yöntemler genellikle parametrelerde bir idempotencyKey gerektirir (örnek: send, poll, agent, chat.send).
• agent, çalışma zamanında üretilen orkestrasyon bağlamı için isteğe bağlı internalEvents kabul eder (örneğin alt ajan/cron görevi tamamlanma devri); bunu dahili API yüzeyi olarak ele alın.

Canlı şema JSON'u

Üretilmiş JSON Schema depoda dist/protocol.schema.json konumundadır. Yayımlanan ham dosya genellikle şurada bulunur:

• https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json

Şemaları değiştirdiğinizde

1. TypeBox şemalarını güncelleyin.
2. Yöntemi/olayı src/gateway/server-methods-list.ts içinde kaydedin.
3. Yeni RPC operatör veya node kapsam sınıflandırmasına ihtiyaç duyduğunda src/gateway/method-scopes.ts dosyasını güncelleyin.
4. pnpm protocol:check çalıştırın.
5. Yeniden üretilmiş şemayı + Swift modellerini commit edin.

İlgili

• Zengin çıktı protokolü
• RPC bağdaştırıcıları