idea-aws 4.0.14 → 4.1.0

package/dist/src/s3.d.ts

@@ -22,14 +22,12 @@ export declare class S3 {
     createDownloadURLFromData(data: BodyDataTypes, options?: CreateDownloadURLFromDataOptions): Promise<SignedURL>;
     /**
      * Get a signed URL to put a file on a S3 bucket.
-     * @param expires seconds after which the signed URL expires
      */
-    signedURLPut(bucket: string, key: string, expires?: number): Promise<SignedURL>;
+    signedURLPut(bucket: string, key: string, options?: SignedURLOptions): Promise<SignedURL>;
     /**
      * Get a signed URL to get a file on a S3 bucket.
-     * @param expires seconds after which the signed URL expires
      */
-    signedURLGet(bucket: string, key: string, expires?: number): Promise<SignedURL>;
+    signedURLGet(bucket: string, key: string, options?: SignedURLOptions): Promise<SignedURL>;
     /**
      * Make a copy of an object of the bucket.
      */
@@ -83,6 +81,25 @@ export interface CreateDownloadURLFromDataOptions {
      * Seconds to URL expiration; default: `180`.
      */
     secToExp?: number;
+    /**
+     * The suggested name for the file once it's downloaded/saved.
+     * Note: the string is cleaned to ensure maximum compatibility with every OS.
+     */
+    filename?: string;
+}
+/**
+ * Options for generating a signed URL.
+ */
+export interface SignedURLOptions {
+    /**
+     * Seconds to URL expiration; default: `180` for GET, `300` for PUT.
+     */
+    secToExp?: number;
+    /**
+     * The suggested name for the file once it's downloaded/saved.
+     * Note: the string is cleaned to ensure maximum compatibility with every OS.
+     */
+    filename?: string;
 }
 /**
  * Options for copying an object.
@@ -117,6 +134,11 @@ export interface GetObjectOptions {
      * Enum: JSON; useful to cast the result.
      */
     type?: GetObjectTypes;
+    /**
+     * The suggested name for the file once it's downloaded/saved.
+     * Note: the string is cleaned to ensure maximum compatibility with every OS.
+     */
+    filename?: string;
 }
 /**
  * The managed types to convert objects coming from an S3 bucket.
@@ -153,6 +175,11 @@ export interface PutObjectOptions {
      * A set of metadata as attributes
      */
     metadata?: any;
+    /**
+     * The suggested name for the file once it's downloaded/saved.
+     * Note: the string is cleaned to ensure maximum compatibility with every OS.
+     */
+    filename?: string;
 }
 /**
  * Options for deleting an object.
@@ -180,3 +207,7 @@ export interface ListObjectsOptions {
      */
     prefix?: string;
 }
+/**
+ * Clean a filename to be compatible with most OS.
+ */
+export declare const cleanFilename: (filename: string) => string;

package/dist/src/s3.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetObjectTypes = exports.S3 = void 0;
+exports.cleanFilename = exports.GetObjectTypes = exports.S3 = void 0;
 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");
@@ -57,26 +57,28 @@ class S3 {
         const params = { Bucket: options.bucket, Key: options.key, Body: data, ContentType: options.contentType };
         const upload = new lib_storage_1.Upload({ client: this.s3, params });
         await upload.done();
-        return this.signedURLGet(options.bucket, options.key, options.secToExp);
+        return this.signedURLGet(options.bucket, options.key, { secToExp: options.secToExp, filename: options.filename });
     }
     /**
      * Get a signed URL to put a file on a S3 bucket.
-     * @param expires seconds after which the signed URL expires
      */
-    async signedURLPut(bucket, key, expires) {
-        const putCommand = new AWSS3.PutObjectCommand({ Bucket: bucket, Key: key });
-        const expiresIn = expires || this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP;
-        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, putCommand, { expiresIn });
+    async signedURLPut(bucket, key, options) {
+        const putParams = { Bucket: bucket, Key: key };
+        if (options.filename)
+            putParams.ContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
+        const expiresIn = options.secToExp || this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP;
+        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new AWSS3.PutObjectCommand(putParams), { expiresIn });
         return new idea_toolbox_1.SignedURL({ url });
     }
     /**
      * Get a signed URL to get a file on a S3 bucket.
-     * @param expires seconds after which the signed URL expires
      */
-    async signedURLGet(bucket, key, expires) {
-        const getCommand = new AWSS3.GetObjectCommand({ Bucket: bucket, Key: key });
-        const expiresIn = expires || this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP;
-        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, getCommand, { expiresIn });
+    async signedURLGet(bucket, key, options) {
+        const getParams = { Bucket: bucket, Key: key };
+        if (options.filename)
+            getParams.ResponseContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
+        const expiresIn = options.secToExp || this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP;
+        const url = await (0, s3_request_presigner_1.getSignedUrl)(this.s3, new AWSS3.GetObjectCommand(getParams), { expiresIn });
         return new idea_toolbox_1.SignedURL({ url });
     }
     /**
@@ -96,7 +98,10 @@ class S3 {
      */
     async getObject(options) {
         this.logger.debug(`S3 get object: ${options.key}`);
-        const command = new AWSS3.GetObjectCommand({ Bucket: options.bucket, Key: options.key });
+        const params = { Bucket: options.bucket, Key: options.key };
+        if (!options.type && options.filename)
+            params.ResponseContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
+        const command = new AWSS3.GetObjectCommand(params);
         const result = await this.s3.send(command);
         switch (options.type) {
             case GetObjectTypes.JSON:
@@ -118,6 +123,8 @@ class S3 {
             params.ACL = options.acl;
         if (options.metadata)
             params.Metadata = options.metadata;
+        if (options.filename)
+            params.ContentDisposition = `attachment; filename ="${(0, exports.cleanFilename)(options.filename)}"`;
         this.logger.debug(`S3 put object: ${options.key}`);
         return await this.s3.send(new AWSS3.PutObjectCommand(params));
     }
@@ -167,3 +174,8 @@ var GetObjectTypes;
     GetObjectTypes["JSON"] = "JSON";
     GetObjectTypes["TEXT"] = "TEXT";
 })(GetObjectTypes || (exports.GetObjectTypes = GetObjectTypes = {}));
+/**
+ * Clean a filename to be compatible with most OS.
+ */
+const cleanFilename = (filename) => filename.replace(/[^a-z0-9-.\s]/gi, '_');
+exports.cleanFilename = cleanFilename;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "4.0.14",
+  "version": "4.1.0",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",