@e-mc/db 0.8.10 → 0.9.1

package/LICENSE

@@ -1,7 +1,11 @@
 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:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-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.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,7 +1,7 @@
 # @e-mc/db
 
-* NodeJS 14
-* ES2019
+* NodeJS 16
+* ES2020
 
 ## General Usage
 
@@ -9,15 +9,16 @@
 
 ## Interface
 
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/index.d.ts
+* [View Source](https://www.unpkg.com/@e-mc/types@0.9.1/lib/index.d.ts)
 
 ```typescript
 import type { DbDataSource } from "./squared";
 
 import type { IHost } from "./index";
 import type { ClientDbConstructor, IClientDb } from "./core";
-import type { DB_TYPE, SQL_COMMAND, BatchQueryResult, ExecuteBatchQueryOptions, ExecuteQueryOptions, HandleFailOptions, PoolConfig, ProcessRowsOptions, QueryResult } from "./db";
-import type { DbCoerceSettings, DbModule, DbSourceOptions } from "./settings";
+import type { BatchQueryResult, DB_TYPE, ErrorQueryCallback, ExecuteBatchQueryOptions, ExecuteQueryOptions, HandleFailOptions, ProcessRowsOptions, QueryResult, SQL_COMMAND } from "./db";
+import type { AuthValue } from "./http";
+import type { DbCoerceSettings, DbModule, DbSourceOptions, PoolConfig } from "./settings";
 
 import type { SecureContextOptions } from "tls";
 
@@ -26,8 +27,10 @@ interface IDb extends IClientDb<IHost, DbModule, DbDataSource, DbSourceOptions,
     getCredential(item: DbDataSource): Record<string | number | symbol, unknown>;
     hasSource(source: string, ...type: number[]): boolean;
     applyCommand(...items: DbDataSource[]): void;
+    executeQuery(item: V, callback: ErrorQueryCallback): Promise<QueryResult>;
     executeQuery(item: DbDataSource, sessionKey: string): Promise<QueryResult>;
     executeQuery(item: DbDataSource, options?: ExecuteQueryOptions | string): Promise<QueryResult>;
+    executeBatchQuery(batch: DbDataSource[], callback: ErrorQueryCallback, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
     executeBatchQuery(batch: DbDataSource[], sessionKey: string, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
     executeBatchQuery(batch: DbDataSource[], options?: ExecuteBatchQueryOptions | string, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
     processRows(batch: DbDataSource[], tasks: Promise<QueryResult | null>[], parallel: boolean): Promise<BatchQueryResult>;
@@ -92,14 +95,119 @@ interface DbPoolConstructor {
 }
 ```
 
+## Settings
+
+```typescript
+import type { DbSourceOptions, PurgeComponent } from "./settings";
+
+interface DbModule {
+    // handler: "@e-mc/db";
+    mariadb?: DbStoredCredentials;
+    mongodb?: DbStoredCredentials;
+    mssql?: DbStoredCredentials;
+    mysql?: DbStoredCredentials;
+    oracle?: DbStoredCredentials;
+    postgres?: DbStoredCredentials;
+    redis?: DbStoredCredentials;
+    settings?: {
+        broadcast_id?: string | string[];
+        users?: Record<string, Record<string, unknown>>;
+        cache_dir?: string;
+        session_expires?: number;
+        user_key?: Record<string, DbSourceOptions>;
+        imports?: StringMap;
+        purge?: PurgeComponent;
+        mariadb?: DbSourceOptions;
+        mongodb?: DbSourceOptions;
+        mssql?: DbSourceOptions;
+        mysql?: DbSourceOptions;
+        oracle?: DbSourceOptions;
+        postgres?: DbSourceOptions;
+        redis?: DbSourceOptions;
+    };
+}
+
+type DbStoredCredentials = Record<string, Record<string, unknown>>;
+```
+
+### Example usage
+
+```javascript
+const Db = require("@e-mc/db"); // Using @pi-r/mongodb
+
+const instance = new Db({
+    mongodb: {
+        main: {
+            server: "localhost:27017",
+            auth: {
+                username: "**********",
+                password: "**********"
+            },
+            authMechanism: "SCRAM-SHA-1"
+        }
+    },
+    settings: {
+        mongodb: {
+            pool: {
+                max: 10,
+                idle: 60 * 1000,
+                queue_max: 4,
+                queue_idle: 30 * 1000,
+                timeout: 10 * 1000
+            },
+            cache: {
+                timeout: "1d",
+                when_empty: false
+            },
+            coerce: {
+                credential: false,
+                options: true
+            }
+        }
+    }
+});
+// instance.host = new Host();
+instance.init();
+
+const item = {
+    source: "mongodb",
+    credential: "main",
+    table: "demo",
+    name: "nodejs",
+    query: {
+        id: {
+            "$eq": "1"
+        }
+    },
+    willAbort: true
+};
+await instance.setCredential(item);
+
+const rows = await instance.executeQuery(item, (err, item) => {
+    if (err.code === "E11000") {
+        return true; // throw err;
+    }
+    return false; // return [];
+});
+
+const [rows1, rows2] = await instance.executeBatchQuery([
+        { ...item, usePool: true },
+        { ...item, query: { id: { "$eq": "2" } } }
+    ],
+    { parallel: true, connectOnce: true }
+);
+```
+
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/db.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/object.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/http.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/settings.d.ts
+
+* https://www.npmjs.com/package/@types/node
 
 ## LICENSE
 
-MIT
+BSD 3-Clause

package/index.js

@@ -1,5 +1,4 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
 const types_1 = require("@e-mc/types");
 const core_1 = require("@e-mc/core");
@@ -8,15 +7,14 @@ const util_1 = require("@e-mc/db/util");
 const DB_CLIENT = new Map();
 const POOL_CONFIG = new Map();
 function sanitizePoolConfig(value) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    (_a = value.min) !== null && _a !== void 0 ? _a : (value.min = -1);
-    (_b = value.max) !== null && _b !== void 0 ? _b : (value.max = -1);
-    (_c = value.idle) !== null && _c !== void 0 ? _c : (value.idle = -1);
-    (_d = value.queue_max) !== null && _d !== void 0 ? _d : (value.queue_max = -1);
-    (_e = value.queue_idle) !== null && _e !== void 0 ? _e : (value.queue_idle = -1);
-    (_f = value.purge) !== null && _f !== void 0 ? _f : (value.purge = 0);
-    (_g = value.timeout) !== null && _g !== void 0 ? _g : (value.timeout = -1);
-    (_h = value.socket_timeout) !== null && _h !== void 0 ? _h : (value.socket_timeout = -1);
+    value.min ?? (value.min = -1);
+    value.max ?? (value.max = -1);
+    value.idle ?? (value.idle = -1);
+    value.queue_max ?? (value.queue_max = -1);
+    value.queue_idle ?? (value.queue_idle = -1);
+    value.purge ?? (value.purge = 0);
+    value.timeout ?? (value.timeout = -1);
+    value.socket_timeout ?? (value.socket_timeout = -1);
     return value;
 }
 function setCert(items, cache) {
@@ -34,13 +32,12 @@ class Db extends core_1.ClientDb {
         this._threadable = true;
     }
     static async purgeMemory(percent = 1, limit = 0, parent) {
-        var _a, _b;
         let result = 0;
         if (percent > 0 && percent <= 1) {
             for (const [name, client] of DB_CLIENT) {
-                const purge = ((_a = POOL_CONFIG.get(name)) === null || _a === void 0 ? void 0 : _a.purge) || 0;
+                const purge = POOL_CONFIG.get(name)?.purge || 0;
                 if (purge > 0) {
-                    const checkTimeout = (_b = client.checkTimeout) === null || _b === void 0 ? void 0 : _b.bind(client);
+                    const checkTimeout = client.checkTimeout?.bind(client);
                     if (checkTimeout) {
                         try {
                             result += await checkTimeout(purge, limit);
@@ -73,10 +70,9 @@ class Db extends core_1.ClientDb {
         }
     }
     getCredential(item) {
-        var _a;
         let credential = item.credential, stored;
         if (typeof credential === 'string') {
-            credential = (_a = this.module[item.source]) === null || _a === void 0 ? void 0 : _a[credential];
+            credential = this.module[item.source]?.[credential];
             stored = true;
         }
         if ((0, types_1.isPlainObject)(credential)) {
@@ -97,7 +93,6 @@ class Db extends core_1.ClientDb {
         }
     }
     applyCommand(...items) {
-        var _a, _b, _c;
         let settings;
         for (let i = 0, length = items.length; i < length; ++i) {
             const item = items[i];
@@ -105,12 +100,12 @@ class Db extends core_1.ClientDb {
             if (!command) {
                 continue;
             }
-            if (!settings && !(0, types_1.isPlainObject)(settings = (_b = (_a = this.getUserSettings()) === null || _a === void 0 ? void 0 : _a[item.source]) === null || _b === void 0 ? void 0 : _b.commands)) {
+            if (!settings && !(0, types_1.isPlainObject)(settings = this.getUserSettings()?.[item.source]?.commands)) {
                 return;
             }
             let name, table;
             const [group, procedure] = Array.isArray(command) ? command : ({ name, table } = item, [(name || table ? name && table ? name + ':' + table : table || name : typeof item.document === 'string' && item.document) || '', command]);
-            const data = (_c = settings[group]) === null || _c === void 0 ? void 0 : _c[procedure];
+            const data = settings[group]?.[procedure];
             if (!(0, types_1.isPlainObject)(data)) {
                 continue;
             }
@@ -128,7 +123,10 @@ class Db extends core_1.ClientDb {
     }
     async executeQuery(item, options) {
         if (this.aborted) {
-            return Promise.reject((0, types_1.createAbortError)());
+            return (0, types_1.createAbortError)(true);
+        }
+        if (typeof options === 'function') {
+            options = { errorQuery: options };
         }
         try {
             return this.getClient(item.source).executeQuery.call(this, item, options);
@@ -139,7 +137,10 @@ class Db extends core_1.ClientDb {
     }
     async executeBatchQuery(batch, options, outResult) {
         if (this.aborted) {
-            return Promise.reject((0, types_1.createAbortError)());
+            return (0, types_1.createAbortError)(true);
+        }
+        if (typeof options === 'function') {
+            options = { errorQuery: options };
         }
         try {
             return this.getClient(batch[0].source).executeBatchQuery.call(this, batch, options, outResult);
@@ -215,11 +216,10 @@ class Db extends core_1.ClientDb {
     }
     async commit(items) {
         if (this.aborted) {
-            return Promise.reject((0, types_1.createAbortError)());
+            return (0, types_1.createAbortError)(true);
         }
         const tasks = (items || this.pending).map(async (data) => {
-            var _a;
-            (_a = data.ignoreCache) !== null && _a !== void 0 ? _a : (data.ignoreCache = true);
+            data.ignoreCache ?? (data.ignoreCache = true);
             return this.executeQuery(data).catch(() => {
                 this.applyState([data], 16);
                 return [];
@@ -230,11 +230,11 @@ class Db extends core_1.ClientDb {
     readTLSCert(value, cache) {
         if ((0, types_1.isString)(value)) {
             let pathname = value.trim();
-            if (request_1.default.isCert(pathname)) {
+            if (request_1.isCert(pathname)) {
                 return pathname;
             }
             if (Db.isPath(pathname = path.resolve(pathname)) && this.canRead(pathname, { ownPermissionOnly: true })) {
-                return request_1.default.readCACert(pathname, cache);
+                return request_1.readCACert(pathname, cache);
             }
         }
         return '';
@@ -259,10 +259,9 @@ class Db extends core_1.ClientDb {
         }
     }
     resolveSource(source, folder) {
-        var _a;
         let result;
         if (!source.startsWith('@')) {
-            result = ((_a = this.settings.imports) === null || _a === void 0 ? void 0 : _a[source]) || util_1.IMPORTS[source];
+            result = this.settings.imports?.[source] || util_1.IMPORTS[source];
         }
         else if (!folder && !source.includes('/')) {
             folder = 'client';
@@ -270,18 +269,17 @@ class Db extends core_1.ClientDb {
         return (result || source) + (folder ? '/' + folder : '');
     }
     getPoolConfig(source, uuidKey) {
-        var _a, _b, _c, _d, _e, _f, _g;
         const config = Db.getPoolConfig(source);
         const result = uuidKey && this.settingsKey(uuidKey, 'pool');
         if (result) {
             if (config) {
-                (_a = result.min) !== null && _a !== void 0 ? _a : (result.min = config.min);
-                (_b = result.max) !== null && _b !== void 0 ? _b : (result.max = config.max);
-                (_c = result.idle) !== null && _c !== void 0 ? _c : (result.idle = config.idle);
-                (_d = result.queue_max) !== null && _d !== void 0 ? _d : (result.queue_max = config.queue_max);
-                (_e = result.queue_idle) !== null && _e !== void 0 ? _e : (result.queue_idle = config.queue_idle);
-                (_f = result.timeout) !== null && _f !== void 0 ? _f : (result.timeout = config.timeout);
-                (_g = result.socket_timeout) !== null && _g !== void 0 ? _g : (result.socket_timeout = config.socket_timeout);
+                result.min ?? (result.min = config.min);
+                result.max ?? (result.max = config.max);
+                result.idle ?? (result.idle = config.idle);
+                result.queue_max ?? (result.queue_max = config.queue_max);
+                result.queue_idle ?? (result.queue_idle = config.queue_idle);
+                result.timeout ?? (result.timeout = config.timeout);
+                result.socket_timeout ?? (result.socket_timeout = config.socket_timeout);
             }
             else {
                 sanitizePoolConfig(result);
@@ -303,7 +301,7 @@ class Db extends core_1.ClientDb {
         }
         try {
             client = require(this.resolveSource(source));
-            if (client === null || client === void 0 ? void 0 : client.DB_SOURCE_CLIENT) {
+            if (client?.DB_SOURCE_CLIENT) {
                 client.DB_SOURCE_NAME = source;
                 DB_CLIENT.set(source, client);
                 return client;
@@ -318,9 +316,5 @@ Db.STORE_RESULT_PARTITION_SIZE = 16;
 Db.STORE_RESULT_PARTITION_MULT = 2;
 Object.freeze(types_1.DB_TYPE);
 Object.freeze(util_1.SQL_COMMAND);
-exports.default = Db;
 
-if (exports.default) {
-    module.exports = exports.default;
-    module.exports.default = exports.default;
-}
+module.exports = Db;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/db",
-  "version": "0.8.10",
+  "version": "0.9.1",
   "description": "DB modules for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,11 +17,11 @@
     "squared-functions"
   ],
   "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
+  "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.8.10",
-    "@e-mc/request": "0.8.10",
-    "@e-mc/types": "0.8.10"
+    "@e-mc/core": "0.9.1",
+    "@e-mc/request": "0.9.1",
+    "@e-mc/types": "0.9.1"
   }
 }

package/pool.js

@@ -1,6 +1,5 @@
 "use strict";
 var _a, _b, _c;
-Object.defineProperty(exports, "__esModule", { value: true });
 const types_1 = require("@e-mc/types");
 const util_1 = require("@e-mc/db/util");
 const kItems = Symbol('items');
@@ -30,17 +29,15 @@ class DbPool {
     }
     static validateKey(pools, username, uuidKey) {
         if ((0, types_1.validateUUID)(uuidKey)) {
-            if ((0, types_1.isString)(username)) {
-                for (const key in pools) {
-                    const pool = pools[key];
-                    const auth = pool.uuidKey;
-                    if ((auth === null || auth === void 0 ? void 0 : auth.username) === username && auth.password === uuidKey) {
-                        if (!pool.closed) {
-                            return [uuidKey, pool];
-                        }
-                        delete pools[key];
-                        break;
+            for (const key in pools) {
+                const pool = pools[key];
+                const auth = pool.uuidKey;
+                if (auth?.username === username && auth.password === uuidKey) {
+                    if (!pool.closed) {
+                        return [uuidKey, pool];
                     }
+                    delete pools[key];
+                    break;
                 }
             }
             return [uuidKey, null];
@@ -72,9 +69,8 @@ class DbPool {
         this[_c] = { success: -1, failed: -1, count: 0, error: 0 };
     }
     add(item, uuidKey) {
-        var _d;
         this[kItems].add(item);
-        if (uuidKey || (uuidKey = (_d = this.uuidKey) === null || _d === void 0 ? void 0 : _d.password)) {
+        if (uuidKey || (uuidKey = this.uuidKey?.password)) {
             (0, util_1.setUUIDKey)(item, uuidKey);
         }
         this.lastAccessed = Date.now();
@@ -140,9 +136,5 @@ class DbPool {
     }
 }
 _a = kItems, _b = kParent, _c = kIdlePrevious;
-exports.default = DbPool;
 
-if (exports.default) {
-    module.exports = exports.default;
-    module.exports.default = exports.default;
-}
+module.exports = DbPool;

package/util.d.ts

@@ -1,6 +1,7 @@
 import type { DbDataSource } from '../types/lib/squared';
 
 import type { DbConnection, SQL_COMMAND, ServerAuth } from '../types/lib/db';
+import type { AuthValue } from '../types/lib/http';
 
 declare namespace util {
     const SQL_COMMAND: SQL_COMMAND;

package/util.js

@@ -1,5 +1,4 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasBasicAuth = exports.getBasicAuth = exports.setUUIDKey = exports.checkEmpty = exports.parseConnectionString = exports.parseServerAuth = exports.IMPORTS = exports.SQL_COMMAND = void 0;
 const types_1 = require("@e-mc/types");
 const util_1 = require("@e-mc/request/util");
@@ -86,14 +85,13 @@ function parseServerAuth(credential, port, all) {
 }
 exports.parseServerAuth = parseServerAuth;
 function parseConnectionString(value, scheme = 'http') {
-    var _a;
     if (!/^[^:]+:\/\//.test(value)) {
         value = scheme + '://' + value;
     }
     try {
         const { protocol, username, password, hostname, pathname, port, search } = new URL(value);
         const database = pathname.substring(1);
-        return { protocol, username: decodeURIComponent(username), password: decodeURIComponent(password), hostname, port, database: decodeURIComponent(((_a = /^([^?/#]+)/.exec(database)) === null || _a === void 0 ? void 0 : _a[1]) || database), pathname, search };
+        return { protocol, username: decodeURIComponent(username), password: decodeURIComponent(password), hostname, port, database: decodeURIComponent(/^([^?/#]+)/.exec(database)?.[1] || database), pathname, search };
     }
     catch {
         return null;