idea-aws 4.4.4 → 4.4.5

package/dist/src/metrics.d.ts

@@ -0,0 +1,31 @@
+import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
+/**
+ * A wrapper for simple uses of CloudWatch Metrics.
+ */
+export declare class CloudWatchMetrics {
+    private metrics;
+    constructor(options?: {
+        project?: string;
+    });
+    /**
+     * Get the raw Metrics object. To use for custom purposes.
+     */
+    __raw(): Metrics;
+    /**
+     * Add an entry for the metrics.
+     */
+    addMetric(metricName: string, value?: number, unit?: MetricUnits): void;
+    /**
+     * Add a metadata useful when you want to search highly contextual information along with your metrics in your logs.
+     */
+    addMetadata(key: string, value: string): void;
+    /**
+     * Add an additional metrics dimension.
+     */
+    addDimension(name: string, value: string, defaultValue?: string): void;
+    /**
+     * Synchronous function to actually publish your metrics.
+     * It will create a new EMF blob and log it to be then ingested by Cloudwatch logs and processed for metrics creation.
+     */
+    publishStoredMetrics(): void;
+}

package/dist/src/metrics.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudWatchMetrics = void 0;
+const metrics_1 = require("@aws-lambda-powertools/metrics");
+/**
+ * A wrapper for simple uses of CloudWatch Metrics.
+ */
+class CloudWatchMetrics {
+    constructor(options = {}) {
+        const namespace = options.project ?? 'unknownProject';
+        this.metrics = new metrics_1.Metrics({ namespace });
+    }
+    /**
+     * Get the raw Metrics object. To use for custom purposes.
+     */
+    __raw() {
+        return this.metrics;
+    }
+    /**
+     * Add an entry for the metrics.
+     */
+    addMetric(metricName, value = 1, unit = metrics_1.MetricUnits.Count) {
+        this.metrics.addMetric(metricName, unit, value);
+    }
+    /**
+     * Add a metadata useful when you want to search highly contextual information along with your metrics in your logs.
+     */
+    addMetadata(key, value) {
+        this.metrics.addMetadata(key, value);
+    }
+    /**
+     * Add an additional metrics dimension.
+     */
+    addDimension(name, value, defaultValue = '-') {
+        this.metrics.addDimension(name, value ?? defaultValue);
+    }
+    /**
+     * Synchronous function to actually publish your metrics.
+     * It will create a new EMF blob and log it to be then ingested by Cloudwatch logs and processed for metrics creation.
+     */
+    publishStoredMetrics() {
+        this.metrics.publishStoredMetrics();
+    }
+}
+exports.CloudWatchMetrics = CloudWatchMetrics;

package/dist/src/resourceController.d.ts

@@ -0,0 +1,232 @@
+import { Tracer } from '@aws-lambda-powertools/tracer';
+import { APIGatewayProxyEventV2, APIGatewayProxyEvent, Callback } from 'aws-lambda';
+import { CognitoUser, Auth0User } from 'idea-toolbox';
+import { CloudWatchMetrics } from './metrics';
+import { GenericController } from './genericController';
+/**
+ * An abstract class to inherit to manage API requests (AWS API Gateway) in an AWS Lambda function.
+ */
+export declare abstract class ResourceController extends GenericController {
+    protected event: APIGatewayProxyEventV2 | APIGatewayProxyEvent;
+    protected callback: Callback;
+    protected initError: boolean;
+    protected authorization: string;
+    protected claims: any;
+    protected principalId: string;
+    protected cognitoUser: CognitoUser;
+    protected auth0User: Auth0User;
+    protected project: string;
+    protected stage: string;
+    protected httpMethod: string;
+    protected body: any;
+    protected queryParams: any;
+    protected resourcePath: string;
+    protected path: string;
+    protected pathParameters: any;
+    protected resource: string;
+    protected resourceId: string;
+    protected clientVersion: string;
+    protected clientPlatform: string;
+    protected clientBundle: string;
+    protected returnStatusCode?: number;
+    protected logRequestsWithKey: string;
+    protected metrics: CloudWatchMetrics;
+    protected tracer: Tracer;
+    protected currentLang: string;
+    protected defaultLang: string;
+    protected translations: any;
+    protected templateMatcher: RegExp;
+    constructor(event: APIGatewayProxyEventV2 | APIGatewayProxyEvent, callback: Callback, options?: ResourceControllerOptions);
+    private initFromEventV2;
+    private initFromEventV1;
+    protected getEventSummary(): Record<string, any>;
+    /**
+     * Force the parsing of a query parameter as an array of strings.
+     */
+    protected getQueryParamAsArray(paramName: string): string[];
+    handleRequest: () => Promise<void>;
+    protected done(error?: Error | any, rawResult?: any, statusCode?: number): void;
+    /**
+     * To @override
+     */
+    protected checkAuthBeforeRequest(): Promise<void>;
+    /**
+     * To @override
+     */
+    protected getResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected postResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected putResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected deleteResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected headResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected getResources(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected postResources(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected putResources(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected patchResource(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected patchResources(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected deleteResources(): Promise<any>;
+    /**
+     * To @override
+     */
+    protected headResources(): Promise<any>;
+    /**
+     * Store the log associated to the request (no response/error handling).
+     */
+    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.
+     */
+    protected sharedResourceExists(filePath: string): boolean;
+    /**
+     * Load a shared resource 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.
+     */
+    protected loadSharedResource(filePath: string): string;
+    /**
+     * Prepare the CloudWatch metrics at the beginning of a request.
+     */
+    protected prepareMetrics(): void;
+    /**
+     * Publish the CloudWatch metrics (default and custom-defined) at the end of a reqeust.
+     */
+    protected publishMetrics(statusCode: number, error?: any): void;
+    /**
+     * Simulate an internal API request, invoking directly the lambda and therefore saving resources.
+     * @return the body of the response
+     * @deprecated don't run a Lambda from another Lambda (bad practice)
+     */
+    invokeInternalAPIRequest(params: InternalAPIRequestParams): Promise<any>;
+    private invokeInternalAPIRequestWithLambda;
+    private invokeInternalAPIRequestWithEventBridge;
+    private mapEventForInternalApiRequest;
+    /**
+     * Whether the current request comes from an internal API request, i.e. it was invoked by another controller.
+     * @deprecated don't run a Lambda from another Lambda (bad practice)
+     */
+    comesFromInternalRequest(): boolean;
+    /**
+     * Load the translations from the shared resources and set them with a fallback language.
+     */
+    loadTranslations(lang: string, defLang?: string): void;
+    /**
+     * Get a translated term by key, optionally interpolating variables (e.g. `{{user}}`).
+     * If the term doesn't exist in the current language, it is searched in the default language.
+     */
+    t(key: string, interpolateParams?: any): string;
+    /**
+     * Interpolates a string to replace parameters.
+     * `"This is a {{ key }}"` ==> `"This is a value", with params = { key: "value" }`.
+     */
+    private interpolate;
+    /**
+     * Gets a value from an object by composed key.
+     * `getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA')` ==> `'valueI'`.
+     */
+    private getValue;
+    /**
+     * Helper to quicly check if the value is defined.
+     */
+    private isDefined;
+}
+/**
+ * The initial options for a constructor of class ResourceController.
+ */
+export interface ResourceControllerOptions {
+    /**
+     * The resourceId of the API request, to specify if different from "proxy".
+     */
+    resourceId?: string;
+    /**
+     * 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 instance of the tracer to use in case of advanced monitoring.
+     */
+    tracer?: Tracer;
+}
+/**
+ * The parameters needed to invoke an internal API request.
+ * @deprecated don't run a Lambda from another Lambda (bad practice).
+ */
+export interface InternalAPIRequestParams {
+    /**
+     * The name of the Lambda function receiving the request; e.g. `project_memberships`.
+     * Note: the invocation is always syncronous.
+     * Either this attribute or `eventBus` must be set.
+     */
+    lambda?: string;
+    /**
+     * The EventBridge destination of the request.
+     * If the bus name or ARN isn't specified, the default one is used.
+     * The `target` maps into the `DetailType` of the event.
+     * Note: the invocation is always asyncronous.
+     * Either this attribute or `lambda` must be set.
+     */
+    eventBridge?: {
+        bus?: string;
+        target?: string;
+    };
+    /**
+     * The alias of the lambda function to invoke. Default: the value of the current API stage.
+     */
+    stage?: string;
+    /**
+     * The http method to use.
+     */
+    httpMethod: string;
+    /**
+     * The path (in the internal API) to the resource we need; e.g. `teams/{teamId}/memberships/{userId}`.
+     */
+    resource: string;
+    /**
+     * The parameters to substitute in the path.
+     */
+    pathParams?: {
+        [index: string]: string | number;
+    };
+    /**
+     * The parameters to substitute in the path.
+     */
+    queryParams?: {
+        [index: string]: string | number;
+    };
+    /**
+     * The body of the request.
+     */
+    body?: any;
+}