@opra/mongodb 1.0.0-alpha.16 → 1.0.0-alpha.18

package/esm/mongo-entity-service.js

@@ -1,6 +1,6 @@
-import * as assert from 'node:assert';
 import { InternalServerError } from '@opra/common';
 import omit from 'lodash.omit';
+import { isNotNullish } from 'valgen';
 import { MongoAdapter } from './mongo-adapter.js';
 import { MongoService } from './mongo-service.js';
 /**
@@ -21,19 +21,27 @@ export class MongoEntityService extends MongoService {
     /**
      * Creates a new document in the MongoDB collection.
      *
-     * @param {PartialDTO<T>} input
-     * @param {MongoEntityService.CreateOptions} options
+     * @param {MongoEntityService.CreateCommand} command
      * @protected
      */
-    async _create(input, options) {
+    async _create(command) {
+        isNotNullish(command.input, { label: 'input' });
+        isNotNullish(command.input._id, { label: 'input._id' });
         const inputCodec = this.getInputCodec('create');
-        const doc = inputCodec(input);
-        assert.ok(doc._id, 'You must provide the "_id" field');
+        const doc = inputCodec(command.input);
+        const { options } = command;
         const r = await this._dbInsertOne(doc, options);
         if (r.insertedId) {
-            if (!options)
+            if (!command.options)
                 return doc;
-            const out = await this._findById(doc._id, omit(options, 'filter'));
+            const findCommand = {
+                ...command,
+                crud: 'read',
+                byId: true,
+                documentId: doc._id,
+                options: omit(options, 'filter'),
+            };
+            const out = await this._findById(findCommand);
             if (out)
                 return out;
         }
@@ -43,56 +51,65 @@ export class MongoEntityService extends MongoService {
     /**
      * Returns the count of documents in the collection based on the provided options.
      *
-     * @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.
+     * @param {MongoEntityService.CountCommand<T>} command
+     * @protected
      */
-    async _count(options) {
+    async _count(command) {
+        const { options } = command;
         const filter = MongoAdapter.prepareFilter(options?.filter);
         return this._dbCountDocuments(filter, omit(options, 'filter'));
     }
     /**
      * Deletes a document from the collection.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document to delete.
-     * @param {MongoEntityService.DeleteOptions<T>} [options] - Optional delete options.
-     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
+     * @param {MongoEntityService.DeleteCommand<T>} command
+     * @protected
      */
-    async _delete(id, options) {
-        assert.ok(id, 'You must provide an id');
-        const filter = MongoAdapter.prepareFilter([MongoAdapter.prepareKeyValues(id, ['_id']), options?.filter]);
+    async _delete(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        const { options } = command;
+        const filter = MongoAdapter.prepareFilter([
+            MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
+            options?.filter,
+        ]);
         const r = await this._dbDeleteOne(filter, options);
         return r.deletedCount;
     }
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {MongoEntityService.DeleteManyOptions<T>} options - The options for the delete operation.
-     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
+     * @param {MongoEntityService.DeleteCommand<T>} command
+     * @protected
      */
-    async _deleteMany(options) {
+    async _deleteMany(command) {
+        const { options } = command;
         const filter = MongoAdapter.prepareFilter(options?.filter);
         const r = await this._dbDeleteMany(filter, omit(options, 'filter'));
         return r.deletedCount;
     }
     /**
      * The distinct command returns a list of distinct values for the given key across a collection.
-     * @param {string} field
-     * @param {MongoEntityService.DistinctOptions<T>} options
+     *
+     * @param {MongoEntityService.DistinctCommand<T>} command
      * @protected
      */
-    async _distinct(field, options) {
+    async _distinct(command) {
+        const { options, field } = command;
         const filter = MongoAdapter.prepareFilter(options?.filter);
         return await this._dbDistinct(field, filter, omit(options, 'filter'));
     }
     /**
      * Finds a document by its ID.
      *
-     * @param {MongoAdapter.AnyId} id - The ID of the document.
-     * @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.
+     * @param { MongoEntityService.FindOneCommand<T>} command
      */
-    async _findById(id, options) {
-        const filter = MongoAdapter.prepareFilter([MongoAdapter.prepareKeyValues(id, ['_id']), options?.filter]);
+    async _findById(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        const filter = MongoAdapter.prepareFilter([
+            MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
+            command.options?.filter,
+        ]);
+        const { options } = command;
         const mongoOptions = {
             ...options,
             projection: MongoAdapter.prepareProjection(this.dataType, options?.projection),
@@ -108,10 +125,10 @@ export class MongoEntityService extends MongoService {
     /**
      * Finds a document in the collection that matches the specified options.
      *
-     * @param {MongoEntityService.FindOneOptions} [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.
+     * @param {MongoEntityService.FindOneCommand<T>} command
      */
-    async _findOne(options) {
+    async _findOne(command) {
+        const { options } = command;
         const filter = MongoAdapter.prepareFilter(options?.filter);
         const mongoOptions = {
             ...omit(options, 'filter'),
@@ -127,10 +144,10 @@ export class MongoEntityService extends MongoService {
     /**
      * Finds multiple documents in the MongoDB collection.
      *
-     * @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.
+     * @param {MongoEntityService.FindManyCommand<T>} command
      */
-    async _findMany(options) {
+    async _findMany(command) {
+        const { options } = command;
         const mongoOptions = {
             ...omit(options, ['projection', 'sort', 'skip', 'limit', 'filter']),
         };
@@ -169,10 +186,10 @@ export class MongoEntityService extends MongoService {
      * Finds multiple documents in the collection and returns both records (max limit)
      * and total count that matched the given criteria
      *
-     * @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.
+     * @param {MongoEntityService.FindManyCommand<T>} command
      */
-    async _findManyWithCount(options) {
+    async _findManyWithCount(command) {
+        const { options } = command;
         const mongoOptions = {
             ...omit(options, ['projection', 'sort', 'skip', 'limit', 'filter']),
         };
@@ -226,20 +243,17 @@ export class MongoEntityService extends MongoService {
     /**
      * Updates a document with the given id in the collection.
      *
-     * @param {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 {MongoEntityService.UpdateOptions<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.
+     * @param {MongoEntityService.UpdateOneCommand<T>} command
      */
-    async _update(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) {
+    async _update(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        const { input, inputRaw, options } = command;
+        isNotNullish(input || inputRaw, { label: 'input' });
+        if (input && inputRaw) {
             throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
         }
         let update;
-        if (isDocument) {
+        if (input) {
             const inputCodec = this.getInputCodec('update');
             const doc = inputCodec(input);
             delete doc._id;
@@ -247,8 +261,11 @@ export class MongoEntityService extends MongoService {
             update.$set = update.$set || {};
         }
         else
-            update = input;
-        const filter = MongoAdapter.prepareFilter([MongoAdapter.prepareKeyValues(id, ['_id']), options?.filter]);
+            update = inputRaw;
+        const filter = MongoAdapter.prepareFilter([
+            MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
+            options?.filter,
+        ]);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
@@ -263,19 +280,17 @@ export class MongoEntityService extends MongoService {
     /**
      * 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 {MongoEntityService.UpdateOptions<T>} [options] - The options for updating the document.
-     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
+     * @param {MongoEntityService.UpdateOneCommand<T>} command
      */
-    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) {
+    async _updateOnly(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        const { input, inputRaw, options } = command;
+        isNotNullish(input || inputRaw, { label: 'input' });
+        if (input && inputRaw) {
             throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
         }
         let update;
-        if (isDocument) {
+        if (input) {
             const inputCodec = this.getInputCodec('update');
             const doc = inputCodec(input);
             delete doc._id;
@@ -284,8 +299,11 @@ export class MongoEntityService extends MongoService {
                 return 0;
         }
         else
-            update = input;
-        const filter = MongoAdapter.prepareFilter([MongoAdapter.prepareKeyValues(id, ['_id']), options?.filter]);
+            update = inputRaw;
+        const filter = MongoAdapter.prepareFilter([
+            MongoAdapter.prepareKeyValues(command.documentId, ['_id']),
+            options?.filter,
+        ]);
         const mongoOptions = {
             ...options,
             includeResultMetadata: false,
@@ -298,18 +316,17 @@ export class MongoEntityService extends MongoService {
     /**
      * 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 {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.
+     * @param {MongoEntityService.UpdateManyCommand<T>} command
      */
-    async _updateMany(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) {
+    async _updateMany(command) {
+        isNotNullish(command.input, { label: 'input' });
+        const { input, inputRaw, options } = command;
+        isNotNullish(input || inputRaw, { label: 'input' });
+        if (input && inputRaw) {
             throw new TypeError('You must pass one of MongoDB UpdateFilter or a partial document, not both');
         }
         let update;
-        if (isDocument) {
+        if (input) {
             const inputCodec = this.getInputCodec('update');
             const doc = inputCodec(input);
             delete doc._id;
@@ -318,7 +335,7 @@ export class MongoEntityService extends MongoService {
                 return 0;
         }
         else
-            update = input;
+            update = inputRaw;
         const mongoOptions = {
             ...omit(options, 'filter'),
             upsert: undefined,