import type { Effect } from "effect"; import type { DBAdapter, DBSchema, StorageFailure, TypedAdapter, } from "@executor/storage-core"; import type { ScopedBlobStore } from "./blob"; import type { DefinitionsInput, SourceInput, ToolAnnotations, ToolRow, } from "./core-schema"; import type { SourceDetectionResult } from "./types"; import type { ElicitationDeclinedError, ElicitationHandler, ElicitationRequest, ElicitationResponse, } from "./elicitation"; import type { Scope } from "./scope"; import type { SecretProvider, SecretRef, SetSecretInput } from "./secrets"; // --------------------------------------------------------------------------- // StorageDeps — backing passed to a plugin's `storage` factory. The only // place a plugin ever sees storage; `PluginCtx` does not carry it. The // `adapter` field is a `TypedAdapter` view narrowed by the // plugin's own declared `schema` — plugins never import or construct // a typed adapter themselves, the executor infers TSchema from the // `schema` field on their spec and hands back a typed view. // // Plugins with no schema (secret-provider-only plugins, etc.) get a // bare `DBAdapter` they can ignore. // --------------------------------------------------------------------------- export interface StorageDeps { readonly scope: Scope; /** * Plugin-facing typed adapter. Failures surface as raw `StorageFailure` * (`StorageError` | `UniqueViolationError`). Plugins can * `catchTag("UniqueViolationError", …)` to translate to their own * user-facing errors. `StorageError` bubbles up; the HTTP edge (see * `@executor/api` `withCapture`) is the one place that * translates it to the opaque `InternalError({ traceId })`. */ readonly adapter: TSchema extends DBSchema ? TypedAdapter : DBAdapter; readonly blobs: ScopedBlobStore; } // --------------------------------------------------------------------------- // defineSchema — sugar around `as const satisfies DBSchema`. Preserves // literal types via the `const` type parameter modifier so plugins can // just write `const mySchema = defineSchema({ ... })` without annotation // ceremony. // --------------------------------------------------------------------------- export const defineSchema = (schema: S): S => schema; // --------------------------------------------------------------------------- // Elicit — suspends the fiber, calls the invoke-time elicitation // handler, resumes with the user's response. Available on both static // tool handlers and dynamic `invokeTool` handlers. Threaded through // the executor from `tools.invoke(id, args, { onElicitation })`. // --------------------------------------------------------------------------- export type Elicit = ( request: ElicitationRequest, ) => Effect.Effect; // --------------------------------------------------------------------------- // PluginCtx — threaded into every extension method, static tool handler, // and dynamic tool handler. No raw adapter, no raw blobs. Core writes // go through `core.sources.register` / `core.definitions.register`. // --------------------------------------------------------------------------- export interface PluginCtx { readonly scope: Scope; readonly storage: TStore; readonly core: { readonly sources: { readonly register: ( input: SourceInput, ) => Effect.Effect; readonly unregister: ( sourceId: string, ) => Effect.Effect; }; /** Register shared JSON-schema `$defs` for a source. Tool * input/output schemas registered via `sources.register` can carry * `$ref: "#/$defs/X"` pointers; `executor.tools.schema(toolId)` * attaches matching defs to the returned schema. Call inside the * same `ctx.transaction` as `sources.register` for atomicity. * Replaces any existing defs for the given sourceId. */ readonly definitions: { readonly register: ( input: DefinitionsInput, ) => Effect.Effect; }; }; readonly secrets: { readonly get: ( id: string, ) => Effect.Effect; readonly list: () => Effect.Effect< readonly { readonly id: string; readonly name: string; readonly provider: string }[], StorageFailure >; /** Write a secret value through a provider. Used by plugins that * mint secrets on behalf of the user (OAuth2 token storage, * interactive onboarding flows). Normally writes go through * `executor.secrets.set` on the host surface, but OAuth2 refresh * and one-shot token capture from plugin-owned flows need it here * too. Same routing rules as the host-level setter. */ readonly set: ( input: SetSecretInput, ) => Effect.Effect; /** Delete a secret from its pinned provider and the core table. */ readonly remove: (id: string) => Effect.Effect; }; /** Run `effect` inside a database transaction. Wraps the underlying * adapter's transaction method. Use this in extension methods that * need atomicity across plugin storage writes AND core source/tool * registration. */ readonly transaction: ( effect: Effect.Effect, ) => Effect.Effect; } // --------------------------------------------------------------------------- // Static tool / source declarations. Pure data + handlers declared at // plugin-definition time. // // Importantly, `StaticToolDecl.handler` does NOT reference TExtension. // If it did, the nested generic would break inference for the whole // PluginSpec (TS would fall back to the `object` constraint on TExtension). // `self: NoInfer` lives on `staticSources` one level up // instead, and plugin authors close over it via the arrow-function // closure when they write their handler. // --------------------------------------------------------------------------- export interface StaticToolHandlerInput { readonly ctx: PluginCtx; readonly args: unknown; /** Suspend the fiber to request user input. The handler passed to * `executor.tools.invoke(..., { onElicitation })` is called. */ readonly elicit: Elicit; } export interface StaticToolDecl { readonly name: string; readonly description: string; readonly inputSchema?: unknown; readonly outputSchema?: unknown; /** Default-policy annotations — `requiresApproval`, `approvalDescription`, * `mayElicit`. Enforced by the executor before the handler runs. * Inline because static tools have no plugin storage to resolve from; * the plugin author literally writes this at definition time. */ readonly annotations?: ToolAnnotations; readonly handler: ( input: StaticToolHandlerInput, ) => Effect.Effect; } export interface StaticSourceDecl { readonly id: string; readonly kind: string; readonly name: string; readonly url?: string; /** Static sources default to `canRemove: false` — they represent * plugin-provided control surfaces and shouldn't be user-removable. * Override only if you really want that. */ readonly canRemove?: boolean; readonly canRefresh?: boolean; readonly canEdit?: boolean; readonly tools: readonly StaticToolDecl[]; } // --------------------------------------------------------------------------- // Dynamic invoke / source lifecycle inputs. // --------------------------------------------------------------------------- export interface InvokeToolInput { readonly ctx: PluginCtx; /** Already-loaded tool row. Plugin doesn't need to re-fetch or parse * the tool id. Carries source_id, name, input/output schemas, * annotations. */ readonly toolRow: ToolRow; readonly args: unknown; /** Elicitation handle for plugins that need mid-invocation user input * (onepassword auth prompt, interactive MCP tools, etc.). */ readonly elicit: Elicit; } export interface SourceLifecycleInput { readonly ctx: PluginCtx; readonly sourceId: string; } // --------------------------------------------------------------------------- // PluginSpec — what a `definePlugin(factory)` call returns. // --------------------------------------------------------------------------- export interface PluginSpec< TId extends string = string, TExtension extends object = Record, TStore = unknown, TSchema extends DBSchema | undefined = DBSchema | undefined, > { readonly id: TId; /** Plugin-declared schema. Merged with coreSchema and other plugins' * schemas at executor startup via `collectSchemas`. The type flows * into the `storage` factory's `deps.adapter` as a `TypedAdapter` * so plugins get narrowed model names + typed rows for free. */ readonly schema?: TSchema; /** Build the plugin's typed store from backing. `deps.adapter` is * already narrowed to this plugin's schema; `deps.blobs` is already * scoped to the plugin id so key collisions across plugins are * structurally impossible. */ readonly storage: (deps: StorageDeps) => TStore; /** Build the plugin's extension API. The returned object becomes * `executor[plugin.id]` and is also the `self` passed to * `staticSources`. Field order matters: `extension` MUST appear * before `staticSources` so TS infers TExtension from this * factory's return BEFORE type-checking `self: NoInfer`. */ readonly extension?: (ctx: PluginCtx) => TExtension; /** Static sources contributed by this plugin with inline tool * handlers. Lives entirely in memory — no DB writes at startup. * Handlers close over `self` via the closure, so a control tool * that delegates to the plugin's real API is a one-liner: * `({ args }) => self.addSpec(args)`. */ readonly staticSources?: ( self: NoInfer, ) => readonly StaticSourceDecl[]; /** Invoke a dynamic tool. Called when the executor's static-handler * map doesn't have the toolId. The plugin reads its own enrichment * via `ctx.storage` and returns the result. Optional — plugins with * only static tools can omit it. */ readonly invokeTool?: ( input: InvokeToolInput, ) => Effect.Effect; /** Bulk resolve annotations (requiresApproval, approvalDescription, * mayElicit) for a set of tool rows under a single source. Called * by the executor: * - at invoke time with a single-element `toolRows` array, to * enforce approval on the about-to-run tool * - at list time with every dynamic tool row under each source, * grouped by source_id, to populate `Tool.annotations` for UI * * The expected implementation for most plugins is: read plugin * storage once for the given source/rows, derive annotations from * the same data that was used to build the tool (HTTP method + * path for openapi, introspection kind for graphql, etc.), return * a map keyed by tool id. * * Omit if the plugin has no annotations to contribute — executor * treats tools from that plugin as auto-approved with no * elicitation. */ readonly resolveAnnotations?: (input: { readonly ctx: PluginCtx; readonly sourceId: string; readonly toolRows: readonly ToolRow[]; }) => Effect.Effect, unknown>; /** Called when `executor.sources.remove(id)` targets a source owned * by this plugin. Plugin-side cleanup only; the executor deletes * the core source/tool rows after this callback returns, inside * the same transaction. */ readonly removeSource?: ( input: SourceLifecycleInput, ) => Effect.Effect; readonly refreshSource?: ( input: SourceLifecycleInput, ) => Effect.Effect; /** URL autodetection hook. When the user pastes a URL in the * onboarding UI, `executor.sources.detect(url)` fans out to every * plugin's `detect`. Return a `SourceDetectionResult` if you * recognize the URL, `null` otherwise. Implementations should be * defensive — swallow fetch errors and return null rather than * throwing. First high-confidence match wins. */ readonly detect?: (input: { readonly ctx: PluginCtx; readonly url: string; }) => Effect.Effect; /** Secret providers contributed by this plugin. Either a static * array or a function of ctx (for providers that need per-instance * state like the keychain's scope-derived service name). Called * once at executor startup after `storage` and `extension` have * been built. */ readonly secretProviders?: | readonly SecretProvider[] | ((ctx: PluginCtx) => readonly SecretProvider[]); readonly close?: () => Effect.Effect; } export interface Plugin< TId extends string = string, TExtension extends object = Record, TStore = unknown, TSchema extends DBSchema | undefined = DBSchema | undefined, > extends PluginSpec {} // --------------------------------------------------------------------------- // definePlugin — factory-returning-spec. Options from the author factory // are merged with a storage override so consumers can swap the default // store implementation without touching plugin internals. // --------------------------------------------------------------------------- export type ConfiguredPlugin< TId extends string, TExtension extends object, TStore, TOptions extends object, TSchema extends DBSchema | undefined, > = ( options?: TOptions & { readonly storage?: (deps: StorageDeps) => TStore; }, ) => Plugin; // eslint-disable-next-line @typescript-eslint/ban-types export function definePlugin< TId extends string, TExtension extends object, TStore, TSchema extends DBSchema | undefined = undefined, TOptions extends object = {}, >( authorFactory: ( options?: TOptions, ) => PluginSpec, ): ConfiguredPlugin { return (options) => { const { storage: storageOverride, ...rest }: { storage?: (deps: StorageDeps) => TStore; [key: string]: unknown; } = options ?? {}; const hasAuthorOptions = Object.keys(rest).length > 0; const spec = authorFactory( hasAuthorOptions ? (rest as unknown as TOptions) : undefined, ); return { ...spec, storage: storageOverride ?? spec.storage, }; }; } // --------------------------------------------------------------------------- // AnyPlugin / PluginExtensions — type-level glue for the Executor surface. // --------------------------------------------------------------------------- // eslint-disable-next-line @typescript-eslint/no-explicit-any export type AnyPlugin = Plugin; export type PluginExtensions = { readonly [P in TPlugins[number] as P["id"]]: P extends Plugin< string, infer TExt, // eslint-disable-next-line @typescript-eslint/no-explicit-any any, // eslint-disable-next-line @typescript-eslint/no-explicit-any any > ? TExt : never; }; /** Lightweight projection of a secret entry as returned by `ctx.secrets.list`. */ export interface SecretListEntry { readonly id: string; readonly name: string; readonly provider: string; } // Re-exported for consumers that check the elicitation handler type. export type { ElicitationHandler };