@utaba/deep-memory 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2024 Utaba AI Ltd
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,224 @@
1
+ # @utaba/deep-memory
2
+
3
+ Vocabulary-driven graph memory for AI agents.
4
+
5
+ Deep Memory is a TypeScript library that gives AI agents structured, persistent memory as a knowledge graph. Instead of dumping raw text into vector stores, agents work with typed entities, validated relationships, and governed vocabularies — making memory queryable, portable, and auditable.
6
+
7
+ ## Why
8
+
9
+ AI agents need memory that goes beyond retrieval. They need to:
10
+
11
+ - **Store structured knowledge** — entities with typed properties and defined relationships, not just embeddings
12
+ - **Enforce consistency** — a vocabulary system acts as a schema contract, preventing drift as agents write autonomously
13
+ - **Trace provenance** — every mutation records who changed what, when, and in what conversation
14
+ - **Stay portable** — export a repository, import it elsewhere, migrate vocabularies across versions
15
+
16
+ Deep Memory provides these capabilities as functions, not tools. It is protocol-agnostic — the consuming application maps library functions to MCP tools, OpenAI function calls, Anthropic tool definitions, or whatever interface the agent framework requires.
17
+
18
+ ## Quick Start
19
+
20
+ ```typescript
21
+ import { DeepMemory, InMemoryStorageProvider } from '@utaba/deep-memory';
22
+
23
+ const memory = new DeepMemory({
24
+ storage: new InMemoryStorageProvider(),
25
+ provenance: { actorId: 'my-agent', actorType: 'agent' },
26
+ });
27
+
28
+ const repo = await memory.createRepository({
29
+ repositoryId: 'my-knowledge',
30
+ label: 'My Knowledge Graph',
31
+ vocabulary: {
32
+ entityTypes: [
33
+ { type: 'person', description: 'A person' },
34
+ { type: 'topic', description: 'A topic or concept' },
35
+ ],
36
+ relationshipTypes: [
37
+ {
38
+ type: 'interested_in',
39
+ description: 'A person is interested in a topic',
40
+ allowedSourceTypes: ['person'],
41
+ allowedTargetTypes: ['topic'],
42
+ },
43
+ ],
44
+ },
45
+ });
46
+
47
+ // Create entities — IDs are auto-generated GUIDs, with a deterministic slug
48
+ const alice = await repo.createEntity({
49
+ entityType: 'person',
50
+ label: 'Alice',
51
+ summary: 'Software engineer interested in graph databases',
52
+ });
53
+ // alice.id === 'a1b2c3d4-...' (GUID), alice.slug === 'person:alice'
54
+
55
+ const graphs = await repo.createEntity({
56
+ entityType: 'topic',
57
+ label: 'Graph Databases',
58
+ });
59
+
60
+ // Create relationships — validated against vocabulary constraints
61
+ await repo.createRelationship({
62
+ relationshipType: 'interested_in',
63
+ sourceEntityId: alice.entityId,
64
+ targetEntityId: graphs.entityId,
65
+ });
66
+
67
+ // Explore the graph
68
+ const neighbours = await repo.exploreNeighbourhood(alice.entityId);
69
+ // neighbours.layers[0]['interested_in'].entities === [{ label: 'Graph Databases', ... }]
70
+ ```
71
+
72
+ ## Installation
73
+
74
+ ```bash
75
+ npm install @utaba/deep-memory
76
+ ```
77
+
78
+ ## Core Concepts
79
+
80
+ - **Repository** — an isolated knowledge graph with its own vocabulary and entity space
81
+ - **Vocabulary** — a typed schema defining allowed entity types, relationship types, and property constraints. Governance modes (locked, managed, open) control how the vocabulary evolves
82
+ - **Entity** — a node in the graph with a type, label, summary, typed properties, and optional rich data
83
+ - **Relationship** — a typed, directional edge between two entities
84
+ - **Provenance** — automatic tracking of actor, timestamp, and conversation context on every mutation
85
+
86
+ ## Architecture
87
+
88
+ - **Zero runtime dependencies** — the core library has no npm dependencies
89
+ - **Provider pattern** — storage, search, and embedding are pluggable interfaces
90
+ - **Dual CJS/ESM build** — works in any Node.js environment
91
+ - **Functions, not tools** — Deep Memory is a library; wrap its functions as MCP tools, OpenAI functions, or Anthropic tools
92
+
93
+ ## Sub-path Exports
94
+
95
+ ```typescript
96
+ // Main API — classes, errors, built-in providers
97
+ import { DeepMemory, MemoryRepository, InMemoryStorageProvider } from '@utaba/deep-memory';
98
+
99
+ // Provider interfaces — for implementing custom providers
100
+ import type { StorageProvider, SearchProvider, EmbeddingProvider } from '@utaba/deep-memory/providers';
101
+
102
+ // Types only — for type annotations
103
+ import type { Entity, Relationship, MemoryVocabulary } from '@utaba/deep-memory/types';
104
+
105
+ // Testing — conformance suite for custom StorageProvider implementations
106
+ import { runStorageProviderConformanceTests } from '@utaba/deep-memory/testing';
107
+ ```
108
+
109
+ ## Provider Pattern
110
+
111
+ | Provider | Required | Purpose |
112
+ |----------|----------|---------|
113
+ | `StorageProvider` | Yes | Persistence (entities, relationships, vocabulary) |
114
+ | `SearchProvider` | No | Full-text search enhancement |
115
+ | `EmbeddingProvider` | No | Semantic/vector similarity search |
116
+ | `LockProvider` | No | Distributed locking (reserved) |
117
+
118
+ `InMemoryStorageProvider` ships as the reference implementation. For production, implement `StorageProvider` against your database and validate with the conformance test suite:
119
+
120
+ ```typescript
121
+ import { runStorageProviderConformanceTests } from '@utaba/deep-memory/testing';
122
+
123
+ runStorageProviderConformanceTests(() => new MyCosmosDBProvider(config));
124
+ ```
125
+
126
+ ## Vocabulary & Governance
127
+
128
+ Vocabularies define what kinds of entities and relationships can exist, with typed property schemas:
129
+
130
+ ```typescript
131
+ const repo = await memory.createRepository({
132
+ repositoryId: 'legal',
133
+ label: 'Legal Analysis',
134
+ vocabulary: {
135
+ entityTypes: [{
136
+ type: 'contract',
137
+ description: 'A legal contract',
138
+ properties: [
139
+ { name: 'value', type: 'number', required: false },
140
+ { name: 'status', type: 'enum', required: true, enumValues: ['draft', 'active', 'expired'] },
141
+ ],
142
+ }],
143
+ relationshipTypes: [/* ... */],
144
+ },
145
+ governance: { mode: 'managed' },
146
+ });
147
+ ```
148
+
149
+ Governance modes control vocabulary evolution:
150
+ - **locked** — vocabulary cannot change
151
+ - **managed** — changes require validation (and optionally human approval)
152
+ - **open** — validated changes auto-approve (with deduplication)
153
+
154
+ ## Events & Hooks
155
+
156
+ ```typescript
157
+ // Listen to lifecycle events
158
+ repo.on('entity:created', (event) => {
159
+ console.log(`Created: ${event.payload.entity.label}`);
160
+ });
161
+
162
+ // Cancel operations with pre-mutation hooks
163
+ repo.onHook('entity:creating', (event) => {
164
+ if (event.payload.input.entityType === 'secret') {
165
+ return { cancel: true, reason: 'Secrets are not allowed' };
166
+ }
167
+ return {};
168
+ });
169
+ ```
170
+
171
+ ## Error Handling
172
+
173
+ All errors extend `DeepMemoryError` with a `code` and actionable `suggestion`:
174
+
175
+ ```typescript
176
+ import { EntityNotFoundError, VocabularyValidationError } from '@utaba/deep-memory';
177
+
178
+ try {
179
+ await repo.getEntity('nonexistent');
180
+ } catch (err) {
181
+ if (err instanceof EntityNotFoundError) {
182
+ console.log(err.code); // 'ENTITY_NOT_FOUND'
183
+ console.log(err.suggestion); // 'Check the entity ID is correct...'
184
+ }
185
+ }
186
+ ```
187
+
188
+ ## Export / Import
189
+
190
+ Portable repository archives with vocabulary migration:
191
+
192
+ ```typescript
193
+ // Export
194
+ const archive = await memory.exportRepository('my-repo');
195
+
196
+ // Import into a new repository
197
+ await memory.importRepository(archive, {
198
+ target: { mode: 'create', repositoryId: 'copy', config: { repositoryId: 'copy', label: 'Copy' } },
199
+ });
200
+
201
+ // Merge into an existing repository
202
+ await memory.importRepository(archive, {
203
+ target: { mode: 'merge', repositoryId: 'existing' },
204
+ vocabularyConflict: 'extend', // 'reject' | 'extend' | 'prompt'
205
+ entityConflict: 'skip', // 'skip' | 'overwrite' | 'rename'
206
+ });
207
+ ```
208
+
209
+ ## Examples
210
+
211
+ See [`examples/`](examples/) for complete integration examples:
212
+
213
+ - **[Basic Usage](examples/basic-usage/)** — personal knowledge graph, legal domain vocabulary
214
+ - **[MCP Server](examples/mcp-server/)** — tool definitions for Model Context Protocol
215
+ - **[OpenAI Functions](examples/openai-functions/)** — function definitions for Chat Completions API
216
+ - **[Anthropic Tools](examples/anthropic-tools/)** — tool definitions for Messages API
217
+
218
+ ## Status
219
+
220
+ Under active development. Not yet published to npm.
221
+
222
+ ## License
223
+
224
+ Apache 2.0
@@ -0,0 +1,56 @@
1
+ import { S as StorageRepositoryConfig, a as StoredRepository, R as RepositoryFilter, P as PaginatedResult, b as StoredRepositorySummary, c as RepositoryUpdate, d as RepositoryStats, M as MemoryVocabulary, e as PaginationOptions, V as VocabularyChangeRecord, f as StoredEntity, g as StoredEntityUpdate, h as StorageFindQuery, i as StoredRelationship, j as RelationshipQueryOptions, k as StorageExploreOptions, l as StorageNeighbourhood, m as StoragePathOptions, n as StoragePathResult, o as StorageTimelineOptions, p as StorageTimelineResult, E as ExportChunk, I as ImportChunk, B as BulkImportResult } from './portability-DdlNYXGX.js';
2
+
3
+ /**
4
+ * StorageProvider — the primary persistence interface.
5
+ *
6
+ * Must be supplied when creating a DeepMemory instance. Handles all
7
+ * persistence of entities, relationships, vocabulary, and repositories.
8
+ *
9
+ * Works with "Stored" types (full internal representations including
10
+ * provenance and embeddings). The core engine maps these to public types
11
+ * based on the requested detail level.
12
+ */
13
+ interface StorageProvider {
14
+ /** Optional initialisation (e.g., database connection) */
15
+ initialise?(): Promise<void>;
16
+ /** Optional cleanup (e.g., close connections) */
17
+ dispose?(): Promise<void>;
18
+ /** Optional schema creation / migration (e.g., create tables if they don't exist) */
19
+ ensureSchema?(): Promise<void>;
20
+ createRepository(config: StorageRepositoryConfig): Promise<StoredRepository>;
21
+ getRepository(repositoryId: string): Promise<StoredRepository | null>;
22
+ listRepositories(filter?: RepositoryFilter): Promise<PaginatedResult<StoredRepositorySummary>>;
23
+ updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
24
+ deleteRepository(repositoryId: string): Promise<void>;
25
+ getRepositoryStats(repositoryId: string): Promise<RepositoryStats>;
26
+ getVocabulary(repositoryId: string): Promise<MemoryVocabulary>;
27
+ saveVocabulary(repositoryId: string, vocabulary: MemoryVocabulary): Promise<void>;
28
+ getVocabularyChangeLog(repositoryId: string, options?: PaginationOptions): Promise<PaginatedResult<VocabularyChangeRecord>>;
29
+ createEntity(repositoryId: string, entity: StoredEntity): Promise<StoredEntity>;
30
+ getEntity(repositoryId: string, entityId: string): Promise<StoredEntity | null>;
31
+ getEntityBySlug(repositoryId: string, slug: string): Promise<StoredEntity | null>;
32
+ getEntities(repositoryId: string, entityIds: string[]): Promise<Map<string, StoredEntity>>;
33
+ updateEntity(repositoryId: string, entityId: string, updates: StoredEntityUpdate): Promise<StoredEntity>;
34
+ deleteEntity(repositoryId: string, entityId: string): Promise<void>;
35
+ /** Delete all entities of a given type and their associated relationships */
36
+ deleteEntitiesByType(repositoryId: string, entityType: string): Promise<{
37
+ deletedEntities: number;
38
+ deletedRelationships: number;
39
+ }>;
40
+ findEntities(repositoryId: string, query: StorageFindQuery): Promise<PaginatedResult<StoredEntity>>;
41
+ createRelationship(repositoryId: string, relationship: StoredRelationship): Promise<StoredRelationship>;
42
+ getRelationship(repositoryId: string, relationshipId: string): Promise<StoredRelationship | null>;
43
+ getEntityRelationships(repositoryId: string, entityId: string, options?: RelationshipQueryOptions): Promise<PaginatedResult<StoredRelationship>>;
44
+ deleteRelationship(repositoryId: string, relationshipId: string): Promise<void>;
45
+ /** Delete all relationships of a given type */
46
+ deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
47
+ deletedRelationships: number;
48
+ }>;
49
+ exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
50
+ findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
51
+ getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
52
+ exportAll(repositoryId: string): AsyncIterable<ExportChunk>;
53
+ importBulk(repositoryId: string, data: ImportChunk[]): Promise<BulkImportResult>;
54
+ }
55
+
56
+ export type { StorageProvider as S };
@@ -0,0 +1,56 @@
1
+ import { S as StorageRepositoryConfig, a as StoredRepository, R as RepositoryFilter, P as PaginatedResult, b as StoredRepositorySummary, c as RepositoryUpdate, d as RepositoryStats, M as MemoryVocabulary, e as PaginationOptions, V as VocabularyChangeRecord, f as StoredEntity, g as StoredEntityUpdate, h as StorageFindQuery, i as StoredRelationship, j as RelationshipQueryOptions, k as StorageExploreOptions, l as StorageNeighbourhood, m as StoragePathOptions, n as StoragePathResult, o as StorageTimelineOptions, p as StorageTimelineResult, E as ExportChunk, I as ImportChunk, B as BulkImportResult } from './portability-DdlNYXGX.cjs';
2
+
3
+ /**
4
+ * StorageProvider — the primary persistence interface.
5
+ *
6
+ * Must be supplied when creating a DeepMemory instance. Handles all
7
+ * persistence of entities, relationships, vocabulary, and repositories.
8
+ *
9
+ * Works with "Stored" types (full internal representations including
10
+ * provenance and embeddings). The core engine maps these to public types
11
+ * based on the requested detail level.
12
+ */
13
+ interface StorageProvider {
14
+ /** Optional initialisation (e.g., database connection) */
15
+ initialise?(): Promise<void>;
16
+ /** Optional cleanup (e.g., close connections) */
17
+ dispose?(): Promise<void>;
18
+ /** Optional schema creation / migration (e.g., create tables if they don't exist) */
19
+ ensureSchema?(): Promise<void>;
20
+ createRepository(config: StorageRepositoryConfig): Promise<StoredRepository>;
21
+ getRepository(repositoryId: string): Promise<StoredRepository | null>;
22
+ listRepositories(filter?: RepositoryFilter): Promise<PaginatedResult<StoredRepositorySummary>>;
23
+ updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
24
+ deleteRepository(repositoryId: string): Promise<void>;
25
+ getRepositoryStats(repositoryId: string): Promise<RepositoryStats>;
26
+ getVocabulary(repositoryId: string): Promise<MemoryVocabulary>;
27
+ saveVocabulary(repositoryId: string, vocabulary: MemoryVocabulary): Promise<void>;
28
+ getVocabularyChangeLog(repositoryId: string, options?: PaginationOptions): Promise<PaginatedResult<VocabularyChangeRecord>>;
29
+ createEntity(repositoryId: string, entity: StoredEntity): Promise<StoredEntity>;
30
+ getEntity(repositoryId: string, entityId: string): Promise<StoredEntity | null>;
31
+ getEntityBySlug(repositoryId: string, slug: string): Promise<StoredEntity | null>;
32
+ getEntities(repositoryId: string, entityIds: string[]): Promise<Map<string, StoredEntity>>;
33
+ updateEntity(repositoryId: string, entityId: string, updates: StoredEntityUpdate): Promise<StoredEntity>;
34
+ deleteEntity(repositoryId: string, entityId: string): Promise<void>;
35
+ /** Delete all entities of a given type and their associated relationships */
36
+ deleteEntitiesByType(repositoryId: string, entityType: string): Promise<{
37
+ deletedEntities: number;
38
+ deletedRelationships: number;
39
+ }>;
40
+ findEntities(repositoryId: string, query: StorageFindQuery): Promise<PaginatedResult<StoredEntity>>;
41
+ createRelationship(repositoryId: string, relationship: StoredRelationship): Promise<StoredRelationship>;
42
+ getRelationship(repositoryId: string, relationshipId: string): Promise<StoredRelationship | null>;
43
+ getEntityRelationships(repositoryId: string, entityId: string, options?: RelationshipQueryOptions): Promise<PaginatedResult<StoredRelationship>>;
44
+ deleteRelationship(repositoryId: string, relationshipId: string): Promise<void>;
45
+ /** Delete all relationships of a given type */
46
+ deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
47
+ deletedRelationships: number;
48
+ }>;
49
+ exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
50
+ findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
51
+ getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
52
+ exportAll(repositoryId: string): AsyncIterable<ExportChunk>;
53
+ importBulk(repositoryId: string, data: ImportChunk[]): Promise<BulkImportResult>;
54
+ }
55
+
56
+ export type { StorageProvider as S };