الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

TypeBox هي مكتبة مخططات موجهة لـ TypeScript. نستخدمها لتعريف بروتوكول WebSocket الخاص بـ Gateway (المصافحة، الطلب/الاستجابة، أحداث الخادم). تقود هذه المخططات التحقق في وقت التشغيل، وتصدير JSON Schema، وتوليد كود Swift لتطبيق macOS. مصدر حقيقة واحد؛ وكل شيء آخر يتم توليده. إذا أردت سياق البروتوكول الأعلى مستوى، فابدأ بـ بنية Gateway.

​
النموذج الذهني (30 ثانية)

كل رسالة Gateway WS هي أحد ثلاثة إطارات:
  • طلب: { type: "req", id, method, params }
  • استجابة: { type: "res", id, ok, payload | error }
  • حدث: { type: "event", event, payload, seq?, stateVersion? }
يجب أن يكون الإطار الأول طلب connect. بعد ذلك، يمكن للعملاء استدعاء الطرق (مثل health، وsend، وchat.send) والاشتراك في الأحداث (مثل presence، وtick، وagent). تدفق الاتصال (الحد الأدنى): 
Client                    Gateway
  |---- req:connect -------->|
  |<---- res:hello-ok --------|
  |<---- event:tick ----------|
  |---- req:health ---------->|
  |<---- res:health ----------|
الطرق + الأحداث الشائعة:
الفئةأمثلةملاحظات
النواةconnect, health, statusيجب أن يكون connect أولًا
المراسلةsend, agent, agent.wait, system-event, logs.tailالآثار الجانبية تحتاج إلى idempotencyKey
الدردشةchat.history, chat.send, chat.abortيستخدم WebChat هذه
الجلساتsessions.list, sessions.patch, sessions.deleteإدارة الجلسات
الأتمتةwake, cron.list, cron.run, cron.runsالتحكم في wake + cron
العقدnode.list, node.invoke, node.pair.*Gateway WS + إجراءات العقد
الأحداثtick, presence, agent, chat, health, shutdownدفع الخادم
تعيش قائمة الاكتشاف المعلنة والموثوقة في src/gateway/server-methods-list.ts (listGatewayMethods, GATEWAY_EVENTS).

​
مكان وجود المخططات

  • المصدر: src/gateway/protocol/schema.ts
  • مدققات وقت التشغيل (AJV): src/gateway/protocol/index.ts
  • سجل الميزات/الاكتشاف المعلن: src/gateway/server-methods-list.ts
  • مصافحة الخادم + توجيه الطرق: src/gateway/server.impl.ts
  • عميل Node: src/gateway/client.ts
  • JSON Schema المولدة: dist/protocol.schema.json
  • نماذج Swift المولدة: apps/macos/Sources/OpenClawProtocol/GatewayModels.swift

​
المسار الحالي

  • pnpm protocol:gen
    • يكتب JSON Schema (draft-07) إلى dist/protocol.schema.json
  • pnpm protocol:gen:swift
    • يولد نماذج Swift الخاصة بـ Gateway
  • pnpm protocol:check
    • يشغل كلا المولدين ويتحقق من أن الناتج ملتزم به

​
كيف تُستخدم المخططات في وقت التشغيل

  • جانب الخادم: يتم التحقق من كل إطار وارد باستخدام AJV. لا تقبل المصافحة إلا طلب connect تطابق معاملاته ConnectParams.
  • جانب العميل: يتحقق عميل JS من إطارات الأحداث والاستجابات قبل استخدامها.
  • اكتشاف الميزات: يرسل Gateway قائمة محافظة من features.methods وfeatures.events في hello-ok من listGatewayMethods() و GATEWAY_EVENTS.
  • قائمة الاكتشاف هذه ليست تفريغًا مولدًا لكل مساعد قابل للاستدعاء في coreGatewayHandlers؛ فبعض RPCs المساعدة منفذة في src/gateway/server-methods/*.ts دون تعدادها في قائمة الميزات المعلنة.

​
أمثلة على الإطارات

Connect (الرسالة الأولى): 
{
  "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: 
{
  "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 }
  }
}
طلب + استجابة: 
{ "type": "req", "id": "r1", "method": "health" }

{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }
حدث: 
{ "type": "event", "event": "tick", "payload": { "ts": 1730000000 }, "seq": 12 }

​
عميل بسيط (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();
  }
});

​
مثال عملي: إضافة طريقة من البداية إلى النهاية

مثال: أضف طلب system.echo جديدًا يعيد { ok: true, text }.
  1. المخطط (مصدر الحقيقة)
أضف إلى src/gateway/protocol/schema.ts: 
export const SystemEchoParamsSchema = Type.Object(
  { text: NonEmptyString },
  { additionalProperties: false },
);

export const SystemEchoResultSchema = Type.Object(
  { ok: Type.Boolean(), text: NonEmptyString },
  { additionalProperties: false },
);
أضف كليهما إلى ProtocolSchemas وصدّر الأنواع: 
  SystemEchoParams: SystemEchoParamsSchema,
  SystemEchoResult: SystemEchoResultSchema,

export type SystemEchoParams = Static<typeof SystemEchoParamsSchema>;
export type SystemEchoResult = Static<typeof SystemEchoResultSchema>;
  1. التحقق
في src/gateway/protocol/index.ts، صدّر مدقق AJV: 
export const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);
  1. سلوك الخادم
أضف معالجًا في src/gateway/server-methods/system.ts: 
export const systemHandlers: GatewayRequestHandlers = {
  "system.echo": ({ params, respond }) => {
    const text = String(params.text ?? "");
    respond(true, { ok: true, text });
  },
};
سجله في src/gateway/server-methods.ts (يدمج systemHandlers بالفعل)، ثم أضف "system.echo" إلى مُدخلات listGatewayMethods في src/gateway/server-methods-list.ts. إذا كانت الطريقة قابلة للاستدعاء من عملاء المشغل أو العقد، فصنفها أيضًا في src/gateway/method-scopes.ts حتى يظل فرض النطاق وإعلان ميزات hello-ok متوافقين.
  1. إعادة التوليد
pnpm protocol:check
  1. الاختبارات + التوثيق
أضف اختبار خادم في src/gateway/server.*.test.ts واذكر الطريقة في التوثيق.

​
سلوك توليد كود Swift

ينتج مولد Swift:
  • enum باسم GatewayFrame مع حالات req وres وevent وunknown
  • structs/enums للحمولات مكتوبة الأنواع بقوة
  • قيم ErrorCode وGATEWAY_PROTOCOL_VERSION وGATEWAY_MIN_PROTOCOL_VERSION
تُحفظ أنواع الإطارات غير المعروفة كحمولات خام للتوافق المستقبلي.

​
الإصدارات + التوافق

  • يوجد PROTOCOL_VERSION في src/gateway/protocol/version.ts.
  • يرسل العملاء minProtocol + maxProtocol؛ يرفض الخادم النطاقات التي لا تتضمن بروتوكوله الحالي.
  • تحتفظ نماذج Swift بأنواع الإطارات غير المعروفة لتجنب كسر العملاء الأقدم.

​
أنماط المخططات والاصطلاحات

  • تستخدم معظم الكائنات additionalProperties: false للحمولات الصارمة.
  • NonEmptyString هو الافتراضي للمعرفات وأسماء الطرق/الأحداث.
  • يستخدم GatewayFrame في المستوى الأعلى مميزًا على type.
  • الطرق ذات الآثار الجانبية تتطلب عادة idempotencyKey في المعاملات (مثال: send، وpoll، وagent، وchat.send).
  • يقبل agent قيمة internalEvents اختيارية لسياق التنسيق المولد في وقت التشغيل (على سبيل المثال تسليم إكمال مهمة وكيل فرعي/cron)؛ تعامل مع هذا كسطح API داخلي.

​
JSON المخطط المباشر

توجد JSON Schema المولدة في المستودع عند dist/protocol.schema.json. يكون الملف الخام المنشور متاحًا عادةً على:

​
عندما تغير المخططات

  1. حدّث مخططات TypeBox.
  2. سجل الطريقة/الحدث في src/gateway/server-methods-list.ts.
  3. حدّث src/gateway/method-scopes.ts عندما تحتاج RPC الجديدة إلى تصنيف نطاق المشغل أو العقدة.
  4. شغّل pnpm protocol:check.
  5. التزم بالمخطط المعاد توليده + نماذج Swift.

​
ذات صلة