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

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
@@ -20,9 +21,9 @@ export class SqbEntityService extends ServiceBase {
         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
@@ -66,7 +67,7 @@ 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');
@@ -104,13 +105,13 @@ export class SqbEntityService extends ServiceBase {
     /**
      * 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) {
+    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);
@@ -122,90 +123,89 @@ export class SqbEntityService extends ServiceBase {
     /**
      * 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) {
+    async _findById(command) {
+        isNotNullish(command.documentId, { label: 'documentId' });
         const decode = this.getOutputCodec('find');
-        const out = await this._dbFindById(id, options);
+        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) {
+    async _findOne(command) {
         const decode = this.getOutputCodec('find');
-        const out = await this._dbFindOne(options);
+        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) {
+    async _findMany(command) {
         const decode = this.getOutputCodec('find');
-        const out = await this._dbFindMany(options);
+        const out = await this._dbFindMany(command.options);
         if (out?.length) {
             return out.map(x => decode(x));
         }
@@ -214,17 +214,17 @@ 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) {
+    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(id, data, options);
+        const out = await this._dbUpdate(documentId, data, options);
         const outputCodec = this.getOutputCodec('update');
         if (out)
             return outputCodec(out);
@@ -232,29 +232,30 @@ export class SqbEntityService extends ServiceBase {
     /**
      * 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) {
+    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(id, data, options);
+        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) {
+    async _updateMany(command) {
+        isNotNullish(command.input, { label: 'input' });
         const inputCodec = this.getInputCodec('update');
-        const data = inputCodec(input);
-        return await this._dbUpdateMany(data, options);
+        const data = inputCodec(command.input);
+        return await this._dbUpdateMany(data, command.options);
     }
     /**
      * Acquires a connection and performs Repository.create operation
@@ -441,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) {
+                    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/esm/sqb-singleton-service.js

@@ -37,16 +37,16 @@ export class SqbSingletonService 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(async () => {
+        return this._executeCommand(command, async () => {
             const primaryFields = EntityMetadata.getPrimaryIndexColumns(this.entityMetadata);
-            const data = { ...input };
+            const data = { ...command.input };
             if (primaryFields.length > 1) {
                 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`);
@@ -57,8 +57,9 @@ export class SqbSingletonService extends SqbEntityService {
             }
             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
@@ -67,17 +68,18 @@ export class SqbSingletonService extends 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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._delete(this.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);
+        });
     }
     /**
      * Checks if the singleton record exists.
@@ -86,17 +88,18 @@ export class SqbSingletonService extends 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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._exists(this.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);
+        });
     }
     /**
      * Finds the singleton record. Returns `undefined` if not found
@@ -105,17 +108,18 @@ export class SqbSingletonService extends 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 = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._findById(this.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._findById(command);
+        });
     }
     /**
      * Retrieves the singleton record. Throws error if not found.
@@ -140,7 +144,7 @@ export class SqbSingletonService extends SqbEntityService {
      * undefined if the document was not found.
      */
     async update(input, options) {
-        const info = {
+        const command = {
             crud: 'update',
             method: 'update',
             documentId: this.id,
@@ -148,10 +152,11 @@ export class SqbSingletonService extends SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._update(this.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 the singleton and  returns updated record count
@@ -161,7 +166,7 @@ export class SqbSingletonService extends 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,
@@ -169,9 +174,10 @@ export class SqbSingletonService extends SqbEntityService {
             input,
             options,
         };
-        return this._intercept(async () => {
-            const filter = SQBAdapter.parseFilter([await this._getCommonFilter(info), options?.filter]);
-            return this._updateOnly(this.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);
+        });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/sqb",
-  "version": "1.0.0-alpha.16",
+  "version": "1.0.0-alpha.18",
   "description": "Opra SQB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -35,11 +35,11 @@
     "@sqb/builder": "^4.12.1",
     "@sqb/connect": "^4.12.1",
     "@sqb/postgres": "^4.12.1",
-    "postgresql-client": "^2.11.2",
+    "postgresql-client": "^2.12.0",
     "ts-gems": "^3.4.0"
   },
   "peerDependencies": {
-    "@opra/core": "^1.0.0-alpha.16",
+    "@opra/core": "^1.0.0-alpha.18",
     "@sqb/connect": ">= 4.10.6"
   },
   "type": "module",

package/types/sqb-collection-service.d.ts

@@ -7,7 +7,7 @@ import { SqbEntityService } from './sqb-entity-service.js';
 export declare namespace SqbCollectionService {
     interface Options extends SqbEntityService.Options {
         defaultLimit?: SqbCollectionService<any>['defaultLimit'];
-        interceptor?: SqbCollectionService<any>['$interceptor'];
+        interceptor?: SqbCollectionService<any>['interceptor'];
     }
     /**
      * Represents options for "create" operation
@@ -70,14 +70,14 @@ export declare namespace SqbCollectionService {
      *
      * @interface
      */
-    interface UpdateOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOptions extends SqbEntityService.UpdateOneOptions {
     }
     /**
      * Represents options for "updateOnly" operation
      *
      * @interface
      */
-    interface UpdateOnlyOptions extends SqbEntityService.UpdateOptions {
+    interface UpdateOnlyOptions extends SqbEntityService.UpdateOneOptions {
     }
     /**
      * Represents options for "updateMany" operation
@@ -163,11 +163,11 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
     /**
      * 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.
      */
-    findById(id: SQBAdapter.Id, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
+    findById(id: SQBAdapter.IdOrIds, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T> | undefined>;
     /**
      * Finds a record in the collection that matches the specified options.
      *
@@ -196,13 +196,13 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
     /**
      * 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.
      * @throws {ResourceNotAvailableError} - If the document with the specified ID does not exist.
      */
-    get(id: SQBAdapter.Id, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T>>;
+    get(id: SQBAdapter.IdOrIds, options?: SqbCollectionService.FindOneOptions): Promise<PartialDTO<T>>;
     /**
      * Updates a record with the given id in the collection.
      *
@@ -221,7 +221,7 @@ export declare abstract class SqbCollectionService<T extends object = object> ex
      * @param {SqbCollectionService.UpdateOptions} options - The options for updating the document.
      * @returns {Promise<number>} - A promise that resolves to the number of documents modified.
      */
-    updateOnly(id: SQBAdapter.Id, input: PatchDTO<T>, options?: SqbCollectionService.UpdateOnlyOptions): Promise<number>;
+    updateOnly(id: SQBAdapter.IdOrIds, input: PatchDTO<T>, options?: SqbCollectionService.UpdateOnlyOptions): Promise<number>;
     /**
      * Updates multiple records in the collection based on the specified input and options.
      *