eip-cloud-services 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {
@@ -22,4 +22,4 @@
     "mysql": "^2.18.1",
     "redis": "^4.6.7"
   }
-}
+}

package/src/redis.js

@@ -80,7 +80,43 @@ exports.get = async ( key ) => {
         throw new Error ( `redis.get expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [get]', error.stack );
+        console.log ( 'REDIS LIB ERROR [get]', error );
+        throw error;
+    }
+};
+
+/**
+ * Retrieves the values of multiple keys.
+ * @param {string[]} keys - The keys to retrieve.
+ * @returns {Promise} - A promise that resolves with the values of the keys.
+ *
+ * @description This method retrieves the values associated with the specified keys from Redis.
+ * If the value is a JSON string, it will be parsed and returned as a JavaScript object.
+ * If the value is not a valid JSON string, it will be returned as a string.
+ */
+exports.multiGet = async ( keys ) => {
+    try {
+        if ( Array.isArray ( keys ) ) {
+            const client = await getClient ();
+
+            const commandArgs = keys.map ( key => key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key );
+
+            const data = await client.sendCommand ( [ 'MGET', ...commandArgs ] );
+
+            return data.map ( val => {
+                try {
+                    return JSON.parse ( val );
+                }
+                catch {
+                    return val;
+                }
+            } );
+        }
+
+        throw new Error ( `redis.multiGet expects an array of keys, instead the type provided was: ${typeof keys}` );
+    }
+    catch ( error ) {
+        console.log ( 'REDIS LIB ERROR [multiGet]', error );
         throw error;
     }
 };
@@ -145,7 +181,7 @@ exports.del = async ( key ) => {
         throw new Error ( `redis.del expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [del]', error.stack );
+        console.log ( 'REDIS LIB ERROR [del]', error );
         throw error;
     }
 };
@@ -208,7 +244,7 @@ exports.setRemove = async ( key, members ) => {
         throw new Error ( `redis.setRemove expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [setRemove]', error.stack );
+        console.log ( 'REDIS LIB ERROR [setRemove]', error );
         throw error;
     }
 };
@@ -236,7 +272,7 @@ exports.setMembers = async ( key ) => {
         throw new Error ( `redis.setMembers expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [setMembers]', error.stack );
+        console.log ( 'REDIS LIB ERROR [setMembers]', error );
         throw error;
     }
 };
@@ -274,7 +310,7 @@ exports.setPop = async ( key ) => {
         throw new Error ( `redis.setPop expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [setPop]', error.stack );
+        console.log ( 'REDIS LIB ERROR [setPop]', error );
         throw error;
     }
 };
@@ -315,7 +351,7 @@ exports.listUnshift = async ( key, values ) => {
         throw new Error ( `redis.listUnshift expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [listUnshift]', error.stack );
+        console.log ( 'REDIS LIB ERROR [listUnshift]', error );
         throw error;
     }
 };
@@ -356,7 +392,7 @@ exports.listPush = async ( key, values ) => {
         throw new Error ( `redis.listPush expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [listPush]', error.stack );
+        console.log ( 'REDIS LIB ERROR [listPush]', error );
         throw error;
     }
 };
@@ -388,7 +424,7 @@ exports.listPop = async ( key, count = 1 ) => {
         throw new Error ( `redis.listPop expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [listPop]', error.stack );
+        console.log ( 'REDIS LIB ERROR [listPop]', error );
         throw error;
     }
 };
@@ -422,7 +458,7 @@ exports.listRange = async ( key, start = 0, end = -1 ) => {
         throw new Error ( `redis.listRange expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [listRange]', error.stack );
+        console.log ( 'REDIS LIB ERROR [listRange]', error );
         throw error;
     }
 };
@@ -452,7 +488,7 @@ exports.getExpiryInSeconds = async ( key ) => {
         throw new Error ( `redis.getExpiryInSeconds expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [getExpiryInSeconds]', error.stack );
+        console.log ( 'REDIS LIB ERROR [getExpiryInSeconds]', error );
         throw error;
     }
 };
@@ -483,7 +519,7 @@ exports.setExpiry = async ( key, seconds = 0 ) => {
         throw new Error ( `redis.setExpiry expects a string key, instead the type provided was: ${typeof key}` );
     }
     catch ( error ) {
-        console.log ( 'REDIS LIB ERROR [setExpiry]', error.stack );
+        console.log ( 'REDIS LIB ERROR [setExpiry]', error );
         throw error;
     }
 };

package/src/s3.js

@@ -251,7 +251,7 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
 };
 
 /**
- * Move an object within S3 to a different location.
+ * Copy an object within S3 to a different location. (This keep the original like a COPY / PASTE operation)
  *
  * @param {string} sourceKey - The source object key.
  * @param {string} destinationKey - The destination object key.
@@ -260,7 +260,7 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
  * @returns {Promise} A promise that resolves when the object is successfully moved in S3.
  * @description Moves an object from the source location to the destination location within S3.
  */
-exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucket, destinationBucket = config.s3.Bucket ) => {
+exports.copy = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucket, destinationBucket = config.s3.Bucket ) => {
     try {
         // Copy the object to the destination location
         const copyCommand = new CopyObjectCommand ( {
@@ -272,19 +272,39 @@ exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
         } );
   
         await S3.send ( copyCommand );
-  
-        // Delete the object from the source location
-        const deleteCommand = new DeleteObjectsCommand ( {
-            Bucket: sourceBucket,
-            Delete: {
-                Objects: [
-                    { Key: sourceKey }
-                ],
-                Quiet: true
+
+        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' ){
+            if ( sourceBucket === destinationBucket ){
+                log ( `S3 [COPY]: ${sourceKey} moved to ${destinationKey} on ${sourceBucket}.` );
             }
-        } );
+            else {
+                log ( `S3 [COPY]: ${sourceKey} on ${sourceBucket} moved to ${destinationKey} on ${destinationBucket}.` );
+            }
+        }
+    }
+    catch ( error ) {
+        throw error;
+    }
+};
+
+/**
+ * Move an object within S3 to a different location. (This deletes the original like a CUT / PASTE operation)
+ *
+ * @param {string} sourceKey - The source object key.
+ * @param {string} destinationKey - The destination object key.
+ * @param {string} [sourceBucket=config.s3.Bucket] - The source bucket name. Defaults to the configured bucket.
+ * @param {string} [destinationBucket=config.s3.Bucket] - The destination bucket name. Defaults to the configured bucket.
+ * @returns {Promise} A promise that resolves when the object is successfully moved in S3.
+ * @description Moves an object from the source location to the destination location within S3.
+ */
+exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucket, destinationBucket = config.s3.Bucket ) => {
+    try {
+
+        // Copy the object to the destination location
+        await this.copy ( sourceKey, destinationKey, sourceBucket, destinationBucket );
   
-        await S3.send ( deleteCommand );
+        // Delete the object from the source location
+        await this.del ( sourceKey, sourceBucket );
 
         if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' ){
             if ( sourceBucket === destinationBucket ){