idea-aws 4.0.13 → 4.1.0

package/dist/src/cognito.js

@@ -30,8 +30,9 @@ const idea_toolbox_1 = require("idea-toolbox");
  * A wrapper for AWS Cognito.
  */
 class Cognito {
-    constructor(params = {}) {
-        this.cognito = new CognitoIP.CognitoIdentityProviderClient({ region: params.region });
+    constructor(params) {
+        const options = Object.assign({}, params);
+        this.cognito = new CognitoIP.CognitoIdentityProviderClient({ region: options.region });
     }
     /**
      * Change the region in which to find the user pool.

package/dist/src/comprehend.js

@@ -29,8 +29,9 @@ const AmazonComprehend = __importStar(require("@aws-sdk/client-comprehend"));
  * A wrapper for Amazon Comprehend.
  */
 class Comprehend {
-    constructor(params = {}) {
-        this.comprehend = new AmazonComprehend.ComprehendClient({ region: params.region });
+    constructor(params) {
+        const options = Object.assign({}, params);
+        this.comprehend = new AmazonComprehend.ComprehendClient({ region: options.region });
     }
     /**
      * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

package/dist/src/dynamoDB.d.ts

@@ -7,8 +7,8 @@ import { Logger } from './logger';
 export declare class DynamoDB {
     protected dynamo: DDB.DynamoDBDocument;
     logger: Logger;
-    constructor(options?: {
-        debug: boolean;
+    constructor(params?: {
+        debug?: boolean;
     });
     /**
      * Convert a JSON object from DynamoDB format to simple JSON.

package/dist/src/dynamoDB.js

@@ -38,8 +38,9 @@ const logger_1 = require("./logger");
  * A wrapper for AWS DynamoDB.
  */
 class DynamoDB {
-    constructor(options = { debug: true }) {
+    constructor(params) {
         this.logger = new logger_1.Logger();
+        const options = Object.assign({}, params, { debug: true });
         this.dynamo = DDB.DynamoDBDocument.from(new client_dynamodb_1.DynamoDB(), {
             marshallOptions: { convertEmptyValues: true, removeUndefinedValues: true, convertClassInstanceToMap: true }
         });

package/dist/src/logger.d.ts

@@ -4,7 +4,7 @@
 export declare class Logger {
     level: string;
     private originalLevel;
-    constructor({ level }?: {
+    constructor(params?: {
         level?: string;
     });
     isEnabled(level: number): boolean;

package/dist/src/logger.js

@@ -5,8 +5,9 @@ exports.Logger = void 0;
  * Manage structured logging.
  */
 class Logger {
-    constructor({ level = process.env.LOG_LEVEL } = {}) {
-        this.level = (level || 'DEBUG').toUpperCase();
+    constructor(params) {
+        const options = Object.assign({}, params, { level: process.env.LOG_LEVEL });
+        this.level = (options.level ?? 'DEBUG').toUpperCase();
         this.originalLevel = this.level;
     }
     isEnabled(level) {

package/dist/src/metrics.d.ts

@@ -4,7 +4,7 @@ import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
  */
 export declare class CloudWatchMetrics {
     private metrics;
-    constructor(options?: {
+    constructor(params?: {
         project?: string;
     });
     /**

package/dist/src/metrics.js

@@ -6,9 +6,9 @@ const metrics_1 = require("@aws-lambda-powertools/metrics");
  * A wrapper for simple uses of CloudWatch Metrics.
  */
 class CloudWatchMetrics {
-    constructor(options) {
-        const project = options?.project ?? 'unknownProject';
-        this.metrics = new metrics_1.Metrics({ namespace: project });
+    constructor(params) {
+        const options = Object.assign({}, params, { project: 'unknownProject' });
+        this.metrics = new metrics_1.Metrics({ namespace: options.project });
     }
     /**
      * Get the raw Metrics object. To use for custom purposes.

package/dist/src/s3.d.ts

@@ -12,8 +12,8 @@ export declare class S3 {
     protected DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP: number;
     protected DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP: number;
     logger: Logger;
-    constructor(options?: {
-        debug: boolean;
+    constructor(params?: {
+        debug?: boolean;
     });
     /**
      * Create a download link of a piece of data (through S3).
@@ -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");
@@ -33,12 +33,13 @@ const logger_1 = require("./logger");
  * A wrapper for AWS Simple Storage Service.
  */
 class S3 {
-    constructor(options = { debug: true }) {
+    constructor(params) {
         this.DEFAULT_DOWNLOAD_BUCKET_PREFIX = 'common';
         this.DEFAULT_DOWNLOAD_BUCKET = 'idea-downloads';
         this.DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP = 180;
         this.DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP = 300;
         this.logger = new logger_1.Logger();
+        const options = Object.assign({}, params, { debug: true });
         this.s3 = new AWSS3.S3Client();
         this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }
@@ -56,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 });
     }
     /**
@@ -95,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:
@@ -117,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));
     }
@@ -166,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/dist/src/ses.d.ts

@@ -9,9 +9,9 @@ import { Logger } from './logger';
 export declare class SES {
     protected ses: AWSSES.SESv2Client;
     logger: Logger;
-    constructor(options?: {
+    constructor(params?: {
         region?: string;
-        debug: boolean;
+        debug?: boolean;
     });
     getTemplate(templateName: string): Promise<AWSSES.EmailTemplateContent>;
     setTemplate(templateName: string, subject: string, content: string, isHTML?: boolean): Promise<void>;

package/dist/src/ses.js

@@ -33,8 +33,9 @@ const logger_1 = require("./logger");
  * A wrapper for AWS Simple Email Service.
  */
 class SES {
-    constructor(options = { debug: true }) {
+    constructor(params) {
         this.logger = new logger_1.Logger();
+        const options = Object.assign({}, params, { debug: true });
         this.ses = new AWSSES.SESv2Client({ region: options.region });
         this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }

package/dist/src/sns.d.ts

@@ -6,8 +6,8 @@ import { Logger } from './logger';
  */
 export declare class SNS {
     logger: Logger;
-    constructor(options?: {
-        debug: boolean;
+    constructor(params?: {
+        debug?: boolean;
     });
     /**
      * Create a new endpoint in the SNS platform specified.

package/dist/src/sns.js

@@ -31,8 +31,9 @@ const logger_1 = require("./logger");
  * A wrapper for AWS Simple Notification Service.
  */
 class SNS {
-    constructor(options = { debug: true }) {
+    constructor(params) {
         this.logger = new logger_1.Logger();
+        const options = Object.assign({}, params, { debug: true });
         this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }
     /**

package/dist/src/translate.d.ts

@@ -23,7 +23,7 @@ export declare class Translate {
     /**
      * Initialize a new Translate helper object.
      */
-    constructor(options?: {
+    constructor(params?: {
         region?: string;
     });
     /**

package/dist/src/translate.js

@@ -33,7 +33,8 @@ class Translate {
     /**
      * Initialize a new Translate helper object.
      */
-    constructor(options = {}) {
+    constructor(params) {
+        const options = Object.assign({}, params);
         this.translate = new AWSTranslate.TranslateClient({ region: options.region });
         this.sourceLanguageCode = 'en';
         this.targetLanguageCode = 'en';

package/package.json

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