@pi-r/mssql 0.7.3 → 0.8.1

package/client/index.js

@@ -1,42 +1,15 @@
 "use strict";
-exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = void 0;
+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 Db = require("@e-mc/db");
+const DbPool = require("@pi-r/mssql/client/pool");
 const TediousPool = require('tedious-connection-pool2');
-const DbPool = require('@e-mc/db/pool');
-class MSSQLPool extends DbPool {
-    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;
-    }
-}
 const POOL_STATE = {};
 function convertParameters(sql, params, output) {
     if ((0, types_1.isPlainObject)(params)) {
@@ -57,9 +30,9 @@ function convertParameters(sql, params, output) {
                     }
                     const columns = value.columns;
                     if ((0, types_1.isArray)(columns)) {
-                        columns.forEach(col => {
+                        for (const col of columns) {
                             col.type = convertType(sql, col.type, col.value, col.options ||= {});
-                        });
+                        }
                     }
                 }
                 this[output ? 'addOutputParameter' : 'addParameter'](name, type, value, options);
@@ -72,7 +45,10 @@ function convertType(sql, type, value, options) {
     if (typeof type === 'string') {
         result = sql[type];
     }
-    else if ((0, types_1.isObject)(type) && type.name) {
+    else if ((0, types_1.isObject)(type)) {
+        if (typeof type.id === 'number' && typeof type.declaration === 'function' && typeof type.validate === 'function') {
+            return type;
+        }
         result = sql[type.name];
     }
     if (result) {
@@ -111,32 +87,6 @@ function convertType(sql, type, value, options) {
             return sql.VarChar;
     }
 }
-function getPoolKey(credential) {
-    const auth = credential.authentication?.options;
-    if (!credential.server || !(auth?.userName && auth.password)) {
-        return;
-    }
-    const tls = credential.options?.cryptoCredentialsDetails;
-    if (tls) {
-        if (!(0, types_1.isObject)(tls)) {
-            delete credential.options.cryptoCredentialsDetails;
-        }
-        else if (tls.ca || tls.cert || tls.key) {
-            credential = { ...credential };
-            if ('uuidKey' in credential) {
-                delete credential.uuidKey;
-            }
-            credential.options = { ...credential.options };
-            delete credential.options.cryptoCredentialsDetails;
-            return JSON.stringify(credential) + '_tls';
-        }
-    }
-    if ('uuidKey' in credential) {
-        credential = { ...credential };
-        delete credential.uuidKey;
-    }
-    return JSON.stringify(credential);
-}
 const isOutputParameters = (params) => (0, types_1.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;
@@ -171,17 +121,65 @@ function setCredential(item) {
             options.port ||= +port;
         }
     }
-    if (username || password) {
-        authOptions.userName ||= username;
-        authOptions.password ||= password;
+    let flags = 0;
+    switch (auth.type) {
+        case 'default':
+            flags = 1;
+            break;
+        case 'ntlm':
+            flags = 1;
+            if (!(0, types_1.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)) {
+                errors.push('authentication.options.credential');
+            }
+            break;
+        case 'azure-active-directory-access-token':
+            if (!(0, types_1.isString)(authOptions.token)) {
+                errors.push('authentication.options.token');
+            }
+            break;
+        case 'azure-active-directory-msi-vm':
+            flags = 8;
+            break;
+        case 'azure-active-directory-msi-app-service':
+            flags = 4 | 8;
+            if (!(0, types_1.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)) {
+                errors.push('authentication.options.clientSecret');
+            }
+            break;
     }
-    if (!authOptions.userName) {
-        errors.push('authentication.options.userName');
+    if (flags & 1) {
+        if (username || password) {
+            authOptions.userName ||= username;
+            authOptions.password ||= password;
+        }
+        if (!(0, types_1.isString)(authOptions.userName)) {
+            errors.push('authentication.options.userName');
+        }
+        if (!(0, types_1.isString)(authOptions.password)) {
+            errors.push('authentication.options.password');
+        }
     }
-    if (!authOptions.password) {
-        errors.push('authentication.options.password');
+    if ((flags & 4) && !(0, types_1.isString)(authOptions.clientId)) {
+        errors.push('authentication.options.clientId');
     }
-    if (errors.length) {
+    if ((flags & 8) && !(0, types_1.isString)(authOptions.msiEndpoint)) {
+        errors.push('authentication.options.msiEndpoint');
+    }
+    if (errors.length > 0) {
         throw (0, types_1.errorMessage)("mssql", 'Not defined - ' + errors.join(' | '));
     }
     const options = credential.options;
@@ -235,18 +233,19 @@ function setCredential(item) {
             poolConfig.acquireTimeout ??= queue_idle;
         }
     }
-    const poolKey = getPoolKey(credential);
+    const poolKey = DbPool.asString(credential);
     if ((pool = POOL_STATE[poolKey]) && !pool.closed) {
         pool.add(item);
         return;
     }
-    new MSSQLPool(new TediousPool(poolConfig, credential), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
+    const client = new TediousPool(poolConfig, credential);
+    new DbPool(client, poolKey, username && password ? { username, password } : undefined)
+        .add(item)
+        .parent = POOL_STATE;
 }
-exports.setCredential = setCredential;
 async function executeQuery(item, options) {
     return (await executeBatchQuery.call(this, [item], options))[0] || [];
 }
-exports.executeQuery = executeQuery;
 async function executeBatchQuery(batch, options = '', outResult) {
     const length = batch.length;
     if (length === 0) {
@@ -285,7 +284,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
             item.transactionState &= ~64;
             return client;
         }
-        const pool = item.usePool && DbPool.findKey(POOL_STATE, item.usePool, getPoolKey(credential), ...connectOnce ? [item, batch[0]] : [item]);
+        const pool = item.usePool && DbPool.findKey(POOL_STATE, item.usePool, DbPool.asString(credential), ...connectOnce ? [item, batch[0]] : [item]);
         if (pool) {
             try {
                 client = await pool.getConnection();
@@ -401,7 +400,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     mssqlClient = undefined;
                 }
                 commandType = this.commandType.SELECT;
-                const processRow = typeof streamRow === 'function' && streamRow;
+                const processRow = typeof streamRow === 'function' ? streamRow : null;
                 const rows = [];
                 let recordset = 1, resume, output;
                 const request = new tedious.Request(query, () => {
@@ -441,7 +440,9 @@ 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);
+                                    for (const col of items) {
+                                        col.__recordset__ = recordset;
+                                    }
                                     rows.push(...items);
                                 }
                             }
@@ -516,21 +517,19 @@ async function executeBatchQuery(batch, options = '', outResult) {
         }
     }
     return this.processRows(batch, tasks, {
-        disconnect: () => {
-            clients.forEach(item => {
+        parallel,
+        disconnect() {
+            for (const item of clients) {
                 item.close();
-            });
-            pools.forEach(item => {
+            }
+            for (const item of pools) {
                 item.release();
-            });
-        },
-        parallel
+            }
+        }
     }, outResult);
 }
-exports.executeBatchQuery = executeBatchQuery;
 async function checkTimeout(value, limit = 0) {
     return DbPool.checkTimeout(POOL_STATE, value, limit);
 }
-exports.checkTimeout = checkTimeout;
 exports.DB_SOURCE_CLIENT = true;
 exports.DB_SOURCE_TYPE = types_1.DB_TYPE.SQL;

package/client/pool.d.ts

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

package/client/pool.js

@@ -0,0 +1,63 @@
+"use strict";
+const util_1 = require("@e-mc/db/util");
+const types_1 = require("@e-mc/types");
+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,6 +1,6 @@
 {
   "name": "@pi-r/mssql",
-  "version": "0.7.3",
+  "version": "0.8.1",
   "description": "MSSQL client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -21,9 +21,9 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.9.6",
-    "@e-mc/types": "^0.9.6",
-    "tedious": "^16.7.1",
+    "@e-mc/db": "^0.10.0",
+    "@e-mc/types": "^0.10.0",
+    "tedious": "^18.6.2",
     "tedious-connection-pool2": "^2.1.0"
   }
 }

package/types/index.d.ts

@@ -1,5 +1,8 @@
+/// <reference lib="es2022" />
+
 import type { DbDataSource } from '@e-mc/types/lib/squared';
 
+import type { IdentifierAction } from '@e-mc/types/lib/core';
 import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
 
 import type { ConnectionConfiguration, TYPES } from 'tedious';
@@ -27,4 +30,5 @@ export interface MSSQLRequestParameterValue {
 }
 
 export type MSSQLRequestParameters = Null<MSSQLRequestParameterValue[] | ObjectMap<Omit<MSSQLRequestParameterValue, "name">>>;
-export type MSSQLDataType = keyof typeof TYPES;
+export type MSSQLDataType = keyof typeof TYPES;
+export type DbPoolCredential = ConnectionConfiguration & IdentifierAction;

package/types/pool.d.ts

@@ -1,5 +1,3 @@
-/* eslint @typescript-eslint/consistent-type-imports: "off" */
-
 import type { Connection, ConnectionConfiguration } from 'tedious';
 
 import type * as EventEmitter from 'events';