@opra/mongodb 0.33.2 → 0.33.4

package/esm/mongo-service.js

@@ -9,8 +9,8 @@ export class MongoService extends ApiService {
     /**
      * Constructs a new instance
      *
-     * @param {Type | string} dataType - The data type of the array elements.
-     * @param {MongoService.Options} [options] - The options for the array service.
+     * @param dataType - The data type of the array elements.
+     * @param [options] - The options for the array service.
      * @constructor
      */
     constructor(dataType, options) {
@@ -34,7 +34,6 @@ export class MongoService extends ApiService {
     /**
      * Retrieves the data type of the document
      *
-     * @returns {ComplexType} The complex data type of the field.
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
     getDataType() {
@@ -43,8 +42,7 @@ export class MongoService extends ApiService {
     /**
      * Retrieves the encoder for the specified operation.
      *
-     * @param {String} operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
-     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
+     * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
     getEncoder(operation) {
         let encoder = this._encoders[operation];
@@ -56,8 +54,6 @@ export class MongoService extends ApiService {
     }
     /**
      * Retrieves the decoder.
-     *
-     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
      */
     getDecoder() {
         let decoder = this._decoder;
@@ -70,9 +66,8 @@ export class MongoService extends ApiService {
     /**
      * Executes the provided function within a transaction.
      *
-     * @param {WithTransactionCallback} callback - The function to be executed within the transaction.
-     * @param {TransactionOptions} [options] - Optional options for the transaction.
-     * @returns {Promise<any>} - A promise that resolves with the result of the function execution within the transaction.
+     * @param callback - The function to be executed within the transaction.
+     * @param [options] - Optional options for the transaction.
      */
     async withTransaction(callback, options) {
         let session = this.getSession();
@@ -101,12 +96,12 @@ export class MongoService extends ApiService {
         }
         finally {
             // Restore old session property
-            if (hasOldSession) {
+            if (hasOldSession)
                 this.session = oldSessionGetter;
-                await session.endSession();
-            }
             else
                 delete this.session;
+            if (!oldInTransaction)
+                await session.endSession();
         }
     }
     /**
@@ -114,9 +109,8 @@ export class MongoService extends ApiService {
      * one will be added to each of the documents missing it by the driver, mutating the document. This behavior
      * can be overridden by setting the **forceServerObjectId** flag.
      *
-     * @param {T} doc - The document to be inserted.
-     * @param {mongodb.InsertOneOptions} options - The options for the insert operation.
-     * @returns {Promise<mongodb.InsertOneWriteOpResult<mongodb.OptionalId<T>>>} - A promise that resolves with the result of the insert operation.
+     * @param doc - The document to insert
+     * @param options - Optional settings for the command
      * @protected
      */
     async __insertOne(doc, options) {
@@ -137,9 +131,8 @@ export class MongoService extends ApiService {
     /**
      * Gets the number of documents matching the filter.
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to match documents.
-     * @param {mongodb.CountOptions} options - The options for counting documents.
-     * @returns {Promise<number>} - The number of documents matching the filter.
+     * @param filter - The filter used to match documents.
+     * @param options - The options for counting documents.
      * @protected
      */
     async __countDocuments(filter, options) {
@@ -161,9 +154,9 @@ export class MongoService extends ApiService {
     /**
      * Delete a document from a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to select the document to remove
-     * @param {mongodb.DeleteOptions} options - Optional settings for the command
-     * @return {Promise<mongodb.DeleteResult>} A Promise that resolves to the result of the delete operation
+     * @param filter - The filter used to select the document to remove
+     * @param options - Optional settings for the command
+     * @protected
      */
     async __deleteOne(filter, options) {
         const db = this.getDatabase();
@@ -181,12 +174,10 @@ export class MongoService extends ApiService {
         }
     }
     /**
-     * Deletes multiple documents from a collection.
+     * Delete multiple documents from a collection
      *
-     * @param {mongodb.Filter<T>} [filter] - The filter object specifying the documents to delete.
-     * If not provided, all documents in the collection will be deleted.
-     * @param {mongodb.DeleteOptions} [options] - The options for the delete operation.
-     * @returns {Promise<mongodb.DeleteResult>} A promise that resolves with the delete result object.
+     * @param filter - The filter used to select the documents to remove
+     * @param options - Optional settings for the command
      * @protected
      */
     async __deleteMany(filter, options) {
@@ -205,12 +196,33 @@ export class MongoService extends ApiService {
         }
     }
     /**
-     * Create a new Change Stream, watching for new changes
-     * (insertions, updates, replacements, deletions, and invalidations) in this collection.
+     * Gets the number of documents matching the filter.
+     *
+     * @param field - Field of the document to find distinct values for
+     * @param filter - The filter for filtering the set of documents to which we apply the distinct filter.
+     * @param options - Optional settings for the command
+     * @protected
+     */
+    async __distinct(field, filter, options) {
+        const db = this.getDatabase();
+        const collection = await this.getCollection(db);
+        options = {
+            ...options,
+            session: options?.session || this.getSession()
+        };
+        try {
+            return await collection.distinct(field, filter || {}, options);
+        }
+        catch (e) {
+            await this.$onError?.(e, this);
+            throw e;
+        }
+    }
+    /**
+     * Execute an aggregation framework pipeline against the collection, needs MongoDB \>= 2.2
      *
-     * @param {mongodb.Document[]} pipeline - The pipeline of aggregation stages to apply to the collection.
-     * @param {mongodb.AggregateOptions} options - The options to customize the aggregation.
-     * @returns {Promise<mongodb.ChangeStream<T>>} - A promise that resolves to a Change Stream that represents the result of the aggregation.
+     * @param pipeline - An array of aggregation pipelines to execute
+     * @param options - Optional settings for the command
      * @protected
      */
     async __aggregate(pipeline, options) {
@@ -231,10 +243,9 @@ export class MongoService extends ApiService {
     /**
      * Fetches the first document that matches the filter
      *
-     * @param {mongodb.Filter<T>} filter - The filter object to match documents against
-     * @param {mongodb.FindOptions} [options] - The options to use when querying the collection
+     * @param filter - Query for find Operation
+     * @param options - Optional settings for the command
      * @protected
-     * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the first matching document, or undefined if no match is found
      */
     async __findOne(filter, options) {
         const db = this.getDatabase();
@@ -252,11 +263,11 @@ export class MongoService extends ApiService {
         }
     }
     /**
-     * Creates a cursor for a filter that can be used to iterate over results from MongoDB.
+     * Creates a cursor for a filter that can be used to iterate over results from MongoDB
      *
-     * @param {mongodb.Filter<T>} filter - The filter to apply when searching for results.
-     * @param {mongodb.FindOptions} [options] - The options to customize the search behavior.
-     * @returns {mongodb.Cursor<T>} - The cursor object that can be used to iterate over the results.
+     * @param filter - The filter predicate. If unspecified,
+     * then all documents in the collection will match the predicate
+     * @param options - Optional settings for the command
      * @protected
      */
     async __find(filter, options) {
@@ -275,13 +286,12 @@ export class MongoService extends ApiService {
         }
     }
     /**
-     * Update a single document in a collection.
+     * Update a single document in a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter to select the document(s) to update.
-     * @param {mongodb.UpdateFilter<T>} update - The update operation to be applied on the selected document(s).
-     * @param {mongodb.UpdateOptions} [options] - Optional settings for the update operation.
+     * @param filter - The filter used to select the document to update
+     * @param update - The update operations to be applied to the document
+     * @param options - Optional settings for the command
      * @protected
-     * @returns {Promise<mongodb.UpdateResult>} - A promise that resolves to the result of the update operation.
      */
     async __updateOne(filter, update, options) {
         const db = this.getDatabase();
@@ -301,13 +311,12 @@ export class MongoService extends ApiService {
     /**
      * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
      *
-     * @param {mongodb.Filter<T>} filter - The filter to select the document to be updated.
-     * @param {mongodb.UpdateFilter<T>} doc - The update document.
-     * @param {mongodb.FindOneAndUpdateOptions} [options] - Optional options for the find one and update operation.
-     * @returns {Promise<T | null>} - A promise that resolves to the updated document or null if no document matched the filter.
+     * @param filter - The filter used to select the document to update
+     * @param update - Update operations to be performed on the document
+     * @param options - Optional settings for the command
      * @protected
      */
-    async __findOneAndUpdate(filter, doc, options) {
+    async __findOneAndUpdate(filter, update, options) {
         const db = this.getDatabase();
         const collection = await this.getCollection(db);
         const opts = {
@@ -317,7 +326,7 @@ export class MongoService extends ApiService {
             session: options?.session || this.getSession(),
         };
         try {
-            return await collection.findOneAndUpdate(filter || {}, doc, opts);
+            return await collection.findOneAndUpdate(filter || {}, update, opts);
         }
         catch (e) {
             await this.$onError?.(e, this);
@@ -325,15 +334,14 @@ export class MongoService extends ApiService {
         }
     }
     /**
-     * Update multiple documents in a collection.
+     * Update multiple documents in a collection
      *
-     * @param {mongodb.Filter<T>} filter - The filter used to select the documents to be updated.
-     * @param {mongodb.UpdateFilter<T> | Partial<T>} doc - The updates to be applied to the selected documents.
-     * @param {StrictOmit<mongodb.UpdateOptions, 'upsert'>} [options] - The optional settings for the update operation.
-     * @return {Promise<mongodb.UpdateResult>} - A Promise that resolves to the result of the update operation.
+     * @param filter - The filter used to select the documents to update
+     * @param update - The update operations to be applied to the documents
+     * @param options - Optional settings for the command
      * @protected
      */
-    async __updateMany(filter, doc, options) {
+    async __updateMany(filter, update, options) {
         const db = this.getDatabase();
         const collection = await this.getCollection(db);
         options = {
@@ -342,7 +350,7 @@ export class MongoService extends ApiService {
             upsert: false
         };
         try {
-            return await collection.updateMany(filter || {}, doc, options);
+            return await collection.updateMany(filter || {}, update, options);
         }
         catch (e) {
             await this.$onError?.(e, this);
@@ -354,7 +362,6 @@ export class MongoService extends ApiService {
      *
      * @protected
      *
-     * @returns {Promise<mongodb.Db>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     getDatabase() {
@@ -370,7 +377,6 @@ export class MongoService extends ApiService {
      *
      * @protected
      *
-     * @returns {Promise<mongodb.ClientSession>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     getSession() {
@@ -381,9 +387,8 @@ export class MongoService extends ApiService {
     /**
      * Retrieves a MongoDB collection from the given database.
      *
-     * @param {mongodb.Db} db - The MongoDB database.
+     * @param db - The MongoDB database.
      * @protected
-     * @returns {Promise<mongodb.Collection<T>>} A promise that resolves to the MongoDB collection.
      */
     async getCollection(db) {
         return db.collection(this.getCollectionName());
@@ -392,7 +397,7 @@ export class MongoService extends ApiService {
      * Retrieves the collection name.
      *
      * @protected
-     * @returns {string} The collection name.
+     * @returns The collection name.
      * @throws {Error} If the collection name is not defined.
      */
     getCollectionName() {
@@ -407,7 +412,7 @@ export class MongoService extends ApiService {
      * Retrieves the resource name.
      *
      * @protected
-     * @returns {string} The collection name.
+     * @returns {string} The resource name.
      * @throws {Error} If the collection name is not defined.
      */
     getResourceName() {
@@ -421,9 +426,9 @@ export class MongoService extends ApiService {
     /**
      * Generates an encoder for the specified operation.
      *
-     * @param {string} operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
+     * @param operation - The operation to generate the encoder for. Must be either 'create' or 'update'.
      * @protected
-     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
+     * @returns - The generated encoder for the specified operation.
      */
     _generateEncoder(operation) {
         const dataType = this.getDataType();
@@ -438,7 +443,7 @@ export class MongoService extends ApiService {
      * Generates an encoder for the specified operation.
      *
      * @protected
-     * @returns {IsObject.Validator} - The generated encoder for the specified operation.
+     * @returns - The generated encoder for the specified operation.
      */
     _generateDecoder() {
         const dataType = this.getDataType();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/mongodb",
-  "version": "0.33.2",
+  "version": "0.33.4",
   "description": "Opra MongoDB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -30,8 +30,8 @@
     "ts-gems": "^3.1.0"
   },
   "peerDependencies": {
-    "@opra/common": "^0.33.2",
-    "@opra/core": "^0.33.2",
+    "@opra/common": "^0.33.4",
+    "@opra/core": "^0.33.4",
     "mongodb": ">=6.x.x"
   },
   "type": "module",

package/types/mongo-collection-service.d.ts

@@ -81,7 +81,7 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @throws {Error} if an unknown error occurs while creating the document.
      */
     create(input: PartialDTO<T>, options?: MongoCollectionService.CreateOptions): Promise<PartialDTO<T>>;
-    protected _create(input: PartialDTO<T>, options: MongoCollectionService.CreateOptions | undefined): Promise<PartialDTO<T>>;
+    protected _create(input: PartialDTO<T>, options?: MongoCollectionService.CreateOptions): Promise<PartialDTO<T>>;
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
@@ -107,6 +107,8 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      */
     deleteMany(options?: MongoCollectionService.DeleteManyOptions<T>): Promise<number>;
     protected _deleteMany(options?: MongoCollectionService.DeleteManyOptions<T>): Promise<number>;
+    distinct(field: string, options?: MongoCollectionService.DistinctOptions<T>): Promise<any[]>;
+    protected _distinct(field: string, options?: MongoCollectionService.DistinctOptions<T>): Promise<any[]>;
     /**
      * Checks if an object with the given id exists.
      *
@@ -175,8 +177,8 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
      * undefined if the document was not found.
      */
-    update(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
-    protected _update(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
+    update(id: AnyId, input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
+    protected _update(id: AnyId, input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<PartialDTO<T> | undefined>;
     /**
      * Updates a document in the collection with the specified ID.
      *
@@ -185,8 +187,8 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @param {MongoCollectionService.UpdateOptions<T>} options - The options for updating the document.
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
-    updateOnly(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
-    protected _updateOnly(id: AnyId, input: PatchDTO<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
+    updateOnly(id: AnyId, input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
+    protected _updateOnly(id: AnyId, input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateOptions<T>): Promise<number>;
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
@@ -194,8 +196,8 @@ export declare class MongoCollectionService<T extends mongodb.Document> extends
      * @param {MongoCollectionService.UpdateManyOptions<T>} options - The options for updating the documents.
      * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
-    updateMany(input: PatchDTO<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
-    protected _updateMany(input: PatchDTO<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
+    updateMany(input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
+    protected _updateMany(input: PatchDTO<T> | mongodb.UpdateFilter<T>, options?: MongoCollectionService.UpdateManyOptions<T>): Promise<number>;
     /**
      * Generates an ID.
      *
@@ -244,7 +246,7 @@ export declare namespace MongoCollectionService {
         interceptor?: MongoCollectionService<any>['$interceptor'];
     }
     /**
-     * Represents options for creating a new document.
+     * Represents options for "create" operation
      *
      * @interface
      */
@@ -254,7 +256,7 @@ export declare namespace MongoCollectionService {
         include?: string[];
     }
     /**
-     * Represents options for counting document.
+     * Represents options for "count" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -263,7 +265,7 @@ export declare namespace MongoCollectionService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
     /**
-     * Represents options for deleting single document.
+     * Represents options for "delete" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -272,7 +274,7 @@ export declare namespace MongoCollectionService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
     /**
-     * Represents options for deleting multiple documents.
+     * Represents options for "deleteMany" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -281,7 +283,16 @@ export declare namespace MongoCollectionService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
     /**
-     * Represents options for finding single document.
+     * Represents options for "distinct" operation
+     *
+     * @interface
+     * @template T - The type of the document.
+     */
+    interface DistinctOptions<T> extends mongodb.DistinctOptions {
+        filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
+    }
+    /**
+     * Represents options for "findOne" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -289,7 +300,7 @@ export declare namespace MongoCollectionService {
     interface FindOneOptions<T = any> extends StrictOmit<FindManyOptions<T>, 'count' | 'limit'> {
     }
     /**
-     * Represents options for finding multiple documents.
+     * Represents options for "findMany" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -305,7 +316,7 @@ export declare namespace MongoCollectionService {
         count?: boolean;
     }
     /**
-     * Represents options for updating single document.
+     * Represents options for "update" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -317,7 +328,7 @@ export declare namespace MongoCollectionService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
     /**
-     * Represents options for updating multiple documents.
+     * Represents options for "updateMany" operation
      *
      * @interface
      * @template T - The type of the document.
@@ -326,7 +337,7 @@ export declare namespace MongoCollectionService {
         filter?: mongodb.Filter<T> | OpraCommon.OpraFilter.Ast | string;
     }
     /**
-     * Represents options for checking the document exists
+     * Represents options for "exists" operation
      *
      * @interface
      */