@middy/secrets-manager 3.0.0-alpha.3 → 3.0.0-alpha.7

package/README.md

@@ -1,26 +1,36 @@
-# Middy secrets-manager middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy secrets-manager middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>Secrets Manager middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fsecrets-manager">
+  <a href="https://www.npmjs.com/package/@middy/secrets-manager?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fsecrets-manager.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/secrets-manager">
+    <img src="https://packagephobia.com/badge?p=@middy/secrets-manager" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <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://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <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>
+  <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%;">
   </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
@@ -46,9 +56,9 @@ npm install --save @middy/secrets-manager
 ## Options
 
 - `AwsClient` (object) (default `AWS.SecretsManager`): AWS.SecretsManager class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
-- `awsClientOptions` (object) (optional): Options to pass to AWS.SecretsManager class constructor.
-- `awsClientAssumeRole` (string) (optional): Internal key where secrets are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
-- `awsClientCapture` (function) (optional): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
+- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.SecretsManager class constructor.
+- `awsClientAssumeRole` (string) (default `undefined`): Internal key where secrets are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
+- `awsClientCapture` (function) (default `undefined`): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
 - `fetchData` (object) (required): Mapping of internal key name to API request parameter `SecretId`.
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 - `cacheKey` (string) (default `secrets-manager`): Cache key for the fetched data responses. Must be unique across all middleware.

package/index.js

@@ -1,79 +1,3 @@
-import {
-  canPrefetch,
-  createPrefetchClient,
-  createClient,
-  getCache,
-  getInternal,
-  processCache,
-  modifyCache,
-  jsonSafeParse
-} from '@middy/util'
-import SecretsManager from 'aws-sdk/clients/secretsmanager.js' // v2
-// import { SecretsManager } from '@aws-sdk/client-secrets-manager'  // v3
+import{canPrefetch,createPrefetchClient,createClient,getCache,getInternal,processCache,modifyCache,jsonSafeParse}from'@middy/util';import SecretsManager from'aws-sdk/clients/secretsmanager.js';const defaults={AwsClient:SecretsManager,awsClientOptions:{},awsClientAssumeRole:undefined,awsClientCapture:undefined,fetchData:{},disablePrefetch:false,cacheKey:'secrets-manager',cacheExpiry:-1,setToContext:false};const secretsManagerMiddleware=(opts={})=>{const options={...defaults,...opts};const fetch=(request,cachedValues={})=>{const values={};for(const internalKey of Object.keys(options.fetchData)){if(cachedValues[internalKey])continue;values[internalKey]=client.getSecretValue({SecretId:options.fetchData[internalKey]}).promise().then(resp=>jsonSafeParse(resp.SecretString)).catch(e=>{const value=getCache(options.cacheKey).value??{};value[internalKey]=undefined;modifyCache(options.cacheKey,value);throw e})}return values};let prefetch,client;if(canPrefetch(options)){client=createPrefetchClient(options);prefetch=processCache(options,fetch)}const secretsManagerMiddlewareBefore=async request=>{if(!client){client=await createClient(options,request)}const{value}=prefetch??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:secretsManagerMiddlewareBefore}};export default secretsManagerMiddleware
 
-const defaults = {
-  AwsClient: SecretsManager,
-  awsClientOptions: {},
-  awsClientAssumeRole: undefined,
-  awsClientCapture: undefined,
-  fetchData: {}, // If more than 2, consider writing own using ListSecrets
-  disablePrefetch: false,
-  cacheKey: 'secrets-manager',
-  cacheExpiry: -1,
-  setToContext: false
-}
-
-const secretsManagerMiddleware = (opts = {}) => {
-  const options = { ...defaults, ...opts }
-
-  const fetch = (request, cachedValues = {}) => {
-    const values = {}
-
-    // Multiple secrets can be requested in a single requests,
-    // however this is likely uncommon IRL, increases complexity to handle,
-    // and will require recursive promise resolution impacting performance.
-    // See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SecretsManager.html#listSecrets-property
-    for (const internalKey of Object.keys(options.fetchData)) {
-      if (cachedValues[internalKey]) continue
-      values[internalKey] = client
-        .getSecretValue({ SecretId: options.fetchData[internalKey] })
-        .promise() // Required for aws-sdk v2
-        .then((resp) => jsonSafeParse(resp.SecretString))
-        .catch((e) => {
-          const value = getCache(options.cacheKey).value ?? {}
-          value[internalKey] = undefined
-          modifyCache(options.cacheKey, value)
-          throw e
-        })
-    }
-    return values
-  }
-
-  let prefetch, client
-  if (canPrefetch(options)) {
-    client = createPrefetchClient(options)
-    prefetch = processCache(options, fetch)
-  }
-
-  const secretsManagerMiddlewareBefore = async (request) => {
-    if (!client) {
-      client = await createClient(options, request)
-    }
-
-    const { value } = prefetch ?? 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: secretsManagerMiddlewareBefore
-  }
-}
-export default secretsManagerMiddleware
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/secrets-manager",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.7",
   "description": "Secrets Manager middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -46,12 +46,12 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.3"
+    "@middy/util": "^3.0.0-alpha.7"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.3",
+    "@middy/core": "^3.0.0-alpha.7",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
+  "gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
 }