rag-lite-ts 2.1.1 → 2.2.0

package/dist/esm/core/resource-manager.d.ts

@@ -0,0 +1,212 @@
+/**
+ * CORE MODULE — Resource Manager
+ * Implements proper cleanup methods for all embedder implementations
+ * Adds automatic resource management for image processing operations
+ * Creates memory monitoring and garbage collection optimization
+ * Ensures proper disposal of transformers.js model resources
+ *
+ * Requirements: 9.4, 9.6 - Resource cleanup and memory management
+ */
+import type { UniversalEmbedder } from './universal-embedder.js';
+/**
+ * Resource tracking information
+ */
+interface ResourceInfo {
+    id: string;
+    type: 'embedder' | 'model' | 'processor' | 'cache';
+    name: string;
+    memoryEstimateMB: number;
+    createdAt: Date;
+    lastUsedAt: Date;
+    resource: any;
+    cleanupFn?: () => Promise<void>;
+}
+/**
+ * Memory usage statistics
+ */
+interface MemoryStats {
+    heapUsedMB: number;
+    heapTotalMB: number;
+    externalMB: number;
+    rssMemoryMB: number;
+    peakHeapUsedMB: number;
+    gcCount: number;
+    lastGcAt?: Date;
+}
+/**
+ * Resource cleanup statistics
+ */
+interface CleanupStats {
+    totalResourcesTracked: number;
+    resourcesCleanedUp: number;
+    cleanupErrors: number;
+    memoryFreedMB: number;
+    cleanupTimeMs: number;
+}
+/**
+ * Comprehensive resource manager for embedders and models
+ * Handles automatic cleanup, memory monitoring, and garbage collection
+ */
+export declare class ResourceManager {
+    private static instance;
+    private resources;
+    private memoryThresholdMB;
+    private autoCleanupEnabled;
+    private gcEnabled;
+    private cleanupIntervalMs;
+    private cleanupTimer?;
+    private memoryMonitorTimer?;
+    private peakMemoryMB;
+    private gcCount;
+    private lastGcAt?;
+    private constructor();
+    /**
+     * Get singleton instance
+     */
+    static getInstance(): ResourceManager;
+    /**
+     * Register an embedder for resource management
+     */
+    registerEmbedder(embedder: UniversalEmbedder): string;
+    /**
+     * Register a transformers.js model for resource management
+     */
+    registerModel(model: any, modelName: string, modelType: string): string;
+    /**
+     * Register an image processor for resource management
+     */
+    registerImageProcessor(processor: any, processorName: string): string;
+    /**
+     * Update last used timestamp for a resource
+     */
+    updateResourceUsage(resourceId: string): void;
+    /**
+     * Clean up a specific resource by ID
+     */
+    cleanupResource(resourceId: string): Promise<boolean>;
+    /**
+     * Clean up all resources of a specific type
+     */
+    cleanupResourcesByType(type: ResourceInfo['type']): Promise<CleanupStats>;
+    /**
+     * Clean up all registered resources
+     */
+    cleanupAllResources(): Promise<CleanupStats>;
+    /**
+     * Clean up unused resources (not used recently)
+     */
+    cleanupUnusedResources(maxAgeMinutes?: number): Promise<CleanupStats>;
+    /**
+     * Get current memory statistics
+     */
+    getMemoryStats(): MemoryStats;
+    /**
+     * Check if memory usage exceeds threshold
+     */
+    isMemoryThresholdExceeded(): boolean;
+    /**
+     * Force garbage collection
+     */
+    forceGarbageCollection(): boolean;
+    /**
+     * Perform memory optimization
+     */
+    optimizeMemory(): Promise<{
+        initialMemoryMB: number;
+        finalMemoryMB: number;
+        memoryFreedMB: number;
+        resourcesCleanedUp: number;
+        gcPerformed: boolean;
+    }>;
+    /**
+     * Configure memory threshold
+     */
+    setMemoryThreshold(thresholdMB: number): void;
+    /**
+     * Enable or disable automatic cleanup
+     */
+    setAutoCleanup(enabled: boolean): void;
+    /**
+     * Enable or disable garbage collection
+     */
+    setGarbageCollection(enabled: boolean): void;
+    /**
+     * Set cleanup interval
+     */
+    setCleanupInterval(intervalMs: number): void;
+    /**
+     * Get comprehensive resource statistics
+     */
+    getResourceStats(): {
+        totalResources: number;
+        resourcesByType: Record<string, number>;
+        totalEstimatedMemoryMB: number;
+        oldestResource: {
+            name: string;
+            ageMinutes: number;
+        } | null;
+        newestResource: {
+            name: string;
+            ageMinutes: number;
+        } | null;
+        memoryStats: MemoryStats;
+    };
+    /**
+     * Generate unique resource ID
+     */
+    private generateResourceId;
+    /**
+     * Estimate memory usage for embedder
+     */
+    private estimateEmbedderMemory;
+    /**
+     * Estimate memory usage for model
+     */
+    private estimateModelMemory;
+    /**
+     * Estimate memory usage for processor
+     */
+    private estimateProcessorMemory;
+    /**
+     * Start automatic cleanup timer
+     */
+    private startAutoCleanup;
+    /**
+     * Stop automatic cleanup timer
+     */
+    private stopAutoCleanup;
+    /**
+     * Setup memory monitoring
+     */
+    private setupMemoryMonitoring;
+    /**
+     * Stop memory monitoring
+     */
+    private stopMemoryMonitoring;
+    /**
+     * Shutdown resource manager
+     */
+    shutdown(): Promise<void>;
+}
+/**
+ * Get the global resource manager instance
+ */
+export declare function getResourceManager(): ResourceManager;
+/**
+ * Register an embedder for automatic resource management
+ */
+export declare function registerEmbedder(embedder: UniversalEmbedder): string;
+/**
+ * Clean up all resources and optimize memory
+ */
+export declare function cleanupAndOptimizeMemory(): Promise<void>;
+/**
+ * Force garbage collection if available
+ */
+export declare function forceGarbageCollection(): boolean;
+/**
+ * Get current memory statistics
+ */
+export declare function getMemoryStats(): MemoryStats;
+export default ResourceManager;
+//# sourceMappingURL=resource-manager.d.ts.map