@middy/ssm 4.0.0 → 4.0.2

package/README.md

@@ -36,115 +36,6 @@
 <p>You can read the documentation at: <a href="https://middy.js.org/docs/middlewares/ssm">https://middy.js.org/docs/middlewares/ssm</a></p>
 </div>
 
-This middleware fetches parameters from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html).
-
-Parameters to fetch can be defined by path and by name (not mutually exclusive). See AWS docs [here](https://aws.amazon.com/blogs/mt/organize-parameters-by-hierarchy-tags-or-amazon-cloudwatch-events-with-amazon-ec2-systems-manager-parameter-store/).
-
-Parameters can be assigned to the function handler's `context` object by setting the `setToContext` flag to `true`. By default all parameters are added with uppercase names.
-
-The Middleware makes a single API request to fetch all the parameters defined by name, but must make an additional request per specified path. This is because the AWS SDK currently doesn't expose a method to retrieve parameters from multiple paths.
-
-For each parameter defined by name, you also provide the name under which its value should be added to `context`. For each path, you instead provide a prefix, and by default the value import each parameter returned from that path will be added to `context` with a name equal to what's left of the parameter's full name _after_ the defined path, with the prefix prepended. If the prefix is an empty string, nothing is prepended. You can override this behaviour by providing your own mapping function with the `getParamNameFromPath` config option.
-
-## Install
-
-To install this middleware you can use NPM:
-
-```bash
-npm install --save @middy/ssm
-```
-
-## Options
-
-- `AwsClient` (object) (default `SSMClient`): SSMClient class constructor (i.e. that has been instrumented with AWS X-Ray). Must be from `@aws-sdk/client-ssm`.
-- `awsClientOptions` (object) (default `undefined`): Options to pass to SSMClient class constructor.
-- `awsClientAssumeRole` (string) (default `undefined`): Internal key where role tokens are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
-- `awsClientCapture` (function) (default `undefined`): Enable AWS X-Ray by passing `captureAWSClient` from `aws-xray-sdk` in.
-- `fetchData` (object) (required): Mapping of internal key name to API request parameter `Names`/`Path`. `SecureString` are automatically decrypted.
-- `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
-- `cacheKey` (string) (default `ssm`): Cache key for the fetched data responses. Must be unique across all middleware.
-- `cacheExpiry` (number) (default `-1`): How long fetch data responses should be cached for. `-1`: cache forever, `0`: never cache, `n`: cache for n ms.
-- `setToContext` (boolean) (default `false`): Store role tokens to `request.context`.
-
-NOTES:
-
-- Lambda is required to have IAM permission for `ssm:GetParameters` and/or `ssm:GetParametersByPath` depending on what you're requesting.
-- `SSM` has [throughput limitations](https://docs.aws.amazon.com/general/latest/gr/ssm.html). Switching to Advanced Parameter type or increasing `maxRetries` and `retryDelayOptions.base` in `awsClientOptions` may be required.
-
-## Sample usage
-
-```javascript
-import middy from '@middy/core'
-import ssm from '@middy/ssm'
-
-const handler = middy((event, context) => {
-  return {}
-})
-
-let globalDefaults = {}
-handler
-  .use(
-    ssm({
-      fetchData: {
-        accessToken: '/dev/service_name/access_token', // single value
-        dbParams: '/dev/service_name/database/', // object of values, key for each path
-        defaults: '/dev/defaults'
-      },
-      setToContext: true
-    })
-  )
-  .before((request) => {
-    globalDefaults = request.context.defaults.global
-  })
-```
-
-```javascript
-import middy from '@middy/core'
-import { getInternal } from '@middy/util'
-import ssm from '@middy/ssm'
-
-const handler = middy((event, context) => {
-  return {}
-})
-
-let globalDefaults = {}
-handler
-  .use(
-    ssm({
-      fetchData: {
-        defaults: '/dev/defaults'
-      },
-      cacheKey: 'ssm-defaults'
-    })
-  )
-  .use(
-    ssm({
-      fetchData: {
-        accessToken: '/dev/service_name/access_token', // single value
-        dbParams: '/dev/service_name/database/' // object of values, key for each path
-      },
-      cacheExpiry: 15 * 60 * 1000,
-      cacheKey: 'ssm-secrets'
-    })
-  )
-  // ... other middleware that fetch
-  .before(async (request) => {
-    const data = await getInternal(
-      ['accessToken', 'dbParams', 'defaults'],
-      request
-    )
-    Object.assign(request.context, data)
-  })
-```
-
-## Middy documentation and examples
-
-For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
-
-## Contributing
-
-Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
-
 ## License
 
 Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/ssm",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "SSM (EC2 Systems Manager) parameters middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -62,14 +62,14 @@
   },
   "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "4.0.0"
+    "@middy/util": "4.0.2"
   },
   "devDependencies": {
     "@aws-sdk/client-ssm": "^3.186.0",
-    "@middy/core": "4.0.0",
+    "@middy/core": "4.0.2",
     "@types/aws-lambda": "^8.10.101",
     "aws-xray-sdk": "^3.3.3",
     "type-fest": "^3.0.0"
   },
-  "gitHead": "582286144bcd79968a8c7c2f8867a23c80079a47"
+  "gitHead": "c77c9413ecb80999a71b67ff97edac1fed2ca754"
 }