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

package/cjs/mongo-service.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MongoService = void 0;
-const mongodb_1 = require("mongodb");
 const common_1 = require("@opra/common");
 const core_1 = require("@opra/core");
+const mongodb_1 = require("mongodb");
 /**
  * Class representing a MongoDB service for interacting with a collection.
  * @extends ServiceBase
@@ -19,23 +19,24 @@ class MongoService extends core_1.ServiceBase {
      */
     constructor(dataType, options) {
         super();
-        this._encoders = {};
-        this._dataType = dataType;
+        this._inputCodecs = {};
+        this._outputCodecs = {};
+        this._dataType_ = dataType;
         this.db = options?.db;
-        this.$documentFilter = this.$documentFilter || options?.documentFilter;
-        this.$interceptor = this.$interceptor || options?.interceptor;
-        this.$collectionName = options?.collectionName;
-        if (!this.$collectionName) {
+        this.documentFilter = options?.documentFilter;
+        this.interceptor = options?.interceptor;
+        this.collectionName = options?.collectionName;
+        if (!this.collectionName) {
             if (typeof dataType === 'string')
-                this.$collectionName = dataType;
+                this.collectionName = dataType;
             if (typeof dataType === 'function') {
                 const metadata = Reflect.getMetadata(common_1.DATATYPE_METADATA, dataType);
                 if (metadata)
-                    this.$collectionName = metadata.name;
+                    this.collectionName = metadata.name;
             }
         }
-        this.$resourceName = options?.resourceName;
-        this.$idGenerator = options?.idGenerator;
+        this.resourceName = options?.resourceName;
+        this.idGenerator = options?.idGenerator;
     }
     /**
      * Retrieves the collection name.
@@ -45,7 +46,7 @@ class MongoService extends core_1.ServiceBase {
      * @throws {Error} If the collection name is not defined.
      */
     getCollectionName() {
-        const out = typeof this.$collectionName === 'function' ? this.$collectionName(this) : this.$collectionName;
+        const out = typeof this.collectionName === 'function' ? this.collectionName(this) : this.collectionName;
         if (out)
             return out;
         throw new Error('collectionName is not defined');
@@ -55,53 +56,53 @@ class MongoService extends core_1.ServiceBase {
      *
      * @protected
      * @returns {string} The resource name.
-     * @throws {Error} If the collection name is not defined.
+     * @throws {Error} If the resource name is not defined.
      */
     getResourceName() {
-        const out = typeof this.$resourceName === 'function'
-            ? this.$resourceName(this)
-            : this.$resourceName || this.getCollectionName();
+        const out = typeof this.resourceName === 'function' ? this.resourceName(this) : this.resourceName || this.getCollectionName();
         if (out)
             return out;
         throw new Error('resourceName is not defined');
     }
     /**
-     * Retrieves the data type of the document
+     * Retrieves the OPRA data type
      *
      * @throws {NotAcceptableError} If the data type is not a ComplexType.
      */
-    getDataType() {
-        return this.context.document.node.getComplexType(this._dataType);
+    get dataType() {
+        if (!this._dataType)
+            this._dataType = this.context.document.node.getComplexType(this._dataType_);
+        return this._dataType;
     }
     /**
-     * Retrieves the encoder for the specified operation.
+     * Retrieves the codec 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];
-        if (encoder)
-            return encoder;
+    getInputCodec(operation) {
+        let validator = this._inputCodecs[operation];
+        if (validator)
+            return validator;
         const options = { projection: '*' };
         if (operation === 'update')
-            options.partial = true;
-        const dataType = this.getDataType();
-        encoder = dataType.generateCodec('encode', options);
-        this._encoders[operation] = encoder;
-        return encoder;
+            options.partial = 'deep';
+        const dataType = this.dataType;
+        validator = dataType.generateCodec('decode', options);
+        this._inputCodecs[operation] = validator;
+        return validator;
     }
     /**
-     * Retrieves the decoder.
+     * Retrieves the codec.
      */
-    getDecoder() {
-        let decoder = this._decoder;
-        if (decoder)
-            return decoder;
-        const options = { projection: '*', partial: true };
-        const dataType = this.getDataType();
-        decoder = dataType.generateCodec('decode', options);
-        this._decoder = decoder;
-        return decoder;
+    getOutputCodec(operation) {
+        let validator = this._outputCodecs[operation];
+        if (validator)
+            return validator;
+        const options = { projection: '*', partial: 'deep' };
+        const dataType = this.dataType;
+        validator = dataType.generateCodec('decode', options);
+        this._outputCodecs[operation] = validator;
+        return validator;
     }
     /**
      * Executes the provided function within a transaction.
@@ -114,7 +115,7 @@ class MongoService extends core_1.ServiceBase {
         if (session)
             return callback(session);
         // Backup old session property
-        const hasOldSession = this.hasOwnProperty('session');
+        const hasOldSession = Object.prototype.hasOwnProperty.call(this, 'session');
         const oldSessionGetter = hasOldSession ? this.session : undefined;
         const db = this.getDatabase();
         const client = db.client;
@@ -367,8 +368,8 @@ class MongoService extends core_1.ServiceBase {
      * @protected
      * @returns {MongoAdapter.AnyId} The generated ID.
      */
-    _generateId() {
-        return typeof this.$idGenerator === 'function' ? this.$idGenerator(this) : new mongodb_1.ObjectId();
+    _generateId(command) {
+        return typeof this.idGenerator === 'function' ? this.idGenerator(command, this) : new mongodb_1.ObjectId();
     }
     /**
      * Retrieves the common filter used for querying documents.
@@ -378,18 +379,29 @@ class MongoService extends core_1.ServiceBase {
      * @returns {FilterInput | Promise<FilterInput> | undefined} The common filter or a Promise
      * that resolves to the common filter, or undefined if not available.
      */
-    _getDocumentFilter(info) {
-        return typeof this.$documentFilter === 'function' ? this.$documentFilter(info, this) : this.$documentFilter;
+    _getDocumentFilter(command) {
+        return typeof this.documentFilter === 'function' ? this.documentFilter(command, this) : this.documentFilter;
     }
-    async _intercept(callback, info) {
+    async _executeCommand(command, commandFn) {
+        let proto;
+        const next = async () => {
+            proto = proto ? Object.getPrototypeOf(proto) : this;
+            while (proto) {
+                if (proto.interceptor) {
+                    return await proto.interceptor.call(this, next, command, this);
+                }
+                proto = Object.getPrototypeOf(proto);
+                if (!(proto instanceof MongoService))
+                    break;
+            }
+            return commandFn();
+        };
         try {
-            if (this.$interceptor)
-                return this.$interceptor(callback, info, this);
-            return callback();
+            return await next();
         }
         catch (e) {
-            Error.captureStackTrace(e, this._intercept);
-            await this.$onError?.(e, this);
+            Error.captureStackTrace(e, this._executeCommand);
+            await this.onError?.(e, this);
             throw e;
         }
     }

package/cjs/mongo-singleton-service.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MongoSingletonService = void 0;
-const mongodb_1 = require("mongodb");
 const common_1 = require("@opra/common");
+const mongodb_1 = require("mongodb");
 const mongo_adapter_js_1 = require("./mongo-adapter.js");
 const mongo_entity_service_js_1 = require("./mongo-entity-service.js");
 /**
@@ -26,7 +26,7 @@ class MongoSingletonService extends mongo_entity_service_js_1.MongoEntityService
     /**
      * Asserts the existence of a resource based on the given options.
      *
-     * @param {MongoSingletonService.ExistsOptions<T>} [options]
+     * @param {MongoEntityService.ExistsOptions<T>} [options]
      * @returns {Promise<void>} A Promise that resolves when the resource exists.
      * @throws {ResourceNotAvailableError} If the resource does not exist.
      */
@@ -38,72 +38,88 @@ class MongoSingletonService extends mongo_entity_service_js_1.MongoEntityService
      * Creates the document in the database.
      *
      * @param {PartialDTO<T>} input - The partial input to create the document with.
-     * @param {MongoSingletonService.CreateOptions} [options] - The options for creating the document.
+     * @param {MongoEntityService.CreateOptions} [options] - The options for creating the document.
      * @return {Promise<PartialDTO<T>>} A promise that resolves to the partial output of the created document.
      * @throws {Error} Throws an error if an unknown error occurs while creating the document.
      */
     async create(input, options) {
-        input._id = this._id;
-        const info = {
+        const command = {
             crud: 'create',
             method: 'create',
             byId: false,
-            documentId: this._id,
             input,
             options,
         };
-        return this._intercept(() => this._create(input, options), info);
+        input._id = this._id;
+        return this._executeCommand(command, () => this._create(command));
     }
     /**
      * Deletes a record from the database
      *
-     * @param {MongoSingletonService.DeleteOptions<T>} options - The options for deleting the record
+     * @param {MongoEntityService.DeleteOptions<T>} options - The options for deleting the record
      * @returns {Promise<number>} The number of records deleted
      */
     async delete(options) {
-        const info = {
+        const command = {
             crud: 'delete',
             method: 'delete',
             byId: true,
             documentId: this._id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._delete(this._id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._delete(command);
+        });
     }
     /**
      * Checks if the document exists in the database.
      *
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for finding the document.
      * @return {Promise<boolean>} - A promise that resolves to a boolean value indicating if the document exists.
      */
     async exists(options) {
-        return !!(await this.find({ ...options, projection: ['_id'], skip: undefined }));
+        const command = {
+            crud: 'read',
+            method: 'exists',
+            byId: true,
+            documentId: this._id,
+            options,
+        };
+        return this._executeCommand(command, async () => {
+            const documentFilter = await this._getDocumentFilter(command);
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            const findCommand = command;
+            findCommand.options = { ...command.options, filter, projection: ['_id'] };
+            return !!(await this._findById(findCommand));
+        });
     }
     /**
      * Fetches the document if it exists. Returns undefined if not found.
      *
-     * @param {MongoSingletonService.FindOneOptions<T>} [options] - The options for finding the document.
+     * @param {MongoEntityService.FindOneOptions<T>} [options] - The options for finding the document.
      * @returns {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the found document or undefined if not found.
      */
     async find(options) {
-        const info = {
+        const command = {
             crud: 'read',
-            method: 'findOne',
+            method: 'findById',
             byId: true,
             documentId: this._id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._findById(this._id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const documentFilter = await this._getDocumentFilter(command);
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([documentFilter, command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findById(command);
+        });
     }
     /**
      * Fetches the document from the Mongo collection service. Throws error if not found.
      *
-     * @param {MongoSingletonService.FindOneOptions<T>} options - The options to customize the query.
+     * @param {MongoEntityService.FindOneOptions<T>} options - The options to customize the query.
      * @return {Promise<PartialDTO<T>>} - A promise that resolves to the fetched document.
      * @throws {ResourceNotAvailableError} - If the document is not found in the collection.
      */
@@ -117,45 +133,49 @@ class MongoSingletonService extends mongo_entity_service_js_1.MongoEntityService
      * Updates a document in the MongoDB collection.
      *
      * @param {PatchDTO<T>} input - The partial input to update the document.
-     * @param {MongoSingletonService.UpdateOptions<T>} [options] - The update options.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The update options.
      *
-     * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
+     * @return {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the updated document or undefined if not found.
      */
-    async updateOnly(input, options) {
-        const info = {
+    async update(input, options) {
+        const isUpdateFilter = Array.isArray(input) || !!Object.keys(input).find(x => x.startsWith('$'));
+        const command = {
             crud: 'update',
             method: 'update',
-            byId: true,
             documentId: this._id,
-            input,
+            byId: true,
+            input: isUpdateFilter ? undefined : input,
+            inputRaw: isUpdateFilter ? input : undefined,
             options,
         };
-        return this._intercept(async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._updateOnly(this._id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._update(command);
+        });
     }
     /**
      * Updates a document in the MongoDB collection.
      *
      * @param {PatchDTO<T>} input - The partial input to update the document.
-     * @param {MongoSingletonService.UpdateOptions<T>} [options] - The update options.
+     * @param {MongoEntityService.UpdateOneOptions<T>} [options] - The update options.
      *
-     * @return {Promise<PartialDTO<T> | undefined>} - A promise that resolves to the updated document or undefined if not found.
+     * @return {Promise<number>} - A promise that resolves to the updated document or undefined if not found.
      */
-    async update(input, options) {
-        const info = {
+    async updateOnly(input, options) {
+        const command = {
             crud: 'update',
-            method: 'update',
-            byId: true,
+            method: 'updateOnly',
             documentId: this._id,
+            byId: true,
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(info), options?.filter]);
-            return this._update(this._id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = mongo_adapter_js_1.MongoAdapter.prepareFilter([await this._getDocumentFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateOnly(command);
+        });
     }
 }
 exports.MongoSingletonService = MongoSingletonService;

package/esm/adapter-utils/prepare-filter.js

@@ -164,6 +164,8 @@ function prepareFilterAst(ast, negative) {
                         },
                     }, !negative),
                 };
+            default:
+                break;
         }
         throw new Error(`Unimplemented ComparisonExpression operation (right side is ${ast.right.kind})`);
     }

package/esm/adapter-utils/prepare-key-values.js

@@ -3,13 +3,14 @@ const defaultPrimaryKey = ['_id'];
 export default function prepareKeyValues(keyValue, primaryKey) {
     primaryKey = primaryKey || defaultPrimaryKey;
     const b = isPlainObject(keyValue);
-    if (primaryKey.length > 1 && !b)
-        new TypeError(`Argument "keyValue" must be an object that contains all key values`);
+    if (primaryKey.length > 1 && !b) {
+        throw new TypeError(`Argument "keyValue" must be an object that contains all key values`);
+    }
     if (primaryKey.length > 1 || b) {
         return primaryKey.reduce((o, k) => {
             o[k] = keyValue[k];
             if (o[k] == null)
-                new Error(`Value of key "${k}" is required`);
+                throw new Error(`Value of key "${k}" is required`);
             return o;
         }, {});
     }

package/esm/adapter-utils/prepare-patch.js

@@ -4,10 +4,11 @@ export default function preparePatch(doc, options) {
     trg.$set = trg.$set || {};
     return trg;
 }
-function _preparePatch(src, trg = {}, path, options) {
+function _preparePatch(src, trg, path, options) {
     let f;
     let key;
     let field;
+    trg = trg || {};
     const fieldPrefix = options?.fieldPrefix;
     for (const [k, v] of Object.entries(src)) {
         f = k.startsWith('*') ? k.substring(1) : k;

package/esm/index.js

@@ -1,5 +1,5 @@
 export * from './mongo-adapter.js';
-export * from './mongo-nested-service.js';
 export * from './mongo-collection-service.js';
+export * from './mongo-nested-service.js';
 export * from './mongo-service.js';
 export * from './mongo-singleton-service.js';

package/esm/mongo-adapter.js

@@ -13,7 +13,7 @@ export var MongoAdapter;
     async function parseRequest(context) {
         const { operation } = context;
         if (operation.composition?.startsWith('Entity.') && operation.compositionOptions?.type) {
-            const { compositionOptions } = operation;
+            const controller = operation.owner;
             switch (operation.composition) {
                 case 'Entity.Create': {
                     const data = await context.getBody();
@@ -23,7 +23,8 @@ export var MongoAdapter;
                     return { method: 'create', data, options };
                 }
                 case 'Entity.Delete': {
-                    const key = context.pathParams[compositionOptions.keyParameter];
+                    const keyParam = operation.parameters.find(p => p.keyParam) || controller.parameters.find(p => p.keyParam);
+                    const key = keyParam && context.pathParams[String(keyParam.name)];
                     const options = {
                         filter: context.queryParams.filter,
                     };
@@ -47,7 +48,8 @@ export var MongoAdapter;
                     return { method: 'findMany', options };
                 }
                 case 'Entity.Get': {
-                    const key = context.pathParams[compositionOptions.keyParameter];
+                    const keyParam = operation.parameters.find(p => p.keyParam) || controller.parameters.find(p => p.keyParam);
+                    const key = keyParam && context.pathParams[String(keyParam.name)];
                     const options = {
                         projection: context.queryParams.projection,
                         filter: context.queryParams.filter,
@@ -56,7 +58,8 @@ export var MongoAdapter;
                 }
                 case 'Entity.Update': {
                     const data = await context.getBody();
-                    const key = context.pathParams[compositionOptions.keyParameter];
+                    const keyParam = operation.parameters.find(p => p.keyParam) || controller.parameters.find(p => p.keyParam);
+                    const key = keyParam && context.pathParams[String(keyParam.name)];
                     const options = {
                         projection: context.queryParams.projection,
                         filter: context.queryParams.filter,
@@ -70,6 +73,8 @@ export var MongoAdapter;
                     };
                     return { method: 'updateMany', data, options };
                 }
+                default:
+                    break;
             }
         }
         throw new Error(`This operation is not compatible to MongoDB adapter`);