lambda-essentials-ts 5.3.2 → 6.0.0

package/CHANGELOG.md

@@ -4,11 +4,24 @@ 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
+
+### Changed
+
+- **[Breaking change]** Upgraded aws-sdk to v3 which has `SecretsManager` and `KMS` replaced by `SecretsManagerClient` and `KMSClient` class.
+  The functionality and interface remains the same, the imports need to be changed.
+
+## [5.4.0] - 2024-02-08
+
+### Added
+
+HttpClient options now accept `clientExceptionStatusCodeMapOverride` which can be used to override the default HTTP error status code mapping. This is useful e.g. when a dependent service is not following REST-ful best practices and e.g. returns a 403 when there's an intermittent network error communicating with the authorization service
+
 ## [5.3.2] - 2024-02-08
 
 ### Fixed
 
-Error details of external HTTP error resposes are propagated correctly
+Error details of external HTTP error responses are propagated correctly
 
 ## [5.3.1] - 2023-10-25
 

package/lib/exceptions/clientException.d.ts

@@ -3,6 +3,6 @@ export declare class ClientException extends Exception {
     readonly serviceName: string;
     readonly originalStatusCode?: number;
     private static readonly statusCodeMap;
-    constructor(serviceName: string, originalStatusCode?: number, details?: any);
+    constructor(serviceName: string, originalStatusCode?: number, details?: any, statusCodeMapOverride?: Record<number, number>);
     private static convertStatusCode;
 }

package/lib/exceptions/clientException.js

@@ -3,15 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientException = void 0;
 const exception_1 = require("./exception");
 class ClientException extends exception_1.Exception {
-    constructor(serviceName, originalStatusCode, details) {
-        super(`Dependent service "${serviceName}" returned error`, ClientException.convertStatusCode(originalStatusCode), details);
+    constructor(serviceName, originalStatusCode, details, statusCodeMapOverride) {
+        super(`Dependent service "${serviceName}" returned error`, ClientException.convertStatusCode(originalStatusCode, statusCodeMapOverride), details);
         this.serviceName = serviceName;
         this.originalStatusCode = originalStatusCode;
     }
-    static convertStatusCode(originalStatusCode) {
+    static convertStatusCode(originalStatusCode, statusCodeMapOverride) {
         let statusCode = 503;
-        if (originalStatusCode && this.statusCodeMap[originalStatusCode]) {
-            statusCode = this.statusCodeMap[originalStatusCode];
+        const statusCodeMap = {
+            ...ClientException.statusCodeMap,
+            ...(statusCodeMapOverride || {}),
+        };
+        if (originalStatusCode && statusCodeMap[originalStatusCode]) {
+            statusCode = statusCodeMap[originalStatusCode];
         }
         return statusCode;
     }

package/lib/httpClient/httpClient.d.ts

@@ -17,6 +17,7 @@ export default class HttpClient {
     private readonly enableRetry;
     private readonly enableCache;
     private readonly timeout?;
+    private readonly clientExceptionStatusCodeMapOverride?;
     /**
      * Create a new Instance of the HttpClient
      */
@@ -100,6 +101,11 @@ export interface HttpClientOptions {
      * @link https://github.com/axios/axios/blob/main/README.md#request-config
      */
     timeout?: number;
+    /**
+     * Override the default mapping of status code when wrapping error responses returned by dependencies into ClientException.
+     * This is useful, when dependent services return incorrect status codes than then drive incorrect behavior upstream (e.g. 403 instead of 503)
+     */
+    clientExceptionStatusCodeMapOverride?: Record<number, number>;
 }
 /**
  * Log options object.

package/lib/httpClient/httpClient.js

@@ -62,6 +62,7 @@ class HttpClient {
         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: (() => {
@@ -129,7 +130,7 @@ class HttpClient {
             const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
                 ? new url_1.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);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, this.clientExceptionStatusCodeMapOverride);
         });
         this.client.interceptors.response.use((response) => {
             if (this.logOptions.enabledLogs.includes(HttpLogType.responses)) {
@@ -168,7 +169,7 @@ class HttpClient {
             const hostname = ((_a = error.config) === null || _a === void 0 ? void 0 : _a.url)
                 ? new url_1.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);
+            throw new clientException_1.ClientException(hostname, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.status, serializedAxiosError === null || serializedAxiosError === void 0 ? void 0 : serializedAxiosError.details, this.clientExceptionStatusCodeMapOverride);
         });
     }
     static extractRequestLogData(requestConfig) {

package/lib/tokenProvider/kmsTokenProvider.d.ts

@@ -1,5 +1,5 @@
-import { KMS } from 'aws-sdk';
 import TokenProvider, { Auth0Secret, TokenConfiguration, TokenProviderOptions } from './tokenProvider';
+import { KMSClient } from '@aws-sdk/client-kms';
 export default class KmsTokenProvider extends TokenProvider {
     private kmsClient;
     private kmsConfiguration;
@@ -10,7 +10,7 @@ export interface KmsTokenProviderOptions extends TokenProviderOptions {
     /**
      * AWS KMS Client
      */
-    kmsClient: KMS;
+    kmsClient: KMSClient;
     /**
      * Configuration needed for the token
      */

package/lib/tokenProvider/kmsTokenProvider.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const tokenProvider_1 = __importDefault(require("./tokenProvider"));
+const client_kms_1 = require("@aws-sdk/client-kms");
 class KmsTokenProvider extends tokenProvider_1.default {
     constructor(options) {
         super(options);
@@ -11,12 +12,11 @@ class KmsTokenProvider extends tokenProvider_1.default {
         this.kmsConfiguration = options.tokenConfiguration;
     }
     async getClientSecret() {
-        const secret = await this.kmsClient
-            .decrypt({
+        var _a;
+        const data = await this.kmsClient.send(new client_kms_1.DecryptCommand({
             CiphertextBlob: Buffer.from(this.kmsConfiguration.encryptedClientSecret, 'base64'),
-        })
-            .promise()
-            .then((data) => { var _a; return (_a = data.Plaintext) === null || _a === void 0 ? void 0 : _a.toString(); });
+        }));
+        const secret = (_a = data.Plaintext) === null || _a === void 0 ? void 0 : _a.toString();
         if (!secret) {
             throw new Error('Request error: failed to decrypt secret using KMS');
         }

package/lib/tokenProvider/secretsManagerTokenProvider.d.ts

@@ -1,5 +1,5 @@
-import { SecretsManager } from 'aws-sdk';
 import TokenProvider, { Auth0Secret, TokenConfiguration, TokenProviderOptions } from './tokenProvider';
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 export default class SecretsManagerTokenProvider extends TokenProvider {
     private secretsManagerClient;
     private secretsManagerConfiguration;
@@ -10,7 +10,7 @@ export interface SecretsManagerTokenProviderOptions extends TokenProviderOptions
     /**
      * AWS Secrets Manager Client
      */
-    secretsManagerClient: SecretsManager;
+    secretsManagerClient: SecretsManagerClient;
     /**
      * Configuration needed for the token
      */

package/lib/tokenProvider/secretsManagerTokenProvider.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const tokenProvider_1 = __importDefault(require("./tokenProvider"));
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
 class SecretsManagerTokenProvider extends tokenProvider_1.default {
     constructor(options) {
         super(options);
@@ -11,9 +12,9 @@ class SecretsManagerTokenProvider extends tokenProvider_1.default {
         this.secretsManagerConfiguration = options.tokenConfiguration;
     }
     async getClientSecret() {
-        const secret = await this.secretsManagerClient
-            .getSecretValue({ SecretId: this.secretsManagerConfiguration.clientSecretId })
-            .promise();
+        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)) {
             throw new Error('Request error: failed to retrieve secret from Secrets Manager');
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-essentials-ts",
-  "version": "5.3.2",
+  "version": "6.0.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,7 +26,8 @@
   },
   "homepage": "https://github.com/Cimpress-MCP/lambda-essentials-ts#readme",
   "dependencies": {
-    "aws-sdk": "^2.1287.0",
+    "@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",