eip-cloud-services 1.0.21 → 1.1.0

package/src/s3.js

@@ -39,20 +39,27 @@
  */
 
 const { S3Client, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand, CopyObjectCommand, DeleteObjectsCommand } = require ( '@aws-sdk/client-s3' );
-const config = require ( 'config' );
+const fs = require ( 'fs' );
+let config = {};
+const configDirPath = `${ process.cwd ()}/config`;
+if ( fs.existsSync ( configDirPath ) && fs.statSync ( configDirPath ).isDirectory () ) {
+    config = require ( 'config' ); // require the config directory if it exists
+}
 const zlib = require ( 'zlib' );
-
+const crypto = require ( 'crypto' );
+const { cwd } = require ( 'process' );
+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,
@@ -60,10 +67,16 @@ exports.exists = async ( key, bucket = config.s3.Bucket ) => {
         } );
   
         await S3.send ( command );
+
+        if ( config?.s3?.logs === 'verbose' )
+            log ( `S3 [EXISTS]: ${key} on ${bucket} - Exists` );
         
         return true;
     }
     catch ( error ) {
+        if ( config?.s3?.logs === 'verbose' )
+            log ( `S3 [EXISTS]: ${key} on ${bucket} - Does not exist` );
+        
         return false;
     }
 };
@@ -72,26 +85,61 @@ 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.
  * @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 ) => {
+exports.get = async ( key, bucket = config?.s3?.Bucket ) => {
     try {
         const command = new GetObjectCommand ( {
-            Bucket: config.s3.Bucket,
+            Bucket: bucket,
             Key: key
         } );
 
+        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 ( config?.s3?.logs === 'verbose' )
+                log ( `S3 [GET]: ${key} on ${bucket} was unzipped (was gzipped).` );
+
             data = zlib.unzipSync ( data );
         }
 
-        if ( response.ContentType !== 'application/json' ) {
+        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' );
         }
+        
+        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.` );
 
         return JSON.parse ( data.toString ( 'utf8' ) );
     }
@@ -110,21 +158,52 @@ exports.get = async ( key ) => {
  * @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.
+ * @param {boolean} [options.encrypt=false] - When storing JSON parsing this as true will encrypt the data with a random uuid stored in the metadata of the object.
+ * @param {object} [options.metadata={}] - Sets metadata for the object.
  * @returns {Promise} A promise that resolves when the object is successfully set in S3.
  * @description Sets an object in S3 with the provided key, body, and optional parameters.
  */
 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'
+        cacheControl = 'max-age=25,s-maxage=30,must-revalidate',
+        encrypt = false,
+        metadata = {}
     } = options;
-  
+    
+    if ( encrypt && ( contentType === 'application/json' || contentType === 'text/plain' ) ) {
+
+        if ( config?.s3?.logs === 'verbose' )
+            log ( `S3 [SET]: ${bucket}/${key} - Encrypting.` );
+
+        const encoder = new TextEncoder ();
+        const data = encoder.encode ( body );
+
+        const encryptionKey = await crypto.subtle.generateKey (
+            { name: 'AES-CBC', length: 256 },
+            true,
+            [ 'encrypt', 'decrypt' ]
+        );
+        const iv = crypto.randomBytes ( 16 );
+        const exportedKey = await crypto.subtle.exportKey ( 'raw', encryptionKey );
+        const exportedIV = iv.toString ( 'base64' );
+        metadata[ 'Tmg-Crypt' ] = Buffer.from ( exportedKey ).toString ( 'base64' );
+        metadata[ 'Tmg-Crypt-Vec' ] = exportedIV;
+
+        const encryptedData = await crypto.subtle.encrypt (
+            { name: 'AES-CBC', iv },
+            encryptionKey,
+            data
+        );
+        body = Buffer.from ( encryptedData ).toString ( 'base64' );
+    }
+
     try {
         const command = new PutObjectCommand ( {
             Bucket: bucket,
@@ -132,14 +211,20 @@ exports.set = async ( key, body, options = {} ) => {
             Body: body,
             ContentType: contentType,
             ACL: acl,
-            CacheControl: cacheControl
+            CacheControl: cacheControl,
+            Metadata: metadata,
+            ContentLength: Buffer.byteLength ( body )
         } );
   
         const data = await S3.send ( command );
+
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' )
+            log ( `S3 [SET]: ${bucket}/${key} - Stored.` );
   
         return data;
     }
     catch ( error ) {
+        console.log ( error );
         throw error;
     }
 };
@@ -148,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,
@@ -161,6 +246,9 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
 
         const data = await S3.send ( command );
 
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' )
+            log ( `S3 [DELETE]: ${key} on ${bucket} - Deleted.` );
+
         return data;
     }
     catch ( error ) {
@@ -169,16 +257,16 @@ 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.
- * @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.copy = async ( sourceKey, destinationKey, sourceBucket = config?.s3?.Bucket, destinationBucket = config?.s3?.Bucket ) => {
     try {
         // Copy the object to the destination location
         const copyCommand = new CopyObjectCommand ( {
@@ -190,19 +278,48 @@ exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
         } );
   
         await S3.send ( copyCommand );
+
+        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 );
   
         // Delete the object from the source location
-        const deleteCommand = new DeleteObjectsCommand ( {
-            Bucket: sourceBucket,
-            Delete: {
-                Objects: [
-                    { Key: sourceKey }
-                ],
-                Quiet: true
+        await this.del ( sourceKey, sourceBucket );
+
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' ){
+            if ( sourceBucket === destinationBucket ){
+                log ( `S3 [MOVE]: ${sourceKey} moved to ${destinationKey} on ${sourceBucket}.` );
             }
-        } );
-  
-        await S3.send ( deleteCommand );
+            else {
+                log ( `S3 [MOVE]: ${sourceKey} on ${sourceBucket} moved to ${destinationKey} on ${destinationBucket}.` );
+            }
+        }
     }
     catch ( error ) {
         throw error;

package/src/util/log.js

@@ -0,0 +1,3 @@
+exports.log = log => {
+    console.log ( log );
+};