Міграція Plugin SDK

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.

​

Що змінюється

• openclaw/plugin-sdk/compat - один імпорт, який повторно експортував десятки допоміжних функцій. Його було запроваджено, щоб старі hook-based plugin продовжували працювати, поки будувалася нова архітектура plugin.
• openclaw/plugin-sdk/infra-runtime - широкий barrel допоміжних runtime-функцій, який змішував системні події, стан heartbeat, черги доставлення, допоміжні функції fetch/proxy, допоміжні функції для файлів, типи схвалення та непов’язані утиліти.
• openclaw/plugin-sdk/config-runtime - широкий barrel сумісності конфігурації, який досі містить застарілі прямі допоміжні функції завантаження/запису протягом вікна міграції.
• openclaw/extension-api - міст, який давав plugin прямий доступ до host-side допоміжних функцій, як-от вбудований agent runner.
• api.registerEmbeddedExtensionFactory(...) - видалений bundled extension hook лише для Pi, який міг спостерігати події embedded-runner, такі як tool_result.

​

Чому це змінилося

• Повільний запуск - імпорт однієї допоміжної функції завантажував десятки непов’язаних модулів
• Циклічні залежності - широкі повторні експорти спрощували створення циклів імпорту
• Нечітка поверхня API - не було способу визначити, які експорти стабільні, а які внутрішні

• Anthropic зберігає специфічні для Claude stream helper у власному seam api.ts / contract-api.ts
• OpenAI зберігає provider builders, default-model helpers і realtime provider builders у власному api.ts
• OpenRouter зберігає provider builder і onboarding/config helpers у власному api.ts

​

План міграції Talk і realtime voice

1. Залишити спільні controller/runtime primitives у plugin-sdk/realtime-voice.
2. Перевести bundled surfaces на спільний controller: browser relay, managed-room handoff, voice-call realtime, voice-call streaming STT, Google Meet realtime і native push-to-talk.
3. Замінити старі сімейства Talk RPC на фінальні API talk.session.* і talk.client.*.
4. Оголосити один live Talk event channel у Gateway hello-ok.features.events: talk.event.
5. Видалити старий realtime HTTP endpoint і будь-який шлях request-time instruction override.

// Gateway-owned Talk session API.
await gateway.request("talk.session.create", {
  mode: "realtime",
  transport: "gateway-relay",
  brain: "agent-consult",
  sessionKey: "main",
});
await gateway.request("talk.session.appendAudio", { sessionId, audioBase64 });
await gateway.request("talk.session.cancelOutput", { sessionId, reason: "barge-in" });
await gateway.request("talk.session.submitToolResult", {
  sessionId,
  callId,
  result: { status: "working" },
  options: { willContinue: true },
});
await gateway.request("talk.session.submitToolResult", {
  sessionId,
  callId,
  result: { status: "already_delivered" },
  options: { suppressResponse: true },
});
await gateway.request("talk.session.submitToolResult", { sessionId, callId, result });
await gateway.request("talk.session.close", { sessionId });

// Client-owned provider session API.
await gateway.request("talk.client.create", {
  mode: "realtime",
  transport: "webrtc",
  brain: "agent-consult",
  sessionKey: "main",
});
await gateway.request("talk.client.toolCall", { sessionKey, callId, name, args });

​

Політика сумісності

1. додати новий контракт
2. зберегти стару поведінку, під’єднану через адаптер сумісності
3. видати діагностику або попередження, що називає старий шлях і заміну
4. покрити обидва шляхи тестами
5. задокументувати застарівання та шлях міграції
6. видаляти лише після оголошеного вікна міграції, зазвичай у major-релізі

​

Як мігрувати

await api.runtime.config.mutateConfigFile({
  afterWrite: { mode: "auto" },
  mutate(draft) {
    draft.plugins ??= {};
  },
});

// Pi and Codex runtime dynamic tools
api.registerAgentToolResultMiddleware(async (event) => {
  return compactToolResult(event);
}, {
  runtimes: ["pi", "codex"],
});

{
  "contracts": {
    "agentToolResultMiddleware": ["pi", "codex"]
  }
}

// Before
const program = applyWindowsSpawnProgramPolicy({ candidate });

// After
const program = applyWindowsSpawnProgramPolicy({
  candidate,
  // Only set this for trusted compatibility callers that intentionally
  // accept shell-mediated fallback.
  allowShellFallback: true,
});

grep -r "plugin-sdk/compat" my-plugin/
grep -r "plugin-sdk/infra-runtime" my-plugin/
grep -r "plugin-sdk/config-runtime" my-plugin/
grep -r "openclaw/extension-api" my-plugin/

// Before (deprecated backwards-compatibility layer)
import {
  createChannelReplyPipeline,
  createPluginRuntimeStore,
  resolveControlCommandGate,
} from "openclaw/plugin-sdk/compat";

// After (modern focused imports)
import { createChannelReplyPipeline } from "openclaw/plugin-sdk/channel-reply-pipeline";
import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store";
import { resolveControlCommandGate } from "openclaw/plugin-sdk/command-auth";

// Before (deprecated extension-api bridge)
import { runEmbeddedPiAgent } from "openclaw/extension-api";
const result = await runEmbeddedPiAgent({ sessionId, prompt });

// After (injected runtime)
const result = await api.runtime.agent.runEmbeddedPiAgent({ sessionId, prompt });

pnpm build
pnpm test -- my-plugin/

​

Довідник шляхів імпорту

​

Активні застаріння

// Before
import { buildHelpMessage } from "openclaw/plugin-sdk/command-auth";

// After
import { buildHelpMessage } from "openclaw/plugin-sdk/command-status";

{
  "contracts": {
    "externalAuthProviders": ["anthropic", "openai"]
  }
}

// Before
const flow = api.runtime.tasks.flow.fromToolContext(ctx);
// After
const flow = api.runtime.tasks.managedFlows.fromToolContext(ctx);

// Before
import type { OpenClawSchemaType } from "openclaw/plugin-sdk";
// After
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-schema";

​

Графік видалення

​

Тимчасове приглушення попереджень

OPENCLAW_SUPPRESS_PLUGIN_SDK_COMPAT_WARNING=1 openclaw gateway run
OPENCLAW_SUPPRESS_EXTENSION_API_WARNING=1 openclaw gateway run

​

Пов’язане

• Початок роботи - створіть свій перший plugin
• Огляд SDK - повний довідник імпорту підшляхів
• Channel Plugins - створення channel plugins
• Provider Plugins - створення provider plugins
• Внутрішня архітектура plugin - поглиблений огляд архітектури
• Manifest plugin - довідник схеми manifest