@opra/mongodb 0.33.2 → 0.33.4

package/cjs/mongo-collection-service.js

@@ -155,6 +155,24 @@ class MongoCollectionService extends mongo_service_js_1.MongoService {
         const r = await this.__deleteMany(filter, (0, lodash_omit_1.default)(options, 'filter'));
         return r.deletedCount;
     }
+    async distinct(field, options) {
+        const info = {
+            crud: 'read',
+            method: 'distinct',
+            options
+        };
+        return this._intercept(async () => {
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
+                await this._getDocumentFilter(info),
+                options?.filter,
+            ]);
+            return this._distinct(field, { ...options, filter });
+        }, info);
+    }
+    async _distinct(field, options) {
+        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
+        return await this.__distinct(field, filter, (0, lodash_omit_1.default)(options, 'filter'));
+    }
     /**
      * Checks if an object with the given id exists.
      *
@@ -365,21 +383,33 @@ class MongoCollectionService extends mongo_service_js_1.MongoService {
         }, info);
     }
     async _update(id, input, options) {
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        const patch = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
+            update.$set = update.$set || {};
+        }
+        else
+            update = input;
+        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
+            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
+            options?.filter
+        ]);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
             upsert: undefined,
             projection: mongo_adapter_js_1.MongoAdapter.prepareProjection(this.getDataType(), options),
         };
-        const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
-            mongo_adapter_js_1.MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
-            options?.filter
-        ]);
         const decode = this.getDecoder();
-        const out = await this.__findOneAndUpdate(filter, patch, mongoOptions);
+        const out = await this.__findOneAndUpdate(filter, update, mongoOptions);
         return out ? decode(out, { coerce: true }) : undefined;
     }
     /**
@@ -407,22 +437,33 @@ class MongoCollectionService extends mongo_service_js_1.MongoService {
         }, info);
     }
     async _updateOnly(id, input, options) {
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
+            if (!Object.keys(doc).length)
+                return 0;
+        }
+        else
+            update = input;
         const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([
             mongo_adapter_js_1.MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
             options?.filter
         ]);
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        if (!Object.keys(doc).length)
-            return 0;
-        const patch = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
             upsert: undefined,
             projection: mongo_adapter_js_1.MongoAdapter.prepareProjection(this.getDataType(), options),
         };
-        const out = await this.__updateOne(filter, patch, mongoOptions);
+        const out = await this.__updateOne(filter, update, mongoOptions);
         return out.matchedCount;
     }
     /**
@@ -448,18 +489,28 @@ class MongoCollectionService extends mongo_service_js_1.MongoService {
         }, info);
     }
     async _updateMany(input, options) {
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        if (!Object.keys(doc).length)
-            return 0;
-        const patch = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
-        patch.$set = patch.$set || {};
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = mongo_adapter_js_1.MongoAdapter.preparePatch(doc);
+            if (!Object.keys(doc).length)
+                return 0;
+        }
+        else
+            update = input;
         const mongoOptions = {
             ...(0, lodash_omit_1.default)(options, 'filter'),
             upsert: undefined
         };
         const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter(options?.filter);
-        const r = await this.__updateMany(filter, patch, mongoOptions);
+        const r = await this.__updateMany(filter, update, mongoOptions);
         return r.matchedCount;
     }
     /**

package/cjs/mongo-service.js

@@ -12,8 +12,8 @@ class MongoService extends core_1.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) {
@@ -37,7 +37,6 @@ class MongoService extends core_1.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() {
@@ -46,8 +45,7 @@ class MongoService extends core_1.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];
@@ -59,8 +57,6 @@ class MongoService extends core_1.ApiService {
     }
     /**
      * Retrieves the decoder.
-     *
-     * @returns {IsObject.Validator<T>} - The encoder for the specified operation.
      */
     getDecoder() {
         let decoder = this._decoder;
@@ -73,9 +69,8 @@ class MongoService extends core_1.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();
@@ -104,12 +99,12 @@ class MongoService extends core_1.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();
         }
     }
     /**
@@ -117,9 +112,8 @@ class MongoService extends core_1.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) {
@@ -140,9 +134,8 @@ class MongoService extends core_1.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) {
@@ -164,9 +157,9 @@ class MongoService extends core_1.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();
@@ -184,12 +177,10 @@ class MongoService extends core_1.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) {
@@ -208,12 +199,33 @@ class MongoService extends core_1.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) {
@@ -234,10 +246,9 @@ class MongoService extends core_1.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();
@@ -255,11 +266,11 @@ class MongoService extends core_1.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) {
@@ -278,13 +289,12 @@ class MongoService extends core_1.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();
@@ -304,13 +314,12 @@ class MongoService extends core_1.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 = {
@@ -320,7 +329,7 @@ class MongoService extends core_1.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);
@@ -328,15 +337,14 @@ class MongoService extends core_1.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 = {
@@ -345,7 +353,7 @@ class MongoService extends core_1.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);
@@ -357,7 +365,6 @@ class MongoService extends core_1.ApiService {
      *
      * @protected
      *
-     * @returns {Promise<mongodb.Db>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     getDatabase() {
@@ -373,7 +380,6 @@ class MongoService extends core_1.ApiService {
      *
      * @protected
      *
-     * @returns {Promise<mongodb.ClientSession>} The database connection.
      * @throws {Error} If the context or database is not set.
      */
     getSession() {
@@ -384,9 +390,8 @@ class MongoService extends core_1.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());
@@ -395,7 +400,7 @@ class MongoService extends core_1.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() {
@@ -410,7 +415,7 @@ class MongoService extends core_1.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() {
@@ -424,9 +429,9 @@ class MongoService extends core_1.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();
@@ -441,7 +446,7 @@ class MongoService extends core_1.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/esm/mongo-collection-service.js

@@ -151,6 +151,24 @@ export class MongoCollectionService extends MongoService {
         const r = await this.__deleteMany(filter, omit(options, 'filter'));
         return r.deletedCount;
     }
+    async distinct(field, options) {
+        const info = {
+            crud: 'read',
+            method: 'distinct',
+            options
+        };
+        return this._intercept(async () => {
+            const filter = MongoAdapter.prepareFilter([
+                await this._getDocumentFilter(info),
+                options?.filter,
+            ]);
+            return this._distinct(field, { ...options, filter });
+        }, info);
+    }
+    async _distinct(field, options) {
+        const filter = MongoAdapter.prepareFilter(options?.filter);
+        return await this.__distinct(field, filter, omit(options, 'filter'));
+    }
     /**
      * Checks if an object with the given id exists.
      *
@@ -361,21 +379,33 @@ export class MongoCollectionService extends MongoService {
         }, info);
     }
     async _update(id, input, options) {
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        const patch = MongoAdapter.preparePatch(doc);
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = MongoAdapter.preparePatch(doc);
+            update.$set = update.$set || {};
+        }
+        else
+            update = input;
+        const filter = MongoAdapter.prepareFilter([
+            MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
+            options?.filter
+        ]);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
             upsert: undefined,
             projection: MongoAdapter.prepareProjection(this.getDataType(), options),
         };
-        const filter = MongoAdapter.prepareFilter([
-            MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
-            options?.filter
-        ]);
         const decode = this.getDecoder();
-        const out = await this.__findOneAndUpdate(filter, patch, mongoOptions);
+        const out = await this.__findOneAndUpdate(filter, update, mongoOptions);
         return out ? decode(out, { coerce: true }) : undefined;
     }
     /**
@@ -403,22 +433,33 @@ export class MongoCollectionService extends MongoService {
         }, info);
     }
     async _updateOnly(id, input, options) {
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = MongoAdapter.preparePatch(doc);
+            if (!Object.keys(doc).length)
+                return 0;
+        }
+        else
+            update = input;
         const filter = MongoAdapter.prepareFilter([
             MongoAdapter.prepareKeyValues(id, [this.collectionKey]),
             options?.filter
         ]);
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        if (!Object.keys(doc).length)
-            return 0;
-        const patch = MongoAdapter.preparePatch(doc);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
             upsert: undefined,
             projection: MongoAdapter.prepareProjection(this.getDataType(), options),
         };
-        const out = await this.__updateOne(filter, patch, mongoOptions);
+        const out = await this.__updateOne(filter, update, mongoOptions);
         return out.matchedCount;
     }
     /**
@@ -444,18 +485,28 @@ export class MongoCollectionService extends MongoService {
         }, info);
     }
     async _updateMany(input, options) {
-        const encode = this.getEncoder('update');
-        const doc = encode(input, { coerce: true });
-        if (!Object.keys(doc).length)
-            return 0;
-        const patch = MongoAdapter.preparePatch(doc);
-        patch.$set = patch.$set || {};
+        const isUpdateFilter = Array.isArray(input) ||
+            !!Object.keys(input).find(x => x.startsWith('$'));
+        const isDocument = !Array.isArray(input) &&
+            !!Object.keys(input).find(x => !x.startsWith('$'));
+        if (isUpdateFilter && isDocument)
+            throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
+        let update;
+        if (isDocument) {
+            const encode = this.getEncoder('update');
+            const doc = encode(input, { coerce: true });
+            update = MongoAdapter.preparePatch(doc);
+            if (!Object.keys(doc).length)
+                return 0;
+        }
+        else
+            update = input;
         const mongoOptions = {
             ...omit(options, 'filter'),
             upsert: undefined
         };
         const filter = MongoAdapter.prepareFilter(options?.filter);
-        const r = await this.__updateMany(filter, patch, mongoOptions);
+        const r = await this.__updateMany(filter, update, mongoOptions);
         return r.matchedCount;
     }
     /**