eip-cloud-services 1.1.1 → 1.1.2

package/package.json

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

package/src/s3.js

@@ -326,6 +326,45 @@ exports.move = async ( sourceKey, destinationKey, sourceBucket = config?.s3?.Buc
     }
 };
 
+/**
+ * List objects in an S3 bucket filtered by a prefix, with support for pagination.
+ *
+ * @param {string} prefix - The prefix to filter objects by.
+ * @param {string} [bucket=config?.s3?.Bucket] - The bucket name. Defaults to the configured bucket.
+ * @param {string} [continuationToken] - The continuation token for pagination (optional).
+ * @returns {Promise} A promise that resolves with the list of objects and potentially a continuation token for further pagination.
+ * @description Retrieves a list of objects from S3 that match the given prefix, with support for pagination.
+ */
+exports.listObjects = async ( prefix, bucket = config?.s3?.Bucket, continuationToken ) => {
+    try {
+        const params = {
+            Bucket: bucket,
+            Prefix: prefix,
+        };
+
+        if ( continuationToken ) {
+            params.ContinuationToken = continuationToken;
+        }
+
+        const command = new ListObjectsV2Command ( params );
+
+        const data = await S3.send ( command );
+
+        if ( config?.s3?.logs === 'outputs' || config?.s3?.logs === 'verbose' ) {
+            log ( `S3 [LIST]: Retrieved list for prefix ${prefix} on ${bucket}${continuationToken ? ' with continuation token' : ''}.` );
+        }
+
+        return {
+            objects: data.Contents,
+            isTruncated: data.IsTruncated,
+            nextContinuationToken: data.NextContinuationToken,
+        };
+    }
+    catch ( error ) {
+        throw error;
+    }
+};
+
 exports.getClient = S3;
 
 const streamToBuffer = ( stream ) =>