@pi-r/redis 0.7.3 → 0.7.5

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,7 +1,7 @@
-### @pi-r/redis
-
-https://e-mc.readthedocs.io/en/latest/db/redis.html
-
-### LICENSE
-
+### @pi-r/redis
+
+https://e-mc.readthedocs.io/en/latest/db/redis.html
+
+### LICENSE
+
 MIT

package/client/index.d.ts

@@ -1,7 +1,7 @@
-import type { IDbSourceClient } from '@e-mc/db/types';
-
-import type { RedisDataSource } from '../types';
-
-declare const Redis: IDbSourceClient<RedisDataSource>;
-
+import type { IDbSourceClient } from '@e-mc/db/types';
+
+import type { RedisDataSource } from '../types';
+
+declare const Redis: IDbSourceClient<RedisDataSource>;
+
 export = Redis;

package/client/index.js

@@ -570,7 +570,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                                 break;
                             default:
                                 if (item.field) {
-                                    data = client.hGet(...command ? [command, key, item.field] : [key, item.field]);
+                                    data = await client.hGet(...command ? [command, key, item.field] : [key, item.field]);
                                 }
                                 else {
                                     data = await client.hGetAll(...command ? [command, key] : [key]);

package/client/pool.js

@@ -0,0 +1,36 @@
+"use strict";
+const DbPool = require('@e-mc/db/pool');
+const POOL_ACTIVE = new WeakSet();
+class RedisPool extends DbPool {
+    static asString(credential) {
+        if (credential.url) {
+            return JSON.stringify(credential);
+        }
+        return super.asString(credential);
+    }
+    static sanitize(credential) {
+        if (!POOL_ACTIVE.has(credential) || credential.uuidKey) {
+            return credential;
+        }
+        if ('socket' in credential || 'isolationPoolOptions' in credential) {
+            return { ...credential, socket: credential.socket?.tls ? { tls: true } : undefined, isolationPoolOptions: undefined };
+        }
+        return credential;
+    }
+    async getConnection(credential) {
+        if (credential) {
+            POOL_ACTIVE.add(credential);
+        }
+        return this.client;
+    }
+    async close() {
+        return this.client.disconnect();
+    }
+    isEmpty() {
+        return this.closed;
+    }
+    get closed() {
+        return !this.client.isOpen;
+    }
+}
+module.exports = RedisPool;

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "@pi-r/redis",
-  "version": "0.7.3",
-  "description": "Redis client driver for E-mc.",
-  "main": "client/index.js",
-  "types": "client/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/pi-r.git",
-    "directory": "src/db/redis"
-  },
-  "keywords": [
-    "squared",
-    "e-mc",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/pi-r#readme",
-  "dependencies": {
-    "@e-mc/db": "^0.9.6",
-    "@e-mc/types": "^0.9.6",
-    "redis": "^4.6.15"
-  }
-}
+{
+  "name": "@pi-r/redis",
+  "version": "0.7.5",
+  "description": "Redis client driver for E-mc.",
+  "main": "client/index.js",
+  "types": "client/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
+    "directory": "src/db/redis"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/db": "^0.9.18",
+    "@e-mc/types": "^0.9.18",
+    "redis": "^4.7.0"
+  }
+}

package/types/index.d.ts

@@ -1,83 +1,83 @@
-import type { DbDataSource } from '@e-mc/types/lib/squared';
-
-import type { CascadeAction, ServerAuth } from '@e-mc/types/lib/db';
-
-import type { CommandOptions } from '@redis/client/dist/lib/command-options';
-import type { ClientCommandOptions } from '@redis/client/dist/lib/client';
-import type { RedisClientOptions } from '@redis/client';
-import type { RedisCommandArgument } from '@redis/client/dist/lib/commands';
-import type { RedisJSON } from '@redis/json/dist/commands';
-import type { RediSearchSchema, SearchOptions, SetOptions } from 'redis';
-
-export interface RedisDataSource extends DbDataSource<string, PlainObject, ArrayOf<RedisSetValue> | ArrayOf<RedisJSONValue>, RedisCredential, string>, CascadeAction, AuthValue {
-    source: "redis";
-    key?: ArrayOf<RedisCommandArgument>;
-    field?: RedisCommandArgument;
-    path?: string;
-    format?: RedisFormat | "HKEYS" | "HVALS";
-    search?: RedisQuery;
-    aggregate?: RedisQuery;
-    options?: {
-        client?: RedisClientOptions;
-        command?: RedisCommandOptions;
-        get?: PlainObject;
-        search?: SearchOptions;
-        aggregate?: PlainObject;
-    };
-    database?: number;
-}
-
-export type RedisCredential = ServerAuth;
-
-export interface RedisCommand<T = "HASH" | "JSON" | undefined, U = unknown, V = unknown> {
-    format: T;
-    command?: string;
-    key?: U;
-    value?: V;
-    NX?: boolean;
-    XX?: boolean;
-    options?: {
-        set?: SetOptions;
-        expire?: { [K in RedisExpireCondition]?: boolean; };
-        command?: RedisCommandOptions;
-    };
-}
-
-export interface RedisSetValue extends RedisCommand<"HASH", RedisCommandArgument, RedisCommandValue | RedisHSETObject> {
-    field?: RedisCommandValue | RedisHSETObject;
-    EX?: number;
-    PX?: number;
-    EXAT?: number;
-    PXAT?: number;
-    KEEPTTL?: boolean;
-}
-
-export interface RedisJSONValue extends RedisCommand<"JSON", string, ArrayOf<RedisJSON>> {
-    command?: RedisCommandJSON;
-    path?: string;
-    start?: number | string;
-    stop?: number | string;
-    index?: number | string;
-}
-
-export interface RedisQuery {
-    index?: string;
-    schema?: RediSearchSchema | string;
-    query?: string;
-    options?: PlainObject;
-}
-
-export interface JsonMSetItem {
-    key: RedisCommandArgument;
-    path: RedisCommandArgument;
-    value: RedisJSON;
-}
-
-export type RedisFormat = "HASH" | "JSON";
-export type RedisCommandJSON = "ARRAPPEND" | "ARRINDEX" | "ARRINSERT" | "ARRPOP" | "ARRTRIM" | "DEL" | "FORGET" | "MERGE" | "MSET" | "NUMINCRBY" | "NUMMULTBY" | "SET" | "STRAPPEND";
-export type RedisExpireCondition = "NX" | "XX" | "GT" | "LT";
-export type RedisCommandValue = RedisCommandArgument | number;
-export type RedisCommandOptions = CommandOptions<ClientCommandOptions>;
-export type RedisHSETObject = Record<number | string, RedisCommandValue>;
-
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { CascadeAction, ServerAuth } from '@e-mc/types/lib/db';
+
+import type { CommandOptions } from '@redis/client/dist/lib/command-options';
+import type { ClientCommandOptions } from '@redis/client/dist/lib/client';
+import type { RedisClientOptions } from '@redis/client';
+import type { RedisCommandArgument } from '@redis/client/dist/lib/commands';
+import type { RedisJSON } from '@redis/json/dist/commands';
+import type { RediSearchSchema, SearchOptions, SetOptions } from 'redis';
+
+export interface RedisDataSource extends DbDataSource<string, PlainObject, ArrayOf<RedisSetValue> | ArrayOf<RedisJSONValue>, RedisCredential, string>, CascadeAction, AuthValue {
+    source: "redis";
+    key?: ArrayOf<RedisCommandArgument>;
+    field?: RedisCommandArgument;
+    path?: string;
+    format?: RedisFormat | "HKEYS" | "HVALS";
+    search?: RedisQuery;
+    aggregate?: RedisQuery;
+    options?: {
+        client?: RedisClientOptions;
+        command?: RedisCommandOptions;
+        get?: PlainObject;
+        search?: SearchOptions;
+        aggregate?: PlainObject;
+    };
+    database?: number;
+}
+
+export type RedisCredential = ServerAuth;
+
+export interface RedisCommand<T = "HASH" | "JSON" | undefined, U = unknown, V = unknown> {
+    format: T;
+    command?: string;
+    key?: U;
+    value?: V;
+    NX?: boolean;
+    XX?: boolean;
+    options?: {
+        set?: SetOptions;
+        expire?: { [K in RedisExpireCondition]?: boolean; };
+        command?: RedisCommandOptions;
+    };
+}
+
+export interface RedisSetValue extends RedisCommand<"HASH", RedisCommandArgument, RedisCommandValue | RedisHSETObject> {
+    field?: RedisCommandValue | RedisHSETObject;
+    EX?: number;
+    PX?: number;
+    EXAT?: number;
+    PXAT?: number;
+    KEEPTTL?: boolean;
+}
+
+export interface RedisJSONValue extends RedisCommand<"JSON", string, ArrayOf<RedisJSON>> {
+    command?: RedisCommandJSON;
+    path?: string;
+    start?: number | string;
+    stop?: number | string;
+    index?: number | string;
+}
+
+export interface RedisQuery {
+    index?: string;
+    schema?: RediSearchSchema | string;
+    query?: string;
+    options?: PlainObject;
+}
+
+export interface JsonMSetItem {
+    key: RedisCommandArgument;
+    path: RedisCommandArgument;
+    value: RedisJSON;
+}
+
+export type RedisFormat = "HASH" | "JSON";
+export type RedisCommandJSON = "ARRAPPEND" | "ARRINDEX" | "ARRINSERT" | "ARRPOP" | "ARRTRIM" | "DEL" | "FORGET" | "MERGE" | "MSET" | "NUMINCRBY" | "NUMMULTBY" | "SET" | "STRAPPEND";
+export type RedisExpireCondition = "NX" | "XX" | "GT" | "LT";
+export type RedisCommandValue = RedisCommandArgument | number;
+export type RedisCommandOptions = CommandOptions<ClientCommandOptions>;
+export type RedisHSETObject = Record<number | string, RedisCommandValue>;
+
 export type { RedisCommandArgument, RedisJSON };