lambda-essentials-ts 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
+## [5.1.0] - 2022-09-05
+
+### Changed
+
+Dependencies aren't pinned to a fixed version to allow users of the library to independently upgrade minor (devDependencies) and patch (dependencies) versions. This will simplify fixing security alerts faster than in this library, for example by applying `npm audit fix`.
+
 ## [5.0.0] - 2022-02-22
 
 ### Changed

package/lib/exceptions/exception.js

@@ -6,7 +6,7 @@ class Exception extends Error {
     constructor(message, statusCode, details) {
         super(message);
         this.statusCode = statusCode;
-        this.details = details ? util_1.serializeObject(details) : details;
+        this.details = details ? (0, util_1.serializeObject)(details) : details;
     }
 }
 exports.Exception = Exception;

package/lib/httpClient/httpClient.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -14,7 +18,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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;
 };
@@ -47,6 +51,7 @@ class HttpClient {
     /**
      * Create a new Instance of the HttpClient
      */
+    // eslint-disable-next-line complexity
     constructor(options) {
         var _a, _b, _c, _d, _e;
         // eslint-disable-next-line no-console
@@ -56,26 +61,27 @@ class HttpClient {
         this.correlationIdResolverFunction = options === null || options === void 0 ? void 0 : options.correlationIdResolver;
         this.enableCache = (_c = options === null || options === void 0 ? void 0 : options.enableCache) !== null && _c !== void 0 ? _c : false;
         this.enableRetry = (_d = options === null || options === void 0 ? void 0 : options.enableRetry) !== null && _d !== void 0 ? _d : false;
-        this.client = (_e = options === null || options === void 0 ? void 0 : options.client) !== null && _e !== void 0 ? _e : axios_1.default.create({
-            adapter: (() => {
-                let adapters = axios_1.default.defaults.adapter;
-                if (this.enableCache) {
-                    const cache = axios_cache_adapter_1.setupCache({
-                        maxAge: 5 * 60 * 1000,
-                        readHeaders: false,
-                        readOnError: true,
-                        exclude: {
-                            query: false,
-                        },
-                        ...options === null || options === void 0 ? void 0 : options.cacheOptions,
-                        key: (req) => HttpClient.generateCacheKey(req),
-                    });
-                    // debounce concurrent calls with the same cacheKey so that only one HTTP request is made
-                    adapters = deduplicateRequestAdapter_1.createDebounceRequestAdapter(cache.adapter, HttpClient.generateCacheKey);
-                }
-                return adapters;
-            })(),
-        });
+        this.client =
+            (_e = options === null || options === void 0 ? void 0 : options.client) !== null && _e !== void 0 ? _e : axios_1.default.create({
+                adapter: (() => {
+                    let adapters = axios_1.default.defaults.adapter;
+                    if (this.enableCache) {
+                        const cache = (0, axios_cache_adapter_1.setupCache)({
+                            maxAge: 5 * 60 * 1000,
+                            readHeaders: false,
+                            readOnError: true,
+                            exclude: {
+                                query: false, // also cache requests with query parameters
+                            },
+                            ...options === null || options === void 0 ? void 0 : options.cacheOptions,
+                            key: (req) => HttpClient.generateCacheKey(req),
+                        });
+                        // debounce concurrent calls with the same cacheKey so that only one HTTP request is made
+                        adapters = (0, deduplicateRequestAdapter_1.createDebounceRequestAdapter)(cache.adapter, HttpClient.generateCacheKey);
+                    }
+                    return adapters;
+                })(),
+            });
         if (this.enableRetry) {
             this.client.defaults.raxConfig = {
                 ...options === null || options === void 0 ? void 0 : options.retryOptions,
@@ -88,7 +94,7 @@ class HttpClient {
                         level: 'INFO',
                         retryAttempt: (_b = (_a = err.config) === null || _a === void 0 ? void 0 : _a.raxConfig) === null || _b === void 0 ? void 0 : _b.currentRetryAttempt,
                         ...HttpClient.extractRequestLogData(err.config),
-                        error: util_1.serializeAxiosError(err),
+                        error: (0, util_1.serializeAxiosError)(err),
                     });
                 },
             };
@@ -109,7 +115,7 @@ class HttpClient {
             return config;
         }, (error) => {
             var _a;
-            const serializedAxiosError = util_1.serializeAxiosError(error);
+            const serializedAxiosError = (0, util_1.serializeAxiosError)(error);
             this.logFunction({
                 title: 'HTTP Request Error',
                 level: 'WARN',
@@ -136,7 +142,7 @@ class HttpClient {
             if (error instanceof clientException_1.ClientException) {
                 throw error;
             }
-            const serializedAxiosError = util_1.serializeAxiosError(error);
+            const serializedAxiosError = (0, util_1.serializeAxiosError)(error);
             if (error.message === invalidToken) {
                 this.logFunction({
                     title: 'HTTP call skipped due to a token error',
@@ -166,18 +172,20 @@ class HttpClient {
             method: requestConfig.method,
             url: requestConfig.url,
             query: requestConfig.params,
-            request: util_1.safeJsonParse(requestConfig.data, requestConfig.data),
+            request: (0, util_1.safeJsonParse)(requestConfig.data, requestConfig.data),
             correlationId: (_a = requestConfig.headers) === null || _a === void 0 ? void 0 : _a[shared_1.orionCorrelationIdRoot],
         };
     }
     // implemented based on https://github.com/RasCarlito/axios-cache-adapter/blob/master/src/cache.js#L77
     static generateCacheKey(req) {
         var _a, _b;
-        const prefix = ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.Authorization) ? (_b = util_1.safeJwtCanonicalIdParse(req.headers.Authorization.replace('Bearer ', ''))) !== null && _b !== void 0 ? _b : uuid.v4() : 'shared';
+        const prefix = ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.Authorization)
+            ? (_b = (0, util_1.safeJwtCanonicalIdParse)(req.headers.Authorization.replace('Bearer ', ''))) !== null && _b !== void 0 ? _b : uuid.v4()
+            : 'shared';
         const url = `${req.baseURL ? req.baseURL : ''}${req.url}`;
         const query = req.params ? JSON.stringify(req.params) : ''; // possible improvement: optimize cache-hit ratio by sorting the query params
         const key = `${prefix}/${url}${query}`;
-        return `${key}${req.data ? md5_1.default(req.data) : ''}`;
+        return `${key}${req.data ? (0, md5_1.default)(req.data) : ''}`;
     }
     /**
      * Resolves the token with the token provider and adds it to the headers

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -14,7 +18,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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;
 };

package/lib/logger/logger.js

@@ -2,7 +2,11 @@
 /* eslint-disable no-console */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -15,7 +19,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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;
 };
@@ -70,8 +74,8 @@ class Logger {
         const truncateToken = (innerPayload) => {
             return innerPayload.replace(/(eyJ[a-zA-Z0-9_-]{5,}\.eyJ[a-zA-Z0-9_-]{5,})\.[a-zA-Z0-9_-]*/gi, (m, p1) => `${p1}.<sig>`);
         };
-        const replacer = (key, value) => (is_error_1.default(value) ? Logger.errorToObject(value) : value);
-        let stringifiedPayload = truncateToken(fast_safe_stringify_1.default(payload, replacer, this.jsonSpace));
+        const replacer = (key, value) => ((0, is_error_1.default)(value) ? Logger.errorToObject(value) : value);
+        let stringifiedPayload = truncateToken((0, fast_safe_stringify_1.default)(payload, replacer, this.jsonSpace));
         // https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html 256KB => 32768 characters
         if (stringifiedPayload.length >= 32768) {
             const replacementPayload = {
@@ -82,7 +86,7 @@ class Logger {
                     truncatedPayload: stringifiedPayload.substring(0, 10000),
                 },
             };
-            stringifiedPayload = fast_safe_stringify_1.default(replacementPayload, replacer, this.jsonSpace);
+            stringifiedPayload = (0, fast_safe_stringify_1.default)(replacementPayload, replacer, this.jsonSpace);
         }
         this.logFunction(stringifiedPayload);
     }

package/lib/openApi/openApiWrapper.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -14,7 +18,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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;
 };
@@ -43,8 +47,10 @@ class OpenApiWrapper {
                 const correlationId = this.generateCorrelationId(request.headers);
                 requestLogger.startInvocation(null, correlationId);
                 // TODO: restrict the alternative way of resolving token and principal only for localhost
-                this.userToken = (_b = (_a = request.requestContext.authorizer) === null || _a === void 0 ? void 0 : _a.jwt) !== null && _b !== void 0 ? _b : (_c = request.headers.Authorization) === null || _c === void 0 ? void 0 : _c.split(' ')[1];
-                this.userPrincipal = (_f = (_e = (_d = request.requestContext.authorizer) === null || _d === void 0 ? void 0 : _d.canonicalId) !== null && _e !== void 0 ? _e : util_1.safeJwtCanonicalIdParse(this.userToken)) !== null && _f !== void 0 ? _f : 'unknown';
+                this.userToken =
+                    (_b = (_a = request.requestContext.authorizer) === null || _a === void 0 ? void 0 : _a.jwt) !== null && _b !== void 0 ? _b : (_c = request.headers.Authorization) === null || _c === void 0 ? void 0 : _c.split(' ')[1];
+                this.userPrincipal =
+                    (_f = (_e = (_d = request.requestContext.authorizer) === null || _d === void 0 ? void 0 : _d.canonicalId) !== null && _e !== void 0 ? _e : (0, util_1.safeJwtCanonicalIdParse)(this.userToken)) !== null && _f !== void 0 ? _f : 'unknown';
                 this.requestId = request.requestContext.requestId;
                 requestLogger.log({
                     title: 'RequestLogger',
@@ -71,7 +77,7 @@ class OpenApiWrapper {
             errorMiddleware: (request, error) => {
                 const { correlationId } = this;
                 this.clearContext();
-                const serializedError = util_1.serializeObject(error);
+                const serializedError = (0, util_1.serializeObject)(error);
                 if (error instanceof exception_1.Exception) {
                     if (error.statusCode === 500) {
                         requestLogger.log({ title: 'ErrorLogger', level: 'ERROR', ...serializedError });

package/lib/util.js

@@ -43,7 +43,7 @@ function serializeAxiosError(error) {
     const { status, data } = error.response;
     return {
         status: (_a = data.originalStatusCode) !== null && _a !== void 0 ? _a : status,
-        details: data.details ? data.details : data,
+        details: data.details ? data.details : data, // Prevent wrapping of Exception
     };
 }
 exports.serializeAxiosError = serializeAxiosError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "A selection of the finest modules supporting authorization, API routing, error handling, logging and sending HTTP requests.",
   "main": "lib/index.js",
   "private": false,
@@ -26,28 +26,28 @@
   },
   "homepage": "https://github.com/Cimpress-MCP/lambda-essentials-ts#readme",
   "dependencies": {
-    "aws-sdk": "2.1078.0",
-    "axios": "0.21.1",
-    "axios-cache-adapter": "2.7.3",
-    "fast-safe-stringify": "2.0.7",
-    "is-error": "2.2.2",
-    "jsonwebtoken": "8.5.1",
-    "md5": "2.3.0",
+    "aws-sdk": "^2.1078.0",
+    "axios": "~0.21.3",
+    "axios-cache-adapter": "~2.7.3",
+    "fast-safe-stringify": "~2.0.7",
+    "is-error": "~2.2.2",
+    "jsonwebtoken": "~8.5.1",
+    "md5": "~2.3.0",
     "openapi-factory": "5.2.17",
-    "retry-axios": "2.6.0",
-    "uuid": "8.3.2"
+    "retry-axios": "~2.6.0",
+    "uuid": "~8.3.2"
   },
   "devDependencies": {
-    "@types/jest": "26.0.20",
-    "eslint": "7.18.0",
-    "eslint-config-cimpress-atsquad": "2.1.2",
-    "husky": "4.2.5",
-    "jest": "26.2.2",
-    "lint-staged": "10.2.13",
-    "prettier": "2.0.5",
-    "ts-jest": "26.1.4",
-    "ts-node": "8.10.2",
-    "typescript": "3.9.7"
+    "@types/jest": "^26.0.20",
+    "eslint": "^7.18.0",
+    "eslint-config-cimpress-atsquad": "^2.1.2",
+    "husky": "^4.2.5",
+    "jest": "^26.2.2",
+    "lint-staged": "^10.2.13",
+    "prettier": "^2.7.1",
+    "ts-jest": "^26.1.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.2"
   },
   "eslintConfig": {
     "extends": "cimpress-atsquad"