minimem 0.0.6 → 0.1.0

package/dist/index.d.cts

@@ -855,4 +855,201 @@ declare class MemorySearcher {
     private ensureVectorReady;
 }
 
-export { type SearchResult as CoreSearchResult, DebugFn, type EmbeddingProvider, type EmbeddingProviderOptions, type EmbeddingProviderResult, type GeminiBatchRequest, type GeminiEmbeddingClient, type GraphLink, type GraphNeighbor, type IndexStats, type IndexerConfig, KNOWLEDGE_GRAPH_TOOL, KNOWLEDGE_PATH_TOOL, KNOWLEDGE_SEARCH_TOOL, type KnowledgeGraphParams, type KnowledgePathParams, type KnowledgeSearchOptions, type KnowledgeSearchParams, MEMORY_GET_DETAILS_TOOL, MEMORY_SEARCH_TOOL, MEMORY_TOOLS, McpServer, type McpServerConfig, MemoryChunk, MemoryFileEntry, type MemoryGetDetailsParams, type MemoryIndexMeta, MemoryIndexer, type MemoryInstance, type MemorySearchParams, MemorySearcher, MemoryToolExecutor, Minimem, type MinimemConfig, type MinimemSearchResult, type OpenAiBatchRequest, type OpenAiEmbeddingClient, type SearchConfig, type MinimemSearchResult as SearchResult, type ToolDefinition, type ToolInputSchema, type ToolResult, buildKnowledgeFilterSql, createEmbeddingProvider, createGeminiEmbeddingProvider, createMcpServer, createOpenAiEmbeddingProvider, createToolExecutor, generateMcpConfig, getLinksFrom, getLinksTo, getNeighbors, getPathBetween, getToolDefinitions, runGeminiEmbeddingBatches, runMcpServer, runOpenAiEmbeddingBatches };
+/**
+ * Store manifest: defines known stores and their relationships.
+ *
+ * Manifests can live in two places:
+ * 1. Global: ~/.config/minimem/stores.json (user-wide registry)
+ * 2. Per-store: .minimem/links.json (declares that store's dependencies)
+ *
+ * The global manifest is the source of truth for store metadata (path, remote).
+ * Per-store link files declare which other stores a store depends on.
+ */
+/**
+ * A single store definition in the global manifest.
+ */
+type StoreDefinition = {
+    /** Absolute path to the store's memory directory */
+    path: string;
+    /** Git remote URL for remote materialization */
+    remote?: string;
+    /** Human-readable description */
+    description?: string;
+};
+/**
+ * Global store manifest (~/.config/minimem/stores.json)
+ */
+type StoreManifest = {
+    stores: Record<string, StoreDefinition>;
+};
+/**
+ * Per-store links file (.minimem/links.json or .swarm/minimem/links.json)
+ * Declares which other stores this store depends on.
+ */
+type StoreLinks = {
+    /** Store names that this store links to (depth-1 only) */
+    links: string[];
+};
+/**
+ * Load the global store manifest.
+ * Returns an empty manifest if the file doesn't exist.
+ */
+declare function loadManifest(manifestPath?: string): Promise<StoreManifest>;
+/**
+ * Save the global store manifest.
+ */
+declare function saveManifest(manifest: StoreManifest, manifestPath?: string): Promise<void>;
+/**
+ * Load per-store links from a memory directory.
+ * Checks .minimem/links.json, .swarm/minimem/links.json, and links.json (contained layout).
+ */
+declare function loadStoreLinks(memoryDir: string): Promise<StoreLinks>;
+/**
+ * Save per-store links to a memory directory.
+ * Writes to the first config subdirectory that exists.
+ */
+declare function saveStoreLinks(memoryDir: string, links: StoreLinks): Promise<void>;
+/**
+ * Resolve store name to its definition.
+ * Looks up the store in the global manifest.
+ */
+declare function resolveStore(manifest: StoreManifest, storeName: string): StoreDefinition | null;
+/**
+ * Resolve a directory path to its store name in the manifest.
+ * Returns the first store whose path matches.
+ */
+declare function resolveStoreName(manifest: StoreManifest, dirPath: string): string | null;
+/**
+ * Get all linked store names for a given store (depth 1 only).
+ * Merges links from the global manifest and per-store links file.
+ */
+declare function getLinkedStoreNames(manifest: StoreManifest, storeName: string): Promise<string[]>;
+/**
+ * Get the default global manifest path.
+ */
+declare function getManifestPath(): string;
+
+/**
+ * Store materialization strategies.
+ *
+ * Two strategies for making a linked store accessible:
+ *
+ * A. Remote materialization: clone/fetch a git remote into a cache directory
+ *    Used when the store isn't available locally.
+ *
+ * B. Symlink materialization: create temporary symlinks to a local store
+ *    Used when the store is already present on disk.
+ *    Symlinks go into a temp directory with unique subdirectory names
+ *    to avoid path collisions between stores.
+ */
+
+type MaterializeResult = {
+    /** The directory path to use for creating a Minimem instance */
+    path: string;
+    /** How the store was materialized */
+    strategy: "local" | "symlink" | "remote";
+    /** Cleanup function to call when done (removes symlinks, etc.) */
+    cleanup: () => Promise<void>;
+};
+/**
+ * Materialize a store so it can be accessed by a Minimem instance.
+ *
+ * Resolution order:
+ * 1. If the store path exists locally → use directly (no materialization needed)
+ * 2. If the store has a remote → clone/fetch into cache
+ * 3. Otherwise → return null (store unavailable)
+ */
+declare function materializeStore(storeName: string, storeDef: StoreDefinition, opts?: {
+    /** Force refresh from remote even if cache exists */
+    refresh?: boolean;
+}): Promise<MaterializeResult | null>;
+/**
+ * Get the cache directory for remote stores.
+ */
+declare function getRemoteCacheDir(): string;
+/**
+ * List cached remote stores.
+ */
+declare function listCachedStores(): Promise<string[]>;
+/**
+ * Clear the cache for a specific remote store.
+ */
+declare function clearStoreCache(storeName: string): Promise<void>;
+
+/**
+ * StoreGraph: meta-layer above Minimem for managing linked stores.
+ *
+ * A StoreGraph resolves a store and its dependencies (depth 1),
+ * materializes them as needed, and produces an array of MemoryInstance
+ * objects that can be passed to MemoryToolExecutor or used directly.
+ *
+ * The Minimem class is unchanged — StoreGraph just orchestrates
+ * multiple independent Minimem instances.
+ */
+
+type StoreGraphOptions = {
+    /** Path to the global manifest file (default: ~/.config/minimem/stores.json) */
+    manifestPath?: string;
+    /** Factory to create a MinimemConfig for a given store directory */
+    configFactory?: (memoryDir: string, storeName: string) => Promise<MinimemConfig>;
+    /** Debug logging */
+    debug?: (message: string) => void;
+};
+type ResolvedStore = {
+    name: string;
+    definition: StoreDefinition;
+    materialization: MaterializeResult;
+    instance: Minimem;
+};
+declare class StoreGraph {
+    private manifest;
+    private resolved;
+    private configFactory;
+    private debug?;
+    private constructor();
+    /**
+     * Create a StoreGraph from the global manifest.
+     */
+    static create(opts?: StoreGraphOptions): Promise<StoreGraph>;
+    /**
+     * Create a StoreGraph from an explicit manifest object (useful for testing).
+     */
+    static fromManifest(manifest: StoreManifest, opts?: StoreGraphOptions): StoreGraph;
+    /**
+     * Get the loaded manifest.
+     */
+    getManifest(): StoreManifest;
+    /**
+     * Resolve a store by name: materialize it and all its linked stores (depth 1).
+     * Returns an array of MemoryInstance objects ready for search.
+     *
+     * Linked stores that fail to materialize are skipped with a warning.
+     */
+    resolve(storeName: string): Promise<MemoryInstance[]>;
+    /**
+     * Resolve a store by directory path (looks up the store name in the manifest).
+     * Falls back to creating a standalone instance if the directory isn't in the manifest.
+     */
+    resolveByPath(dirPath: string): Promise<MemoryInstance[]>;
+    /**
+     * List all known stores from the manifest with their link info.
+     */
+    listStores(): Promise<Array<{
+        name: string;
+        path: string;
+        remote?: string;
+        links: string[];
+        available: boolean;
+    }>>;
+    /**
+     * Close all resolved Minimem instances and clean up materializations.
+     */
+    close(): Promise<void>;
+    /**
+     * Resolve a single store by name.
+     * Returns cached instance if already resolved.
+     */
+    private resolveOne;
+}
+
+export { type SearchResult as CoreSearchResult, DebugFn, type EmbeddingProvider, type EmbeddingProviderOptions, type EmbeddingProviderResult, type GeminiBatchRequest, type GeminiEmbeddingClient, type GraphLink, type GraphNeighbor, type IndexStats, type IndexerConfig, KNOWLEDGE_GRAPH_TOOL, KNOWLEDGE_PATH_TOOL, KNOWLEDGE_SEARCH_TOOL, type KnowledgeGraphParams, type KnowledgePathParams, type KnowledgeSearchOptions, type KnowledgeSearchParams, MEMORY_GET_DETAILS_TOOL, MEMORY_SEARCH_TOOL, MEMORY_TOOLS, type MaterializeResult, McpServer, type McpServerConfig, MemoryChunk, MemoryFileEntry, type MemoryGetDetailsParams, type MemoryIndexMeta, MemoryIndexer, type MemoryInstance, type MemorySearchParams, MemorySearcher, MemoryToolExecutor, Minimem, type MinimemConfig, type MinimemSearchResult, type OpenAiBatchRequest, type OpenAiEmbeddingClient, type ResolvedStore, type SearchConfig, type MinimemSearchResult as SearchResult, type StoreDefinition, StoreGraph, type StoreGraphOptions, type StoreLinks, type StoreManifest, type ToolDefinition, type ToolInputSchema, type ToolResult, buildKnowledgeFilterSql, clearStoreCache, createEmbeddingProvider, createGeminiEmbeddingProvider, createMcpServer, createOpenAiEmbeddingProvider, createToolExecutor, generateMcpConfig, getLinkedStoreNames, getLinksFrom, getLinksTo, getManifestPath, getNeighbors, getPathBetween, getRemoteCacheDir, getToolDefinitions, listCachedStores, loadManifest, loadStoreLinks, materializeStore, resolveStore, resolveStoreName, runGeminiEmbeddingBatches, runMcpServer, runOpenAiEmbeddingBatches, saveManifest, saveStoreLinks };

package/dist/index.d.ts

@@ -855,4 +855,201 @@ declare class MemorySearcher {
     private ensureVectorReady;
 }
 
-export { type SearchResult as CoreSearchResult, DebugFn, type EmbeddingProvider, type EmbeddingProviderOptions, type EmbeddingProviderResult, type GeminiBatchRequest, type GeminiEmbeddingClient, type GraphLink, type GraphNeighbor, type IndexStats, type IndexerConfig, KNOWLEDGE_GRAPH_TOOL, KNOWLEDGE_PATH_TOOL, KNOWLEDGE_SEARCH_TOOL, type KnowledgeGraphParams, type KnowledgePathParams, type KnowledgeSearchOptions, type KnowledgeSearchParams, MEMORY_GET_DETAILS_TOOL, MEMORY_SEARCH_TOOL, MEMORY_TOOLS, McpServer, type McpServerConfig, MemoryChunk, MemoryFileEntry, type MemoryGetDetailsParams, type MemoryIndexMeta, MemoryIndexer, type MemoryInstance, type MemorySearchParams, MemorySearcher, MemoryToolExecutor, Minimem, type MinimemConfig, type MinimemSearchResult, type OpenAiBatchRequest, type OpenAiEmbeddingClient, type SearchConfig, type MinimemSearchResult as SearchResult, type ToolDefinition, type ToolInputSchema, type ToolResult, buildKnowledgeFilterSql, createEmbeddingProvider, createGeminiEmbeddingProvider, createMcpServer, createOpenAiEmbeddingProvider, createToolExecutor, generateMcpConfig, getLinksFrom, getLinksTo, getNeighbors, getPathBetween, getToolDefinitions, runGeminiEmbeddingBatches, runMcpServer, runOpenAiEmbeddingBatches };
+/**
+ * Store manifest: defines known stores and their relationships.
+ *
+ * Manifests can live in two places:
+ * 1. Global: ~/.config/minimem/stores.json (user-wide registry)
+ * 2. Per-store: .minimem/links.json (declares that store's dependencies)
+ *
+ * The global manifest is the source of truth for store metadata (path, remote).
+ * Per-store link files declare which other stores a store depends on.
+ */
+/**
+ * A single store definition in the global manifest.
+ */
+type StoreDefinition = {
+    /** Absolute path to the store's memory directory */
+    path: string;
+    /** Git remote URL for remote materialization */
+    remote?: string;
+    /** Human-readable description */
+    description?: string;
+};
+/**
+ * Global store manifest (~/.config/minimem/stores.json)
+ */
+type StoreManifest = {
+    stores: Record<string, StoreDefinition>;
+};
+/**
+ * Per-store links file (.minimem/links.json or .swarm/minimem/links.json)
+ * Declares which other stores this store depends on.
+ */
+type StoreLinks = {
+    /** Store names that this store links to (depth-1 only) */
+    links: string[];
+};
+/**
+ * Load the global store manifest.
+ * Returns an empty manifest if the file doesn't exist.
+ */
+declare function loadManifest(manifestPath?: string): Promise<StoreManifest>;
+/**
+ * Save the global store manifest.
+ */
+declare function saveManifest(manifest: StoreManifest, manifestPath?: string): Promise<void>;
+/**
+ * Load per-store links from a memory directory.
+ * Checks .minimem/links.json, .swarm/minimem/links.json, and links.json (contained layout).
+ */
+declare function loadStoreLinks(memoryDir: string): Promise<StoreLinks>;
+/**
+ * Save per-store links to a memory directory.
+ * Writes to the first config subdirectory that exists.
+ */
+declare function saveStoreLinks(memoryDir: string, links: StoreLinks): Promise<void>;
+/**
+ * Resolve store name to its definition.
+ * Looks up the store in the global manifest.
+ */
+declare function resolveStore(manifest: StoreManifest, storeName: string): StoreDefinition | null;
+/**
+ * Resolve a directory path to its store name in the manifest.
+ * Returns the first store whose path matches.
+ */
+declare function resolveStoreName(manifest: StoreManifest, dirPath: string): string | null;
+/**
+ * Get all linked store names for a given store (depth 1 only).
+ * Merges links from the global manifest and per-store links file.
+ */
+declare function getLinkedStoreNames(manifest: StoreManifest, storeName: string): Promise<string[]>;
+/**
+ * Get the default global manifest path.
+ */
+declare function getManifestPath(): string;
+
+/**
+ * Store materialization strategies.
+ *
+ * Two strategies for making a linked store accessible:
+ *
+ * A. Remote materialization: clone/fetch a git remote into a cache directory
+ *    Used when the store isn't available locally.
+ *
+ * B. Symlink materialization: create temporary symlinks to a local store
+ *    Used when the store is already present on disk.
+ *    Symlinks go into a temp directory with unique subdirectory names
+ *    to avoid path collisions between stores.
+ */
+
+type MaterializeResult = {
+    /** The directory path to use for creating a Minimem instance */
+    path: string;
+    /** How the store was materialized */
+    strategy: "local" | "symlink" | "remote";
+    /** Cleanup function to call when done (removes symlinks, etc.) */
+    cleanup: () => Promise<void>;
+};
+/**
+ * Materialize a store so it can be accessed by a Minimem instance.
+ *
+ * Resolution order:
+ * 1. If the store path exists locally → use directly (no materialization needed)
+ * 2. If the store has a remote → clone/fetch into cache
+ * 3. Otherwise → return null (store unavailable)
+ */
+declare function materializeStore(storeName: string, storeDef: StoreDefinition, opts?: {
+    /** Force refresh from remote even if cache exists */
+    refresh?: boolean;
+}): Promise<MaterializeResult | null>;
+/**
+ * Get the cache directory for remote stores.
+ */
+declare function getRemoteCacheDir(): string;
+/**
+ * List cached remote stores.
+ */
+declare function listCachedStores(): Promise<string[]>;
+/**
+ * Clear the cache for a specific remote store.
+ */
+declare function clearStoreCache(storeName: string): Promise<void>;
+
+/**
+ * StoreGraph: meta-layer above Minimem for managing linked stores.
+ *
+ * A StoreGraph resolves a store and its dependencies (depth 1),
+ * materializes them as needed, and produces an array of MemoryInstance
+ * objects that can be passed to MemoryToolExecutor or used directly.
+ *
+ * The Minimem class is unchanged — StoreGraph just orchestrates
+ * multiple independent Minimem instances.
+ */
+
+type StoreGraphOptions = {
+    /** Path to the global manifest file (default: ~/.config/minimem/stores.json) */
+    manifestPath?: string;
+    /** Factory to create a MinimemConfig for a given store directory */
+    configFactory?: (memoryDir: string, storeName: string) => Promise<MinimemConfig>;
+    /** Debug logging */
+    debug?: (message: string) => void;
+};
+type ResolvedStore = {
+    name: string;
+    definition: StoreDefinition;
+    materialization: MaterializeResult;
+    instance: Minimem;
+};
+declare class StoreGraph {
+    private manifest;
+    private resolved;
+    private configFactory;
+    private debug?;
+    private constructor();
+    /**
+     * Create a StoreGraph from the global manifest.
+     */
+    static create(opts?: StoreGraphOptions): Promise<StoreGraph>;
+    /**
+     * Create a StoreGraph from an explicit manifest object (useful for testing).
+     */
+    static fromManifest(manifest: StoreManifest, opts?: StoreGraphOptions): StoreGraph;
+    /**
+     * Get the loaded manifest.
+     */
+    getManifest(): StoreManifest;
+    /**
+     * Resolve a store by name: materialize it and all its linked stores (depth 1).
+     * Returns an array of MemoryInstance objects ready for search.
+     *
+     * Linked stores that fail to materialize are skipped with a warning.
+     */
+    resolve(storeName: string): Promise<MemoryInstance[]>;
+    /**
+     * Resolve a store by directory path (looks up the store name in the manifest).
+     * Falls back to creating a standalone instance if the directory isn't in the manifest.
+     */
+    resolveByPath(dirPath: string): Promise<MemoryInstance[]>;
+    /**
+     * List all known stores from the manifest with their link info.
+     */
+    listStores(): Promise<Array<{
+        name: string;
+        path: string;
+        remote?: string;
+        links: string[];
+        available: boolean;
+    }>>;
+    /**
+     * Close all resolved Minimem instances and clean up materializations.
+     */
+    close(): Promise<void>;
+    /**
+     * Resolve a single store by name.
+     * Returns cached instance if already resolved.
+     */
+    private resolveOne;
+}
+
+export { type SearchResult as CoreSearchResult, DebugFn, type EmbeddingProvider, type EmbeddingProviderOptions, type EmbeddingProviderResult, type GeminiBatchRequest, type GeminiEmbeddingClient, type GraphLink, type GraphNeighbor, type IndexStats, type IndexerConfig, KNOWLEDGE_GRAPH_TOOL, KNOWLEDGE_PATH_TOOL, KNOWLEDGE_SEARCH_TOOL, type KnowledgeGraphParams, type KnowledgePathParams, type KnowledgeSearchOptions, type KnowledgeSearchParams, MEMORY_GET_DETAILS_TOOL, MEMORY_SEARCH_TOOL, MEMORY_TOOLS, type MaterializeResult, McpServer, type McpServerConfig, MemoryChunk, MemoryFileEntry, type MemoryGetDetailsParams, type MemoryIndexMeta, MemoryIndexer, type MemoryInstance, type MemorySearchParams, MemorySearcher, MemoryToolExecutor, Minimem, type MinimemConfig, type MinimemSearchResult, type OpenAiBatchRequest, type OpenAiEmbeddingClient, type ResolvedStore, type SearchConfig, type MinimemSearchResult as SearchResult, type StoreDefinition, StoreGraph, type StoreGraphOptions, type StoreLinks, type StoreManifest, type ToolDefinition, type ToolInputSchema, type ToolResult, buildKnowledgeFilterSql, clearStoreCache, createEmbeddingProvider, createGeminiEmbeddingProvider, createMcpServer, createOpenAiEmbeddingProvider, createToolExecutor, generateMcpConfig, getLinkedStoreNames, getLinksFrom, getLinksTo, getManifestPath, getNeighbors, getPathBetween, getRemoteCacheDir, getToolDefinitions, listCachedStores, loadManifest, loadStoreLinks, materializeStore, resolveStore, resolveStoreName, runGeminiEmbeddingBatches, runMcpServer, runOpenAiEmbeddingBatches, saveManifest, saveStoreLinks };