@e-mc/db 0.8.7 → 0.9.0

package/LICENSE

@@ -1,11 +1,11 @@
-Copyright 2024 An Pham
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-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.
-
+Copyright 2024 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+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,6 +1,6 @@
 # @e-mc/db
 
-* NodeJS 14
+* NodeJS 14/16
 * ES2020
 
 ## General Usage
@@ -9,15 +9,16 @@
 
 ## Interface
 
-- https://www.unpkg.com/@e-mc/types@0.8.7/lib/index.d.ts
+* [View Source](https://www.unpkg.com/@e-mc/types@0.9.0/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,13 +95,134 @@ 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 }
+);
+```
+
+## NodeJS 14 LTS
+
+Any optional fail safe dependencies were removed as of `E-mc 0.9`. The code itself will still be *ES2020* and will continue to work equivalently when self-installing these dependencies:
+
+### Under 15.4 + 16.0
+
+```sh
+npm i abort-controller event-target-shim
+```
+
+### Under 14.17 + 15.6
+
+```sh
+  npm i uuid
+```
+
 ## 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
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/http.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.0/lib/settings.d.ts
+
+* https://www.npmjs.com/package/@types/node
 
 ## LICENSE
 

package/index.d.ts

@@ -1,5 +1,5 @@
-import type { DbConstructor } from '../types/lib';
-
-declare const Db: DbConstructor;
-
+import type { DbConstructor } from '../types/lib';
+
+declare const Db: DbConstructor;
+
 export = Db;

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");
@@ -124,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);
@@ -135,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);
@@ -211,7 +216,7 @@ 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) => {
             data.ignoreCache ?? (data.ignoreCache = true);
@@ -225,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 '';
@@ -311,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.7",
+  "version": "0.9.0",
   "description": "DB modules for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,8 +20,8 @@
   "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.8.7",
-    "@e-mc/request": "0.8.7",
-    "@e-mc/types": "0.8.7"
+    "@e-mc/core": "0.9.0",
+    "@e-mc/request": "0.9.0",
+    "@e-mc/types": "0.9.0"
   }
 }

package/pool.d.ts

@@ -1,5 +1,5 @@
-import type { DbPoolConstructor } from '../types/lib/db';
-
-declare const DbPool: DbPoolConstructor;
-
+import type { DbPoolConstructor } from '../types/lib/db';
+
+declare const DbPool: DbPoolConstructor;
+
 export = DbPool;

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?.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];
@@ -139,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");