@sparkleideas/plugins 3.0.0-alpha.8

package/src/index.ts

@@ -0,0 +1,378 @@
+/**
+ * @sparkleideas/plugins
+ *
+ * Unified Plugin SDK for Claude Flow v3
+ *
+ * This package provides a comprehensive plugin development framework including:
+ * - Plugin lifecycle management
+ * - Worker capabilities
+ * - Hook system
+ * - LLM provider integration
+ * - Security utilities
+ * - MCP tool development
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   PluginBuilder,
+ *   HookEvent,
+ *   HookPriority,
+ *   WorkerFactory,
+ *   ProviderFactory,
+ *   Security,
+ * } from '@sparkleideas/plugins';
+ *
+ * // Create a plugin with the builder
+ * const myPlugin = new PluginBuilder('my-plugin', '1.0.0')
+ *   .withDescription('My awesome plugin')
+ *   .withMCPTools([...])
+ *   .withHooks([...])
+ *   .withWorkers([...])
+ *   .build();
+ *
+ * // Register with the default registry
+ * await getDefaultRegistry().register(myPlugin);
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+// ============================================================================
+// Core Types
+// ============================================================================
+
+export * from './types/index.js';
+
+// ============================================================================
+// Plugin Interface & Base
+// ============================================================================
+
+export {
+  type IPlugin,
+  type PluginFactory,
+  type PluginModule,
+  type PluginEvent,
+  validatePlugin,
+  validatePluginMetadata,
+  PLUGIN_EVENTS,
+} from './core/plugin-interface.js';
+
+export {
+  BasePlugin,
+  createSimplePlugin,
+  type SimplePluginConfig,
+} from './core/base-plugin.js';
+
+// ============================================================================
+// Plugin Registry
+// ============================================================================
+
+export {
+  PluginRegistry,
+  getDefaultRegistry,
+  setDefaultRegistry,
+  type PluginRegistryConfig,
+  type PluginEntry,
+  type RegistryStats,
+} from './registry/plugin-registry.js';
+
+// ============================================================================
+// Enhanced Plugin Registry (v2)
+// ============================================================================
+
+export {
+  EnhancedPluginRegistry,
+  getDefaultEnhancedRegistry,
+  setDefaultEnhancedRegistry,
+  type EnhancedPluginRegistryConfig,
+  type InitializationStrategy,
+  type ConflictStrategy,
+  type ConflictResolution,
+  type UnregisterOptions,
+  type HotReloadOptions,
+  type ServiceMetadata,
+} from './registry/enhanced-plugin-registry.js';
+
+// ============================================================================
+// Dependency Graph
+// ============================================================================
+
+export {
+  DependencyGraph,
+  parseVersion,
+  compareVersions,
+  satisfiesVersion,
+  type PluginDependency,
+  type DependencyNode,
+  type DependencyError,
+} from './registry/dependency-graph.js';
+
+// ============================================================================
+// Plugin Collections
+// ============================================================================
+
+export {
+  // Collection Manager
+  PluginCollectionManager,
+  getDefaultCollectionManager,
+  setDefaultCollectionManager,
+  type PluginCollection,
+  type PluginCollectionEntry,
+  type PluginCategory,
+  type PluginCapability,
+  type CollectionManagerState,
+  type CollectionManagerConfig,
+  type CollectionStats,
+
+  // Official Plugins
+  sessionPlugin,
+  memoryCoordinatorPlugin,
+  eventBusPlugin,
+  coderAgentPlugin,
+  testerAgentPlugin,
+  reviewerAgentPlugin,
+  gitIntegrationPlugin,
+  linterPlugin,
+  sonaPlugin,
+  reasoningBankPlugin,
+  patternLearningPlugin,
+  hiveMindPlugin,
+  maestroPlugin,
+  consensusPlugin,
+  coordinatorAgentPlugin,
+  inputValidationPlugin,
+  pathSecurityPlugin,
+  auditLogPlugin,
+  securityScanPlugin,
+  metricsPlugin,
+  cachePlugin,
+
+  // Official Collections
+  coreCollection,
+  developmentCollection,
+  intelligenceCollection,
+  swarmCollection,
+  securityCollection,
+  utilityCollection,
+  officialCollections,
+
+  // Helpers
+  getAllOfficialPlugins,
+  getOfficialCollection,
+} from './collections/index.js';
+
+// ============================================================================
+// SDK Builders
+// ============================================================================
+
+export {
+  PluginBuilder,
+  MCPToolBuilder,
+  HookBuilder,
+  WorkerBuilder,
+  createToolPlugin,
+  createHooksPlugin,
+  createWorkerPlugin,
+  createProviderPlugin,
+} from './sdk/index.js';
+
+// ============================================================================
+// Workers
+// ============================================================================
+
+export {
+  WorkerPool,
+  WorkerInstance,
+  WorkerFactory,
+  WORKER_EVENTS,
+  type IWorkerPool,
+  type IWorkerInstance,
+  type WorkerTask,
+  type WorkerTaskResult,
+  type WorkerPoolConfig,
+  type PoolMetrics,
+  type WorkerEvent,
+} from './workers/index.js';
+
+// ============================================================================
+// Hooks
+// ============================================================================
+
+export {
+  HookRegistry,
+  HookBuilder as HookBuilderAdvanced,
+  HookFactory,
+  HookExecutor,
+  HookEvent,
+  HookPriority,
+  type HookRegistryConfig,
+  type HookEntry,
+  type HookRegistryStats,
+} from './hooks/index.js';
+
+// ============================================================================
+// Providers
+// ============================================================================
+
+export {
+  ProviderRegistry,
+  BaseLLMProvider,
+  ProviderFactory,
+  PROVIDER_EVENTS,
+  type ILLMProvider,
+  type RateLimitStatus,
+  type ProviderRegistryConfig,
+  type ProviderEntry,
+  type ProviderRegistryStats,
+  type RetryConfig,
+  type ProviderEvent,
+} from './providers/index.js';
+
+// ============================================================================
+// Integrations
+// ============================================================================
+
+export {
+  // Agentic Flow
+  AgenticFlowBridge,
+  getAgenticFlowBridge,
+  AGENTIC_FLOW_EVENTS,
+  type AgenticFlowConfig,
+  type SwarmTopology,
+  type AgentSpawnOptions,
+  type SpawnedAgent,
+  type TaskOrchestrationOptions,
+  type OrchestrationResult,
+  type AgenticFlowEvent,
+  // AgentDB
+  AgentDBBridge,
+  getAgentDBBridge,
+  resetBridges,
+  type AgentDBConfig,
+  type VectorEntry,
+  type VectorSearchOptions,
+  type VectorSearchResult,
+} from './integrations/index.js';
+
+// ============================================================================
+// Security
+// ============================================================================
+
+export {
+  Security,
+  validateString,
+  validateNumber,
+  validateBoolean,
+  validateArray,
+  validateEnum,
+  validatePath,
+  validateCommand,
+  safePath,
+  safePathAsync,
+  safeJsonParse,
+  safeJsonStringify,
+  escapeShellArg,
+  sanitizeError,
+  sanitizeErrorMessage,
+  createRateLimiter,
+  createResourceLimiter,
+  generateSecureId,
+  generateSecureToken,
+  hashString,
+  constantTimeCompare,
+  type RateLimiter,
+  type ResourceLimits,
+} from './security/index.js';
+
+// ============================================================================
+// Version
+// ============================================================================
+
+export const VERSION = '3.0.0-alpha.1';
+export const SDK_VERSION = '1.0.0';
+
+// ============================================================================
+// Quick Start Utilities
+// ============================================================================
+
+import { PluginBuilder } from './sdk/index.js';
+import { getDefaultRegistry } from './registry/plugin-registry.js';
+import type { IPlugin, PluginFactory } from './core/plugin-interface.js';
+import type { PluginConfig } from './types/index.js';
+
+/**
+ * Quick start: Create and register a plugin in one call.
+ *
+ * @example
+ * ```typescript
+ * const plugin = await quickPlugin('my-plugin', '1.0.0', (builder) => {
+ *   builder
+ *     .withDescription('Quick plugin')
+ *     .withMCPTools([...]);
+ * });
+ * ```
+ */
+export async function quickPlugin(
+  name: string,
+  version: string,
+  configure: (builder: PluginBuilder) => void,
+  config?: Partial<PluginConfig>
+): Promise<IPlugin> {
+  const builder = new PluginBuilder(name, version);
+  configure(builder);
+  return builder.buildAndRegister(config);
+}
+
+/**
+ * Load and register a plugin module dynamically.
+ *
+ * @example
+ * ```typescript
+ * const plugin = await loadPlugin('./my-plugin.js');
+ * ```
+ */
+export async function loadPlugin(
+  modulePath: string,
+  config?: Partial<PluginConfig>
+): Promise<IPlugin> {
+  const module = await import(modulePath);
+  const pluginOrFactory: IPlugin | PluginFactory = module.default ?? module.plugin;
+
+  if (!pluginOrFactory) {
+    throw new Error(`Module ${modulePath} does not export a plugin`);
+  }
+
+  const plugin = typeof pluginOrFactory === 'function'
+    ? await pluginOrFactory()
+    : pluginOrFactory;
+
+  await getDefaultRegistry().register(plugin, config);
+  return plugin;
+}
+
+/**
+ * Initialize the plugin system.
+ *
+ * @example
+ * ```typescript
+ * await initializePlugins({
+ *   coreVersion: '3.0.0',
+ *   dataDir: './data',
+ * });
+ * ```
+ */
+export async function initializePlugins(_options?: {
+  coreVersion?: string;
+  dataDir?: string;
+}): Promise<void> {
+  const registry = getDefaultRegistry();
+  await registry.initialize();
+}
+
+/**
+ * Shutdown the plugin system.
+ */
+export async function shutdownPlugins(): Promise<void> {
+  const registry = getDefaultRegistry();
+  await registry.shutdown();
+}