@abejarano/ts-mongodb-criteria 1.5.2 → 1.6.1

package/README.md

@@ -154,12 +154,21 @@ class UserRepository extends MongoRepository<User> {
   collectionName(): string {
     return "users"
   }
+
+  // Create indexes the first time the collection is accessed
+  protected async ensureIndexes(collection: Collection): Promise<void> {
+    await collection.createIndex({ email: 1 }, { unique: true })
+  }
 }
 
 const userRepo = new UserRepository()
 const { results } = await userRepo.list(criteria)
 ```
 
+Indexes are created lazily the first time the repository accesses the collection
+(via `list`, `one`, or `upsert`).
+Use the `collection` argument inside `ensureIndexes` to avoid recursion.
+
 MongoRepository provides ready-to-use public methods for repositories that extend it:
 - `list(criteria, fieldsToExclude?)` for paginated queries
 - `one(filter)` to fetch a single entity

package/dist/cjs/mongo/MongoRepository.js

@@ -9,6 +9,23 @@ class MongoRepository {
         this.aggregateRootClass = aggregateRootClass;
         this.criteriaConverter = new MongoCriteriaConverter_1.MongoCriteriaConverter();
     }
+    async ensureIndexesOnce() {
+        const key = this.collectionName();
+        if (MongoRepository.indexRegistry.has(key))
+            return;
+        const collection = await this.collectionRaw();
+        await this.ensureIndexes(collection);
+        MongoRepository.indexRegistry.add(key);
+    }
+    async collection() {
+        await this.ensureIndexesOnce();
+        return this.collectionRaw();
+    }
+    async collectionRaw() {
+        return (await MongoClientFactory_1.MongoClientFactory.createClient())
+            .db()
+            .collection(this.collectionName());
+    }
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
     async one(filter) {
         const collection = await this.collection();
@@ -28,11 +45,6 @@ class MongoRepository {
         const documents = await this.searchByCriteria(criteria, fieldsToExclude);
         return this.paginate(documents);
     }
-    async collection() {
-        return (await MongoClientFactory_1.MongoClientFactory.createClient())
-            .db()
-            .collection(this.collectionName());
-    }
     async updateOne(filter, update) {
         const collection = await this.collection();
         await collection.updateOne(filter, update, {
@@ -100,3 +112,4 @@ class MongoRepository {
     }
 }
 exports.MongoRepository = MongoRepository;
+MongoRepository.indexRegistry = new Set();

package/dist/esm/mongo/MongoRepository.js

@@ -6,6 +6,23 @@ export class MongoRepository {
         this.aggregateRootClass = aggregateRootClass;
         this.criteriaConverter = new MongoCriteriaConverter();
     }
+    async ensureIndexesOnce() {
+        const key = this.collectionName();
+        if (MongoRepository.indexRegistry.has(key))
+            return;
+        const collection = await this.collectionRaw();
+        await this.ensureIndexes(collection);
+        MongoRepository.indexRegistry.add(key);
+    }
+    async collection() {
+        await this.ensureIndexesOnce();
+        return this.collectionRaw();
+    }
+    async collectionRaw() {
+        return (await MongoClientFactory.createClient())
+            .db()
+            .collection(this.collectionName());
+    }
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
     async one(filter) {
         const collection = await this.collection();
@@ -25,11 +42,6 @@ export class MongoRepository {
         const documents = await this.searchByCriteria(criteria, fieldsToExclude);
         return this.paginate(documents);
     }
-    async collection() {
-        return (await MongoClientFactory.createClient())
-            .db()
-            .collection(this.collectionName());
-    }
     async updateOne(filter, update) {
         const collection = await this.collection();
         await collection.updateOne(filter, update, {
@@ -96,3 +108,4 @@ export class MongoRepository {
         };
     }
 }
+MongoRepository.indexRegistry = new Set();

package/dist/types/mongo/MongoRepository.d.ts

@@ -6,15 +6,19 @@ export declare abstract class MongoRepository<T extends AggregateRoot> {
     private criteriaConverter;
     private query;
     private criteria;
+    private static indexRegistry;
     protected constructor(aggregateRootClass: AggregateRootClass<T>);
     abstract collectionName(): string;
+    protected abstract ensureIndexes(collection: Collection): Promise<void>;
+    protected ensureIndexesOnce(): Promise<void>;
+    protected collection<U extends Document>(): Promise<Collection<U>>;
+    private collectionRaw;
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
     one(filter: object): Promise<T | null>;
     /** Upserts an aggregate by delegating to persist with its id. */
     upsert(entity: T): Promise<void>;
     /** Lists entities by criteria and returns a paginated response. */
     list<D>(criteria: Criteria, fieldsToExclude?: string[]): Promise<Paginate<D>>;
-    protected collection<T extends Document>(): Promise<Collection<T>>;
     protected updateOne(filter: object, update: Document[] | UpdateFilter<any>): Promise<void>;
     private persist;
     private searchByCriteria;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@abejarano/ts-mongodb-criteria",
   "author": "angel bejarano / angel.bejarano@jaspesoft.com",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "description": "Patrón Criteria para consultas MongoDB en TypeScript",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",