lambda-essentials-ts 6.1.0 → 7.0.0-beta

package/CHANGELOG.md

@@ -4,7 +4,28 @@ 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/)
 
-## [6.0.0] - 2022-02-22
+## [7.0.0-beta] - 2025-11-14
+
+### Changed
+
+- Add 429 status code mapping
+- Changed logging format. Removed the inner `message` object.
+- Update packages
+- Use axios-cache-interceptor instead of axios-cache-adapter
+
+## [6.1.1] - 2025-10-27
+
+### Changed
+
+- TokenProviderHttpClient now uses the http client with retries as default.
+
+## [6.1.0] - 2024-09-30
+
+### Changed
+
+- Preserve the original message in ClientException
+
+## [6.0.0] - 2024-02-22
 
 ### Changed
 

package/lib/exceptions/clientException.js

@@ -4,7 +4,7 @@ exports.ClientException = void 0;
 const exception_1 = require("./exception");
 class ClientException extends exception_1.Exception {
     constructor(serviceName, originalStatusCode, details, originalMessage, statusCodeMapOverride) {
-        super(`Dependent service "${serviceName}" returned error: ${originalMessage !== null && originalMessage !== void 0 ? originalMessage : 'Unknown error'}`, ClientException.convertStatusCode(originalStatusCode, statusCodeMapOverride), details);
+        super(`Dependent service "${serviceName}" returned error: ${originalMessage ?? 'Unknown error'}`, ClientException.convertStatusCode(originalStatusCode, statusCodeMapOverride), details);
         this.serviceName = serviceName;
         this.originalStatusCode = originalStatusCode;
     }
@@ -27,4 +27,5 @@ ClientException.statusCodeMap = {
     403: 403,
     404: 422,
     422: 422,
+    429: 429,
 };

package/lib/httpClient/httpClient.d.ts

@@ -1,6 +1,6 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { IAxiosCacheAdapterOptions } from 'axios-cache-adapter';
+import { AxiosHeaderValue, AxiosInstance, AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios';
 import { RetryConfig } from 'retry-axios';
+import { CacheOptions } from 'axios-cache-interceptor';
 /**
  * Allows to specify which http data should be logged.
  */
@@ -27,7 +27,11 @@ export default class HttpClient {
     /**
      * Resolves the token with the token provider and adds it to the headers
      */
-    createHeadersWithResolvedToken(headers?: Record<string, string>): Promise<Record<string, string>>;
+    createHeadersWithResolvedToken(headers?: RawAxiosRequestHeaders | {
+        [key: string]: AxiosHeaderValue;
+    } | Record<string, string>): Promise<{
+        [p: string]: AxiosHeaderValue;
+    }>;
     /**
      * Get from the given url. Bearer token is automatically injected if tokenResolverFunction was provided to the constructor.
      */
@@ -83,10 +87,10 @@ export interface HttpClientOptions {
      */
     enableCache?: boolean;
     /**
-     * Cache options
-     * @link https://github.com/RasCarlito/axios-cache-adapter/blob/master/axios-cache-adapter.d.ts#L26
+     * Cache options (global defaults for axios-cache-interceptor)
+     * @link https://axios-cache-interceptor.js.org/config
      */
-    cacheOptions?: IAxiosCacheAdapterOptions;
+    cacheOptions?: CacheOptions;
     /**
      * Enable automatic retries
      */

package/lib/httpClient/httpClient.js

@@ -15,29 +15,37 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 });
 exports.HttpLogType = void 0;
 const uuid = __importStar(require("uuid"));
-const url_1 = require("url");
 const axios_1 = __importDefault(require("axios"));
-const axios_cache_adapter_1 = require("axios-cache-adapter");
 const rax = __importStar(require("retry-axios"));
 const md5_1 = __importDefault(require("md5"));
 const util_1 = require("../util");
 const internalException_1 = require("../exceptions/internalException");
 const clientException_1 = require("../exceptions/clientException");
 const shared_1 = require("../shared");
-const deduplicateRequestAdapter_1 = require("./deduplicateRequestAdapter");
+const axios_cache_interceptor_1 = require("axios-cache-interceptor");
 const invalidToken = 'Invalid token';
 /**
  * Allows to specify which http data should be logged.
@@ -46,55 +54,47 @@ var HttpLogType;
 (function (HttpLogType) {
     HttpLogType["requests"] = "requests";
     HttpLogType["responses"] = "responses";
-})(HttpLogType = exports.HttpLogType || (exports.HttpLogType = {}));
+})(HttpLogType || (exports.HttpLogType = HttpLogType = {}));
 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
-        this.logFunction = (_a = options === null || options === void 0 ? void 0 : options.logFunction) !== null && _a !== void 0 ? _a : console.log;
-        this.logOptions = (_b = options === null || options === void 0 ? void 0 : options.logOptions) !== null && _b !== void 0 ? _b : { enabledLogs: [HttpLogType.requests] };
-        this.tokenResolverFunction = options === null || options === void 0 ? void 0 : options.tokenResolver;
-        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.timeout = options === null || options === void 0 ? void 0 : options.timeout;
-        this.clientExceptionStatusCodeMapOverride = options === null || options === void 0 ? void 0 : options.clientExceptionStatusCodeMapOverride;
-        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;
-                })(),
+        this.logFunction = options?.logFunction ?? console.log;
+        this.logOptions = options?.logOptions ?? { enabledLogs: [HttpLogType.requests] };
+        this.tokenResolverFunction = options?.tokenResolver;
+        this.correlationIdResolverFunction = options?.correlationIdResolver;
+        this.enableCache = options?.enableCache ?? false;
+        this.enableRetry = options?.enableRetry ?? false;
+        this.timeout = options?.timeout;
+        this.clientExceptionStatusCodeMapOverride = options?.clientExceptionStatusCodeMapOverride;
+        this.client = options?.client ?? axios_1.default.create();
+        if (this.enableCache) {
+            (0, axios_cache_interceptor_1.setupCache)(this.client, {
+                // 5 minutes TTL
+                ttl: 5 * 60 * 1000,
+                // Respect cache-control headers and have ttl as a fallback https://axios-cache-interceptor.js.org/config/request-specifics#cache-interpretheader
+                interpretHeader: true,
+                // Serve stale cache on error
+                staleIfError: true,
+                // Use custom cache key to include auth, url, params and body hash
+                generateKey: (req) => HttpClient.generateCacheKey(req),
+                // Allow overriding defaults via provided options
+                ...options?.cacheOptions,
             });
+        }
         if (this.enableRetry) {
             this.client.defaults.raxConfig = {
-                ...options === null || options === void 0 ? void 0 : options.retryOptions,
-                instance: this.client,
-                httpMethodsToRetry: ['GET', 'HEAD', 'OPTIONS', 'DELETE', 'PUT', 'POST'],
+                ...options?.retryOptions,
+                instance: this.client, // always attach retry-axios to the private axios client
+                httpMethodsToRetry: ['GET', 'HEAD', 'OPTIONS', 'DELETE', 'PUT', 'POST'], // extending the defaults to retry POST calls
                 onRetryAttempt: (err) => {
-                    var _a, _b;
                     this.logFunction({
                         title: 'HTTP Response Error Retry',
                         level: 'INFO',
-                        retryAttempt: (_b = (_a = err.config) === null || _a === void 0 ? void 0 : _a.raxConfig) === null || _b === void 0 ? void 0 : _b.currentRetryAttempt,
+                        retryAttempt: err.config?.raxConfig?.currentRetryAttempt,
                         ...HttpClient.extractRequestLogData(err.config),
                         error: (0, util_1.serializeAxiosError)(err),
                     });
@@ -119,7 +119,6 @@ class HttpClient {
             }
             return config;
         }, (error) => {
-            var _a;
             const serializedAxiosError = (0, util_1.serializeAxiosError)(error);
             this.logFunction({
                 title: 'HTTP Request Error',
@@ -127,10 +126,10 @@ class HttpClient {
                 ...HttpClient.extractRequestLogData(error.config),
                 error: serializedAxiosError,
             });
-            const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
-                ? new url_1.URL(error.config.url, error.config.baseURL).hostname
+            const hostname = error.config?.url
+                ? new URL(error.config.url, error.config.baseURL).hostname
                 : 'N/A';
-            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.message, this.clientExceptionStatusCodeMapOverride);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError?.status, serializedAxiosError?.details, serializedAxiosError?.message, this.clientExceptionStatusCodeMapOverride);
         });
         this.client.interceptors.response.use((response) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.responses)) {
@@ -143,7 +142,6 @@ class HttpClient {
             }
             return response;
         }, (error) => {
-            var _a;
             // when retries are configured, this middleware gets triggered for each retry
             // it changes the error object to ClientException and therefore the transformation can be run only once
             if (error instanceof clientException_1.ClientException) {
@@ -166,14 +164,13 @@ class HttpClient {
                     error: serializedAxiosError,
                 });
             }
-            const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
-                ? new url_1.URL(error.config.url, error.config.baseURL).hostname
+            const hostname = error.config?.url
+                ? new URL(error.config.url, error.config.baseURL).hostname
                 : 'N/A';
-            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.message, this.clientExceptionStatusCodeMapOverride);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError?.status, serializedAxiosError?.details, serializedAxiosError?.message, this.clientExceptionStatusCodeMapOverride);
         });
     }
     static extractRequestLogData(requestConfig) {
-        var _a;
         if (!requestConfig) {
             return {};
         }
@@ -182,14 +179,13 @@ class HttpClient {
             url: requestConfig.url,
             query: requestConfig.params,
             request: (0, util_1.safeJsonParse)(requestConfig.data, requestConfig.data),
-            correlationId: (_a = requestConfig.headers) === null || _a === void 0 ? void 0 : _a[shared_1.orionCorrelationIdRoot],
+            correlationId: requestConfig.headers?.[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 = (0, util_1.safeJwtCanonicalIdParse)(req.headers.Authorization.replace('Bearer ', ''))) !== null && _b !== void 0 ? _b : uuid.v4()
+        const prefix = req.headers?.Authorization
+            ? (0, util_1.safeJwtCanonicalIdParse)(req.headers.Authorization.replace('Bearer ', '')) ?? 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
@@ -199,13 +195,13 @@ class HttpClient {
     /**
      * Resolves the token with the token provider and adds it to the headers
      */
-    async createHeadersWithResolvedToken(headers = {}) {
+    async createHeadersWithResolvedToken(headers) {
         const newHeaders = {};
         if (this.correlationIdResolverFunction) {
             newHeaders[shared_1.orionCorrelationIdRoot] = this.correlationIdResolverFunction();
         }
         if (this.tokenResolverFunction) {
-            if (headers.Authorization) {
+            if (headers && headers.Authorization) {
                 throw new internalException_1.InternalException('Authorization header already specified, please create a new HttpClient with a different (or without a) tokenResolver');
             }
             else {

package/lib/httpClient/redisStorage.d.ts

@@ -0,0 +1,2 @@
+import { createClient } from 'redis';
+export default function createRedisStorage(client: ReturnType<typeof createClient>): import("axios-cache-interceptor").AxiosStorage;

package/lib/httpClient/redisStorage.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createRedisStorage;
+const axios_cache_interceptor_1 = require("axios-cache-interceptor");
+const KEY_PREFIX = 'axios-cache-';
+const MIN_TTL = 60000;
+function createRedisStorage(client) {
+    // source https://axios-cache-interceptor.js.org/guide/storages#node-redis-storage
+    return (0, axios_cache_interceptor_1.buildStorage)({
+        async find(key) {
+            const result = await client.get(`${KEY_PREFIX}${key}`);
+            return result ? JSON.parse(result) : undefined;
+        },
+        // eslint-disable-next-line complexity
+        async set(key, value, req) {
+            await client.set(`${KEY_PREFIX}${key}`, JSON.stringify(value), {
+                PXAT: 
+                // We don't want to keep indefinitely values in the storage if
+                // their request don't finish somehow. Either set its value as
+                // the TTL or 1 minute (MIN_TTL).
+                value.state === 'loading'
+                    ? Date.now() +
+                        (req?.cache && typeof req.cache.ttl === 'number' ? req.cache.ttl : MIN_TTL)
+                    : (value.state === 'stale' && value.ttl) ||
+                        (value.state === 'cached' && !(0, axios_cache_interceptor_1.canStale)(value))
+                        ? value.createdAt + value.ttl
+                        : // otherwise, we can't determine when it should expire, so we keep
+                            //   it indefinitely.
+                            undefined,
+            });
+        },
+        async remove(key) {
+            await client.del(`${KEY_PREFIX}${key}`);
+        },
+    });
+}

package/lib/index.d.ts

@@ -15,5 +15,6 @@ import { InvalidDataException } from './exceptions/invalidDataException';
 import { NotFoundException } from './exceptions/notFoundException';
 import { ValidationException } from './exceptions/validationException';
 import { serializeObject, serializeAxiosError } from './util';
-export { Logger, OpenApiWrapper, ApiResponse, HttpClient, HttpLogType, KmsTokenProvider, SecretsManagerTokenProvider, ValidationException, NotFoundException, InvalidDataException, InternalException, ForbiddenException, Exception, ConflictException, ClientException, serializeObject, serializeAxiosError, };
+import RedisStorage from './httpClient/redisStorage';
+export { Logger, OpenApiWrapper, ApiResponse, HttpClient, HttpLogType, KmsTokenProvider, SecretsManagerTokenProvider, ValidationException, NotFoundException, InvalidDataException, InternalException, ForbiddenException, Exception, ConflictException, ClientException, serializeObject, serializeAxiosError, RedisStorage, };
 export type { LoggerConfiguration, SuggestedLogObject, HttpClientOptions, HttpLogOptions, ApiRequest, GetRequest, PostRequest, PutRequest, DeleteRequest, TokenProviderHttpClient, KmsTokenProviderOptions, KmsTokenConfiguration, SecretsManagerTokenProviderOptions, SecretsManagerTokenConfiguration, };

package/lib/index.js

@@ -15,18 +15,28 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 });
-exports.serializeAxiosError = exports.serializeObject = exports.ClientException = exports.ConflictException = exports.Exception = exports.ForbiddenException = exports.InternalException = exports.InvalidDataException = exports.NotFoundException = exports.ValidationException = exports.SecretsManagerTokenProvider = exports.KmsTokenProvider = exports.HttpLogType = exports.HttpClient = exports.ApiResponse = exports.OpenApiWrapper = exports.Logger = void 0;
+exports.RedisStorage = exports.serializeAxiosError = exports.serializeObject = exports.ClientException = exports.ConflictException = exports.Exception = exports.ForbiddenException = exports.InternalException = exports.InvalidDataException = exports.NotFoundException = exports.ValidationException = exports.SecretsManagerTokenProvider = exports.KmsTokenProvider = exports.HttpLogType = exports.HttpClient = exports.ApiResponse = exports.OpenApiWrapper = exports.Logger = void 0;
 const httpClient_1 = __importStar(require("./httpClient/httpClient"));
 exports.HttpClient = httpClient_1.default;
 Object.defineProperty(exports, "HttpLogType", { enumerable: true, get: function () { return httpClient_1.HttpLogType; } });
@@ -59,3 +69,5 @@ Object.defineProperty(exports, "ValidationException", { enumerable: true, get: f
 const util_1 = require("./util");
 Object.defineProperty(exports, "serializeObject", { enumerable: true, get: function () { return util_1.serializeObject; } });
 Object.defineProperty(exports, "serializeAxiosError", { enumerable: true, get: function () { return util_1.serializeAxiosError; } });
+const redisStorage_1 = __importDefault(require("./httpClient/redisStorage"));
+exports.RedisStorage = redisStorage_1.default;

package/lib/logger/logger.d.ts

@@ -2,11 +2,13 @@ export default class Logger {
     invocationId: string;
     private readonly logFunction;
     private readonly jsonSpace;
+    private readonly payloadLimit;
     private staticData;
     constructor(configuration?: LoggerConfiguration);
     /**
      * Create a new invocation which will end up setting the additional invocation metadata for the request, which will be used when logging.
      * @param staticData Any static data that are assigned to every log message. Typical might be an environment parameter or version number.
+     * @param invocationId
      */
     startInvocation(staticData?: any, invocationId?: string): void;
     log(message: string | SuggestedLogObject): void;
@@ -21,6 +23,13 @@ export interface LoggerConfiguration {
      * the number of spaces that are used then stringifying the message.
      */
     jsonSpace?: number;
+    /**
+     * the limit of a stringified payload in characters above which the payload will be truncated.
+     * 3000 characters are reserved
+     * @min 10000
+     * @default 32768
+     */
+    payloadLimit?: number;
 }
 export interface SuggestedLogObject {
     /**

package/lib/logger/logger.js

@@ -16,13 +16,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -31,20 +41,27 @@ const uuid = __importStar(require("uuid"));
 const fast_safe_stringify_1 = __importDefault(require("fast-safe-stringify"));
 const is_error_1 = __importDefault(require("is-error"));
 const util_1 = require("../util");
+const DEFAULT_PAYLOAD_LIMIT = 32768;
+const MIN_PAYLOAD_LIMIT = 10000;
 class Logger {
     constructor(configuration) {
-        var _a, _b;
-        this.logFunction = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.logFunction) !== null && _a !== void 0 ? _a : console.log;
-        this.jsonSpace = (_b = configuration === null || configuration === void 0 ? void 0 : configuration.jsonSpace) !== null && _b !== void 0 ? _b : 2;
+        this.logFunction = configuration?.logFunction ?? console.log;
+        this.jsonSpace = configuration?.jsonSpace ?? 2;
+        this.payloadLimit = !configuration?.payloadLimit
+            ? DEFAULT_PAYLOAD_LIMIT
+            : configuration?.payloadLimit < MIN_PAYLOAD_LIMIT
+                ? MIN_PAYLOAD_LIMIT
+                : configuration.payloadLimit;
         this.invocationId = 'none';
     }
     /**
      * Create a new invocation which will end up setting the additional invocation metadata for the request, which will be used when logging.
      * @param staticData Any static data that are assigned to every log message. Typical might be an environment parameter or version number.
+     * @param invocationId
      */
     startInvocation(staticData, invocationId) {
         this.staticData = staticData;
-        this.invocationId = invocationId !== null && invocationId !== void 0 ? invocationId : uuid.v4();
+        this.invocationId = invocationId ?? uuid.v4();
     }
     // eslint-disable-next-line complexity
     log(message) {
@@ -71,7 +88,7 @@ class Logger {
         }
         const payload = {
             invocationId: this.invocationId,
-            message: messageAsObject,
+            ...messageAsObject,
         };
         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>`);
@@ -79,15 +96,12 @@ class Logger {
         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));
         stringifiedPayload = (0, util_1.redactSecret)(stringifiedPayload);
-        // https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html 256KB => 32768 characters
-        if (stringifiedPayload.length >= 32768) {
+        if (stringifiedPayload.length >= this.payloadLimit) {
             const replacementPayload = {
                 invocationId: this.invocationId,
-                message: {
-                    title: 'Payload too large',
-                    fields: Object.keys(payload),
-                    truncatedPayload: stringifiedPayload.substring(0, 10000),
-                },
+                title: 'Payload too large',
+                fields: Object.keys(payload),
+                truncatedPayload: stringifiedPayload.substring(0, this.payloadLimit - 3000),
             };
             stringifiedPayload = (0, fast_safe_stringify_1.default)(replacementPayload, replacer, this.jsonSpace);
         }

package/lib/openApi/openApiModel.d.ts

@@ -23,7 +23,7 @@ export interface OpenApiModel {
         errorMiddleware: ErrorMiddleware;
     }, overrideLogger?: () => void): any;
 }
-export declare type ApiControllerRoute<T = ApiRequest> = (path: string, handler: (request: T) => Promise<ApiResponse>) => void;
-export declare type RequestMiddleware = (request: ApiRequest) => ApiRequest;
-export declare type ResponseMiddleware = (request: ApiRequest, response: ApiResponse) => ApiResponse;
-export declare type ErrorMiddleware = (request: ApiRequest, error: Exception | Error) => ApiResponse;
+export type ApiControllerRoute<T = ApiRequest> = (path: string, handler: (request: T) => Promise<ApiResponse>) => void;
+export type RequestMiddleware = (request: ApiRequest) => ApiRequest;
+export type ResponseMiddleware = (request: ApiRequest, response: ApiResponse) => ApiResponse;
+export type ErrorMiddleware = (request: ApiRequest, error: Exception | Error) => ApiResponse;

package/lib/openApi/openApiWrapper.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -40,19 +50,18 @@ class OpenApiWrapper {
         this.userPrincipal = this.notSet;
         this.requestId = this.notSet;
         this.correlationId = this.notSet;
-        if (config === null || config === void 0 ? void 0 : config.enableNewRelicTracking) {
+        if (config?.enableNewRelicTracking) {
             // eslint-disable-next-line global-require
             this.newrelic = require('newrelic');
         }
         // @ts-ignore Later Use the options Type from OpenApiFactory
         this.api = new openapi_factory_1.default({
             requestMiddleware: async (request) => {
-                var _a, _b;
                 const correlationId = this.generateCorrelationId(request.headers);
                 requestLogger.startInvocation(null, correlationId);
                 const userData = this.determineUserData(request.headers, request.requestContext.authorizer);
-                this.userToken = (_a = userData.userToken) !== null && _a !== void 0 ? _a : this.notSet;
-                this.userPrincipal = (_b = userData.userPrincipal) !== null && _b !== void 0 ? _b : this.notSet;
+                this.userToken = userData.userToken ?? this.notSet;
+                this.userPrincipal = userData.userPrincipal ?? this.notSet;
                 this.requestId = request.requestContext.requestId;
                 requestLogger.log({
                     title: 'RequestLogger',
@@ -69,7 +78,7 @@ class OpenApiWrapper {
                     user: this.userPrincipal,
                     query: request.multiValueQueryStringParameters,
                 });
-                if (config === null || config === void 0 ? void 0 : config.enableNewRelicTracking) {
+                if (config?.enableNewRelicTracking) {
                     this.newrelic.addCustomAttributes({
                         canonicalId: this.userPrincipal,
                         correlationId,
@@ -141,19 +150,18 @@ class OpenApiWrapper {
     }
     generateCorrelationId(headers) {
         const existingCorrelationId = headers[shared_1.orionCorrelationIdRoot];
-        this.correlationId = existingCorrelationId !== null && existingCorrelationId !== void 0 ? existingCorrelationId : uuid.v4();
+        this.correlationId = existingCorrelationId ?? uuid.v4();
         return this.correlationId;
     }
     determineUserData(headers, authorizerContext) {
-        var _a, _b, _c;
         if (authorizerContext) {
             return {
-                userPrincipal: (_a = authorizerContext.canonicalId) !== null && _a !== void 0 ? _a : authorizerContext.principalId,
-                userToken: (_b = authorizerContext.jwt) !== null && _b !== void 0 ? _b : authorizerContext.accessToken,
+                userPrincipal: authorizerContext.canonicalId ?? authorizerContext.principalId,
+                userToken: authorizerContext.jwt ?? authorizerContext.accessToken,
             };
         }
         if (headers.Authorization) {
-            const userToken = (_c = headers.Authorization.split(' ')) === null || _c === void 0 ? void 0 : _c[1];
+            const userToken = headers.Authorization.split(' ')?.[1];
             const userPrincipal = (0, util_1.safeJwtCanonicalIdParse)(userToken);
             return { userToken, userPrincipal };
         }

package/lib/tokenProvider/kmsTokenProvider.js

@@ -12,11 +12,12 @@ class KmsTokenProvider extends tokenProvider_1.default {
         this.kmsConfiguration = options.tokenConfiguration;
     }
     async getClientSecret() {
-        var _a;
         const data = await this.kmsClient.send(new client_kms_1.DecryptCommand({
-            CiphertextBlob: Buffer.from(this.kmsConfiguration.encryptedClientSecret, 'base64'),
+            CiphertextBlob: new Uint8Array(Buffer.from(this.kmsConfiguration.encryptedClientSecret, 'base64')),
         }));
-        const secret = (_a = data.Plaintext) === null || _a === void 0 ? void 0 : _a.toString();
+        const secret = data.Plaintext
+            ? Buffer.from(data.Plaintext).toString()
+            : undefined;
         if (!secret) {
             throw new Error('Request error: failed to decrypt secret using KMS');
         }

package/lib/tokenProvider/secretsManagerTokenProvider.js

@@ -15,7 +15,7 @@ class SecretsManagerTokenProvider extends tokenProvider_1.default {
         const secret = await this.secretsManagerClient.send(new client_secrets_manager_1.GetSecretValueCommand({
             SecretId: this.secretsManagerConfiguration.clientSecretId,
         }));
-        if (!(secret === null || secret === void 0 ? void 0 : secret.SecretString)) {
+        if (!secret?.SecretString) {
             throw new Error('Request error: failed to retrieve secret from Secrets Manager');
         }
         return JSON.parse(secret.SecretString);

package/lib/tokenProvider/tokenProvider.d.ts

@@ -23,7 +23,8 @@ export interface Auth0Secret {
 }
 export interface TokenProviderOptions {
     /**
-     * Either an Axios instance or an @atsquad/httpclient instance, by default it creates an axios instance
+     * Either an Axios instance or an @atsquad/httpclient instance, by default it creates an @atsquad/httpclient instance without cache
+     * with retries
      */
     httpClient?: TokenProviderHttpClient;
     /**

package/lib/tokenProvider/tokenProvider.js

@@ -4,21 +4,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-const axios_1 = __importDefault(require("axios"));
+const httpClient_1 = __importDefault(require("../httpClient/httpClient"));
 class TokenProvider {
     /**
      * Create a new Instance of the TokenProvider
      */
     constructor(options) {
-        var _a;
-        this.httpClient = (_a = options.httpClient) !== null && _a !== void 0 ? _a : axios_1.default.create();
+        this.httpClient =
+            options.httpClient ??
+                new httpClient_1.default({
+                    enableCache: false,
+                    enableRetry: true,
+                    retryOptions: {
+                        retry: 3,
+                    },
+                });
         this.configuration = options.tokenConfiguration;
     }
     /**
      * Get access token. Subsequent calls are cached and the token is renewed only if it is expired.
      */
     async getToken() {
-        var _a;
         if (!this.currentTokenPromise) {
             this.currentTokenPromise = this.getTokenWithoutCache();
             return this.currentTokenPromise;
@@ -26,7 +32,7 @@ class TokenProvider {
         try {
             const jwtToken = await this.currentTokenPromise;
             // lower the token expiry time by 10s so that the returned token will be not immediately expired
-            if (!jwtToken || ((_a = jsonwebtoken_1.default.decode(jwtToken)) === null || _a === void 0 ? void 0 : _a.exp) < Date.now() / 1000 - 10) {
+            if (!jwtToken || jsonwebtoken_1.default.decode(jwtToken)?.exp < Date.now() / 1000 - 10) {
                 this.currentTokenPromise = this.getTokenWithoutCache();
             }
             return await this.currentTokenPromise;
@@ -41,7 +47,7 @@ class TokenProvider {
      */
     async getTokenWithoutCache() {
         const secret = await this.getClientSecret();
-        if (!(secret === null || secret === void 0 ? void 0 : secret.Auth0ClientID) || !secret.Auth0ClientSecret) {
+        if (!secret?.Auth0ClientID || !secret.Auth0ClientSecret) {
             throw new Error('Request error: failed to retrieve Auth0 Client ID/Secret');
         }
         const headers = { 'Content-Type': 'application/json' };

package/lib/util.d.ts

@@ -3,7 +3,7 @@ export declare function safeJwtCanonicalIdParse(jwtToken: string): string | unde
 export declare function safeJsonParse(input: any, defaultValue: unknown): unknown;
 export declare const redactSecret: (data: string) => string;
 export declare function serializeObject(obj: unknown, redact?: boolean): object;
-export declare function serializeAxiosError(error: AxiosError): SerializedAxiosError | undefined;
+export declare function serializeAxiosError(error: AxiosError<any>): SerializedAxiosError | undefined;
 export interface SerializedAxiosError {
     status: number;
     details: any;

package/lib/util.js

@@ -3,18 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAxiosError = exports.serializeObject = exports.redactSecret = exports.safeJsonParse = exports.safeJwtCanonicalIdParse = void 0;
+exports.redactSecret = void 0;
+exports.safeJwtCanonicalIdParse = safeJwtCanonicalIdParse;
+exports.safeJsonParse = safeJsonParse;
+exports.serializeObject = serializeObject;
+exports.serializeAxiosError = serializeAxiosError;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 function safeJwtCanonicalIdParse(jwtToken) {
-    var _a;
     try {
-        return (_a = jsonwebtoken_1.default.decode(jwtToken)) === null || _a === void 0 ? void 0 : _a['https://claims.cimpress.io/canonical_id'];
+        return jsonwebtoken_1.default.decode(jwtToken)?.['https://claims.cimpress.io/canonical_id'];
     }
-    catch (_b) {
+    catch {
         return undefined;
     }
 }
-exports.safeJwtCanonicalIdParse = safeJwtCanonicalIdParse;
 function safeJsonParse(input, defaultValue) {
     try {
         return JSON.parse(input);
@@ -23,7 +25,6 @@ function safeJsonParse(input, defaultValue) {
         return defaultValue;
     }
 }
-exports.safeJsonParse = safeJsonParse;
 const redactSecret = (data) => {
     return data.replace(/(\\*"*'*client_secret\\*"*'*:\s*\\*"*'*)([^"'\\]+)(\\*"*'*)/gi, (m, p1, p2, p3) => `${p1}<REDACTED>${p3}`);
 };
@@ -32,7 +33,6 @@ function serializeObject(obj, redact) {
     let modObj = obj;
     if (obj && typeof obj === 'object') {
         modObj = Object.getOwnPropertyNames(obj).reduce((map, key) => {
-            // eslint-disable-next-line no-param-reassign
             map[key] = obj[key];
             return map;
         }, {});
@@ -41,9 +41,7 @@ function serializeObject(obj, redact) {
         ? JSON.parse((0, exports.redactSecret)(JSON.stringify(modObj)))
         : JSON.parse(JSON.stringify(modObj));
 }
-exports.serializeObject = serializeObject;
 function serializeAxiosError(error) {
-    var _a;
     if (!error.response) {
         return {
             status: 500,
@@ -52,9 +50,8 @@ function serializeAxiosError(error) {
     }
     const { status, data } = error.response;
     return {
-        status: (_a = data.originalStatusCode) !== null && _a !== void 0 ? _a : status,
-        details: data.details && Object.keys(data.details).length > 0 ? data.details : data,
+        status: data.originalStatusCode ?? status, // Propagate original status code of ClientException
+        details: data.details && Object.keys(data.details).length > 0 ? data.details : data, // Prevent wrapping of Exception
         message: data.message,
     };
 }
-exports.serializeAxiosError = serializeAxiosError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "6.1.0",
+  "version": "7.0.0-beta",
   "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,30 +26,33 @@
   },
   "homepage": "https://github.com/Cimpress-MCP/lambda-essentials-ts#readme",
   "dependencies": {
-    "@aws-sdk/client-kms": "^3.569.0",
-    "@aws-sdk/client-secrets-manager": "^3.569.0",
-    "axios": "~0.21.3",
-    "axios-cache-adapter": "~2.7.3",
-    "fast-safe-stringify": "~2.0.7",
+    "@aws-sdk/client-kms": "^3.930.0",
+    "@aws-sdk/client-secrets-manager": "^3.930.0",
+    "@types/node": "^24.10.1",
+    "axios": "1.13.2",
+    "axios-cache-interceptor": "^1.8.3",
+    "fast-safe-stringify": "~2.1.1",
     "is-error": "~2.2.2",
-    "jsonwebtoken": "9.0.0",
+    "jsonwebtoken": "9.0.2",
     "md5": "~2.3.0",
     "openapi-factory": "5.4.60",
-    "retry-axios": "~2.6.0",
-    "uuid": "~8.3.2"
+    "retry-axios": "~3.2.1",
+    "uuid": "~11.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.20",
-    "@types/newrelic": "^9.14.0",
-    "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"
+    "@types/jest": "^29.5.14",
+    "@types/newrelic": "^9.14.8",
+    "redis": "^5.9.0",
+    "axios-mock-adapter": "^2.1.0",
+    "eslint": "^8.57.1",
+    "eslint-config-cimpress-atsquad": "^2.2.0-beta",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.5.2",
+    "prettier": "^2.8.8",
+    "ts-jest": "^29.4.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
   },
   "eslintConfig": {
     "extends": "cimpress-atsquad"
@@ -74,9 +77,9 @@
     "collectCoverage": false
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=20.0.0"
   },
   "peerDependencies": {
-    "newrelic": "^10.2.0"
+    "newrelic": "^12.0.0"
   }
 }

package/lib/httpClient/deduplicateRequestAdapter.d.ts

@@ -1,2 +0,0 @@
-import { AxiosAdapter } from 'axios';
-export declare function createDebounceRequestAdapter(requestAdapter: AxiosAdapter, requestKeyProvider: (AxiosRequestConfig: any) => string): AxiosAdapter;

package/lib/httpClient/deduplicateRequestAdapter.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDebounceRequestAdapter = void 0;
-// adopted from https://github.com/RasCarlito/axios-cache-adapter/issues/231#issuecomment-880288436
-function createDebounceRequestAdapter(requestAdapter, requestKeyProvider) {
-    const runningRequests = {};
-    return (req) => {
-        const cacheKey = requestKeyProvider(req);
-        // Add the request to runningRequests. If it is already there, drop the duplicated request.
-        if (!runningRequests[cacheKey]) {
-            runningRequests[cacheKey] = requestAdapter(req);
-        }
-        // Return the response promise
-        return runningRequests[cacheKey].finally(() => {
-            // Finally, delete the request from the runningRequests whether there's error or not
-            delete runningRequests[cacheKey];
-        });
-    };
-}
-exports.createDebounceRequestAdapter = createDebounceRequestAdapter;