eip-cloud-services 1.0.15 → 1.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "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

@@ -10,7 +10,7 @@ let redisClient;
 const getClient = async () => {
     try {
         if ( !redisClient ) {
-            redisClient = redis.createClient ( { url: `${config.redis.host}:${config.redis.port}` } );
+            redisClient = redis.createClient ( { url: `${config?.redis?.host}:${config?.redis?.port}` } );
             await redisClient.connect ();
             redisClient.on ( 'error', error => {
                 console.error ( '\x1b[33mREDIS CONNECTION FAILED: Redis connection failed. If you\'re running locally, is a redis server actually active? Also, check your connection configuration.\x1b[0m' );
@@ -40,7 +40,7 @@ exports.keys = async ( pattern ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                pattern.startsWith ( config.redis.prefix ) ? pattern : config.redis.prefix + pattern,
+                pattern.startsWith ( config?.redis?.prefix ) ? pattern : config?.redis?.prefix + pattern,
             ];
 
             return await client.sendCommand ( [ 'KEYS', ...commandArgs ] );
@@ -73,7 +73,7 @@ exports.scan = async ( cursor, matchPattern = '*', count = 100 ) => {
 
         const commandArgs = [
             String ( cursor ),
-            'MATCH', matchPattern.startsWith ( config.redis.prefix ) ? matchPattern : config.redis.prefix + matchPattern,
+            'MATCH', matchPattern.startsWith ( config?.redis?.prefix ) ? matchPattern : config?.redis?.prefix + matchPattern,
             'COUNT', String ( count ),
         ];
 
@@ -100,7 +100,7 @@ exports.get = async ( key ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             const data = await client.sendCommand ( [ 'GET', ...commandArgs ] );
@@ -135,7 +135,7 @@ exports.multiGet = async ( keys ) => {
         if ( Array.isArray ( keys ) ) {
             const client = await getClient ();
 
-            const commandArgs = keys.map ( key => key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key );
+            const commandArgs = keys.map ( key => key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key );
 
             const data = await client.sendCommand ( [ 'MGET', ...commandArgs ] );
 
@@ -175,7 +175,7 @@ exports.set = async ( key, value, ex, px ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 value,
             ];
 
@@ -208,7 +208,7 @@ exports.del = async ( key ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             return await client.sendCommand ( [ 'DEL', ...commandArgs ] );
@@ -239,7 +239,7 @@ exports.setAdd = async ( key, members ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 ...( Array.isArray ( members ) ? members : [ members ] ),
             ];
 
@@ -270,7 +270,7 @@ exports.setRemove = async ( key, members ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 ...( Array.isArray ( members ) ? members : [ members ] ),
             ];
 
@@ -299,7 +299,7 @@ exports.setMembers = async ( key ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             return await client.sendCommand ( [ 'SMEMBERS', ...commandArgs ] );
@@ -330,7 +330,7 @@ exports.setPop = async ( key ) => {
             const client = await getClient ();
   
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
   
             const member = await client.sendCommand ( [ 'SPOP', ...commandArgs ] );
@@ -368,7 +368,7 @@ exports.listUnshift = async ( key, values ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             if ( typeof values === 'string' ) {
@@ -409,7 +409,7 @@ exports.listPush = async ( key, values ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             if ( typeof values === 'string' ) {
@@ -450,7 +450,7 @@ exports.listPop = async ( key, count = 1 ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 String ( count ),
             ];
 
@@ -483,7 +483,7 @@ exports.listRange = async ( key, start = 0, end = -1 ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 String ( start ),
                 String ( end ),
             ];
@@ -515,7 +515,7 @@ exports.getExpiryInSeconds = async ( key ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
             ];
 
             return await client.sendCommand ( [ 'TTL', ...commandArgs ] );
@@ -545,7 +545,7 @@ exports.setExpiry = async ( key, seconds = 0 ) => {
             const client = await getClient ();
 
             const commandArgs = [
-                key.startsWith ( config.redis.prefix ) ? key : config.redis.prefix + key,
+                key.startsWith ( config?.redis?.prefix ) ? key : config?.redis?.prefix + key,
                 String ( seconds ),
             ];
 

package/src/s3.js

@@ -48,18 +48,18 @@ if ( fs.existsSync ( configDirPath ) && fs.statSync ( configDirPath ).isDirector
 const zlib = require ( 'zlib' );
 const crypto = require ( 'crypto' );
 const { cwd } = require ( 'process' );
-const { log } = config?.s3?.logsFunction ? require ( `${  cwd ()}/${config.s3.logsFunction}` ) : console;
+const { log } = config?.s3?.logsFunction ? require ( `${  cwd ()}/${config?.s3?.logsFunction}` ) : console;
 const S3 = new S3Client ( { region: 'eu-west-1' } );
 
 /**
  * Check if an object exists in S3.
  *
  * @param {string} key - The object key.
- * @param {string} [bucket=config.s3.Bucket] - The bucket name. Defaults to the configured bucket.
+ * @param {string} [bucket=config?.s3?.Bucket] - The bucket name. Defaults to the configured bucket.
  * @returns {Promise<boolean>} A promise that resolves to true if the object exists, false otherwise.
  * @description Checks if an object with the specified key exists in S3.
  */
-exports.exists = async ( key, bucket = config.s3.Bucket ) => {
+exports.exists = async ( key, bucket = config?.s3?.Bucket ) => {
     try {
         const command = new HeadObjectCommand ( {
             Bucket: bucket,
@@ -68,13 +68,13 @@ exports.exists = async ( key, bucket = config.s3.Bucket ) => {
   
         await S3.send ( command );
 
-        if ( config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'verbose' )
             log ( `S3 [EXISTS]: ${key} on ${bucket} - Exists` );
         
         return true;
     }
     catch ( error ) {
-        if ( config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'verbose' )
             log ( `S3 [EXISTS]: ${key} on ${bucket} - Does not exist` );
         
         return false;
@@ -85,18 +85,18 @@ exports.exists = async ( key, bucket = config.s3.Bucket ) => {
  * Get an object from S3.
  *
  * @param {string} key - The object key.
- * @param {string} [bucket=config.s3.Bucket] - The bucket name. Defaults to the configured bucket.
+ * @param {string} [bucket=config?.s3?.Bucket] - The bucket name. Defaults to the configured bucket.
  * @returns {Promise} A promise that resolves to the retrieved object.
  * @description Retrieves an object from S3 based on the provided key.
  */
-exports.get = async ( key, bucket = config.s3.Bucket ) => {
+exports.get = async ( key, bucket = config?.s3?.Bucket ) => {
     try {
         const command = new GetObjectCommand ( {
             Bucket: bucket,
             Key: key
         } );
 
-        if ( config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'verbose' )
             log ( `S3 [GET]: Getting ${bucket}/${key}.` );
             
         const response = await S3.send ( command );
@@ -104,14 +104,14 @@ exports.get = async ( key, bucket = config.s3.Bucket ) => {
 
         if ( response.ContentEncoding && response.ContentEncoding === 'gzip' ) {
 
-            if ( config.s3.logs === 'verbose' )
+            if ( config?.s3?.logs === 'verbose' )
                 log ( `S3 [GET]: ${key} on ${bucket} was unzipped (was gzipped).` );
 
             data = zlib.unzipSync ( data );
         }
 
         if ( response.ContentType !== 'application/json' && !response.Metadata[ 'tmg-json' ] ) {
-            if ( config.s3.logs === 'output' )
+            if ( config?.s3?.logs === 'output' )
                 log ( `S3 [GET]: Returned ${response.ContentType} from ${bucket}/${key}.` );
             
             return data.toString ( 'utf8' );
@@ -134,11 +134,11 @@ exports.get = async ( key, bucket = config.s3.Bucket ) => {
 
             data = Buffer.from ( decryptedArrayBuffer ).toString ( 'utf8' );
 
-            if ( config.s3.logs === 'verbose' )
+            if ( config?.s3?.logs === 'verbose' )
                 log ( `S3 [GET]: ${key} on ${bucket} - JSON content was decrypted.` );
         }
 
-        if ( config.s3.logs === 'output' )
+        if ( config?.s3?.logs === 'output' )
             log ( `S3 [GET]: ${bucket}/${key} - JSON content was returned.` );
 
         return JSON.parse ( data.toString ( 'utf8' ) );
@@ -158,7 +158,7 @@ exports.get = async ( key, bucket = config.s3.Bucket ) => {
  * @param {string} key - The object key.
  * @param {Buffer|Uint8Array|Blob|string} body - The object body.
  * @param {object} [options] - The optional parameters for setting the object.
- * @param {string} [options.bucket=config.s3.Bucket] - The bucket name. Defaults to the configured bucket.
+ * @param {string} [options.bucket=config?.s3?.Bucket] - The bucket name. Defaults to the configured bucket.
  * @param {string} [options.contentType='application/json'] - The content type of the object. Defaults to 'application/json'.
  * @param {string} [options.acl='public-read'] - The ACL (Access Control List) of the object. Defaults to 'public-read'.
  * @param {string} [options.cacheControl='max-age=25,s-maxage=30,must-revalidate'] - Sets cache control for the object.
@@ -169,7 +169,7 @@ exports.get = async ( key, bucket = config.s3.Bucket ) => {
  */
 exports.set = async ( key, body, options = {} ) => {
     const {
-        bucket = config.s3.Bucket,
+        bucket = config?.s3?.Bucket,
         contentType = 'application/json',
         acl = 'public-read',
         cacheControl = 'max-age=25,s-maxage=30,must-revalidate',
@@ -179,7 +179,7 @@ exports.set = async ( key, body, options = {} ) => {
     
     if ( encrypt && ( contentType === 'application/json' || contentType === 'text/plain' ) ) {
 
-        if ( config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'verbose' )
             log ( `S3 [SET]: ${bucket}/${key} - Encrypting.` );
 
         const encoder = new TextEncoder ();
@@ -218,7 +218,7 @@ exports.set = async ( key, body, options = {} ) => {
   
         const data = await S3.send ( command );
 
-        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' )
             log ( `S3 [SET]: ${bucket}/${key} - Stored.` );
   
         return data;
@@ -233,11 +233,11 @@ exports.set = async ( key, body, options = {} ) => {
  * Delete an object from S3.
  *
  * @param {string} key - The object key.
- * @param {string} [bucket=config.s3.Bucket] - The bucket name. Defaults to the configured bucket.
+ * @param {string} [bucket=config?.s3?.Bucket] - The bucket name. Defaults to the configured bucket.
  * @returns {Promise} A promise that resolves when the object is successfully deleted from S3.
  * @description Deletes an object from S3 based on the provided key.
  */
-exports.del = async ( key, bucket = config.s3.Bucket ) => {
+exports.del = async ( key, bucket = config?.s3?.Bucket ) => {
     try {
         const command = new DeleteObjectCommand ( {
             Bucket: bucket,
@@ -246,7 +246,7 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
 
         const data = await S3.send ( command );
 
-        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' )
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' )
             log ( `S3 [DELETE]: ${key} on ${bucket} - Deleted.` );
 
         return data;
@@ -261,12 +261,12 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
  *
  * @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.
+ * @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.copy = 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 ( {
@@ -279,7 +279,7 @@ exports.copy = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
   
         await S3.send ( copyCommand );
 
-        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' ){
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' ){
             if ( sourceBucket === destinationBucket ){
                 log ( `S3 [COPY]: ${sourceKey} moved to ${destinationKey} on ${sourceBucket}.` );
             }
@@ -298,12 +298,12 @@ exports.copy = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
  *
  * @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.
+ * @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 ) => {
+exports.move = async ( sourceKey, destinationKey, sourceBucket = config?.s3?.Bucket, destinationBucket = config?.s3?.Bucket ) => {
     try {
 
         // Copy the object to the destination location
@@ -312,7 +312,7 @@ exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
         // Delete the object from the source location
         await this.del ( sourceKey, sourceBucket );
 
-        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' ){
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' ){
             if ( sourceBucket === destinationBucket ){
                 log ( `S3 [MOVE]: ${sourceKey} moved to ${destinationKey} on ${sourceBucket}.` );
             }