TypeBox

​

Mentaal model (30 seconden)

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

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

​

Waar de schema’s zich bevinden

• Bronbarrel: packages/gateway-protocol/src/schema.ts exporteert domeinmodules onder packages/gateway-protocol/src/schema/*.ts opnieuw (frames.ts voor de enveloppen en handshake op het hoogste niveau, agent.ts, sessions.ts, cron.ts, enzovoort per functiegebied). protocol-schemas.ts is het centrale ProtocolSchemas-register dat schemanamen aan hun TypeBox-definities koppelt.
• Runtimevalidators (AJV): packages/gateway-protocol/src/index.ts
• Geïntroduceerd functie-/detectieregister: src/gateway/server-methods-list.ts
• Serverhandshake en methodedispatch: src/gateway/server.impl.ts
• Node-client: src/gateway/client.ts
• Gegenereerd JSON Schema: dist/protocol.schema.json (builduitvoer, niet gecommit)
• Gegenereerde Swift-modellen: apps/shared/OpenClawKit/Sources/OpenClawProtocol/GatewayModels.swift

​

Huidige pijplijn

• pnpm protocol:gen schrijft JSON Schema (draft-07) naar dist/protocol.schema.json.
• pnpm protocol:gen:swift genereert de Swift Gateway-modellen.
• pnpm protocol:check voert beide generatoren uit en verifieert dat de Swift-uitvoer is gecommit (de JSON Schema-uitvoer is een door Git genegeerd buildartefact).

​

Hoe de schema’s tijdens runtime worden gebruikt

• Serverzijde: elk binnenkomend frame wordt met AJV gevalideerd. De handshake accepteert alleen een connect-verzoek waarvan de parameters overeenkomen met ConnectParams.
• Clientzijde: de JS-client valideert gebeurtenis- en antwoordframes voordat deze worden gebruikt.
• Functiedetectie: de Gateway verzendt in hello-ok een conservatieve lijst met features.methods en features.events, afkomstig uit listGatewayMethods() en GATEWAY_EVENTS.
• Die detectielijst is geen gegenereerde dump van elke aanroepbare helper in coreGatewayHandlers; sommige helper-RPC’s zijn geïmplementeerd in src/gateway/server-methods/*.ts zonder dat ze in de geadverteerde functielijst zijn opgenomen.

​

Voorbeeldframes

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

{
  "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
    },
    "auth": { "role": "operator", "scopes": ["operator.read"] },
    "policy": { "maxPayload": 1048576, "maxBufferedBytes": 1048576, "tickIntervalMs": 30000 }
  }
}

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

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

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

​

Minimale client (Node.js)

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: een methode van begin tot eind toevoegen

1. Schema (gezaghebbende bron)

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

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

  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

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

2. Validatie

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

3. Servergedrag

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

4. Opnieuw genereren

pnpm protocol:check

5. Tests en documentatie

​

Gedrag van Swift-codegeneratie

• een GatewayFrame-enum met de cases req, res, event en unknown
• sterk getypeerde payloadstructs/-enums
• ErrorCode-waarden, GATEWAY_PROTOCOL_VERSION en GATEWAY_MIN_PROTOCOL_VERSION

​

Versiebeheer en compatibiliteit

• PROTOCOL_VERSION bevindt zich in packages/gateway-protocol/src/version.ts (huidige waarde: 4).
• Clients verzenden minProtocol en maxProtocol; de server weigert bereiken die het huidige protocol niet omvatten.
• De Swift-modellen behouden onbekende frametypen om te voorkomen dat oudere clients niet meer werken.

​

Schemapatronen en conventies

• De meeste objecten gebruiken additionalProperties: false voor strikte payloads.
• NonEmptyString (Type.String({ minLength: 1 })) is de standaard voor ID’s en namen van methoden/gebeurtenissen.
• De GatewayFrame op het hoogste niveau gebruikt een discriminator op type.
• Methoden met neveneffecten vereisen doorgaans een idempotencyKey in de parameters (voorbeeld: send, poll, agent, chat.send).
• agent accepteert een optionele internalEvents voor tijdens runtime gegenereerde orkestratiecontext (bijvoorbeeld overdracht na voltooiing van een subagent-/cron-taak); behandel dit als een intern API-oppervlak.

​

Live 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 in de verantwoordelijke packages/gateway-protocol/src/schema/*.ts-module en registreer ze in protocol-schemas.ts.
2. Registreer de methode/gebeurtenis in src/gateway/server-methods-list.ts.
3. Werk src/gateway/method-scopes.ts bij wanneer de nieuwe RPC een scopeclassificatie voor operators of nodes nodig heeft.
4. Voer pnpm protocol:check uit.
5. Commit de opnieuw gegenereerde Swift-modellen.

​

Gerelateerd

• Protocol voor rijke uitvoer
• RPC-adapters