claude-flow 3.28.0 → 3.30.0

package/v3/@claude-flow/shared/README.md

@@ -1,323 +1,323 @@
-# @claude-flow/shared
-
-[![npm version](https://img.shields.io/npm/v/@claude-flow/shared.svg)](https://www.npmjs.com/package/@claude-flow/shared)
-[![npm downloads](https://img.shields.io/npm/dm/@claude-flow/shared.svg)](https://www.npmjs.com/package/@claude-flow/shared)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
-[![Core](https://img.shields.io/badge/Module-Core-blue.svg)](https://github.com/ruvnet/claude-flow)
-
-> Shared utilities, types, and core infrastructure for Claude Flow V3 - the foundation module used by all other @claude-flow packages.
-
-## Features
-
-- **Core Types** - Agent, Task, Memory, MCP, and Swarm type definitions
-- **Core Interfaces** - Agent, Task, Memory, Event, and Coordinator interfaces
-- **Configuration** - Schema validation, loading, and default values
-- **Event System** - Event bus, coordinator, and handler utilities
-- **Hooks System** - Pre/post execution hooks for extensibility
-- **MCP Infrastructure** - Server, transport, connection pool, and tool registry
-- **Health Monitoring** - Health checks and monitoring utilities
-
-## Installation
-
-```bash
-npm install @claude-flow/shared
-```
-
-## Quick Start
-
-```typescript
-import {
-  AgentState,
-  TaskDefinition,
-  MemoryEntry,
-  EventBus,
-  ConfigLoader
-} from '@claude-flow/shared';
-
-// Use shared types
-const agent: AgentState = {
-  id: { id: 'agent-1', swarmId: 'swarm-1', type: 'coder' },
-  name: 'Code Agent',
-  type: 'coder',
-  status: 'idle'
-};
-
-// Use configuration
-const config = await ConfigLoader.load('./config.json');
-
-// Use event system
-const eventBus = new EventBus();
-eventBus.on('task.completed', (event) => {
-  console.log(`Task ${event.taskId} completed`);
-});
-```
-
-## Package Exports
-
-```typescript
-// Main entry (recommended - includes all modules)
-import { ... } from '@claude-flow/shared';
-
-// Submodule exports (for tree-shaking or specific imports)
-import { ... } from '@claude-flow/shared/types';      // Type definitions
-import { ... } from '@claude-flow/shared/core';       // Config, interfaces, orchestrator
-import { ... } from '@claude-flow/shared/events';     // Event sourcing (ADR-007)
-import { ... } from '@claude-flow/shared/hooks';      // Hooks system
-import { ... } from '@claude-flow/shared/mcp';        // MCP server infrastructure
-import { ... } from '@claude-flow/shared/security';   // Security utilities
-import { ... } from '@claude-flow/shared/resilience'; // Retry, circuit breaker, rate limiter
-```
-
-## API Reference
-
-### Types
-
-```typescript
-import type {
-  // Agent types
-  AgentId,
-  AgentState,
-  AgentType,
-  AgentStatus,
-  AgentCapabilities,
-  AgentMetrics,
-
-  // Task types
-  TaskId,
-  TaskDefinition,
-  TaskType,
-  TaskStatus,
-  TaskPriority,
-
-  // Memory types
-  MemoryEntry,
-  MemoryType,
-  SearchResult,
-
-  // Swarm types
-  SwarmId,
-  SwarmStatus,
-  SwarmEvent,
-  CoordinatorConfig,
-
-  // MCP types
-  MCPTool,
-  MCPRequest,
-  MCPResponse
-} from '@claude-flow/shared/types';
-```
-
-### Core Interfaces
-
-```typescript
-import type {
-  IAgent,
-  ITask,
-  IMemory,
-  ICoordinator,
-  IEventHandler
-} from '@claude-flow/shared/core';
-
-// Agent interface
-interface IAgent {
-  getId(): AgentId;
-  getState(): AgentState;
-  execute(task: TaskDefinition): Promise<TaskResult>;
-  handleMessage(message: Message): Promise<void>;
-}
-
-// Memory interface
-interface IMemory {
-  store(entry: MemoryEntry): Promise<string>;
-  retrieve(id: string): Promise<MemoryEntry | null>;
-  search(query: SearchQuery): Promise<SearchResult[]>;
-  delete(id: string): Promise<boolean>;
-}
-
-// Coordinator interface
-interface ICoordinator {
-  initialize(): Promise<void>;
-  shutdown(): Promise<void>;
-  registerAgent(agent: IAgent): Promise<string>;
-  submitTask(task: TaskDefinition): Promise<string>;
-}
-```
-
-### Configuration
-
-```typescript
-import {
-  ConfigLoader,
-  ConfigValidator,
-  defaultConfig,
-  ConfigSchema
-} from '@claude-flow/shared/core';
-
-// Load configuration
-const config = await ConfigLoader.load('./config.json');
-const config2 = await ConfigLoader.loadFromEnv();
-
-// Validate configuration
-const errors = ConfigValidator.validate(config);
-if (errors.length > 0) {
-  console.error('Invalid config:', errors);
-}
-
-// Default configuration
-const defaults = defaultConfig();
-```
-
-### Event System
-
-```typescript
-import { EventBus, EventCoordinator } from '@claude-flow/shared/events';
-
-const eventBus = new EventBus();
-
-// Subscribe to events
-eventBus.on('agent.joined', (event) => {
-  console.log(`Agent ${event.agentId} joined`);
-});
-
-eventBus.on('task.*', (event) => {
-  console.log(`Task event: ${event.type}`);
-});
-
-// Emit events
-eventBus.emit({
-  type: 'task.completed',
-  taskId: 'task-1',
-  result: { success: true }
-});
-
-// Event coordinator for complex workflows
-const coordinator = new EventCoordinator();
-coordinator.orchestrate([
-  { event: 'step1.done', handler: () => startStep2() },
-  { event: 'step2.done', handler: () => startStep3() }
-]);
-```
-
-### Hooks System
-
-```typescript
-import { HooksManager, Hook } from '@claude-flow/shared/hooks';
-
-const hooks = new HooksManager();
-
-// Register pre-execution hook
-hooks.register('pre:task', async (context) => {
-  console.log(`Starting task: ${context.taskId}`);
-  return { ...context, startTime: Date.now() };
-});
-
-// Register post-execution hook
-hooks.register('post:task', async (context, result) => {
-  const duration = Date.now() - context.startTime;
-  console.log(`Task completed in ${duration}ms`);
-});
-
-// Execute with hooks
-const result = await hooks.execute('task', context, async (ctx) => {
-  return await runTask(ctx);
-});
-```
-
-### MCP Infrastructure
-
-```typescript
-import {
-  createMCPServer,
-  createToolRegistry,
-  createConnectionPool,
-  createSessionManager,
-  defineTool,
-  quickStart,
-} from '@claude-flow/shared/mcp';
-
-// Quick start - simplest way to create an MCP server
-const server = await quickStart({
-  transport: 'stdio',
-  name: 'My MCP Server',
-});
-
-// Tool registry
-const registry = createToolRegistry();
-registry.register(defineTool({
-  name: 'swarm_init',
-  description: 'Initialize a swarm',
-  inputSchema: { type: 'object', properties: { topology: { type: 'string' } } },
-  handler: async (params) => ({ result: 'initialized' }),
-}));
-
-// Connection pool
-const pool = createConnectionPool({
-  maxConnections: 10,
-  acquireTimeoutMs: 30000,
-});
-
-// Session manager
-const sessions = createSessionManager({ timeoutMs: 3600000 });
-const session = await sessions.create({ clientInfo: { name: 'client' } });
-```
-
-### Health Monitor
-
-```typescript
-import { HealthMonitor, HealthCheck } from '@claude-flow/shared/core';
-
-const monitor = new HealthMonitor();
-
-// Register health checks
-monitor.register('database', async () => {
-  const connected = await db.ping();
-  return { healthy: connected, latency: pingTime };
-});
-
-monitor.register('memory', async () => {
-  const usage = process.memoryUsage();
-  return { healthy: usage.heapUsed < MAX_HEAP, usage };
-});
-
-// Run health checks
-const report = await monitor.check();
-// { overall: 'healthy', checks: { database: {...}, memory: {...} } }
-```
-
-## TypeScript Types
-
-All types are fully exported and documented:
-
-```typescript
-// Re-export all types
-export * from './types/agent.types';
-export * from './types/task.types';
-export * from './types/memory.types';
-export * from './types/swarm.types';
-export * from './types/mcp.types';
-```
-
-## Dependencies
-
-- `sql.js` - SQLite WASM for cross-platform persistence
-
-## Used By
-
-This package is a dependency of all other @claude-flow modules:
-
-- [@claude-flow/cli](../cli) - CLI module
-- [@claude-flow/security](../security) - Security & validation
-- [@claude-flow/memory](../memory) - AgentDB & HNSW indexing
-- [@claude-flow/neural](../neural) - SONA learning & RL algorithms
-- [@claude-flow/performance](../performance) - Benchmarking & optimization
-- [@claude-flow/swarm](../swarm) - 15-agent coordination
-- [@claude-flow/integration](../integration) - agentic-flow@alpha bridge
-- [@claude-flow/testing](../testing) - TDD framework & fixtures
-- [@claude-flow/deployment](../deployment) - Release management
-- [@claude-flow/embeddings](../embeddings) - Embedding service
-- [@claude-flow/hooks](../hooks) - Hooks system
-
-## License
-
-MIT
+# @claude-flow/shared
+
+[![npm version](https://img.shields.io/npm/v/@claude-flow/shared.svg)](https://www.npmjs.com/package/@claude-flow/shared)
+[![npm downloads](https://img.shields.io/npm/dm/@claude-flow/shared.svg)](https://www.npmjs.com/package/@claude-flow/shared)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
+[![Core](https://img.shields.io/badge/Module-Core-blue.svg)](https://github.com/ruvnet/claude-flow)
+
+> Shared utilities, types, and core infrastructure for Claude Flow V3 - the foundation module used by all other @claude-flow packages.
+
+## Features
+
+- **Core Types** - Agent, Task, Memory, MCP, and Swarm type definitions
+- **Core Interfaces** - Agent, Task, Memory, Event, and Coordinator interfaces
+- **Configuration** - Schema validation, loading, and default values
+- **Event System** - Event bus, coordinator, and handler utilities
+- **Hooks System** - Pre/post execution hooks for extensibility
+- **MCP Infrastructure** - Server, transport, connection pool, and tool registry
+- **Health Monitoring** - Health checks and monitoring utilities
+
+## Installation
+
+```bash
+npm install @claude-flow/shared
+```
+
+## Quick Start
+
+```typescript
+import {
+  AgentState,
+  TaskDefinition,
+  MemoryEntry,
+  EventBus,
+  ConfigLoader
+} from '@claude-flow/shared';
+
+// Use shared types
+const agent: AgentState = {
+  id: { id: 'agent-1', swarmId: 'swarm-1', type: 'coder' },
+  name: 'Code Agent',
+  type: 'coder',
+  status: 'idle'
+};
+
+// Use configuration
+const config = await ConfigLoader.load('./config.json');
+
+// Use event system
+const eventBus = new EventBus();
+eventBus.on('task.completed', (event) => {
+  console.log(`Task ${event.taskId} completed`);
+});
+```
+
+## Package Exports
+
+```typescript
+// Main entry (recommended - includes all modules)
+import { ... } from '@claude-flow/shared';
+
+// Submodule exports (for tree-shaking or specific imports)
+import { ... } from '@claude-flow/shared/types';      // Type definitions
+import { ... } from '@claude-flow/shared/core';       // Config, interfaces, orchestrator
+import { ... } from '@claude-flow/shared/events';     // Event sourcing (ADR-007)
+import { ... } from '@claude-flow/shared/hooks';      // Hooks system
+import { ... } from '@claude-flow/shared/mcp';        // MCP server infrastructure
+import { ... } from '@claude-flow/shared/security';   // Security utilities
+import { ... } from '@claude-flow/shared/resilience'; // Retry, circuit breaker, rate limiter
+```
+
+## API Reference
+
+### Types
+
+```typescript
+import type {
+  // Agent types
+  AgentId,
+  AgentState,
+  AgentType,
+  AgentStatus,
+  AgentCapabilities,
+  AgentMetrics,
+
+  // Task types
+  TaskId,
+  TaskDefinition,
+  TaskType,
+  TaskStatus,
+  TaskPriority,
+
+  // Memory types
+  MemoryEntry,
+  MemoryType,
+  SearchResult,
+
+  // Swarm types
+  SwarmId,
+  SwarmStatus,
+  SwarmEvent,
+  CoordinatorConfig,
+
+  // MCP types
+  MCPTool,
+  MCPRequest,
+  MCPResponse
+} from '@claude-flow/shared/types';
+```
+
+### Core Interfaces
+
+```typescript
+import type {
+  IAgent,
+  ITask,
+  IMemory,
+  ICoordinator,
+  IEventHandler
+} from '@claude-flow/shared/core';
+
+// Agent interface
+interface IAgent {
+  getId(): AgentId;
+  getState(): AgentState;
+  execute(task: TaskDefinition): Promise<TaskResult>;
+  handleMessage(message: Message): Promise<void>;
+}
+
+// Memory interface
+interface IMemory {
+  store(entry: MemoryEntry): Promise<string>;
+  retrieve(id: string): Promise<MemoryEntry | null>;
+  search(query: SearchQuery): Promise<SearchResult[]>;
+  delete(id: string): Promise<boolean>;
+}
+
+// Coordinator interface
+interface ICoordinator {
+  initialize(): Promise<void>;
+  shutdown(): Promise<void>;
+  registerAgent(agent: IAgent): Promise<string>;
+  submitTask(task: TaskDefinition): Promise<string>;
+}
+```
+
+### Configuration
+
+```typescript
+import {
+  ConfigLoader,
+  ConfigValidator,
+  defaultConfig,
+  ConfigSchema
+} from '@claude-flow/shared/core';
+
+// Load configuration
+const config = await ConfigLoader.load('./config.json');
+const config2 = await ConfigLoader.loadFromEnv();
+
+// Validate configuration
+const errors = ConfigValidator.validate(config);
+if (errors.length > 0) {
+  console.error('Invalid config:', errors);
+}
+
+// Default configuration
+const defaults = defaultConfig();
+```
+
+### Event System
+
+```typescript
+import { EventBus, EventCoordinator } from '@claude-flow/shared/events';
+
+const eventBus = new EventBus();
+
+// Subscribe to events
+eventBus.on('agent.joined', (event) => {
+  console.log(`Agent ${event.agentId} joined`);
+});
+
+eventBus.on('task.*', (event) => {
+  console.log(`Task event: ${event.type}`);
+});
+
+// Emit events
+eventBus.emit({
+  type: 'task.completed',
+  taskId: 'task-1',
+  result: { success: true }
+});
+
+// Event coordinator for complex workflows
+const coordinator = new EventCoordinator();
+coordinator.orchestrate([
+  { event: 'step1.done', handler: () => startStep2() },
+  { event: 'step2.done', handler: () => startStep3() }
+]);
+```
+
+### Hooks System
+
+```typescript
+import { HooksManager, Hook } from '@claude-flow/shared/hooks';
+
+const hooks = new HooksManager();
+
+// Register pre-execution hook
+hooks.register('pre:task', async (context) => {
+  console.log(`Starting task: ${context.taskId}`);
+  return { ...context, startTime: Date.now() };
+});
+
+// Register post-execution hook
+hooks.register('post:task', async (context, result) => {
+  const duration = Date.now() - context.startTime;
+  console.log(`Task completed in ${duration}ms`);
+});
+
+// Execute with hooks
+const result = await hooks.execute('task', context, async (ctx) => {
+  return await runTask(ctx);
+});
+```
+
+### MCP Infrastructure
+
+```typescript
+import {
+  createMCPServer,
+  createToolRegistry,
+  createConnectionPool,
+  createSessionManager,
+  defineTool,
+  quickStart,
+} from '@claude-flow/shared/mcp';
+
+// Quick start - simplest way to create an MCP server
+const server = await quickStart({
+  transport: 'stdio',
+  name: 'My MCP Server',
+});
+
+// Tool registry
+const registry = createToolRegistry();
+registry.register(defineTool({
+  name: 'swarm_init',
+  description: 'Initialize a swarm',
+  inputSchema: { type: 'object', properties: { topology: { type: 'string' } } },
+  handler: async (params) => ({ result: 'initialized' }),
+}));
+
+// Connection pool
+const pool = createConnectionPool({
+  maxConnections: 10,
+  acquireTimeoutMs: 30000,
+});
+
+// Session manager
+const sessions = createSessionManager({ timeoutMs: 3600000 });
+const session = await sessions.create({ clientInfo: { name: 'client' } });
+```
+
+### Health Monitor
+
+```typescript
+import { HealthMonitor, HealthCheck } from '@claude-flow/shared/core';
+
+const monitor = new HealthMonitor();
+
+// Register health checks
+monitor.register('database', async () => {
+  const connected = await db.ping();
+  return { healthy: connected, latency: pingTime };
+});
+
+monitor.register('memory', async () => {
+  const usage = process.memoryUsage();
+  return { healthy: usage.heapUsed < MAX_HEAP, usage };
+});
+
+// Run health checks
+const report = await monitor.check();
+// { overall: 'healthy', checks: { database: {...}, memory: {...} } }
+```
+
+## TypeScript Types
+
+All types are fully exported and documented:
+
+```typescript
+// Re-export all types
+export * from './types/agent.types';
+export * from './types/task.types';
+export * from './types/memory.types';
+export * from './types/swarm.types';
+export * from './types/mcp.types';
+```
+
+## Dependencies
+
+- `sql.js` - SQLite WASM for cross-platform persistence
+
+## Used By
+
+This package is a dependency of all other @claude-flow modules:
+
+- [@claude-flow/cli](../cli) - CLI module
+- [@claude-flow/security](../security) - Security & validation
+- [@claude-flow/memory](../memory) - AgentDB & HNSW indexing
+- [@claude-flow/neural](../neural) - SONA learning & RL algorithms
+- [@claude-flow/performance](../performance) - Benchmarking & optimization
+- [@claude-flow/swarm](../swarm) - 15-agent coordination
+- [@claude-flow/integration](../integration) - agentic-flow@alpha bridge
+- [@claude-flow/testing](../testing) - TDD framework & fixtures
+- [@claude-flow/deployment](../deployment) - Release management
+- [@claude-flow/embeddings](../embeddings) - Embedding service
+- [@claude-flow/hooks](../hooks) - Hooks system
+
+## License
+
+MIT