@middy/sts 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,35 +1,52 @@
 import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
-import { STSClient, STSClientConfig } from '@aws-sdk/client-sts'
+import { AssumeRoleCommandInput, STSClient, STSClientConfig } from '@aws-sdk/client-sts'
 
-interface Options<AwsSTSClient = STSClient>
+export interface AssumedRoleCredentials {
+  accessKeyId: string
+  secretAccessKey: string
+  sessionToken: string
+}
+
+export type AssumeRoleCommandInputWithOptionalRoleSessionName = Omit<
+AssumeRoleCommandInput, 'RoleSessionName'
+> & { RoleSessionName?: string | undefined }
+
+interface STSOptions<AwsSTSClient = STSClient>
   extends Pick<
   MiddyOptions<AwsSTSClient, STSClientConfig>,
   | 'AwsClient'
   | 'awsClientOptions'
   | 'awsClientCapture'
-  | 'fetchData'
   | 'disablePrefetch'
   | 'cacheKey'
   | 'cacheExpiry'
   | 'setToContext'
-  > {}
-
-export type Context<TOptions extends Options | undefined> = TOptions extends {
-  setToContext: true
+  > {
+  fetchData?: { [key: string]: AssumeRoleCommandInputWithOptionalRoleSessionName }
 }
-  ? LambdaContext &
-  Record<
-  keyof TOptions['fetchData'],
-  {
-    credentials: STSClientConfig['credentials']
-  }
-  >
-  : LambdaContext
 
-declare function sts<TOptions extends Options> (
+export type Context<TOptions extends STSOptions | undefined> =
+  TOptions extends { setToContext: true }
+    ? TOptions extends { fetchData: infer TFetchData }
+      ? LambdaContext & {
+        [Key in keyof TFetchData]: AssumedRoleCredentials
+      }
+      : never
+    : LambdaContext
+
+export type Internal<TOptions extends STSOptions | undefined> =
+    TOptions extends STSOptions
+      ? TOptions extends { fetchData: infer TFetchData }
+        ? {
+            [Key in keyof TFetchData]: AssumedRoleCredentials
+          }
+        : {}
+      : {}
+
+declare function sts<TOptions extends STSOptions | undefined> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default sts

package/index.js

@@ -3,10 +3,12 @@ import { STSClient, AssumeRoleCommand } from '@aws-sdk/client-sts';
 const defaults = {
     AwsClient: STSClient,
     awsClientOptions: {},
+    // awsClientAssumeRole: undefined, // Not Applicable, as this is the middleware that defines the roles
     awsClientCapture: undefined,
     fetchData: {},
     disablePrefetch: false,
     cacheKey: 'sts',
+    cacheKeyExpiry: {},
     cacheExpiry: -1,
     setToContext: false
 };
@@ -20,6 +22,7 @@ const stsMiddleware = (opts = {})=>{
         for (const internalKey of Object.keys(options.fetchData)){
             if (cachedValues[internalKey]) continue;
             const assumeRoleOptions = options.fetchData[internalKey];
+            // Date cannot be used here to assign default session name, possibility of collision when > 1 role defined
             assumeRoleOptions.RoleSessionName ??= 'middy-sts-session-' + Math.ceil(Math.random() * 99999);
             values[internalKey] = client.send(new AssumeRoleCommand(assumeRoleOptions)).then((resp)=>({
                     accessKeyId: resp.Credentials.AccessKeyId,
@@ -34,22 +37,21 @@ const stsMiddleware = (opts = {})=>{
         }
         return values;
     };
-    let prefetch, client;
+    let client;
     if (canPrefetch(options)) {
         client = createPrefetchClient(options);
-        prefetch = processCache(options, fetch);
+        processCache(options, fetch);
     }
     const stsMiddlewareBefore = async (request)=>{
         if (!client) {
             client = await createClient(options, 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);
             if (options.setToContext) Object.assign(request.context, data);
         }
-        prefetch = null;
     };
     return {
         before: stsMiddlewareBefore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/sts",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "STS (Security Token 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,13 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
     "@aws-sdk/client-sts": "^3.0.0",
-    "@middy/core": "5.0.0-alpha.0",
+    "@middy/core": "5.0.0-alpha.2",
     "@types/aws-lambda": "^8.10.101",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _util = require("@middy/util");
-const _clientSts = require("@aws-sdk/client-sts");
-const defaults = {
-    AwsClient: _clientSts.STSClient,
-    awsClientOptions: {},
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'sts',
-    cacheExpiry: -1,
-    setToContext: false
-};
-const stsMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues = {})=>{
-        const values = {};
-        for (const internalKey of Object.keys(options.fetchData)){
-            if (cachedValues[internalKey]) continue;
-            const assumeRoleOptions = options.fetchData[internalKey];
-            assumeRoleOptions.RoleSessionName ??= 'middy-sts-session-' + Math.ceil(Math.random() * 99999);
-            values[internalKey] = client.send(new _clientSts.AssumeRoleCommand(assumeRoleOptions)).then((resp)=>({
-                    accessKeyId: resp.Credentials.AccessKeyId,
-                    secretAccessKey: resp.Credentials.SecretAccessKey,
-                    sessionToken: resp.Credentials.SessionToken
-                })).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, client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-        prefetch = (0, _util.processCache)(options, fetch);
-    }
-    const stsMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await (0, _util.createClient)(options, 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);
-            if (options.setToContext) Object.assign(request.context, data);
-        }
-        prefetch = null;
-    };
-    return {
-        before: stsMiddlewareBefore
-    };
-};
-const _default = stsMiddleware;
-