@middy/ssm 3.6.1 → 4.0.0-alpha.0

package/README.md

@@ -46,7 +46,6 @@ The Middleware makes a single API request to fetch all the parameters defined by
 
 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:
@@ -55,11 +54,10 @@ To install this middleware you can use NPM:
 npm install --save @middy/ssm
 ```
 
-
 ## Options
 
-- `AwsClient` (object) (default `AWS.SSM`): AWS.SSM class constructor (e.g. that has been instrumented with AWS X-Ray). Must be from `aws-sdk` v2.
-- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.SSM class constructor.
+- `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.
@@ -69,6 +67,7 @@ npm install --save @middy/ssm
 - `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.
 
@@ -84,14 +83,16 @@ const handler = middy((event, context) => {
 
 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
-  }))
+  .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
   })
@@ -99,7 +100,7 @@ handler
 
 ```javascript
 import middy from '@middy/core'
-import {getInternal} from '@middy/util'
+import { getInternal } from '@middy/util'
 import ssm from '@middy/ssm'
 
 const handler = middy((event, context) => {
@@ -108,38 +109,42 @@ const handler = middy((event, context) => {
 
 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'
-  }))
+  .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)
+    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/index.cjs

@@ -7,15 +7,10 @@ Object.defineProperty(module, "exports", {
     get: ()=>_default
 });
 const _util = require("@middy/util");
-const _ssmJs = _interopRequireDefault(require("aws-sdk/clients/ssm.js"));
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
+const _clientSsm = require("@aws-sdk/client-ssm");
 const awsRequestLimit = 10;
 const defaults = {
-    AwsClient: _ssmJs.default,
+    AwsClient: _clientSsm.SSMClient,
     awsClientOptions: {},
     awsClientAssumeRole: undefined,
     awsClientCapture: undefined,
@@ -52,10 +47,10 @@ const ssmMiddleware = (opts = {})=>{
             if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === internalKeys.length)) {
                 continue;
             }
-            batchReq = client.getParameters({
+            batchReq = client.send(new _clientSsm.GetParametersCommand({
                 Names: batchFetchKeys,
                 WithDecryption: true
-            }).promise().then((resp)=>{
+            })).then((resp)=>{
                 return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
                     return {
                         [fetchKey]: new Promise(()=>{
@@ -104,12 +99,12 @@ const ssmMiddleware = (opts = {})=>{
         return values;
     };
     const fetchPath = (path, nextToken, values = {})=>{
-        return client.getParametersByPath({
+        return client.send(new _clientSsm.GetParametersByPathCommand({
             Path: path,
             NextToken: nextToken,
             Recursive: true,
             WithDecryption: true
-        }).promise().then((resp)=>{
+        })).then((resp)=>{
             Object.assign(values, ...resp.Parameters.map((param)=>{
                 return {
                     [(0, _util.sanitizeKey)(param.Name.replace(path, ''))]: parseValue(param)

package/index.d.ts

@@ -1,11 +1,11 @@
 import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
-import SSM from 'aws-sdk/clients/ssm'
+import { SSMClient, SSMClientConfig } from '@aws-sdk/client-ssm'
 import { JsonValue } from 'type-fest'
 
-interface Options<S = SSM>
-  extends MiddyOptions<S, SSM.Types.ClientConfiguration> {}
+interface Options<AwsSSMClient = SSMClient>
+  extends MiddyOptions<AwsSSMClient, SSMClientConfig> {}
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type ExtractSingles<T> = T extends `/${infer _}` ? never : T

package/index.js

@@ -1,8 +1,8 @@
 import { canPrefetch, createPrefetchClient, createClient, processCache, getCache, modifyCache, jsonSafeParse, getInternal, sanitizeKey } from '@middy/util';
-import SSM from 'aws-sdk/clients/ssm.js';
+import { SSMClient, GetParametersCommand, GetParametersByPathCommand } from '@aws-sdk/client-ssm';
 const awsRequestLimit = 10;
 const defaults = {
-    AwsClient: SSM,
+    AwsClient: SSMClient,
     awsClientOptions: {},
     awsClientAssumeRole: undefined,
     awsClientCapture: undefined,
@@ -39,10 +39,10 @@ const ssmMiddleware = (opts = {})=>{
             if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === internalKeys.length)) {
                 continue;
             }
-            batchReq = client.getParameters({
+            batchReq = client.send(new GetParametersCommand({
                 Names: batchFetchKeys,
                 WithDecryption: true
-            }).promise().then((resp)=>{
+            })).then((resp)=>{
                 return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
                     return {
                         [fetchKey]: new Promise(()=>{
@@ -91,12 +91,12 @@ const ssmMiddleware = (opts = {})=>{
         return values;
     };
     const fetchPath = (path, nextToken, values = {})=>{
-        return client.getParametersByPath({
+        return client.send(new GetParametersByPathCommand({
             Path: path,
             NextToken: nextToken,
             Recursive: true,
             WithDecryption: true
-        }).promise().then((resp)=>{
+        })).then((resp)=>{
             Object.assign(values, ...resp.Parameters.map((param)=>{
                 return {
                     [sanitizeKey(param.Name.replace(path, ''))]: parseValue(param)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@middy/ssm",
-  "version": "3.6.1",
+  "version": "4.0.0-alpha.0",
   "description": "SSM (EC2 Systems Manager) parameters middleware for the middy framework",
   "type": "module",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "engineStrict": true,
   "publishConfig": {
@@ -62,14 +62,14 @@
   },
   "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "3.6.1"
+    "@middy/util": "4.0.0-alpha.0"
   },
   "devDependencies": {
-    "@middy/core": "3.6.1",
+    "@aws-sdk/client-ssm": "^3.186.0",
+    "@middy/core": "4.0.0-alpha.0",
     "@types/aws-lambda": "^8.10.101",
-    "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3",
     "type-fest": "^3.0.0"
   },
-  "gitHead": "31a7f9f8e93a73a8be382b3022b9cfcbc13b2961"
+  "gitHead": "306fb9aa633d5757d11ced3dc192f046ef3c2685"
 }