@middy/sts 4.6.5 → 5.0.0-alpha.1

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

@@ -1,61 +1,80 @@
-import { canPrefetch, createPrefetchClient, createClient, getCache, getInternal, processCache, modifyCache } from '@middy/util';
-import { STSClient, AssumeRoleCommand } from '@aws-sdk/client-sts';
+import {
+  canPrefetch,
+  createPrefetchClient,
+  createClient,
+  getCache,
+  getInternal,
+  processCache,
+  modifyCache
+} from '@middy/util'
+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
-};
-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];
-            // 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,
-                    secretAccessKey: resp.Credentials.SecretAccessKey,
-                    sessionToken: resp.Credentials.SessionToken
-                })).catch((e)=>{
-                const value = getCache(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                modifyCache(options.cacheKey, value);
-                throw e;
-            });
-        }
-        return values;
-    };
-    let client;
-    if (canPrefetch(options)) {
-        client = createPrefetchClient(options);
-        processCache(options, fetch);
+  AwsClient: STSClient,
+  awsClientOptions: {},
+  // awsClientAssumeRole: undefined, // Not Applicable, as this is the middleware that defines the roles
+  awsClientCapture: undefined,
+  fetchData: {}, // { contextKey: {RoleArn, RoleSessionName} }
+  disablePrefetch: false,
+  cacheKey: 'sts',
+  cacheKeyExpiry: {},
+  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]
+      // 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,
+          secretAccessKey: resp.Credentials.SecretAccessKey,
+          sessionToken: resp.Credentials.SessionToken
+        }))
+        .catch((e) => {
+          const value = getCache(options.cacheKey).value ?? {}
+          value[internalKey] = undefined
+          modifyCache(options.cacheKey, value)
+          throw e
+        })
+    }
+
+    return values
+  }
+
+  let client
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options)
+    processCache(options, fetch)
+  }
+
+  const stsMiddlewareBefore = async (request) => {
+    if (!client) {
+      client = await createClient(options, 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)
     }
-    const stsMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await createClient(options, 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);
-        }
-    };
-    return {
-        before: stsMiddlewareBefore
-    };
-};
-export default stsMiddleware;
+  }
 
+  return {
+    before: stsMiddlewareBefore
+  }
+}
+export default stsMiddleware

package/package.json

@@ -1,33 +1,27 @@
 {
   "name": "@middy/sts",
-  "version": "4.6.5",
+  "version": "5.0.0-alpha.1",
   "description": "STS (Security Token Service) credentials middleware for the middy framework",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "engineStrict": true,
   "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": "4.6.5"
+    "@middy/util": "5.0.0-alpha.1"
   },
   "devDependencies": {
     "@aws-sdk/client-sts": "^3.0.0",
-    "@middy/core": "4.6.5",
+    "@middy/core": "5.0.0-alpha.1",
     "@types/aws-lambda": "^8.10.101",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "573d7b0bb243d8c5a9bcb00cf29d031aa7a0c606"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: function() {
-        return _default;
-    }
-});
-const _util = require("@middy/util");
-const _clientsts = require("@aws-sdk/client-sts");
-const defaults = {
-    AwsClient: _clientsts.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
-};
-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];
-            // 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 _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 client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-        (0, _util.processCache)(options, fetch);
-    }
-    const stsMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await (0, _util.createClient)(options, request);
-        }
-        const { value } = (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);
-        }
-    };
-    return {
-        before: stsMiddlewareBefore
-    };
-};
-const _default = stsMiddleware;
-