@quatrain/storage-s3 1.2.5 → 1.2.6

package/dist/S3StorageAdapter.d.ts

@@ -1,4 +1,4 @@
-import { AbstractStorageAdapter, FileType, FileResponseLinkType, StorageParameters, DownloadFileMetaType } from '@quatrain/storage';
+import { AbstractStorageAdapter, FileType, FileResponseLinkType, StorageParameters, DownloadFileMetaType, BucketStatsType } from '@quatrain/storage';
 import { Readable, Stream } from 'node:stream';
 import { S3Client } from '@aws-sdk/client-s3';
 /**
@@ -111,4 +111,12 @@ export declare class S3StorageAdapter extends AbstractStorageAdapter {
      * @returns A promise resolving to the upload URL instructions.
      */
     getUploadUrl(file: FileType, expiresIn?: number): Promise<FileResponseLinkType>;
+    /**
+     * Computes statistics for a given bucket in S3.
+     * Iterates over all objects in the bucket to compute total count and size.
+     *
+     * @param bucket - Target bucket name.
+     * @returns A promise resolving to bucket statistics.
+     */
+    getBucketStats(bucket?: string): Promise<BucketStatsType>;
 }

package/dist/S3StorageAdapter.js

@@ -294,5 +294,69 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             };
         });
     }
+    /**
+     * Computes statistics for a given bucket in S3.
+     * Iterates over all objects in the bucket to compute total count and size.
+     *
+     * @param bucket - Target bucket name.
+     * @returns A promise resolving to bucket statistics.
+     */
+    getBucketStats(bucket) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const targetBucket = bucket || this._params.config.bucket;
+            let totalObjects = 0;
+            let totalSize = 0;
+            let isTruncated = true;
+            let continuationToken = undefined;
+            const folders = {};
+            storage_1.Storage.info(`Fetching bucket stats for ${targetBucket}`);
+            while (isTruncated) {
+                const input = {
+                    Bucket: targetBucket,
+                    ContinuationToken: continuationToken,
+                };
+                const command = new client_s3_1.ListObjectsV2Command(input);
+                const res = yield this._client.send(command);
+                if (res.Contents) {
+                    for (const item of res.Contents) {
+                        const size = item.Size || 0;
+                        totalObjects++;
+                        totalSize += size;
+                        if (item.Key) {
+                            const parts = item.Key.split('/');
+                            parts.pop(); // remove file name to get exact folder
+                            const folderPath = parts.length > 0 ? parts.join('/') : '/';
+                            const folderName = parts.length > 0 ? parts[parts.length - 1] : '/';
+                            if (!folders[folderPath]) {
+                                folders[folderPath] = {
+                                    name: folderName,
+                                    path: folderPath,
+                                    totalObjects: 0,
+                                    totalSize: 0,
+                                    lastModified: item.LastModified
+                                };
+                            }
+                            else if (item.LastModified) {
+                                if (!folders[folderPath].lastModified || item.LastModified > folders[folderPath].lastModified) {
+                                    folders[folderPath].lastModified = item.LastModified;
+                                }
+                            }
+                            folders[folderPath].totalObjects++;
+                            folders[folderPath].totalSize += size;
+                        }
+                    }
+                }
+                isTruncated = (_a = res.IsTruncated) !== null && _a !== void 0 ? _a : false;
+                continuationToken = res.NextContinuationToken;
+            }
+            return {
+                bucket: targetBucket,
+                totalObjects,
+                totalSize,
+                folders,
+            };
+        });
+    }
 }
 exports.S3StorageAdapter = S3StorageAdapter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/storage-s3",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Storage adapter for S3 compatible services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,7 +33,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.337.0",
     "@aws-sdk/s3-request-presigner": "^3.342.0",
-    "@quatrain/storage": "^1.2.6",
+    "@quatrain/storage": "^1.2.7",
     "fs-extra": "^11.2.0"
   },
   "scripts": {

package/src/S3StorageAdapter.ts

@@ -5,6 +5,7 @@ import {
    FileResponseLinkType,
    StorageParameters,
    DownloadFileMetaType,
+   BucketStatsType,
 } from '@quatrain/storage'
 import { Readable, Stream } from 'node:stream'
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
@@ -17,6 +18,9 @@ import {
    CopyObjectCommand,
    HeadObjectCommand,
    ListBucketsCommand,
+   ListObjectsV2Command,
+   ListObjectsV2CommandInput,
+   ListObjectsV2CommandOutput,
 } from '@aws-sdk/client-s3'
 
 /**
@@ -331,4 +335,70 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
          expiresIn,
       }
    }
+
+   /**
+    * Computes statistics for a given bucket in S3.
+    * Iterates over all objects in the bucket to compute total count and size.
+    * 
+    * @param bucket - Target bucket name.
+    * @returns A promise resolving to bucket statistics.
+    */
+   async getBucketStats(bucket?: string): Promise<BucketStatsType> {
+      const targetBucket = bucket || this._params.config.bucket
+      let totalObjects = 0
+      let totalSize = 0
+      let isTruncated = true
+      let continuationToken: string | undefined = undefined
+      const folders: Record<string, any> = {}
+
+      Storage.info(`Fetching bucket stats for ${targetBucket}`)
+
+      while (isTruncated) {
+         const input: ListObjectsV2CommandInput = {
+            Bucket: targetBucket,
+            ContinuationToken: continuationToken,
+         }
+         const command = new ListObjectsV2Command(input)
+         const res: ListObjectsV2CommandOutput = await this._client.send(command)
+         if (res.Contents) {
+            for (const item of res.Contents) {
+               const size = item.Size || 0
+               totalObjects++
+               totalSize += size
+
+               if (item.Key) {
+                  const parts = item.Key.split('/')
+                  parts.pop() // remove file name to get exact folder
+                  const folderPath = parts.length > 0 ? parts.join('/') : '/'
+                  const folderName = parts.length > 0 ? parts[parts.length - 1] : '/'
+                  
+                  if (!folders[folderPath]) {
+                     folders[folderPath] = { 
+                        name: folderName,
+                        path: folderPath,
+                        totalObjects: 0, 
+                        totalSize: 0,
+                        lastModified: item.LastModified
+                     }
+                  } else if (item.LastModified) {
+                     if (!folders[folderPath].lastModified || item.LastModified > folders[folderPath].lastModified) {
+                        folders[folderPath].lastModified = item.LastModified
+                     }
+                  }
+                  folders[folderPath].totalObjects++
+                  folders[folderPath].totalSize += size
+               }
+            }
+         }
+         isTruncated = res.IsTruncated ?? false
+         continuationToken = res.NextContinuationToken
+      }
+
+      return {
+         bucket: targetBucket,
+         totalObjects,
+         totalSize,
+         folders,
+      }
+   }
 }