TypeBox

TypeBox is een schema-bibliotheek met TypeScript als uitgangspunt. We gebruiken deze om het Gateway WebSocket-protocol te definiëren (handshake, aanvraag/antwoord, servergebeurtenissen). Die schema's sturen runtimevalidatie, JSON Schema-export en Swift-codegeneratie voor de macOS-app aan. Eén bron van waarheid; al het andere wordt gegenereerd.

Als je de protocolcontext op hoger niveau wilt, begin dan met Gateway-architectuur.

Mentaal model (30 seconden)

Elk Gateway-WS-bericht is een van drie frames:

• Aanvraag: { type: "req", id, method, params }
• Antwoord: { type: "res", id, ok, payload | error }
• Gebeurtenis: { type: "event", event, payload, seq?, stateVersion? }

Het eerste frame moet een connect-aanvraag zijn. Daarna kunnen clients methoden aanroepen (bijv. health, send, chat.send) en zich abonneren op gebeurtenissen (bijv. presence, tick, agent).

Verbindingsstroom (minimaal):

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

Veelgebruikte methoden + gebeurtenissen:

De gezaghebbende geadverteerde discovery-inventaris staat in src/gateway/server-methods-list.ts (listGatewayMethods, GATEWAY_EVENTS).

Waar de schema's staan

• Bron: packages/gateway-protocol/src/schema.ts
• Runtimevalidators (AJV): packages/gateway-protocol/src/index.ts
• Geadverteerd feature-/discovery-register: src/gateway/server-methods-list.ts
• Serverhandshake + methode-dispatch: src/gateway/server.impl.ts
• Node-client: src/gateway/client.ts
• Gegenereerd JSON Schema: dist/protocol.schema.json
• Gegenereerde Swift-modellen: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

Huidige pijplijn

• pnpm protocol:gen
  • schrijft JSON Schema (draft-07) naar dist/protocol.schema.json
• pnpm protocol:gen:swift
  • genereert Swift-gatewaymodellen
• pnpm protocol:check
  • voert beide generatoren uit en controleert of de uitvoer is gecommit

Hoe de schema's tijdens runtime worden gebruikt

• Serverzijde: elk inkomend frame wordt gevalideerd met AJV. De handshake accepteert alleen een connect-aanvraag waarvan de parameters overeenkomen met ConnectParams.
• Clientzijde: de JS-client valideert gebeurtenis- en antwoordframes voordat ze worden gebruikt.
• Feature discovery: de Gateway stuurt een conservatieve lijst met features.methods en features.events in hello-ok vanuit listGatewayMethods() en GATEWAY_EVENTS.
• Die discovery-lijst is geen gegenereerde dump van elke aanroepbare helper in coreGatewayHandlers; sommige helper-RPC's zijn geïmplementeerd in src/gateway/server-methods/*.ts zonder te worden opgesomd in de geadverteerde featurelijst.

Voorbeeldframes

Connect (eerste bericht):

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

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

Aanvraag + antwoord:

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

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

Gebeurtenis:

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

Minimale client (Node.js)

Kleinste nuttige stroom: verbinden + health.

 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();  }});

Uitgewerkt voorbeeld: voeg een methode end-to-end toe

Voorbeeld: voeg een nieuwe system.echo-aanvraag toe die { ok: true, text } retourneert.

1. Schema (bron van waarheid)

Voeg toe aan packages/gateway-protocol/src/schema.ts:

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

Voeg beide toe aan ProtocolSchemas en exporteer typen:

  SystemEchoParams: SystemEchoParamsSchema,  SystemEchoResult: SystemEchoResultSchema,

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

2. Validatie

Exporteer in packages/gateway-protocol/src/index.ts een AJV-validator:

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

3. Servergedrag

Voeg een handler toe in src/gateway/server-methods/system.ts:

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

Registreer deze in src/gateway/server-methods.ts (voegt systemHandlers al samen), en voeg daarna "system.echo" toe aan de invoer van listGatewayMethods in src/gateway/server-methods-list.ts.

Als de methode aanroepbaar is door operator- of node-clients, classificeer deze dan ook in src/gateway/method-scopes.ts zodat scopehandhaving en hello-ok-featureadvertising op elkaar afgestemd blijven.

4. Opnieuw genereren

pnpm protocol:check

5. Tests + docs

Voeg een servertest toe in src/gateway/server.*.test.ts en vermeld de methode in de docs.

Gedrag van Swift-codegeneratie

De Swift-generator maakt:

• GatewayFrame-enum met req-, res-, event- en unknown-gevallen
• Sterk getypeerde payload-structs/enums
• ErrorCode-waarden, GATEWAY_PROTOCOL_VERSION en GATEWAY_MIN_PROTOCOL_VERSION

Onbekende frametypen worden behouden als ruwe payloads voor voorwaartse compatibiliteit.

Versiebeheer + compatibiliteit

• PROTOCOL_VERSION staat in packages/gateway-protocol/src/version.ts.
• Clients sturen minProtocol + maxProtocol; de server weigert bereiken die het huidige protocol niet bevatten.
• De Swift-modellen behouden onbekende frametypen om oudere clients niet te breken.

Schemapatronen en conventies

• De meeste objecten gebruiken additionalProperties: false voor strikte payloads.
• NonEmptyString is de standaard voor ID's en methode-/gebeurtenisnamen.
• Het hoogste niveau GatewayFrame gebruikt een discriminator op type.
• Methoden met neveneffecten vereisen meestal een idempotencyKey in params (voorbeeld: send, poll, agent, chat.send).
• agent accepteert optionele internalEvents voor runtimegegenereerde orkestratiecontext (bijvoorbeeld overdracht na voltooiing van subagent-/cron-taken); behandel dit als intern API-oppervlak.

Live schema-JSON

Gegenereerd JSON Schema staat in de repo op dist/protocol.schema.json. Het gepubliceerde raw-bestand is doorgaans beschikbaar op:

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

Wanneer je schema's wijzigt

1. Werk de TypeBox-schema's bij.
2. Registreer de methode/gebeurtenis in src/gateway/server-methods-list.ts.
3. Werk src/gateway/method-scopes.ts bij wanneer de nieuwe RPC operator- of node-scopeclassificatie nodig heeft.
4. Voer pnpm protocol:check uit.
5. Commit het opnieuw gegenereerde schema + de Swift-modellen.

Gerelateerd

• Rich output-protocol
• RPC-adapters