@pi-r/mssql 0.11.2 → 0.12.0

package/client/index.js

@@ -1,18 +1,14 @@
 "use strict";
-exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = void 0;
-exports.setCredential = setCredential;
-exports.executeQuery = executeQuery;
-exports.executeBatchQuery = executeBatchQuery;
-exports.checkTimeout = checkTimeout;
-const tedious = require("tedious");
-const Db = require("@e-mc/db");
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/db/util");
-const DbPool = require("@pi-r/mssql/client/pool");
+
+const tedious = require('tedious');
+const Db = require('@e-mc/db');
+const { DB_TYPE, asFunction, errorMessage, isArray, isError, isErrorCode, isObject, isPlainObject, isString } = require('@e-mc/types');
+const { parseConnectionString, parseServerAuth } = require('@e-mc/db/util');
+const DbPool = require('@pi-r/mssql/client/pool');
 const TediousPool = require('tedious-connection-pool2');
 const POOL_STATE = {};
-function convertParameters(sql, params, output) {
-    if ((0, types_1.isPlainObject)(params)) {
+function convertParameters(sql, params, item) {
+    if (isPlainObject(params)) {
         const items = [];
         for (const name in params) {
             items.push({ ...params[name], name });
@@ -25,27 +21,29 @@ function convertParameters(sql, params, output) {
             if (name) {
                 const type = convertType(sql, param.type, value, options);
                 if (type.name === 'TVP') {
-                    if (output || !(0, types_1.isPlainObject)(value)) {
-                        continue;
-                    }
-                    const columns = value.columns;
-                    if ((0, types_1.isArray)(columns)) {
-                        for (const col of columns) {
-                            col.type = convertType(sql, col.type, col.value, col.options ||= {});
+                    if (item && isPlainObject(value)) {
+                        if (isArray(value.columns)) {
+                            for (const col of value.columns) {
+                                col.type = convertType(sql, col.type, col.value, col.options ||= {});
+                            }
                         }
+                        item.storedProc = true;
+                    }
+                    else {
+                        continue;
                     }
                 }
-                this[output ? 'addOutputParameter' : 'addParameter'](name, type, value, options);
+                this[item ? 'addParameter' : 'addOutputParameter'](name, type, value, options);
             }
         }
     }
 }
 function convertType(sql, type, value, options) {
     let result;
-    if (typeof type === 'string') {
+    if (isString(type)) {
         result = sql[type];
     }
-    else if ((0, types_1.isObject)(type)) {
+    else if (isObject(type)) {
         if (typeof type.id === 'number' && typeof type.declaration === 'function' && typeof type.validate === 'function') {
             return type;
         }
@@ -87,17 +85,17 @@ function convertType(sql, type, value, options) {
             return sql.VarChar;
     }
 }
-const isOutputParameters = (params) => (0, types_1.isPlainObject)(params) && Object.keys(params).length === 2 && 'input' in params && 'output' in params;
+const isOutputParameters = (params) => isPlainObject(params) && Object.keys(params).length === 2 && 'input' in params && 'output' in params;
 function setCredential(item) {
     let credential = this.getCredential(item), hostname, username, password, port, database;
     if (credential) {
-        ({ username, password, hostname, port, database } = (0, util_1.parseServerAuth)(credential, true));
+        ({ username, password, hostname, port, database } = parseServerAuth(credential, true));
     }
     else {
         const uri = item.uri;
         credential = {};
         if (uri) {
-            const connection = (0, util_1.parseConnectionString)(uri);
+            const connection = parseConnectionString(uri);
             if (connection) {
                 ({ username, password, hostname, port, database } = connection);
             }
@@ -127,20 +125,20 @@ function setCredential(item) {
             break;
         case 'ntlm':
             flags = 1;
-            if (!(0, types_1.isString)(authOptions.domain)) {
+            if (!isString(authOptions.domain)) {
                 errors.push('authentication.options.domain');
             }
             break;
-        case 'azure-active-directory-password':
-            flags = 1 | 4;
-            break;
         case 'token-credential':
-            if (!(0, types_1.isObject)(authOptions.credential)) {
+            if (!isObject(authOptions.credential)) {
                 errors.push('authentication.options.credential');
             }
             break;
+        case 'azure-active-directory-password':
+            flags = 1 | 4;
+            break;
         case 'azure-active-directory-access-token':
-            if (!(0, types_1.isString)(authOptions.token)) {
+            if (!isString(authOptions.token)) {
                 errors.push('authentication.options.token');
             }
             break;
@@ -149,13 +147,13 @@ function setCredential(item) {
             break;
         case 'azure-active-directory-msi-app-service':
             flags = 4 | 8;
-            if (!(0, types_1.isString)(authOptions.msiSecret)) {
+            if (!isString(authOptions.msiSecret)) {
                 errors.push('authentication.options.msiSecret');
             }
             break;
         case 'azure-active-directory-service-principal-secret':
             flags = 4;
-            if (!(0, types_1.isString)(authOptions.clientSecret)) {
+            if (!isString(authOptions.clientSecret)) {
                 errors.push('authentication.options.clientSecret');
             }
             break;
@@ -165,21 +163,21 @@ function setCredential(item) {
             authOptions.userName ||= username;
             authOptions.password ||= password;
         }
-        if (!(0, types_1.isString)(authOptions.userName)) {
+        if (!isString(authOptions.userName)) {
             errors.push('authentication.options.userName');
         }
-        if (!(0, types_1.isString)(authOptions.password)) {
+        if (!isString(authOptions.password)) {
             errors.push('authentication.options.password');
         }
     }
-    if ((flags & 4) && !(0, types_1.isString)(authOptions.clientId)) {
+    if ((flags & 4) && !isString(authOptions.clientId)) {
         errors.push('authentication.options.clientId');
     }
-    if ((flags & 8) && !(0, types_1.isString)(authOptions.msiEndpoint)) {
+    if ((flags & 8) && !isString(authOptions.msiEndpoint)) {
         errors.push('authentication.options.msiEndpoint');
     }
     if (errors.length > 0) {
-        throw (0, types_1.errorMessage)("mssql", "Invalid credentials", errors.join(', '));
+        throw errorMessage("mssql", "Invalid credentials", errors.join(', '));
     }
     const options = credential.options;
     if (options) {
@@ -202,7 +200,7 @@ function setCredential(item) {
     }
     let pool;
     password = undefined;
-    if ((0, types_1.isString)(usePool)) {
+    if (isString(usePool)) {
         username = authOptions.userName;
         if (username) {
             [password, pool] = DbPool.validateKey(POOL_STATE, username, usePool);
@@ -217,7 +215,7 @@ function setCredential(item) {
         }
     }
     const config = this.getPoolConfig("mssql", password);
-    const poolConfig = (0, types_1.isPlainObject)(item.usePool) ? item.usePool : {};
+    const poolConfig = isPlainObject(item.usePool) ? item.usePool : {};
     if (config) {
         const { min, max, idle, queue_idle } = config;
         if (min >= 0) {
@@ -252,7 +250,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         return [];
     }
     let parallel, connectOnce, errorQuery, sessionKey, outCacheMiss;
-    if ((0, types_1.isPlainObject)(options)) {
+    if (isPlainObject(options)) {
         ({ parallel, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
     }
     else {
@@ -295,19 +293,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
             }
             catch (err) {
                 let close;
-                switch (err instanceof Error && err.code) {
-                    case 'ELOGIN':
-                    case 'EDRIVER':
-                    case 'EINSTLOOKUP':
-                        close = 1;
-                        break;
-                    default:
-                        close = pool.closeable;
-                        break;
+                if (!isErrorCode(err, 'ELOGIN', 'EDRIVER', 'EINSTLOOKUP')) {
+                    close = pool.closeable;
                 }
-                if (close) {
+                if (close !== false) {
                     await pool.detach(true);
-                    if (close === 1) {
+                    if (!close) {
                         throw err;
                     }
                 }
@@ -343,7 +334,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         const item = batch[i];
         const { source, query, ignoreCache } = item;
         let credential = mssqlCredential || onceCredential, error;
-        if (!credential && !(0, types_1.isPlainObject)(credential = item.credential) && (error = (0, types_1.errorMessage)(source, "Invalid credentials")) || !query && (error = (0, types_1.errorMessage)(source, "Missing database query"))) {
+        if (!credential && !isPlainObject(credential = item.credential) && (error = errorMessage(source, "Invalid credentials")) || !query && (error = errorMessage(source, "Missing database query"))) {
             if (this.handleFail(error, item, { errorQuery })) {
                 if (!parallel) {
                     tasks.length = 0;
@@ -360,7 +351,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
             continue;
         }
         item.transactionState = 1;
-        const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("mssql", 'options', credential) && (0, types_1.asFunction)(item.streamRow) : item.streamRow;
+        const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("mssql", 'options', credential) && asFunction(item.streamRow) : item.streamRow;
         const cacheValue = ignoreCache === undefined ? sessionKey : Array.isArray(ignoreCache) ? { sessionKey, exclusiveOf: ignoreCache } : { sessionKey, renewCache: ignoreCache === 0 };
         let params = item.params, queryString = '';
         if (caching && ignoreCache !== true && !streamRow) {
@@ -403,8 +394,8 @@ async function executeBatchQuery(batch, options = '', outResult) {
                 const processRow = typeof streamRow === 'function' ? streamRow : null;
                 const rows = [];
                 let recordset = 1, resume = false, output;
-                const request = new tedious.Request(query, () => {
-                    if (error && this.handleFail(error, item, { errorQuery, commandType })) {
+                const request = new tedious.Request(query, err => {
+                    if ((error ||= err) && this.handleFail(error, item, { errorQuery, commandType })) {
                         reject(error);
                     }
                     else {
@@ -423,10 +414,10 @@ async function executeBatchQuery(batch, options = '', outResult) {
                         ({ input: params, output: paramsOutput } = params);
                     }
                     if (params) {
-                        convertParameters.call(request, tedious.TYPES, params, false);
+                        convertParameters.call(request, tedious.TYPES, params, item);
                     }
                     if (paramsOutput) {
-                        convertParameters.call(request, tedious.TYPES, paramsOutput, true);
+                        convertParameters.call(request, tedious.TYPES, paramsOutput);
                     }
                 }
                 request
@@ -439,7 +430,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                         if (name === 'JSON_F52E2B61-18A1-11d1-B105-00805F49916B') {
                             try {
                                 const items = JSON.parse(data.value);
-                                if ((0, types_1.isArray)(items)) {
+                                if (isArray(items)) {
                                     for (const col of items) {
                                         col.__recordset__ = recordset;
                                     }
@@ -458,7 +449,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                         if (err === false) {
                             return;
                         }
-                        if (err instanceof Error) {
+                        if (isError(err)) {
                             error = err;
                             return;
                         }
@@ -532,5 +523,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
 async function checkTimeout(value, limit = 0) {
     return DbPool.checkTimeout(POOL_STATE, value, limit);
 }
-exports.DB_SOURCE_CLIENT = true;
-exports.DB_SOURCE_TYPE = types_1.DB_TYPE.SQL;
+const DB_SOURCE_CLIENT = true;
+const DB_SOURCE_TYPE = DB_TYPE.SQL;
+
+exports.DB_SOURCE_CLIENT = DB_SOURCE_CLIENT;
+exports.DB_SOURCE_TYPE = DB_SOURCE_TYPE;
+exports.checkTimeout = checkTimeout;
+exports.executeBatchQuery = executeBatchQuery;
+exports.executeQuery = executeQuery;
+exports.setCredential = setCredential;

package/client/pool.d.ts

@@ -2,7 +2,7 @@ import type { DbPoolConstructor } from '@e-mc/types/lib/db';
 
 import type { DbPoolCredential, MSSQLDataSource } from '../types';
 
-import type * as mssql_pool from '../types/pool';
+import type mssql_pool from '../types/pool';
 
 declare const MSSQLPool: DbPoolConstructor<MSSQLDataSource, mssql_pool, mssql_pool.PooledConnection, DbPoolCredential>;
 

package/client/pool.js

@@ -1,6 +1,7 @@
 "use strict";
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/db/util");
+
+const { isObject } = require('@e-mc/types');
+const { checkEmpty } = require('@e-mc/db/util');
 const DbPool = require('@e-mc/db/pool');
 class MSSQLPool extends DbPool {
     static asString(credential) {
@@ -11,7 +12,7 @@ class MSSQLPool extends DbPool {
         const options = credential.options;
         let tls;
         if (options && (tls = options.cryptoCredentialsDetails)) {
-            if (!(0, types_1.isObject)(tls)) {
+            if (!isObject(tls)) {
                 delete options.cryptoCredentialsDetails;
             }
             else if (tls.ca || tls.cert || tls.key) {
@@ -54,10 +55,11 @@ class MSSQLPool extends DbPool {
         });
     }
     isEmpty() {
-        return this.closed || (0, util_1.checkEmpty)(this.client.connections) && (0, util_1.checkEmpty)(this.client.waiting);
+        return this.closed || checkEmpty(this.client.connections) && checkEmpty(this.client.waiting);
     }
     get closed() {
         return !!this.client.drained;
     }
 }
+
 module.exports = MSSQLPool;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/mssql",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "MSSQL client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -20,9 +20,9 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.13.9",
-    "@e-mc/types": "^0.13.9",
-    "tedious": "^18.6.2",
+    "@e-mc/db": "^0.14.0",
+    "@e-mc/types": "^0.14.0",
+    "tedious": "^19.2.1",
     "tedious-connection-pool2": "^2.1.0"
   }
 }

package/types/pool.d.ts

@@ -2,36 +2,28 @@ import type { Connection, ConnectionConfiguration } from 'tedious';
 
 import EventEmitter from 'node:events';
 
-declare class Pool extends EventEmitter {
+declare namespace tcp {
     /**
-     * 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
+     * Extends Tedious Connection with release function
      */
-    acquire(callback: (err: Error, connection: Pool.PooledConnection) => void): void;
-
-    /**
-     * closes opened connections
-     */
-    drain(): void;
-}
-
-declare namespace Pool {
-
-    export class PooledConnection extends Connection {
+    class PooledConnection extends Connection {
         /**
          * If the connection is issued from a connection pool returns the connection to the pool.
          */
         release(): void;
     }
 
-    export interface PoolConfig {
+    /**
+     * Provides a connection or an error
+     * @param err error if any
+     * @param connection issued from the pool
+     */
+    type ConnectionCallback = (err: Error, connection: PooledConnection) => void;
+
+    /**
+     *  Pool Configuration interface
+     */
+    interface PoolConfig {
         /**
          * Minimum concurrent connections
          */
@@ -64,4 +56,27 @@ declare namespace Pool {
     }
 }
 
-export = Pool;
+/**
+ * Tedious Connection Pool Class
+ */
+declare class tcp extends EventEmitter {
+    /**
+     * Connection Pool constructor
+     * @param poolConfig the pool configuration
+     * @param connectionConfig the connection configuration
+     */
+    constructor(poolConfig: tcp.PoolConfig, connectionConfig: ConnectionConfiguration);
+
+    /**
+     * acquires a connection from the pool
+     * @param callback invoked when the connection is retrieved and ready
+     */
+    acquire(callback: tcp.ConnectionCallback): void;
+
+    /**
+     * closes opened connections
+     */
+    drain(): void;
+}
+
+export = tcp;