idea-aws 3.15.2 → 3.16.0

package/dist/src/genericController.d.ts

@@ -1,12 +1,3 @@
-import { DynamoDB } from './dynamoDB';
-import { Cognito } from './cognito';
-import { S3 } from './s3';
-import { SES } from './ses';
-import { SNS } from './sns';
-import { Translate } from './translate';
-import { Comprehend } from './comprehend';
-import { SecretsManager } from './secretsManager';
-import { Attachments } from './attachments';
 import { Logger } from './logger';
 /**
  * An abstract class to inherit to manage some resources with an AWS Lambda function.
@@ -14,24 +5,13 @@ import { Logger } from './logger';
 export declare abstract class GenericController {
     protected event: any;
     protected callback: any;
-    protected _dynamoDB: DynamoDB;
-    protected _cognito: Cognito;
-    protected _s3: S3;
-    protected _ses: SES;
-    protected _sns: SNS;
-    protected _translate: Translate;
-    protected _comprehend: Comprehend;
-    protected _secrets: SecretsManager;
-    protected _attachments: Attachments;
-    tables: any;
     protected logger: Logger;
-    protected logRequestsWithKey: string;
     /**
      * Initialize a new GenericController helper object.
      * @param event the event that invoked the AWS lambda function
      * @param callback the callback to resolve or reject the execution
      */
-    constructor(event: any, callback: any, options?: GenericControllerOptions);
+    constructor(event: any, callback: any);
     /**
      * The main function, that handle the request and should terminate with an invokation of the method `done`.
      */
@@ -40,63 +20,4 @@ export declare abstract class GenericController {
      * Default callback for the Lambda.
      */
     protected done(err: any, res?: any): void;
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get dynamoDB(): DynamoDB;
-    protected set dynamoDB(dynamoDB: DynamoDB);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get cognito(): Cognito;
-    protected set cognito(cognito: Cognito);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get s3(): S3;
-    protected set s3(s3: S3);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get ses(): SES;
-    protected set ses(ses: SES);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get sns(): SNS;
-    protected set sns(sns: SNS);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get translate(): Translate;
-    protected set translate(translate: Translate);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get comprehend(): Comprehend;
-    protected set comprehend(comprehend: Comprehend);
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    protected get secrets(): SecretsManager;
-    protected set secrets(secrets: SecretsManager);
-    /**
-     * Manage attachments (through SignedURLs).
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get attachments(): Attachments;
-    set attachments(attachments: Attachments);
-}
-/**
- * The initial options for a constructor of class GenericController.
- * @deprecated following new IAC standards.
- */
-export interface GenericControllerOptions {
-    /**
-     * The AWS DDB tables involved, as a map of shortcut and names.
-     * e.g. `{ users: 'project_users' }`.
-     */
-    tables?: {
-        [table: string]: string;
-    };
 }

package/dist/src/genericController.js

@@ -1,15 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenericController = void 0;
-const dynamoDB_1 = require("./dynamoDB");
-const cognito_1 = require("./cognito");
-const s3_1 = require("./s3");
-const ses_1 = require("./ses");
-const sns_1 = require("./sns");
-const translate_1 = require("./translate");
-const comprehend_1 = require("./comprehend");
-const secretsManager_1 = require("./secretsManager");
-const attachments_1 = require("./attachments");
 const logger_1 = require("./logger");
 /**
  * An abstract class to inherit to manage some resources with an AWS Lambda function.
@@ -20,11 +11,10 @@ class GenericController {
      * @param event the event that invoked the AWS lambda function
      * @param callback the callback to resolve or reject the execution
      */
-    constructor(event, callback, options = {}) {
+    constructor(event, callback) {
         this.logger = new logger_1.Logger();
         this.event = event;
         this.callback = callback;
-        this.tables = options.tables || {};
     }
     /**
      * Default callback for the Lambda.
@@ -36,111 +26,5 @@ class GenericController {
             this.logger.info('END-SUCCESS');
         this.callback(err, res);
     }
-    ///
-    /// AWS SERVICES
-    ///
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get dynamoDB() {
-        if (!this._dynamoDB)
-            this._dynamoDB = new dynamoDB_1.DynamoDB();
-        return this._dynamoDB;
-    }
-    set dynamoDB(dynamoDB) {
-        this._dynamoDB = dynamoDB;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get cognito() {
-        if (!this._cognito)
-            this._cognito = new cognito_1.Cognito();
-        return this._cognito;
-    }
-    set cognito(cognito) {
-        this._cognito = cognito;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get s3() {
-        if (!this._s3)
-            this._s3 = new s3_1.S3();
-        return this._s3;
-    }
-    set s3(s3) {
-        this._s3 = s3;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get ses() {
-        if (!this._ses)
-            this._ses = new ses_1.SES();
-        return this._ses;
-    }
-    set ses(ses) {
-        this._ses = ses;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get sns() {
-        if (!this._sns)
-            this._sns = new sns_1.SNS();
-        return this._sns;
-    }
-    set sns(sns) {
-        this._sns = sns;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get translate() {
-        if (!this._translate)
-            this._translate = new translate_1.Translate();
-        return this._translate;
-    }
-    set translate(translate) {
-        this._translate = translate;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get comprehend() {
-        if (!this._comprehend)
-            this._comprehend = new comprehend_1.Comprehend();
-        return this._comprehend;
-    }
-    set comprehend(comprehend) {
-        this._comprehend = comprehend;
-    }
-    /**
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get secrets() {
-        if (!this._secrets)
-            this._secrets = new secretsManager_1.SecretsManager();
-        return this._secrets;
-    }
-    set secrets(secrets) {
-        this._secrets = secrets;
-    }
-    ///
-    /// HELPERS
-    ///
-    /**
-     * Manage attachments (through SignedURLs).
-     * @deprecated use external object to improve cold starts. See most recent projects for reference.
-     */
-    get attachments() {
-        if (!this._attachments)
-            this._attachments = new attachments_1.Attachments();
-        return this._attachments;
-    }
-    set attachments(attachments) {
-        this._attachments = attachments;
-    }
 }
 exports.GenericController = GenericController;

package/dist/src/resourceController.d.ts

@@ -3,7 +3,8 @@ import { APIGatewayProxyEventV2, APIGatewayProxyEvent, Callback } from 'aws-lamb
 import { CognitoUser, Auth0User } from 'idea-toolbox';
 import { Logger } from './logger';
 import { CloudWatchMetrics } from './metrics';
-import { GenericController, GenericControllerOptions } from './genericController';
+import { GenericController } from './genericController';
+import { DynamoDB } from './dynamoDB';
 /**
  * An abstract class to inherit to manage API requests (AWS API Gateway) in an AWS Lambda function.
  */
@@ -31,6 +32,7 @@ export declare abstract class ResourceController extends GenericController {
     protected returnStatusCode?: number;
     protected logger: Logger;
     protected logRequestsWithKey: string;
+    protected ddbToLogRequests: DynamoDB;
     protected metrics: CloudWatchMetrics;
     protected currentLang: string;
     protected defaultLang: string;
@@ -101,7 +103,7 @@ export declare abstract class ResourceController extends GenericController {
     /**
      * Store the log associated to the request (no response/error handling).
      */
-    protected storeLog(succeeded: boolean): void;
+    protected storeLog(succeeded: boolean): Promise<void>;
     /**
      * Check whether shared resource exists in the back-end (translation, template, etc.).
      * Search for the specified file path in both the Lambda function's main folder and the layers folder.
@@ -161,7 +163,7 @@ export declare abstract class ResourceController extends GenericController {
 /**
  * The initial options for a constructor of class ResourceController.
  */
-export interface ResourceControllerOptions extends GenericControllerOptions {
+export interface ResourceControllerOptions {
     /**
      * The resourceId of the API request, to specify if different from "proxy".
      */
@@ -170,6 +172,10 @@ export interface ResourceControllerOptions extends GenericControllerOptions {
      * If set, the logs of the API requests on this resource will be stored (using this key).
      */
     logRequestsWithKey?: string;
+    /**
+     * Whether to automatically store usage metrics on CloudWatch.
+     */
+    useMetrics?: boolean;
 }
 /**
  * The parameters needed to invoke an internal API request.

package/dist/src/resourceController.js

@@ -8,12 +8,13 @@ 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");
 /**
  * An abstract class to inherit to manage API requests (AWS API Gateway) in an AWS Lambda function.
  */
 class ResourceController extends genericController_1.GenericController {
     constructor(event, callback, options = {}) {
-        super(event, callback, options);
+        super(event, callback);
         this.initError = false;
         this.project = process?.env?.PROJECT;
         this.stage = process?.env?.STAGE;
@@ -21,7 +22,6 @@ class ResourceController extends genericController_1.GenericController {
         this.clientVersion = '?';
         this.clientPlatform = '?';
         this.logger = new logger_1.Logger();
-        this.metrics = new metrics_1.CloudWatchMetrics({ project: this.project });
         this.templateMatcher = /{{\s?([^{}\s]*)\s?}}/g;
         ///
         /// REQUEST HANDLERS
@@ -101,6 +101,8 @@ class ResourceController extends genericController_1.GenericController {
             else
                 this.initFromEventV1(event, options);
             this.logRequestsWithKey = options.logRequestsWithKey;
+            if (this.logRequestsWithKey)
+                this.ddbToLogRequests = new dynamoDB_1.DynamoDB();
             // acquire some info about the client, if available
             if (this.queryParams['_v']) {
                 this.clientVersion = this.queryParams['_v'];
@@ -110,7 +112,8 @@ class ResourceController extends genericController_1.GenericController {
                 this.clientPlatform = this.queryParams['_p'];
                 delete this.queryParams['_p'];
             }
-            this.prepareMetrics();
+            if (options.useMetrics)
+                this.prepareMetrics();
             // print the initial log
             const info = {
                 principalId: this.principalId,
@@ -195,7 +198,8 @@ class ResourceController extends genericController_1.GenericController {
             this.logger.info('END-SUCCESS', { statusCode });
         if (this.logRequestsWithKey)
             this.storeLog(!err);
-        this.publishMetrics(statusCode, err);
+        if (this.metrics)
+            this.publishMetrics(statusCode, err);
         this.callback(null, {
             statusCode: String(statusCode),
             body: err ? JSON.stringify({ message: err.message }) : JSON.stringify(res || {}),
@@ -286,7 +290,7 @@ class ResourceController extends genericController_1.GenericController {
     /**
      * Store the log associated to the request (no response/error handling).
      */
-    storeLog(succeeded) {
+    async storeLog(succeeded) {
         const log = new idea_toolbox_1.APIRequestLog({
             logId: this.logRequestsWithKey,
             userId: this.principalId,
@@ -299,9 +303,12 @@ class ResourceController extends genericController_1.GenericController {
         // optionally add a track of the action
         if (this.httpMethod === 'PATCH' && this.body && this.body.action)
             log.action = this.body.action;
-        this.dynamoDB.put({ TableName: 'idea_logs', Item: log }).catch(() => {
-            /* ignore */
-        });
+        try {
+            await this.ddbToLogRequests.put({ TableName: 'idea_logs', Item: log });
+        }
+        catch (error) {
+            // ignore
+        }
     }
     /**
      * Check whether shared resource exists in the back-end (translation, template, etc.).
@@ -326,6 +333,7 @@ class ResourceController extends genericController_1.GenericController {
      * Prepare the CloudWatch metrics at the beginning of a request.
      */
     prepareMetrics() {
+        this.metrics = new metrics_1.CloudWatchMetrics({ project: this.project });
         this.metrics.addDimension('stage', this.stage);
         this.metrics.addDimension('resource', this.resource);
         this.metrics.addDimension('method', this.httpMethod);
@@ -340,6 +348,8 @@ class ResourceController extends genericController_1.GenericController {
      * Publish the CloudWatch metrics (default and custom-defined) at the end of a reqeust.
      */
     publishMetrics(statusCode, error) {
+        if (!this.metrics)
+            return;
         this.metrics.addMetric('request');
         this.metrics.addMetric('statusCode', statusCode);
         if (error) {

package/dist/src/streamController.d.ts

@@ -1,8 +1,8 @@
-import { GenericController, GenericControllerOptions } from './genericController';
+import { GenericController } from './genericController';
 /**
  * An abstract class to inherit to manage AWS DDB streams in an AWS Lambda function.
  */
 export declare abstract class StreamController extends GenericController {
     records: any[];
-    constructor(event: any, callback: any, options?: GenericControllerOptions);
+    constructor(event: any, callback: any);
 }

package/dist/src/streamController.js

@@ -8,10 +8,10 @@ const logger = new logger_1.Logger();
  * An abstract class to inherit to manage AWS DDB streams in an AWS Lambda function.
  */
 class StreamController extends genericController_1.GenericController {
-    constructor(event, callback, options = {}) {
-        super(event, callback, options);
-        this.records = event.Records || [];
-        logger.info(`START STREAM: ${this.records.length || 0} records`);
+    constructor(event, callback) {
+        super(event, callback);
+        this.records = event.Records ?? [];
+        logger.info(`START STREAM: ${this.records.length ?? 0} records`);
     }
 }
 exports.StreamController = StreamController;

package/package.json

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