Página generada desde el TSDoc de @styx/plugin-sdk. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Interface: IPluginRegistryCopiar enlace

Registry de extensiones embebidas de un servicio.

PropertiesCopiar enlace

pluginIdsCopiar enlace

readonly pluginIds: readonly string[]

Ids registrados, en orden de id (determinista).

MethodsCopiar enlace

discover()Copiar enlace

discover<K>(kind): readonly IPluginBinding<K>[]

Todos los plugins que cubren un extension point, ordenados por precedencia (mejor primero). Incluye los no servibles — el caller ve el panorama completo.

Type ParametersCopiar enlace

KCopiar enlace

K extends keyof PluginExportsByKind

ParametersCopiar enlace

kindCopiar enlace

K

Extension point.

ReturnsCopiar enlace

readonly IPluginBinding<K>[]

Bindings ordenados por precedencia.

---

healthOf()Copiar enlace

healthOf(pluginId): Result<PluginHealthState, ResultError<"PLUGIN_NOT_FOUND">>

Health actual de un plugin.

ParametersCopiar enlace

pluginIdCopiar enlace

string

Id del plugin.

ReturnsCopiar enlace

Result<PluginHealthState, ResultError<"PLUGIN_NOT_FOUND">>

Result con el health, o PLUGIN_NOT_FOUND.

---

initialize()Copiar enlace

initialize(host): Promise<IRegistryInitReport>

Inicializa todos los plugins no desactivados, cada uno con su contexto scoped y bajo timeout.

No devuelve Result a propósito: el arranque del registry no es una operación fallible — un plugin caído no debe tumbar el servicio (r48 §3.2). Ningún fallo se traga: cada uno viaja en outcomes[].result y en failed[], para que el servicio lo loguee con su extension.id.

ParametersCopiar enlace

hostCopiar enlace

IExtensionHost

Fuente host-level de config/secrets/principal.

ReturnsCopiar enlace

Promise<IRegistryInitReport>

Reporte con el outcome de cada plugin.

---

lifecycleOf()Copiar enlace

lifecycleOf(pluginId): Result<PluginLifecycleState, ResultError<"PLUGIN_NOT_FOUND">>

Lifecycle actual de un plugin.

ParametersCopiar enlace

pluginIdCopiar enlace

string

Id del plugin.

ReturnsCopiar enlace

Result<PluginLifecycleState, ResultError<"PLUGIN_NOT_FOUND">>

Result con el lifecycle, o PLUGIN_NOT_FOUND.

---

probeHealth()Copiar enlace

probeHealth(pluginId): Promise<Result<PluginHealthState, ResultError<"INVALID_HEALTH_TRANSITION" | "PLUGIN_NOT_FOUND">>>

Sondea el health de un plugin llamando a su health() y aplica la transición.

ParametersCopiar enlace

pluginIdCopiar enlace

string

Id del plugin.

ReturnsCopiar enlace

Promise<Result<PluginHealthState, ResultError<"INVALID_HEALTH_TRANSITION" | "PLUGIN_NOT_FOUND">>>

Result con el health resultante, o el motivo del rechazo.

---

select()Copiar enlace

select<K>(kind): Result<IPluginBinding<K>, ResultError<"NO_PLUGIN_AVAILABLE">>

El plugin de mayor precedencia que puede servir ese extension point.

Salta los no servibles (failed, disabled, unavailable, misconfigured): ahí es donde un provider caído deja paso al siguiente en vez de romper el flujo.

Type ParametersCopiar enlace

KCopiar enlace

K extends keyof PluginExportsByKind

ParametersCopiar enlace

kindCopiar enlace

K

Extension point.

ReturnsCopiar enlace

Result<IPluginBinding<K>, ResultError<"NO_PLUGIN_AVAILABLE">>

Result con el binding ganador, o NO_PLUGIN_AVAILABLE.

---

setHealth()Copiar enlace

setHealth(pluginId, next): Result<PluginHealthState, ResultError<"INVALID_HEALTH_TRANSITION" | "PLUGIN_NOT_FOUND">>

Fuerza una transición de health (acción de operador: disable/enable, o un health check externo al plugin).

ParametersCopiar enlace

pluginIdCopiar enlace

string

Id del plugin.

nextCopiar enlace

PluginHealthState

Health destino.

ReturnsCopiar enlace

Result<PluginHealthState, ResultError<"INVALID_HEALTH_TRANSITION" | "PLUGIN_NOT_FOUND">>

Result con el health resultante, o el motivo del rechazo.

---

shutdown()Copiar enlace

shutdown(): Promise<readonly IPluginShutdownOutcome[]>

Apaga los plugins activos.

Como initialize(), no falla en bloque: devuelve el outcome de cada uno.

ReturnsCopiar enlace

Promise<readonly IPluginShutdownOutcome[]>

Outcome de shutdown por plugin, en orden de id.