@comicrelief/lambda-wrapper 1.10.1 → 2.0.0-beta.2

package/dist/services/LoggerService.js

@@ -0,0 +1,258 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Sentry = __importStar(require("@sentry/node"));
+const epsagon_1 = __importDefault(require("epsagon"));
+const winston_1 = __importDefault(require("winston"));
+const DependencyAwareClass_1 = __importDefault(require("../core/DependencyAwareClass"));
+const sentryIsAvailable = typeof process.env.RAVEN_DSN !== 'undefined' && typeof process.env.RAVEN_DSN === 'string' && process.env.RAVEN_DSN !== 'undefined';
+// initialise the Sentry client if available
+if (sentryIsAvailable) {
+    Sentry.init({
+        dsn: process.env.RAVEN_DSN,
+        shutdownTimeout: 5,
+        environment: process.env.STAGE,
+    });
+}
+/**
+ * Provides logging and integrations with our monitoring tools.
+ *
+ * For logging we use [Winston](https://github.com/winstonjs/winston).
+ * Errors will also be sent to [Sentry](https://sentry.io/) and
+ * [Epsagon](https://epsagon.com/) if those are available.
+ */
+class LoggerService extends DependencyAwareClass_1.default {
+    constructor(di) {
+        super(di);
+        this.sentry = null;
+        this.winston = null;
+        const { event, context } = this.di;
+        if (sentryIsAvailable && !di.isOffline) {
+            Sentry.configureScope((scope) => {
+                scope.setTags({
+                    Event: event,
+                    Context: context,
+                });
+                scope.setExtras({
+                    lambda: context.functionName,
+                    memory_size: context.memoryLimitInMB,
+                    log_group: context.logGroupName,
+                    log_stream: context.logStreamName,
+                    stage: process.env.STAGE,
+                    path: event.path,
+                    httpMethod: event.httpMethod,
+                });
+            });
+            this.sentry = Sentry;
+        }
+    }
+    /**
+     * Returns a Winston logger configured for our lambdas.
+     *
+     * Note: If the lambda is executed in a `serverless-offline` context, the
+     * log output to console will be pretty-printed.
+     */
+    getLogger() {
+        const loggerFormats = [
+            winston_1.default.format.json({
+                replacer: (key, value) => {
+                    if (value instanceof Buffer) {
+                        return value.toString('base64');
+                    }
+                    if (value instanceof Error) {
+                        return Object.fromEntries(Object.getOwnPropertyNames(value)
+                            .map((errorKey) => [errorKey, value[errorKey]]));
+                    }
+                    return value;
+                },
+            }),
+        ];
+        if (this.di.isOffline) {
+            loggerFormats.push(winston_1.default.format.prettyPrint());
+        }
+        return winston_1.default.createLogger({
+            level: 'info',
+            format: winston_1.default.format.combine(...loggerFormats),
+            transports: [new winston_1.default.transports.Console()],
+        });
+    }
+    /**
+     * Returns the logger.
+     *
+     * Uses a cached Winston logger if it has been already created, otherwise it
+     * creates one.
+     */
+    get logger() {
+        if (!this.winston) {
+            this.winston = this.getLogger();
+        }
+        return this.winston;
+    }
+    /**
+     * Get Sentry client.
+     */
+    getSentry() {
+        return this.sentry;
+    }
+    /**
+     * While logging an error, we should recognise axios errors and trim down the
+     * information to only what is useful for debugging.
+     *
+     * Keep the following keys:
+     * - message.config
+     * - message.message
+     * - message.response?.status
+     * - message.response?.data
+     *
+     * @param {object} error
+     */
+    static processAxiosError(error) {
+        const processed = {
+            config: error.config,
+            message: error.message,
+        };
+        // It's pretty common for axios errors to not have a `response`,
+        // for example if there was a network error or timeout.
+        if (error.response) {
+            processed.response = {
+                status: error.response.status,
+                data: error.response.data,
+            };
+        }
+        return processed;
+    }
+    /**
+     * Transform the original message before it is passed to the logger.
+     *
+     * @param message
+     */
+    static processMessage(message) {
+        let processed = message;
+        if (processed?.isAxiosError) {
+            processed = LoggerService.processAxiosError(processed);
+        }
+        return processed;
+    }
+    /**
+     * Log Error Message
+     *
+     * @param error object
+     * @param message string
+     */
+    error(error, message = '') {
+        if (sentryIsAvailable && error instanceof Error) {
+            Sentry.captureException(error);
+        }
+        if (typeof process.env.EPSAGON_TOKEN === 'string'
+            && process.env.EPSAGON_TOKEN !== 'undefined'
+            && typeof process.env.EPSAGON_SERVICE_NAME === 'string'
+            && process.env.EPSAGON_SERVICE_NAME !== 'undefined'
+            && error instanceof Error) {
+            epsagon_1.default.setError(error);
+        }
+        this.logger.log('error', message, { error: LoggerService.processMessage(error) });
+        this.label('error', true);
+        this.metric('error', 'error', true);
+    }
+    /**
+     * Log an informational message.
+     *
+     * @param message
+     */
+    info(message) {
+        this.logger.log('info', LoggerService.processMessage(message));
+    }
+    /**
+     * Log an error, using `LoggerService.error` or `LoggerService.info` based
+     * on `process.env.LOGGER_SOFT_WARNING`.
+     *
+     * Please note that `LoggerService.error` and `LoggerService.info` have
+     * different signatures. The function uses the shared argument instead of
+     * introducing ambiguity.
+     *
+     * @param error
+     */
+    warning(error) {
+        const softWarningValues = ['true', '1'];
+        if (softWarningValues.includes(process.env.LOGGER_SOFT_WARNING || '')) {
+            return this.info(error);
+        }
+        return this.error(error);
+    }
+    /**
+     * Add a label to the function's Epsagon trace.
+     *
+     * @param descriptor
+     * @param silent If `false`, the label will also be logged. (default: false)
+     */
+    label(descriptor, silent = false) {
+        if (typeof process.env.EPSAGON_TOKEN === 'string'
+            && process.env.EPSAGON_TOKEN !== 'undefined'
+            && typeof process.env.EPSAGON_SERVICE_NAME === 'string'
+            && process.env.EPSAGON_SERVICE_NAME !== 'undefined') {
+            epsagon_1.default.label(descriptor, true);
+        }
+        if (!silent) {
+            this.logger.log('info', `label - ${descriptor}`);
+        }
+    }
+    /**
+     * Add a metric to the function's Epsagon trace.
+     *
+     * @param descriptor
+     * @param stat
+     * @param silent If `false`, the metric will also be logged. (default: false)
+     */
+    metric(descriptor, stat, silent = false) {
+        if (typeof process.env.EPSAGON_TOKEN === 'string'
+            && process.env.EPSAGON_TOKEN !== 'undefined'
+            && typeof process.env.EPSAGON_SERVICE_NAME === 'string'
+            && process.env.EPSAGON_SERVICE_NAME !== 'undefined') {
+            epsagon_1.default.label(descriptor, stat);
+        }
+        if (silent === false) {
+            this.logger.log('info', `metric - ${descriptor} - ${stat}`);
+        }
+    }
+    /**
+     * Log an object so that it can be inspected.
+     *
+     * @param action What are we doing with the object, e.g. 'Processing'
+     * @param object The object to be stored in logs
+     * @param level 'error', 'warning' or 'info'
+     */
+    object(action, object, level = 'info') {
+        if (!(['error', 'warning', 'info'].includes(level))) {
+            throw new Error('Unrecognised log level');
+        }
+        const payload = JSON.stringify(object, null, 4);
+        return this[level](`${action}: '${payload}'`);
+    }
+}
+exports.default = LoggerService;
+//# sourceMappingURL=LoggerService.js.map

package/dist/services/LoggerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoggerService.js","sourceRoot":"","sources":["../../src/services/LoggerService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAuC;AAEvC,sDAA8B;AAC9B,sDAA8B;AAE9B,wFAAgE;AAGhE,MAAM,iBAAiB,GAAG,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,WAAW,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,WAAW,CAAC;AAE7J,4CAA4C;AAC5C,IAAI,iBAAiB,EAAE;IACrB,MAAM,CAAC,IAAI,CAAC;QACV,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS;QAC1B,eAAe,EAAE,CAAC;QAClB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;KAC/B,CAAC,CAAC;CACJ;AAED;;;;;;GAMG;AACH,MAAqB,aAAc,SAAQ,8BAAoB;IAK7D,YAAY,EAAuB;QACjC,KAAK,CAAC,EAAE,CAAC,CAAC;QAEV,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAEnC,IAAI,iBAAiB,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE;YACtC,MAAM,CAAC,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9B,KAAK,CAAC,OAAO,CAAC;oBACZ,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,OAAc;iBACxB,CAAC,CAAC;gBACH,KAAK,CAAC,SAAS,CAAC;oBACd,MAAM,EAAE,OAAO,CAAC,YAAY;oBAC5B,WAAW,EAAE,OAAO,CAAC,eAAe;oBACpC,SAAS,EAAE,OAAO,CAAC,YAAY;oBAC/B,UAAU,EAAE,OAAO,CAAC,aAAa;oBACjC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;oBACxB,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,UAAU,EAAE,KAAK,CAAC,UAAU;iBAC7B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;IACH,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,MAAM,aAAa,GAAG;YACpB,iBAAO,CAAC,MAAM,CAAC,IAAI,CAAC;gBAClB,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oBACvB,IAAI,KAAK,YAAY,MAAM,EAAE;wBAC3B,OAAO,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;qBACjC;oBACD,IAAI,KAAK,YAAY,KAAK,EAAE;wBAC1B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC;6BAC9B,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAG,KAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC3D,CAAC;qBACH;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;aACF,CAAC;SACH,CAAC;QAEF,IAAI,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE;YACrB,aAAa,CAAC,IAAI,CAAC,iBAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;SAClD;QAED,OAAO,iBAAO,CAAC,YAAY,CAAC;YAC1B,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC;YAChD,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;SAC/C,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;SACjC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAiB;QACxC,MAAM,SAAS,GAAQ;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC;QAEF,gEAAgE;QAChE,uDAAuD;QACvD,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,SAAS,CAAC,QAAQ,GAAG;gBACnB,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM;gBAC7B,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;aAC1B,CAAC;SACH;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,OAAY;QAChC,IAAI,SAAS,GAAG,OAAO,CAAC;QAExB,IAAI,SAAS,EAAE,YAAY,EAAE;YAC3B,SAAS,GAAG,aAAa,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;SACxD;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAU,EAAE,OAAO,GAAG,EAAE;QAC5B,IAAI,iBAAiB,IAAI,KAAK,YAAY,KAAK,EAAE;YAC/C,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;SAChC;QAED,IACE,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ;eAC1C,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,WAAW;eACzC,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,QAAQ;eACpD,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,WAAW;eAChD,KAAK,YAAY,KAAK,EACzB;YACA,iBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClF,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAAY;QACf,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAU;QAChB,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAExC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC,EAAE;YACrE,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACzB;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,MAAM,GAAG,KAAK;QACtC,IACE,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ;eAC1C,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,WAAW;eACzC,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,QAAQ;eACpD,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,WAAW,EACnD;YACA,iBAAO,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;SACjC;QAED,IAAI,CAAC,MAAM,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,UAAU,EAAE,CAAC,CAAC;SAClD;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,IAAqB,EAAE,MAAM,GAAG,KAAK;QAC9D,IACE,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,QAAQ;eAC1C,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,WAAW;eACzC,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,QAAQ;eACpD,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,WAAW,EACnD;YACA,iBAAO,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;SACjC;QAED,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,UAAU,MAAM,IAAI,EAAE,CAAC,CAAC;SAC7D;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,MAAW,EAAE,QAAsC,MAAM;QAC9E,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEhD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC;IAChD,CAAC;CACF;AAzPD,gCAyPC"}

package/dist/services/RequestService.d.ts

@@ -0,0 +1,119 @@
+/// <reference types="node" />
+import { APIGatewayProxyEvent } from 'aws-lambda';
+import DependencyAwareClass from '../core/DependencyAwareClass';
+import ResponseModel from '../models/ResponseModel';
+export declare const REQUEST_TYPES: {
+    DELETE: string;
+    GET: string;
+    HEAD: string;
+    OPTIONS: string;
+    PATCH: string;
+    POST: string;
+    PUT: string;
+};
+export declare const HTTP_METHODS_WITHOUT_PAYLOADS: string[];
+export declare const HTTP_METHODS_WITH_PAYLOADS: string[];
+export declare const ERROR_TYPES: {
+    VALIDATION_ERROR: ResponseModel;
+};
+export declare type RequestFile = {
+    type: string;
+    filename: string;
+    contentType: string;
+    content: string | Buffer;
+};
+/**
+ * Provides access to components of the HTTP request being handled.
+ */
+export default class RequestService extends DependencyAwareClass {
+    /**
+     * Get a parameter from the request.
+     *
+     * @param parameter
+     * @param ifNull Value to return if the parameter is not set.
+     * @param requestType
+     */
+    get(parameter: string, ifNull?: string | null, requestType?: string): string | string[] | null;
+    /**
+     * Get all HTTP headers included in the request.
+     *
+     * @returns An object with a key for each header.
+     */
+    getAllHeaders(): {
+        [x: string]: string | undefined;
+    };
+    /**
+     * Get an HTTP header from the request.
+     *
+     * The header name is case-insensitive.
+     *
+     * @param name The name of the header.
+     * @param [whenMissing] Value to return if the header is missing.
+     *   (default: empty string)
+     */
+    getHeader(name: string, whenMissing?: string): string;
+    /**
+     * Get an authorization token from the `Authorization` header.
+     */
+    getAuthorizationToken(): string | null;
+    /**
+     * Get a path parameter, or all path parameters if no `parameter` is given.
+     *
+     * @param parameter
+     * @param ifNull Value to return if the parameter is not set.
+     */
+    getPathParameter(parameter?: string, ifNull?: {}): any;
+    /**
+     * Get all request parameters
+     *
+     * @param requestType
+     */
+    getAll(requestType?: string): any;
+    /**
+     * Fetch the request IP address
+     */
+    getIp(): string | null;
+    /**
+     * Get user agent details from the `User-Agent` header.
+     */
+    getUserBrowserAndDevice(): {
+        'browser-type': string;
+        'browser-version': string;
+        'device-type': string;
+        'operating-system': string;
+        'operating-system-version': string;
+    } | null;
+    /**
+     * Test a request against validation constraints.
+     *
+     * See [validate.js](https://validatejs.org/) for how to write constraints.
+     *
+     * @param constraints
+     */
+    validateAgainstConstraints(constraints: object): Promise<void>;
+    /**
+     * Fetch the request multipart form.
+     *
+     * @param useBuffer Whether to return file content as a `Buffer`.
+     */
+    parseForm(useBuffer: boolean): Record<string, string | RequestFile>;
+    /**
+     * Fetch the request AWS event Records
+     */
+    getAWSRecords(): any;
+    /**
+     * Gets a value independently from the case of the key.
+     *
+     * @param object
+     * @param key
+     */
+    static getValueIgnoringKeyCase(object: Record<string, string | undefined>, key: string): string | undefined;
+    /**
+     * Returns the content type
+     * assoiated with the request
+     *
+     * @param event
+     */
+    static getBoundary(event: APIGatewayProxyEvent): string | undefined;
+}
+//# sourceMappingURL=RequestService.d.ts.map

package/dist/services/RequestService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestService.d.ts","sourceRoot":"","sources":["../../src/services/RequestService.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAKlD,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,aAAa,MAAM,yBAAyB,CAAC;AAGpD,eAAO,MAAM,aAAa;;;;;;;;CAQzB,CAAC;AAEF,eAAO,MAAM,6BAA6B,UAKzC,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAItC,CAAC;AAGF,eAAO,MAAM,WAAW;;CAEvB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,oBAAoB;IAC9D;;;;;;OAMG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAU9F;;;;OAIG;IACH,aAAa;;;IAKb;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,SAAK,GAAG,MAAM;IAUjD;;OAEG;IACH,qBAAqB,IAAI,MAAM,GAAG,IAAI;IAgBtC;;;;;OAKG;IACH,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,GAAG,GAAG;IAqBtD;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,GAAG;IAyDjC;;OAEG;IACH,KAAK,IAAI,MAAM,GAAG,IAAI;IActB;;OAEG;IACH,uBAAuB;;;;;;;IAuBvB;;;;;;OAMG;IACH,0BAA0B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9D;;;;OAIG;IACH,SAAS,CAAC,SAAS,EAAE,OAAO;IAiC5B;;OAEG;IACH,aAAa;IAUb;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAM3G;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS;CAGpE"}

package/dist/services/RequestService.js

@@ -0,0 +1,293 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_TYPES = exports.HTTP_METHODS_WITH_PAYLOADS = exports.HTTP_METHODS_WITHOUT_PAYLOADS = exports.REQUEST_TYPES = void 0;
+const querystring_1 = __importDefault(require("querystring"));
+const useragent_1 = __importDefault(require("useragent"));
+const validate_1 = __importDefault(require("validate.js/validate"));
+const xml2js_1 = __importDefault(require("xml2js"));
+const DependencyAwareClass_1 = __importDefault(require("../core/DependencyAwareClass"));
+const ResponseModel_1 = __importDefault(require("../models/ResponseModel"));
+const LoggerService_1 = __importDefault(require("./LoggerService"));
+exports.REQUEST_TYPES = {
+    DELETE: 'DELETE',
+    GET: 'GET',
+    HEAD: 'HEAD',
+    OPTIONS: 'OPTIONS',
+    PATCH: 'PATCH',
+    POST: 'POST',
+    PUT: 'PUT',
+};
+exports.HTTP_METHODS_WITHOUT_PAYLOADS = [
+    exports.REQUEST_TYPES.DELETE,
+    exports.REQUEST_TYPES.GET,
+    exports.REQUEST_TYPES.HEAD,
+    exports.REQUEST_TYPES.OPTIONS,
+];
+exports.HTTP_METHODS_WITH_PAYLOADS = [
+    exports.REQUEST_TYPES.PATCH,
+    exports.REQUEST_TYPES.POST,
+    exports.REQUEST_TYPES.PUT,
+];
+// Define action specific error types
+exports.ERROR_TYPES = {
+    VALIDATION_ERROR: new ResponseModel_1.default({}, 400, 'required fields are missing'),
+};
+/**
+ * Provides access to components of the HTTP request being handled.
+ */
+class RequestService extends DependencyAwareClass_1.default {
+    /**
+     * Get a parameter from the request.
+     *
+     * @param parameter
+     * @param ifNull Value to return if the parameter is not set.
+     * @param requestType
+     */
+    get(parameter, ifNull, requestType) {
+        const queryParameters = this.getAll(requestType);
+        if (queryParameters === null) {
+            return ifNull ?? null;
+        }
+        return queryParameters[parameter] ?? ifNull ?? null;
+    }
+    /**
+     * Get all HTTP headers included in the request.
+     *
+     * @returns An object with a key for each header.
+     */
+    getAllHeaders() {
+        const event = this.getContainer().getEvent();
+        return { ...event.headers };
+    }
+    /**
+     * Get an HTTP header from the request.
+     *
+     * The header name is case-insensitive.
+     *
+     * @param name The name of the header.
+     * @param [whenMissing] Value to return if the header is missing.
+     *   (default: empty string)
+     */
+    getHeader(name, whenMissing = '') {
+        const headers = this.getAllHeaders();
+        if (!headers) {
+            return whenMissing;
+        }
+        const lowerName = name.toLowerCase();
+        const key = Object.keys(headers).find((k) => k.toLowerCase() === lowerName);
+        return (key && headers[key]) || whenMissing;
+    }
+    /**
+     * Get an authorization token from the `Authorization` header.
+     */
+    getAuthorizationToken() {
+        const authorization = this.getHeader('Authorization');
+        if (!authorization) {
+            return null;
+        }
+        const tokenParts = authorization.split(' ');
+        const tokenValue = tokenParts[1];
+        if (!(tokenParts[0].toLowerCase() === 'bearer' && tokenValue)) {
+            return null;
+        }
+        return tokenValue;
+    }
+    /**
+     * Get a path parameter, or all path parameters if no `parameter` is given.
+     *
+     * @param parameter
+     * @param ifNull Value to return if the parameter is not set.
+     */
+    getPathParameter(parameter, ifNull = {}) {
+        const event = this.getContainer().getEvent();
+        // If no parameter has been requested, return all path parameters
+        if (!parameter && typeof event.pathParameters === 'object') {
+            return event.pathParameters;
+        }
+        // If a specifc parameter has been requested, return the parameter if it exists
+        if (parameter
+            && typeof event.pathParameters === 'object'
+            && event.pathParameters !== null
+            && typeof event.pathParameters[parameter] !== 'undefined') {
+            return event.pathParameters[parameter];
+        }
+        return ifNull;
+    }
+    /**
+     * Get all request parameters
+     *
+     * @param requestType
+     */
+    getAll(requestType) {
+        const event = this.getContainer().getEvent();
+        if (exports.HTTP_METHODS_WITHOUT_PAYLOADS.includes(event.httpMethod)
+            || exports.HTTP_METHODS_WITHOUT_PAYLOADS.includes(requestType || '')) {
+            // get simple parameters
+            const params = {
+                ...event.queryStringParameters,
+            };
+            // add array parameters as arrays
+            if (event.multiValueQueryStringParameters !== null) {
+                Object.keys(params)
+                    .filter((key) => key.endsWith('[]'))
+                    .forEach((key) => {
+                    params[key] = event.multiValueQueryStringParameters?.[key];
+                });
+            }
+            return params;
+        }
+        if (exports.HTTP_METHODS_WITH_PAYLOADS.includes(event.httpMethod)
+            || exports.HTTP_METHODS_WITH_PAYLOADS.includes(requestType || '')) {
+            const contentType = this.getHeader('Content-Type');
+            let queryParameters = {};
+            if (contentType.includes('application/x-www-form-urlencoded')) {
+                queryParameters = querystring_1.default.parse(event.body);
+            }
+            if (contentType.includes('application/json')) {
+                try {
+                    queryParameters = JSON.parse(event.body);
+                }
+                catch {
+                    queryParameters = {};
+                }
+            }
+            if (contentType.includes('text/xml')) {
+                xml2js_1.default.parseString(event.body, (error, result) => {
+                    queryParameters = error ? {} : result;
+                });
+            }
+            if (contentType.includes('multipart/form-data')) {
+                queryParameters = this.parseForm(true);
+            }
+            return typeof queryParameters !== 'undefined' ? queryParameters : {};
+        }
+        return null;
+    }
+    /**
+     * Fetch the request IP address
+     */
+    getIp() {
+        const event = this.getContainer().getEvent();
+        if (typeof event.requestContext !== 'undefined'
+            && typeof event.requestContext.identity !== 'undefined'
+            && typeof event.requestContext.identity.sourceIp !== 'undefined') {
+            return event.requestContext.identity.sourceIp;
+        }
+        return null;
+    }
+    /**
+     * Get user agent details from the `User-Agent` header.
+     */
+    getUserBrowserAndDevice() {
+        const userAgent = this.getHeader('user-agent');
+        if (!userAgent) {
+            return null;
+        }
+        try {
+            const agent = useragent_1.default.parse(userAgent);
+            const os = agent.os.toJSON();
+            return {
+                'browser-type': agent.family,
+                'browser-version': agent.toVersion(),
+                'device-type': agent.device.family,
+                'operating-system': os.family,
+                'operating-system-version': agent.os.toVersion(),
+            };
+        }
+        catch {
+            this.di.get(LoggerService_1.default).label('user-agent-parsing-failed');
+            return null;
+        }
+    }
+    /**
+     * Test a request against validation constraints.
+     *
+     * See [validate.js](https://validatejs.org/) for how to write constraints.
+     *
+     * @param constraints
+     */
+    validateAgainstConstraints(constraints) {
+        const logger = this.di.get(LoggerService_1.default);
+        return new Promise((resolve, reject) => {
+            const validation = (0, validate_1.default)(this.getAll(), constraints);
+            if (typeof validation === 'undefined') {
+                resolve();
+            }
+            else {
+                logger.label('request-validation-failed');
+                const validationErrorResponse = exports.ERROR_TYPES.VALIDATION_ERROR;
+                validationErrorResponse.setBodyVariable('validation_errors', validation);
+                reject(validationErrorResponse);
+            }
+        });
+    }
+    /**
+     * Fetch the request multipart form.
+     *
+     * @param useBuffer Whether to return file content as a `Buffer`.
+     */
+    parseForm(useBuffer) {
+        // todo: rewrite this to use a dedicated package and add error handling
+        /* eslint-disable @typescript-eslint/no-non-null-assertion */
+        const event = this.getContainer().getEvent();
+        const boundary = RequestService.getBoundary(event);
+        const body = event.isBase64Encoded
+            ? Buffer.from(event.body, 'base64').toString('binary').trim()
+            : event.body;
+        const result = {};
+        body.split(boundary).forEach((item) => {
+            if (/filename=".+"/g.test(item)) {
+                const name = item.match(/name=".+";/g)[0].slice(6, -2);
+                result[name] = {
+                    type: 'file',
+                    filename: item.match(/filename=".+"/g)[0].slice(10, -1),
+                    contentType: item.match(/Content-Type:\s.+/g)[0].slice(14),
+                    content: useBuffer
+                        ? Buffer.from(item.slice(item.search(/Content-Type:\s.+/g) + item.match(/Content-Type:\s.+/g)[0].length + 4, -4), 'binary')
+                        : item.slice(item.search(/Content-Type:\s.+/g) + item.match(/Content-Type:\s.+/g)[0].length + 4, -4),
+                };
+            }
+            else if (/name=".+"/g.test(item)) {
+                result[item.match(/name=".+"/g)[0].slice(6, -1)] = item.slice(item.search(/name=".+"/g) + item.match(/name=".+"/g)[0].length + 4, -4);
+            }
+        });
+        /* eslint-enable @typescript-eslint/no-non-null-assertion */
+        return result;
+    }
+    /**
+     * Fetch the request AWS event Records
+     */
+    getAWSRecords() {
+        const event = this.getContainer().getEvent();
+        const eventRecord = event.Records && event.Records[0];
+        if (typeof event.Records !== 'undefined' && typeof event.Records[0] !== 'undefined' && typeof eventRecord.eventSource !== 'undefined') {
+            return eventRecord;
+        }
+        return null;
+    }
+    /**
+     * Gets a value independently from the case of the key.
+     *
+     * @param object
+     * @param key
+     */
+    static getValueIgnoringKeyCase(object, key) {
+        const foundKey = Object.keys(object)
+            .find((currentKey) => currentKey.toLocaleLowerCase() === key.toLowerCase());
+        return foundKey && object[foundKey];
+    }
+    /**
+     * Returns the content type
+     * assoiated with the request
+     *
+     * @param event
+     */
+    static getBoundary(event) {
+        return this.getValueIgnoringKeyCase(event.headers, 'Content-Type')?.split('=')?.[1];
+    }
+}
+exports.default = RequestService;
+//# sourceMappingURL=RequestService.js.map