@abejarano/ts-mongodb-criteria 1.9.0 → 1.10.0

package/README.md

@@ -214,6 +214,9 @@ await MongoTransaction.run(async (tx) => {
   await userRepository.upsert(user, tx)
   await auditRepository.upsert(auditEntry, tx)
   await sessionRepository.delete({ userId: user.getId() }, undefined, tx)
+
+  // Reads can observe writes made earlier in this transaction.
+  const persistedUser = await userRepository.one({ id: user.getId() }, tx)
 })
 ```
 
@@ -232,8 +235,8 @@ async deactivateUser(id: string, tx: MongoTransaction): Promise<void> {
 
 MongoDB transactions require a replica set or a sharded cluster; standalone
 MongoDB instances do not support them. This initial API applies the transaction
-context only to `upsert`, `delete`, and protected `updateOne`; `one` and `list`
-remain regular reads.
+context to `upsert`, `delete`, protected `updateOne`, `one`, and `list`.
+Pass `tx` as the third argument to `list` after `fieldsToExclude`.
 
 **Your First Query in 30 Seconds:**
 

package/dist/cjs/mongo/MongoRepository.js

@@ -11,9 +11,12 @@ class MongoRepository {
         this.criteriaConverter = new MongoCriteriaConverter_1.MongoCriteriaConverter();
     }
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
-    async one(filter) {
+    async one(filter, transaction) {
         const collection = await this.collection();
-        const result = await collection.findOne(filter);
+        const session = MongoTransaction_1.MongoTransaction.sessionFor(transaction);
+        const result = session
+            ? await collection.findOne(filter, { session })
+            : await collection.findOne(filter);
         if (!result) {
             return null;
         }
@@ -27,9 +30,9 @@ class MongoRepository {
         await this.persist(entity.getId(), entity, transaction);
     }
     /** Lists entities by criteria and returns a paginated response. */
-    async list(criteria, fieldsToExclude = []) {
-        const documents = await this.searchByCriteria(criteria, fieldsToExclude);
-        return this.paginate(documents);
+    async list(criteria, fieldsToExclude = [], transaction) {
+        const documents = await this.searchByCriteria(criteria, fieldsToExclude, transaction);
+        return this.paginate(documents, transaction);
     }
     /**
      * Deletes documents from the database based on a filter and optional options.
@@ -80,13 +83,14 @@ class MongoRepository {
             },
         }, transaction);
     }
-    async searchByCriteria(criteria, fieldsToExclude = []) {
+    async searchByCriteria(criteria, fieldsToExclude = [], transaction) {
         this.criteria = criteria;
         this.query = this.criteriaConverter.convert(criteria);
         const collection = await this.collection();
+        const session = MongoTransaction_1.MongoTransaction.sessionFor(transaction);
         if (fieldsToExclude.length === 0) {
             const results = await collection
-                .find(this.query.filter, {})
+                .find(this.query.filter, session ? { session } : {})
                 .sort(this.query.sort)
                 .skip(this.query.skip)
                 .limit(this.query.limit)
@@ -98,16 +102,19 @@ class MongoRepository {
             projection[field] = 0;
         });
         const results = await collection
-            .find(this.query.filter, { projection })
+            .find(this.query.filter, session ? { projection, session } : { projection })
             .sort(this.query.sort)
             .skip(this.query.skip)
             .limit(this.query.limit)
             .toArray();
         return results.map(({ _id, ...rest }) => rest);
     }
-    async paginate(documents) {
+    async paginate(documents, transaction) {
         const collection = await this.collection();
-        const count = await collection.countDocuments(this.query.filter);
+        const session = MongoTransaction_1.MongoTransaction.sessionFor(transaction);
+        const count = session
+            ? await collection.countDocuments(this.query.filter, { session })
+            : await collection.countDocuments(this.query.filter);
         const limit = this.criteria?.limit || 10;
         const currentPage = this.criteria?.currentPage || 1;
         const hasNextPage = currentPage * limit < count;

package/dist/esm/mongo/MongoRepository.js

@@ -8,9 +8,12 @@ export class MongoRepository {
         this.criteriaConverter = new MongoCriteriaConverter();
     }
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
-    async one(filter) {
+    async one(filter, transaction) {
         const collection = await this.collection();
-        const result = await collection.findOne(filter);
+        const session = MongoTransaction.sessionFor(transaction);
+        const result = session
+            ? await collection.findOne(filter, { session })
+            : await collection.findOne(filter);
         if (!result) {
             return null;
         }
@@ -24,9 +27,9 @@ export class MongoRepository {
         await this.persist(entity.getId(), entity, transaction);
     }
     /** Lists entities by criteria and returns a paginated response. */
-    async list(criteria, fieldsToExclude = []) {
-        const documents = await this.searchByCriteria(criteria, fieldsToExclude);
-        return this.paginate(documents);
+    async list(criteria, fieldsToExclude = [], transaction) {
+        const documents = await this.searchByCriteria(criteria, fieldsToExclude, transaction);
+        return this.paginate(documents, transaction);
     }
     /**
      * Deletes documents from the database based on a filter and optional options.
@@ -77,13 +80,14 @@ export class MongoRepository {
             },
         }, transaction);
     }
-    async searchByCriteria(criteria, fieldsToExclude = []) {
+    async searchByCriteria(criteria, fieldsToExclude = [], transaction) {
         this.criteria = criteria;
         this.query = this.criteriaConverter.convert(criteria);
         const collection = await this.collection();
+        const session = MongoTransaction.sessionFor(transaction);
         if (fieldsToExclude.length === 0) {
             const results = await collection
-                .find(this.query.filter, {})
+                .find(this.query.filter, session ? { session } : {})
                 .sort(this.query.sort)
                 .skip(this.query.skip)
                 .limit(this.query.limit)
@@ -95,16 +99,19 @@ export class MongoRepository {
             projection[field] = 0;
         });
         const results = await collection
-            .find(this.query.filter, { projection })
+            .find(this.query.filter, session ? { projection, session } : { projection })
             .sort(this.query.sort)
             .skip(this.query.skip)
             .limit(this.query.limit)
             .toArray();
         return results.map(({ _id, ...rest }) => rest);
     }
-    async paginate(documents) {
+    async paginate(documents, transaction) {
         const collection = await this.collection();
-        const count = await collection.countDocuments(this.query.filter);
+        const session = MongoTransaction.sessionFor(transaction);
+        const count = session
+            ? await collection.countDocuments(this.query.filter, { session })
+            : await collection.countDocuments(this.query.filter);
         const limit = this.criteria?.limit || 10;
         const currentPage = this.criteria?.currentPage || 1;
         const hasNextPage = currentPage * limit < count;

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

@@ -3,8 +3,8 @@ import { AggregateRoot } from "../AggregateRoot";
 import { DeleteOptions } from "mongodb";
 import { MongoTransaction } from "./MongoTransaction";
 export interface IRepository<T extends AggregateRoot> {
-    one(filter: object): Promise<T | null>;
-    list<D>(criteria: Criteria, fieldsToExclude?: string[]): Promise<Paginate<D>>;
+    one(filter: object, transaction?: MongoTransaction): Promise<T | null>;
+    list<D>(criteria: Criteria, fieldsToExclude?: string[], transaction?: MongoTransaction): Promise<Paginate<D>>;
     upsert(entity: T, transaction?: MongoTransaction): Promise<void>;
     delete(filter: object, options?: DeleteOptions, transaction?: MongoTransaction): Promise<void>;
 }

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

@@ -11,11 +11,11 @@ export declare abstract class MongoRepository<T extends AggregateRoot> {
     protected constructor(aggregateRootClass: AggregateRootClass<T>);
     abstract collectionName(): string;
     /** Finds a single entity and hydrates it via the aggregate's fromPrimitives. */
-    one(filter: object): Promise<T | null>;
+    one(filter: object, transaction?: MongoTransaction): Promise<T | null>;
     /** Upserts an aggregate by delegating to persist with its id. */
     upsert(entity: T, transaction?: MongoTransaction): Promise<void>;
     /** Lists entities by criteria and returns a paginated response. */
-    list<D>(criteria: Criteria, fieldsToExclude?: string[]): Promise<Paginate<D>>;
+    list<D>(criteria: Criteria, fieldsToExclude?: string[], transaction?: MongoTransaction): Promise<Paginate<D>>;
     /**
      * Deletes documents from the database based on a filter and optional options.
      *

package/package.json

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