Migração do SDK de Plugin

​

O que está mudando

• openclaw/plugin-sdk/compat - uma única importação que reexportava dezenas de auxiliares. Ela foi introduzida para manter Plugins mais antigos baseados em hooks funcionando enquanto a nova arquitetura de Plugins estava sendo criada.
• openclaw/plugin-sdk/infra-runtime - um amplo barrel de auxiliares de runtime que misturava eventos do sistema, estado de Heartbeat, filas de entrega, auxiliares de fetch/proxy, auxiliares de arquivos, tipos de aprovação e utilitários não relacionados.
• openclaw/plugin-sdk/config-runtime - um amplo barrel de compatibilidade de configuração que ainda carrega auxiliares obsoletos de carregamento/gravação direta durante a janela de migração.
• openclaw/extension-api - uma ponte que dava aos Plugins acesso direto a auxiliares do lado do host, como o executor de agente incorporado.
• api.registerEmbeddedExtensionFactory(...) - um hook removido de extensão empacotada somente do executor incorporado que podia observar eventos do executor incorporado, como tool_result.

​

Por que isso mudou

• Inicialização lenta - importar um auxiliar carregava dezenas de módulos não relacionados
• Dependências circulares - reexportações amplas facilitavam a criação de ciclos de importação
• Superfície de API pouco clara - não havia como saber quais exportações eram estáveis versus internas

• Anthropic mantém auxiliares de stream específicos do Claude em seu próprio seam api.ts / contract-api.ts
• OpenAI mantém construtores de provedor, auxiliares de modelo padrão e construtores de provedor realtime em seu próprio api.ts
• OpenRouter mantém o construtor de provedor e auxiliares de onboarding/configuração em seu próprio api.ts

​

Plano de migração do Talk e voz realtime

1. Mantenha o controlador compartilhado e as primitivas de runtime em plugin-sdk/realtime-voice.
2. Mova as superfícies empacotadas para o controlador compartilhado: retransmissão do navegador, handoff de sala gerenciada, realtime de chamada de voz, STT por streaming de chamada de voz, Google Meet realtime e push-to-talk nativo.
3. Substitua as antigas famílias de RPC do Talk pela API final talk.session.* e talk.client.*.
4. Anuncie um canal de eventos Talk ao vivo no Gateway hello-ok.features.events: talk.event.
5. Exclua o antigo endpoint HTTP realtime e qualquer caminho de substituição de instruções em tempo de solicitação.

// 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 });
await gateway.request("talk.client.steer", { sessionKey, text, mode: "steer" });

​

Política de compatibilidade

1. adicionar o novo contrato
2. manter o comportamento antigo conectado por meio de um adaptador de compatibilidade
3. emitir um diagnóstico ou aviso que nomeie o caminho antigo e a substituição
4. cobrir ambos os caminhos em testes
5. documentar a depreciação e o caminho de migração
6. remover somente após a janela de migração anunciada, geralmente em uma versão principal

​

Como migrar

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

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

{
  "contracts": {
    "agentToolResultMiddleware": ["openclaw", "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 { runEmbeddedAgent } from "openclaw/extension-api";
const result = await runEmbeddedAgent({ sessionId, prompt });

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

pnpm build
pnpm test -- my-plugin/

​

Referência de caminhos de importação

​

Descontinuações ativas

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

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

// Before
api.on("deactivate", async (event, ctx) => {
  await stopPluginService(ctx);
});

// After
api.on("gateway_stop", async (event, ctx) => {
  await stopPluginService(ctx);
});

// Before
api.on("subagent_spawning", async () => ({
  status: "ok",
  threadBindingReady: true,
  deliveryOrigin: { channel: "discord", to: "channel:123", threadId: "456" },
}));

// After
api.on("subagent_spawned", async (event) => {
  await observeSubagentLaunch(event);
});

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

​

Cronograma de remoção

​

Suprimindo os avisos temporariamente

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

​

Relacionados

• Primeiros passos - crie seu primeiro plugin
• Visão geral do SDK - referência completa de imports por subcaminho
• Plugins de canal - criação de plugins de canal
• Plugins de provedor - criação de plugins de provedor
• Aspectos internos do Plugin - análise aprofundada da arquitetura
• Manifesto do Plugin - referência do esquema do manifesto