eip-cloud-services 1.1.8 → 1.1.10

package/eslint.config.js

@@ -0,0 +1,51 @@
+module.exports = [ {
+    languageOptions: {
+        ecmaVersion: 2021,
+        sourceType: 'module',
+        parserOptions: {
+            ecmaFeatures: {
+                jsx: true
+            }
+        }
+    },
+    rules: {
+        'max-len': 'off',
+        'semi': [ 'error', 'always' ],
+        'no-underscore-dangle': 'off',
+        'class-methods-use-this': 'off',
+        'no-param-reassign': 'off',
+        'no-restricted-syntax': 'warn',
+        'no-continue': 'warn',
+        'consistent-return': 'warn',
+        'guard-for-in': 'warn',
+        'import/no-commonjs': 'off',
+        'import/no-dynamic-require': 'off',
+        'new-cap': 'warn',
+        'no-nested-ternary': 'off',
+        'prefer-const': 'error',
+        'newline-before-return': [ 'error', 'always' ],
+        'quotes': [ 'error', 'single' ],
+        'no-multiple-empty-lines': [ 'error', { max: 1 } ],
+        'space-before-function-paren': [ 'error', 'always' ],
+        'func-call-spacing': [ 'error', 'always' ],
+        'block-spacing': [ 'error', 'always' ],
+        'space-in-parens': [ 'error', 'always' ],
+        'object-curly-spacing': [ 'error', 'always' ],
+        'no-spaced-func': 'off',
+        'space-unary-ops': [ 'error', { 'words': true, 'nonwords': false, 'overrides': { 'new': false, '++': false } } ],
+        'arrow-spacing': [ 'error', { 'before': true, 'after': true } ],
+        'indent': [ 'error', 4, { 'SwitchCase': 1 } ],
+        'key-spacing': [ 'error', { 'beforeColon': false, 'afterColon': true } ],
+        'computed-property-spacing': [ 'error', 'always' ],
+        'array-bracket-spacing': [ 'error', 'never' ],
+        'comma-spacing': [ 'error', { 'before': false, 'after': true } ],
+        'brace-style': [ 'error', 'stroustrup' ],
+        'space-infix-ops': 'error',
+        'keyword-spacing': [ 'error', { overrides: {
+            if: { after: true },
+            for: { after: true },
+            while: { after: true }
+        } } ],
+        'array-bracket-spacing': [ 'error', 'always' ],
+    },
+} ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {
@@ -10,6 +10,7 @@
   "license": "ISC",
   "devDependencies": {
     "chai": "^4.3.7",
+    "eslint": "^9.1.1",
     "mocha": "^10.2.0"
   },
   "dependencies": {

package/src/redis.js

@@ -78,6 +78,13 @@ const getClient = async ( clientId = 'main' ) => {
     }
 };
 
+const deleteClient = async ( clientId ) => {
+    if ( clients[ clientId ] ){
+        await clients[ clientId ].quit ();
+        delete clients[ clientId ];
+    }
+};
+
 /**
  * Retrieves a Redis client based on the provided identifier.
  * This function is primarily used internally within the module.
@@ -600,6 +607,46 @@ exports.listRange = async ( key, start = 0, end = -1 ) => {
     }
 };
 
+/**
+ * Increments the integer value of a key by the provided amount, or by 1 if no amount is specified.
+ * @param {string} key - The key whose value is to be incremented.
+ * @param {number} [increment=1] - The amount by which to increment the key's value. Defaults to 1.
+ * @returns {Promise<number>} - A promise that resolves with the new value after increment.
+ *
+ * @description This method uses the Redis INCRBY command to increment the value of the key.
+ * It defaults to incrementing by 1 if no specific increment value is provided.
+ */
+exports.increment = async (key, increment = 1) => {
+    try {
+        const client = await getClient();
+        const fullKey = (!config?.redis?.prefix || key.startsWith(config?.redis?.prefix)) ? key : config?.redis?.prefix + key;
+        return await client.incrby(fullKey, increment);
+    } catch (error) {
+        console.log('REDIS LIB ERROR [increment]', error);
+        throw error;
+    }
+};
+
+/**
+ * Decrements the integer value of a key by the provided amount, or by 1 if no amount is specified.
+ * @param {string} key - The key whose value is to be decremented.
+ * @param {number} [decrement=1] - The amount by which to decrement the key's value. Defaults to 1.
+ * @returns {Promise<number>} - A promise that resolves with the new value after decrement.
+ *
+ * @description This method uses the Redis DECRBY command to decrement the value of the key.
+ * It defaults to decrementing by 1 if no specific decrement value is provided.
+ */
+exports.decrement = async (key, decrement = 1) => {
+    try {
+        const client = await getClient();
+        const fullKey = (!config?.redis?.prefix || key.startsWith(config?.redis?.prefix)) ? key : config?.redis?.prefix + key;
+        return await client.decrby(fullKey, decrement);
+    } catch (error) {
+        console.log('REDIS LIB ERROR [decrement]', error);
+        throw error;
+    }
+};
+
 /**
  * Retrieves the expiration time of a key in seconds.
  * @param {string} key - The key to get the expiration time of.
@@ -700,6 +747,7 @@ exports.subscribe = async ( channel, messageHandler ) => {
                     messageHandler ( message );
                 }
             } );
+
             await client.subscribe ( channel );
         
             return;
@@ -721,21 +769,24 @@ exports.subscribe = async ( channel, messageHandler ) => {
  *
  * @description This method unsubscribes from the specified channel in Redis for incoming messages. 
  */
-exports.unsubscribe = async (channel) => {
+exports.unsubscribe = async ( channel ) => {
     try {
-        if (typeof channel === 'string') {
-            const client = await getClient(`${channel}_sub`);
+        if ( typeof channel === 'string' ) {
+            const client = await getClient ( `${channel}_sub` );
 
-            client.removeAllListeners('message');
+            client.removeAllListeners ( 'message' );
 
-            await client.unsubscribe(channel);
+            await client.unsubscribe ( channel );
+            await deleteClient ( `${channel}_sub` );
 
             return;
-        } else {
-            throw new Error('redis.unsubscribe expects a string channel and a function as handler');
         }
-    } catch (error) {
-        console.error('REDIS LIB ERROR [unsubscribe]', error);
+        else {
+            throw new Error ( 'redis.unsubscribe expects a string channel and a function as handler' );
+        }
+    }
+    catch ( error ) {
+        console.error ( 'REDIS LIB ERROR [unsubscribe]', error );
         throw error;
     }
 };