@henrychong-ai/mcp-neo4j-knowledge-graph 1.0.0

package/dist/storage/FileStorageProvider.js

@@ -0,0 +1,322 @@
+import * as fs from 'fs';
+import path from 'path';
+/**
+ * A storage provider that uses the file system to store the knowledge graph
+ * @deprecated This storage provider is deprecated and will be removed in a future version.
+ * Please migrate to SqliteStorageProvider.
+ */
+export class FileStorageProvider {
+    /**
+     * Create a new FileStorageProvider
+     * @param options Configuration options for the file storage provider
+     * @deprecated This storage provider is deprecated and will be removed in a future version.
+     * Please migrate to SqliteStorageProvider.
+     */
+    constructor(options) {
+        this.graph = { entities: [], relations: [] };
+        // Only emit warning in test environments to avoid disrupting JSON-RPC protocol
+        if (process.env.NODE_ENV === 'test') {
+            // console.warn('WARNING: FileStorageProvider is deprecated and will be removed in a future version. Please migrate to SqliteStorageProvider.');
+        }
+        this._fs = fs;
+        // Store vector store options for initialization
+        this.vectorStoreOptions = options?.vectorStoreOptions;
+        // Default to test-output directory during tests
+        if (!options?.memoryFilePath && !options?.filePath) {
+            const testOutputDir = path.join(process.cwd(), 'test-output', 'file-storage');
+            if (!fs.existsSync(testOutputDir)) {
+                fs.mkdirSync(testOutputDir, { recursive: true });
+            }
+            this.filePath = path.join(testOutputDir, 'memory.json');
+        }
+        else {
+            this.filePath = options?.memoryFilePath || options?.filePath || '';
+        }
+        this.loadGraph();
+    }
+    /**
+     * Set the fs module (for testing purposes)
+     */
+    setFs(fsModule) {
+        this._fs = fsModule;
+    }
+    /**
+     * Load the entire knowledge graph from the file
+     * @returns Promise resolving to the loaded KnowledgeGraph
+     */
+    async loadGraph() {
+        try {
+            const content = await this._fs.promises.readFile(this.filePath, 'utf-8');
+            this.graph = JSON.parse(content);
+            return this.graph;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                // File doesn't exist, return empty graph
+                return { entities: [], relations: [] };
+            }
+            throw new Error(`Error loading graph from ${this.filePath}: ${error.message}`);
+        }
+    }
+    /**
+     * Save the entire knowledge graph to the file
+     * @param graph The KnowledgeGraph to save
+     * @returns Promise that resolves when the save is complete
+     */
+    async saveGraph(graph) {
+        await this._fs.promises.writeFile(this.filePath, JSON.stringify(graph, null, 2), 'utf-8');
+    }
+    /**
+     * Search for nodes in the graph that match the query
+     * @param query The search query string
+     * @param options Optional search parameters
+     * @returns Promise resolving to a KnowledgeGraph containing matching nodes
+     */
+    async searchNodes(query, options) {
+        // Load the entire graph
+        const graph = await this.loadGraph();
+        // Apply default options
+        const searchOptions = {
+            limit: options?.limit ?? Number.MAX_SAFE_INTEGER,
+            caseSensitive: options?.caseSensitive ?? false,
+            entityTypes: options?.entityTypes ?? [],
+        };
+        // Filter entities that match the query
+        let matchingEntities = graph.entities.filter((entity) => {
+            // Check if entity matches the query
+            const nameMatches = searchOptions.caseSensitive
+                ? entity.name.includes(query)
+                : entity.name.toLowerCase().includes(query.toLowerCase());
+            const observationsMatch = entity.observations.some((obs) => searchOptions.caseSensitive
+                ? obs.includes(query)
+                : obs.toLowerCase().includes(query.toLowerCase()));
+            // Match if name or any observation contains the query
+            return nameMatches || observationsMatch;
+        });
+        // Filter by entity type if specified
+        if (searchOptions.entityTypes.length > 0) {
+            matchingEntities = matchingEntities.filter((entity) => searchOptions.entityTypes.includes(entity.entityType));
+        }
+        // Apply limit
+        matchingEntities = matchingEntities.slice(0, searchOptions.limit);
+        // Get entity names for relation filtering
+        const entityNames = new Set(matchingEntities.map((entity) => entity.name));
+        // Filter relations that connect matching entities
+        const matchingRelations = graph.relations.filter((relation) => entityNames.has(relation.from) && entityNames.has(relation.to));
+        return {
+            entities: matchingEntities,
+            relations: matchingRelations,
+        };
+    }
+    /**
+     * Open specific nodes by their exact names
+     * @param names Array of node names to open
+     * @returns Promise resolving to a KnowledgeGraph containing the specified nodes
+     */
+    async openNodes(names) {
+        // Handle empty input array case
+        if (names.length === 0) {
+            return { entities: [], relations: [] };
+        }
+        // Load the entire graph
+        const graph = await this.loadGraph();
+        // Create a Set of names for faster lookups
+        const nameSet = new Set(names);
+        // Filter entities by name
+        const filteredEntities = graph.entities.filter((entity) => nameSet.has(entity.name));
+        // Create a Set of entity names that were found
+        const foundEntityNames = new Set(filteredEntities.map((entity) => entity.name));
+        // Filter relations to only include those between found entities
+        const filteredRelations = graph.relations.filter((relation) => foundEntityNames.has(relation.from) && foundEntityNames.has(relation.to));
+        return {
+            entities: filteredEntities,
+            relations: filteredRelations,
+        };
+    }
+    /**
+     * Create new relations between entities
+     * @param relations Array of relations to create
+     * @returns Promise resolving to array of newly created relations
+     */
+    async createRelations(relations) {
+        const graph = await this.loadGraph();
+        const newRelations = relations.filter((r) => !graph.relations.some((existingRelation) => existingRelation.from === r.from &&
+            existingRelation.to === r.to &&
+            existingRelation.relationType === r.relationType));
+        // Always save the graph, even when no new relations are found
+        // This ensures backward compatibility with existing tests
+        await this.saveGraph({
+            entities: graph.entities,
+            relations: [...graph.relations, ...newRelations],
+        });
+        return newRelations;
+    }
+    /**
+     * Add observations to entities
+     * @param observations Array of observations to add
+     * @returns Promise resolving to array of added observations
+     */
+    async addObservations(observations) {
+        if (!observations || observations.length === 0) {
+            return [];
+        }
+        const graph = await this.loadGraph();
+        // Process each observation request
+        const results = observations.map((obs) => {
+            const entity = graph.entities.find((e) => e.name === obs.entityName);
+            if (!entity) {
+                throw new Error(`Entity with name ${obs.entityName} not found`);
+            }
+            // Filter out observations that already exist
+            const newObservations = obs.contents.filter((content) => !entity.observations.includes(content));
+            // Add new observations to entity
+            entity.observations.push(...newObservations);
+            return {
+                entityName: obs.entityName,
+                addedObservations: newObservations,
+            };
+        });
+        // Save the updated graph
+        await this.saveGraph(graph);
+        return results;
+    }
+    /**
+     * Delete entities and their relations from the knowledge graph
+     * @param entityNames Array of entity names to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    async deleteEntities(entityNames) {
+        if (!entityNames || entityNames.length === 0) {
+            return;
+        }
+        const graph = await this.loadGraph();
+        // Create a set for faster lookups
+        const nameSet = new Set(entityNames);
+        // Filter out entities that are in the delete list
+        graph.entities = graph.entities.filter((e) => !nameSet.has(e.name));
+        // Filter out relations that reference deleted entities
+        graph.relations = graph.relations.filter((r) => !nameSet.has(r.from) && !nameSet.has(r.to));
+        // Save the updated graph
+        await this.saveGraph(graph);
+    }
+    /**
+     * Delete specific observations from entities
+     * @param deletions Array of objects with entity name and observations to delete
+     * @returns Promise that resolves when deletion is complete
+     */
+    async deleteObservations(deletions) {
+        if (!deletions || deletions.length === 0) {
+            return;
+        }
+        const graph = await this.loadGraph();
+        // Process each deletion request
+        deletions.forEach((deletion) => {
+            const entity = graph.entities.find((e) => e.name === deletion.entityName);
+            if (entity) {
+                // Filter out the observations that should be deleted
+                entity.observations = entity.observations.filter((obs) => !deletion.observations.includes(obs));
+            }
+        });
+        // Save the updated graph
+        await this.saveGraph(graph);
+    }
+    /**
+     * Delete relations from the graph
+     * @param relations Array of relations to delete
+     * @returns Promise that resolves when deletion is complete
+     * @deprecated FileStorageProvider is deprecated. Use SqliteStorageProvider instead.
+     */
+    async deleteRelations(relations) {
+        await this.loadGraph();
+        for (const relation of relations) {
+            this.graph.relations = this.graph.relations.filter((r) => !(r.from === relation.from &&
+                r.to === relation.to &&
+                r.relationType === relation.relationType));
+        }
+        await this.saveGraph(this.graph);
+    }
+    /**
+     * Get a specific relation by its identifying properties
+     * @param from Source entity name
+     * @param to Target entity name
+     * @param relationType Type of relation
+     * @returns Promise resolving to the relation or null if not found
+     */
+    async getRelation(from, to, relationType) {
+        const graph = await this.loadGraph();
+        const relation = graph.relations.find((r) => r.from === from && r.to === to && r.relationType === relationType);
+        return relation || null;
+    }
+    /**
+     * Update an existing relation with new properties
+     * @param relation The relation with updated properties (from, to, and relationType identify the relation)
+     * @returns Promise that resolves when the update is complete
+     * @throws Error if the relation doesn't exist
+     */
+    async updateRelation(relation) {
+        const graph = await this.loadGraph();
+        // Find the index of the relation to update
+        const index = graph.relations.findIndex((r) => r.from === relation.from && r.to === relation.to && r.relationType === relation.relationType);
+        if (index === -1) {
+            throw new Error(`Relation from ${relation.from} to ${relation.to} of type ${relation.relationType} not found`);
+        }
+        // Update the relation with new properties, preserving any existing properties not specified
+        graph.relations[index] = {
+            ...graph.relations[index], // Keep existing properties
+            ...relation, // Overwrite with new properties
+        };
+        // Save the updated graph
+        await this.saveGraph(graph);
+    }
+    /**
+     * Create new entities in the knowledge graph
+     * @param entities Array of entities to create
+     * @returns Promise resolving to the array of created entities with timestamps
+     * @deprecated FileStorageProvider is deprecated. Use SqliteStorageProvider instead.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async createEntities(entities) {
+        await this.loadGraph();
+        const timestamp = Date.now();
+        const createdEntities = [];
+        for (const entity of entities) {
+            // Check if entity already exists
+            const exists = this.graph.entities.some((e) => e.name === entity.name);
+            if (!exists) {
+                // Add temporal metadata to match SqliteStorageProvider behavior
+                const createdEntity = {
+                    ...entity,
+                    createdAt: timestamp,
+                    updatedAt: timestamp,
+                    validFrom: timestamp,
+                    validTo: null,
+                    version: 1,
+                    changedBy: null,
+                };
+                this.graph.entities.push(createdEntity);
+                createdEntities.push(createdEntity);
+            }
+            else {
+                // Entity already exists, just return the original
+                createdEntities.push(entity);
+            }
+        }
+        // Save the updated graph
+        await this.saveGraph(this.graph);
+        return createdEntities;
+    }
+    /**
+     * Get an entity by name
+     * @param entityName Name of the entity to retrieve
+     * @returns Promise resolving to the entity or null if not found
+     * @deprecated FileStorageProvider is deprecated. Use SqliteStorageProvider instead.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async getEntity(entityName) {
+        await this.loadGraph();
+        const entity = this.graph.entities.find((e) => e.name === entityName);
+        return entity || null;
+    }
+}
+//# sourceMappingURL=FileStorageProvider.js.map

package/dist/storage/FileStorageProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileStorageProvider.js","sourceRoot":"","sources":["../../src/storage/FileStorageProvider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,OAAO,IAAI,MAAM,MAAM,CAAC;AASxB;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAM9B;;;;;OAKG;IACH,YAAY,OAAoC;QATxC,UAAK,GAAmB,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAU9D,+EAA+E;QAC/E,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YACpC,gJAAgJ;QAClJ,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QAEd,gDAAgD;QAChD,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,kBAAkB,CAAC;QAEtD,gDAAgD;QAChD,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC;YACnD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;YAC9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBAClC,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACnD,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,OAAO,EAAE,cAAc,IAAI,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;QACrE,CAAC;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAmB;QACvB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACzE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC;YAClB,8DAA8D;QAChE,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5B,yCAAyC;gBACzC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;YACzC,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,KAAqB;QACnC,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,OAAuB;QACtD,wBAAwB;QACxB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,wBAAwB;QACxB,MAAM,aAAa,GAAG;YACpB,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,MAAM,CAAC,gBAAgB;YAChD,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,KAAK;YAC9C,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,EAAE;SACxC,CAAC;QAEF,uCAAuC;QACvC,IAAI,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;YACtD,oCAAoC;YACpC,MAAM,WAAW,GAAG,aAAa,CAAC,aAAa;gBAC7C,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YAE5D,MAAM,iBAAiB,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACzD,aAAa,CAAC,aAAa;gBACzB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACrB,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CACpD,CAAC;YAEF,sDAAsD;YACtD,OAAO,WAAW,IAAI,iBAAiB,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,qCAAqC;QACrC,IAAI,aAAa,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CACpD,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CACtD,CAAC;QACJ,CAAC;QAED,cAAc;QACd,gBAAgB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;QAElE,0CAA0C;QAC1C,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3E,kDAAkD;QAClD,MAAM,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAC9C,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAC7E,CAAC;QAEF,OAAO;YACL,QAAQ,EAAE,gBAAgB;YAC1B,SAAS,EAAE,iBAAiB;SAC7B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,KAAe;QAC7B,gCAAgC;QAChC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QACzC,CAAC;QAED,wBAAwB;QACxB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,2CAA2C;QAC3C,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAE/B,0BAA0B;QAC1B,MAAM,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAErF,+CAA+C;QAC/C,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhF,gEAAgE;QAChE,MAAM,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAC9C,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CACvF,CAAC;QAEF,OAAO;YACL,QAAQ,EAAE,gBAAgB;YAC1B,SAAS,EAAE,iBAAiB;SAC7B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,SAAqB;QACzC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CACnC,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CACnB,CAAC,gBAAgB,EAAE,EAAE,CACnB,gBAAgB,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;YAChC,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE;YAC5B,gBAAgB,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY,CACnD,CACJ,CAAC;QAEF,8DAA8D;QAC9D,0DAA0D;QAC1D,MAAM,IAAI,CAAC,SAAS,CAAC;YACnB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,SAAS,EAAE,GAAG,YAAY,CAAC;SACjD,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CACnB,YAA0D;QAE1D,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,mCAAmC;QACnC,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACvC,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,UAAU,CAAC,CAAC;YAErE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,CAAC,UAAU,YAAY,CAAC,CAAC;YAClE,CAAC;YAED,6CAA6C;YAC7C,MAAM,eAAe,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CACzC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CACpD,CAAC;YAEF,iCAAiC;YACjC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;YAE7C,OAAO;gBACL,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,iBAAiB,EAAE,eAAe;aACnC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE5B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,WAAqB;QACxC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7C,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,kCAAkC;QAClC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QAErC,kDAAkD;QAClD,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpE,uDAAuD;QACvD,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5F,yBAAyB;QACzB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CACtB,SAA2D;QAE3D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzC,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,gCAAgC;QAChC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC1E,IAAI,MAAM,EAAE,CAAC;gBACX,qDAAqD;gBACrD,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAC9C,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC9C,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,SAAqB;QACzC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEvB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAChD,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CACC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI;gBACxB,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE;gBACpB,CAAC,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY,CACzC,CACJ,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,EAAU,EAAE,YAAoB;QAC9D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,YAAY,KAAK,YAAY,CACzE,CAAC;QAEF,OAAO,QAAQ,IAAI,IAAI,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,QAAkB;QACrC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAErC,2CAA2C;QAC3C,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CACrC,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY,CAC/F,CAAC;QAEF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,iBAAiB,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,EAAE,YAAY,QAAQ,CAAC,YAAY,YAAY,CAC9F,CAAC;QACJ,CAAC;QAED,4FAA4F;QAC5F,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG;YACvB,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,2BAA2B;YACtD,GAAG,QAAQ,EAAE,gCAAgC;SAC9C,CAAC;QAEF,yBAAyB;QACzB,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IAC9D,KAAK,CAAC,cAAc,CAAC,QAAe;QAClC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEvB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,eAAe,GAAG,EAAE,CAAC;QAE3B,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC9B,iCAAiC;YACjC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC;YAEvE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,gEAAgE;gBAChE,MAAM,aAAa,GAAG;oBACpB,GAAG,MAAM;oBACT,SAAS,EAAE,SAAS;oBACpB,SAAS,EAAE,SAAS;oBACpB,SAAS,EAAE,SAAS;oBACpB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,IAAI;iBAChB,CAAC;gBAEF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBACxC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,kDAAkD;gBAClD,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,yBAAyB;QACzB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjC,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,8DAA8D;IAC9D,KAAK,CAAC,SAAS,CAAC,UAAkB;QAChC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;QACtE,OAAO,MAAM,IAAI,IAAI,CAAC;IACxB,CAAC;CACF"}

package/dist/storage/SearchResultCache.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Cache system for search results to improve performance for repeated queries
+ */
+/**
+ * Cache configuration
+ */
+export interface SearchCacheConfig {
+    maxSize?: number;
+    defaultTtl?: number;
+    enableStats?: boolean;
+}
+/**
+ * Cache statistics
+ */
+export interface CacheStats {
+    hits: number;
+    misses: number;
+    hitRate: number;
+    currentSize: number;
+    maxSize: number;
+    entryCount: number;
+    evictions: number;
+    averageLookupTime: number;
+}
+/**
+ * A memory-efficient cache for search results
+ */
+export declare class SearchResultCache<T> {
+    private cache;
+    private maxSize;
+    private currentSize;
+    private defaultTtl;
+    private enableStats;
+    private hits;
+    private misses;
+    private evictions;
+    private totalLookupTime;
+    private totalLookups;
+    /**
+     * Create a new SearchResultCache
+     * @param config Configuration options
+     */
+    constructor(config?: SearchCacheConfig);
+    /**
+     * Estimate the size of an object in bytes
+     * @param obj The object to measure
+     * @returns Approximate size in bytes
+     */
+    private estimateSize;
+    /**
+     * Generate a cache key from a query and parameters
+     * @param query Original query string
+     * @param params Optional parameters that affect the query
+     * @returns A cache key string
+     */
+    private generateKey;
+    /**
+     * Evict the oldest or least valuable entries to free up space
+     * @param requiredSpace The amount of space needed
+     */
+    private evictEntries;
+    /**
+     * Set a cache entry
+     * @param query The original query
+     * @param params Optional parameters that affect the results
+     * @param data The data to cache
+     * @param ttl Optional time-to-live in milliseconds
+     */
+    set(query: string, data: T, params?: Record<string, unknown>, ttl?: number): void;
+    /**
+     * Get a value from the cache
+     * @param query The original query
+     * @param params Optional parameters that affect the results
+     * @returns The cached data or undefined if not found or expired
+     */
+    get(query: string, params?: Record<string, unknown>): T | undefined;
+    /**
+     * Remove all expired entries from the cache
+     */
+    removeExpired(): void;
+    /**
+     * Clear the entire cache
+     */
+    clear(): void;
+    /**
+     * Get cache statistics
+     * @returns Cache statistics
+     */
+    getStats(): CacheStats;
+    /**
+     * Get the current number of entries in the cache
+     * @returns Number of entries
+     */
+    size(): number;
+    /**
+     * Check if the cache contains a specific key
+     * @param query The original query
+     * @param params Optional parameters that affect the results
+     * @returns True if the key exists and is not expired
+     */
+    has(query: string, params?: Record<string, unknown>): boolean;
+}