@utaba/deep-memory 0.3.0 → 0.5.0

package/dist/{StorageProvider-DqW-zpd0.d.ts → StorageProvider-CBhwqavV.d.cts}

@@ -1,4 +1,4 @@
-import { S as StorageRepositoryConfig, c as StoredRepository, d as RepositoryFilter, e as PaginatedResult, f as StoredRepositorySummary, g as RepositoryUpdate, h as DeleteProgressCallback, i as RepositoryStats, M as MemoryVocabulary, 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 StorageNeighbourhood, r as StoragePathOptions, s as StoragePathResult, t as StorageTimelineOptions, u as StorageTimelineResult, v as ExportChunk, I as ImportChunk, B as BulkImportOptions, w as BulkImportResult } from './portability-1KBMVBGJ.js';
+import { S as StorageRepositoryConfig, c as StoredRepository, d as RepositoryFilter, e as PaginatedResult, f as StoredRepositorySummary, g as RepositoryUpdate, h as DeleteProgressCallback, i as RepositoryStats, M as MemoryVocabulary, 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, I as ImportChunk, B as BulkImportOptions, w as BulkImportResult } from './portability-B-8J4nQQ.cjs';
 
 /** Result returned by ensureSchema describing what actions were taken. */
 interface EnsureSchemaResult {
@@ -22,8 +22,8 @@ interface EnsureSchemaResult {
  * based on the requested detail level.
  */
 interface StorageProvider {
-    /** Optional initialisation (e.g., database connection) */
-    initialise?(): Promise<void>;
+    /** Optional initialization (e.g., database connection) */
+    initialize?(): Promise<void>;
     /** Optional cleanup (e.g., close connections) */
     dispose?(): Promise<void>;
     /** Optional schema creation / migration (e.g., create tables if they don't exist) */
@@ -62,7 +62,7 @@ interface StorageProvider {
     deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
         deletedRelationships: number;
     }>;
-    exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
+    exploreNeighborhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighborhood>;
     findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
     getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
     exportAll(repositoryId: string): AsyncIterable<ExportChunk>;

package/dist/{StorageProvider-CSbaIY6X.d.cts → StorageProvider-ynfpc5wz.d.ts}

@@ -1,4 +1,4 @@
-import { S as StorageRepositoryConfig, c as StoredRepository, d as RepositoryFilter, e as PaginatedResult, f as StoredRepositorySummary, g as RepositoryUpdate, h as DeleteProgressCallback, i as RepositoryStats, M as MemoryVocabulary, 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 StorageNeighbourhood, r as StoragePathOptions, s as StoragePathResult, t as StorageTimelineOptions, u as StorageTimelineResult, v as ExportChunk, I as ImportChunk, B as BulkImportOptions, w as BulkImportResult } from './portability-1KBMVBGJ.cjs';
+import { S as StorageRepositoryConfig, c as StoredRepository, d as RepositoryFilter, e as PaginatedResult, f as StoredRepositorySummary, g as RepositoryUpdate, h as DeleteProgressCallback, i as RepositoryStats, M as MemoryVocabulary, 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, I as ImportChunk, B as BulkImportOptions, w as BulkImportResult } from './portability-B-8J4nQQ.js';
 
 /** Result returned by ensureSchema describing what actions were taken. */
 interface EnsureSchemaResult {
@@ -22,8 +22,8 @@ interface EnsureSchemaResult {
  * based on the requested detail level.
  */
 interface StorageProvider {
-    /** Optional initialisation (e.g., database connection) */
-    initialise?(): Promise<void>;
+    /** Optional initialization (e.g., database connection) */
+    initialize?(): Promise<void>;
     /** Optional cleanup (e.g., close connections) */
     dispose?(): Promise<void>;
     /** Optional schema creation / migration (e.g., create tables if they don't exist) */
@@ -62,7 +62,7 @@ interface StorageProvider {
     deleteRelationshipsByType(repositoryId: string, relationshipType: string): Promise<{
         deletedRelationships: number;
     }>;
-    exploreNeighbourhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighbourhood>;
+    exploreNeighborhood(repositoryId: string, entityId: string, options: StorageExploreOptions): Promise<StorageNeighborhood>;
     findPaths(repositoryId: string, sourceId: string, targetId: string, options: StoragePathOptions): Promise<StoragePathResult>;
     getTimeline(repositoryId: string, entityId: string, options: StorageTimelineOptions): Promise<StorageTimelineResult>;
     exportAll(repositoryId: string): AsyncIterable<ExportChunk>;

package/dist/index.cjs

@@ -332,6 +332,12 @@ var EntityManager = class {
     this.storage = storage;
     this.embedding = embedding;
   }
+  repositoryId;
+  vocabularyEngine;
+  provenanceTracker;
+  eventBus;
+  storage;
+  embedding;
   /** Create one or more entities with vocabulary validation, ID generation, provenance, and events */
   async create(inputs) {
     const results = [];
@@ -695,7 +701,7 @@ function jaroWinklerSimilarity(a, b, scalingFactor = 0.1) {
   }
   return jaro + commonPrefix * Math.min(scalingFactor, 0.25) * (1 - jaro);
 }
-function normaliseTypeName(name) {
+function normalizeTypeName(name) {
   return name.toLowerCase().trim().replace(/[-\s.]+/g, "_").replace(/[^a-z0-9_]/g, "");
 }
 function toScreamingSnakeCase(name) {
@@ -711,6 +717,11 @@ var RelationshipManager = class {
     this.eventBus = eventBus;
     this.storage = storage;
   }
+  repositoryId;
+  vocabularyEngine;
+  provenanceTracker;
+  eventBus;
+  storage;
   /** Create one or more relationships with vocabulary validation, provenance, and events */
   async create(inputs) {
     const results = [];
@@ -1645,8 +1656,12 @@ var GraphTraversal = class {
     this.graphTraversalProvider = graphTraversalProvider;
     this.vocabularyEngine = vocabularyEngine;
   }
-  /** BFS neighbourhood exploration from a centre entity */
-  async exploreNeighbourhood(entityId, options) {
+  repositoryId;
+  storage;
+  graphTraversalProvider;
+  vocabularyEngine;
+  /** BFS neighborhood exploration from a center entity */
+  async exploreNeighborhood(entityId, options) {
     const storageOptions = {
       depth: options?.depth ?? 1,
       relationshipTypes: options?.relationshipTypes,
@@ -1656,13 +1671,13 @@ var GraphTraversal = class {
       offsetPerType: options?.offsetPerType ?? 0,
       relationshipPropertyFilters: options?.relationshipPropertyFilters
     };
-    const storageResult = await this.storage.exploreNeighbourhood(
+    const storageResult = await this.storage.exploreNeighborhood(
       this.repositoryId,
       entityId,
       storageOptions
     );
-    const centreEntity = await this.storage.getEntity(this.repositoryId, entityId);
-    if (!centreEntity) {
+    const centerEntity = await this.storage.getEntity(this.repositoryId, entityId);
+    if (!centerEntity) {
       throw new EntityNotFoundError(entityId);
     }
     const detailLevel = options?.detailLevel ?? "summary";
@@ -1686,11 +1701,11 @@ var GraphTraversal = class {
       return layer;
     });
     return {
-      centre: {
-        id: centreEntity.id,
-        slug: centreEntity.slug,
-        entityType: centreEntity.entityType,
-        label: centreEntity.label
+      center: {
+        id: centerEntity.id,
+        slug: centerEntity.slug,
+        entityType: centerEntity.entityType,
+        label: centerEntity.label
       },
       layers,
       statistics: {
@@ -2244,8 +2259,8 @@ var MemoryRepository = class {
     };
   }
   // ─── Graph Traversal ───────────────────────────────────────────────
-  async exploreNeighbourhood(entityId, options) {
-    return this.graphTraversal.exploreNeighbourhood(entityId, options);
+  async exploreNeighborhood(entityId, options) {
+    return this.graphTraversal.exploreNeighborhood(entityId, options);
   }
   async findPaths(sourceId, targetId, options) {
     return this.graphTraversal.findPaths(sourceId, targetId, options);
@@ -2275,7 +2290,7 @@ var MemoryRepository = class {
       storageOptions
     );
     const entity = await this.storage.getEntity(this.repositoryId, entityId);
-    const centreRef = {
+    const centerRef = {
       id: entityId,
       slug: entity?.slug ?? entityId,
       label: entity?.label ?? entityId
@@ -2321,7 +2336,7 @@ var MemoryRepository = class {
           timestamp: e.timestamp,
           eventType: e.eventType,
           description: `${rel.type} relationship created ${direction} ${otherRef.label}`,
-          relatedEntities: [centreRef, otherRef],
+          relatedEntities: [centerRef, otherRef],
           relationship: relDetail
         };
       }
@@ -2329,13 +2344,13 @@ var MemoryRepository = class {
       return {
         timestamp: e.timestamp,
         eventType: e.eventType,
-        description: `${centreRef.label} ${action}`,
-        relatedEntities: [centreRef]
+        description: `${centerRef.label} ${action}`,
+        relatedEntities: [centerRef]
       };
     });
     return {
       id: entityId,
-      slug: centreRef.slug,
+      slug: centerRef.slug,
       totalEvents: storageResult.total,
       returned: events.length,
       events
@@ -2418,14 +2433,14 @@ var SemanticDeduplicator = class {
   /**
    * Check whether a proposed type name is a duplicate of an existing type.
    * Uses embedding similarity if an EmbeddingProvider is available, otherwise falls back
-   * to Jaro-Winkler string similarity on normalised type names.
+   * to Jaro-Winkler string similarity on normalized type names.
    */
   async checkDuplicate(proposedType, proposedDescription, existingTypes) {
     if (existingTypes.length === 0) {
       return { isDuplicate: false, matches: [] };
     }
-    const normProposed = normaliseTypeName(proposedType);
-    const exactMatch = existingTypes.find((t) => normaliseTypeName(t.type) === normProposed);
+    const normProposed = normalizeTypeName(proposedType);
+    const exactMatch = existingTypes.find((t) => normalizeTypeName(t.type) === normProposed);
     if (exactMatch) {
       return {
         isDuplicate: true,
@@ -2461,10 +2476,10 @@ var SemanticDeduplicator = class {
     };
   }
   checkWithStringSimilarity(proposedType, existingTypes) {
-    const normProposed = normaliseTypeName(proposedType);
+    const normProposed = normalizeTypeName(proposedType);
     const matches = [];
     for (const existing of existingTypes) {
-      const normExisting = normaliseTypeName(existing.type);
+      const normExisting = normalizeTypeName(existing.type);
       const similarity = jaroWinklerSimilarity(normProposed, normExisting);
       if (similarity >= this.threshold) {
         matches.push({
@@ -2625,7 +2640,7 @@ function canPropose(governanceConfig, _proposal) {
     case "locked":
       return {
         allowed: false,
-        reason: "Vocabulary is locked. Only organisation admins can modify the vocabulary via the admin API."
+        reason: "Vocabulary is locked. Only organization admins can modify the vocabulary via the admin API."
       };
     case "managed":
     case "open":
@@ -3065,9 +3080,9 @@ function validateEntityUpdate(input, entityTypeDef) {
   return ok();
 }
 function validateRelationship(input, vocabulary, sourceEntityType, targetEntityType) {
-  const normalisedType = toScreamingSnakeCase(input.relationshipType);
+  const normalizedType = toScreamingSnakeCase(input.relationshipType);
   const relTypeDef = vocabulary.relationshipTypes.find(
-    (rt) => rt.type === normalisedType
+    (rt) => rt.type === normalizedType
   );
   if (!relTypeDef) {
     const closest = findClosestType(input.relationshipType, vocabulary.relationshipTypes);
@@ -3392,7 +3407,7 @@ var EventBus = class {
 };
 
 // src/portability/RepositoryExporter.ts
-var LIBRARY_VERSION = true ? "0.3.0" : "0.1.0";
+var LIBRARY_VERSION = true ? "0.5.0" : "0.1.0";
 var RepositoryExporter = class {
   storage;
   provenance;
@@ -3608,7 +3623,7 @@ function diffArrays(from, to) {
 // src/portability/MigrationEngine.ts
 var MigrationEngine = class {
   /**
-   * Analyse and migrate vocabulary differences between source and target.
+   * Analyze and migrate vocabulary differences between source and target.
    *
    * @param sourceVocabulary - vocabulary from the export archive
    * @param targetVocabulary - vocabulary in the target repository
@@ -4048,7 +4063,7 @@ var DeepMemory = class {
   graphTraversalProvider;
   provenance;
   globalEventBus;
-  initialised = false;
+  initialized = false;
   constructor(config) {
     this.storage = config.storage;
     this.search = config.search;
@@ -4058,16 +4073,16 @@ var DeepMemory = class {
     this.provenance = new ProvenanceTracker(config.provenance);
     this.globalEventBus = new EventBus(config.provenance);
   }
-  /** Initialise the storage provider and optional providers (call once before use) */
-  async ensureInitialised() {
-    if (!this.initialised) {
-      if (this.storage.initialise) {
-        await this.storage.initialise();
+  /** Initialize the storage provider and optional providers (call once before use) */
+  async ensureInitialized() {
+    if (!this.initialized) {
+      if (this.storage.initialize) {
+        await this.storage.initialize();
       }
-      if (this.graphTraversalProvider?.initialise) {
-        await this.graphTraversalProvider.initialise();
+      if (this.graphTraversalProvider?.initialize) {
+        await this.graphTraversalProvider.initialize();
       }
-      this.initialised = true;
+      this.initialized = true;
     }
   }
   /** Create or migrate the storage schema. Call once at deployment / startup, not per-request. */
@@ -4079,15 +4094,15 @@ var DeepMemory = class {
       schemaVersion: 0
     };
     try {
-      await this.ensureInitialised();
+      await this.ensureInitialized();
     } catch {
     }
     let result = noOpResult;
     if (this.storage.ensureSchema) {
       result = await this.storage.ensureSchema();
     }
-    if (!this.initialised) {
-      await this.ensureInitialised();
+    if (!this.initialized) {
+      await this.ensureInitialized();
     }
     return result;
   }
@@ -4102,7 +4117,7 @@ var DeepMemory = class {
   }
   /** Create a new memory repository */
   async createRepository(config) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     const repositoryId = config.repositoryId ?? generateId();
     this.validateRepositoryId(repositoryId);
     const context = this.provenance.getContext();
@@ -4159,7 +4174,7 @@ var DeepMemory = class {
   }
   /** Open an existing repository */
   async openRepository(repositoryId) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     this.validateRepositoryId(repositoryId);
     const storedRepo = await this.storage.getRepository(repositoryId);
     if (!storedRepo) {
@@ -4188,7 +4203,7 @@ var DeepMemory = class {
   }
   /** List all repositories */
   async listRepositories(filter) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     const result = await this.storage.listRepositories(filter);
     return {
       items: result.items.map((stored) => ({
@@ -4206,7 +4221,7 @@ var DeepMemory = class {
   }
   /** Update repository metadata and settings */
   async updateRepository(repositoryId, updates) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     this.validateRepositoryId(repositoryId);
     const updated = await this.storage.updateRepository(repositoryId, updates);
     await this.globalEventBus.emit("repository:updated", { repositoryId });
@@ -4214,7 +4229,7 @@ var DeepMemory = class {
   }
   /** Delete a repository */
   async deleteRepository(repositoryId) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     this.validateRepositoryId(repositoryId);
     const stats = await this.storage.getRepositoryStats(repositoryId);
     await this.globalEventBus.emit("delete:started", {
@@ -4235,7 +4250,7 @@ var DeepMemory = class {
   }
   /** Delete all entities and relationships in a repository, preserving the repository and vocabulary */
   async deleteAllContents(repositoryId) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     this.validateRepositoryId(repositoryId);
     const stats = await this.storage.getRepositoryStats(repositoryId);
     await this.globalEventBus.emit("delete:started", {
@@ -4256,7 +4271,7 @@ var DeepMemory = class {
   }
   /** Export a repository to a portable archive */
   async exportRepository(repositoryId, options) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     const stats = await this.storage.getRepositoryStats(repositoryId);
     await this.globalEventBus.emit("export:started", {
       repositoryId,
@@ -4278,7 +4293,7 @@ var DeepMemory = class {
   }
   /** Import a repository from a portable archive */
   async importRepository(archive, options) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     await this.globalEventBus.emit("import:started", { repositoryId: options.target.repositoryId });
     const importer = new RepositoryImporter({
       storage: this.storage,
@@ -4306,7 +4321,7 @@ var DeepMemory = class {
    * Use for large repositories to avoid loading everything into memory.
    */
   async *exportRepositoryStream(repositoryId, options) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     const exporter = new RepositoryExporter({
       storage: this.storage,
       provenance: this.provenance.getContext(),
@@ -4363,7 +4378,7 @@ var DeepMemory = class {
    * Use for large repositories to avoid loading everything into memory.
    */
   async importRepositoryStream(header, chunks, options) {
-    await this.ensureInitialised();
+    await this.ensureInitialized();
     const importer = new RepositoryImporter({
       storage: this.storage,
       actorId: this.provenance.getContext().actorId,
@@ -4403,7 +4418,7 @@ var DeepMemory = class {
     if (this.storage.dispose) {
       await this.storage.dispose();
     }
-    this.initialised = false;
+    this.initialized = false;
   }
 };
 
@@ -4418,7 +4433,7 @@ var InMemoryStorageProvider = class {
     return store;
   }
   // ─── Lifecycle ─────────────────────────────────────────────────────
-  async initialise() {
+  async initialize() {
   }
   async dispose() {
     this.stores.clear();
@@ -4735,7 +4750,7 @@ var InMemoryStorageProvider = class {
     return { deletedRelationships };
   }
   // ─── Graph Traversal ───────────────────────────────────────────────
-  async exploreNeighbourhood(repositoryId, entityId, options) {
+  async exploreNeighborhood(repositoryId, entityId, options) {
     const store = this.getStore(repositoryId);
     if (!store.entities.has(entityId)) {
       throw new EntityNotFoundError(entityId);
@@ -4801,7 +4816,7 @@ var InMemoryStorageProvider = class {
       if (nextFrontier.size === 0) break;
     }
     return {
-      centreId: entityId,
+      centerId: entityId,
       layers
     };
   }