@pi-r/redis 0.2.1 → 0.2.8

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 An Pham
+Copyright 2023 Mile Square Park
 
 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:
 

package/README.md

@@ -1,5 +1,7 @@
-### @pi-r/redis
+# @pi-r/redis
 
-### LICENSE
+PEP 402 - Forever
+
+## LICENSE
 
 MIT

package/client/index.js

@@ -5,7 +5,7 @@ const util_1 = require("@e-mc/db/util");
 const types_1 = require("@e-mc/types");
 const Db = require("@e-mc/db");
 const DbPool = require('@e-mc/db/pool');
-const REDIS_V4 = Db.checkSemVer("redis" /* STRINGS.PACKAGE_NAME */, 4);
+const REDIS_V4 = Db.checkSemVer("redis", 4);
 class RedisPool extends DbPool {
     getConnection() {
         return Promise.resolve(this.client);
@@ -39,16 +39,16 @@ function getClient(db, options, poolKey) {
         client.connect().then(() => resolve(client)).catch(err => reject(err));
     });
 }
-const removePoolProperties = (options) => {
+function removePoolProperties(options) {
     if (!options.uuidKey && ('socket' in options || 'isolationPoolOptions' in options)) {
         return { ...options, socket: options.socket?.tls ? { tls: true } : undefined, isolationPoolOptions: undefined };
     }
     return options;
-};
+}
 const getPoolKey = (options) => options.url + '_' + (options.username || '') + '_' + (options.password || '') + '_' + (options.database ?? '') + '_' + (options.socket?.tls ? '1' : '0') + '_' + (options.legacyMode ? '1' : '0');
 async function setCredential(item) {
     if (!REDIS_V4) {
-        throw (0, types_1.errorValue)("Upgrade client to latest version" /* ERR_DB.UPGRADE */, "redis" /* STRINGS.PACKAGE_NAME */ + '@' + Db.getPackageVersion("redis" /* STRINGS.PACKAGE_NAME */));
+        throw (0, types_1.errorValue)("Upgrade client to latest version", "redis" + '@' + Db.getPackageVersion("redis"));
     }
     const credential = this.getCredential(item);
     const options = item.options || (item.options = {});
@@ -58,7 +58,7 @@ async function setCredential(item) {
         client.database = database;
     }
     if (credential) {
-        const auth = (0, util_1.parseServerAuth)(credential, 6379 /* VALUES.PORT */);
+        const auth = (0, util_1.parseServerAuth)(credential, 6379);
         if (!client.database) {
             if ('database' in credential) {
                 const value = credential.database;
@@ -71,7 +71,7 @@ async function setCredential(item) {
                 client.database = database;
             }
         }
-        uri || (uri = (auth.protocol || 'redis:') + '//' + (auth.server || 'localhost:' + (auth.port ? auth.port : 6379 /* VALUES.PORT */)));
+        uri || (uri = (auth.protocol || 'redis:') + '//' + (auth.server || 'localhost:' + (auth.port ? auth.port : 6379)));
         username || (username = auth.username);
         password || (password = auth.password);
     }
@@ -79,7 +79,7 @@ async function setCredential(item) {
         delete item.credential;
     }
     if (!uri) {
-        throw (0, types_1.errorMessage)("redis" /* STRINGS.MODULE_NAME */, 'Not defined - uri');
+        throw (0, types_1.errorMessage)("redis", 'Not defined - uri');
     }
     if (client.socket?.tls) {
         this.readTLSConfig(client.socket);
@@ -105,8 +105,8 @@ async function setCredential(item) {
         }
         const poolKey = getPoolKey(client);
         if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
-            const db = require("redis" /* STRINGS.PACKAGE_NAME */);
-            const config = this.getPoolConfig("redis" /* STRINGS.MODULE_NAME */, password);
+            const db = require("redis");
+            const config = this.getPoolConfig("redis", password);
             const poolOptions = client.isolationPoolOptions || (client.isolationPoolOptions = {});
             if (config) {
                 const { min, max, idle, queue_max, queue_idle } = config;
@@ -151,7 +151,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
     if (length === 0) {
         return [];
     }
-    const db = require("redis" /* STRINGS.PACKAGE_NAME */);
+    const db = require("redis");
     let parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss;
     if ((0, types_1.isPlainObject)(options)) {
         ({ parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
@@ -172,12 +172,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
     if (!parallel) {
         outResult || (outResult = new Array(length));
     }
-    const caching = this.hasCache("redis" /* STRINGS.MODULE_NAME */, sessionKey);
+    const caching = this.hasCache("redis", sessionKey);
     const tasks = new Array(length);
     const clients = [];
     let redisClient, redisCredential, redisCache = 0, onceCredential = connectOnce ? batch[0].options?.client : undefined;
     const getConnection = async (item, credential) => {
-        item.transactionState = 64 /* DB_TRANSACTION.AUTH */;
+        item.transactionState = 64;
         let client;
         if (item.usePool) {
             const pool = DbPool.findKey(POOL_STATE, item.usePool, getPoolKey(credential), ...connectOnce ? [item, batch[0]] : [item]);
@@ -199,14 +199,14 @@ async function executeBatchQuery(batch, options = '', outResult) {
             redisClient = client;
             redisCredential = credential;
         }
-        item.transactionState &= ~64 /* DB_TRANSACTION.AUTH */;
+        item.transactionState &= ~64;
         return client;
     };
     for (let i = 0; i < length; ++i) {
         const item = batch[i];
-        const { source, uri, key, format = 'HASH', search, update, options: clientOptions = {}, cacheObjectKey, ignoreCache } = item;
+        const { source, uri, key, format = 'HASH', search, aggregate, update, options: clientOptions = {}, cacheObjectKey, ignoreCache } = item;
         let credential = (redisCredential || onceCredential), error;
-        if (!credential && !(0, types_1.isPlainObject)(credential = clientOptions.client) && (error = (0, types_1.errorMessage)(source, "Invalid credentials" /* ERR_DB.CREDENTIALS */)) || !((0, types_1.isString)(key) || (0, types_1.isArray)(key) || (0, types_1.isPlainObject)(search) && ((0, types_1.isPlainObject)(search.schema) || (0, types_1.isString)(search.query))) && (error = (0, types_1.errorMessage)(source, "Missing database query" /* ERR_DB.QUERY */, uri))) {
+        if (!credential && !(0, types_1.isPlainObject)(credential = clientOptions.client) && (error = (0, types_1.errorMessage)(source, "Invalid credentials")) || !((0, types_1.isString)(key) || (0, types_1.isArray)(key) || (0, types_1.isPlainObject)(search) && ((0, types_1.isPlainObject)(search.schema) || (0, types_1.isString)(search.query)) || (0, types_1.isPlainObject)(aggregate) && ((0, types_1.isPlainObject)(aggregate.schema) || (0, types_1.isString)(aggregate.query))) && (error = (0, types_1.errorMessage)(source, "Missing database query", uri))) {
             ++redisCache;
             if (this.handleFail(error, item, { errorQuery })) {
                 if (!parallel) {
@@ -223,9 +223,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
             }
             continue;
         }
-        item.transactionState = 1 /* DB_TRANSACTION.ACTIVE */;
+        item.transactionState = 1;
         const uuidKey = (credential.uuidKey || (credential.uuidKey = (onceCredential ? batch[0] : item).credential?.uuidKey));
-        const targetObject = typeof checkObject === 'string' ? this.hasCoerce("redis" /* STRINGS.MODULE_NAME */, 'options', uuidKey) && (0, types_1.asFunction)(checkObject) : checkObject;
+        const targetObject = typeof checkObject === 'string' ? this.hasCoerce("redis", 'options', uuidKey) && (0, types_1.asFunction)(checkObject) : checkObject;
         const renewCache = ignoreCache === 0;
         const cacheValue = renewCache ? { sessionKey, renewCache } : sessionKey;
         const command = (0, types_1.isPlainObject)(clientOptions.command) ? db.commandOptions(clientOptions.command) : null;
@@ -234,6 +234,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
             if ((0, types_1.isObject)(search)) {
                 queryString = Db.asString(search, true);
             }
+            else if ((0, types_1.isObject)(aggregate)) {
+                queryString = Db.asString(aggregate, true);
+            }
             else if (!targetObject) {
                 queryString = Db.asString(key);
             }
@@ -252,7 +255,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     else {
                         outResult[i] = rows;
                     }
-                    this.add(item, 4 /* DB_TRANSACTION.COMMIT */ | 128 /* DB_TRANSACTION.CACHE */);
+                    this.add(item, 4 | 128);
                     continue;
                 }
                 if (!ignoreCache && outCacheMiss) {
@@ -285,8 +288,8 @@ async function executeBatchQuery(batch, options = '', outResult) {
                                 success(target);
                                 return;
                             }
-                            const failKey = () => failed((0, types_1.errorMessage)(f, "Invalid key" /* ERR_DB.KEY */, Db.asString(k) || "Unknown" /* ERR_MESSAGE.UNKNOWN */));
-                            const failValue = () => failed((0, types_1.errorMessage)(f, "Invalid value" /* ERR_DB.VALUE */, Db.asString(v) || "Unknown" /* ERR_MESSAGE.UNKNOWN */));
+                            const failKey = () => failed((0, types_1.errorMessage)(f, "Invalid key", Db.asString(k) || "Unknown"));
+                            const failValue = () => failed((0, types_1.errorMessage)(f, "Invalid value", Db.asString(v) || "Unknown"));
                             const commandSet = (0, types_1.isPlainObject)(setOptions.command) && db.commandOptions(setOptions.command);
                             let pending;
                             if ((f = f.toUpperCase()) === 'JSON') {
@@ -295,7 +298,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                                     return;
                                 }
                                 const path = target.path || '$';
-                                if (this.hasCoerce("redis" /* STRINGS.MODULE_NAME */, 'options', uuidKey)) {
+                                if (this.hasCoerce("redis", 'options', uuidKey)) {
                                     if ((0, types_1.isString)(v) && v.startsWith('new')) {
                                         ({ outV: v } = (0, types_1.coerceObject)({ outV: v }));
                                     }
@@ -401,7 +404,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                                                     success(target);
                                                 }
                                                 else {
-                                                    failed((0, types_1.errorMessage)(f, "Invalid value" /* ERR_DB.VALUE */, has(EX) ? 'EX: ' + EX : has(PX) ? 'PX: ' + PX : EXAT > 0 ? 'EXAT: ' + EX : 'PXAT: ' + PXAT));
+                                                    failed((0, types_1.errorMessage)(f, "Invalid value", has(EX) ? 'EX: ' + EX : has(PX) ? 'PX: ' + PX : EXAT > 0 ? 'EXAT: ' + EX : 'PXAT: ' + PXAT));
                                                 }
                                             })
                                                 .catch(err => failed(err));
@@ -437,22 +440,28 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     });
                 }
                 commandType = this.commandType.SELECT;
-                if ((0, types_1.isObject)(search)) {
-                    const { query = '', schema, index } = search;
+                const target = (0, types_1.isObject)(search) ? search : (0, types_1.isObject)(aggregate) ? aggregate : null;
+                if (target) {
+                    const { query = '', schema, index } = target;
                     let idx = '';
                     if ((0, types_1.isObject)(schema)) {
                         idx = index || (0, types_1.generateUUID)();
-                        await (command ? client.ft.create(command, idx, schema, search.options) : client.ft.create(idx, schema, search.options));
+                        await (command ? client.ft.create(command, idx, schema, target.options) : client.ft.create(idx, schema, target.options));
                     }
                     try {
-                        const reply = await (command ? client.ft.search(command, index || idx, query) : client.ft.search(index || idx, query));
-                        rows = reply.documents.map(doc => (doc.value['__id__'] = doc.id) && doc.value);
+                        if (target === search) {
+                            const reply = await (command ? client.ft.search(command, index || idx, query, clientOptions.search) : client.ft.search(index || idx, query, clientOptions.search));
+                            rows = reply.documents.map(doc => (doc.value['__id__'] = doc.id) && doc.value);
+                        }
+                        else {
+                            ({ results: rows } = await (command ? client.ft.aggregate(command, index || idx, query, clientOptions.aggregate) : client.ft.aggregate(index || idx, query, clientOptions.aggregate)));
+                        }
                     }
                     catch (err) {
                         error = err;
                     }
                     if (idx && idx !== index) {
-                        client.ft.dropIndex(idx).catch(err => this.writeFail(['Unable to drop search index', idx], err, { type: 65536 /* LOG_TYPE.DB */, fatal: false }));
+                        client.ft.dropIndex(idx).catch(err => this.writeFail([`Unable to drop ${target === search ? 'search' : 'aggregate'} index`, idx], err, { type: 65536, fatal: false }));
                     }
                     if (error instanceof Error) {
                         throw error;
@@ -500,16 +509,16 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     rows = (targetObject ? targetObject(item, data) : data);
                 }
                 if (rows === undefined) {
-                    throw (0, types_1.errorMessage)(source, "Missing database query" /* ERR_DB.QUERY */);
+                    throw (0, types_1.errorMessage)(source, "Missing database query");
                 }
-                this.add(item, 4 /* DB_TRANSACTION.COMMIT */);
+                this.add(item, 4);
                 resolve(this.setQueryResult(source, removePoolProperties(redisCredential || credential), queryString, rows, cacheValue));
             }
             catch (err) {
                 if (err instanceof Error) {
                     switch (err.message) {
-                        case "The client is closed" /* STRINGS.ERR_CLIENT_CLOSE */:
-                        case "Disconnects client" /* STRINGS.ERR_CLIENT_DISCONNECT */: {
+                        case "The client is closed":
+                        case "Disconnects client": {
                             const pool = item.usePool && DbPool.findKey(POOL_STATE, item.usePool, getPoolKey(credential));
                             if (pool) {
                                 await pool.detach(true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/redis",
-  "version": "0.2.1",
+  "version": "0.2.8",
   "description": "Redis client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/anpham6/pi-r.git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
     "directory": "src/db/redis"
   },
   "keywords": [
@@ -21,8 +21,8 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.5.2",
-    "@e-mc/types": "^0.5.2",
-    "redis": "^4.6.6"
+    "@e-mc/db": "^0.5.4",
+    "@e-mc/types": "^0.5.4",
+    "redis": "^4.6.13"
   }
 }

package/types/index.d.ts

@@ -7,7 +7,7 @@ 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 } from 'redis';
+import type { AggregateOptions, RediSearchSchema, SearchOptions } from 'redis';
 
 export interface RedisDataSource extends DbDataSource<string, PlainObject, ArrayOf<RedisSetValue> | ArrayOf<RedisJSONValue>, string | RedisCredential, string>, CascadeAction, AuthValue {
     source: "redis";
@@ -15,16 +15,14 @@ export interface RedisDataSource extends DbDataSource<string, PlainObject, Array
     field?: RedisCommandArgument;
     path?: string;
     format?: RedisFormat | "HKEYS" | "HVALS";
-    search?: {
-        index?: string;
-        schema?: RediSearchSchema | string;
-        query?: string;
-        options?: PlainObject;
-    };
+    search?: RedisQuery;
+    aggregate?: RedisQuery;
     options?: {
         client?: RedisClientOptions;
-        get?: PlainObject;
         command?: RedisCommandOptions;
+        get?: PlainObject;
+        search?: SearchOptions;
+        aggregate?: AggregateOptions;
     };
     database?: number;
 }
@@ -53,6 +51,13 @@ export interface RedisJSONValue extends Omit<RedisSetValue<"JSON", string, Redis
     path?: string;
 }
 
+export interface RedisQuery {
+    index?: string;
+    schema?: RediSearchSchema | string;
+    query?: string;
+    options?: PlainObject;
+}
+
 export type RedisFormat = "HASH" | "JSON";
 export type RedisExpireCondition = "NX" | "XX" | "GT" | "LT";
 export type RedisCommandValue = RedisCommandArgument | number;