@middy/rds-signer 3.6.1 → 4.0.0-alpha.0

package/README.md

@@ -46,11 +46,10 @@ To install this middleware you can use NPM:
 npm install --save @middy/rds-signer
 ```
 
-
 ## Options
 
-- `AwsClient` (object) (default `AWS.RDS.Signer`): AWS.RDS.Signer class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
-- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.RDS.Signer class constructor.
+- `AwsClient` (object) (default `Signer`): Signer class constructor (e.g. that has been instrumented with AWS XRay). Must be from `@aws-sdk/rds-signer`.
+- `awsClientOptions` (object) (default `undefined`): Options to pass to Signer class constructor.
 - `fetchData` (object `{ contextKey: {region, hostname, username, database, port} }`) (required): Mapping of internal key name to API request parameters.
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 - `cacheKey` (string) (default `rds-signer`): Cache key for the fetched data responses. Must be unique across all middleware.
@@ -58,6 +57,7 @@ npm install --save @middy/rds-signer
 - `setToContext` (boolean) (default `false`): Store role tokens to `request.context`.
 
 NOTES:
+
 - Lambda is required to have IAM permission for `rds-db:connect` with a resource like `arn:aws:rds-db:#{AWS::Region}:#{AWS::AccountId}:dbuser:${database_resource}/${iam_role}`
 
 ## Sample usage
@@ -71,13 +71,13 @@ const handler = middy((event, context) => {
     statusCode: 200,
     headers: {},
     body: JSON.stringify({ message: 'hello world' })
-  };
+  }
 
   return response
 })
 
-handler
-  .use(rdsSigner({
+handler.use(
+  rdsSigner({
     fetchData: {
       rdsToken: {
         region: 'ca-central-1',
@@ -87,20 +87,18 @@ handler
         port: 5432
       }
     }
-  }))
+  })
+)
 ```
 
-
 ## 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,14 +7,9 @@ Object.defineProperty(module, "exports", {
     get: ()=>_default
 });
 const _util = require("@middy/util");
-const _rdsJs = _interopRequireDefault(require("aws-sdk/clients/rds.js"));
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
+const _rdsSigner = require("@aws-sdk/rds-signer");
 const defaults = {
-    AwsClient: _rdsJs.default.Signer,
+    AwsClient: _rdsSigner.Signer,
     awsClientOptions: {},
     fetchData: {},
     disablePrefetch: false,
@@ -35,16 +30,11 @@ const rdsSignerMiddleware = (opts = {})=>{
                 ...options.awsClientOptions,
                 ...options.fetchData[internalKey]
             });
-            values[internalKey] = new Promise((resolve, reject)=>{
-                client.getAuthToken({}, (e, token)=>{
-                    if (e) {
-                        reject(e);
-                    }
-                    if (!token.includes('X-Amz-Security-Token=')) {
-                        reject(new Error('[rds-signer] X-Amz-Security-Token Missing'));
-                    }
-                    resolve(token);
-                });
+            values[internalKey] = client.getAuthToken().then((token)=>{
+                if (!token.includes('X-Amz-Security-Token=')) {
+                    throw new Error('[rds-signer] X-Amz-Security-Token Missing');
+                }
+                return token;
             }).catch((e)=>{
                 const value = (0, _util.getCache)(options.cacheKey).value ?? {};
                 value[internalKey] = undefined;

package/index.d.ts

@@ -1,8 +1,9 @@
-import RDS from 'aws-sdk/clients/rds'
 import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
+import { SignerConfig, Signer } from '@aws-sdk/rds-signer'
 
-interface Options<Signer = RDS.Signer> extends MiddyOptions<Signer, RDS.Types.ClientConfiguration> {}
+interface Options<AwsSigner = Signer>
+  extends MiddyOptions<AwsSigner, SignerConfig> {}
 
 declare function rdsSigner (options?: Options): middy.MiddlewareObj
 

package/index.js

@@ -1,7 +1,7 @@
 import { canPrefetch, getInternal, processCache, getCache, modifyCache } from '@middy/util';
-import RDS from 'aws-sdk/clients/rds.js';
+import { Signer } from '@aws-sdk/rds-signer';
 const defaults = {
-    AwsClient: RDS.Signer,
+    AwsClient: Signer,
     awsClientOptions: {},
     fetchData: {},
     disablePrefetch: false,
@@ -22,16 +22,11 @@ const rdsSignerMiddleware = (opts = {})=>{
                 ...options.awsClientOptions,
                 ...options.fetchData[internalKey]
             });
-            values[internalKey] = new Promise((resolve, reject)=>{
-                client.getAuthToken({}, (e, token)=>{
-                    if (e) {
-                        reject(e);
-                    }
-                    if (!token.includes('X-Amz-Security-Token=')) {
-                        reject(new Error('[rds-signer] X-Amz-Security-Token Missing'));
-                    }
-                    resolve(token);
-                });
+            values[internalKey] = client.getAuthToken().then((token)=>{
+                if (!token.includes('X-Amz-Security-Token=')) {
+                    throw new Error('[rds-signer] X-Amz-Security-Token Missing');
+                }
+                return token;
             }).catch((e)=>{
                 const value = getCache(options.cacheKey).value ?? {};
                 value[internalKey] = undefined;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@middy/rds-signer",
-  "version": "3.6.1",
+  "version": "4.0.0-alpha.0",
   "description": "RDS (Relational Database Service) credentials middleware for the middy framework",
   "type": "module",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "engineStrict": true,
   "publishConfig": {
@@ -62,13 +62,13 @@
   },
   "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/rds-signer": "^3.186.0",
+    "@middy/core": "4.0.0-alpha.0",
     "@types/node": "^18.0.0",
-    "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "31a7f9f8e93a73a8be382b3022b9cfcbc13b2961"
+  "gitHead": "306fb9aa633d5757d11ced3dc192f046ef3c2685"
 }