@splashcodex/api-key-manager 4.1.0 → 5.0.0

package/src/index.ts

@@ -1,13 +1,31 @@
 /**
- * Universal ApiKeyManager v4.0 — Mastermind Edition
+ * Universal ApiKeyManager v5.0 — Ecosystem Edition
  * Implements: Rotation, Circuit Breaker, Persistence, Exponential Backoff, Strategies,
  *             Event Emitter, Fallback, execute(), Timeout, Auto-Retry, Provider Tags,
  *             Health Checks, Bulkhead/Concurrency
+ * NEW in v5.0: Provider Presets (GeminiManager, OpenAIManager, MultiManager),
+ *              Built-in Persistence (FileStorage, MemoryStorage)
  * Gemini-Specific: finishReason handling, Safety blocks, RECITATION detection
  */
 
 import { EventEmitter } from 'events';
 
+// ─── Re-exports: Persistence ─────────────────────────────────────────────────
+// Persistence adapters can be imported from root or via subpath
+export { FileStorage } from './persistence/file';
+export type { FileStorageOptions } from './persistence/file';
+export { MemoryStorage } from './persistence/memory';
+
+// ─── Presets ─────────────────────────────────────────────────────────────────
+// Presets are available via subpath imports to avoid circular dependencies:
+//   import { GeminiManager } from '@splashcodex/api-key-manager/presets/gemini';
+//   import { OpenAIManager } from '@splashcodex/api-key-manager/presets/openai';
+//   import { MultiManager } from '@splashcodex/api-key-manager/presets/multi';
+// Or import all at once:
+//   import { GeminiManager, OpenAIManager, MultiManager } from '@splashcodex/api-key-manager/presets';
+
+
+
 // ─── Interfaces & Types ──────────────────────────────────────────────────────
 
 export interface KeyState {
@@ -185,12 +203,15 @@ export class WeightedStrategy implements LoadBalancingStrategy {
 }
 
 /**
- * Latency Strategy: Pick lowest average latency
+ * Latency Strategy: Pick lowest average latency with LRU tie-break
  */
 export class LatencyStrategy implements LoadBalancingStrategy {
     next(candidates: KeyState[]): KeyState | null {
         if (candidates.length === 0) return null;
-        candidates.sort((a, b) => a.averageLatency - b.averageLatency);
+        candidates.sort((a, b) => {
+            if (a.averageLatency !== b.averageLatency) return a.averageLatency - b.averageLatency;
+            return a.lastUsed - b.lastUsed; // LRU tie-break
+        });
         return candidates[0];
     }
 }

package/src/persistence/file.ts

@@ -0,0 +1,89 @@
+/**
+ * File-Based Storage Adapter
+ *
+ * Persists API key state to a JSON file on disk.
+ * Survives process restarts so keys don't reset to CLOSED
+ * when an app reboots.
+ *
+ * Extracted from the proven WhatsDeX adapter pattern.
+ *
+ * @module persistence/file
+ */
+
+import { writeFileSync, readFileSync, existsSync, mkdirSync, unlinkSync } from 'fs';
+import { dirname, join } from 'path';
+import { tmpdir } from 'os';
+
+export interface FileStorageOptions {
+    /** Full path to the state file. Defaults to `os.tmpdir()/codedex_api_key_state.json` */
+    filePath?: string;
+    /** If true, clears any existing state file on construction (fresh start). Default: true */
+    clearOnInit?: boolean;
+}
+
+/**
+ * File-based storage adapter for ApiKeyManager.
+ *
+ * @example
+ * ```ts
+ * import { ApiKeyManager } from '@splashcodex/api-key-manager';
+ * import { FileStorage } from '@splashcodex/api-key-manager/persistence/file';
+ *
+ * const manager = new ApiKeyManager(keys, {
+ *   storage: new FileStorage({ filePath: './state.json' })
+ * });
+ * ```
+ */
+export class FileStorage {
+    private filePath: string;
+
+    constructor(options: FileStorageOptions = {}) {
+        this.filePath = options.filePath || join(tmpdir(), 'codedex_api_key_state.json');
+
+        if (options.clearOnInit !== false) {
+            this.clear();
+        }
+    }
+
+    getItem(_key: string): string | null {
+        try {
+            if (existsSync(this.filePath)) {
+                return readFileSync(this.filePath, 'utf-8');
+            }
+        } catch {
+            // Silently fail — state will be rebuilt from scratch
+        }
+        return null;
+    }
+
+    setItem(_key: string, value: string): void {
+        try {
+            const dir = dirname(this.filePath);
+            if (!existsSync(dir)) {
+                mkdirSync(dir, { recursive: true });
+            }
+            writeFileSync(this.filePath, value, 'utf-8');
+        } catch {
+            // Silently fail — state will be lost on restart
+        }
+    }
+
+    /**
+     * Delete the persisted state file.
+     * Useful for clearing stale dead-key states from a previous session.
+     */
+    clear(): void {
+        try {
+            if (existsSync(this.filePath)) {
+                unlinkSync(this.filePath);
+            }
+        } catch {
+            // Silently fail
+        }
+    }
+
+    /** Get the path to the state file (for debugging/logging) */
+    getFilePath(): string {
+        return this.filePath;
+    }
+}

package/src/persistence/index.ts

@@ -0,0 +1,7 @@
+/**
+ * Persistence Adapters
+ * @module persistence
+ */
+export { FileStorage } from './file';
+export type { FileStorageOptions } from './file';
+export { MemoryStorage } from './memory';

package/src/persistence/memory.ts

@@ -0,0 +1,43 @@
+/**
+ * In-Memory Storage Adapter
+ *
+ * Simple key-value storage that lives only for the process lifetime.
+ * Useful for testing, serverless functions, or when persistence isn't needed.
+ *
+ * @module persistence/memory
+ */
+
+/**
+ * In-memory storage adapter for ApiKeyManager.
+ *
+ * @example
+ * ```ts
+ * import { ApiKeyManager } from '@splashcodex/api-key-manager';
+ * import { MemoryStorage } from '@splashcodex/api-key-manager/persistence/memory';
+ *
+ * const manager = new ApiKeyManager(keys, {
+ *   storage: new MemoryStorage()
+ * });
+ * ```
+ */
+export class MemoryStorage {
+    private store: Map<string, string> = new Map();
+
+    getItem(key: string): string | null {
+        return this.store.get(key) ?? null;
+    }
+
+    setItem(key: string, value: string): void {
+        this.store.set(key, value);
+    }
+
+    /** Clear all stored state */
+    clear(): void {
+        this.store.clear();
+    }
+
+    /** Get the number of stored entries */
+    get size(): number {
+        return this.store.size;
+    }
+}

package/src/presets/base.ts

@@ -0,0 +1,323 @@
+/**
+ * BasePreset — Shared foundation for all provider presets
+ *
+ * Provides the "batteries included" pattern:
+ * - Singleton lifecycle management
+ * - Environment variable parsing (single key or JSON array)
+ * - File-based persistence (survives restarts)
+ * - Event-to-logger wiring
+ * - Health check scheduling
+ * - Result<T> pattern for safe initialization
+ *
+ * @module presets/base
+ */
+
+import {
+    ApiKeyManager,
+    LatencyStrategy,
+    ExecuteOptions,
+    ApiKeyManagerOptions,
+    LoadBalancingStrategy,
+} from '../index';
+import { FileStorage } from '../persistence/file';
+import { join } from 'path';
+import { tmpdir } from 'os';
+
+// ─── Result Type ─────────────────────────────────────────────────────────────
+
+/**
+ * A discriminated union for safe error handling without exceptions.
+ * Used by `getInstance()` to avoid crashing on missing env vars.
+ */
+export type Result<T> =
+    | { success: true; data: T }
+    | { success: false; error: Error };
+
+// ─── Configuration ──────────────────────────────────────────────────────────
+
+export interface PresetOptions {
+    /** Environment variable name(s) to read API keys from. */
+    envKeys: string[];
+    /** Provider name for logging and file state isolation. Default: 'default' */
+    provider?: string;
+    /** Load balancing strategy. Default: LatencyStrategy */
+    strategy?: LoadBalancingStrategy;
+    /** Max concurrent execute() calls. Default: 20 */
+    concurrency?: number;
+    /** Health check interval in ms. Set to 0 to disable. Default: 300_000 (5 min) */
+    healthCheckIntervalMs?: number;
+    /** Custom health check function. If not set, health checks are disabled. */
+    healthCheckFn?: (key: string) => Promise<boolean>;
+    /** Semantic cache config. Optional. */
+    semanticCache?: ApiKeyManagerOptions['semanticCache'];
+    /** Custom logger. Defaults to console. */
+    logger?: PresetLogger;
+    /** Fallback function when all keys are exhausted. */
+    fallbackFn?: () => any;
+    /** Custom state file path. Defaults to `os.tmpdir()/codedex_{provider}_state.json` */
+    stateFilePath?: string;
+}
+
+export interface PresetLogger {
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+}
+
+// ─── Base Preset Class ──────────────────────────────────────────────────────
+
+/**
+ * Abstract base class for provider presets.
+ * Subclasses only need to define `getDefaultOptions()` with provider-specific
+ * defaults (env var name, health check function, etc.).
+ *
+ * @example
+ * ```ts
+ * // Creating a custom preset:
+ * class MyProviderPreset extends BasePreset {
+ *   protected static getDefaultOptions(): Partial<PresetOptions> {
+ *     return {
+ *       envKeys: ['MY_PROVIDER_API_KEY'],
+ *       provider: 'my-provider',
+ *     };
+ *   }
+ * }
+ * ```
+ */
+export abstract class BasePreset {
+    private static instances: Map<string, BasePreset> = new Map();
+
+    protected manager: ApiKeyManager;
+    protected logger: PresetLogger;
+    protected options: Required<Pick<PresetOptions, 'provider' | 'concurrency' | 'healthCheckIntervalMs'>> & PresetOptions;
+
+    protected constructor(apiKeys: string[], options: PresetOptions) {
+        this.logger = options.logger || console;
+
+        this.options = {
+            provider: options.provider || 'default',
+            concurrency: options.concurrency ?? 20,
+            healthCheckIntervalMs: options.healthCheckIntervalMs ?? 300_000,
+            ...options,
+        };
+
+        const stateFile = this.options.stateFilePath ||
+            join(tmpdir(), `codedex_${this.options.provider}_state.json`);
+
+        const storage = new FileStorage({
+            filePath: stateFile,
+            clearOnInit: true, // Fresh start each session to clear stale DEAD keys
+        });
+
+        this.manager = new ApiKeyManager(apiKeys, {
+            storage,
+            strategy: this.options.strategy || new LatencyStrategy(),
+            fallbackFn: this.options.fallbackFn,
+            concurrency: this.options.concurrency,
+            semanticCache: this.options.semanticCache,
+        });
+
+        this.wireEvents();
+
+        if (this.options.healthCheckFn && this.options.healthCheckIntervalMs > 0) {
+            this.manager.setHealthCheck(this.options.healthCheckFn);
+            this.manager.startHealthChecks(this.options.healthCheckIntervalMs);
+        }
+
+        this.logger.info(
+            `[${this.options.provider}] ApiKeyManager initialized with ${apiKeys.length} keys ` +
+            `(Strategy: ${this.options.strategy?.constructor.name || 'LatencyStrategy'}, ` +
+            `Concurrency: ${this.options.concurrency}, ` +
+            `HealthChecks: ${this.options.healthCheckIntervalMs > 0 ? `every ${this.options.healthCheckIntervalMs / 1000}s` : 'disabled'})`
+        );
+    }
+
+    /**
+     * Wire all manager events to the logger.
+     */
+    private wireEvents(): void {
+        const tag = this.options.provider;
+        this.manager.on('keyDead', (key) =>
+            this.logger.error(`[${tag}] Key PERMANENTLY DEAD: ...${key.slice(-4)}`));
+        this.manager.on('circuitOpen', (key) =>
+            this.logger.warn(`[${tag}] Circuit OPEN (cooldown): ...${key.slice(-4)}`));
+        this.manager.on('keyRecovered', (key) =>
+            this.logger.info(`[${tag}] Key RECOVERED: ...${key.slice(-4)}`));
+        this.manager.on('retry', (key, attempt, delay) =>
+            this.logger.info(`[${tag}] Retry with ...${key.slice(-4)} (Attempt ${attempt}, Delay ${delay}ms)`));
+        this.manager.on('fallback', (reason) =>
+            this.logger.warn(`[${tag}] Triggering FALLBACK: ${reason}`));
+        this.manager.on('allKeysExhausted', () =>
+            this.logger.error(`[${tag}] ALL KEYS EXHAUSTED! No fallback available.`));
+        this.manager.on('bulkheadRejected', () =>
+            this.logger.warn(`[${tag}] Bulkhead rejected request (concurrency limit reached)`));
+        this.manager.on('healthCheckPassed', (key) =>
+            this.logger.info(`[${tag}] Health check PASSED: ...${key.slice(-4)}`));
+        this.manager.on('healthCheckFailed', (key) =>
+            this.logger.warn(`[${tag}] Health check FAILED: ...${key.slice(-4)}`));
+    }
+
+    // ─── Public API ─────────────────────────────────────────────────────────
+
+    /**
+     * Execute a function with automatic key rotation, retries, timeout, and caching.
+     */
+    async execute<T>(
+        fn: (key: string, signal?: AbortSignal) => Promise<T>,
+        options?: ExecuteOptions & { prompt?: string }
+    ): Promise<T> {
+        return this.manager.execute(fn, options);
+    }
+
+    /**
+     * Execute a streaming function with retry on initial connection failure.
+     */
+    async *executeStream<T>(
+        fn: (key: string, signal?: AbortSignal) => AsyncGenerator<T, any, unknown>,
+        options?: ExecuteOptions & { prompt?: string }
+    ): AsyncGenerator<T, any, unknown> {
+        yield* this.manager.executeStream(fn, options);
+    }
+
+    /**
+     * Get the best available API key directly (low-level).
+     */
+    getKey(): string | null {
+        return this.manager.getKey();
+    }
+
+    /**
+     * Get the number of non-dead keys.
+     */
+    getKeyCount(): number {
+        return this.manager.getKeyCount();
+    }
+
+    /**
+     * Get pool health statistics.
+     */
+    getStats() {
+        return this.manager.getStats();
+    }
+
+    /**
+     * Get the underlying ApiKeyManager instance for advanced use.
+     */
+    getManager(): ApiKeyManager {
+        return this.manager;
+    }
+
+    /**
+     * Stop health checks and clean up. Call when shutting down.
+     */
+    destroy(): void {
+        this.manager.stopHealthChecks();
+    }
+
+    // ─── Static Factory ─────────────────────────────────────────────────────
+
+    /**
+     * Parse API keys from environment variables.
+     * Supports:
+     * - Single key: `"AIza..."`
+     * - JSON array: `'["AIza...", "AIzb..."]'`
+     * - Comma-separated: `"AIza...,AIzb..."`
+     */
+    protected static parseKeysFromEnv(envKeys: string[]): string[] {
+        const keys: string[] = [];
+
+        for (const envName of envKeys) {
+            const envValue = process.env[envName];
+            if (!envValue) continue;
+
+            const trimmed = envValue.trim();
+            if (!trimmed) continue;
+
+            // Try JSON array
+            if (trimmed.startsWith('[')) {
+                try {
+                    const parsed = JSON.parse(trimmed);
+                    if (Array.isArray(parsed)) {
+                        keys.push(...parsed.filter((k: any) => typeof k === 'string' && k.trim()));
+                        continue;
+                    }
+                } catch {
+                    // Not valid JSON, fall through to comma split
+                }
+            }
+
+            // Comma-separated or single key
+            keys.push(...trimmed.split(',').map(k => k.trim()).filter(k => k.length > 0));
+        }
+
+        return [...new Set(keys)]; // Deduplicate
+    }
+
+    /**
+     * Get or create the singleton instance for a preset.
+     * This is the core factory used by all preset subclasses.
+     *
+     * @param PresetClass - The preset class to instantiate
+     * @param overrides - Optional overrides for preset options
+     * @returns Result<T> — either `{ success: true, data: instance }` or `{ success: false, error }`
+     */
+    protected static createInstance<T extends BasePreset>(
+        PresetClass: new (keys: string[], options: PresetOptions) => T,
+        defaultOptions: Partial<PresetOptions>,
+        overrides?: Partial<PresetOptions>
+    ): Result<T> {
+        const mergedOptions = { ...defaultOptions, ...overrides } as PresetOptions;
+        const instanceKey = mergedOptions.provider || PresetClass.name;
+
+        // Return existing singleton
+        const existing = BasePreset.instances.get(instanceKey);
+        if (existing) {
+            return { success: true, data: existing as T };
+        }
+
+        // Parse keys
+        const envKeys = mergedOptions.envKeys || [];
+        const keys = BasePreset.parseKeysFromEnv(envKeys);
+
+        if (keys.length === 0) {
+            const logger = mergedOptions.logger || console;
+            logger.warn(
+                `[${instanceKey}] No API keys found in env vars: ${envKeys.join(', ')}. ` +
+                `AI features will be disabled.`
+            );
+            // Still create the instance with empty keys — allows graceful degradation
+        }
+
+        try {
+            const instance = new PresetClass(keys, mergedOptions);
+            BasePreset.instances.set(instanceKey, instance);
+            return { success: true, data: instance };
+        } catch (error) {
+            return {
+                success: false,
+                error: error instanceof Error ? error : new Error(String(error)),
+            };
+        }
+    }
+
+    /**
+     * Reset a singleton instance (primarily for testing).
+     */
+    protected static resetInstance(provider: string): void {
+        const existing = BasePreset.instances.get(provider);
+        if (existing) {
+            existing.destroy();
+            BasePreset.instances.delete(provider);
+        }
+    }
+
+    /**
+     * Reset ALL singleton instances (primarily for testing).
+     */
+    static resetAll(): void {
+        for (const [, instance] of BasePreset.instances) {
+            instance.destroy();
+        }
+        BasePreset.instances.clear();
+    }
+}

package/src/presets/gemini.ts

@@ -0,0 +1,84 @@
+/**
+ * Gemini Preset — One-line Gemini API key management
+ *
+ * Pre-configured singleton with:
+ * - Reads `GOOGLE_GEMINI_API_KEY` or `GEMINI_API_KEY` from env
+ * - LatencyStrategy for optimal key selection
+ * - File persistence (survives restarts)
+ * - Health checks every 5 minutes
+ * - Concurrency limit of 20
+ *
+ * @module presets/gemini
+ *
+ * @example
+ * ```ts
+ * import { GeminiManager } from '@splashcodex/api-key-manager/presets/gemini';
+ *
+ * // Initialize once (reads keys from process.env automatically)
+ * const result = GeminiManager.getInstance();
+ * if (!result.success) throw result.error;
+ * const gemini = result.data;
+ *
+ * // Use the execute() wrapper for automatic key rotation + retries
+ * const response = await gemini.execute(async (key) => {
+ *   const genAI = new GoogleGenerativeAI(key);
+ *   const model = genAI.getGenerativeModel({ model: 'gemini-2.0-flash' });
+ *   const res = await model.generateContent('Hello, world!');
+ *   return res.response.text();
+ * }, { maxRetries: 3, timeoutMs: 30000 });
+ * ```
+ */
+
+import { BasePreset, PresetOptions, Result } from './base';
+
+export class GeminiManager extends BasePreset {
+    private static readonly PROVIDER = 'gemini';
+
+    private constructor(keys: string[], options: PresetOptions) {
+        super(keys, options);
+    }
+
+    /**
+     * Default configuration for Gemini presets.
+     */
+    private static getDefaultOptions(): Partial<PresetOptions> {
+        return {
+            envKeys: ['GOOGLE_GEMINI_API_KEY', 'GEMINI_API_KEY'],
+            provider: GeminiManager.PROVIDER,
+            concurrency: 20,
+            healthCheckIntervalMs: 300_000, // 5 minutes
+        };
+    }
+
+    /**
+     * Get or create the singleton GeminiManager instance.
+     *
+     * @param overrides - Optional configuration overrides
+     * @returns Result<GeminiManager> — safely check `.success` before using `.data`
+     *
+     * @example
+     * ```ts
+     * const result = GeminiManager.getInstance();
+     * if (result.success) {
+     *   const gemini = result.data;
+     *   const text = await gemini.execute(apiCall, { maxRetries: 3 });
+     * }
+     * ```
+     */
+    static getInstance(overrides?: Partial<PresetOptions>): Result<GeminiManager> {
+        return BasePreset.createInstance(
+            GeminiManager as unknown as new (keys: string[], options: PresetOptions) => GeminiManager,
+            GeminiManager.getDefaultOptions(),
+            overrides
+        ) as Result<GeminiManager>;
+    }
+
+    /**
+     * Reset the singleton instance. Primarily for testing.
+     */
+    static reset(): void {
+        BasePreset.resetInstance(GeminiManager.PROVIDER);
+    }
+}
+
+export { Result } from './base';

package/src/presets/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Presets — Batteries-included provider managers
+ * @module presets
+ */
+export { BasePreset } from './base';
+export type { PresetOptions, PresetLogger, Result } from './base';
+export { GeminiManager } from './gemini';
+export { OpenAIManager } from './openai';
+export { MultiManager } from './multi';
+export type { ProviderConfig, MultiManagerOptions } from './multi';