idea-aws 3.16.2 → 3.16.4

package/dist/src/dynamoDB.d.ts

@@ -1,10 +1,14 @@
 import { DynamoDB as DDB } from 'aws-sdk';
+import { Logger } from './logger';
 /**
  * A wrapper for AWS DynamoDB.
  */
 export declare class DynamoDB {
     protected dynamo: DDB.DocumentClient;
-    constructor();
+    logger: Logger;
+    constructor(options?: {
+        debug: boolean;
+    });
     /**
      * Convert a JSON object from dynamoDB format to simple JSON.
      */

package/dist/src/dynamoDB.js

@@ -7,13 +7,14 @@ const nanoid_1 = require("nanoid");
 const NanoID = (0, nanoid_1.customAlphabet)('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz', 25);
 const shortid_1 = require("shortid");
 const logger_1 = require("./logger");
-const logger = new logger_1.Logger();
 /**
  * A wrapper for AWS DynamoDB.
  */
 class DynamoDB {
-    constructor() {
+    constructor(options = { debug: true }) {
+        this.logger = new logger_1.Logger();
         this.dynamo = new aws_sdk_1.DynamoDB.DocumentClient();
+        this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }
     /**
      * Convert a JSON object from dynamoDB format to simple JSON.
@@ -101,7 +102,7 @@ class DynamoDB {
      * @param key the key of the counter
      */
     async getAtomicCounterByKey(key) {
-        logger.debug(`Get atomic counter for ${key}`);
+        this.logger.debug(`Get atomic counter for ${key}`);
         const result = await this.update({
             TableName: 'idea_atomicCounters',
             Key: { key },
@@ -118,7 +119,7 @@ class DynamoDB {
      * Get an item of a DynamoDB table.
      */
     async get(params) {
-        logger.debug(`Get ${params.TableName}`);
+        this.logger.debug(`Get ${params.TableName}`);
         const result = await this.dynamo.get(params).promise();
         if (!result?.Item)
             throw new Error('Not found');
@@ -128,21 +129,21 @@ class DynamoDB {
      * Put an item in a DynamoDB table.
      */
     async put(params) {
-        logger.debug(`Put ${params.TableName}`);
+        this.logger.debug(`Put ${params.TableName}`);
         return await this.dynamo.put(params).promise();
     }
     /**
      * Update an item of a DynamoDB table.
      */
     async update(params) {
-        logger.debug(`Update ${params.TableName}`);
+        this.logger.debug(`Update ${params.TableName}`);
         return await this.dynamo.update(params).promise();
     }
     /**
      * Delete an item of a DynamoDB table.
      */
     async delete(params) {
-        logger.debug(`Delete ${params.TableName}`);
+        this.logger.debug(`Delete ${params.TableName}`);
         return await this.dynamo.delete(params).promise();
     }
     /**
@@ -151,7 +152,7 @@ class DynamoDB {
      */
     async batchGet(table, keys, ignoreErr) {
         if (!keys.length) {
-            logger.debug(`Batch get ${table}: no elements to get`);
+            this.logger.debug(`Batch get ${table}: no elements to get`);
             return [];
         }
         return await this.batchGetHelper(table, keys, [], Boolean(ignoreErr));
@@ -162,7 +163,7 @@ class DynamoDB {
                 [table]: { Keys: keys.slice(currentChunk, currentChunk + chunkSize) }
             }
         };
-        logger.debug(`Batch get ${table}: ${currentChunk} of ${keys.length}`);
+        this.logger.debug(`Batch get ${table}: ${currentChunk} of ${keys.length}`);
         let result;
         try {
             result = await this.dynamo.batchGet(batch).promise();
@@ -187,7 +188,7 @@ class DynamoDB {
      */
     async batchPut(table, items) {
         if (!items.length)
-            return logger.debug(`Batch write (put) ${table}: no elements to write`);
+            return this.logger.debug(`Batch write (put) ${table}: no elements to write`);
         await this.batchWriteHelper(table, items, true);
     }
     /**
@@ -197,11 +198,11 @@ class DynamoDB {
      */
     async batchDelete(table, keys) {
         if (!keys.length)
-            return logger.debug(`Batch write (delete) ${table}: no elements to write`);
+            return this.logger.debug(`Batch write (delete) ${table}: no elements to write`);
         await this.batchWriteHelper(table, keys, false);
     }
     async batchWriteHelper(table, itemsOrKeys, isPut, currentChunk = 0, chunkSize = 25) {
-        logger.debug(`Batch write (${isPut ? 'put' : 'delete'}) ${table}: ${currentChunk} of ${itemsOrKeys.length}`);
+        this.logger.debug(`Batch write (${isPut ? 'put' : 'delete'}) ${table}: ${currentChunk} of ${itemsOrKeys.length}`);
         let requests;
         if (isPut)
             requests = itemsOrKeys.slice(currentChunk, currentChunk + chunkSize).map(i => ({ PutRequest: { Item: i } }));
@@ -226,7 +227,7 @@ class DynamoDB {
                 params.RequestItems = response.UnprocessedItems;
                 attempts++;
                 const waitSeconds = getRandomInt(attempts * 5);
-                logger.debug(`Batch write throttled: waiting ${waitSeconds} seconds to retry`);
+                this.logger.debug(`Batch write throttled: waiting ${waitSeconds} seconds to retry`);
                 await wait(waitSeconds);
             }
             else {
@@ -239,9 +240,9 @@ class DynamoDB {
      * @param params the params to apply to DynamoDB's function
      */
     async query(params) {
-        logger.debug(`Query ${params.TableName}`);
+        this.logger.debug(`Query ${params.TableName}`);
         const result = await this.queryScanHelper(params, [], true);
-        logger.debug(`Results query ${params.TableName}: ${result?.length || 0}`);
+        this.logger.debug(`Results query ${params.TableName}: ${result?.length || 0}`);
         return result;
     }
     /**
@@ -249,9 +250,9 @@ class DynamoDB {
      * @param params the params to apply to DynamoDB's function
      */
     async scan(params) {
-        logger.debug(`Scan ${params.TableName}`);
+        this.logger.debug(`Scan ${params.TableName}`);
         const result = await this.queryScanHelper(params, [], false);
-        logger.debug(`Results scan ${params.TableName}: ${result?.length || 0}`);
+        this.logger.debug(`Results scan ${params.TableName}: ${result?.length || 0}`);
         return result;
     }
     async queryScanHelper(params, items, isQuery) {
@@ -273,9 +274,9 @@ class DynamoDB {
      * @param params the params to apply to DynamoDB's function
      */
     async queryClassic(params) {
-        logger.debug(`Query classic ${params.TableName}`);
+        this.logger.debug(`Query classic ${params.TableName}`);
         const result = await this.dynamo.query(params).promise();
-        logger.debug(`Results query classic ${params.TableName}: ${result?.Items?.length || 0}`);
+        this.logger.debug(`Results query classic ${params.TableName}: ${result?.Items?.length || 0}`);
         return result;
     }
     /**
@@ -283,9 +284,9 @@ class DynamoDB {
      * @param params the params to apply to DynamoDB's function
      */
     async scanClassic(params) {
-        logger.debug(`Scan classic ${params.TableName}`);
+        this.logger.debug(`Scan classic ${params.TableName}`);
         const result = await this.dynamo.scan(params).promise();
-        logger.debug(`Results scan classic ${params.TableName}: ${result?.Items?.length || 0}`);
+        this.logger.debug(`Results scan classic ${params.TableName}: ${result?.Items?.length || 0}`);
         return result;
     }
     /**
@@ -294,8 +295,8 @@ class DynamoDB {
      */
     async transactWrites(ops) {
         if (!ops.length)
-            return logger.debug('Transaction writes: no elements to write');
-        logger.debug('Transaction writes');
+            return this.logger.debug('Transaction writes: no elements to write');
+        this.logger.debug('Transaction writes');
         await this.dynamo.transactWrite({ TransactItems: ops.slice(0, 10) }).promise();
     }
     /**

package/dist/src/genericController.d.ts

@@ -1,3 +1,4 @@
+import 'source-map-support/register';
 import { Logger } from './logger';
 /**
  * An abstract class to inherit to manage some resources with an AWS Lambda function.

package/dist/src/genericController.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenericController = void 0;
+require("source-map-support/register");
 const logger_1 = require("./logger");
 /**
  * An abstract class to inherit to manage some resources with an AWS Lambda function.

package/dist/src/resourceController.d.ts

@@ -1,7 +1,5 @@
-import 'source-map-support/register';
 import { APIGatewayProxyEventV2, APIGatewayProxyEvent, Callback } from 'aws-lambda';
 import { CognitoUser, Auth0User } from 'idea-toolbox';
-import { Logger } from './logger';
 import { CloudWatchMetrics } from './metrics';
 import { GenericController } from './genericController';
 /**
@@ -29,7 +27,6 @@ export declare abstract class ResourceController extends GenericController {
     protected clientVersion: string;
     protected clientPlatform: string;
     protected returnStatusCode?: number;
-    protected logger: Logger;
     protected logRequestsWithKey: string;
     protected metrics: CloudWatchMetrics;
     protected currentLang: string;

package/dist/src/resourceController.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RCError = exports.ResourceController = void 0;
-require("source-map-support/register");
 const fs_1 = require("fs");
 const aws_sdk_1 = require("aws-sdk");
 const idea_toolbox_1 = require("idea-toolbox");
-const logger_1 = require("./logger");
 const metrics_1 = require("./metrics");
 const genericController_1 = require("./genericController");
 const dynamoDB_1 = require("./dynamoDB");
@@ -21,7 +19,6 @@ class ResourceController extends genericController_1.GenericController {
         this.resource = process?.env?.RESOURCE;
         this.clientVersion = '?';
         this.clientPlatform = '?';
-        this.logger = new logger_1.Logger();
         this.templateMatcher = /{{\s?([^{}\s]*)\s?}}/g;
         ///
         /// REQUEST HANDLERS

package/dist/src/s3.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { S3 as AWSS3 } from 'aws-sdk';
 import { SignedURL } from 'idea-toolbox';
+import { Logger } from './logger';
 /**
  * A wrapper for AWS Simple Storage Service.
  */
@@ -10,10 +11,10 @@ export declare class S3 {
     protected DEFAULT_DOWNLOAD_BUCKET: string;
     protected DEFAULT_DOWNLOAD_BUCKET_SEC_TO_EXP: number;
     protected DEFAULT_UPLOAD_BUCKET_SEC_TO_EXP: number;
-    /**
-     * Initialize a new S3 helper object.
-     */
-    constructor();
+    logger: Logger;
+    constructor(options?: {
+        debug: boolean;
+    });
     /**
      * Create a download link of a piece of data (through S3).
      * *Practically*, it uploads the file on an S3 bucket, generating and returning a url to it.

package/dist/src/s3.js

@@ -4,20 +4,18 @@ exports.GetObjectTypes = exports.S3 = void 0;
 const aws_sdk_1 = require("aws-sdk");
 const idea_toolbox_1 = require("idea-toolbox");
 const logger_1 = require("./logger");
-const logger = new logger_1.Logger();
 /**
  * A wrapper for AWS Simple Storage Service.
  */
 class S3 {
-    /**
-     * Initialize a new S3 helper object.
-     */
-    constructor() {
+    constructor(options = { debug: true }) {
         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();
         this.s3 = new aws_sdk_1.S3({ apiVersion: '2006-03-01', signatureVersion: 'v4' });
+        this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }
     /**
      * Create a download link of a piece of data (through S3).
@@ -65,14 +63,14 @@ class S3 {
      * Make a copy of an object of the bucket.
      */
     async copyObject(options) {
-        logger.debug(`S3 copy object: ${options.key}`);
+        this.logger.debug(`S3 copy object: ${options.key}`);
         await this.s3.copyObject({ CopySource: options.copySource, Bucket: options.bucket, Key: options.key }).promise();
     }
     /**
      * Get an object from a S3 bucket.
      */
     async getObject(options) {
-        logger.debug(`S3 get object: ${options.key}`);
+        this.logger.debug(`S3 get object: ${options.key}`);
         const result = await this.s3.getObject({ Bucket: options.bucket, Key: options.key }).promise();
         switch (options.type) {
             case GetObjectTypes.JSON:
@@ -94,21 +92,21 @@ class S3 {
             params.ACL = options.acl;
         if (options.metadata)
             params.Metadata = options.metadata;
-        logger.debug(`S3 put object: ${options.key}`);
+        this.logger.debug(`S3 put object: ${options.key}`);
         return await this.s3.putObject(params).promise();
     }
     /**
      * Delete an object from an S3 bucket.
      */
     async deleteObject(options) {
-        logger.debug(`S3 delete object: ${options.key}`);
+        this.logger.debug(`S3 delete object: ${options.key}`);
         return await this.s3.deleteObject({ Bucket: options.bucket, Key: options.key }).promise();
     }
     /**
      * List the objects of an S3 bucket.
      */
     async listObjects(options) {
-        logger.debug(`S3 list object: ${options.prefix}`);
+        this.logger.debug(`S3 list object: ${options.prefix}`);
         return await this.s3.listObjects({ Bucket: options.bucket, Prefix: options.prefix }).promise();
     }
     /**

package/dist/src/ses.d.ts

@@ -2,13 +2,16 @@
 import { SES as AWSSES } from 'aws-sdk';
 import { SentMessageInfo as NodemailerSentMessageInfo } from 'nodemailer';
 import { Headers } from 'nodemailer/lib/mailer';
+import { Logger } from './logger';
 /**
  * A wrapper for AWS Simple Email Service.
  */
 export declare class SES {
     protected ses: AWSSES;
-    constructor(params?: {
+    logger: Logger;
+    constructor(options?: {
         region?: string;
+        debug: boolean;
     });
     getTemplate(templateName: string): Promise<AWSSES.Template>;
     setTemplate(templateName: string, subject: string, content: string, isHTML?: boolean): Promise<void>;

package/dist/src/ses.js

@@ -5,13 +5,14 @@ const aws_sdk_1 = require("aws-sdk");
 const nodemailer_1 = require("nodemailer");
 const dynamoDB_1 = require("./dynamoDB");
 const logger_1 = require("./logger");
-const logger = new logger_1.Logger();
 /**
  * A wrapper for AWS Simple Email Service.
  */
 class SES {
-    constructor(params = {}) {
-        this.ses = new aws_sdk_1.SES({ region: params.region });
+    constructor(options = { debug: true }) {
+        this.logger = new logger_1.Logger();
+        this.ses = new aws_sdk_1.SES({ region: options.region });
+        this.logger.level = options.debug ? 'DEBUG' : 'INFO';
     }
     //
     // CONFIG
@@ -64,7 +65,7 @@ class SES {
             ses = this.ses;
         else
             ses = new aws_sdk_1.SES({ region: sesParams.region });
-        logger.debug('SES send templated email');
+        this.logger.debug('SES send templated email');
         return await ses.sendTemplatedEmail(request).promise();
     }
     /**
@@ -104,7 +105,7 @@ class SES {
             ses = this.ses;
         else
             ses = new aws_sdk_1.SES({ region: sesParams.region });
-        logger.debug('SES send email');
+        this.logger.debug('SES send email');
         return await ses.sendEmail(request).promise();
     }
     async sendEmailWithNodemailer(emailData, sesParams) {
@@ -128,7 +129,7 @@ class SES {
             ses = this.ses;
         else
             ses = new aws_sdk_1.SES({ region: sesParams.region });
-        logger.debug('SES send email (Nodemailer)');
+        this.logger.debug('SES send email (Nodemailer)');
         return await (0, nodemailer_1.createTransport)({ SES: ses }).sendMail(mailOptions);
     }
     prepareEmailDestination(emailData) {

package/dist/src/sns.d.ts

@@ -1,8 +1,13 @@
 import { PushNotificationsPlatforms } from 'idea-toolbox';
+import { Logger } from './logger';
 /**
  * A wrapper for AWS Simple Notification Service.
  */
 export declare class SNS {
+    logger: Logger;
+    constructor(options?: {
+        debug: boolean;
+    });
     /**
      * Create a new endpoint in the SNS platform specified.
      * @return platform endpoint ARN

package/dist/src/sns.js

@@ -4,11 +4,14 @@ exports.SNS = void 0;
 const aws_sdk_1 = require("aws-sdk");
 const idea_toolbox_1 = require("idea-toolbox");
 const logger_1 = require("./logger");
-const logger = new logger_1.Logger();
 /**
  * A wrapper for AWS Simple Notification Service.
  */
 class SNS {
+    constructor(options = { debug: true }) {
+        this.logger = new logger_1.Logger();
+        this.logger.level = options.debug ? 'DEBUG' : 'INFO';
+    }
     /**
      * Create a new endpoint in the SNS platform specified.
      * @return platform endpoint ARN
@@ -28,7 +31,7 @@ class SNS {
             default:
                 throw new Error('Unsupported platform');
         }
-        logger.debug('SNS ADD PLATFORM ENDPOINT');
+        this.logger.debug('SNS ADD PLATFORM ENDPOINT');
         const result = await new aws_sdk_1.SNS({ apiVersion: '2010-03-31', region: snsParams.region })
             .createPlatformEndpoint({ PlatformApplicationArn: platformARN, Token: token })
             .promise();
@@ -57,7 +60,7 @@ class SNS {
                 default:
                     throw new Error('Unsupported platform');
             }
-        logger.debug('SNS PUBLISH IN TOPIC');
+        this.logger.debug('SNS PUBLISH IN TOPIC');
         return await new aws_sdk_1.SNS({ apiVersion: '2010-03-31', region: snsParams.region })
             .publish({ MessageStructure: 'json', Message: JSON.stringify(structuredMessage), TargetArn: snsParams.endpoint })
             .promise();

package/dist/src/streamController.js

@@ -2,8 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamController = void 0;
 const genericController_1 = require("./genericController");
-const logger_1 = require("./logger");
-const logger = new logger_1.Logger();
 /**
  * An abstract class to inherit to manage AWS DDB streams in an AWS Lambda function.
  */
@@ -11,7 +9,7 @@ class StreamController extends genericController_1.GenericController {
     constructor(event, callback) {
         super(event, callback);
         this.records = event.Records ?? [];
-        logger.info(`START STREAM: ${this.records.length ?? 0} records`);
+        this.logger.info(`START STREAM: ${this.records.length ?? 0} records`);
     }
 }
 exports.StreamController = StreamController;

package/dist/src/translate.d.ts

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

package/dist/src/translate.js

@@ -10,8 +10,8 @@ class Translate {
     /**
      * Initialize a new Translate helper object.
      */
-    constructor(params = {}) {
-        this.translate = new aws_sdk_1.Translate({ apiVersion: '2017-07-01', region: params.region });
+    constructor(options = {}) {
+        this.translate = new aws_sdk_1.Translate({ apiVersion: '2017-07-01', region: options.region });
         this.sourceLanguageCode = 'en';
         this.targetLanguageCode = 'en';
         this.terminologyNames = new Array();

package/docs.style.css

@@ -0,0 +1,4 @@
+.tsd-hierarchy,
+.tsd-index-summary {
+  display: none;
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "idea-aws",
-  "version": "3.16.2",
+  "version": "3.16.4",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "lint": "eslint --ext .ts",
     "compile": "tsc --build",
-    "docs": "typedoc index.ts",
+    "docs": "typedoc index.ts --customCss ./docs.style.css",
     "build": "./build.sh",
     "publishPackage": "./build.sh && npm publish"
   },
@@ -37,7 +37,7 @@
   "homepage": "https://iter-idea.github.io/IDEA-AWS",
   "dependencies": {
     "@aws-lambda-powertools/metrics": "^1.4.1",
-    "idea-toolbox": "^6.6.3",
+    "idea-toolbox": "^6.6.8",
     "nanoid": "^3.3.4",
     "nodemailer": "^6.7.7",
     "shortid": "^2.2.16",