@sqb/nestjs 4.20.7 → 4.21.1

package/README.md

@@ -41,6 +41,38 @@ $ npm install @sqb/nestjs --save
 
 - node >= 16.x
 
+## Environment Variables
+
+The library supports configuration through environment variables. Environment variables below is accepted.
+All environment variables starts with prefix (SQB\_). This can be configured while registering the module.
+
+<!--- BEGIN env --->
+
+| Environment Variable         | Type    | Default | Description                                           |
+|------------------------------|---------|---------|-------------------------------------------------------|
+| SQB_DIALECT                  | String  |         | Database dialect (e.g. postgres, mysql, oracle)       |
+| SQB_CONNECTION_NAME          | String  |         | Logical name of the database connection               |
+| SQB_HOST                     | String  |         | Database server host address                          |
+| SQB_PORT                     | Number  |         | Database server port                                  |
+| SQB_DATABASE                 | String  |         | Database name                                         |
+| SQB_SCHEMA                   | String  |         | Default database schema                               |
+| SQB_USER                     | String  |         | Database user name                                    |
+| SQB_PASSWORD                 | String  |         | Database user password                                |
+| SQB_DRIVER                   | String  |         | Database driver identifier                            |
+| SQB_POOL_MAX                 | Number  |         | Maximum number of connections in the pool             |
+| SQB_POOL_MIN                 | Number  |         | Minimum number of connections in the pool             |
+| SQB_POOL_IDLE_TIMEOUT        | Number  |         | Time (ms) before an idle connection is released       |
+| SQB_POOL_ACQUIRE_TIMEOUT     | Number  |         | Timeout (ms) for acquiring a connection               |
+| SQB_POOL_ACQUIRE_MAX_RETRIES | Number  |         | Maximum number of retries when acquiring a connection |
+| SQB_POOL_ACQUIRE_RETRY_WAIT  | Number  |         | Wait time (ms) between acquire retry attempts         |
+| SQB_POOL_FIFO                | Boolean |         | Whether the pool queue operates in FIFO mode          |
+| SQB_POOL_MAX_QUEUE           | Number  |         | Maximum number of queued connection requests          |
+| SQB_POOL_MIN_IDLE            | Number  |         | Minimum number of idle connections to keep            |
+| SQB_POOL_VALIDATION          | Boolean |         | Enables validation of connections before use          |
+| SQB_POOL_HOUSE_KEEP_INTERVAL | Number  |         | Interval (ms) for pool housekeeping tasks             |
+
+<!--- END env --->
+
 ### License
 
 SQB is available under [MIT](LICENSE) license.
@@ -61,3 +93,4 @@ SQB is available under [MIT](LICENSE) license.
 [devdependencies-url]: https://david-dm.org/sqbjs/@sqb/nestjs?type=dev
 [quality-image]: http://npm.packagequality.com/shield/@sqb/nestjs.png
 [quality-url]: http://packagequality.com/#?package=@sqb/nestjs
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/nestjs",
   "description": "Nestjs module for data connection using SQB",
-  "version": "4.20.7",
+  "version": "4.21.1",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {
@@ -12,29 +12,24 @@
   "peerDependencies": {
     "@nestjs/common": ">=7.4.0",
     "@nestjs/core": ">=7.4.0",
-    "@sqb/builder": "^4.20.7",
-    "@sqb/connect": "^4.20.7",
+    "@sqb/builder": "^4.21.1",
+    "@sqb/connect": "^4.21.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": ">=6.6.0"
   },
   "type": "module",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./types/index.d.ts",
-        "default": "./esm/index.js"
-      },
-      "require": {
-        "types": "./types/index.d.cts",
-        "default": "./cjs/index.js"
-      },
-      "default": "./esm/index.js"
+      "types": "./index.d.ts",
+      "default": "./index.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.0"
+  },
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
     "Ilker Gurelli <i.gurelli@panates.com>"
@@ -44,17 +39,6 @@
     "url": "https://github.com/panates/sqb.git",
     "directory": "packages/nestjs"
   },
-  "engines": {
-    "node": ">=18.0"
-  },
-  "files": [
-    "bin/",
-    "cjs/",
-    "esm/",
-    "types/",
-    "LICENSE",
-    "README.md"
-  ],
   "keywords": [
     "sqb",
     "nestjs",

package/{types/sqb-core.module.d.ts → sqb-core.module.d.ts}

@@ -1,12 +1,14 @@
-import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
+import { DynamicModule, Logger, OnApplicationShutdown } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import type { SqbModuleAsyncOptions, SqbModuleOptions } from './sqb.interface.js';
 export declare class SqbCoreModule implements OnApplicationShutdown {
     private readonly options;
     private readonly moduleRef;
-    constructor(options: SqbModuleOptions, moduleRef: ModuleRef);
+    private logger?;
+    constructor(options: SqbModuleOptions, moduleRef: ModuleRef, logger?: Logger | undefined);
     static forRoot(options?: SqbModuleOptions): DynamicModule;
     static forRootAsync(options: SqbModuleAsyncOptions): DynamicModule;
+    onApplicationBootstrap(): Promise<void> | undefined;
     onApplicationShutdown(): Promise<void>;
     private static createAsyncProviders;
     private static createAsyncOptionsProvider;

package/{esm/sqb-core.module.js → sqb-core.module.js}

@@ -1,6 +1,6 @@
 var SqbCoreModule_1;
 import { __decorate, __metadata, __param } from "tslib";
-import { Global, Inject, Module, } from '@nestjs/common';
+import { Global, Inject, Logger, Module, } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import { SqbClient } from '@sqb/connect';
 import * as crypto from 'crypto';
@@ -12,9 +12,11 @@ import { getSQBToken, handleRetry } from './sqb.utils.js';
 let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
     options;
     moduleRef;
-    constructor(options, moduleRef) {
+    logger;
+    constructor(options, moduleRef, logger) {
         this.options = options;
         this.moduleRef = moduleRef;
+        this.logger = logger;
     }
     static forRoot(options = {}) {
         const optionsProvider = {
@@ -35,6 +37,12 @@ let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
                     provide: SQB_CONNECTION_OPTIONS,
                     useValue: getSqbConfig(options.useValue || {}, options.envPrefix),
                 },
+                {
+                    provide: Logger,
+                    useValue: typeof options.logger === 'string'
+                        ? new Logger(options.logger)
+                        : options.logger,
+                },
             ],
             exports: [connectionProvider],
         };
@@ -60,10 +68,28 @@ let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
                     provide: SQB_MODULE_ID,
                     useValue: crypto.randomUUID(),
                 },
+                {
+                    provide: Logger,
+                    useValue: typeof options.logger === 'string'
+                        ? new Logger(options.logger)
+                        : options.logger,
+                },
             ],
             exports: [connectionProvider],
         };
     }
+    onApplicationBootstrap() {
+        const client = this.moduleRef.get(getSQBToken(this.options.name));
+        const op = this.moduleRef.get(SQB_CONNECTION_OPTIONS);
+        if (this.options.lazyConnect)
+            return;
+        this.logger?.log(`Connecting to database [${op.database}] at ${op.host}:${op.port} using ${op.dialect} dialect`);
+        Logger.flush();
+        return client.test().catch(e => {
+            this.logger?.error(`${op.dialect} connection failed: ` + e.message);
+            throw e;
+        });
+    }
     async onApplicationShutdown() {
         const client = this.moduleRef.get(getSQBToken(this.options.name));
         const op = this.moduleRef.get(SQB_CONNECTION_OPTIONS);
@@ -121,6 +147,7 @@ SqbCoreModule = SqbCoreModule_1 = __decorate([
     Global(),
     Module({}),
     __param(0, Inject(SQB_MODULE_OPTIONS)),
-    __metadata("design:paramtypes", [Object, ModuleRef])
+    __metadata("design:paramtypes", [Object, ModuleRef,
+        Logger])
 ], SqbCoreModule);
 export { SqbCoreModule };

package/{types/sqb.interface.d.ts → sqb.interface.d.ts}

@@ -39,6 +39,7 @@ interface BaseModuleOptions {
     logger?: LoggerService | string;
     global?: boolean;
     name?: string;
+    lazyConnect?: boolean;
 }
 export interface SqbModuleOptions extends BaseModuleOptions {
     useValue?: SqbClientConnectionOptions;

package/cjs/get-sqb-config.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSqbConfig = getSqbConfig;
-const tslib_1 = require("tslib");
-const node_process_1 = tslib_1.__importDefault(require("node:process"));
-const objects_1 = require("@jsopen/objects");
-const putil_varhelpers_1 = require("putil-varhelpers");
-function getSqbConfig(moduleOptions, prefix = 'SQB_') {
-    const options = (0, objects_1.clone)(moduleOptions);
-    const env = node_process_1.default.env;
-    options.dialect = options.dialect || env[prefix + 'DIALECT'];
-    options.name = options.name || env[prefix + 'CONNECTION_NAME'];
-    options.host = options.host || env[prefix + 'HOST'];
-    options.port = options.port || (0, putil_varhelpers_1.toInt)(env[prefix + 'PORT']);
-    options.database = options.database || env[prefix + 'DATABASE'];
-    options.schema = options.schema || env[prefix + 'SCHEMA'];
-    options.user = options.user || env[prefix + 'USER'];
-    options.password = options.password || env[prefix + 'PASSWORD'];
-    options.driver = options.driver || env[prefix + 'DRIVER'];
-    options.pool = options.pool || {};
-    options.pool.max = options.pool.max || (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_MAX']);
-    options.pool.min = options.pool.min || (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_MIN']);
-    options.pool.idleTimeoutMillis =
-        options.pool.idleTimeoutMillis || (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_IDLE_TIMEOUT']);
-    options.pool.acquireTimeoutMillis =
-        options.pool.acquireTimeoutMillis ||
-            (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_ACQUIRE_TIMEOUT']);
-    options.pool.acquireMaxRetries =
-        options.pool.acquireMaxRetries ||
-            (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_ACQUIRE_MAX_RETRIES']);
-    options.pool.acquireRetryWait =
-        options.pool.acquireRetryWait ||
-            (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_ACQUIRE_RETRY_WAIT']);
-    options.pool.fifo = options.pool.fifo || (0, putil_varhelpers_1.toBoolean)(env[prefix + 'POOL_FIFO']);
-    options.pool.maxQueue =
-        options.pool.maxQueue || (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_MAX_QUEUE']);
-    options.pool.minIdle =
-        options.pool.minIdle || (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_MIN_IDLE']);
-    options.pool.validation =
-        options.pool.validation || (0, putil_varhelpers_1.toBoolean)(env[prefix + 'POOL_VALIDATION']);
-    options.pool.houseKeepInterval =
-        options.pool.houseKeepInterval ||
-            (0, putil_varhelpers_1.toInt)(env[prefix + 'POOL_HOUSE_KEEP_INTERVAL']);
-    return options;
-}

package/cjs/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SqbClient = void 0;
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./sqb.decorators.js"), exports);
-tslib_1.__exportStar(require("./sqb.interface.js"), exports);
-tslib_1.__exportStar(require("./sqb.module.js"), exports);
-tslib_1.__exportStar(require("./sqb.utils.js"), exports);
-var connect_1 = require("@sqb/connect");
-Object.defineProperty(exports, "SqbClient", { enumerable: true, get: function () { return connect_1.SqbClient; } });

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/sqb-core.module.js

@@ -1,129 +0,0 @@
-"use strict";
-var SqbCoreModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SqbCoreModule = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@nestjs/common");
-const core_1 = require("@nestjs/core");
-const connect_1 = require("@sqb/connect");
-const crypto = tslib_1.__importStar(require("crypto"));
-const rxjs_1 = require("rxjs");
-const rxjs = tslib_1.__importStar(require("rxjs"));
-const get_sqb_config_js_1 = require("./get-sqb-config.js");
-const sqb_constants_js_1 = require("./sqb.constants.js");
-const sqb_utils_js_1 = require("./sqb.utils.js");
-let SqbCoreModule = SqbCoreModule_1 = class SqbCoreModule {
-    options;
-    moduleRef;
-    constructor(options, moduleRef) {
-        this.options = options;
-        this.moduleRef = moduleRef;
-    }
-    static forRoot(options = {}) {
-        const optionsProvider = {
-            provide: sqb_constants_js_1.SQB_MODULE_OPTIONS,
-            useValue: options,
-        };
-        const connectionProvider = {
-            provide: (0, sqb_utils_js_1.getSQBToken)(options.name),
-            inject: [sqb_constants_js_1.SQB_CONNECTION_OPTIONS],
-            useFactory: (sqbConnectionOptions) => this.createConnection(options, sqbConnectionOptions),
-        };
-        return {
-            module: SqbCoreModule_1,
-            providers: [
-                connectionProvider,
-                optionsProvider,
-                {
-                    provide: sqb_constants_js_1.SQB_CONNECTION_OPTIONS,
-                    useValue: (0, get_sqb_config_js_1.getSqbConfig)(options.useValue || {}, options.envPrefix),
-                },
-            ],
-            exports: [connectionProvider],
-        };
-    }
-    static forRootAsync(options) {
-        const connectionProvider = {
-            provide: (0, sqb_utils_js_1.getSQBToken)(options.name),
-            inject: [sqb_constants_js_1.SQB_MODULE_OPTIONS, sqb_constants_js_1.SQB_CONNECTION_OPTIONS],
-            useFactory: async (sqbOptions, sqbConnectionOptions) => this.createConnection(sqbOptions, sqbConnectionOptions),
-        };
-        const asyncProviders = this.createAsyncProviders(options);
-        return {
-            module: SqbCoreModule_1,
-            imports: options.imports,
-            providers: [
-                ...asyncProviders,
-                connectionProvider,
-                {
-                    provide: sqb_constants_js_1.SQB_MODULE_OPTIONS,
-                    useValue: options,
-                },
-                {
-                    provide: sqb_constants_js_1.SQB_MODULE_ID,
-                    useValue: crypto.randomUUID(),
-                },
-            ],
-            exports: [connectionProvider],
-        };
-    }
-    async onApplicationShutdown() {
-        const client = this.moduleRef.get((0, sqb_utils_js_1.getSQBToken)(this.options.name));
-        const op = this.moduleRef.get(sqb_constants_js_1.SQB_CONNECTION_OPTIONS);
-        if (client)
-            await client.close(op.shutdownWaitMs);
-    }
-    static createAsyncProviders(options) {
-        if (options.useExisting || options.useFactory)
-            return [this.createAsyncOptionsProvider(options)];
-        if (options.useClass) {
-            return [
-                this.createAsyncOptionsProvider(options),
-                {
-                    provide: options.useClass,
-                    useClass: options.useClass,
-                },
-            ];
-        }
-        throw new Error('Invalid configuration. Must provide useFactory, useClass or useExisting');
-    }
-    static createAsyncOptionsProvider(options) {
-        if (options.useFactory) {
-            return {
-                provide: sqb_constants_js_1.SQB_CONNECTION_OPTIONS,
-                useFactory: options.useFactory,
-                inject: options.inject || [],
-            };
-        }
-        const useClass = options.useClass || options.useExisting;
-        if (useClass) {
-            return {
-                provide: sqb_constants_js_1.SQB_CONNECTION_OPTIONS,
-                useFactory: (optionsFactory) => optionsFactory.createSqbOptions(options.name),
-                inject: [useClass],
-            };
-        }
-        throw new Error('Invalid configuration. Must provide useFactory, useClass or useExisting');
-    }
-    static async createConnection(moduleOptions, sqbConnectionOptions) {
-        const connectionToken = moduleOptions.name;
-        // NestJS 8
-        // @ts-ignore
-        if (rxjs.lastValueFrom) {
-            // @ts-ignore
-            return await rxjs.lastValueFrom((0, rxjs_1.defer)(async () => new connect_1.SqbClient(sqbConnectionOptions)).pipe((0, sqb_utils_js_1.handleRetry)(connectionToken, sqbConnectionOptions.retryAttempts, sqbConnectionOptions.retryDelay, sqbConnectionOptions.verboseRetryLog, sqbConnectionOptions.toRetry)));
-        }
-        // NestJS 7
-        // @ts-ignore
-        return await (0, rxjs_1.defer)(async () => new connect_1.SqbClient(sqbConnectionOptions))
-            .pipe((0, sqb_utils_js_1.handleRetry)(connectionToken, sqbConnectionOptions.retryAttempts, sqbConnectionOptions.retryDelay, sqbConnectionOptions.verboseRetryLog, sqbConnectionOptions.toRetry))
-            .toPromise();
-    }
-};
-exports.SqbCoreModule = SqbCoreModule;
-exports.SqbCoreModule = SqbCoreModule = SqbCoreModule_1 = tslib_1.__decorate([
-    (0, common_1.Global)(),
-    (0, common_1.Module)({}),
-    tslib_1.__param(0, (0, common_1.Inject)(sqb_constants_js_1.SQB_MODULE_OPTIONS)),
-    tslib_1.__metadata("design:paramtypes", [Object, core_1.ModuleRef])
-], SqbCoreModule);

package/cjs/sqb.constants.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SQB_MODULE_ID = exports.SQB_CONNECTION_OPTIONS = exports.SQB_MODULE_OPTIONS = void 0;
-exports.SQB_MODULE_OPTIONS = Symbol('SQB_MODULE_OPTIONS');
-exports.SQB_CONNECTION_OPTIONS = Symbol('SQB_CONNECTION_OPTIONS');
-exports.SQB_MODULE_ID = Symbol('SQB_MODULE_ID');

package/cjs/sqb.decorators.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InjectSQB = void 0;
-const common_1 = require("@nestjs/common");
-const sqb_utils_js_1 = require("./sqb.utils.js");
-const InjectSQB = (name) => (0, common_1.Inject)((0, sqb_utils_js_1.getSQBToken)(name));
-exports.InjectSQB = InjectSQB;

package/cjs/sqb.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/sqb.module.js

@@ -1,25 +0,0 @@
-"use strict";
-var SqbModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SqbModule = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@nestjs/common");
-const sqb_core_module_js_1 = require("./sqb-core.module.js");
-let SqbModule = SqbModule_1 = class SqbModule {
-    static forRoot(options) {
-        return {
-            module: SqbModule_1,
-            imports: [sqb_core_module_js_1.SqbCoreModule.forRoot(options)],
-        };
-    }
-    static forRootAsync(options) {
-        return {
-            module: SqbModule_1,
-            imports: [sqb_core_module_js_1.SqbCoreModule.forRootAsync(options)],
-        };
-    }
-};
-exports.SqbModule = SqbModule;
-exports.SqbModule = SqbModule = SqbModule_1 = tslib_1.__decorate([
-    (0, common_1.Module)({})
-], SqbModule);

package/cjs/sqb.utils.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSQBToken = getSQBToken;
-exports.handleRetry = handleRetry;
-const common_1 = require("@nestjs/common");
-const connect_1 = require("@sqb/connect");
-const operators_1 = require("rxjs/operators");
-const logger = new common_1.Logger('SqbModule');
-/**
- * This function returns a Connection injection token for the given connection name.
- * @param {string | symbol} [name=SQB_DEFAULT_CONNECTION] This optional parameter is either
- * a SqbClient, or a ConnectionOptions or a string.
- * @returns {string | symbol} The Connection injection token.
- */
-function getSQBToken(name) {
-    if (!name)
-        return connect_1.SqbClient;
-    if (typeof name === 'symbol' || typeof name === 'function')
-        return name;
-    return `${name}_SqbConnection`;
-}
-function handleRetry(connectionName, retryAttempts = 9, retryDelay = 3000, verboseRetryLog = false, toRetry) {
-    return (source) => source.pipe((0, operators_1.retryWhen)(e => e.pipe((0, operators_1.scan)((errorCount, error) => {
-        if (toRetry && !toRetry(error)) {
-            throw error;
-        }
-        const connectionInfo = !connectionName || connectionName === connect_1.SqbClient
-            ? 'default'
-            : ` (${String(connectionName)})`;
-        const verboseMessage = verboseRetryLog
-            ? ` Message: ${error.message}.`
-            : '';
-        logger.error(`Unable to connect to the database ${connectionInfo}.${verboseMessage} Retrying (${errorCount + 1})...`, error.stack);
-        if (errorCount + 1 >= retryAttempts) {
-            throw error;
-        }
-        return errorCount + 1;
-    }, 0), (0, operators_1.delay)(retryDelay))));
-}

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/types/index.d.cts

@@ -1,5 +0,0 @@
-export * from './sqb.decorators.js';
-export * from './sqb.interface.js';
-export * from './sqb.module.js';
-export * from './sqb.utils.js';
-export { SqbClient } from '@sqb/connect';