@e-mc/db 0.13.9 → 0.14.0

package/README.md

@@ -1,6 +1,6 @@
 # @e-mc/db
 
-* NodeJS 18.20 LTS
+* NodeJS 20 (Minimum 18)
 * ES2022
 
 ## General Usage
@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.13.9/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.14.0/lib/index.d.ts)
 
 ```typescript
 import type { DbDataSource } from "./squared";
@@ -18,7 +18,7 @@ import type { IHost } from "./index";
 import type { ClientDbConstructor, IClientDb } from "./core";
 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 { DbCoerceSettings, DbModule, DbSettings, DbSourceOptions, PoolConfig } from "./settings";
 
 import type { SecureContextOptions } from "node:tls";
 
@@ -56,6 +56,8 @@ interface IDb extends IClientDb<IHost, DbModule, DbDataSource, DbSourceOptions,
 }
 
 interface DbConstructor extends ClientDbConstructor<IHost> {
+    readonly HASH_ALGORITHM: string;
+    loadSettings(settings: Settings & { db?: DbSettings }, password?: string): boolean;
     setPoolConfig(value: Record<string, PoolConfig>): void;
     getPoolConfig(source: string): Required<PoolConfig> | undefined;
     readonly prototype: IDb;
@@ -126,7 +128,10 @@ interface DbModule {
     settings?: {
         broadcast_id?: string | string[];
         users?: Record<string, Record<string, unknown>>;
-        cache_dir?: string;
+        cache?: {
+            dir?: string;
+            algorithm?: string;
+        };
         session_expires?: number;
         user_key?: Record<string, DbSourceOptions>;
         imports?: StringMap;
@@ -214,11 +219,11 @@ const [rows1, rows2] = await instance.executeBatchQuery([
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.13.9/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.9/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.9/lib/db.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.9/lib/http.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.9/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.14.0/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.14.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.14.0/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.14.0/lib/http.d.ts
+- https://www.unpkg.com/@e-mc/types@0.14.0/lib/settings.d.ts
 
 * https://www.npmjs.com/package/@types/node
 

package/index.js

@@ -1,12 +1,14 @@
 "use strict";
-const path = require("node:path");
-const types_1 = require("@e-mc/types");
-const core_1 = require("@e-mc/core");
-const request_1 = require("@e-mc/request");
-const util_1 = require("@e-mc/db/util");
+
+const path = require('node:path');
+const { DB_TYPE, IMPORT_MAP, coerceObject, createAbortError, errorMessage, getAlgorithm, isArray, isError, isObject, isPlainObject, isString } = require('@e-mc/types');
+const { ClientDb } = require('@e-mc/core');
+const Request = require('@e-mc/request');
+const { SQL_COMMAND } = require('@e-mc/db/util');
 const kDb = Symbol.for('db:constructor');
 const DB_CLIENT = new Map();
 const POOL_CONFIG = new Map();
+let HASH_ALGORITHM = 'sha256';
 function sanitizePoolConfig(value) {
     value.min ??= -1;
     value.max ??= -1;
@@ -20,10 +22,23 @@ function sanitizePoolConfig(value) {
     value.socket_timeout ??= -1;
     return value;
 }
-class Db extends core_1.ClientDb {
+class Db extends ClientDb {
     static [kDb] = true;
     static STORE_RESULT_PARTITION_SIZE = 16;
     static STORE_RESULT_PARTITION_MULT = 2;
+    static get HASH_ALGORITHM() {
+        return HASH_ALGORITHM;
+    }
+    static loadSettings(settings, password) {
+        if (this.enabled("process.password") && !super.loadSettings({ process: settings.process }, password)) {
+            return false;
+        }
+        const algorithm = getAlgorithm(settings.db?.cache?.algorithm);
+        if (algorithm) {
+            HASH_ALGORITHM = algorithm;
+        }
+        return true;
+    }
     static async purgeMemory(percent = 1, limit = 0, parent) {
         let result = 0;
         if (percent > 0 && percent <= 1) {
@@ -46,7 +61,7 @@ class Db extends core_1.ClientDb {
     static setPoolConfig(value) {
         for (const name in value) {
             const source = value[name];
-            if ((0, types_1.isPlainObject)(source)) {
+            if (isPlainObject(source)) {
                 POOL_CONFIG.set(name, sanitizePoolConfig(source));
             }
         }
@@ -61,7 +76,7 @@ class Db extends core_1.ClientDb {
             return this.getClient(item.source).setCredential.call(this, item);
         }
         catch (err) {
-            if (err instanceof Error) {
+            if (isError(err)) {
                 throw err;
             }
             throw new Error("Invalid credentials", { cause: err });
@@ -73,9 +88,9 @@ class Db extends core_1.ClientDb {
             credential = this.module[item.source]?.[credential];
             stored = true;
         }
-        if ((0, types_1.isPlainObject)(credential)) {
+        if (isPlainObject(credential)) {
             if (this.settingsOf(item.source, 'coerce', 'credential') === true) {
-                (0, types_1.coerceObject)(credential, stored);
+                coerceObject(credential, stored);
             }
             return stored ? item.credential = { ...credential } : credential;
         }
@@ -96,13 +111,13 @@ class Db extends core_1.ClientDb {
             const item = items[i];
             const command = item.withCommand;
             if (command) {
-                if (!settings && !(0, types_1.isPlainObject)(settings = this.getUserSettings()?.[item.source]?.commands)) {
+                if (!settings && !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 = settings[group]?.[procedure];
-                if ((0, types_1.isPlainObject)(data)) {
+                if (isPlainObject(data)) {
                     if ('uri' in data) {
                         delete data.uri;
                     }
@@ -119,7 +134,7 @@ class Db extends core_1.ClientDb {
     }
     async executeQuery(item, options) {
         if (this.aborted) {
-            return (0, types_1.createAbortError)(true);
+            return createAbortError(true);
         }
         if (typeof options === 'function') {
             options = { errorQuery: options };
@@ -128,7 +143,7 @@ class Db extends core_1.ClientDb {
     }
     async executeBatchQuery(batch, options, outResult) {
         if (this.aborted) {
-            return (0, types_1.createAbortError)(true);
+            return createAbortError(true);
         }
         if (typeof options === 'function') {
             options = { errorQuery: options };
@@ -137,7 +152,7 @@ class Db extends core_1.ClientDb {
     }
     async processRows(batch, tasks, parallel, outResult) {
         let disconnect;
-        if ((0, types_1.isObject)(parallel)) {
+        if (isObject(parallel)) {
             ({ disconnect, parallel } = parallel);
         }
         const terminate = () => {
@@ -213,7 +228,7 @@ class Db extends core_1.ClientDb {
     }
     async commit(items) {
         if (this.aborted) {
-            return (0, types_1.createAbortError)(true);
+            return createAbortError(true);
         }
         const tasks = (items || this.pending).map(async (data) => {
             data.ignoreCache ??= true;
@@ -225,32 +240,32 @@ class Db extends core_1.ClientDb {
         return tasks.length === 0 ? false : this.allSettled(tasks, ["Execute unassigned queries", this.moduleName]).then(result => result.length > 0).catch(() => false);
     }
     readTLSCert(value, cache) {
-        if ((0, types_1.isString)(value)) {
-            if (request_1.isCert(value)) {
+        if (isString(value)) {
+            if (Request.isCert(value)) {
                 return value.trim();
             }
             const pathname = path.resolve(value);
             if (Db.isPath(pathname) && this.canRead(pathname, { ownPermissionOnly: true })) {
-                return request_1.readCACert(pathname, cache);
+                return Request.readCACert(pathname, cache);
             }
         }
         return '';
     }
     readTLSConfig(options, cache = true) {
-        if ((0, types_1.isPlainObject)(options)) {
+        if (isPlainObject(options)) {
             const { ca, cert, key } = options;
             if (ca) {
-                options.ca = this.#checkCert(ca);
+                options.ca = this.#checkTLSCert(ca);
             }
             if (cert) {
-                options.cert = this.#checkCert(cert);
+                options.cert = this.#checkTLSCert(cert);
             }
             if (key) {
-                if ((0, types_1.isString)(key)) {
+                if (isString(key)) {
                     options.key = this.readTLSCert(key, cache);
                 }
-                else if ((0, types_1.isArray)(key)) {
-                    options.key = key.map(item => (0, types_1.isString)(item) ? { pem: this.readTLSCert(item, cache) } : Buffer.isBuffer(item) ? { pem: item.toString('utf8') } : item).filter(item => item.pem);
+                else if (isArray(key)) {
+                    options.key = key.map(item => isString(item) ? { pem: this.readTLSCert(item, cache) } : Buffer.isBuffer(item) ? { pem: item.toString('utf8') } : item).filter(item => item.pem);
                 }
             }
         }
@@ -258,7 +273,7 @@ class Db extends core_1.ClientDb {
     resolveSource(source, folder) {
         let result;
         if (!source.startsWith('@')) {
-            result = this.settings.imports?.[source] || types_1.IMPORT_MAP[source];
+            result = this.settings.imports?.[source] || IMPORT_MAP[source];
         }
         else if (!folder && !source.includes('/')) {
             folder = 'client';
@@ -302,23 +317,24 @@ class Db extends core_1.ClientDb {
         }
         catch {
         }
-        throw (0, types_1.errorMessage)(source, "Database provider not found");
+        throw errorMessage(source, "Database provider not found");
     }
-    #checkCert(items, cache) {
+    #checkTLSCert(items, cache) {
         if (Array.isArray(items)) {
-            return items.map(cert => (0, types_1.isString)(cert) ? this.readTLSCert(cert, cache) : Buffer.isBuffer(cert) ? cert : null).filter(cert => cert);
+            return items.map(cert => isString(cert) ? this.readTLSCert(cert, cache) : Buffer.isBuffer(cert) ? cert : null).filter(cert => cert);
         }
-        if ((0, types_1.isString)(items)) {
+        if (isString(items)) {
             return this.readTLSCert(items, cache);
         }
     }
     get sourceType() {
-        return types_1.DB_TYPE;
+        return DB_TYPE;
     }
     get commandType() {
-        return util_1.SQL_COMMAND;
+        return SQL_COMMAND;
     }
 }
-Object.freeze(types_1.DB_TYPE);
-Object.freeze(util_1.SQL_COMMAND);
+Object.freeze(DB_TYPE);
+Object.freeze(SQL_COMMAND);
+
 module.exports = Db;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/db",
-  "version": "0.13.9",
+  "version": "0.14.0",
   "description": "DB modules for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -19,8 +19,8 @@
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.13.9",
-    "@e-mc/request": "0.13.9",
-    "@e-mc/types": "0.13.9"
+    "@e-mc/core": "0.14.0",
+    "@e-mc/request": "0.14.0",
+    "@e-mc/types": "0.14.0"
   }
 }

package/pool.js

@@ -1,7 +1,8 @@
 "use strict";
-const crypto = require("node:crypto");
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/db/util");
+
+const { randomUUID } = require('node:crypto');
+const { validateUUID } = require('@e-mc/types');
+const { setUUIDKey } = require('@e-mc/db/util');
 class DbPool {
     client;
     poolKey;
@@ -9,7 +10,7 @@ class DbPool {
     static CACHE_UNUSED = [];
     static CACHE_IGNORE = [];
     static asString(credential) {
-        return crypto.randomUUID();
+        return randomUUID();
     }
     static canCache(credential) {
         if (credential.uuidKey) {
@@ -64,7 +65,7 @@ class DbPool {
         return null;
     }
     static validateKey(pools, username, uuidKey) {
-        if ((0, types_1.validateUUID)(uuidKey)) {
+        if (validateUUID(uuidKey)) {
             for (const key in pools) {
                 const pool = pools[key];
                 const auth = pool.uuidKey;
@@ -107,7 +108,7 @@ class DbPool {
     add(item, uuidKey) {
         this.#items.add(item);
         if (uuidKey ||= this.uuidKey?.password) {
-            (0, util_1.setUUIDKey)(item, uuidKey);
+            setUUIDKey(item, uuidKey);
         }
         this.lastAccessed = Date.now();
         return this;
@@ -171,4 +172,5 @@ class DbPool {
         this.#parent = value;
     }
 }
+
 module.exports = DbPool;

package/util.js

@@ -1,20 +1,14 @@
 "use strict";
-exports.hasBasicAuth = exports.getBasicAuth = exports.SQL_COMMAND = void 0;
-exports.parseServerAuth = parseServerAuth;
-exports.parseConnectionString = parseConnectionString;
-exports.checkEmpty = checkEmpty;
-exports.setUUIDKey = setUUIDKey;
-const types_1 = require("@e-mc/types");
-const util_1 = require("@e-mc/request/util");
-Object.defineProperty(exports, "getBasicAuth", { enumerable: true, get: function () { return util_1.getBasicAuth; } });
-Object.defineProperty(exports, "hasBasicAuth", { enumerable: true, get: function () { return util_1.hasBasicAuth; } });
-var SQL_COMMAND;
+
+const { isObject, isPlainObject, isString } = require('@e-mc/types');
+const { getBasicAuth, hasBasicAuth } = require('@e-mc/request/util');
+exports.SQL_COMMAND = void 0;
 (function (SQL_COMMAND) {
     SQL_COMMAND[SQL_COMMAND["SELECT"] = 1] = "SELECT";
     SQL_COMMAND[SQL_COMMAND["INSERT"] = 2] = "INSERT";
     SQL_COMMAND[SQL_COMMAND["UPDATE"] = 3] = "UPDATE";
     SQL_COMMAND[SQL_COMMAND["DELETE"] = 4] = "DELETE";
-})(SQL_COMMAND || (exports.SQL_COMMAND = SQL_COMMAND = {}));
+})(exports.SQL_COMMAND || (exports.SQL_COMMAND = {}));
 function parseServerAuth(credential, port, all) {
     if (typeof port === 'boolean') {
         all = port;
@@ -84,7 +78,7 @@ function parseConnectionString(value, scheme = 'http') {
     }
     try {
         const { protocol, username, password, hostname, pathname, port, search } = new URL(value);
-        const database = pathname.substring(1);
+        const database = pathname.slice(1);
         return { protocol, username: decodeURIComponent(username), password: decodeURIComponent(password), hostname, port, database: decodeURIComponent(/^([^?/#]+)/.exec(database)?.[1] || database), pathname, search };
     }
     catch {
@@ -92,13 +86,20 @@ function parseConnectionString(value, scheme = 'http') {
     }
 }
 function checkEmpty(value) {
-    return value === undefined || value === null ? false : value === 0 || (value instanceof Set || value instanceof Map ? value.size === 0 : (Array.isArray(value) || (0, types_1.isObject)(value)) && value.length === 0);
+    return value === undefined || value === null ? false : value === 0 || (value instanceof Set || value instanceof Map ? value.size === 0 : (Array.isArray(value) || isObject(value)) && value.length === 0);
 }
 function setUUIDKey(item, value) {
-    if ((0, types_1.isString)(value)) {
-        if (!(0, types_1.isPlainObject)(item.credential)) {
+    if (isString(value)) {
+        if (!isPlainObject(item.credential)) {
             item.credential = {};
         }
         item.credential.uuidKey ||= value;
     }
 }
+
+exports.checkEmpty = checkEmpty;
+exports.getBasicAuth = getBasicAuth;
+exports.hasBasicAuth = hasBasicAuth;
+exports.parseConnectionString = parseConnectionString;
+exports.parseServerAuth = parseServerAuth;
+exports.setUUIDKey = setUUIDKey;