Skip to main content
El SDK de plugins contiene subrutas públicas específicas y auxiliares incluidos solo para el repositorio bajo openclaw/plugin-sdk/. Esta página cataloga ambos y marca explícitamente las entradas locales privadas. Tres archivos definen el límite:
  • scripts/lib/plugin-sdk-entrypoints.json: el inventario mantenido de puntos de entrada que compila la compilación.
  • scripts/lib/plugin-sdk-private-local-only-subpaths.json: subrutas internas excluidas del SDK tipado y documentado. Las entradas de producción siguen disponibles como exportaciones del entorno de ejecución del host solo para JavaScript para plugins oficiales publicados por separado; las entradas exclusivas para pruebas permanecen sin exportar.
  • src/plugin-sdk/entrypoints.ts: metadatos de clasificación para subrutas obsoletas, auxiliares incluidos reservados, fachadas incluidas compatibles y superficies públicas propiedad de plugins.
Los responsables de mantenimiento auditan el recuento de exportaciones públicas con pnpm plugin-sdk:surface y las subrutas activas de auxiliares reservados con pnpm plugins:boundary-report:summary; las exportaciones de auxiliares reservados sin usar hacen que falle el informe de CI en lugar de permanecer en el SDK público como deuda de compatibilidad inactiva. Para consultar la guía de creación de plugins, véase Descripción general del SDK de plugins.

Entrada del plugin

Compatibilidad y auxiliares locales privados

Solo permanecen exportadas las subrutas obsoletas del periodo posterior. Se eliminaron los alias de julio de 2026 y las subrutas sin usar, mientras que los auxiliares exclusivos incluidos se eliminaron del paquete público y se marcan a continuación como locales privados. La lista mantenida es scripts/lib/plugin-sdk-deprecated-public-subpaths.json; CI rechaza los incluidos plugin-sdk/text-runtime son solo para compatibilidad, y plugin-sdk/zod es una reexportación de compatibilidad: importe zod directamente desde zod. Los barrels amplios de dominio plugin-sdk/agent-runtime, plugin-sdk/channel-lifecycle, plugin-sdk/conversation-runtime, plugin-sdk/hook-runtime, plugin-sdk/media-runtime, plugin-sdk/plugin-runtime y plugin-sdk/security-runtime también están obsoletos en favor de subrutas específicas. Las subrutas de auxiliares de pruebas de OpenClaw respaldadas por Vitest son solo locales del repositorio y ya no son exportaciones del paquete: agent-runtime-test-contracts, channel-contract-testing, channel-target-testing, channel-test-helpers, plugin-state-test-runtime, plugin-test-api, plugin-test-contracts, plugin-test-runtime, provider-http-test-mocks, provider-test-contracts, reply-payload-testing, sqlite-runtime-testing, test-env, test-fixtures, test-live, test-live-auth, test-media-generation, test-media-understanding, test-node-mocks y testing. Las superficies privadas de auxiliares incluidos ssrf-runtime-internal y codex-native-task-runtime también son solo locales del repositorio.

Subrutas de auxiliares de plugins incluidos

Los módulos auxiliares exclusivos incluidos son locales privados después de la revisión de julio de 2026. Las barreras de protección del contrato del paquete bloquean las importaciones entre propietarios. src/plugin-sdk/entrypoints.ts registra por separado las fachadas incluidas compatibles que siguen siendo públicas, puntos de entrada del SDK respaldados por su plugin incluido hasta que los contratos genéricos sustituyan plugin-sdk/qa-runner-runtime, plugin-sdk/telegram-account, obsoletos para código nuevo; consulte las notas de cada fila a continuación.
Las subrutas de compatibilidad de canales del periodo posterior permanecen públicas solo hasta sus fechas de registro. Se han eliminado los alias de julio, como el acceso directo a mensajes directos, las opciones de respuesta y las rutas de emparejamiento, así como las subdivisiones del entorno de ejecución de canales; los auxiliares exclusivos incluidos son locales privados.
Las instantáneas de uso de proveedores normalmente informan de una o más windows de cuota, cada una con una etiqueta, el porcentaje utilizado y una hora de restablecimiento opcional. Los proveedores que exponen texto de saldo o estado de la cuenta en lugar de intervalos de cuota restablecibles deben devolver summary con una matriz windows vacía, en vez de inventar porcentajes. OpenClaw muestra ese texto de resumen en la salida de estado; use error solo cuando el endpoint de uso haya fallado o no haya devuelto datos de uso aprovechables.
Las subrutas reservadas del SDK para auxiliares incluidos son superficies específicas y restringidas de cada propietario destinadas al código de plugins incluidos. Se registran en el inventario del SDK para que las compilaciones de paquetes y los alias sigan siendo deterministas, pero no son API generales para la creación de plugins. Los nuevos contratos reutilizables del host deben usar subrutas genéricas del SDK, como plugin-sdk/gateway-runtime y plugin-sdk/ssrf-runtime.

Contenido relacionado