wraptc 1.0.2 → 1.0.4

package/src/core/plugin/registry.ts

@@ -0,0 +1,350 @@
+/**
+ * PluginRegistry - Central registry for terminal coder plugins
+ *
+ * Singleton pattern with lifecycle management and provider creation.
+ */
+
+import { binaryExists } from "../provider-factory";
+import type { Provider } from "../providers/index";
+import type {
+  CreateProviderOptions,
+  IPluginRegistry,
+  ManagedProvider,
+  PluginContext,
+  PluginDefinition,
+  PluginInfo,
+  PluginRegistrationOptions,
+  PluginRegistrationResult,
+} from "./types";
+
+/**
+ * PluginRegistry - Manages plugin registration and provider creation
+ */
+export class PluginRegistry implements IPluginRegistry {
+  private static instance: PluginRegistry | null = null;
+
+  /** Registered plugins by type */
+  private plugins = new Map<string, PluginDefinition>();
+
+  /** Track built-in plugins */
+  private builtInTypes = new Set<string>();
+
+  /** Track initialized providers for lifecycle management */
+  private initializedProviders = new Map<string, ManagedProvider>();
+
+  /** Default context */
+  private defaultContext: PluginContext;
+
+  private constructor() {
+    this.defaultContext = {
+      registry: this,
+      cwd: process.cwd(),
+    };
+  }
+
+  /**
+   * Get the singleton instance
+   */
+  static getInstance(): PluginRegistry {
+    if (!PluginRegistry.instance) {
+      PluginRegistry.instance = new PluginRegistry();
+    }
+    return PluginRegistry.instance;
+  }
+
+  /**
+   * Reset the singleton instance (for testing)
+   */
+  static resetInstance(): void {
+    if (PluginRegistry.instance) {
+      // Clean up initialized providers
+      PluginRegistry.instance.shutdownAll().catch(console.warn);
+    }
+    PluginRegistry.instance = null;
+  }
+
+  /**
+   * Register a plugin (async, with lifecycle hooks)
+   */
+  async register(
+    plugin: PluginDefinition,
+    options: PluginRegistrationOptions = {},
+  ): Promise<PluginRegistrationResult> {
+    const { overwrite = false, builtIn = false } = options;
+
+    // Check for existing registration
+    if (this.plugins.has(plugin.type)) {
+      if (!overwrite) {
+        return {
+          success: false,
+          type: plugin.type,
+          message: `Plugin type '${plugin.type}' is already registered.`,
+        };
+      }
+
+      // Call onUnregister for existing plugin
+      const existing = this.plugins.get(plugin.type);
+      if (existing?.onUnregister) {
+        try {
+          await existing.onUnregister(this.defaultContext);
+        } catch (error) {
+          console.warn(`Error during onUnregister for plugin '${plugin.type}':`, error);
+        }
+      }
+    }
+
+    // Register the plugin
+    this.plugins.set(plugin.type, plugin);
+
+    // Mark as built-in if specified
+    if (builtIn) {
+      this.builtInTypes.add(plugin.type);
+    }
+
+    // Call onRegister hook
+    if (plugin.onRegister) {
+      try {
+        await plugin.onRegister(this.defaultContext);
+      } catch (error) {
+        // Rollback on failure
+        this.plugins.delete(plugin.type);
+        this.builtInTypes.delete(plugin.type);
+        return {
+          success: false,
+          type: plugin.type,
+          message: `Plugin onRegister failed: ${
+            error instanceof Error ? error.message : String(error)
+          }`,
+        };
+      }
+    }
+
+    return {
+      success: true,
+      type: plugin.type,
+      overwritten: this.plugins.has(plugin.type) && overwrite,
+    };
+  }
+
+  /**
+   * Register a plugin synchronously (no lifecycle hooks called)
+   */
+  registerSync(
+    plugin: PluginDefinition,
+    options: PluginRegistrationOptions = {},
+  ): PluginRegistrationResult {
+    const { overwrite = false, builtIn = false } = options;
+
+    if (this.plugins.has(plugin.type) && !overwrite) {
+      return {
+        success: false,
+        type: plugin.type,
+        message: `Plugin type '${plugin.type}' is already registered.`,
+      };
+    }
+
+    this.plugins.set(plugin.type, plugin);
+    if (builtIn) {
+      this.builtInTypes.add(plugin.type);
+    }
+
+    return { success: true, type: plugin.type };
+  }
+
+  /**
+   * Unregister a plugin
+   */
+  async unregister(type: string): Promise<boolean> {
+    const plugin = this.plugins.get(type);
+    if (!plugin) return false;
+
+    // Shutdown any initialized provider
+    const provider = this.initializedProviders.get(type);
+    if (provider?.shutdown) {
+      await provider.shutdown();
+      this.initializedProviders.delete(type);
+    }
+
+    // Call onUnregister hook
+    if (plugin.onUnregister) {
+      await plugin.onUnregister(this.defaultContext);
+    }
+
+    this.plugins.delete(type);
+    this.builtInTypes.delete(type);
+    return true;
+  }
+
+  /**
+   * Check if a plugin type is registered
+   */
+  has(type: string): boolean {
+    return this.plugins.has(type);
+  }
+
+  /**
+   * Get a plugin definition
+   */
+  get(type: string): PluginDefinition | undefined {
+    return this.plugins.get(type);
+  }
+
+  /**
+   * Get all registered plugin types
+   */
+  getTypes(): string[] {
+    return Array.from(this.plugins.keys());
+  }
+
+  /**
+   * List all plugins with metadata
+   */
+  listPlugins(): PluginInfo[] {
+    const infos: PluginInfo[] = [];
+
+    for (const plugin of this.plugins.values()) {
+      infos.push({
+        type: plugin.type,
+        displayName: plugin.displayName,
+        description: plugin.description,
+        docsUrl: plugin.docsUrl,
+        version: plugin.version,
+        capabilities: plugin.capabilities,
+        binary: plugin.binary,
+        hasLifecycle: plugin.hasLifecycle,
+        isBuiltIn: this.builtInTypes.has(plugin.type),
+      });
+    }
+
+    return infos;
+  }
+
+  /**
+   * Get plugin info by type
+   */
+  getPluginInfo(type: string): PluginInfo | undefined {
+    const plugin = this.plugins.get(type);
+    if (!plugin) return undefined;
+
+    return {
+      type: plugin.type,
+      displayName: plugin.displayName,
+      description: plugin.description,
+      docsUrl: plugin.docsUrl,
+      version: plugin.version,
+      capabilities: plugin.capabilities,
+      binary: plugin.binary,
+      hasLifecycle: plugin.hasLifecycle,
+      isBuiltIn: this.builtInTypes.has(type),
+    };
+  }
+
+  /**
+   * Create a provider from a registered plugin
+   */
+  createProvider(
+    type: string,
+    config: unknown,
+    options: CreateProviderOptions = {},
+  ): ManagedProvider {
+    const plugin = this.plugins.get(type);
+    if (!plugin) {
+      throw new Error(
+        `No plugin registered for type '${type}'. ` +
+          `Available types: ${this.getTypes().join(", ") || "none"}`,
+      );
+    }
+
+    // Use factory function
+    const context = options.context ?? this.defaultContext;
+    return plugin.factory(config, context) as ManagedProvider;
+  }
+
+  /**
+   * Create and initialize a provider with lifecycle management
+   */
+  async createAndInitProvider(
+    type: string,
+    config: unknown,
+    options: CreateProviderOptions = {},
+  ): Promise<ManagedProvider> {
+    const provider = this.createProvider(type, config, options);
+
+    // Initialize if lifecycle provider
+    if (provider.init) {
+      await provider.init();
+      this.initializedProviders.set(type, provider);
+    }
+
+    return provider;
+  }
+
+  /**
+   * Check if a plugin's binary is available
+   */
+  async isAvailable(type: string): Promise<boolean> {
+    const plugin = this.plugins.get(type);
+    if (!plugin) return false;
+    if (!plugin.binary) return true;
+    return binaryExists(plugin.binary);
+  }
+
+  /**
+   * Get all available plugin types (with valid binaries)
+   */
+  async getAvailableTypes(): Promise<string[]> {
+    const types = this.getTypes();
+    const availability = await Promise.all(types.map((type) => this.isAvailable(type)));
+    return types.filter((_, i) => availability[i]);
+  }
+
+  /**
+   * Shutdown all initialized providers
+   */
+  async shutdownAll(): Promise<void> {
+    for (const provider of this.initializedProviders.values()) {
+      if (provider.shutdown) {
+        try {
+          await provider.shutdown();
+        } catch (error) {
+          console.warn("Error during provider shutdown:", error);
+        }
+      }
+    }
+    this.initializedProviders.clear();
+  }
+
+  /**
+   * Clear all plugins
+   */
+  async clear(): Promise<void> {
+    // Shutdown initialized providers
+    await this.shutdownAll();
+
+    // Call onUnregister for all plugins
+    for (const plugin of this.plugins.values()) {
+      if (plugin.onUnregister) {
+        try {
+          await plugin.onUnregister(this.defaultContext);
+        } catch (error) {
+          console.warn(`Error during onUnregister for plugin '${plugin.type}':`, error);
+        }
+      }
+    }
+
+    this.plugins.clear();
+    this.builtInTypes.clear();
+  }
+
+  /**
+   * Get the number of registered plugins
+   */
+  get size(): number {
+    return this.plugins.size;
+  }
+}
+
+/**
+ * Get the global plugin registry instance
+ */
+export const getPluginRegistry = (): PluginRegistry => PluginRegistry.getInstance();

package/src/core/plugin/types.ts

@@ -0,0 +1,209 @@
+/**
+ * Plugin System Types
+ *
+ * Provides a formal registry for terminal coder plugins with lifecycle hooks
+ * and configuration validation.
+ */
+
+import type { Provider } from "../providers/index";
+
+/**
+ * Plugin lifecycle interface
+ * Providers can optionally implement these for managed lifecycle
+ */
+export interface IPluginLifecycle {
+  /**
+   * Initialize the plugin (async setup, warmup, etc.)
+   * Called once when the plugin is first used
+   */
+  init?(): Promise<void>;
+
+  /**
+   * Perform health check
+   * @returns true if healthy
+   */
+  healthcheck?(): Promise<boolean>;
+
+  /**
+   * Clean shutdown
+   * Called when the system is shutting down
+   */
+  shutdown?(): Promise<void>;
+}
+
+/**
+ * Factory function type for creating provider instances
+ */
+export type ProviderFactory<TConfig = unknown> = (
+  config: TConfig,
+  context?: PluginContext,
+) => Provider;
+
+/**
+ * Context passed to plugin factory and lifecycle methods
+ */
+export interface PluginContext {
+  /** Plugin registry for accessing other plugins */
+  registry: IPluginRegistry;
+  /** Configuration path (if loaded from file) */
+  configPath?: string;
+  /** Working directory */
+  cwd?: string;
+}
+
+/**
+ * Plugin definition interface
+ *
+ * This is the main interface for defining a terminal coder plugin.
+ * For simple tools, use the adapter system instead.
+ */
+export interface PluginDefinition<TConfig = unknown> {
+  /**
+   * Unique type identifier for this plugin
+   * Used as discriminator in config and registry lookup
+   */
+  readonly type: string;
+
+  /**
+   * Human-readable name for display
+   */
+  readonly displayName: string;
+
+  /**
+   * Brief description of the plugin
+   */
+  readonly description?: string;
+
+  /**
+   * URL to documentation
+   */
+  readonly docsUrl?: string;
+
+  /**
+   * Version of the plugin (semver)
+   */
+  readonly version?: string;
+
+  /**
+   * Factory function to create provider instances
+   */
+  readonly factory: ProviderFactory<TConfig>;
+
+  /**
+   * Whether this provider implements IPluginLifecycle
+   * If true, init/shutdown will be called during lifecycle management
+   */
+  readonly hasLifecycle: boolean;
+
+  /**
+   * Capabilities this plugin supports
+   * e.g., ["generate", "edit", "explain", "test", "review"]
+   */
+  readonly capabilities?: string[];
+
+  /**
+   * Binary required by this plugin
+   * Used for availability checking
+   */
+  readonly binary?: string;
+
+  /**
+   * Hook called when plugin is registered
+   * Use for one-time setup or validation
+   */
+  onRegister?(context: PluginContext): void | Promise<void>;
+
+  /**
+   * Hook called when plugin is unregistered
+   * Use for cleanup
+   */
+  onUnregister?(context: PluginContext): void | Promise<void>;
+}
+
+/**
+ * Registration options
+ */
+export interface PluginRegistrationOptions {
+  /** Whether to overwrite if plugin type already exists */
+  overwrite?: boolean;
+  /** Mark as built-in plugin */
+  builtIn?: boolean;
+}
+
+/**
+ * Registration result
+ */
+export interface PluginRegistrationResult {
+  success: boolean;
+  type: string;
+  message?: string;
+  overwritten?: boolean;
+}
+
+/**
+ * Plugin metadata for queries
+ */
+export interface PluginInfo {
+  type: string;
+  displayName: string;
+  description?: string;
+  docsUrl?: string;
+  version?: string;
+  capabilities?: string[];
+  binary?: string;
+  hasLifecycle: boolean;
+  isBuiltIn: boolean;
+  isAvailable?: boolean;
+}
+
+/**
+ * Options for creating a provider
+ */
+export interface CreateProviderOptions {
+  /** Plugin context */
+  context?: PluginContext;
+  /** Skip config validation */
+  skipValidation?: boolean;
+}
+
+/**
+ * Extended provider type with optional lifecycle
+ */
+export type ManagedProvider = Provider & Partial<IPluginLifecycle>;
+
+/**
+ * Type guard for lifecycle providers
+ */
+export function isLifecycleProvider(provider: Provider): provider is Provider & IPluginLifecycle {
+  return (
+    provider != null &&
+    typeof provider === "object" &&
+    "init" in provider &&
+    typeof (provider as IPluginLifecycle).init === "function"
+  );
+}
+
+/**
+ * Helper type to extract config type from plugin
+ */
+export type PluginConfigType<T> = T extends PluginDefinition<infer C> ? C : never;
+
+/**
+ * Plugin registry interface (for dependency injection)
+ */
+export interface IPluginRegistry {
+  register(
+    plugin: PluginDefinition,
+    options?: PluginRegistrationOptions,
+  ): Promise<PluginRegistrationResult>;
+  registerSync(
+    plugin: PluginDefinition,
+    options?: PluginRegistrationOptions,
+  ): PluginRegistrationResult;
+  unregister(type: string): Promise<boolean>;
+  has(type: string): boolean;
+  get(type: string): PluginDefinition | undefined;
+  getTypes(): string[];
+  listPlugins(): PluginInfo[];
+  createProvider(type: string, config: unknown, options?: CreateProviderOptions): ManagedProvider;
+}