Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
import { PluginSearchProvider } from '../../modules/search/providers/plugin-search-provider';
import type { PluginSearchTransport } from '../../modules/search/providers/plugin-search-provider';
import type { PluginSearchRegistryPort } from './plugin-host-ports';
export interface RegisterPluginSearchProviderDeps {
pluginId: string;
label: string;
transport: PluginSearchTransport;
timeoutMs: number;
/** The live search registry port, or undefined when the search module isn't loaded (SEARCH_ENABLED=false). */
registry: PluginSearchRegistryPort | undefined;
/** Resolved SEARCH_PROVIDER mode: 'auto' | 'builtin-fts' | 'none'. */
mode: string;
/** manifest declares search:provide */
hasPermission: boolean;
warn: (message: string, meta: Record<string, unknown>) => void;
}
/**
* Register a sandboxed plugin as a SearchProvider when it declares itself one (search-provider-register).
* Pure policy, extracted from the loader so it is unit-testable without constructing PluginLoaderService:
*
* - no search:provide → deny + warn. Checked FIRST, and warned even when search is off, because an
* undeclared plugin reaching here is a privilege claim, not a config question:
* `ctx.registerSearchProvider` is installed unconditionally in every worker
* context, and this is the only gate between it and the registry (the
* declaration arrives as an IPC message, so it never passes through the
* capability router that gates `ctx.messages`/`ctx.net`/`ctx.engine`).
* - registry undefined → search module not loaded (SEARCH_ENABLED=false); skip silently.
* - mode 'none' → operator disabled search; skip.
* - mode 'auto' → register AND setActive, superseding builtin-fts (the documented auto behavior).
* - mode 'builtin-fts' → register but leave inactive (operator pinned the built-in).
*
* Last-registered plugin wins in 'auto' if multiple register (Part 1 limitation).
*/
export function registerPluginSearchProvider(deps: RegisterPluginSearchProviderDeps): void {
if (!deps.hasPermission) {
// Bounded without a latch: WorkerSearchRegistry posts `search-provider-register` only on the
// plugin's FIRST ctx.registerSearchProvider call, so this is at most one line per enable.
deps.warn(`Sandboxed plugin ${deps.pluginId} declared a search provider without 'search:provide'; ignoring`, {
pluginId: deps.pluginId,
action: 'sandbox_search_provider_denied',
});
return;
}
if (!deps.registry) return;
if (deps.mode === 'none') return;
const provider = new PluginSearchProvider(deps.pluginId, deps.label, deps.transport, deps.timeoutMs);
deps.registry.register(provider);
if (deps.mode === 'auto') deps.registry.setActive(provider.id);
}
/** Drop a plugin's SearchProvider entry on disable/uninstall so queries don't route to a dead worker. */
export function unregisterPluginSearchProvider(registry: PluginSearchRegistryPort | undefined, pluginId: string): void {
registry?.unregister(`plugin:${pluginId}`);
}