eip-cloud-services 1.1.4 → 1.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {

package/src/s3.js

@@ -38,8 +38,9 @@
  * and ensures the best CWVs performance.
  */
 
-const { S3Client, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand, CopyObjectCommand, DeleteObjectsCommand } = require ( '@aws-sdk/client-s3' );
+const { S3Client, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand, CopyObjectCommand, ListObjectsV2Command } = require ( '@aws-sdk/client-s3' );
 const fs = require ( 'fs' );
+const path = require ( 'path' );
 let config = {};
 const configDirPath = `${ process.cwd ()}/config`;
 if ( fs.existsSync ( configDirPath ) && fs.statSync ( configDirPath ).isDirectory () ) {
@@ -82,14 +83,16 @@ exports.exists = async ( key, bucket = config?.s3?.Bucket ) => {
 };
 
 /**
- * Get an object from S3.
+ * Get an object from S3 and optionally download it to a file.
  *
  * @param {string} key - The object key.
  * @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.
+ * @param {Object} [options] - Optional parameters, including targetFolder for file download.
+ * @param {string} [options.targetFolder] - If provided the requested object will be downloaded to this folder instead of being returned. The response will be the file path.
+ * @returns {Promise} A promise that resolves to the retrieved object or the path to the downloaded file.
+ * @description Retrieves an object from S3 based on the provided key and optionally downloads it to a specified folder.
  */
-exports.get = async ( key, bucket = config?.s3?.Bucket ) => {
+exports.get = async ( key, bucket = config?.s3?.Bucket, options = {} ) => {
     try {
         const command = new GetObjectCommand ( {
             Bucket: bucket,
@@ -98,50 +101,69 @@ exports.get = async ( key, bucket = config?.s3?.Bucket ) => {
 
         if ( config?.s3?.logs === 'verbose' )
             log ( `S3 [GET]: Getting ${bucket}/${key}.` );
-            
+
         const response = await S3.send ( command );
-        let data = await streamToBuffer ( response.Body );
 
-        if ( response.ContentEncoding && response.ContentEncoding === 'gzip' ) {
+        // If options.targetFolder is specified, download the file
+        if ( options.targetFolder ) {
+            const filePath = path.join ( options.targetFolder, key.replace ( /\//g, '_' ) );
+            const fileStream = fs.createWriteStream ( filePath );
+            response.Body.pipe ( fileStream );
+            await new Promise ( ( resolve, reject ) => {
+                fileStream.on ( 'finish', resolve );
+                fileStream.on ( 'error', reject );
+            } );
 
-            if ( config?.s3?.logs === 'verbose' )
-                log ( `S3 [GET]: ${key} on ${bucket} was unzipped (was gzipped).` );
+            if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' )
+                log ( `S3 [GET]: Downloaded ${key} to ${filePath}.` );
 
-            data = zlib.unzipSync ( data );
-        }
+            return filePath;
+        } 
+        else {
+                
+            let data = await streamToBuffer ( response.Body );
 
-        if ( response.ContentType !== 'application/json' && !response.Metadata[ 'tmg-json' ] ) {
-            if ( config?.s3?.logs === 'output' )
-                log ( `S3 [GET]: Returned ${response.ContentType} from ${bucket}/${key}.` );
+            if ( response.ContentEncoding && response.ContentEncoding === 'gzip' ) {
+
+                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' )
+                    log ( `S3 [GET]: Returned ${response.ContentType} from ${bucket}/${key}.` );
+                
+                return data.toString ( 'utf8' );
+            }
             
-            return data.toString ( 'utf8' );
-        }
-        
-        if ( ( response.ContentType === 'application/json' || response.Metadata[ 'tmg-json' ] ) && response.Metadata[ 'tmg-crypt' ] && response.Metadata[ 'tmg-crypt-vec' ] ) {
-            const key = await crypto.subtle.importKey (
-                'raw',
-                Buffer.from ( response.Metadata[ 'tmg-crypt' ], 'base64' ),
-                { name: 'AES-CBC', length: 256 },
-                false,
-                [ 'decrypt' ]
-            );
-            const iv = Buffer.from ( response.Metadata[ 'tmg-crypt-vec' ], 'base64' );
-            const decryptedArrayBuffer = await crypto.subtle.decrypt (
-                { name: 'AES-CBC', iv },
-                key,
-                Buffer.from ( data.toString (), 'base64' )
-            );
-
-            data = Buffer.from ( decryptedArrayBuffer ).toString ( 'utf8' );
-
-            if ( config?.s3?.logs === 'verbose' )
-                log ( `S3 [GET]: ${key} on ${bucket} - JSON content was decrypted.` );
-        }
+            if ( ( response.ContentType === 'application/json' || response.Metadata[ 'tmg-json' ] ) && response.Metadata[ 'tmg-crypt' ] && response.Metadata[ 'tmg-crypt-vec' ] ) {
+                const key = await crypto.subtle.importKey (
+                    'raw',
+                    Buffer.from ( response.Metadata[ 'tmg-crypt' ], 'base64' ),
+                    { name: 'AES-CBC', length: 256 },
+                    false,
+                    [ 'decrypt' ]
+                );
+                const iv = Buffer.from ( response.Metadata[ 'tmg-crypt-vec' ], 'base64' );
+                const decryptedArrayBuffer = await crypto.subtle.decrypt (
+                    { name: 'AES-CBC', iv },
+                    key,
+                    Buffer.from ( data.toString (), 'base64' )
+                );
+
+                data = Buffer.from ( decryptedArrayBuffer ).toString ( 'utf8' );
+
+                if ( config?.s3?.logs === 'verbose' )
+                    log ( `S3 [GET]: ${key} on ${bucket} - JSON content was decrypted.` );
+            }
 
-        if ( config?.s3?.logs === 'output' )
-            log ( `S3 [GET]: ${bucket}/${key} - JSON content was returned.` );
+            if ( config?.s3?.logs === 'output' )
+                log ( `S3 [GET]: ${bucket}/${key} - JSON content was returned.` );
 
-        return JSON.parse ( data.toString ( 'utf8' ) );
+            return JSON.parse ( data.toString ( 'utf8' ) );
+        }
     }
     catch ( error ) {
         if ( error.Code === 'NoSuchKey' ) {