@e-mc/db 0.8.17 → 0.8.19

package/LICENSE

@@ -1,7 +1,7 @@
-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:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 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.

package/README.md

@@ -1,105 +1,105 @@
-# @e-mc/db
-
-* NodeJS 14
-* ES2019
-
-## General Usage
-
-* [Read the Docs](https://e-mc.readthedocs.io)
-
-## Interface
-
-- https://www.unpkg.com/@e-mc/types@0.8.17/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.17/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/db.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/object.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.17/lib/settings.d.ts
-
-## LICENSE
-
+# @e-mc/db
+
+* NodeJS 14
+* ES2019
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.19/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.19/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.19/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.19/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.19/lib/object.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.19/lib/settings.d.ts
+
+## LICENSE
+
 MIT

package/index.d.ts

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

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "@e-mc/db",
-  "version": "0.8.17",
-  "description": "DB modules for E-mc.",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/e-mc.git",
-    "directory": "src/db"
-  },
-  "keywords": [
-    "squared",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/e-mc#readme",
-  "dependencies": {
-    "@e-mc/core": "0.8.17",
-    "@e-mc/request": "0.8.17",
-    "@e-mc/types": "0.8.17"
-  }
-}
+{
+  "name": "@e-mc/db",
+  "version": "0.8.19",
+  "description": "DB modules for E-mc.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/e-mc.git",
+    "directory": "src/db"
+  },
+  "keywords": [
+    "squared",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/e-mc#readme",
+  "dependencies": {
+    "@e-mc/core": "0.8.19",
+    "@e-mc/request": "0.8.19",
+    "@e-mc/types": "0.8.19"
+  }
+}

package/pool.d.ts

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

package/types/index.d.ts

@@ -1,7 +1,7 @@
-import type { DbDataSource } from '../../types/lib/squared';
+import type { DbDataSource } from '@e-mc/types/lib/squared';
 
-import type { IDb } from '../../types/lib';
-import type { BatchQueryResult, ExecuteBatchQueryOptions, ExecuteQueryOptions, QueryResult } from '../../types/lib/db';
+import type { IDb } from '@e-mc/types/lib';
+import type { BatchQueryResult, ExecuteBatchQueryOptions, ExecuteQueryOptions, QueryResult } from '@e-mc/types/lib/db';
 
 export interface IDbSourceClient<T extends DbDataSource = DbDataSource> {
     DB_SOURCE_NAME: string;

package/util.d.ts

@@ -1,18 +1,18 @@
-import type { DbDataSource } from '../types/lib/squared';
-
-import type { DbConnection, SQL_COMMAND, ServerAuth } from '../types/lib/db';
-
-declare namespace util {
-    const SQL_COMMAND: SQL_COMMAND;
-    const IMPORTS: Record<string, string | undefined>;
-    function getBasicAuth(auth: AuthValue): string;
-    function getBasicAuth(username: unknown, password?: unknown): string;
-    function hasBasicAuth(value: string): boolean;
-    function parseConnectionString(value: string, scheme?: string): Null<DbConnection>;
-    function parseServerAuth(value: ServerAuth, all: boolean): ServerAuth;
-    function parseServerAuth(value: ServerAuth, port?: number, all?: boolean): ServerAuth;
-    function checkEmpty(value: unknown): boolean;
-    function setUUIDKey(item: DbDataSource, value: unknown): void;
-}
-
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { DbConnection, SQL_COMMAND, ServerAuth } from '@e-mc/types/lib/db';
+
+declare namespace util {
+    const SQL_COMMAND: SQL_COMMAND;
+    const IMPORTS: Record<string, string | undefined>;
+    function getBasicAuth(auth: AuthValue): string;
+    function getBasicAuth(username: unknown, password?: unknown): string;
+    function hasBasicAuth(value: string): boolean;
+    function parseConnectionString(value: string, scheme?: string): Null<DbConnection>;
+    function parseServerAuth(value: ServerAuth, all: boolean): ServerAuth;
+    function parseServerAuth(value: ServerAuth, port?: number, all?: boolean): ServerAuth;
+    function checkEmpty(value: unknown): boolean;
+    function setUUIDKey(item: DbDataSource, value: unknown): void;
+}
+
 export = util;