@e-mc/db 0.8.5 → 0.8.7

package/LICENSE

@@ -1,7 +1,11 @@
-Copyright 2024 Mile Square Park
+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,105 @@
 # @e-mc/db
 
-PEP 402
+* NodeJS 14
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.7/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 { SecureContextOptions } from "tls";
+
+interface IDb extends IClientDb<IHost, DbModule, DbDataSource, DbSourceOptions, DbCoerceSettings> {
+    setCredential(item: DbDataSource): Promise<void>;
+    getCredential(item: DbDataSource): Record<string | number | symbol, unknown>;
+    hasSource(source: string, ...type: number[]): boolean;
+    applyCommand(...items: DbDataSource[]): void;
+    executeQuery(item: DbDataSource, sessionKey: string): Promise<QueryResult>;
+    executeQuery(item: DbDataSource, options?: ExecuteQueryOptions | string): Promise<QueryResult>;
+    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>;
+    processRows(batch: DbDataSource[], tasks: Promise<QueryResult | null>[], options?: ProcessRowsOptions, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
+    handleFail(err: unknown, item: DbDataSource, options?: HandleFailOptions): boolean;
+    readTLSCert(value: unknown, cache?: boolean): string;
+    readTLSConfig(options: SecureContextOptions, cache?: boolean): void;
+    settingsOf(source: string, name: keyof Omit<DbSourceOptions, "coerce">): unknown;
+    settingsOf(source: string, name: "coerce", component: keyof DbCoerceSettings): unknown;
+    settingsKey(source: string, name: keyof Omit<DbSourceOptions, "coerce">): unknown;
+    settingsKey(source: string, name: "coerce", component: keyof DbCoerceSettings): unknown;
+    getPoolConfig(source: string, uuidKey?: string): Required<PoolConfig> | undefined;
+    get sourceType(): DB_TYPE;
+    get commandType(): SQL_COMMAND;
+}
+
+interface DbConstructor extends ClientDbConstructor<IHost> {
+    setPoolConfig(value: Record<string, PoolConfig>): void;
+    getPoolConfig(source: string): Required<PoolConfig> | undefined;
+    readonly prototype: IDb;
+    new(module?: DbModule, database?: DbDataSource[], ...args: unknown[]): IDb;
+}
+
+interface IDbSourceClient {
+    DB_SOURCE_NAME: string;
+    DB_SOURCE_CLIENT: boolean;
+    DB_SOURCE_TYPE: number;
+    setCredential(this: IDb, item: DbDataSource): Promise<void>;
+    executeQuery(this: IDb, item: DbDataSource, options?: ExecuteQueryOptions | string): Promise<QueryResult>;
+    executeBatchQuery(this: IDb, batch: DbDataSource[], options?: ExecuteBatchQueryOptions | string, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
+    checkTimeout?(this: IDbSourceClient, value: number, limit?: number): Promise<number>;
+}
+
+interface IDbPool {
+    client: unknown;
+    lastAccessed: number;
+    success: number;
+    failed: number;
+    poolKey: string;
+    uuidKey: AuthValue | null;
+    add(item: DbDataSource, uuidKey?: string): this;
+    has(item: DbDataSource): boolean;
+    getConnection(): Promise<unknown>;
+    remove(): void;
+    detach(force?: boolean): Promise<void>;
+    close(): Promise<void>;
+    isIdle(timeout: number): boolean;
+    isEmpty(): boolean;
+    set connected(value: boolean);
+    get persist(): boolean;
+    get closed(): boolean;
+    get closeable(): boolean;
+    set parent(value: Record<string, IDbPool>);
+}
+
+interface DbPoolConstructor {
+    findKey(pools: Record<string, IDbPool>, uuidKey: unknown, poolKey: string | undefined, ...items: DbDataSource[]): Record<string, IDbPool> | null;
+    validateKey(pools: Record<string, IDbPool>, username: string, uuidKey: unknown): [string, Record<string, IDbPool> | null];
+    checkTimeout(pools: Record<string, IDbPool>, value: number, limit?: number): Promise<number>;
+    readonly prototype: IDbPool;
+    new(pool: unknown, poolKey: string, uuidKey?: AuthValue | null): IDbPool;
+}
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/object.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/settings.d.ts
 
 ## LICENSE
 
-MIT
+BSD 3-Clause

package/index.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
-const types_1 = require("../types");
-const core_1 = require("../core");
-const request_1 = require("../request");
-const util_1 = require("./util");
+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 DB_CLIENT = new Map();
 const POOL_CONFIG = new Map();
 function sanitizePoolConfig(value) {
@@ -67,7 +67,7 @@ class Db extends core_1.ClientDb {
             return this.getClient(item.source).setCredential.call(this, item);
         }
         catch (err) {
-            return Promise.reject(err instanceof Error ? err : new Error(Db.asString(err) || "Invalid credentials" /* ERR_DB.CREDENTIALS */));
+            return Promise.reject(err instanceof Error ? err : new Error(Db.asString(err) || "Invalid credentials"));
         }
     }
     getCredential(item) {
@@ -150,7 +150,7 @@ class Db extends core_1.ClientDb {
             ({ disconnect, parallel } = parallel);
         }
         const terminate = () => {
-            this.applyState(batch, 8 /* DB_TRANSACTION.TERMINATE */);
+            this.applyState(batch, 8);
             if (typeof disconnect === 'function') {
                 try {
                     disconnect();
@@ -160,7 +160,7 @@ class Db extends core_1.ClientDb {
             }
         };
         const cleanup = () => {
-            this.applyState(batch, 16 /* DB_TRANSACTION.ABORT */);
+            this.applyState(batch, 16);
             terminate();
             if (outResult) {
                 for (let i = 0, length = outResult.length; i < length; ++i) {
@@ -191,7 +191,7 @@ class Db extends core_1.ClientDb {
             .catch(() => cleanup());
     }
     handleFail(err, item, options) {
-        this.add(item, 32 /* DB_TRANSACTION.FAIL */);
+        this.add(item, 32);
         item.transactionFail = true;
         if (options && typeof options.errorQuery === 'function') {
             if (options.errorQuery(err, item, options.commandType)) {
@@ -205,7 +205,7 @@ class Db extends core_1.ClientDb {
             if (item.willAbort) {
                 this.abort(err);
             }
-            this.writeFail(["Unable to execute query" /* ERR_DB.EXEC_QUERY */, item.source], err, 65536 /* LOG_TYPE.DB */);
+            this.writeFail(["Unable to execute query", item.source], err, 65536);
         }
         return false;
     }
@@ -216,11 +216,11 @@ class Db extends core_1.ClientDb {
         const tasks = (items || this.pending).map(async (data) => {
             data.ignoreCache ?? (data.ignoreCache = true);
             return this.executeQuery(data).catch(() => {
-                this.applyState([data], 16 /* DB_TRANSACTION.ABORT */);
+                this.applyState([data], 16);
                 return [];
             });
         });
-        return tasks.length === 0 ? false : this.allSettled(tasks, ["Execute unassigned queries" /* VAL_DB.EXEC_QUERYUNASSIGNED */, this.moduleName]).then(result => result.length > 0).catch(() => false);
+        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)) {
@@ -304,11 +304,11 @@ class Db extends core_1.ClientDb {
         }
         catch {
         }
-        throw (0, types_1.errorMessage)(source, "Database provider not found" /* ERR_DB.PROVIDER_NOTFOUND */);
+        throw (0, types_1.errorMessage)(source, "Database provider not found");
     }
 }
-Db.STORE_RESULT_PARTITION_SIZE = 16 /* CACHE_SIZE.DB_PARTITION_SIZE */;
-Db.STORE_RESULT_PARTITION_MULT = 2 /* CACHE_SIZE.DB_PARTITION_MULT */;
+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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/db",
-  "version": "0.8.5",
+  "version": "0.8.7",
   "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.5",
-    "@e-mc/request": "0.8.5",
-    "@e-mc/types": "0.8.5"
+    "@e-mc/core": "0.8.7",
+    "@e-mc/request": "0.8.7",
+    "@e-mc/types": "0.8.7"
   }
 }

package/pool.js

@@ -1,8 +1,8 @@
 "use strict";
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("../types");
-const util_1 = require("./util");
+const types_1 = require("@e-mc/types");
+const util_1 = require("@e-mc/db/util");
 const kItems = Symbol('items');
 const kParent = Symbol('parent');
 const kIdlePrevious = Symbol('idlePrevious');
@@ -116,7 +116,7 @@ class DbPool {
         }
         previous.success = success;
         previous.failed = failed;
-        return Date.now() - timeout >= this.lastAccessed && (this.closeable || count >= (this.uuidKey ? 10 /* IDLE_THRESHOLD.UUID */ : 5 /* IDLE_THRESHOLD.CONFIG */)) || error >= (this.uuidKey ? 3 /* IDLE_THRESHOLD.UUID_ERROR */ : 2 /* IDLE_THRESHOLD.CONFIG_ERROR */);
+        return Date.now() - timeout >= this.lastAccessed && (this.closeable || count >= (this.uuidKey ? 10 : 5)) || error >= (this.uuidKey ? 3 : 2);
     }
     get persist() {
         return this.uuidKey ? this.success > this.failed : false;

package/util.js

@@ -1,8 +1,8 @@
 "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("../types");
-const util_1 = require("../request/util");
+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;