@utaba/deep-memory 0.2.0 → 0.4.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/dist/index.d.cts CHANGED
@@ -1,9 +1,9 @@
1
- import { G as GovernanceConfig, M as MemoryVocabulary, u as ResolvedVocabulary, C as CreateEntityInput, U as UpdateEntityInput, v as CreateRelationshipInput, w as EntityTypeDefinition, x as VocabularyProposal, y as VocabularyProposalResult, z as ProvenanceContext, A as Provenance, E as Entity, D as DetailLevel, a as EntitySummary, b as EntityBrief, F as FindEntitiesQuery, d as PaginatedResult, H as ReembedResult, J as Relationship, P as PropertyFilter, K as RelationshipSummary, L as GraphResult, N as ExploreOptions, O as Neighbourhood, Q as PathOptions, T as PathResult, W as ConceptSearchOptions, X as ScoredEntity, Y as TimelineOptions, Z as TimelineResult, g as RepositoryStats, _ as RepositoryConfig, R as RepositoryFilter, $ as RepositorySummary, f as RepositoryUpdate, c as StoredRepository, a0 as ExportOptions, a1 as ExportArchive, a2 as ImportOptions, a3 as ImportResult, a4 as ExportStreamItem, a5 as ImportStreamHeader, I as ImportChunk, S as StorageRepositoryConfig, e as StoredRepositorySummary, h as PaginationOptions, V as VocabularyChangeRecord, i as StoredEntity, j as StoredEntityUpdate, k as StorageFindQuery, l as StoredRelationship, m as RelationshipQueryOptions, n as StorageExploreOptions, o as StorageNeighbourhood, p as StoragePathOptions, q as StoragePathResult, r as StorageTimelineOptions, s as StorageTimelineResult, t as ExportChunk, B as BulkImportResult, a6 as SearchOptions, a7 as SearchHit } from './portability-DdjsCB07.cjs';
2
- export { a8 as EnrichedRelationship, a9 as EntityMap, aa as EntityTypeInput, ab as ExportLegalMetadata, ac as ExportManifest, ad as ExportPipelineMetadata, ae as GetEntitiesOptions, af as GetEntityOptions, ag as GovernanceMode, ah as ImportWarning, ai as NeighbourhoodCentre, aj as NeighbourhoodGroup, ak as NeighbourhoodLayer, al as Path, am as PropertySchema, an as PropertyType, ao as ProvenanceFilter, ap as RelationshipDirection, aq as RelationshipTypeDefinition, ar as RelationshipTypeInput, as as RepositoryMetadata, at as StorageNeighbourhoodGroup, au as StorageNeighbourhoodLayer, av as StoragePath, aw as StorageTimelineEvent, ax as TimelineEntityRef, ay as TimelineEvent, az as TimelineRelationshipDetail, aA as VocabularyInput } from './portability-DdjsCB07.cjs';
1
+ import { G as GovernanceConfig, M as MemoryVocabulary, x as ResolvedVocabulary, C as CreateEntityInput, U as UpdateEntityInput, y as CreateRelationshipInput, z as EntityTypeDefinition, A as VocabularyProposal, F as VocabularyProposalResult, H as ProvenanceContext, J as Provenance, E as Entity, D as DetailLevel, a as EntitySummary, b as EntityBrief, K as FindEntitiesQuery, e as PaginatedResult, L as ReembedResult, N as Relationship, P as PropertyFilter, R as RelationshipSummary, O as GraphResult, Q as ExploreOptions, T as Neighborhood, W as PathOptions, X as PathResult, Y as ConceptSearchOptions, Z as ScoredEntity, _ as TimelineOptions, $ as TimelineResult, i as RepositoryStats, a0 as RepositoryConfig, d as RepositoryFilter, a1 as RepositorySummary, g as RepositoryUpdate, c as StoredRepository, a2 as ExportOptions, a3 as ExportArchive, a4 as ImportOptions, a5 as ImportResult, a6 as ExportStreamItem, a7 as ImportStreamHeader, I as ImportChunk, S as StorageRepositoryConfig, f as StoredRepositorySummary, h as DeleteProgressCallback, j as PaginationOptions, V as VocabularyChangeRecord, k as StoredEntity, l as StoredEntityUpdate, m as StorageFindQuery, n as StoredRelationship, o as RelationshipQueryOptions, p as StorageExploreOptions, q as StorageNeighborhood, r as StoragePathOptions, s as StoragePathResult, t as StorageTimelineOptions, u as StorageTimelineResult, v as ExportChunk, B as BulkImportOptions, w as BulkImportResult, a8 as SearchOptions, a9 as SearchHit } from './portability-B-8J4nQQ.cjs';
2
+ export { aa as EnrichedRelationship, ab as EntityMap, ac as EntityTypeInput, ad as ExportLegalMetadata, ae as ExportManifest, af as ExportPipelineMetadata, ag as GetEntitiesOptions, ah as GetEntityOptions, ai as GovernanceMode, aj as ImportWarning, ak as NeighborhoodCenter, al as NeighborhoodGroup, am as NeighborhoodLayer, an as Path, ao as PropertySchema, ap as PropertyType, aq as ProvenanceFilter, ar as RelationshipDirection, as as RelationshipTypeDefinition, at as RelationshipTypeInput, au as RepositoryMetadata, av as StorageNeighborhoodGroup, aw as StorageNeighborhoodLayer, ax as StoragePath, ay as StorageTimelineEvent, az as TimelineEntityRef, aA as TimelineEvent, aB as TimelineRelationshipDetail, aC as VocabularyInput } from './portability-B-8J4nQQ.cjs';
3
3
  import { DeepMemoryEventType, EventHandler, Unsubscribe, DeepMemoryEvent, HookResult, EventPayload } from './types/index.cjs';
4
- import { T as TraversalSpec, a as TraversalResult } from './traversal-BB_yERbf.cjs';
5
- export { Q as QueryMetadata, b as TraversalPath, c as TraversalRelationship, d as TraversalReturnMode, e as TraversalStart, f as TraversalStep } from './traversal-BB_yERbf.cjs';
6
- import { S as StorageProvider, E as EnsureSchemaResult } from './StorageProvider-C3tKhfuw.cjs';
4
+ import { T as TraversalSpec, a as TraversalResult } from './traversal-Llalk03r.cjs';
5
+ export { Q as QueryMetadata, b as TraversalAggregation, c as TraversalPath, d as TraversalProjection, e as TraversalRelationship, f as TraversalReturnMode, g as TraversalStart, h as TraversalStep } from './traversal-Llalk03r.cjs';
6
+ import { S as StorageProvider, E as EnsureSchemaResult } from './StorageProvider-CBhwqavV.cjs';
7
7
  import { EmbeddingProvider, SearchProvider, GraphTraversalProvider, LockProvider, SearchableEntity } from './providers/index.cjs';
8
8
  export { GraphTraversalCapabilities, LockHandle, LockOptions } from './providers/index.cjs';
9
9
 
@@ -292,13 +292,23 @@ declare class MemoryRepository {
292
292
  offset?: number;
293
293
  detailLevel?: DetailLevel;
294
294
  }): Promise<GraphResult>;
295
- exploreNeighbourhood(entityId: string, options?: ExploreOptions): Promise<Neighbourhood>;
295
+ exploreNeighborhood(entityId: string, options?: ExploreOptions): Promise<Neighborhood>;
296
296
  findPaths(sourceId: string, targetId: string, options?: PathOptions): Promise<PathResult>;
297
297
  traverse(spec: TraversalSpec): Promise<TraversalResult>;
298
298
  executeNativeQuery(query: string, params?: Record<string, unknown>): Promise<TraversalResult>;
299
299
  searchByConcept(query: string, options?: ConceptSearchOptions): Promise<PaginatedResult<ScoredEntity>>;
300
300
  getTimeline(entityId: string, options?: TimelineOptions): Promise<TimelineResult>;
301
301
  getStats(): Promise<RepositoryStats>;
302
+ /** Delete all entities and relationships in this repository, preserving the repository and vocabulary */
303
+ deleteAllContents(): Promise<{
304
+ deletedEntities: number;
305
+ deletedRelationships: number;
306
+ }>;
307
+ /**
308
+ * Returns a static markdown guide describing the recommended query strategy
309
+ * for AI agents and other consumers of the repository.
310
+ */
311
+ getQueryGuide(): string;
302
312
  on<E extends DeepMemoryEventType>(event: E, handler: EventHandler<E>): Unsubscribe;
303
313
  onHook<E extends Extract<DeepMemoryEventType, 'entity:creating' | 'entity:updating' | 'entity:deleting' | 'relationship:creating' | 'relationship:removing'>>(event: E, handler: HookHandler<E>): Unsubscribe;
304
314
  }
@@ -331,10 +341,10 @@ declare class DeepMemory {
331
341
  private readonly graphTraversalProvider?;
332
342
  private readonly provenance;
333
343
  private readonly globalEventBus;
334
- private initialised;
344
+ private initialized;
335
345
  constructor(config: DeepMemoryConfig);
336
- /** Initialise the storage provider and optional providers (call once before use) */
337
- private ensureInitialised;
346
+ /** Initialize the storage provider and optional providers (call once before use) */
347
+ private ensureInitialized;
338
348
  /** Create or migrate the storage schema. Call once at deployment / startup, not per-request. */
339
349
  ensureSchema(): Promise<EnsureSchemaResult>;
340
350
  private validateRepositoryId;
@@ -348,6 +358,11 @@ declare class DeepMemory {
348
358
  updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
349
359
  /** Delete a repository */
350
360
  deleteRepository(repositoryId: string): Promise<void>;
361
+ /** Delete all entities and relationships in a repository, preserving the repository and vocabulary */
362
+ deleteAllContents(repositoryId: string): Promise<{
363
+ deletedEntities: number;
364
+ deletedRelationships: number;
365
+ }>;
351
366
  /** Export a repository to a portable archive */
352
367
  exportRepository(repositoryId: string, options?: ExportOptions): Promise<ExportArchive>;
353
368
  /** Import a repository from a portable archive */
@@ -405,13 +420,17 @@ declare class CypherCompiler implements TraversalCompiler {
405
420
  declare class InMemoryStorageProvider implements StorageProvider {
406
421
  private stores;
407
422
  private getStore;
408
- initialise(): Promise<void>;
423
+ initialize(): Promise<void>;
409
424
  dispose(): Promise<void>;
410
425
  createRepository(config: StorageRepositoryConfig): Promise<StoredRepository>;
411
426
  getRepository(repositoryId: string): Promise<StoredRepository | null>;
412
427
  listRepositories(filter?: RepositoryFilter): Promise<PaginatedResult<StoredRepositorySummary>>;
413
428
  updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
414
- deleteRepository(repositoryId: string): Promise<void>;
429
+ deleteRepository(repositoryId: string, _onProgress?: DeleteProgressCallback): Promise<void>;
430
+ deleteAllContents(repositoryId: string, _onProgress?: DeleteProgressCallback): Promise<{
431
+ deletedEntities: number;
432
+ deletedRelationships: number;
433
+ }>;
415
434
  getRepositoryStats(repositoryId: string): Promise<RepositoryStats>;
416
435
  getVocabulary(repositoryId: string): Promise<MemoryVocabulary>;
417
436
  saveVocabulary(repositoryId: string, vocabulary: MemoryVocabulary): Promise<void>;
@@ -434,11 +453,11 @@ declare class InMemoryStorageProvider implements StorageProvider {
434
453
  deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
435
454
  deletedRelationships: number;
436
455
  }>;
437
- exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
456
+ exploreNeighborhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighborhood>;
438
457
  findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
439
458
  getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
440
459
  exportAll(repositoryId: string): AsyncIterable<ExportChunk>;
441
- importBulk(repositoryId: string, data: ImportChunk[]): Promise<BulkImportResult>;
460
+ importBulk(repositoryId: string, data: ImportChunk[], _options?: BulkImportOptions): Promise<BulkImportResult>;
442
461
  }
443
462
 
444
463
  declare class InMemorySearchProvider implements SearchProvider {
@@ -457,4 +476,4 @@ declare class NoOpEmbeddingProvider implements EmbeddingProvider {
457
476
  modelId(): string;
458
477
  }
459
478
 
460
- export { BulkImportResult, type CompiledQuery, ConceptSearchOptions, CreateEntityInput, CreateRelationshipInput, CypherCompiler, DeepMemory, type DeepMemoryConfig, DeepMemoryError, type DeepMemoryErrorCode, DeepMemoryEvent, DeepMemoryEventType, DetailLevel, DuplicateEntityError, DuplicateRelationshipError, DuplicateRepositoryError, EmbeddingProvider, EmbeddingProviderRequiredError, EnsureSchemaResult, Entity, EntityBrief, EntityNotFoundError, EntitySummary, EntityTypeDefinition, EventHandler, EventPayload, ExploreOptions, ExportArchive, ExportChunk, ExportError, ExportOptions, ExportStreamItem, FindEntitiesQuery, GovernanceConfig, GovernanceDeniedError, GraphResult, GraphTraversalProvider, GraphTraversalProviderRequiredError, GremlinCompiler, HookResult, ImportChunk, ImportError, ImportOptions, ImportResult, ImportStreamHeader, InMemorySearchProvider, InMemoryStorageProvider, InvalidInputError, LockProvider, MemoryRepository, MemoryVocabulary, Neighbourhood, NoOpEmbeddingProvider, OperationCancelledError, PaginatedResult, PaginationOptions, PathOptions, PathResult, PropertyFilter, Provenance, ProvenanceContext, ProviderError, ReembedResult, Relationship, RelationshipConstraintError, RelationshipNotFoundError, RelationshipQueryOptions, RelationshipSummary, RepositoryConfig, RepositoryFilter, RepositoryNotFoundError, RepositoryStats, RepositorySummary, RepositoryUpdate, ResolvedVocabulary, ScoredEntity, SearchHit, SearchOptions, SearchProvider, SearchableEntity, StorageExploreOptions, StorageFindQuery, StorageNeighbourhood, StoragePathOptions, StoragePathResult, StorageProvider, StorageRepositoryConfig, StorageTimelineOptions, StorageTimelineResult, StoredEntity, StoredEntityUpdate, StoredRelationship, StoredRepository, StoredRepositorySummary, TimelineOptions, TimelineResult, type TraversalCompiler, TraversalResult, TraversalSpec, TraversalTimeoutError, TraversalValidationError, TraversalVocabularyError, Unsubscribe, UpdateEntityInput, VocabularyChangeRecord, VocabularyProposal, VocabularyProposalResult, VocabularyValidationError, generateId, isValidUuid, matchesPropertyFilters };
479
+ export { BulkImportOptions, BulkImportResult, type CompiledQuery, ConceptSearchOptions, CreateEntityInput, CreateRelationshipInput, CypherCompiler, DeepMemory, type DeepMemoryConfig, DeepMemoryError, type DeepMemoryErrorCode, DeepMemoryEvent, DeepMemoryEventType, DeleteProgressCallback, DetailLevel, DuplicateEntityError, DuplicateRelationshipError, DuplicateRepositoryError, EmbeddingProvider, EmbeddingProviderRequiredError, EnsureSchemaResult, Entity, EntityBrief, EntityNotFoundError, EntitySummary, EntityTypeDefinition, EventHandler, EventPayload, ExploreOptions, ExportArchive, ExportChunk, ExportError, ExportOptions, ExportStreamItem, FindEntitiesQuery, GovernanceConfig, GovernanceDeniedError, GraphResult, GraphTraversalProvider, GraphTraversalProviderRequiredError, GremlinCompiler, HookResult, ImportChunk, ImportError, ImportOptions, ImportResult, ImportStreamHeader, InMemorySearchProvider, InMemoryStorageProvider, InvalidInputError, LockProvider, MemoryRepository, MemoryVocabulary, Neighborhood, NoOpEmbeddingProvider, OperationCancelledError, PaginatedResult, PaginationOptions, PathOptions, PathResult, PropertyFilter, Provenance, ProvenanceContext, ProviderError, ReembedResult, Relationship, RelationshipConstraintError, RelationshipNotFoundError, RelationshipQueryOptions, RelationshipSummary, RepositoryConfig, RepositoryFilter, RepositoryNotFoundError, RepositoryStats, RepositorySummary, RepositoryUpdate, ResolvedVocabulary, ScoredEntity, SearchHit, SearchOptions, SearchProvider, SearchableEntity, StorageExploreOptions, StorageFindQuery, StorageNeighborhood, StoragePathOptions, StoragePathResult, StorageProvider, StorageRepositoryConfig, StorageTimelineOptions, StorageTimelineResult, StoredEntity, StoredEntityUpdate, StoredRelationship, StoredRepository, StoredRepositorySummary, TimelineOptions, TimelineResult, type TraversalCompiler, TraversalResult, TraversalSpec, TraversalTimeoutError, TraversalValidationError, TraversalVocabularyError, Unsubscribe, UpdateEntityInput, VocabularyChangeRecord, VocabularyProposal, VocabularyProposalResult, VocabularyValidationError, generateId, isValidUuid, matchesPropertyFilters };
package/dist/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
- import { G as GovernanceConfig, M as MemoryVocabulary, u as ResolvedVocabulary, C as CreateEntityInput, U as UpdateEntityInput, v as CreateRelationshipInput, w as EntityTypeDefinition, x as VocabularyProposal, y as VocabularyProposalResult, z as ProvenanceContext, A as Provenance, E as Entity, D as DetailLevel, a as EntitySummary, b as EntityBrief, F as FindEntitiesQuery, d as PaginatedResult, H as ReembedResult, J as Relationship, P as PropertyFilter, K as RelationshipSummary, L as GraphResult, N as ExploreOptions, O as Neighbourhood, Q as PathOptions, T as PathResult, W as ConceptSearchOptions, X as ScoredEntity, Y as TimelineOptions, Z as TimelineResult, g as RepositoryStats, _ as RepositoryConfig, R as RepositoryFilter, $ as RepositorySummary, f as RepositoryUpdate, c as StoredRepository, a0 as ExportOptions, a1 as ExportArchive, a2 as ImportOptions, a3 as ImportResult, a4 as ExportStreamItem, a5 as ImportStreamHeader, I as ImportChunk, S as StorageRepositoryConfig, e as StoredRepositorySummary, h as PaginationOptions, V as VocabularyChangeRecord, i as StoredEntity, j as StoredEntityUpdate, k as StorageFindQuery, l as StoredRelationship, m as RelationshipQueryOptions, n as StorageExploreOptions, o as StorageNeighbourhood, p as StoragePathOptions, q as StoragePathResult, r as StorageTimelineOptions, s as StorageTimelineResult, t as ExportChunk, B as BulkImportResult, a6 as SearchOptions, a7 as SearchHit } from './portability-DdjsCB07.js';
2
- export { a8 as EnrichedRelationship, a9 as EntityMap, aa as EntityTypeInput, ab as ExportLegalMetadata, ac as ExportManifest, ad as ExportPipelineMetadata, ae as GetEntitiesOptions, af as GetEntityOptions, ag as GovernanceMode, ah as ImportWarning, ai as NeighbourhoodCentre, aj as NeighbourhoodGroup, ak as NeighbourhoodLayer, al as Path, am as PropertySchema, an as PropertyType, ao as ProvenanceFilter, ap as RelationshipDirection, aq as RelationshipTypeDefinition, ar as RelationshipTypeInput, as as RepositoryMetadata, at as StorageNeighbourhoodGroup, au as StorageNeighbourhoodLayer, av as StoragePath, aw as StorageTimelineEvent, ax as TimelineEntityRef, ay as TimelineEvent, az as TimelineRelationshipDetail, aA as VocabularyInput } from './portability-DdjsCB07.js';
1
+ import { G as GovernanceConfig, M as MemoryVocabulary, x as ResolvedVocabulary, C as CreateEntityInput, U as UpdateEntityInput, y as CreateRelationshipInput, z as EntityTypeDefinition, A as VocabularyProposal, F as VocabularyProposalResult, H as ProvenanceContext, J as Provenance, E as Entity, D as DetailLevel, a as EntitySummary, b as EntityBrief, K as FindEntitiesQuery, e as PaginatedResult, L as ReembedResult, N as Relationship, P as PropertyFilter, R as RelationshipSummary, O as GraphResult, Q as ExploreOptions, T as Neighborhood, W as PathOptions, X as PathResult, Y as ConceptSearchOptions, Z as ScoredEntity, _ as TimelineOptions, $ as TimelineResult, i as RepositoryStats, a0 as RepositoryConfig, d as RepositoryFilter, a1 as RepositorySummary, g as RepositoryUpdate, c as StoredRepository, a2 as ExportOptions, a3 as ExportArchive, a4 as ImportOptions, a5 as ImportResult, a6 as ExportStreamItem, a7 as ImportStreamHeader, I as ImportChunk, S as StorageRepositoryConfig, f as StoredRepositorySummary, h as DeleteProgressCallback, j as PaginationOptions, V as VocabularyChangeRecord, k as StoredEntity, l as StoredEntityUpdate, m as StorageFindQuery, n as StoredRelationship, o as RelationshipQueryOptions, p as StorageExploreOptions, q as StorageNeighborhood, r as StoragePathOptions, s as StoragePathResult, t as StorageTimelineOptions, u as StorageTimelineResult, v as ExportChunk, B as BulkImportOptions, w as BulkImportResult, a8 as SearchOptions, a9 as SearchHit } from './portability-B-8J4nQQ.js';
2
+ export { aa as EnrichedRelationship, ab as EntityMap, ac as EntityTypeInput, ad as ExportLegalMetadata, ae as ExportManifest, af as ExportPipelineMetadata, ag as GetEntitiesOptions, ah as GetEntityOptions, ai as GovernanceMode, aj as ImportWarning, ak as NeighborhoodCenter, al as NeighborhoodGroup, am as NeighborhoodLayer, an as Path, ao as PropertySchema, ap as PropertyType, aq as ProvenanceFilter, ar as RelationshipDirection, as as RelationshipTypeDefinition, at as RelationshipTypeInput, au as RepositoryMetadata, av as StorageNeighborhoodGroup, aw as StorageNeighborhoodLayer, ax as StoragePath, ay as StorageTimelineEvent, az as TimelineEntityRef, aA as TimelineEvent, aB as TimelineRelationshipDetail, aC as VocabularyInput } from './portability-B-8J4nQQ.js';
3
3
  import { DeepMemoryEventType, EventHandler, Unsubscribe, DeepMemoryEvent, HookResult, EventPayload } from './types/index.js';
4
- import { T as TraversalSpec, a as TraversalResult } from './traversal-9JdiqjZ9.js';
5
- export { Q as QueryMetadata, b as TraversalPath, c as TraversalRelationship, d as TraversalReturnMode, e as TraversalStart, f as TraversalStep } from './traversal-9JdiqjZ9.js';
6
- import { S as StorageProvider, E as EnsureSchemaResult } from './StorageProvider-DR9HLYHJ.js';
4
+ import { T as TraversalSpec, a as TraversalResult } from './traversal-BdmDLMxV.js';
5
+ export { Q as QueryMetadata, b as TraversalAggregation, c as TraversalPath, d as TraversalProjection, e as TraversalRelationship, f as TraversalReturnMode, g as TraversalStart, h as TraversalStep } from './traversal-BdmDLMxV.js';
6
+ import { S as StorageProvider, E as EnsureSchemaResult } from './StorageProvider-ynfpc5wz.js';
7
7
  import { EmbeddingProvider, SearchProvider, GraphTraversalProvider, LockProvider, SearchableEntity } from './providers/index.js';
8
8
  export { GraphTraversalCapabilities, LockHandle, LockOptions } from './providers/index.js';
9
9
 
@@ -292,13 +292,23 @@ declare class MemoryRepository {
292
292
  offset?: number;
293
293
  detailLevel?: DetailLevel;
294
294
  }): Promise<GraphResult>;
295
- exploreNeighbourhood(entityId: string, options?: ExploreOptions): Promise<Neighbourhood>;
295
+ exploreNeighborhood(entityId: string, options?: ExploreOptions): Promise<Neighborhood>;
296
296
  findPaths(sourceId: string, targetId: string, options?: PathOptions): Promise<PathResult>;
297
297
  traverse(spec: TraversalSpec): Promise<TraversalResult>;
298
298
  executeNativeQuery(query: string, params?: Record<string, unknown>): Promise<TraversalResult>;
299
299
  searchByConcept(query: string, options?: ConceptSearchOptions): Promise<PaginatedResult<ScoredEntity>>;
300
300
  getTimeline(entityId: string, options?: TimelineOptions): Promise<TimelineResult>;
301
301
  getStats(): Promise<RepositoryStats>;
302
+ /** Delete all entities and relationships in this repository, preserving the repository and vocabulary */
303
+ deleteAllContents(): Promise<{
304
+ deletedEntities: number;
305
+ deletedRelationships: number;
306
+ }>;
307
+ /**
308
+ * Returns a static markdown guide describing the recommended query strategy
309
+ * for AI agents and other consumers of the repository.
310
+ */
311
+ getQueryGuide(): string;
302
312
  on<E extends DeepMemoryEventType>(event: E, handler: EventHandler<E>): Unsubscribe;
303
313
  onHook<E extends Extract<DeepMemoryEventType, 'entity:creating' | 'entity:updating' | 'entity:deleting' | 'relationship:creating' | 'relationship:removing'>>(event: E, handler: HookHandler<E>): Unsubscribe;
304
314
  }
@@ -331,10 +341,10 @@ declare class DeepMemory {
331
341
  private readonly graphTraversalProvider?;
332
342
  private readonly provenance;
333
343
  private readonly globalEventBus;
334
- private initialised;
344
+ private initialized;
335
345
  constructor(config: DeepMemoryConfig);
336
- /** Initialise the storage provider and optional providers (call once before use) */
337
- private ensureInitialised;
346
+ /** Initialize the storage provider and optional providers (call once before use) */
347
+ private ensureInitialized;
338
348
  /** Create or migrate the storage schema. Call once at deployment / startup, not per-request. */
339
349
  ensureSchema(): Promise<EnsureSchemaResult>;
340
350
  private validateRepositoryId;
@@ -348,6 +358,11 @@ declare class DeepMemory {
348
358
  updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
349
359
  /** Delete a repository */
350
360
  deleteRepository(repositoryId: string): Promise<void>;
361
+ /** Delete all entities and relationships in a repository, preserving the repository and vocabulary */
362
+ deleteAllContents(repositoryId: string): Promise<{
363
+ deletedEntities: number;
364
+ deletedRelationships: number;
365
+ }>;
351
366
  /** Export a repository to a portable archive */
352
367
  exportRepository(repositoryId: string, options?: ExportOptions): Promise<ExportArchive>;
353
368
  /** Import a repository from a portable archive */
@@ -405,13 +420,17 @@ declare class CypherCompiler implements TraversalCompiler {
405
420
  declare class InMemoryStorageProvider implements StorageProvider {
406
421
  private stores;
407
422
  private getStore;
408
- initialise(): Promise<void>;
423
+ initialize(): Promise<void>;
409
424
  dispose(): Promise<void>;
410
425
  createRepository(config: StorageRepositoryConfig): Promise<StoredRepository>;
411
426
  getRepository(repositoryId: string): Promise<StoredRepository | null>;
412
427
  listRepositories(filter?: RepositoryFilter): Promise<PaginatedResult<StoredRepositorySummary>>;
413
428
  updateRepository(repositoryId: string, updates: RepositoryUpdate): Promise<StoredRepository>;
414
- deleteRepository(repositoryId: string): Promise<void>;
429
+ deleteRepository(repositoryId: string, _onProgress?: DeleteProgressCallback): Promise<void>;
430
+ deleteAllContents(repositoryId: string, _onProgress?: DeleteProgressCallback): Promise<{
431
+ deletedEntities: number;
432
+ deletedRelationships: number;
433
+ }>;
415
434
  getRepositoryStats(repositoryId: string): Promise<RepositoryStats>;
416
435
  getVocabulary(repositoryId: string): Promise<MemoryVocabulary>;
417
436
  saveVocabulary(repositoryId: string, vocabulary: MemoryVocabulary): Promise<void>;
@@ -434,11 +453,11 @@ declare class InMemoryStorageProvider implements StorageProvider {
434
453
  deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
435
454
  deletedRelationships: number;
436
455
  }>;
437
- exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
456
+ exploreNeighborhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighborhood>;
438
457
  findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
439
458
  getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
440
459
  exportAll(repositoryId: string): AsyncIterable<ExportChunk>;
441
- importBulk(repositoryId: string, data: ImportChunk[]): Promise<BulkImportResult>;
460
+ importBulk(repositoryId: string, data: ImportChunk[], _options?: BulkImportOptions): Promise<BulkImportResult>;
442
461
  }
443
462
 
444
463
  declare class InMemorySearchProvider implements SearchProvider {
@@ -457,4 +476,4 @@ declare class NoOpEmbeddingProvider implements EmbeddingProvider {
457
476
  modelId(): string;
458
477
  }
459
478
 
460
- export { BulkImportResult, type CompiledQuery, ConceptSearchOptions, CreateEntityInput, CreateRelationshipInput, CypherCompiler, DeepMemory, type DeepMemoryConfig, DeepMemoryError, type DeepMemoryErrorCode, DeepMemoryEvent, DeepMemoryEventType, DetailLevel, DuplicateEntityError, DuplicateRelationshipError, DuplicateRepositoryError, EmbeddingProvider, EmbeddingProviderRequiredError, EnsureSchemaResult, Entity, EntityBrief, EntityNotFoundError, EntitySummary, EntityTypeDefinition, EventHandler, EventPayload, ExploreOptions, ExportArchive, ExportChunk, ExportError, ExportOptions, ExportStreamItem, FindEntitiesQuery, GovernanceConfig, GovernanceDeniedError, GraphResult, GraphTraversalProvider, GraphTraversalProviderRequiredError, GremlinCompiler, HookResult, ImportChunk, ImportError, ImportOptions, ImportResult, ImportStreamHeader, InMemorySearchProvider, InMemoryStorageProvider, InvalidInputError, LockProvider, MemoryRepository, MemoryVocabulary, Neighbourhood, NoOpEmbeddingProvider, OperationCancelledError, PaginatedResult, PaginationOptions, PathOptions, PathResult, PropertyFilter, Provenance, ProvenanceContext, ProviderError, ReembedResult, Relationship, RelationshipConstraintError, RelationshipNotFoundError, RelationshipQueryOptions, RelationshipSummary, RepositoryConfig, RepositoryFilter, RepositoryNotFoundError, RepositoryStats, RepositorySummary, RepositoryUpdate, ResolvedVocabulary, ScoredEntity, SearchHit, SearchOptions, SearchProvider, SearchableEntity, StorageExploreOptions, StorageFindQuery, StorageNeighbourhood, StoragePathOptions, StoragePathResult, StorageProvider, StorageRepositoryConfig, StorageTimelineOptions, StorageTimelineResult, StoredEntity, StoredEntityUpdate, StoredRelationship, StoredRepository, StoredRepositorySummary, TimelineOptions, TimelineResult, type TraversalCompiler, TraversalResult, TraversalSpec, TraversalTimeoutError, TraversalValidationError, TraversalVocabularyError, Unsubscribe, UpdateEntityInput, VocabularyChangeRecord, VocabularyProposal, VocabularyProposalResult, VocabularyValidationError, generateId, isValidUuid, matchesPropertyFilters };
479
+ export { BulkImportOptions, BulkImportResult, type CompiledQuery, ConceptSearchOptions, CreateEntityInput, CreateRelationshipInput, CypherCompiler, DeepMemory, type DeepMemoryConfig, DeepMemoryError, type DeepMemoryErrorCode, DeepMemoryEvent, DeepMemoryEventType, DeleteProgressCallback, DetailLevel, DuplicateEntityError, DuplicateRelationshipError, DuplicateRepositoryError, EmbeddingProvider, EmbeddingProviderRequiredError, EnsureSchemaResult, Entity, EntityBrief, EntityNotFoundError, EntitySummary, EntityTypeDefinition, EventHandler, EventPayload, ExploreOptions, ExportArchive, ExportChunk, ExportError, ExportOptions, ExportStreamItem, FindEntitiesQuery, GovernanceConfig, GovernanceDeniedError, GraphResult, GraphTraversalProvider, GraphTraversalProviderRequiredError, GremlinCompiler, HookResult, ImportChunk, ImportError, ImportOptions, ImportResult, ImportStreamHeader, InMemorySearchProvider, InMemoryStorageProvider, InvalidInputError, LockProvider, MemoryRepository, MemoryVocabulary, Neighborhood, NoOpEmbeddingProvider, OperationCancelledError, PaginatedResult, PaginationOptions, PathOptions, PathResult, PropertyFilter, Provenance, ProvenanceContext, ProviderError, ReembedResult, Relationship, RelationshipConstraintError, RelationshipNotFoundError, RelationshipQueryOptions, RelationshipSummary, RepositoryConfig, RepositoryFilter, RepositoryNotFoundError, RepositoryStats, RepositorySummary, RepositoryUpdate, ResolvedVocabulary, ScoredEntity, SearchHit, SearchOptions, SearchProvider, SearchableEntity, StorageExploreOptions, StorageFindQuery, StorageNeighborhood, StoragePathOptions, StoragePathResult, StorageProvider, StorageRepositoryConfig, StorageTimelineOptions, StorageTimelineResult, StoredEntity, StoredEntityUpdate, StoredRelationship, StoredRepository, StoredRepositorySummary, TimelineOptions, TimelineResult, type TraversalCompiler, TraversalResult, TraversalSpec, TraversalTimeoutError, TraversalValidationError, TraversalVocabularyError, Unsubscribe, UpdateEntityInput, VocabularyChangeRecord, VocabularyProposal, VocabularyProposalResult, VocabularyValidationError, generateId, isValidUuid, matchesPropertyFilters };