@pi-r/mssql 0.7.2 → 0.7.4

package/README.md

@@ -1,7 +1,7 @@
-### @pi-r/mssql
-
-https://e-mc.readthedocs.io/en/latest/db/mssql.html
-
-### LICENSE
-
+### @pi-r/mssql
+
+https://e-mc.readthedocs.io/en/latest/db/mssql.html
+
+### LICENSE
+
 MIT

package/client/index.js

@@ -171,15 +171,58 @@ 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 '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 (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.userName) {
-        errors.push('authentication.options.userName');
+    if ((flags & 4) && !(0, types_1.isString)(authOptions.clientId)) {
+        errors.push('authentication.options.clientId');
     }
-    if (!authOptions.password) {
-        errors.push('authentication.options.password');
+    if ((flags & 8) && !(0, types_1.isString)(authOptions.msiEndpoint)) {
+        errors.push('authentication.options.msiEndpoint');
     }
     if (errors.length) {
         throw (0, types_1.errorMessage)("mssql", 'Not defined - ' + errors.join(' | '));

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,29 +1,29 @@
-{
-  "name": "@pi-r/mssql",
-  "version": "0.7.2",
-  "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.9.4",
-    "@e-mc/types": "^0.9.4",
-    "tedious": "^16.7.1",
-    "tedious-connection-pool2": "^2.1.0"
-  }
-}
+{
+  "name": "@pi-r/mssql",
+  "version": "0.7.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.9.12",
+    "@e-mc/types": "^0.9.12",
+    "tedious": "^16.7.1",
+    "tedious-connection-pool2": "^2.1.0"
+  }
+}

package/types/index.d.ts

@@ -1,30 +1,30 @@
-import type { DbDataSource } from '@e-mc/types/lib/squared';
-
-import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
-
-import type { ConnectionConfiguration, TYPES } from 'tedious';
-import type { DataType, ParameterData } from 'tedious/lib/data-type';
-
-import type { PoolConfig } from './pool';
-
-export interface MSSQLDataSource extends DbDataSource<string, unknown, unknown, MSSQLCredential, string | PoolConfig>, ExecuteAction<MSSQLRequestParameters | MSSQLRequestWithOutputParameters> {
-    source: "mssql";
-    storedProc?: boolean;
-}
-
-export interface MSSQLCredential extends ServerAuth, Omit<ConnectionConfiguration, "server"> {}
-
-export interface MSSQLRequestWithOutputParameters {
-    input?: MSSQLRequestParameters;
-    output?: MSSQLRequestParameters;
-}
-
-export interface MSSQLRequestParameterValue {
-    name?: string;
-    value?: unknown;
-    type?: DataType;
-    options?: ParameterData;
-}
-
-export type MSSQLRequestParameters = Null<MSSQLRequestParameterValue[] | ObjectMap<Omit<MSSQLRequestParameterValue, "name">>>;
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
+
+import type { ConnectionConfiguration, TYPES } from 'tedious';
+import type { DataType, ParameterData } from 'tedious/lib/data-type';
+
+import type { PoolConfig } from './pool';
+
+export interface MSSQLDataSource extends DbDataSource<string, unknown, unknown, MSSQLCredential, string | PoolConfig>, ExecuteAction<MSSQLRequestParameters | MSSQLRequestWithOutputParameters> {
+    source: "mssql";
+    storedProc?: boolean;
+}
+
+export interface MSSQLCredential extends ServerAuth, Omit<ConnectionConfiguration, "server"> {}
+
+export interface MSSQLRequestWithOutputParameters {
+    input?: MSSQLRequestParameters;
+    output?: MSSQLRequestParameters;
+}
+
+export interface MSSQLRequestParameterValue {
+    name?: string;
+    value?: unknown;
+    type?: DataType;
+    options?: ParameterData;
+}
+
+export type MSSQLRequestParameters = Null<MSSQLRequestParameterValue[] | ObjectMap<Omit<MSSQLRequestParameterValue, "name">>>;
 export type MSSQLDataType = keyof typeof TYPES;

package/types/pool.d.ts

@@ -1,69 +1,69 @@
-/* eslint @typescript-eslint/consistent-type-imports: "off" */
-
-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;
-    }
-}
-
+/* eslint @typescript-eslint/consistent-type-imports: "off" */
+
+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;