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

package/cjs/sqb-entity-service.js

@@ -4,6 +4,7 @@ exports.SqbEntityService = void 0;
 const common_1 = require("@opra/common");
 const core_1 = require("@opra/core");
 const connect_1 = require("@sqb/connect");
+const valgen_1 = require("valgen");
 const sqb_adapter_js_1 = require("./sqb-adapter.js");
 /**
  * @class SqbEntityService
@@ -19,12 +20,13 @@ class SqbEntityService extends core_1.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
@@ -68,145 +70,145 @@ class SqbEntityService extends core_1.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;
+        (0, valgen_1.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 common_1.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) {
+        (0, valgen_1.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) {
+        (0, valgen_1.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) {
+        (0, valgen_1.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));
         }
@@ -215,47 +217,48 @@ class SqbEntityService extends core_1.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) {
+        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
+        (0, valgen_1.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) {
+        (0, valgen_1.isNotNullish)(command.documentId, { label: 'documentId' });
+        (0, valgen_1.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) {
+        (0, valgen_1.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
@@ -442,17 +445,28 @@ class SqbEntityService extends core_1.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;
         }
     }

package/cjs/sqb-singleton-service.js

@@ -40,27 +40,29 @@ class SqbSingletonService extends sqb_entity_service_js_1.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(async () => {
+        return this._executeCommand(command, async () => {
             const primaryFields = connect_1.EntityMetadata.getPrimaryIndexColumns(this.entityMetadata);
-            const data = { ...input };
+            const data = { ...command.input };
             if (primaryFields.length > 1) {
-                if (typeof primaryFields !== 'object')
+                if (typeof primaryFields !== 'object') {
                     throw new TypeError(`"${this.entityMetadata.name}" should has multiple primary key fields. So you should provide and object that contains key fields`);
+                }
                 for (const field of primaryFields) {
                     data[field.name] = this.id[field.name];
                 }
             }
             else
                 data[primaryFields[0].name] = this.id;
-            return await this._create(data, options);
-        }, info);
+            command.input = data;
+            return await this._create(command);
+        });
     }
     /**
      * Deletes the singleton record
@@ -69,17 +71,18 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
      * @return {Promise<number>} - A Promise that resolves to 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 = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._delete(this.id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._delete(command);
+        });
     }
     /**
      * Checks if the singleton record exists.
@@ -88,17 +91,18 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
      * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
      */
     async exists(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'exists',
             byId: true,
             documentId: this.id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._exists(this.id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._exists(command);
+        });
     }
     /**
      * Finds the singleton record. Returns `undefined` if not found
@@ -107,17 +111,18 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
      * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
      */
     async find(options) {
-        const info = {
+        const command = {
             crud: 'read',
             method: 'findById',
             byId: true,
             documentId: this.id,
             options,
         };
-        return this._intercept(async () => {
-            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._findById(this.id, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._findById(command);
+        });
     }
     /**
      * Retrieves the singleton record. Throws error if not found.
@@ -142,7 +147,7 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
      * undefined if the document was not found.
      */
     async update(input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: this.id,
@@ -150,10 +155,11 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._update(this.id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._update(command);
+        });
     }
     /**
      * Updates the singleton and  returns updated record count
@@ -163,7 +169,7 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
     async updateOnly(input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: this.id,
@@ -171,10 +177,11 @@ class SqbSingletonService extends sqb_entity_service_js_1.SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._updateOnly(this.id, input, { ...options, filter });
-        }, info);
+        return this._executeCommand(command, async () => {
+            const filter = sqb_adapter_js_1.SQBAdapter.parseFilter([await this._getCommonFilter(command), command.options?.filter]);
+            command.options = { ...command.options, filter };
+            return this._updateOnly(command);
+        });
     }
 }
 exports.SqbSingletonService = SqbSingletonService;

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

@@ -75,13 +75,13 @@ function prepareFilterAst(ast) {
             case '!in':
                 return sqb.Nin(left, right);
             case 'like':
-                return sqb.Like(left, String(right).replace(/\*/, '%'));
+                return sqb.Like(left, String(right).replace(/\*/g, '%'));
             case 'ilike':
-                return sqb.Ilike(left, String(right).replace(/\*/, '%'));
+                return sqb.Ilike(left, String(right).replace(/\*/g, '%'));
             case '!like':
-                return sqb.NotLike(left, String(right).replace(/\*/, '%'));
+                return sqb.NotLike(left, String(right).replace(/\*/g, '%'));
             case '!ilike':
-                return sqb.NotILike(left, String(right).replace(/\*/, '%'));
+                return sqb.NotILike(left, String(right).replace(/\*/g, '%'));
             default:
                 throw new Error(`ComparisonExpression operator (${ast.op}) not implemented yet`);
         }

package/esm/augmentation/datatype-factory.augmentation.js

@@ -57,16 +57,20 @@ DataTypeFactory._prepareComplexTypeArgs = async function (context, owner, initAr
                         if (hasNoType || fieldSchema.type === String)
                             fieldSchema.type = 'time';
                         break;
+                    default:
+                        break;
                 }
             }
             if (isAssociationField(sqbField)) {
                 if (sqbField.association.returnsMany())
                     fieldSchema.isArray = true;
-                if (!fieldSchema.hasOwnProperty('exclusive'))
+                if (!Object.prototype.hasOwnProperty.call(fieldSchema, 'exclusive'))
                     fieldSchema.exclusive = true;
             }
-            if (!fieldSchema.hasOwnProperty('exclusive') && sqbField.hasOwnProperty('exclusive'))
+            if (!Object.prototype.hasOwnProperty.call(fieldSchema, 'exclusive') &&
+                Object.prototype.hasOwnProperty.call(sqbField, 'exclusive')) {
                 fieldSchema.exclusive = sqbField.exclusive;
+            }
         }
     }
     return _prepareComplexTypeArgs.apply(DataTypeFactory, [context, owner, initArgs, metadata]);

package/esm/sqb-adapter.js

@@ -10,7 +10,7 @@ export var SQBAdapter;
             const entityMetadata = EntityMetadata.get(dataType.ctor);
             if (!entityMetadata)
                 throw new Error(`Type class "${dataType.ctor}" is not an SQB entity`);
-            const { compositionOptions } = operation;
+            const controller = operation.owner;
             switch (operation.composition) {
                 case 'Entity.Create': {
                     const data = await context.getBody();
@@ -20,7 +20,8 @@ export var SQBAdapter;
                     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: SQBAdapter.parseFilter(context.queryParams.filter),
                     };
@@ -44,7 +45,8 @@ export var SQBAdapter;
                     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: SQBAdapter.parseFilter(context.queryParams.filter),
@@ -53,7 +55,8 @@ export var SQBAdapter;
                 }
                 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: SQBAdapter.parseFilter(context.queryParams.filter),
@@ -67,6 +70,8 @@ export var SQBAdapter;
                     };
                     return { method: 'updateMany', data, options };
                 }
+                default:
+                    break;
             }
         }
         throw new Error(`This operation is not compatible to SQB Adapter`);