@middy/rds-signer 5.0.0-alpha.0 → 5.0.0-alpha.2

package/README.md

@@ -19,8 +19,9 @@
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.d.ts

@@ -1,10 +1,34 @@
 import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
+import { Context as LambdaContext } from 'aws-lambda'
 import { SignerConfig, Signer } from '@aws-sdk/rds-signer'
 
-interface Options<AwsSigner = Signer>
-  extends MiddyOptions<AwsSigner, SignerConfig> {}
+export type RdsSignerOptions<AwsSigner = Signer> = Omit<MiddyOptions<AwsSigner, SignerConfig>, 'fetchData'> & {
+  fetchData?: {
+    [key: string]: SignerConfig
+  }
+}
 
-declare function rdsSigner (options?: Options): middy.MiddlewareObj
+export type Context<TOptions extends RdsSignerOptions | undefined> =
+TOptions extends { setToContext: true }
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? LambdaContext & {
+      [Key in keyof TFetchData]: string
+    }
+    : LambdaContext
+  : LambdaContext
+
+export type Internal<TOptions extends RdsSignerOptions | undefined> =
+TOptions extends RdsSignerOptions
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? {
+        [Key in keyof TFetchData]: string
+      }
+    : {}
+  : {}
+
+declare function rdsSigner<TOptions extends RdsSignerOptions | undefined> (
+  options?: TOptions
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default rdsSigner

package/index.js

@@ -6,6 +6,7 @@ const defaults = {
     fetchData: {},
     disablePrefetch: false,
     cacheKey: 'rds-signer',
+    cacheKeyExpiry: {},
     cacheExpiry: -1,
     setToContext: false
 };
@@ -23,8 +24,13 @@ const rdsSignerMiddleware = (opts = {})=>{
                 ...options.fetchData[internalKey]
             });
             values[internalKey] = client.getAuthToken().then((token)=>{
+                // Catch Missing token, this usually means their is something wrong with the credentials
                 if (!token.includes('X-Amz-Security-Token=')) {
-                    throw new Error('[rds-signer] X-Amz-Security-Token Missing');
+                    throw new Error('X-Amz-Security-Token Missing', {
+                        cause: {
+                            package: '@middy/rds-signer'
+                        }
+                    });
                 }
                 return token;
             }).catch((e)=>{
@@ -36,18 +42,16 @@ const rdsSignerMiddleware = (opts = {})=>{
         }
         return values;
     };
-    let prefetch;
     if (canPrefetch(options)) {
-        prefetch = processCache(options, fetch);
+        processCache(options, fetch);
     }
     const rdsSignerMiddlewareBefore = async (request)=>{
-        const { value  } = prefetch ?? processCache(options, fetch, request);
+        const { value } = processCache(options, fetch, request);
         Object.assign(request.internal, value);
         if (options.setToContext) {
             const data = await getInternal(Object.keys(options.fetchData), request);
             Object.assign(request.context, data);
         }
-        prefetch = null;
     };
     return {
         before: rdsSignerMiddlewareBefore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/rds-signer",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "RDS (Relational Database Service) credentials middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -66,13 +60,14 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
     "@aws-sdk/rds-signer": "^3.0.0",
-    "@middy/core": "5.0.0-alpha.0",
-    "@types/node": "^18.0.0",
+    "@middy/core": "5.0.0-alpha.2",
+    "@types/aws-lambda": "^8.10.101",
+    "@types/node": "^20.0.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _util = require("@middy/util");
-const _rdsSigner = require("@aws-sdk/rds-signer");
-const defaults = {
-    AwsClient: _rdsSigner.Signer,
-    awsClientOptions: {},
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'rds-signer',
-    cacheExpiry: -1,
-    setToContext: false
-};
-const rdsSignerMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues = {})=>{
-        const values = {};
-        for (const internalKey of Object.keys(options.fetchData)){
-            if (cachedValues[internalKey]) continue;
-            const client = new options.AwsClient({
-                ...options.awsClientOptions,
-                ...options.fetchData[internalKey]
-            });
-            values[internalKey] = client.getAuthToken().then((token)=>{
-                if (!token.includes('X-Amz-Security-Token=')) {
-                    throw new Error('[rds-signer] X-Amz-Security-Token Missing');
-                }
-                return token;
-            }).catch((e)=>{
-                const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                (0, _util.modifyCache)(options.cacheKey, value);
-                throw e;
-            });
-        }
-        return values;
-    };
-    let prefetch;
-    if ((0, _util.canPrefetch)(options)) {
-        prefetch = (0, _util.processCache)(options, fetch);
-    }
-    const rdsSignerMiddlewareBefore = async (request)=>{
-        const { value  } = prefetch ?? (0, _util.processCache)(options, fetch, request);
-        Object.assign(request.internal, value);
-        if (options.setToContext) {
-            const data = await (0, _util.getInternal)(Object.keys(options.fetchData), request);
-            Object.assign(request.context, data);
-        }
-        prefetch = null;
-    };
-    return {
-        before: rdsSignerMiddlewareBefore
-    };
-};
-const _default = rdsSignerMiddleware;
-