TypeBox als Protokoll-Wahrheitsquelle

Letzte Aktualisierung: 2026-01-10

TypeBox ist eine TypeScript-First-Schema-Bibliothek. Wir nutzen sie, um das Gateway-WebSocket-Protokoll zu definieren (Handshake, Request/Response, Server-Events). Diese Schemas treiben Laufzeit-Validierung, JSON-Schema-Export und Swift-Codegen fuer die macOS-App an. Eine Wahrheitsquelle; alles andere wird generiert.

Fuer den uebergeordneten Protokollkontext starte mit Gateway-Architektur.

Mentales Modell (30 Sekunden)

Jede Gateway-WS-Nachricht ist eine von drei Frame-Arten:

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

Der erste Frame muss ein connect-Request sein. Danach koennen Clients Methoden aufrufen (z.B. health, send, chat.send) und Events abonnieren (z.B. presence, tick, agent).

Verbindungsablauf (minimal):

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

Gaengige Methoden + Events:

Die autoritative Liste lebt in src/gateway/server.ts (METHODS, EVENTS).

Wo die Schemas leben

• Quelle: src/gateway/protocol/schema.ts
• Laufzeit-Validatoren (AJV): src/gateway/protocol/index.ts
• Server-Handshake + Methoden-Dispatch: src/gateway/server.ts
• Node-Client: src/gateway/client.ts
• Generiertes JSON-Schema: dist/protocol.schema.json
• Generierte Swift-Modelle: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Aktuelle Pipeline

• pnpm protocol:gen
  • schreibt JSON-Schema (draft-07) nach dist/protocol.schema.json
• pnpm protocol:gen:swift
  • generiert Swift-Gateway-Modelle
• pnpm protocol:check
  • fuehrt beide Generatoren aus und prueft, ob der Output eingecheckt ist

Wie die Schemas zur Laufzeit genutzt werden

• Serverseitig: jeder eingehende Frame wird mit AJV validiert. Der Handshake akzeptiert nur einen connect-Request, dessen Params ConnectParams matchen.
• Clientseitig: der JS-Client validiert Event- und Response-Frames, bevor er sie nutzt.
• Methoden-Oberflaeche: das Gateway listet die unterstuetzten methods und events in hello-ok auf.

Beispiel-Frames

Connect (erste Nachricht):

{
  "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-Response:

{
  "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 }
  }
}

Request + Response:

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

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

Event:

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

Minimaler Client (Node.js)

Kleinster nuetzlicher Flow: 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();
  }
});

Praxisbeispiel: eine Methode End-to-End hinzufuegen

Beispiel: eine neue system.echo-Methode hinzufuegen, die { ok: true, text } zurueckgibt.

1. Schema (Wahrheitsquelle)

In src/gateway/protocol/schema.ts hinzufuegen:

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

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

Beide zu ProtocolSchemas hinzufuegen und Typen exportieren:

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

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

2. Validierung

In src/gateway/protocol/index.ts einen AJV-Validator exportieren:

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

3. Server-Verhalten

Handler in src/gateway/server-methods/system.ts hinzufuegen:

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

In src/gateway/server-methods.ts registrieren (merged bereits systemHandlers), dann "system.echo" zu METHODS in src/gateway/server.ts hinzufuegen.

4. Regenerieren

pnpm protocol:check

5. Tests + Docs

Einen Server-Test in src/gateway/server.*.test.ts hinzufuegen und die Methode in den Docs dokumentieren.

Swift-Codegen-Verhalten

Der Swift-Generator erzeugt:

• GatewayFrame-Enum mit req, res, event und unknown-Cases
• Stark typisierte Payload-Structs/Enums
• ErrorCode-Werte und GATEWAY_PROTOCOL_VERSION

Unbekannte Frame-Typen werden als rohe Payloads beibehalten, um Vorwaertskompatibilitaet zu gewaehrleisten.

Versionierung + Kompatibilitaet

• PROTOCOL_VERSION lebt in src/gateway/protocol/schema.ts.
• Clients senden minProtocol + maxProtocol; der Server lehnt Mismatches ab.
• Die Swift-Modelle behalten unbekannte Frame-Typen bei, um aeltere Clients nicht zu brechen.

Schema-Patterns und Konventionen

• Die meisten Objekte nutzen additionalProperties: false fuer strikte Payloads.
• NonEmptyString ist der Standard fuer IDs und Methoden-/Event-Namen.
• Der Top-Level-GatewayFrame nutzt einen Discriminator auf type.
• Methoden mit Seiteneffekten erfordern in der Regel einen idempotencyKey in den Params (Beispiel: send, poll, agent, chat.send).
• agent akzeptiert optionale internalEvents fuer runtime-generierten Orchestrierungskontext (zum Beispiel Subagent/Cron-Task-Completion-Handoff); behandle das als interne API-Oberflaeche.

Live-Schema-JSON

Das generierte JSON-Schema liegt im Repo unter dist/protocol.schema.json. Die veroeffentlichte Rohdatei ist typischerweise verfuegbar unter:

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

Wenn du Schemas aenderst

1. Die TypeBox-Schemas aktualisieren.
2. pnpm protocol:check ausfuehren.
3. Das regenerierte Schema + die Swift-Modelle committen.