@opra/mongodb 1.0.0-alpha.2 → 1.0.0-alpha.21

package/esm/mongo-collection-service.js

@@ -1,4 +1,3 @@
-import { ObjectId } from 'mongodb';
 import { ResourceNotAvailableError } from '@opra/common';
 import { MongoAdapter } from './mongo-adapter.js';
 import { MongoEntityService } from './mongo-entity-service.js';
@@ -23,7 +22,7 @@ export class MongoCollectionService extends MongoEntityService {
      * Throws a ResourceNotFoundError if the resource does not exist.
      *
      * @param {MongoAdapter.AnyId} id - The ID of the resource to assert.
-     * @param {MongoCollectionService.ExistsOptions<T>} [options] - Optional options for checking the existence.
+     * @param {MongoEntityService.ExistsOptions<T>} [options] - Optional options for checking the existence.
      * @returns {Promise<void>} - A Promise that resolves when the resource exists.
      * @throws {ResourceNotAvailableError} - If the resource does not exist.
      */
@@ -36,112 +35,126 @@ export class MongoCollectionService extends MongoEntityService {
      * Interceptors will be called before performing db operation
      *
      * @param {PartialDTO<T>} input - The input data for creating the document.
-     * @param {MongoCollectionService.CreateOptions} [options] - The options for creating the document.
+     * @param {MongoEntityService.CreateOptions} [options] - The options for creating the document.
      * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created document.
      * @throws {Error} if an unknown error occurs while creating the document.
      */
     async create(input, options) {
-        const id = input._id || this._generateId();
-        if (id != null)
-            input._id = id;
-        const info = {
+        const command = {
             crud: 'create',
             method: 'create',
             byId: false,
-            documentId: id,
             input,
             options,
         };
-        return this._intercept(() => this._create(input, options), info);
+        return this._executeCommand(command, () => this._create(command));
     }
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
-     * @param {MongoCollectionService.CountOptions<T>} options - The options for the count operation.
+     * @param {MongoEntityService.CountOptions<T>} options - The options for the count operation.
      * @return {Promise<number>} - A promise that resolves to the count of documents in the collection.
      */
     async count(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'count',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._count({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._count(command);
+        });
     }
     /**
      * Deletes a document from the collection.
      *
      * @param {MongoAdapter.AnyId} id - The ID of the document to delete.
-     * @param {MongoCollectionService.DeleteOptions<T>} [options] - Optional delete options.
+     * @param {MongoEntityService.DeleteOptions<T>} [options] - Optional delete options.
      * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
      */
     async delete(id, options) {
-        const info = {
+        const command = {
             crud: 'delete',
             method: 'delete',
             byId: true,
             documentId: id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._delete(id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._delete(command);
+        });
     }
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {MongoCollectionService.DeleteManyOptions<T>} options - The options for the delete operation.
+     * @param {MongoEntityService.DeleteManyOptions<T>} options - The options for the delete operation.
      * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
      */
     async deleteMany(options) {
-        const info = {
+        const command = {
             crud: 'delete',
             method: 'deleteMany',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._deleteMany({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._deleteMany(command);
+        });
     }
     /**
      * The distinct command returns a list of distinct values for the given key across a collection.
      * @param {string} field
-     * @param {MongoCollectionService.DistinctOptions<T>} [options]
+     * @param {MongoEntityService.DistinctOptions<T>} [options]
      * @protected
      */
     async distinct(field, options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'distinct',
-            byId: true,
+            byId: false,
+            field,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._distinct(field, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._distinct(command);
+        });
     }
     /**
      * Checks if an object with the given id exists.
      *
      * @param {MongoAdapter.AnyId} id - The id of the object to check.
-     * @param {MongoCollectionService.ExistsOptions<T>} [options] - The options for the query (optional).
+     * @param {MongoEntityService.ExistsOptions<T>} [options] - The options for the query (optional).
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     async exists(id, options) {
-        return !!(await this.findById(id, { ...options, projection: ['_id'] }));
+        const command = {
+            crud: 'read',
+            method: 'exists',
+            byId: true,
+            documentId: id,
+            options,
+        };
+        return this._executeCommand(command, async () => {
+            const documentFilter = await this._getDocumentFilter(command);
+            const filter = MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            const findCommand = command;
+            findCommand.options = { ...command.options, filter, projection: ['_id'] };
+            return !!(await this._findById(findCommand));
+        });
     }
     /**
      * Checks if an object with the given arguments exists.
      *
-     * @param {MongoCollectionService.ExistsOneOptions} [options] - The options for the query (optional).
+     * @param {MongoEntityService.ExistsOneOptions} [options] - The options for the query (optional).
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the object exists or not.
      */
     async existsOne(options) {
@@ -151,83 +164,87 @@ export class MongoCollectionService extends MongoEntityService {
      * Finds a document by its ID.
      *
      * @param {MongoAdapter.AnyId} id - The ID of the document.
-     * @param {MongoCollectionService.FindOneOptions<T>} [options] - The options for the find query.
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for the find query.
      * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
      */
     async findById(id, options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'findById',
             byId: true,
             documentId: id,
             options,
         };
-        return this._intercept(async () => {
-            const documentFilter = await this._getDocumentFilter(info);
-            const filter = MongoAdapter.prepareFilter([documentFilter, options?.filter]);
-            return this._findById(id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const documentFilter = await this._getDocumentFilter(command);
+            const filter = MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findById(command);
+        });
     }
     /**
      * Finds a document in the collection that matches the specified options.
      *
-     * @param {MongoCollectionService.FindOneOptions<T>} [options] - The options for the query.
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for the query.
      * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
      */
     async findOne(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'findOne',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._findOne({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findOne(command);
+        });
     }
     /**
      * Finds multiple documents in the MongoDB collection.
      *
-     * @param {MongoCollectionService.FindManyOptions<T>} options - The options for the find operation.
+     * @param {MongoEntityService.FindManyOptions<T>} options - The options for the find operation.
      * @return A Promise that resolves to an array of partial outputs of type T.
      */
     async findMany(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'findMany',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._findMany({ ...options, filter, limit: options?.limit || this.defaultLimit });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter, limit: command.options?.limit || this.defaultLimit };
+            return this._findMany(command);
+        });
     }
     /**
      * Finds multiple documents in the collection and returns both records (max limit)
      * and total count that matched the given criteria
      *
-     * @param {MongoCollectionService.FindManyOptions<T>} [options] - The options for the find operation.
+     * @param {MongoEntityService.FindManyOptions<T>} [options] - The options for the find operation.
      * @return A Promise that resolves to an array of partial outputs of type T.
      */
     async findManyWithCount(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'findManyWithCount',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._findManyWithCount({ ...options, filter, limit: options?.limit || this.defaultLimit });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter, limit: command.options?.limit || this.defaultLimit };
+            return this._findManyWithCount(command);
+        });
     }
     /**
      * Retrieves a document from the collection by its ID. Throws error if not found.
      *
      * @param {MongoAdapter.AnyId} id - The ID of the document to retrieve.
-     * @param {MongoCollectionService.FindOneOptions<T>} [options] - Optional options for the findOne operation.
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - Optional options for the findOne operation.
      * @returns {Promise<PartialDTO<T>>} - A promise that resolves to the retrieved document,
      *    or rejects with a ResourceNotFoundError if the document does not exist.
      * @throws {ResourceNotAvailableError} - If the document with the specified ID does not exist.
@@ -243,73 +260,73 @@ export class MongoCollectionService extends MongoEntityService {
      *
      * @param {MongoAdapter.AnyId} id - The id of the document to update.
      * @param {PatchDTO<T>|UpdateFilter<T>} input - The partial input object containing the fields to update.
-     * @param {MongoCollectionService.UpdateOptions<T>} [options] - The options for the update operation.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The options for the update operation.
      * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
      * undefined if the document was not found.
      */
     async update(id, input, options) {
-        const info = {
+        const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: id,
             byId: true,
-            input,
+            input: isUpdateFilter ? undefined : input,
+            inputRaw: isUpdateFilter ? input : undefined,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._update(id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._update(command);
+        });
     }
     /**
      * Updates a document in the collection with the specified ID.
      *
      * @param {MongoAdapter.AnyId} id - The ID of the document to update.
      * @param {PatchDTO<T>|UpdateFilter<T>} input - The partial input data to update the document with.
-     * @param {MongoCollectionService.UpdateOptions<T>} [options] - The options for updating the document.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The options for updating the document.
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
     async updateOnly(id, input, options) {
-        const info = {
+        const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
+        const command = {
             crud: 'update',
-            method: 'update',
+            method: 'updateOnly',
             documentId: id,
             byId: true,
-            input,
+            input: isUpdateFilter ? undefined : input,
+            inputRaw: isUpdateFilter ? input : undefined,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._updateOnly(id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateOnly(command);
+        });
     }
     /**
      * Updates multiple documents in the collection based on the specified input and options.
      *
      * @param {PatchDTO<T>|UpdateFilter<T>} input - The partial input to update the documents with.
-     * @param {MongoCollectionService.UpdateManyOptions<T>} options - The options for updating the documents.
+     * @param {MongoEntityService.UpdateManyOptions<T>} options - The options for updating the documents.
      * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
     async updateMany(input, options) {
-        const info = {
+        const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
+        const command = {
             crud: 'update',
             method: 'updateMany',
             byId: false,
-            input,
+            input: isUpdateFilter ? undefined : input,
+            inputRaw: isUpdateFilter ? input : undefined,
             options,
         };
-        return this._intercept(async () => {
-            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._updateMany(input, { ...options, filter });
-        }, info);
-    }
-    /**
-     * Generates an ID.
-     *
-     * @protected
-     * @returns {MongoAdapter.AnyId} The generated ID.
-     */
-    _generateId() {
-        return typeof this.$idGenerator === 'function' ? this.$idGenerator(this) : new ObjectId();
+        return this._executeCommand(command, async () => {
+            const filter = MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateMany(command);
+        });
     }
 }