@oktis-works/plugin-runtime 0.6.1 → 0.7.1

package/dist/bootstrap.d.ts

@@ -1,42 +1,43 @@
+import { type PluginJobHandler, type AdminExtensionsState, type PluginBlockManifest, type PluginPatternManifest, type EnqueuedAsset, type PluginHealthCheck } from '@oktis-works/plugin-sdk';
 import { type HookRegistry } from './hook-registry.js';
-import type { PluginApiDependencies, RouteDefinition } from './plugin-api.js';
+import type { PluginApiDependencies, PluginAPI, RouteDefinition } from './plugin-api.js';
 export interface BootstrapPluginsSql {
     unsafe(text: string, params?: unknown[]): Promise<unknown>;
 }
 export interface BootstrapPluginsOptions {
-    /** Diretório de plugins (o chamador resolve — plugin-runtime não conhece o core). */
+    /** Plugins directory (the caller resolves it — plugin-runtime doesn't know the core). */
     pluginsDir: string;
-    /** Cliente postgres para ler os habilitados; omitido = estado desconhecido (no-op). */
+    /** Postgres client to read enabled plugins; omitted = unknown state (no-op). */
     sql?: BootstrapPluginsSql;
-    /** Registry alvo (default: registry do escopo — platform ou `tenantId`). */
+    /** Target registry (default: the scope registry — platform or `tenantId`). */
     registry?: HookRegistry;
-    /** Statuses considerados habilitados (default: ACTIVATED, RUNNING). */
+    /** Statuses considered enabled (default: ACTIVATED, RUNNING). */
     enabledStatuses?: string[];
     /**
-     * Escopo de carga: `null`/omitido → platform (`plugins.tenant_id IS NULL`);
-     * string → tenant (`plugin_tenants` com status ENABLED).
+     * Load scope: `null`/omitted → platform (`plugins.tenant_id IS NULL`);
+     * string → tenant (`plugin_tenants` with ENABLED status).
      */
     tenantId?: string | null;
     /**
-     * Política de permissões concedidas (allowlist). Default: catálogo completo
-     * de permissões do CMS. Nunca é preenchida com as permissões do manifesto.
+     * Granted permission policy (allowlist). Default: the full CMS permission
+     * catalog. Never filled with the manifest's own permissions.
      */
     permissionPolicy?: string[];
-    /** Timeout de callbacks de hook em ms (0 = sem timeout). Default 5000. */
+    /** Hook callback timeout in ms (0 = no timeout). Default 5000. */
     hookTimeoutMs?: number;
     /**
-     * Dependências reais para a PluginAPI (settings, eventBus, db, etc.).
-     * Se omitido, usa apenas o Hooks API legado (compatibilidade).
-     * O core injeta isto com serviços reais.
+     * Real dependencies for the PluginAPI (settings, eventBus, db, etc.).
+     * When omitted, only the legacy Hooks API is used (compatibility).
+     * The core injects this with real services.
      */
     apiDeps?: Partial<PluginApiDependencies>;
 }
 export interface PluginBootstrapResult {
     /** Nomes habilitados no banco (vazio quando o banco falhou = estado desconhecido). */
     enabled: string[];
-    /** Registrados nesta sincronização. */
+    /** Loaded in this sync. */
     loaded: string[];
-    /** Hooks removidos nesta sincronização (saíram dos habilitados). */
+    /** Hooks removed in this sync (left the enabled list). */
     unloaded: string[];
     /** Falhas isoladas por plugin (nunca abortam o lote). */
     failed: Array<{
@@ -44,31 +45,98 @@ export interface PluginBootstrapResult {
         error: string;
     }>;
 }
-/** Escopo com carga registrada (para inspeção/estado de runtime). */
+/** Scope with registered loads (for inspection/runtime state). */
 export declare function listLoadedScopes(): Array<{
     scope: string;
     registry: HookRegistry;
     plugins: string[];
 }>;
-/** Obtém as rotas registradas pelos plugins em um escopo. */
+/** Gets the routes registered by plugins in a scope. */
 export declare function getLoadedPluginRoutes(scopeKey: string): Array<{
     pluginName: string;
     routes: RouteDefinition[];
+    api: PluginAPI;
+    scope: string;
+    tenantId: string | null;
+    /** Route rate-limit rpm (manifest rateLimit.rpm, Item 17). */
+    rpm?: number;
+}>;
+/**
+ * Handlers de jobs dos plugins em um escopo (dispatch pelo worker:
+ * `plugin:{tenant}:{plugin}:{jobName}` → handler).
+ */
+export declare function getLoadedPluginJobHandlers(scopeKey: string): Array<{
+    pluginName: string;
+    handlers: Map<string, PluginJobHandler>;
+}>;
+/**
+ * Runtime `api.admin` state of the plugins loaded in a scope (slots
+ * registered at runtime) — consumed by GET /api/v1/plugins/extensions, which
+ * merges it with `manifest.admin`. Only states with at least one entry are
+ * returned.
+ */
+export declare function getLoadedPluginAdminExtensions(scopeKey: string): Array<{
+    pluginName: string;
+    state: AdminExtensionsState;
+}>;
+/**
+ * Blocks registered at runtime via `api.registerBlock` by the plugins loaded
+ * in a scope — consumed by GET /api/v1/blocks, which merges them with
+ * `manifest.blocks`. Only plugins with at least one block are returned.
+ */
+export declare function getLoadedPluginBlocks(scopeKey: string): Array<{
+    pluginName: string;
+    blocks: Array<PluginBlockManifest & {
+        pluginName: string;
+    }>;
+}>;
+/**
+ * Patterns registered at runtime via `api.registerPattern` by the plugins
+ * loaded in a scope — consumed by GET /api/v1/patterns, which merges them
+ * with `manifest.patterns`. Only plugins with at least one pattern are
+ * returned.
+ */
+export declare function getLoadedPluginPatterns(scopeKey: string): Array<{
+    pluginName: string;
+    patterns: Array<PluginPatternManifest & {
+        pluginName: string;
+    }>;
+}>;
+/**
+ * Assets enqueued at runtime via `api.assets` by the plugins loaded in a
+ * scope — consumed by the public renderer (theme:head pipeline, Item 8).
+ * Only plugins with at least one asset are returned.
+ */
+export declare function getLoadedPluginAssets(scopeKey: string): Array<{
+    pluginName: string;
+    assets: EnqueuedAsset[];
+}>;
+/**
+ * Health checks registered at runtime via `api.health` by the plugins loaded
+ * in a scope — aggregated by GET /api/v1/health (Item 14). Only plugins with
+ * at least one check are returned.
+ */
+export declare function getLoadedPluginHealthChecks(scopeKey: string): Array<{
+    pluginName: string;
+    checks: Array<{
+        name: string;
+        check: PluginHealthCheck;
+    }>;
 }>;
 /**
- * Remove todos os hooks dos escopos carregados e limpa o estado.
- * Útil em testes e em shutdown. Quando `registry` é informado, os hooks são
- * removidos dele; caso contrário, do registry em que foram registrados.
+ * Removes all hooks from the loaded scopes and clears the state.
+ * Useful in tests and shutdown. When `registry` is given, hooks are removed
+ * from it; otherwise from the registry where they were registered.
  */
 export declare function resetLoadedPlugins(registry?: HookRegistry): void;
 /** Descarrega todos os plugins de um escopo (tenant desativado / LRU). */
 export declare function unloadScope(scopeKey: string): boolean;
-/** Descarrega um tenant (chave `tenant:<id>` ou o próprio id). */
+/** Unloads a tenant (key `tenant:<id>` or the id itself). */
 export declare function unloadTenant(tenantId: string): boolean;
 /**
  * Sincroniza o registry de um escopo com os plugins habilitados no banco.
  * Seguro para chamar no boot de qualquer processo e em re-syncs (ex.: logo
- * após ativar/desativar pela API).
+ * after enabling/disabling through the API).
  */
 export declare function bootstrapPlugins(options: BootstrapPluginsOptions): Promise<PluginBootstrapResult>;
 //# sourceMappingURL=bootstrap.d.ts.map

package/dist/bootstrap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAyC,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC9F,OAAO,KAAK,EAAE,qBAAqB,EAAqB,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEjG,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,uBAAuB;IACtC,qFAAqF;IACrF,UAAU,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAqB;IACpC,sFAAsF;IACtF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uCAAuC;IACvC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oEAAoE;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,yDAAyD;IACzD,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAChD;AAoCD,qEAAqE;AACrE,wBAAgB,gBAAgB,IAAI,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAMtG;AAED,6DAA6D;AAC7D,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC,CAahH;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAWhE;AAED,0EAA0E;AAC1E,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAWrD;AAED,kEAAkE;AAClE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEtD;AA6DD;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAwJvG"}
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAoBA,OAAO,EAA+C,KAAK,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,KAAK,mBAAmB,EAAE,KAAK,qBAAqB,EAAE,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAA2C,MAAM,yBAAyB,CAAC;AAInR,OAAO,EAAyC,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC9F,OAAO,KAAK,EAAE,qBAAqB,EAAqB,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE5G,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,uBAAuB;IACtC,yFAAyF;IACzF,UAAU,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,iEAAiE;IACjE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,kEAAkE;IAClE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,qBAAqB;IACpC,sFAAsF;IACtF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,yDAAyD;IACzD,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAChD;AA0DD,kEAAkE;AAClE,wBAAgB,gBAAgB,IAAI,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAMtG;AAED,wDAAwD;AACxD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,GAAG,EAAE,SAAS,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,8DAA8D;IAC9D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC,CAqBD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACzC,CAAC,CAaD;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IACtE,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,oBAAoB,CAAC;CAC7B,CAAC,CAoBD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,mBAAmB,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7D,CAAC,CASD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,KAAK,CAAC,qBAAqB,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE,CAAC,CASD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB,CAAC,CASD;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,iBAAiB,CAAA;KAAE,CAAC,CAAC;CAC3D,CAAC,CASD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAYhE;AAED,0EAA0E;AAC1E,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAgBrD;AAED,6DAA6D;AAC7D,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEtD;AA8DD;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAiPvG"}