--- read_when: - Aggiornamento degli schemi del protocollo o della generazione del codice summary: Schemi TypeBox come unica fonte di verità per il protocollo Gateway title: TypeBox x-i18n: generated_at: "2026-05-11T20:27:52Z" model: gpt-5.5 provider: openai source_hash: ecc9a69ac6d4ac101a4a6f34e44acfbe952dce0f90d178d4f8559191fb92c3b4 source_path: concepts/typebox.md workflow: 16 --- TypeBox è una libreria di schemi pensata prima di tutto per TypeScript. La usiamo per definire il **protocollo WebSocket del Gateway** (handshake, richiesta/risposta, eventi server). Questi schemi guidano la **validazione runtime**, l’**esportazione JSON Schema** e la **generazione di codice Swift** per l’app macOS. Un’unica fonte di verità; tutto il resto viene generato. Se vuoi il contesto del protocollo a un livello più alto, inizia da [Architettura del Gateway](/it/concepts/architecture). ## Modello mentale (30 secondi) Ogni messaggio WS del Gateway è uno di tre frame: - **Richiesta**: `{ type: "req", id, method, params }` - **Risposta**: `{ type: "res", id, ok, payload | error }` - **Evento**: `{ type: "event", event, payload, seq?, stateVersion? }` Il primo frame **deve** essere una richiesta `connect`. Dopo, i client possono chiamare metodi (ad es. `health`, `send`, `chat.send`) e sottoscrivere eventi (ad es. `presence`, `tick`, `agent`). Flusso di connessione (minimo): ``` Client Gateway |---- req:connect -------->| |<---- res:hello-ok --------| |<---- event:tick ----------| |---- req:health ---------->| |<---- res:health ----------| ``` Metodi + eventi comuni: | Categoria | Esempi | Note | | ---------- | --------------------------------------------------------- | ----------------------------------------- | | Core | `connect`, `health`, `status` | `connect` deve essere il primo | | Messaggistica | `send`, `agent`, `agent.wait`, `system-event`, `logs.tail` | gli effetti collaterali richiedono `idempotencyKey` | | Chat | `chat.history`, `chat.send`, `chat.abort` | WebChat usa questi | | Sessioni | `sessions.list`, `sessions.patch`, `sessions.delete` | amministrazione delle sessioni | | Automazione | `wake`, `cron.list`, `cron.run`, `cron.runs` | controllo di wake + cron | | Nodi | `node.list`, `node.invoke`, `node.pair.*` | WS del Gateway + azioni nodo | | Eventi | `tick`, `presence`, `agent`, `chat`, `health`, `shutdown` | push del server | L’inventario autorevole di **discovery** pubblicizzato si trova in `src/gateway/server-methods-list.ts` (`listGatewayMethods`, `GATEWAY_EVENTS`). ## Dove si trovano gli schemi - Sorgente: `src/gateway/protocol/schema.ts` - Validator runtime (AJV): `src/gateway/protocol/index.ts` - Registro pubblicizzato di funzionalità/discovery: `src/gateway/server-methods-list.ts` - Handshake server + dispatch dei metodi: `src/gateway/server.impl.ts` - Client Node: `src/gateway/client.ts` - JSON Schema generato: `dist/protocol.schema.json` - Modelli Swift generati: `apps/macos/Sources/OpenClawProtocol/GatewayModels.swift` ## Pipeline attuale - `pnpm protocol:gen` - scrive JSON Schema (draft-07) in `dist/protocol.schema.json` - `pnpm protocol:gen:swift` - genera i modelli Swift del gateway - `pnpm protocol:check` - esegue entrambi i generatori e verifica che l’output sia stato committato ## Come gli schemi vengono usati a runtime - **Lato server**: ogni frame in ingresso viene validato con AJV. L’handshake accetta solo una richiesta `connect` i cui parametri corrispondono a `ConnectParams`. - **Lato client**: il client JS valida i frame di evento e risposta prima di usarli. - **Discovery delle funzionalità**: il Gateway invia un elenco conservativo `features.methods` e `features.events` in `hello-ok` da `listGatewayMethods()` e `GATEWAY_EVENTS`. - Questo elenco di discovery non è un dump generato di ogni helper chiamabile in `coreGatewayHandlers`; alcuni RPC helper sono implementati in `src/gateway/server-methods/*.ts` senza essere enumerati nell’elenco delle funzionalità pubblicizzato. ## Frame di esempio Connect (primo messaggio): ```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" } } } ``` Risposta hello-ok: ```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 } } } ``` Richiesta + risposta: ```json { "type": "req", "id": "r1", "method": "health" } ``` ```json { "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } } ``` Evento: ```json { "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 } ``` ## Client minimo (Node.js) Flusso utile più piccolo: 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(); } }); ``` ## Esempio completo: aggiungere un metodo end-to-end Esempio: aggiungere una nuova richiesta `system.echo` che restituisce `{ ok: true, text }`. 1. **Schema (fonte di verità)** Aggiungi a `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 }, ); ``` Aggiungi entrambi a `ProtocolSchemas` ed esporta i tipi: ```ts SystemEchoParams: SystemEchoParamsSchema, SystemEchoResult: SystemEchoResultSchema, ``` ```ts export type SystemEchoParams = Static; export type SystemEchoResult = Static; ``` 2. **Validazione** In `src/gateway/protocol/index.ts`, esporta un validator AJV: ```ts export const validateSystemEchoParams = ajv.compile(SystemEchoParamsSchema); ``` 3. **Comportamento server** Aggiungi un handler 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 }); }, }; ``` Registralo in `src/gateway/server-methods.ts` (unisce già `systemHandlers`), poi aggiungi `"system.echo"` all’input di `listGatewayMethods` in `src/gateway/server-methods-list.ts`. Se il metodo è chiamabile dai client operatore o nodo, classificalo anche in `src/gateway/method-scopes.ts` in modo che l’applicazione degli scope e la pubblicizzazione delle funzionalità di `hello-ok` restino allineate. 4. **Rigenera** ```bash pnpm protocol:check ``` 5. **Test + documentazione** Aggiungi un test server in `src/gateway/server.*.test.ts` e annota il metodo nella documentazione. ## Comportamento della generazione di codice Swift Il generatore Swift emette: - enum `GatewayFrame` con casi `req`, `res`, `event` e `unknown` - struct/enum di payload fortemente tipizzati - valori `ErrorCode`, `GATEWAY_PROTOCOL_VERSION` e `GATEWAY_MIN_PROTOCOL_VERSION` I tipi di frame sconosciuti vengono preservati come payload grezzi per la compatibilità in avanti. ## Versionamento + compatibilità - `PROTOCOL_VERSION` si trova in `src/gateway/protocol/version.ts`. - I client inviano `minProtocol` + `maxProtocol`; il server rifiuta intervalli che non includono il suo protocollo corrente. - I modelli Swift mantengono i tipi di frame sconosciuti per evitare di rompere i client più vecchi. ## Pattern e convenzioni degli schemi - La maggior parte degli oggetti usa `additionalProperties: false` per payload rigorosi. - `NonEmptyString` è l’impostazione predefinita per ID e nomi di metodi/eventi. - Il `GatewayFrame` di livello superiore usa un **discriminator** su `type`. - I metodi con effetti collaterali di solito richiedono un `idempotencyKey` nei parametri (esempio: `send`, `poll`, `agent`, `chat.send`). - `agent` accetta `internalEvents` opzionali per il contesto di orchestrazione generato a runtime (per esempio handoff del completamento di attività subagent/cron); trattalo come superficie API interna. ## JSON dello schema live Il JSON Schema generato è nel repository in `dist/protocol.schema.json`. Il file raw pubblicato è in genere disponibile a: - [https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json](https://raw.githubusercontent.com/openclaw/openclaw/main/dist/protocol.schema.json) ## Quando modifichi gli schemi 1. Aggiorna gli schemi TypeBox. 2. Registra il metodo/evento in `src/gateway/server-methods-list.ts`. 3. Aggiorna `src/gateway/method-scopes.ts` quando il nuovo RPC richiede una classificazione dello scope operatore o nodo. 4. Esegui `pnpm protocol:check`. 5. Committa lo schema rigenerato + i modelli Swift. ## Correlati - [Protocollo rich output](/it/reference/rich-output-protocol) - [Adattatori RPC](/it/reference/rpc)