idea-aws 4.5.1 → 4.5.2

package/dist/src/s3.d.ts

@@ -40,6 +40,7 @@ export declare class S3 {
     getObjectAsJSON(options: GetObjectOptions): Promise<any>;
     /**
      * Get an object from a S3 bucket and convert the content to string.
+     * If the object was stored with `Content-Encoding: gzip`, it is decompressed transparently.
      */
     getObjectAsText(options: GetObjectOptions): Promise<string>;
     /**
@@ -83,6 +84,17 @@ export interface CreateDownloadURLFromDataOptions {
      * Content type, e.g. application/json; default: _guessed_.
      */
     contentType?: string;
+    /**
+     * If true, the body is gzipped with `Content-Encoding: gzip`. Browsers and `fetch` decompress transparently.
+     * Recommended for text/JSON payloads over ~50 KB; for already-compressed binaries (images, zip, etc.) leave it off.
+     * Only applied when `data` is a `string`, `Buffer`, or `Uint8Array`; silently ignored for other body types.
+     */
+    compress?: boolean;
+    /**
+     * Explicit `Content-Encoding` to store on the object (e.g., `'gzip'`, `'br'`).
+     * Use this when the body is already compressed. Ignored when `compress: true` (in that case `'gzip'` is forced).
+     */
+    contentEncoding?: string;
     /**
      * Seconds to URL expiration; default: `180`.
      */
@@ -179,6 +191,11 @@ export interface PutObjectOptions {
      * Content type (e.g. image/png).
      */
     contentType?: string;
+    /**
+     * `Content-Encoding` header to store on the object (e.g., `'gzip'`).
+     * The body is uploaded as-is; the caller is responsible for pre-compressing it.
+     */
+    contentEncoding?: string;
     /**
      * Access-control list (e.g. public-read).
      */

package/dist/src/s3.js

@@ -34,6 +34,8 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanFilename = exports.S3 = void 0;
+const node_zlib_1 = require("node:zlib");
+const node_util_1 = require("node:util");
 const AWSS3 = __importStar(require("@aws-sdk/client-s3"));
 const lib_storage_1 = require("@aws-sdk/lib-storage");
 const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
@@ -62,7 +64,21 @@ class S3 {
         options.key = `${options.prefix ?? this.DEFAULT_DOWNLOAD_BUCKET_PREFIX}/${options.key}`;
         options.bucket = options.bucket ?? this.DEFAULT_DOWNLOAD_BUCKET;
         options.secToExp = options.secToExp ?? this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP;
-        const params = { Bucket: options.bucket, Key: options.key, Body: data, ContentType: options.contentType };
+        let body = data;
+        let contentEncoding = options.contentEncoding;
+        if (options.compress && (typeof data === 'string' || data instanceof Uint8Array)) {
+            const gzip = (0, node_util_1.promisify)(node_zlib_1.gzip);
+            body = await gzip(data);
+            contentEncoding = 'gzip';
+        }
+        const params = {
+            Bucket: options.bucket,
+            Key: options.key,
+            Body: body,
+            ContentType: options.contentType
+        };
+        if (contentEncoding)
+            params.ContentEncoding = contentEncoding;
         const upload = new lib_storage_1.Upload({ client: this.client, params });
         await upload.done();
         return this.signedURLGet(options.bucket, options.key, { secToExp: options.secToExp, filename: options.filename });
@@ -121,9 +137,15 @@ class S3 {
     }
     /**
      * Get an object from a S3 bucket and convert the content to string.
+     * If the object was stored with `Content-Encoding: gzip`, it is decompressed transparently.
      */
     async getObjectAsText(options) {
         const result = await this.getObject(options);
+        if (result.ContentEncoding === 'gzip') {
+            const gunzip = (0, node_util_1.promisify)(node_zlib_1.gunzip);
+            const compressed = await result.Body.transformToByteArray();
+            return (await gunzip(Buffer.from(compressed))).toString('utf-8');
+        }
         return await result.Body.transformToString('utf-8');
     }
     /**
@@ -133,6 +155,8 @@ class S3 {
         const params = { Bucket: options.bucket, Key: options.key, Body: options.body };
         if (options.contentType)
             params.ContentType = options.contentType;
+        if (options.contentEncoding)
+            params.ContentEncoding = options.contentEncoding;
         if (options.acl)
             params.ACL = options.acl;
         if (options.metadata)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "4.5.1",
+  "version": "4.5.2",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "license": "MPL-2.0",
   "main": "dist/index.js",