--- read_when: - Protocolschema's of codegeneratie bijwerken summary: TypeBox-schema's als de enige bron van waarheid voor het Gateway-protocol title: TypeBox x-i18n: generated_at: "2026-05-11T20:28:54Z" model: gpt-5.5 provider: openai source_hash: ecc9a69ac6d4ac101a4a6f34e44acfbe952dce0f90d178d4f8559191fb92c3b4 source_path: concepts/typebox.md workflow: 16 --- TypeBox is een TypeScript-first schemabibliotheek. We gebruiken deze om het **Gateway WebSocket-protocol** te definiëren (handshake, request/response, serverevents). Die schema's sturen **runtimevalidatie**, **JSON Schema-export** en **Swift-codegen** 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](/nl/concepts/architecture). ## Mentaal model (30 seconden) Elk Gateway WS-bericht is een van drie frames: - **Request**: `{ type: "req", id, method, params }` - **Response**: `{ type: "res", id, ok, payload | error }` - **Event**: `{ type: "event", event, payload, seq?, stateVersion? }` Het eerste frame **moet** een `connect`-request zijn. Daarna kunnen clients methoden aanroepen (bijv. `health`, `send`, `chat.send`) en zich abonneren op events (bijv. `presence`, `tick`, `agent`). Verbindingsstroom (minimaal): ``` Client Gateway |---- req:connect -------->| |<---- res:hello-ok --------| |<---- event:tick ----------| |---- req:health ---------->| |<---- res:health ----------| ``` Veelvoorkomende methoden + events: | Categorie | Voorbeelden | Opmerkingen | | ---------- | ---------------------------------------------------------- | ---------------------------------- | | Kern | `connect`, `health`, `status` | `connect` moet eerst komen | | Berichten | `send`, `agent`, `agent.wait`, `system-event`, `logs.tail` | side-effects hebben `idempotencyKey` nodig | | Chat | `chat.history`, `chat.send`, `chat.abort` | WebChat gebruikt deze | | Sessies | `sessions.list`, `sessions.patch`, `sessions.delete` | sessiebeheer | | Automatisering | `wake`, `cron.list`, `cron.run`, `cron.runs` | wake + cron-besturing | | Nodes | `node.list`, `node.invoke`, `node.pair.*` | Gateway WS + node-acties | | Events | `tick`, `presence`, `agent`, `chat`, `health`, `shutdown` | server push | De gezaghebbende geadverteerde **discovery**-inventaris staat in `src/gateway/server-methods-list.ts` (`listGatewayMethods`, `GATEWAY_EVENTS`). ## Waar de schema's staan - Bron: `src/gateway/protocol/schema.ts` - Runtimevalidators (AJV): `src/gateway/protocol/index.ts` - Geadverteerd feature-/discovery-register: `src/gateway/server-methods-list.ts` - Serverhandshake + methodedispatch: `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 pipeline - `pnpm protocol:gen` - schrijft JSON Schema (draft-07) naar `dist/protocol.schema.json` - `pnpm protocol:gen:swift` - genereert Swift Gateway-modellen - `pnpm protocol:check` - voert beide generators uit en verifieert dat de output is gecommit ## Hoe de schema's tijdens runtime worden gebruikt - **Serverzijde**: elk inkomend frame wordt gevalideerd met AJV. De handshake accepteert alleen een `connect`-request waarvan de params overeenkomen met `ConnectParams`. - **Clientzijde**: de JS-client valideert event- en response-frames voordat deze worden gebruikt. - **Feature discovery**: de Gateway stuurt een conservatieve `features.methods`- en `features.events`-lijst 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): ```json { "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-response: ```json { "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 } } } ``` Request + response: ```json { "type": "req", "id": "r1", "method": "health" } ``` ```json { "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } } ``` Event: ```json { "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 } ``` ## Minimale client (Node.js) Kleinste bruikbare stroom: connect + health. ```ts 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: 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 nieuw `system.echo`-request toe dat `{ ok: true, text }` retourneert. 1. **Schema (bron van waarheid)** Voeg toe aan `src/gateway/protocol/schema.ts`: ```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 types: ```ts SystemEchoParams: SystemEchoParamsSchema, SystemEchoResult: SystemEchoResultSchema, ``` ```ts export type SystemEchoParams = Static; export type SystemEchoResult = Static; ``` 2. **Validatie** Exporteer in `src/gateway/protocol/index.ts` een AJV-validator: ```ts export const validateSystemEchoParams = ajv.compile(SystemEchoParamsSchema); ``` 3. **Servergedrag** Voeg een handler toe in `src/gateway/server-methods/system.ts`: ```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 vervolgens `"system.echo"` toe aan de input 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`-feature-advertising op elkaar afgestemd blijven. 4. **Opnieuw genereren** ```bash 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-codegen De Swift-generator emitteert: - `GatewayFrame`-enum met `req`-, `res`-, `event`- en `unknown`-cases - Sterk getypeerde payload-structs/enums - `ErrorCode`-waarden, `GATEWAY_PROTOCOL_VERSION` en `GATEWAY_MIN_PROTOCOL_VERSION` Onbekende frametypen blijven behouden als ruwe payloads voor voorwaartse compatibiliteit. ## Versionering + compatibiliteit - `PROTOCOL_VERSION` staat in `src/gateway/protocol/version.ts`. - Clients sturen `minProtocol` + `maxProtocol`; de server weigert bereiken die het huidige protocol niet bevatten. - De Swift-modellen behouden onbekende frametypen om te voorkomen dat oudere clients breken. ## Schemapatronen en conventies - De meeste objecten gebruiken `additionalProperties: false` voor strikte payloads. - `NonEmptyString` is de standaard voor ID's en methode-/eventnamen. - De top-level `GatewayFrame` gebruikt een **discriminator** op `type`. - Methoden met side-effects vereisen meestal een `idempotencyKey` in params (voorbeeld: `send`, `poll`, `agent`, `chat.send`). - `agent` accepteert optionele `internalEvents` voor runtime-gegenereerde orchestration-context (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 meestal beschikbaar op: - [https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json](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/het event 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](/nl/reference/rich-output-protocol) - [RPC-adapters](/nl/reference/rpc)