@pi-r/mssql 0.3.4 → 0.3.6

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2023 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,5 @@
-# @pi-r/mssql
-
-PEP 402 - Forever
-
-## LICENSE
-
+# @pi-r/mssql
+
+## LICENSE
+
 MIT

package/client/index.d.ts

@@ -1,7 +1,7 @@
-import type { IDbSourceClient } from '@e-mc/db/types';
-
-import type { MSSQLDataSource } from '../types';
-
-declare const MSSQL: IDbSourceClient<MSSQLDataSource>;
-
+import type { IDbSourceClient } from '@e-mc/db/types';
+
+import type { MSSQLDataSource } from '../types';
+
+declare const MSSQL: IDbSourceClient<MSSQLDataSource>;
+
 export = MSSQL;

package/client/index.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = void 0;
-const tedious = require("tedious");
 const types_1 = require("@e-mc/types");
 const util_1 = require("@e-mc/db/util");
 const Db = require("@e-mc/db");
-const TediousPool = require('tedious-connection-pool2');
 const DbPool = require('@e-mc/db/pool');
 class MSSQLPool extends DbPool {
     getConnection() {
@@ -204,6 +202,7 @@ function setCredential(item) {
         }
         const poolKey = getPoolKey(credential);
         if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
+            const Pool = require("tedious-connection-pool2");
             const config = this.getPoolConfig("mssql", password);
             const poolConfig = (0, types_1.isPlainObject)(item.usePool) ? item.usePool : {};
             if (config) {
@@ -221,7 +220,7 @@ function setCredential(item) {
                     (_d = poolConfig.acquireTimeout) !== null && _d !== void 0 ? _d : (poolConfig.acquireTimeout = queue_idle);
                 }
             }
-            new MSSQLPool(new TediousPool(poolConfig, credential), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
+            new MSSQLPool(new Pool(poolConfig, credential), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
         }
         else {
             pool.add(item);
@@ -238,6 +237,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
     if (length === 0) {
         return [];
     }
+    const db = require("tedious");
     let parallel, connectOnce, errorQuery, sessionKey, outCacheMiss;
     if ((0, types_1.isPlainObject)(options)) {
         ({ parallel, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
@@ -303,7 +303,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         }
         if (!client) {
             clients.push(client = await new Promise((resolve, reject) => {
-                const sql = new tedious.Connection(mssqlCredential || credential);
+                const sql = new db.Connection(mssqlCredential || credential);
                 sql.connect(err => {
                     if (err) {
                         reject(err);
@@ -388,15 +388,15 @@ async function executeBatchQuery(batch, options = '', outResult) {
                 const processRow = typeof streamRow === 'function' && streamRow;
                 const rows = [];
                 let recordset = 1, resume, output;
-                const request = new tedious.Request(query, () => {
+                const request = new db.Request(query, () => {
                     if (error && this.handleFail(error, item, { errorQuery, commandType })) {
                         reject(error);
                     }
                     else {
                         this.add(item, 4);
                         if (output) {
-                            output.__recordset__ = 0;
-                            output.__returnvalue__ = true;
+                            output['__recordset__'] = 0;
+                            output['__returnvalue__'] = true;
                             rows.push([output]);
                         }
                         resolve(!error ? this.setQueryResult(source, credential, queryString, rows, cacheValue) : rows);
@@ -407,9 +407,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     if (isOutputParameters(params)) {
                         ({ input: params, output: paramsOutput } = params);
                     }
-                    convertParameters.call(request, tedious.TYPES, params, false);
+                    convertParameters.call(request, db.TYPES, params, false);
                     if (paramsOutput) {
-                        convertParameters.call(request, tedious.TYPES, paramsOutput, true);
+                        convertParameters.call(request, db.TYPES, paramsOutput, true);
                     }
                 }
                 request
@@ -423,7 +423,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                             try {
                                 const items = JSON.parse(data.value);
                                 if ((0, types_1.isArray)(items)) {
-                                    items.forEach((col) => col.__recordset__ = recordset);
+                                    items.forEach((col) => col['__recordset__'] = recordset);
                                     rows.push(...items);
                                 }
                             }

package/client/pool.js

@@ -0,0 +1,63 @@
+"use strict";
+const types_1 = require("@e-mc/types");
+const util_1 = require("@e-mc/db/util");
+const DbPool = require('@e-mc/db/pool');
+class MSSQLPool extends DbPool {
+    static asString(credential) {
+        const auth = credential.authentication?.options;
+        if (!credential.server || !(auth?.userName && auth.password)) {
+            return super.asString(credential);
+        }
+        const options = credential.options;
+        let tls;
+        if (options && (tls = options.cryptoCredentialsDetails)) {
+            if (!(0, types_1.isObject)(tls)) {
+                delete options.cryptoCredentialsDetails;
+            }
+            else if (tls.ca || tls.cert || tls.key) {
+                credential = { ...credential };
+                if ('uuidKey' in credential) {
+                    delete credential.uuidKey;
+                }
+                credential.options = { ...options };
+                delete credential.options.cryptoCredentialsDetails;
+                return JSON.stringify(credential) + '_tls';
+            }
+        }
+        if ('uuidKey' in credential) {
+            credential = { ...credential };
+            delete credential.uuidKey;
+        }
+        return JSON.stringify(credential);
+    }
+    async getConnection() {
+        return new Promise((resolve, reject) => {
+            this.client.acquire((err, connection) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve(connection);
+                }
+            });
+        });
+    }
+    async close() {
+        return new Promise((resolve, reject) => {
+            try {
+                this.client.drain();
+                resolve();
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    }
+    isEmpty() {
+        return this.closed || (0, util_1.checkEmpty)(this.client.connections) && (0, util_1.checkEmpty)(this.client.waiting);
+    }
+    get closed() {
+        return !!this.client.drained;
+    }
+}
+module.exports = MSSQLPool;

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@pi-r/mssql",
-  "version": "0.3.4",
-  "description": "MSSQL client driver for E-mc.",
-  "main": "client/index.js",
-  "types": "client/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/pi-r.git",
-    "directory": "src/db/mssql"
-  },
-  "keywords": [
-    "squared",
-    "e-mc",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/pi-r#readme",
-  "dependencies": {
-    "@e-mc/db": "^0.6.3",
-    "@e-mc/types": "^0.6.3",
-    "tedious": "^16.7.1",
-    "tedious-connection-pool2": "^2.1.0"
-  }
-}
+{
+  "name": "@pi-r/mssql",
+  "version": "0.3.6",
+  "description": "MSSQL client driver for E-mc.",
+  "main": "client/index.js",
+  "types": "client/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
+    "directory": "src/db/mssql"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/db": "^0.6.16",
+    "@e-mc/types": "^0.6.16",
+    "tedious": "^16.7.1",
+    "tedious-connection-pool2": "^2.1.0"
+  }
+}

package/types/index.d.ts

@@ -1,29 +1,29 @@
-import type { DbDataSource } from '@e-mc/types/lib/squared';
-
-import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
-
-// @ts-ignore
-import type { ConnectionConfig, ParameterOptions, TediousType, TediousTypes } from 'tedious';
-// @ts-ignore
-import type { PoolConfig } from 'tedious-connection-pool';
-
-export interface MSSQLDataSource extends DbDataSource<string, unknown, unknown, string | MSSQLCredential, string | PoolConfig>, ExecuteAction<MSSQLRequestParameters | MSSQLRequestWithOutputParameters> {
-    source: "mssql";
-    storedProc?: boolean;
-}
-
-export interface MSSQLCredential extends ServerAuth, ConnectionConfig {}
-
-export interface MSSQLRequestWithOutputParameters {
-    input?: MSSQLRequestParameters;
-    output?: MSSQLRequestParameters;
-}
-
-export interface MSSQLRequestParameterValue {
-    name?: string;
-    value?: unknown;
-    type?: keyof TediousTypes | TediousType;
-    options?: ParameterOptions;
-}
-
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
+
+// @ts-ignore
+import type { ConnectionConfig, ParameterOptions, TediousType, TediousTypes } from 'tedious';
+// @ts-ignore
+import type { PoolConfig } from 'tedious-connection-pool';
+
+export interface MSSQLDataSource extends DbDataSource<string, unknown, unknown, string | MSSQLCredential, string | PoolConfig>, ExecuteAction<MSSQLRequestParameters | MSSQLRequestWithOutputParameters> {
+    source: "mssql";
+    storedProc?: boolean;
+}
+
+export interface MSSQLCredential extends ServerAuth, ConnectionConfig {}
+
+export interface MSSQLRequestWithOutputParameters {
+    input?: MSSQLRequestParameters;
+    output?: MSSQLRequestParameters;
+}
+
+export interface MSSQLRequestParameterValue {
+    name?: string;
+    value?: unknown;
+    type?: keyof TediousTypes | TediousType;
+    options?: ParameterOptions;
+}
+
 export type MSSQLRequestParameters = Null<MSSQLRequestParameterValue[] | ObjectMap<Omit<MSSQLRequestParameterValue, "name">>>;

package/types/pool.d.ts

@@ -0,0 +1,67 @@
+import type { Connection, ConnectionConfiguration } from 'tedious';
+
+import type * as EventEmitter from 'events';
+
+declare class Pool extends EventEmitter {
+    /**
+     * Connection Pool constructor
+     * @param poolConfig the pool configuration
+     * @param connectionConfig the connection configuration
+     */
+    constructor(poolConfig: Pool.PoolConfig, connectionConfig: ConnectionConfiguration);
+
+    /**
+     * acquires a connection from the pool
+     * @param callback invoked when the connection is retrieved and ready
+     */
+    acquire(callback: (err: Error, connection: Pool.PooledConnection) => void): void;
+
+    /**
+     * closes opened connections
+     */
+    drain(): void;
+}
+
+declare namespace Pool {
+
+    export class PooledConnection extends Connection {
+        /**
+         * If the connection is issued from a connection pool returns the connection to the pool.
+         */
+        release(): void;
+    }
+
+    export interface PoolConfig {
+        /**
+         * Minimum concurrent connections
+         */
+        min?: number | undefined;
+
+        /**
+         * Maximum concurrent connections
+         */
+        max?: number | undefined;
+
+        /**
+         * Defines if logging is activated
+         */
+        log?: boolean | undefined;
+
+        /**
+         * Idle timeout
+         */
+        idleTimeout?: number | undefined;
+
+        /**
+         * Retry delay
+         */
+        retryDelay?: number | undefined;
+
+        /**
+         * Acquire timeout
+         */
+        acquireTimeout?: number | undefined;
+    }
+}
+
+export = Pool;