@opra/sqb 1.0.5 → 1.0.7

package/cjs/index.js

@@ -7,4 +7,5 @@ require("./augmentation/mixin-type.augmentation.js");
 tslib_1.__exportStar(require("./sqb-adapter.js"), exports);
 tslib_1.__exportStar(require("./sqb-collection-service.js"), exports);
 tslib_1.__exportStar(require("./sqb-entity-service.js"), exports);
+tslib_1.__exportStar(require("./sqb-service-base.js"), exports);
 tslib_1.__exportStar(require("./sqb-singleton-service.js"), exports);

package/cjs/sqb-entity-service.js

@@ -2,17 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqbEntityService = void 0;
 const common_1 = require("@opra/common");
-const core_1 = require("@opra/core");
 const builder_1 = require("@sqb/builder");
 const connect_1 = require("@sqb/connect");
 const valgen_1 = require("valgen");
 const sqb_adapter_js_1 = require("./sqb-adapter.js");
+const sqb_service_base_js_1 = require("./sqb-service-base.js");
 const transactionKey = Symbol.for('transaction');
 /**
  * @class SqbEntityService
  * @template T - The data type class type of the resource
  */
-class SqbEntityService extends core_1.ServiceBase {
+class SqbEntityService extends sqb_service_base_js_1.SqbServiceBase {
     /**
      * Constructs a new instance
      *
@@ -21,11 +21,10 @@ class SqbEntityService extends core_1.ServiceBase {
      * @constructor
      */
     constructor(dataType, options) {
-        super();
+        super(options);
         this._inputCodecs = {};
         this._outputCodecs = {};
         this._dataType_ = dataType;
-        this.db = options?.db;
         this.resourceName = options?.resourceName;
         this.commonFilter = options?.commonFilter;
         this.interceptor = options?.interceptor;

package/cjs/sqb-service-base.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqbServiceBase = void 0;
+const core_1 = require("@opra/core");
+const connect_1 = require("@sqb/connect");
+const transactionKey = Symbol.for('transaction');
+/**
+ * @class SqbServiceBase
+ * @template T - The data type class type of the resource
+ */
+class SqbServiceBase extends core_1.ServiceBase {
+    /**
+     * Constructs a new instance
+     *
+     * @param [options] - The options for the service.
+     * @constructor
+     */
+    constructor(options) {
+        super();
+        this.db = options?.db;
+    }
+    /**
+     * Executes the provided function within a transaction.
+     *
+     * @param callback - The function to be executed within the transaction.
+     */
+    async withTransaction(callback) {
+        const ctx = this.context;
+        let closeSessionOnFinish = false;
+        let connection = ctx[transactionKey];
+        if (!connection) {
+            /** Determine the SqbClient or SqbConnection instance */
+            const db = await this.getConnection();
+            if (db instanceof connect_1.SqbConnection) {
+                connection = db;
+            }
+            else {
+                /** Acquire a connection. New connection should be at the end */
+                connection = await db.acquire({ autoCommit: false });
+                closeSessionOnFinish = true;
+            }
+            /** Store transaction connection in current context */
+            ctx[transactionKey] = connection;
+        }
+        const oldInTransaction = connection.inTransaction;
+        connection.retain();
+        try {
+            if (!oldInTransaction)
+                await connection.startTransaction();
+            const out = await callback(connection, this);
+            if (!oldInTransaction && connection.inTransaction)
+                await connection.commit();
+            return out;
+        }
+        catch (e) {
+            if (!oldInTransaction && connection.inTransaction)
+                await connection.rollback();
+            throw e;
+        }
+        finally {
+            delete ctx[transactionKey];
+            /** Release connection */
+            if (closeSessionOnFinish) {
+                await connection.close();
+            }
+            else
+                connection.release();
+        }
+    }
+    /**
+     * Retrieves the database connection.
+     *
+     * @protected
+     *
+     * @throws {Error} If the context or database is not set.
+     */
+    getConnection() {
+        const ctx = this.context;
+        let db = ctx[transactionKey];
+        if (db)
+            return db;
+        db = typeof this.db === 'function' ? this.db(this) : this.db;
+        if (db)
+            return db;
+        throw new Error(`Database not set!`);
+    }
+}
+exports.SqbServiceBase = SqbServiceBase;

package/esm/index.js

@@ -4,4 +4,5 @@ import './augmentation/mixin-type.augmentation.js';
 export * from './sqb-adapter.js';
 export * from './sqb-collection-service.js';
 export * from './sqb-entity-service.js';
+export * from './sqb-service-base.js';
 export * from './sqb-singleton-service.js';

package/esm/sqb-entity-service.js

@@ -1,15 +1,15 @@
 import { InternalServerError } from '@opra/common';
-import { ServiceBase } from '@opra/core';
 import { op } from '@sqb/builder';
 import { EntityMetadata, SqbConnection } from '@sqb/connect';
 import { isNotNullish } from 'valgen';
 import { SQBAdapter } from './sqb-adapter.js';
+import { SqbServiceBase } from './sqb-service-base.js';
 const transactionKey = Symbol.for('transaction');
 /**
  * @class SqbEntityService
  * @template T - The data type class type of the resource
  */
-export class SqbEntityService extends ServiceBase {
+export class SqbEntityService extends SqbServiceBase {
     /**
      * Constructs a new instance
      *
@@ -18,11 +18,10 @@ export class SqbEntityService extends ServiceBase {
      * @constructor
      */
     constructor(dataType, options) {
-        super();
+        super(options);
         this._inputCodecs = {};
         this._outputCodecs = {};
         this._dataType_ = dataType;
-        this.db = options?.db;
         this.resourceName = options?.resourceName;
         this.commonFilter = options?.commonFilter;
         this.interceptor = options?.interceptor;

package/esm/sqb-service-base.js

@@ -0,0 +1,84 @@
+import { ServiceBase } from '@opra/core';
+import { SqbConnection } from '@sqb/connect';
+const transactionKey = Symbol.for('transaction');
+/**
+ * @class SqbServiceBase
+ * @template T - The data type class type of the resource
+ */
+export class SqbServiceBase extends ServiceBase {
+    /**
+     * Constructs a new instance
+     *
+     * @param [options] - The options for the service.
+     * @constructor
+     */
+    constructor(options) {
+        super();
+        this.db = options?.db;
+    }
+    /**
+     * Executes the provided function within a transaction.
+     *
+     * @param callback - The function to be executed within the transaction.
+     */
+    async withTransaction(callback) {
+        const ctx = this.context;
+        let closeSessionOnFinish = false;
+        let connection = ctx[transactionKey];
+        if (!connection) {
+            /** Determine the SqbClient or SqbConnection instance */
+            const db = await this.getConnection();
+            if (db instanceof SqbConnection) {
+                connection = db;
+            }
+            else {
+                /** Acquire a connection. New connection should be at the end */
+                connection = await db.acquire({ autoCommit: false });
+                closeSessionOnFinish = true;
+            }
+            /** Store transaction connection in current context */
+            ctx[transactionKey] = connection;
+        }
+        const oldInTransaction = connection.inTransaction;
+        connection.retain();
+        try {
+            if (!oldInTransaction)
+                await connection.startTransaction();
+            const out = await callback(connection, this);
+            if (!oldInTransaction && connection.inTransaction)
+                await connection.commit();
+            return out;
+        }
+        catch (e) {
+            if (!oldInTransaction && connection.inTransaction)
+                await connection.rollback();
+            throw e;
+        }
+        finally {
+            delete ctx[transactionKey];
+            /** Release connection */
+            if (closeSessionOnFinish) {
+                await connection.close();
+            }
+            else
+                connection.release();
+        }
+    }
+    /**
+     * Retrieves the database connection.
+     *
+     * @protected
+     *
+     * @throws {Error} If the context or database is not set.
+     */
+    getConnection() {
+        const ctx = this.context;
+        let db = ctx[transactionKey];
+        if (db)
+            return db;
+        db = typeof this.db === 'function' ? this.db(this) : this.db;
+        if (db)
+            return db;
+        throw new Error(`Database not set!`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/sqb",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Opra SQB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -10,8 +10,8 @@
     "valgen": "^5.10.0"
   },
   "peerDependencies": {
-    "@opra/core": "^1.0.5",
-    "@opra/http": "^1.0.5",
+    "@opra/core": "^1.0.7",
+    "@opra/http": "^1.0.7",
     "@sqb/connect": ">= 4.19.1"
   },
   "type": "module",

package/types/index.d.cts

@@ -4,4 +4,5 @@ import './augmentation/mixin-type.augmentation.js';
 export * from './sqb-adapter.js';
 export * from './sqb-collection-service.js';
 export * from './sqb-entity-service.js';
+export * from './sqb-service-base.js';
 export * from './sqb-singleton-service.js';

package/types/index.d.ts

@@ -4,4 +4,5 @@ import './augmentation/mixin-type.augmentation.js';
 export * from './sqb-adapter.js';
 export * from './sqb-collection-service.js';
 export * from './sqb-entity-service.js';
+export * from './sqb-service-base.js';
 export * from './sqb-singleton-service.js';

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

@@ -4,12 +4,12 @@ import { EntityMetadata, Repository, SqbClient, SqbConnection } from '@sqb/conne
 import type { Nullish, PartialDTO, PatchDTO, RequiredSome, StrictOmit, Type } from 'ts-gems';
 import { type IsObject } from 'valgen';
 import { SQBAdapter } from './sqb-adapter.js';
+import { SqbServiceBase } from './sqb-service-base.js';
 /**
  * @namespace SqbEntityService
  */
 export declare namespace SqbEntityService {
-    interface Options {
-        db?: SqbEntityService<any>['db'];
+    interface Options extends SqbServiceBase.Options {
         resourceName?: SqbEntityService<any>['resourceName'];
         onError?: SqbEntityService<any>['onError'];
         commonFilter?: SqbEntityService<any>['commonFilter'];
@@ -153,17 +153,13 @@ export interface SqbEntityService {
  * @class SqbEntityService
  * @template T - The data type class type of the resource
  */
-export declare class SqbEntityService<T extends object = object> extends ServiceBase {
+export declare class SqbEntityService<T extends object = object> extends SqbServiceBase {
     protected _dataType_: Type | string;
     protected _dataType?: ComplexType;
     protected _dataTypeClass?: Type;
     protected _entityMetadata?: EntityMetadata;
     protected _inputCodecs: Record<string, IsObject.Validator<T>>;
     protected _outputCodecs: Record<string, IsObject.Validator<T>>;
-    /**
-     * Represents a SqbClient or SqbConnection object
-     */
-    db?: (SqbClient | SqbConnection) | ((_this: this) => SqbClient | SqbConnection);
     /**
      * Represents the name of a resource.
      * @type {string}

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

@@ -0,0 +1,41 @@
+import { ServiceBase } from '@opra/core';
+import { SqbClient, SqbConnection } from '@sqb/connect';
+/**
+ * @namespace SqbServiceBase
+ */
+export declare namespace SqbServiceBase {
+    interface Options {
+        db?: SqbServiceBase['db'];
+    }
+}
+/**
+ * @class SqbServiceBase
+ * @template T - The data type class type of the resource
+ */
+export declare class SqbServiceBase extends ServiceBase {
+    /**
+     * Represents a SqbClient or SqbConnection object
+     */
+    db?: (SqbClient | SqbConnection) | ((_this: this) => SqbClient | SqbConnection);
+    /**
+     * Constructs a new instance
+     *
+     * @param [options] - The options for the service.
+     * @constructor
+     */
+    constructor(options?: SqbServiceBase.Options);
+    /**
+     * Executes the provided function within a transaction.
+     *
+     * @param callback - The function to be executed within the transaction.
+     */
+    withTransaction(callback: (connection: SqbConnection, _this: this) => any): Promise<any>;
+    /**
+     * Retrieves the database connection.
+     *
+     * @protected
+     *
+     * @throws {Error} If the context or database is not set.
+     */
+    getConnection(): SqbConnection | SqbClient | Promise<SqbConnection | SqbClient>;
+}