@spytecgps/lambda-utils 1.0.0-rc3 → 1.0.0-rc6

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './errors';
 export * from './validation';
 export * from './types';
 export * from './middleware';
+export * from './logger/logger';

package/dist/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./errors"), exports);
 __exportStar(require("./validation"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./middleware"), exports);
+__exportStar(require("./logger/logger"), exports);

package/dist/logger/logger.d.ts

@@ -0,0 +1,4 @@
+export declare const isLocal: () => boolean;
+export declare const isTest: () => boolean;
+declare const logger: import("winston").Logger;
+export default logger;

package/dist/logger/logger.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTest = exports.isLocal = void 0;
+var winston_1 = require("winston");
+var winston_console_format_1 = require("winston-console-format");
+var combine = winston_1.format.combine, errors = winston_1.format.errors, json = winston_1.format.json, timestamp = winston_1.format.timestamp, colorize = winston_1.format.colorize, padLevels = winston_1.format.padLevels;
+exports.isLocal = function () { return !!process.env.IS_OFFLINE; };
+exports.isTest = function () { return process.env.NODE_ENV == 'test'; };
+var replaceError = function (_a) {
+    var label = _a.label, level = _a.level, message = _a.message, stack = _a.stack;
+    return ({
+        label: label,
+        level: level,
+        message: message,
+        stack: stack,
+    });
+};
+var replacer = function (_key, value) {
+    // @ts-ignore
+    return value instanceof Error ? replaceError(value) : value;
+};
+function getDevFormat() {
+    return combine(timestamp(), colorize({ all: true }), padLevels(), winston_console_format_1.consoleFormat({
+        showMeta: true,
+        metaStrip: [
+            'timestamp',
+            'service',
+            'requestId',
+            'x-correlation-id',
+            'function',
+            'contextUserId',
+            'contextUserEmail',
+        ],
+        inspectOptions: {
+            depth: Infinity,
+            colors: true,
+            maxArrayLength: Infinity,
+            breakLength: 120,
+            compact: Infinity,
+        },
+    }));
+}
+function getProductionFormat() {
+    return combine(errors({ stack: true }), timestamp(), json({ replacer: replacer }));
+}
+function getFormat() {
+    if (exports.isTest() || exports.isLocal()) {
+        return getDevFormat();
+    }
+    return getProductionFormat();
+}
+var logger = winston_1.createLogger({
+    level: exports.isTest() || exports.isLocal() ? 'info' : 'verbose',
+    defaultMeta: {},
+    format: getFormat(),
+    transports: [new winston_1.transports.Console()],
+});
+exports.default = logger;

package/dist/middleware/contextualLogger.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Adapted from https://github.com/FormidableLabs/pino-lambda/blob/master/src/request.ts
+ */
 export declare const contextualLogger: () => {
     before: ({ event, context }: {
         event: any;

package/dist/middleware/contextualLogger.js

@@ -35,15 +35,50 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.contextualLoggerMiddleware = exports.contextualLogger = void 0;
-var sdk_1 = require("@spytecgps/sdk");
+var logger_1 = __importDefault(require("../logger/logger"));
+var AMAZON_TRACE_ID = '_X_AMZN_TRACE_ID';
+var CORRELATION_HEADER = 'x-correlation-';
+var CORRELATION_ID = CORRELATION_HEADER + "id";
+var CORRELATION_TRACE_ID = CORRELATION_HEADER + "trace-id";
+/**
+ * Adapted from https://github.com/FormidableLabs/pino-lambda/blob/master/src/request.ts
+ */
 exports.contextualLogger = function () {
+    var ctx = logger_1.default.defaultMeta;
     var before = function (_a) {
         var event = _a.event, context = _a.context;
         return __awaiter(void 0, void 0, void 0, function () {
-            return __generator(this, function (_b) {
-                sdk_1.logger.withRequest(event, context);
+            var apiEvent_1;
+            var _b, _c, _d, _e, _f, _g, _h;
+            return __generator(this, function (_j) {
+                if (context) {
+                    ctx.requestId = context === null || context === void 0 ? void 0 : context.awsRequestId;
+                    ctx.function = context.functionName;
+                }
+                if (!ctx.requestId) {
+                    ctx.requestId = (_b = event === null || event === void 0 ? void 0 : event.requestContext) === null || _b === void 0 ? void 0 : _b.requestId;
+                }
+                if (Object(event).hasOwnProperty('headers')) {
+                    apiEvent_1 = event;
+                    Object.keys(apiEvent_1).forEach(function (header) {
+                        if (header.toLowerCase().startsWith(CORRELATION_HEADER)) {
+                            ctx[header] = apiEvent_1[header];
+                        }
+                    });
+                }
+                if (process.env[AMAZON_TRACE_ID]) {
+                    ctx[CORRELATION_TRACE_ID] = process.env[AMAZON_TRACE_ID];
+                }
+                if (!ctx[CORRELATION_ID]) {
+                    ctx[CORRELATION_ID] = context === null || context === void 0 ? void 0 : context.awsRequestId;
+                }
+                ctx.contextUserId = (_e = (_d = (_c = event === null || event === void 0 ? void 0 : event.requestContext) === null || _c === void 0 ? void 0 : _c.authorizer) === null || _d === void 0 ? void 0 : _d.claims) === null || _e === void 0 ? void 0 : _e.userId;
+                ctx.contextUserEmail = (_h = (_g = (_f = event === null || event === void 0 ? void 0 : event.requestContext) === null || _f === void 0 ? void 0 : _f.authorizer) === null || _g === void 0 ? void 0 : _g.claims) === null || _h === void 0 ? void 0 : _h.email;
                 return [2 /*return*/];
             });
         });

package/dist/middleware/index.d.ts

@@ -4,7 +4,9 @@ import httpResponseSerializer from '@middy/http-response-serializer';
 import { validatorMiddleware } from './validation';
 import { Context as LambdaContext } from 'aws-lambda/handler';
 import { MiddyInputHandler } from './types';
-declare const apiGatewayMiddlewares: rawMiddy.MiddlewareObj<any, any, Error, LambdaContext>[];
+declare const apiGatewayMiddlewares: (rawMiddy.MiddlewareObj<any, any, Error, LambdaContext> | {
+    after: (req: any) => void;
+})[];
 declare const middy: <TEvent, TResult, TContext extends LambdaContext>(handler: MiddyInputHandler<TEvent, TResult, TContext>) => rawMiddy.MiddyfiedHandler<TEvent, TResult, Error, TContext>;
 declare const apiGatewayMiddy: <TEvent, TResult, TContext extends LambdaContext>(handler: MiddyInputHandler<TEvent, TResult, TContext>) => rawMiddy.MiddyfiedHandler<TEvent, TResult, Error, TContext>;
 export { middy, apiGatewayMiddy, httpErrorHandler, httpResponseSerializer, validatorMiddleware, apiGatewayMiddlewares };

package/dist/middleware/index.js

@@ -20,7 +20,8 @@ var contextualLogger_1 = require("./contextualLogger");
 var ioLogger_1 = require("./ioLogger");
 var validation_1 = require("./validation");
 Object.defineProperty(exports, "validatorMiddleware", { enumerable: true, get: function () { return validation_1.validatorMiddleware; } });
-var sdk_1 = require("@spytecgps/sdk");
+var responseWrapper_1 = require("./responseWrapper");
+var logger_1 = __importDefault(require("../logger/logger"));
 var baseMiddlewares = [contextualLogger_1.contextualLoggerMiddleware, ioLogger_1.ioLoggerMiddleware];
 var apiGatewayMiddlewares = [
     http_response_serializer_1.default({
@@ -50,8 +51,9 @@ var apiGatewayMiddlewares = [
         default: 'application/json',
     }),
     http_error_handler_1.default({
-        logger: function (error) { return sdk_1.logger.error(error); },
+        logger: function (error) { return logger_1.default.error(error); },
     }),
+    responseWrapper_1.responseWrapperMiddleware(),
 ];
 exports.apiGatewayMiddlewares = apiGatewayMiddlewares;
 var middy = function (handler) { return core_1.default(handler).use(__spreadArrays(baseMiddlewares)); };

package/dist/middleware/ioLogger.js

@@ -5,10 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ioLoggerMiddleware = void 0;
 var input_output_logger_1 = __importDefault(require("@middy/input-output-logger"));
-var sdk_1 = require("@spytecgps/sdk");
+var logger_1 = __importDefault(require("../logger/logger"));
 exports.ioLoggerMiddleware = input_output_logger_1.default({
     logger: function (req) {
         var message = (req === null || req === void 0 ? void 0 : req.event) ? 'event' : 'response';
-        sdk_1.logger.info(req, message);
+        logger_1.default.info(message, req);
     },
 });

package/dist/middleware/middleware.test.js

@@ -43,6 +43,7 @@ var index_1 = require("./index");
 var joi_1 = __importDefault(require("joi"));
 var validation_1 = require("./validation");
 var errors_1 = require("../errors");
+var responseWrapper_1 = require("./responseWrapper");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 var webEvent = require('./mocks/webEvent.json');
 var context = {};
@@ -118,4 +119,49 @@ describe('Middleware', function () {
             });
         }); });
     });
+    describe('responseWrapperMiddleware', function () {
+        var handler = function (_event) { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                console.log('ok done');
+                return [2 /*return*/, {
+                        data: {
+                            abc: 123,
+                        },
+                    }];
+            });
+        }); };
+        var middifiedHandler = index_1.apiGatewayMiddy(handler).use(responseWrapper_1.responseWrapperMiddleware());
+        it('should work', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, middifiedHandler(webEvent, context, callback)];
+                    case 1:
+                        result = _a.sent();
+                        console.log(result);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    describe('responseWrapperMiddleware error', function () {
+        var handler = function (_event) { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                throw new errors_1.NotFoundError();
+            });
+        }); };
+        var middifiedHandler = index_1.apiGatewayMiddy(handler).use(responseWrapper_1.responseWrapperMiddleware());
+        it('should work', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, middifiedHandler(webEvent, context, callback)];
+                    case 1:
+                        result = _a.sent();
+                        console.log(result);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/dist/middleware/responseWrapper.d.ts

@@ -0,0 +1,3 @@
+export declare const responseWrapperMiddleware: () => {
+    after: (req: any) => void;
+};

package/dist/middleware/responseWrapper.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.responseWrapperMiddleware = void 0;
+var wrappers_1 = require("../wrappers");
+exports.responseWrapperMiddleware = function () {
+    var responseWrapperMiddlewareAfter = function (req) {
+        req.response = wrappers_1.buildProxyResult(req.response);
+    };
+    return {
+        after: responseWrapperMiddlewareAfter,
+    };
+};

package/dist/middleware/validation.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatorMiddleware = void 0;
-var sdk_1 = require("@spytecgps/sdk");
 var errors_1 = require("../errors");
+var logger_1 = __importDefault(require("../logger/logger"));
 exports.validatorMiddleware = function (_a) {
     var schema = _a.schema, _b = _a.allowUnknown, allowUnknown = _b === void 0 ? true : _b;
     var validatorMiddlewareBefore = function (request) {
@@ -16,7 +19,7 @@ exports.validatorMiddleware = function (_a) {
             },
         }), error = _a.error, value = _a.value;
         if (error) {
-            sdk_1.logger.error({ error: error }, 'Validation error');
+            logger_1.default.error('Validation error', { error: error });
             throw error.isJoi ? new errors_1.BadRequestError(error.message) : error;
         }
         request.event = value;

package/dist/types.d.ts

@@ -7,10 +7,12 @@ export interface SpytecAuthorizedResources {
     devices: string[];
 }
 export declare type AuthClass = 'user' | 'client' | 'system';
+export declare type DevicesAccess = 'full' | 'limited';
 export interface SpytecAuthContext {
     type: AuthClass;
     userId?: string;
     clientId: number;
+    devicesAccess: DevicesAccess;
     resources: SpytecAuthorizedResources;
     principalId: string;
     scope?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spytecgps/lambda-utils",
-  "version": "1.0.0-rc3",
+  "version": "1.0.0-rc6",
   "description": "Lambda Utils",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,9 +32,12 @@
     "@middy/input-output-logger": "^2.5.7",
     "@spytecgps/sdk": "0.5.34",
     "joi": "^17.4.0",
+    "logform": "^2.4.0",
     "moment": "2.29.1",
     "moment-timezone": "0.5.33",
-    "qs": "^6.10.1"
+    "qs": "^6.10.1",
+    "winston": "^3.7.2",
+    "winston-console-format": "^1.0.8"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.76",