@claude-flow/memory 3.0.0-alpha.9 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +308 -37
- package/dist/agent-memory-scope.d.ts.map +1 -1
- package/dist/agent-memory-scope.js +10 -2
- package/dist/agent-memory-scope.js.map +1 -1
- package/dist/agentdb-adapter-key-isolation.test.d.ts +2 -0
- package/dist/agentdb-adapter-key-isolation.test.d.ts.map +1 -0
- package/dist/agentdb-adapter-key-isolation.test.js +175 -0
- package/dist/agentdb-adapter-key-isolation.test.js.map +1 -0
- package/dist/agentdb-adapter-upsert.test.d.ts +2 -0
- package/dist/agentdb-adapter-upsert.test.d.ts.map +1 -0
- package/dist/agentdb-adapter-upsert.test.js +216 -0
- package/dist/agentdb-adapter-upsert.test.js.map +1 -0
- package/dist/agentdb-adapter.d.ts +70 -1
- package/dist/agentdb-adapter.d.ts.map +1 -1
- package/dist/agentdb-adapter.js +365 -32
- package/dist/agentdb-adapter.js.map +1 -1
- package/dist/agentdb-backend.d.ts +25 -0
- package/dist/agentdb-backend.d.ts.map +1 -1
- package/dist/agentdb-backend.js +113 -28
- package/dist/agentdb-backend.js.map +1 -1
- package/dist/agentdb-retrieval-guard.d.ts +76 -0
- package/dist/agentdb-retrieval-guard.d.ts.map +1 -0
- package/dist/agentdb-retrieval-guard.js +77 -0
- package/dist/agentdb-retrieval-guard.js.map +1 -0
- package/dist/agentdb-retrieval-guard.test.d.ts +12 -0
- package/dist/agentdb-retrieval-guard.test.d.ts.map +1 -0
- package/dist/agentdb-retrieval-guard.test.js +129 -0
- package/dist/agentdb-retrieval-guard.test.js.map +1 -0
- package/dist/auto-memory-bridge.d.ts +12 -1
- package/dist/auto-memory-bridge.d.ts.map +1 -1
- package/dist/auto-memory-bridge.js +101 -7
- package/dist/auto-memory-bridge.js.map +1 -1
- package/dist/auto-memory-bridge.test.js +121 -15
- package/dist/auto-memory-bridge.test.js.map +1 -1
- package/dist/auto-memory-index-3224.test.d.ts +2 -0
- package/dist/auto-memory-index-3224.test.d.ts.map +1 -0
- package/dist/auto-memory-index-3224.test.js +77 -0
- package/dist/auto-memory-index-3224.test.js.map +1 -0
- package/dist/consolidator-embedding-benchmark.test.d.ts +39 -0
- package/dist/consolidator-embedding-benchmark.test.d.ts.map +1 -0
- package/dist/consolidator-embedding-benchmark.test.js +366 -0
- package/dist/consolidator-embedding-benchmark.test.js.map +1 -0
- package/dist/consolidator.d.ts +131 -0
- package/dist/consolidator.d.ts.map +1 -0
- package/dist/consolidator.js +309 -0
- package/dist/consolidator.js.map +1 -0
- package/dist/consolidator.test.d.ts +17 -0
- package/dist/consolidator.test.d.ts.map +1 -0
- package/dist/consolidator.test.js +376 -0
- package/dist/consolidator.test.js.map +1 -0
- package/dist/controller-registry.d.ts +290 -0
- package/dist/controller-registry.d.ts.map +1 -0
- package/dist/controller-registry.js +1095 -0
- package/dist/controller-registry.js.map +1 -0
- package/dist/controller-registry.test.d.ts +14 -0
- package/dist/controller-registry.test.d.ts.map +1 -0
- package/dist/controller-registry.test.js +818 -0
- package/dist/controller-registry.test.js.map +1 -0
- package/dist/database-provider.d.ts +14 -2
- package/dist/database-provider.d.ts.map +1 -1
- package/dist/database-provider.js +63 -3
- package/dist/database-provider.js.map +1 -1
- package/dist/database-provider.test.js +56 -3
- package/dist/database-provider.test.js.map +1 -1
- package/dist/entity-tagger.d.ts +31 -0
- package/dist/entity-tagger.d.ts.map +1 -0
- package/dist/entity-tagger.js +80 -0
- package/dist/entity-tagger.js.map +1 -0
- package/dist/entity-tagger.test.d.ts +12 -0
- package/dist/entity-tagger.test.d.ts.map +1 -0
- package/dist/entity-tagger.test.js +70 -0
- package/dist/entity-tagger.test.js.map +1 -0
- package/dist/fts5.test.d.ts +13 -0
- package/dist/fts5.test.d.ts.map +1 -0
- package/dist/fts5.test.js +144 -0
- package/dist/fts5.test.js.map +1 -0
- package/dist/graceful-retrieval.test.d.ts +14 -0
- package/dist/graceful-retrieval.test.d.ts.map +1 -0
- package/dist/graceful-retrieval.test.js +251 -0
- package/dist/graceful-retrieval.test.js.map +1 -0
- package/dist/hnsw-index.d.ts +62 -0
- package/dist/hnsw-index.d.ts.map +1 -1
- package/dist/hnsw-index.js +461 -16
- package/dist/hnsw-index.js.map +1 -1
- package/dist/hnsw-persistence.test.d.ts +13 -0
- package/dist/hnsw-persistence.test.d.ts.map +1 -0
- package/dist/hnsw-persistence.test.js +208 -0
- package/dist/hnsw-persistence.test.js.map +1 -0
- package/dist/hnsw-quantization.test.d.ts +17 -0
- package/dist/hnsw-quantization.test.d.ts.map +1 -0
- package/dist/hnsw-quantization.test.js +140 -0
- package/dist/hnsw-quantization.test.js.map +1 -0
- package/dist/hybrid-backend.d.ts +46 -2
- package/dist/hybrid-backend.d.ts.map +1 -1
- package/dist/hybrid-backend.js +120 -21
- package/dist/hybrid-backend.js.map +1 -1
- package/dist/hybrid-backend.test.js +139 -5
- package/dist/hybrid-backend.test.js.map +1 -1
- package/dist/index.d.ts +164 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +272 -30
- package/dist/index.js.map +1 -1
- package/dist/index.test.d.ts +10 -0
- package/dist/index.test.d.ts.map +1 -0
- package/dist/index.test.js +71 -0
- package/dist/index.test.js.map +1 -0
- package/dist/json-security.d.ts +12 -0
- package/dist/json-security.d.ts.map +1 -0
- package/dist/json-security.js +20 -0
- package/dist/json-security.js.map +1 -0
- package/dist/learning-bridge.d.ts +29 -0
- package/dist/learning-bridge.d.ts.map +1 -1
- package/dist/learning-bridge.js +71 -6
- package/dist/learning-bridge.js.map +1 -1
- package/dist/learning-bridge.test.js +181 -1
- package/dist/learning-bridge.test.js.map +1 -1
- package/dist/memory-key.d.ts +3 -0
- package/dist/memory-key.d.ts.map +1 -0
- package/dist/memory-key.js +5 -0
- package/dist/memory-key.js.map +1 -0
- package/dist/migration.d.ts +19 -4
- package/dist/migration.d.ts.map +1 -1
- package/dist/migration.js +99 -24
- package/dist/migration.js.map +1 -1
- package/dist/migration.test.d.ts +11 -0
- package/dist/migration.test.d.ts.map +1 -0
- package/dist/migration.test.js +141 -0
- package/dist/migration.test.js.map +1 -0
- package/dist/mmr-benchmark.test.d.ts +2 -0
- package/dist/mmr-benchmark.test.d.ts.map +1 -0
- package/dist/mmr-benchmark.test.js +286 -0
- package/dist/mmr-benchmark.test.js.map +1 -0
- package/dist/mmr-rerank-cosine-cache.test.d.ts +2 -0
- package/dist/mmr-rerank-cosine-cache.test.d.ts.map +1 -0
- package/dist/mmr-rerank-cosine-cache.test.js +334 -0
- package/dist/mmr-rerank-cosine-cache.test.js.map +1 -0
- package/dist/mmr-rerank-perf.test.d.ts +2 -0
- package/dist/mmr-rerank-perf.test.d.ts.map +1 -0
- package/dist/mmr-rerank-perf.test.js +191 -0
- package/dist/mmr-rerank-perf.test.js.map +1 -0
- package/dist/persistent-sona.d.ts +144 -0
- package/dist/persistent-sona.d.ts.map +1 -0
- package/dist/persistent-sona.js +332 -0
- package/dist/persistent-sona.js.map +1 -0
- package/dist/rvf-backend.d.ts +53 -0
- package/dist/rvf-backend.d.ts.map +1 -0
- package/dist/rvf-backend.js +643 -0
- package/dist/rvf-backend.js.map +1 -0
- package/dist/rvf-learning-store.d.ts +139 -0
- package/dist/rvf-learning-store.d.ts.map +1 -0
- package/dist/rvf-learning-store.js +295 -0
- package/dist/rvf-learning-store.js.map +1 -0
- package/dist/rvf-migration.d.ts +45 -0
- package/dist/rvf-migration.d.ts.map +1 -0
- package/dist/rvf-migration.js +254 -0
- package/dist/rvf-migration.js.map +1 -0
- package/dist/smart-retrieval-scores.test.d.ts +2 -0
- package/dist/smart-retrieval-scores.test.d.ts.map +1 -0
- package/dist/smart-retrieval-scores.test.js +75 -0
- package/dist/smart-retrieval-scores.test.js.map +1 -0
- package/dist/smart-retrieval.d.ts +141 -0
- package/dist/smart-retrieval.d.ts.map +1 -0
- package/dist/smart-retrieval.js +399 -0
- package/dist/smart-retrieval.js.map +1 -0
- package/dist/smart-retrieval.test.d.ts +2 -0
- package/dist/smart-retrieval.test.d.ts.map +1 -0
- package/dist/smart-retrieval.test.js +418 -0
- package/dist/smart-retrieval.test.js.map +1 -0
- package/dist/sqlite-backend.d.ts +10 -0
- package/dist/sqlite-backend.d.ts.map +1 -1
- package/dist/sqlite-backend.js +101 -5
- package/dist/sqlite-backend.js.map +1 -1
- package/dist/sqljs-backend.d.ts +9 -0
- package/dist/sqljs-backend.d.ts.map +1 -1
- package/dist/sqljs-backend.js +91 -3
- package/dist/sqljs-backend.js.map +1 -1
- package/dist/tiered-memory.d.ts +171 -0
- package/dist/tiered-memory.d.ts.map +1 -0
- package/dist/tiered-memory.js +350 -0
- package/dist/tiered-memory.js.map +1 -0
- package/dist/tiered-memory.test.d.ts +9 -0
- package/dist/tiered-memory.test.d.ts.map +1 -0
- package/dist/tiered-memory.test.js +220 -0
- package/dist/tiered-memory.test.js.map +1 -0
- package/dist/types.d.ts +17 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +10 -8
package/dist/index.d.ts
CHANGED
|
@@ -41,20 +41,32 @@
|
|
|
41
41
|
* );
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
44
|
-
export type { MemoryType, AccessLevel, ConsistencyLevel, DistanceMetric, MemoryEntry, MemoryEntryInput, MemoryEntryUpdate, QueryType, MemoryQuery, SearchResult, SearchOptions, HNSWConfig, HNSWStats, QuantizationConfig, IMemoryBackend, BackendStats, HealthCheckResult, ComponentHealth, CacheConfig, CacheStats, CachedEntry, MigrationSource, MigrationConfig, MigrationProgress, MigrationResult, MigrationError, MemoryEventType, MemoryEvent, MemoryEventHandler, SONAMode, LearningPattern, EmbeddingGenerator, } from './types.js';
|
|
44
|
+
export type { MemoryType, AccessLevel, ConsistencyLevel, DistanceMetric, MemoryEntry, MemoryEntryInput, MemoryEntryUpdate, QueryType, MemoryQuery, SearchResult, SearchOptions, HNSWConfig, HNSWStats, QuantizationConfig, IMemoryBackend, BackendStats, HealthCheckResult, ComponentHealth, CacheConfig, CacheStats, CachedEntry, MigrationSource, MigrationConfig, MigrationProgress, MigrationResult, MigrationError, MemoryEventType, MemoryEvent, MemoryEventHandler, SONAMode, LearningPattern, EmbeddingGenerator, BatchEmbeddingGenerator, } from './types.js';
|
|
45
45
|
export { generateMemoryId, createDefaultEntry, PERFORMANCE_TARGETS, } from './types.js';
|
|
46
46
|
export { AutoMemoryBridge, resolveAutoMemoryDir, findGitRoot } from './auto-memory-bridge.js';
|
|
47
47
|
export type { AutoMemoryBridgeConfig, MemoryInsight, InsightCategory, SyncDirection, SyncMode, PruneStrategy, SyncResult, ImportResult, } from './auto-memory-bridge.js';
|
|
48
48
|
export { LearningBridge } from './learning-bridge.js';
|
|
49
49
|
export type { LearningBridgeConfig, LearningStats, ConsolidateResult, PatternMatch, } from './learning-bridge.js';
|
|
50
|
+
export { RvfLearningStore } from './rvf-learning-store.js';
|
|
51
|
+
export type { RvfLearningStoreConfig, PatternRecord, LoraRecord, EwcRecord, TrajectoryRecord, } from './rvf-learning-store.js';
|
|
52
|
+
export { PersistentSonaCoordinator } from './persistent-sona.js';
|
|
53
|
+
export type { PersistentSonaConfig } from './persistent-sona.js';
|
|
54
|
+
export { RvfMigrator } from './rvf-migration.js';
|
|
55
|
+
export type { RvfMigrationOptions, RvfMigrationResult } from './rvf-migration.js';
|
|
50
56
|
export { MemoryGraph } from './memory-graph.js';
|
|
51
57
|
export type { MemoryGraphConfig, GraphNode, GraphEdge, GraphStats, RankedResult, EdgeType, } from './memory-graph.js';
|
|
52
58
|
export { resolveAgentMemoryDir, createAgentBridge, transferKnowledge, listAgentScopes, } from './agent-memory-scope.js';
|
|
53
59
|
export type { AgentMemoryScope, AgentScopedConfig, TransferOptions, TransferResult, } from './agent-memory-scope.js';
|
|
60
|
+
export { ControllerRegistry, INIT_LEVELS } from './controller-registry.js';
|
|
61
|
+
export type { AgentDBControllerName, CLIControllerName, ControllerName, InitLevel, ControllerHealth, RegistryHealthReport, RuntimeConfig, } from './controller-registry.js';
|
|
62
|
+
export { TieredMemoryStore, isTemporallyValid } from './tiered-memory.js';
|
|
63
|
+
export type { TemporalStoreOptions, TieredRecallOptions, TieredMemoryEntry, TieredStoreResult, } from './tiered-memory.js';
|
|
54
64
|
export { AgentDBAdapter } from './agentdb-adapter.js';
|
|
55
65
|
export type { AgentDBAdapterConfig } from './agentdb-adapter.js';
|
|
56
66
|
export { AgentDBBackend } from './agentdb-backend.js';
|
|
57
67
|
export type { AgentDBBackendConfig } from './agentdb-backend.js';
|
|
68
|
+
export { AgentDbRetrievalGuard, createAgentDbRetrievalGuard, isRetrievalGuardEnabled, isRetrievalGuardStrict, } from './agentdb-retrieval-guard.js';
|
|
69
|
+
export type { RetrievalGuardConfig, GuardedSearchResult, FilteredSearchResults, } from './agentdb-retrieval-guard.js';
|
|
58
70
|
export { SQLiteBackend } from './sqlite-backend.js';
|
|
59
71
|
export type { SQLiteBackendConfig } from './sqlite-backend.js';
|
|
60
72
|
export { SqlJsBackend } from './sqljs-backend.js';
|
|
@@ -68,6 +80,8 @@ export type { SortDirection, SortField } from './query-builder.js';
|
|
|
68
80
|
export { MemoryMigrator, createMigrator, migrateMultipleSources } from './migration.js';
|
|
69
81
|
export { createDatabase, getPlatformInfo, getAvailableProviders } from './database-provider.js';
|
|
70
82
|
export type { DatabaseProvider, DatabaseOptions } from './database-provider.js';
|
|
83
|
+
export { smartSearch, defaultQueryExpansions } from './smart-retrieval.js';
|
|
84
|
+
export type { SearchCandidate, RawSearchRequest, RawSearchResponse, SearchFn, SmartSearchOptions, SmartSearchStats, SmartSearchResult, } from './smart-retrieval.js';
|
|
71
85
|
import { EventEmitter } from 'node:events';
|
|
72
86
|
import { IMemoryBackend, MemoryEntry, MemoryEntryInput, MemoryEntryUpdate, MemoryQuery, SearchResult, SearchOptions, BackendStats, HealthCheckResult, EmbeddingGenerator, MigrationSource, MigrationConfig, MigrationResult } from './types.js';
|
|
73
87
|
import { AgentDBAdapter, AgentDBAdapterConfig } from './agentdb-adapter.js';
|
|
@@ -81,26 +95,115 @@ export interface UnifiedMemoryServiceConfig extends Partial<AgentDBAdapterConfig
|
|
|
81
95
|
dimensions?: number;
|
|
82
96
|
/** Embedding generator function */
|
|
83
97
|
embeddingGenerator?: EmbeddingGenerator;
|
|
98
|
+
/**
|
|
99
|
+
* Take an HNSW + metadata snapshot every N successful `store()` calls.
|
|
100
|
+
* Set to `0` (or `Infinity`) to disable interval-based snapshots — `close()`
|
|
101
|
+
* still flushes. Default: 1000.
|
|
102
|
+
*
|
|
103
|
+
* Only takes effect when `persistenceEnabled === true` and `persistencePath`
|
|
104
|
+
* is set. Added by ADR-125 Phase 3.
|
|
105
|
+
*/
|
|
106
|
+
snapshotInterval?: number;
|
|
107
|
+
/**
|
|
108
|
+
* Configuration for the background {@link MemoryConsolidator}. Added by
|
|
109
|
+
* ADR-125 Phase 4. When `autoRun: true`, the service starts a `setInterval`
|
|
110
|
+
* timer (default 6h) that runs sweep + dedup + compact and emits the
|
|
111
|
+
* result via `'consolidation:complete'`.
|
|
112
|
+
*/
|
|
113
|
+
consolidator?: {
|
|
114
|
+
autoRun?: boolean;
|
|
115
|
+
intervalMs?: number;
|
|
116
|
+
dedupStrategy?: 'keep-newest' | 'keep-oldest' | 'merge-tags';
|
|
117
|
+
};
|
|
84
118
|
}
|
|
85
119
|
/**
|
|
86
|
-
*
|
|
120
|
+
* Memory Service implementation (legacy class name).
|
|
121
|
+
*
|
|
122
|
+
* @deprecated Use {@link MemoryService} — the canonical name introduced by
|
|
123
|
+
* ADR-125 Phase 1. `UnifiedMemoryService` is preserved as an alias and will
|
|
124
|
+
* continue to work through `@claude-flow/memory@3.0.0-rc`. Both names refer
|
|
125
|
+
* to the same class.
|
|
87
126
|
*
|
|
88
|
-
* High-level interface
|
|
127
|
+
* High-level interface that provides:
|
|
89
128
|
* - Simple API for common operations
|
|
90
129
|
* - Automatic embedding generation
|
|
91
130
|
* - Cross-agent memory sharing
|
|
92
131
|
* - SONA integration for learning
|
|
93
132
|
* - Event-driven notifications
|
|
94
133
|
* - Performance monitoring
|
|
134
|
+
*
|
|
135
|
+
* @see {@link MemoryService} for the canonical alias.
|
|
95
136
|
*/
|
|
96
137
|
export declare class UnifiedMemoryService extends EventEmitter implements IMemoryBackend {
|
|
97
138
|
private adapter;
|
|
98
139
|
private config;
|
|
99
140
|
private initialized;
|
|
141
|
+
/** Total successful `store()` calls since last snapshot trigger (ADR-125 Phase 3). */
|
|
142
|
+
private storeCountSinceSnapshot;
|
|
143
|
+
/** Resolved snapshot interval — see {@link UnifiedMemoryServiceConfig.snapshotInterval}. */
|
|
144
|
+
private readonly snapshotInterval;
|
|
145
|
+
/** Background consolidator timer (ADR-125 Phase 4). */
|
|
146
|
+
private consolidatorTimer;
|
|
147
|
+
/** Lazy-loaded consolidator instance (ADR-125 Phase 4). */
|
|
148
|
+
private consolidator;
|
|
149
|
+
/**
|
|
150
|
+
* The active memory backend. Defaults to the `AgentDBAdapter` created from
|
|
151
|
+
* config, but can be any `IMemoryBackend` implementation (e.g. `HybridBackend`
|
|
152
|
+
* when constructed via `createHybridService` per ADR-009 / ADR-125 Phase 2).
|
|
153
|
+
*
|
|
154
|
+
* Public so consumers can introspect the backend type without reaching for
|
|
155
|
+
* `getAdapter()` (which is AgentDB-specific).
|
|
156
|
+
*/
|
|
157
|
+
backend: IMemoryBackend;
|
|
100
158
|
constructor(config?: UnifiedMemoryServiceConfig);
|
|
159
|
+
/**
|
|
160
|
+
* Replace the active backend with a pre-built `IMemoryBackend`.
|
|
161
|
+
*
|
|
162
|
+
* Used by `createHybridService` (ADR-125 Phase 2) to wire `HybridBackend`
|
|
163
|
+
* through `createDatabase` rather than instantiating `AgentDBAdapter`
|
|
164
|
+
* directly. The legacy `AgentDBAdapter` instance is kept around for the
|
|
165
|
+
* `storeEntry` / `semanticSearch` convenience methods that the IMemoryBackend
|
|
166
|
+
* interface doesn't cover; those calls still flow through it.
|
|
167
|
+
*
|
|
168
|
+
* Returns `this` for chaining.
|
|
169
|
+
*
|
|
170
|
+
* @internal Prefer the factory functions (`createHybridService`,
|
|
171
|
+
* `createPersistentService`, etc.) over calling this directly.
|
|
172
|
+
*/
|
|
173
|
+
withBackend(backend: IMemoryBackend): this;
|
|
101
174
|
initialize(): Promise<void>;
|
|
102
175
|
shutdown(): Promise<void>;
|
|
176
|
+
/**
|
|
177
|
+
* Alias for {@link shutdown}. Matches the lifecycle name expected by callers
|
|
178
|
+
* who treat `MemoryService` like a connection — referenced from ADR-125
|
|
179
|
+
* Phase 3 (snapshot on close()) and Phase 4 (consolidator timer cleanup).
|
|
180
|
+
*/
|
|
181
|
+
close(): Promise<void>;
|
|
182
|
+
/**
|
|
183
|
+
* Start the background consolidator timer if configured.
|
|
184
|
+
* @internal
|
|
185
|
+
*/
|
|
186
|
+
private startConsolidatorTimer;
|
|
187
|
+
/**
|
|
188
|
+
* Run a single consolidator cycle on the active adapter. Emits a
|
|
189
|
+
* `consolidation:complete` event with the {@link ConsolidationResult}.
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
private runAutoConsolidation;
|
|
193
|
+
/**
|
|
194
|
+
* Get (and lazily construct) the {@link MemoryConsolidator} bound to this
|
|
195
|
+
* service. Added by ADR-125 Phase 4.
|
|
196
|
+
*/
|
|
197
|
+
getConsolidator(): Promise<any>;
|
|
103
198
|
store(entry: MemoryEntry): Promise<void>;
|
|
199
|
+
/**
|
|
200
|
+
* If a snapshot interval is configured and the threshold is hit, fire a
|
|
201
|
+
* snapshot in the background. Only meaningful when the active backend is
|
|
202
|
+
* the AgentDBAdapter with persistence enabled.
|
|
203
|
+
*
|
|
204
|
+
* @internal — ADR-125 Phase 3
|
|
205
|
+
*/
|
|
206
|
+
private maybeSnapshot;
|
|
104
207
|
get(id: string): Promise<MemoryEntry | null>;
|
|
105
208
|
getByKey(namespace: string, key: string): Promise<MemoryEntry | null>;
|
|
106
209
|
update(id: string, update: MemoryEntryUpdate): Promise<MemoryEntry | null>;
|
|
@@ -115,11 +218,20 @@ export declare class UnifiedMemoryService extends EventEmitter implements IMemor
|
|
|
115
218
|
getStats(): Promise<BackendStats>;
|
|
116
219
|
healthCheck(): Promise<HealthCheckResult>;
|
|
117
220
|
/**
|
|
118
|
-
* Store an entry from simple input
|
|
221
|
+
* Store an entry from simple input.
|
|
222
|
+
*
|
|
223
|
+
* When the active backend is the default AgentDBAdapter, delegates to its
|
|
224
|
+
* native `storeEntry`. When a custom backend is wired (e.g. HybridBackend
|
|
225
|
+
* via `createHybridService`), this builds a full `MemoryEntry` and stores
|
|
226
|
+
* it through the IMemoryBackend interface.
|
|
119
227
|
*/
|
|
120
228
|
storeEntry(input: MemoryEntryInput): Promise<MemoryEntry>;
|
|
121
229
|
/**
|
|
122
|
-
* Semantic search by content string
|
|
230
|
+
* Semantic search by content string.
|
|
231
|
+
*
|
|
232
|
+
* When the active backend is the default AgentDBAdapter, delegates to its
|
|
233
|
+
* native `semanticSearch`. Otherwise generates an embedding via the
|
|
234
|
+
* configured generator and calls `backend.search()`.
|
|
123
235
|
*/
|
|
124
236
|
semanticSearch(content: string, k?: number, threshold?: number): Promise<SearchResult[]>;
|
|
125
237
|
/**
|
|
@@ -143,7 +255,12 @@ export declare class UnifiedMemoryService extends EventEmitter implements IMemor
|
|
|
143
255
|
*/
|
|
144
256
|
removeTags(id: string, tags: string[]): Promise<MemoryEntry | null>;
|
|
145
257
|
/**
|
|
146
|
-
* Migrate from a legacy memory source
|
|
258
|
+
* Migrate from a legacy memory source.
|
|
259
|
+
*
|
|
260
|
+
* The migrator is AgentDB-specific (writes through `AgentDBAdapter`).
|
|
261
|
+
* When a custom backend is wired (e.g. HybridBackend), migration still
|
|
262
|
+
* targets the local AgentDB adapter; the hybrid backend can pick up the
|
|
263
|
+
* migrated entries on next read via its own AgentDB index.
|
|
147
264
|
*/
|
|
148
265
|
migrateFrom(source: MigrationSource, sourcePath: string, options?: Partial<MigrationConfig>): Promise<MigrationResult>;
|
|
149
266
|
/**
|
|
@@ -163,6 +280,35 @@ export declare class UnifiedMemoryService extends EventEmitter implements IMemor
|
|
|
163
280
|
*/
|
|
164
281
|
isInitialized(): boolean;
|
|
165
282
|
}
|
|
283
|
+
/**
|
|
284
|
+
* Canonical memory service entry point (ADR-125).
|
|
285
|
+
*
|
|
286
|
+
* `MemoryService` is the preferred name as of `@claude-flow/memory@3.0.0-alpha.18`.
|
|
287
|
+
* It is an alias of {@link UnifiedMemoryService}; both names refer to the same
|
|
288
|
+
* class so existing callers continue working unchanged.
|
|
289
|
+
*
|
|
290
|
+
* @example
|
|
291
|
+
* ```typescript
|
|
292
|
+
* import { MemoryService } from '@claude-flow/memory';
|
|
293
|
+
*
|
|
294
|
+
* const memory = new MemoryService({ dimensions: 1536 });
|
|
295
|
+
* await memory.initialize();
|
|
296
|
+
* ```
|
|
297
|
+
*/
|
|
298
|
+
export declare const MemoryService: typeof UnifiedMemoryService;
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
* @typedef MemoryService
|
|
302
|
+
*
|
|
303
|
+
* Type alias matching the canonical {@link MemoryService} runtime export so that
|
|
304
|
+
* `import type { MemoryService } from '@claude-flow/memory'` works alongside the
|
|
305
|
+
* value import.
|
|
306
|
+
*/
|
|
307
|
+
export type MemoryService = UnifiedMemoryService;
|
|
308
|
+
/**
|
|
309
|
+
* Config type alias for {@link MemoryService}.
|
|
310
|
+
*/
|
|
311
|
+
export type MemoryServiceConfig = UnifiedMemoryServiceConfig;
|
|
166
312
|
/**
|
|
167
313
|
* Create a simple in-memory service (for testing)
|
|
168
314
|
*/
|
|
@@ -176,12 +322,16 @@ export declare function createPersistentService(path: string): UnifiedMemoryServ
|
|
|
176
322
|
*/
|
|
177
323
|
export declare function createEmbeddingService(embeddingGenerator: EmbeddingGenerator, dimensions?: number): UnifiedMemoryService;
|
|
178
324
|
/**
|
|
179
|
-
* Create a hybrid memory service (SQLite + AgentDB)
|
|
180
|
-
*
|
|
325
|
+
* Create a hybrid memory service (SQLite + AgentDB).
|
|
326
|
+
*
|
|
327
|
+
* This is the DEFAULT recommended configuration per ADR-009. ADR-125 Phase 2
|
|
328
|
+
* delivers the real wiring: the returned service's backend is a `HybridBackend`
|
|
329
|
+
* created through `createDatabase({ provider: 'hybrid' })`, not an AgentDB-only
|
|
330
|
+
* downgrade as in earlier versions.
|
|
181
331
|
*
|
|
182
332
|
* @example
|
|
183
333
|
* ```typescript
|
|
184
|
-
* const memory = createHybridService('./data/memory.db', embeddingFn);
|
|
334
|
+
* const memory = await createHybridService('./data/memory.db', embeddingFn);
|
|
185
335
|
* await memory.initialize();
|
|
186
336
|
*
|
|
187
337
|
* // Structured queries go to SQLite
|
|
@@ -189,8 +339,12 @@ export declare function createEmbeddingService(embeddingGenerator: EmbeddingGene
|
|
|
189
339
|
*
|
|
190
340
|
* // Semantic queries go to AgentDB
|
|
191
341
|
* const similar = await memory.semanticSearch('authentication patterns', 10);
|
|
342
|
+
*
|
|
343
|
+
* // Verify the backend is actually hybrid
|
|
344
|
+
* import { HybridBackend } from '@claude-flow/memory';
|
|
345
|
+
* memory.backend instanceof HybridBackend; // true
|
|
192
346
|
* ```
|
|
193
347
|
*/
|
|
194
|
-
export declare function createHybridService(databasePath: string, embeddingGenerator: EmbeddingGenerator, dimensions?: number): UnifiedMemoryService
|
|
348
|
+
export declare function createHybridService(databasePath: string, embeddingGenerator: EmbeddingGenerator, dimensions?: number): Promise<UnifiedMemoryService>;
|
|
195
349
|
export default UnifiedMemoryService;
|
|
196
350
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAGH,YAAY,EAEV,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EAGjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,aAAa,EAGb,UAAU,EACV,SAAS,EACT,kBAAkB,EAGlB,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,eAAe,EAGf,WAAW,EACX,UAAU,EACV,WAAW,EAGX,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,cAAc,EAGd,eAAe,EACf,WAAW,EACX,kBAAkB,EAGlB,QAAQ,EACR,eAAe,EAGf,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAGH,YAAY,EAEV,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EAGjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,aAAa,EAGb,UAAU,EACV,SAAS,EACT,kBAAkB,EAGlB,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,eAAe,EAGf,WAAW,EACX,UAAU,EACV,WAAW,EAGX,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,cAAc,EAGd,eAAe,EACf,WAAW,EACX,kBAAkB,EAGlB,QAAQ,EACR,eAAe,EAGf,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC9F,YAAY,EACV,sBAAsB,EACtB,aAAa,EACb,eAAe,EACf,aAAa,EACb,QAAQ,EACR,aAAa,EACb,UAAU,EACV,YAAY,GACb,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,YAAY,EACV,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,YAAY,GACb,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EACV,sBAAsB,EACtB,aAAa,EACb,UAAU,EACV,SAAS,EACT,gBAAgB,GACjB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AACjE,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGlF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,YAAY,EACV,iBAAiB,EACjB,SAAS,EACT,SAAS,EACT,UAAU,EACV,YAAY,EACZ,QAAQ,GACT,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,GAChB,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,cAAc,GACf,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC3E,YAAY,EACV,qBAAqB,EACrB,iBAAiB,EACjB,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,GACd,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EACL,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EACV,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,WAAW,GACZ,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAChG,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGhF,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC3E,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACL,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,eAAe,EAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAG5E;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IAC/E,4CAA4C;IAC5C,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,mCAAmC;IACnC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE;QACb,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,YAAY,CAAC;KAC9D,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,oBAAqB,SAAQ,YAAa,YAAW,cAAc;IAC9E,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,WAAW,CAAkB;IAErC,sFAAsF;IACtF,OAAO,CAAC,uBAAuB,CAAa;IAE5C,4FAA4F;IAC5F,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAE1C,uDAAuD;IACvD,OAAO,CAAC,iBAAiB,CAA+C;IAExE,2DAA2D;IAC3D,OAAO,CAAC,YAAY,CAAoB;IAExC;;;;;;;OAOG;IACI,OAAO,EAAE,cAAc,CAAC;gBAEnB,MAAM,GAAE,0BAA+B;IAyCnD;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAOpC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B/B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;;OAIG;YACW,oBAAoB;IAYlC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;IAe/B,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9C;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAaf,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI5C,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAIrE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAI1E,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpC,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAIjD,MAAM,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAIhF,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1C,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1C,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAInC,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,QAAQ,IAAI,OAAO,CAAC,YAAY,CAAC;IAIjC,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAM/C;;;;;;;OAOG;IACG,UAAU,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC;IAmB/D;;;;;;OAMG;IACG,cAAc,CAClB,OAAO,EAAE,MAAM,EACf,CAAC,GAAE,MAAW,EACd,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,YAAY,EAAE,CAAC;IAa1B;;OAEG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,GAAE,MAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAYrE;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAC1D,OAAO,CAAC,WAAW,CAAC;IAQvB;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAS7E;;OAEG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAQtE;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAUzE;;;;;;;OAOG;IACG,WAAW,CACf,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,OAAO,CAAC,eAAe,CAAM,GACrC,OAAO,CAAC,eAAe,CAAC;IAoB3B;;OAEG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAczE;;OAEG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAU5D;;OAEG;IACH,UAAU,IAAI,cAAc;IAI5B;;OAEG;IACH,aAAa,IAAI,OAAO;CAGzB;AAID;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,6BAAuB,CAAC;AAElD;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,oBAAoB,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAI7D;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,oBAAoB,CAK5D;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAM1E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,kBAAkB,EACtC,UAAU,GAAE,MAAa,GACxB,oBAAoB,CAOtB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,mBAAmB,CACvC,YAAY,EAAE,MAAM,EACpB,kBAAkB,EAAE,kBAAkB,EACtC,UAAU,GAAE,MAAa,GACxB,OAAO,CAAC,oBAAoB,CAAC,CAgB/B;AAGD,eAAe,oBAAoB,CAAC"}
|