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

package/esm/sqb-collection-service.js

@@ -39,14 +39,14 @@ export class SqbCollectionService extends SqbEntityService {
      * @throws {Error} if an unknown error occurs while creating the resource
      */
     async create(input, options) {
-        const info = {
+        const command = {
             crud: 'create',
             method: 'create',
             byId: false,
             input,
             options,
         };
-        return this._intercept(() => this._create(input, options), info);
+        return this._executeCommand(command, () => this._create(command));
     }
     /**
      * Returns the count of records based on the provided options
@@ -55,16 +55,17 @@ export class SqbCollectionService extends SqbEntityService {
      * @return {Promise<number>} - A promise that resolves to the count of records
      */
     async count(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'count',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._count({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._count(command);
+        });
     }
     /**
      * Deletes a record from the collection.
@@ -74,17 +75,18 @@ export class SqbCollectionService extends SqbEntityService {
      * @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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._delete(id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(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.
@@ -93,16 +95,17 @@ export class SqbCollectionService extends SqbEntityService {
      * @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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._deleteMany({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._deleteMany(command);
+        });
     }
     /**
      * Checks if a record with the given id exists.
@@ -112,17 +115,18 @@ export class SqbCollectionService extends SqbEntityService {
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
      */
     async exists(id, options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'exists',
             byId: true,
             documentId: id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._exists(id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._exists(command);
+        });
     }
     /**
      * Checks if a record with the given arguments exists.
@@ -131,37 +135,39 @@ export class SqbCollectionService extends SqbEntityService {
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
      */
     async existsOne(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'existsOne',
             byId: false,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._existsOne({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._existsOne(command);
+        });
     }
     /**
      * Finds a record by ID.
      *
-     * @param {SQBAdapter.Id} id - The ID of the record.
+     * @param {SQBAdapter.IdOrIds} id - The ID of the record.
      * @param {SqbCollectionService.FindOneOptions} [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._getCommonFilter(info);
-            const filter = SQBAdapter.parseFilter([documentFilter, options?.filter]);
-            return this._findById(id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const documentFilter = await this._getCommonFilter(command);
+            const filter = SQBAdapter.parseFilter([documentFilter, command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findById(command);
+        });
     }
     /**
      * Finds a record in the collection that matches the specified options.
@@ -170,16 +176,17 @@ export class SqbCollectionService extends SqbEntityService {
      * @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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._findOne({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findOne(command);
+        });
     }
     /**
      * Finds multiple records in collection.
@@ -188,16 +195,17 @@ export class SqbCollectionService extends SqbEntityService {
      * @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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._findMany({ ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findMany(command);
+        });
     }
     /**
      * Finds multiple records in the collection and returns both records (max limit)
@@ -213,7 +221,7 @@ export class SqbCollectionService extends SqbEntityService {
     /**
      * Retrieves a records from the collection by its ID. Throws error if not found.
      *
-     * @param {SQBAdapter.Id} id - The ID of the document to retrieve.
+     * @param {SQBAdapter.IdOrIds} id - The ID of the document to retrieve.
      * @param {SqbCollectionService.FindOneOptions} [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.
@@ -235,7 +243,7 @@ export class SqbCollectionService extends SqbEntityService {
      * undefined if the document was not found.
      */
     async update(id, input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: id,
@@ -243,10 +251,11 @@ export class SqbCollectionService extends SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._update(id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._update(command);
+        });
     }
     /**
      * Updates a record in the collection with the specified ID and returns updated record count
@@ -257,7 +266,7 @@ export class SqbCollectionService extends SqbEntityService {
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
     async updateOnly(id, input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: id,
@@ -265,10 +274,11 @@ export class SqbCollectionService extends SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._updateOnly(id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateOnly(command);
+        });
     }
     /**
      * Updates multiple records in the collection based on the specified input and options.
@@ -278,16 +288,17 @@ export class SqbCollectionService extends SqbEntityService {
      * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
      */
     async updateMany(input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'updateMany',
             byId: false,
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._updateMany(input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateMany(command);
+        });
     }
 }

package/esm/sqb-entity-service.js

@@ -1,6 +1,7 @@
 import { InternalServerError } from '@opra/common';
 import { ServiceBase } from '@opra/core';
 import { EntityMetadata } from '@sqb/connect';
+import { isNotNullish } from 'valgen';
 import { SQBAdapter } from './sqb-adapter.js';
 /**
  * @class SqbEntityService
@@ -16,12 +17,13 @@ export class SqbEntityService extends ServiceBase {
      */
     constructor(dataType, options) {
         super();
-        this._encoders = {};
+        this._inputCodecs = {};
+        this._outputCodecs = {};
         this._dataType_ = dataType;
         this.db = options?.db;
-        this.$resourceName = options?.resourceName;
-        this.$commonFilter = this.$commonFilter || options?.commonFilter;
-        this.$interceptor = this.$interceptor || options?.interceptor;
+        this.resourceName = options?.resourceName;
+        this.commonFilter = options?.commonFilter;
+        this.interceptor = options?.interceptor;
     }
     /**
      * Retrieves the OPRA data type
@@ -65,145 +67,145 @@ export class SqbEntityService extends ServiceBase {
      * @throws {Error} If the collection name is not defined.
      */
     getResourceName() {
-        const out = typeof this.$resourceName === 'function' ? this.$resourceName(this) : this.$resourceName || this.dataType.name;
+        const out = typeof this.resourceName === 'function' ? this.resourceName(this) : this.resourceName || this.dataType.name;
         if (out)
             return out;
         throw new Error('resourceName is not defined');
     }
     /**
-     * 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 = 'deep';
         const dataType = this.dataType;
-        encoder = dataType.generateCodec('encode', options);
-        this._encoders[operation] = encoder;
-        return encoder;
+        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;
+    getOutputCodec(operation) {
+        let validator = this._outputCodecs[operation];
+        if (validator)
+            return validator;
         const options = { projection: '*', partial: 'deep' };
         const dataType = this.dataType;
-        decoder = dataType.generateCodec('decode', options);
-        this._decoder = decoder;
-        return decoder;
+        validator = dataType.generateCodec('decode', options);
+        this._outputCodecs[operation] = validator;
+        return validator;
     }
     /**
      * Insert a new record into database
      *
-     * @param {PartialDTO<T>} input - The input data
-     * @param {SqbEntityService.CreateOptions} [options] - The options object
-     * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created resource
-     * @throws {InternalServerError} if an unknown error occurs while creating the resource
+     * @param command
+     * @returns - A promise that resolves to the created resource
      * @protected
      */
-    async _create(input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
+    async _create(command) {
+        const { input, options } = command;
+        isNotNullish(command.input, { label: 'input' });
+        const inputCodec = this.getInputCodec('create');
+        const outputCodec = this.getOutputCodec('create');
+        const data = inputCodec(input);
         const out = await this._dbCreate(data, options);
         if (out)
-            return out;
+            return outputCodec(out);
         throw new InternalServerError(`Unknown error while creating document for "${this.getResourceName()}"`);
     }
     /**
      * Returns the count of records based on the provided options
      *
-     * @param {SqbEntityService.CountOptions} options - The options for the count operation.
-     * @return {Promise<number>} - A promise that resolves to the count of records
+     * @param command
+     * @return - A promise that resolves to the count of records
      * @protected
      */
-    async _count(options) {
-        return this._dbCount(options);
+    async _count(command) {
+        return this._dbCount(command.options);
     }
     /**
      * Deletes a record from the collection.
      *
-     * @param {SQBAdapter.IdOrIds} id - The ID of the document to delete.
-     * @param {SqbEntityService.DeleteOptions} [options] - Optional delete options.
-     * @return {Promise<number>} - A Promise that resolves to the number of documents deleted.
+     * @param command
+     * @return - A Promise that resolves to the number of documents deleted.
      * @protected
      */
-    async _delete(id, options) {
-        return this._dbDelete(id, options);
+    async _delete(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        return this._dbDelete(command.documentId, command.options);
     }
     /**
      * Deletes multiple documents from the collection that meet the specified filter criteria.
      *
-     * @param {SqbEntityService.DeleteManyOptions} options - The options for the delete operation.
-     * @return {Promise<number>} - A promise that resolves to the number of documents deleted.
+     * @param command
+     * @return - A promise that resolves to the number of documents deleted.
      * @protected
      */
-    async _deleteMany(options) {
-        return await this._dbDeleteMany(options);
+    async _deleteMany(command) {
+        return await this._dbDeleteMany(command.options);
     }
     /**
      * Checks if a record with the given id exists.
      *
-     * @param {SQBAdapter.IdOrIds} id - The id of the object to check.
-     * @param {SqbEntityService.ExistsOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     * @param command
      * @protected
      */
-    async _exists(id, options) {
-        return await this._dbExists(id, options);
+    async _exists(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        return await this._dbExists(command.documentId, command.options);
     }
     /**
      * Checks if a record with the given arguments exists.
      *
-     * @param {SqbEntityService.ExistsOneOptions} [options] - The options for the query (optional).
-     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     * @param command
+     * @return - A Promise that resolves to a boolean indicating whether the record exists or not.
      * @protected
      */
-    async _existsOne(options) {
-        return await this._dbExistsOne(options);
+    async _existsOne(command) {
+        return await this._dbExistsOne(command.options);
     }
     /**
      * Finds a record by ID.
      *
-     * @param {SQBAdapter.Id} id - The ID of the record.
-     * @param {SqbEntityService.FindOneOptions} [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 command
+     * @return - A promise resolving to the found document, or undefined if not found.
      * @protected
      */
-    async _findById(id, options) {
-        const decode = this.getDecoder();
-        const out = await this._dbFindById(id, options);
+    async _findById(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        const decode = this.getOutputCodec('find');
+        const out = await this._dbFindById(command.documentId, command.options);
         return out ? decode(out) : undefined;
     }
     /**
      * Finds a record in the collection that matches the specified options.
      *
-     * @param {SqbEntityService.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 command
+     * @return - A promise that resolves with the found document or undefined if no document is found.
      * @protected
      */
-    async _findOne(options) {
-        const decode = this.getDecoder();
-        const out = await this._dbFindOne(options);
+    async _findOne(command) {
+        const decode = this.getOutputCodec('find');
+        const out = await this._dbFindOne(command.options);
         return out ? decode(out) : undefined;
     }
     /**
      * Finds multiple records in collection.
      *
-     * @param {SqbEntityService.FindManyOptions} [options] - The options for the find operation.
-     * @return A Promise that resolves to an array of partial outputs of type T.
+     * @param command
+     * @return - A Promise that resolves to an array of partial outputs of type T.
      * @protected
      */
-    async _findMany(options) {
-        const decode = this.getDecoder();
-        const out = await this._dbFindMany(options);
+    async _findMany(command) {
+        const decode = this.getOutputCodec('find');
+        const out = await this._dbFindMany(command.options);
         if (out?.length) {
             return out.map(x => decode(x));
         }
@@ -212,47 +214,48 @@ export class SqbEntityService extends ServiceBase {
     /**
      * Updates a record with the given id in the collection.
      *
-     * @param {SQBAdapter.IdOrIds} id - The id of the document to update.
-     * @param {PatchDTO<T>} input - The partial input object containing the fields to update.
-     * @param {SqbEntityService.UpdateOptions} [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 command
+     * @returns  A promise that resolves to the updated document or undefined if the document was not found.
      * @protected
      */
-    async _update(id, input, options) {
-        const encode = this.getEncoder('update');
-        const decode = this.getDecoder();
-        const data = encode(input);
-        const out = await this._dbUpdate(id, data, options);
+    async _update(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        isNotNullish(command.input, { label: 'input' });
+        const { documentId, input, options } = command;
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
+        const out = await this._dbUpdate(documentId, data, options);
+        const outputCodec = this.getOutputCodec('update');
         if (out)
-            return decode(out);
+            return outputCodec(out);
     }
     /**
      * Updates a record in the collection with the specified ID and returns updated record count
      *
-     * @param {any} id - The ID of the document to update.
-     * @param {PatchDTO<T>} input - The partial input data to update the document with.
-     * @param {SqbEntityService.UpdateOptions} options - The options for updating the document.
-     * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
+     * @param command
+     * @returns - A promise that resolves to the number of documents modified.
      * @protected
      */
-    async _updateOnly(id, input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
-        return await this._dbUpdateOnly(id, data, options);
+    async _updateOnly(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
+        isNotNullish(command.input, { label: 'input' });
+        const { documentId, input, options } = command;
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
+        return await this._dbUpdateOnly(documentId, data, options);
     }
     /**
      * Updates multiple records in the collection based on the specified input and options.
      *
-     * @param {PatchDTO<T>} input - The partial input to update the documents with.
-     * @param {SqbEntityService.UpdateManyOptions} options - The options for updating the documents.
-     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
+     * @param command
+     * @return - A promise that resolves to the number of documents matched and modified.
      * @protected
      */
-    async _updateMany(input, options) {
-        const encode = this.getEncoder('update');
-        const data = encode(input);
-        return await this._dbUpdateMany(data, options);
+    async _updateMany(command) {
+        isNotNullish(command.input, { label: 'input' });
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(command.input);
+        return await this._dbUpdateMany(data, command.options);
     }
     /**
      * Acquires a connection and performs Repository.create operation
@@ -439,17 +442,28 @@ export class SqbEntityService extends ServiceBase {
      * that resolves to the common filter, or undefined if not available.
      */
     _getCommonFilter(args) {
-        return typeof this.$commonFilter === 'function' ? this.$commonFilter(args, this) : this.$commonFilter;
-    }
-    async _intercept(callback, args) {
+        return typeof this.commonFilter === 'function' ? this.commonFilter(args, this) : this.commonFilter;
+    }
+    async _executeCommand(command, commandFn) {
+        let proto;
+        const next = async () => {
+            proto = proto ? Object.getPrototypeOf(proto) : this;
+            while (proto) {
+                if (proto.interceptor && Object.prototype.hasOwnProperty.call(proto, 'interceptor')) {
+                    return await proto.interceptor.call(this, next, command, this);
+                }
+                proto = Object.getPrototypeOf(proto);
+                if (!(proto instanceof SqbEntityService))
+                    break;
+            }
+            return commandFn();
+        };
         try {
-            if (this.$interceptor)
-                return this.$interceptor(callback, args, 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;
         }
     }