@middy/s3-object-response 3.6.1 → 4.0.0-alpha.0

package/README.md

@@ -46,27 +46,30 @@ To install this middleware you can use NPM:
 npm install --save @middy/s3-object-response
 ```
 
-
 ## Options
+
 - `bodyType` (string) (required): How to pass in the s3 object through the handler. Can be `stream` or `promise`.
-- `AwsClient` (object) (default `AWS.S3`): AWS.S3 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.STS class constructor.
+- `AwsClient` (object) (default `S3Client`): S3Client class constructor (i.e. that has been instrumented with AWS XRay). Must be from `@aws-sdk/client-s3`.
+- `awsClientOptions` (object) (default `undefined`): Options to pass to S3Client class constructor.
 - `awsClientAssumeRole` (string) (default `undfined`): 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.
 - `httpsCapture` (function) (default `undefined`): Enable XRay by passing `captureHTTPsGlobal` from `aws-xray-sdk` in.
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 
 NOTES:
+
 - The response from the handler must match the allowed parameters for [`S3.writeGetObjectResponse`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#writeGetObjectResponse-property), excluding `RequestRoute` and `RequestToken`.
 - Lambda is required to have IAM permission for `s3-object-lambda:WriteGetObjectResponse`
 
 ## Sample usage
+
 ### Stream
+
 ```javascript
 import zlib from 'zlib'
 import middy from '@middy/core'
 import s3ObjectResponse from '@middy/s3-object-response'
-import {captureAWSClient, captureHTTPsGlobal} from 'aws-xray-sdk-core'
+import { captureAWSClient, captureHTTPsGlobal } from 'aws-xray-sdk-core'
 
 const handler = middy((event, context) => {
   const readStream = context.s3Object
@@ -76,20 +79,22 @@ const handler = middy((event, context) => {
   }
 })
 
-handler
-  .use(s3ObjectResponse({
+handler.use(
+  s3ObjectResponse({
     awsClientCapture: captureAWSClient,
-    httpsCapture:captureHTTPsGlobal,
+    httpsCapture: captureHTTPsGlobal,
     bodyType: 'stream'
-  }))
+  })
+)
 ```
 
 ### Promise
+
 ```javascript
 import zlib from 'zlib'
 import middy from '@middy/core'
 import s3ObjectResponse from '@middy/s3-object-response'
-import {captureAWSClient, captureHTTPsGlobal} from 'aws-xray-sdk-core'
+import { captureAWSClient, captureHTTPsGlobal } from 'aws-xray-sdk-core'
 
 const handler = middy(async (event, context) => {
   let body = await context.s3Object
@@ -99,25 +104,23 @@ const handler = middy(async (event, context) => {
   }
 })
 
-handler
-  .use(s3ObjectResponse({
+handler.use(
+  s3ObjectResponse({
     awsClientCapture: captureAWSClient,
-    httpsCapture:captureHTTPsGlobal,
+    httpsCapture: captureHTTPsGlobal,
     bodyType: 'promise'
-  }))
+  })
+)
 ```
 
-
 ## 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

@@ -9,15 +9,14 @@ Object.defineProperty(module, "exports", {
 const _https = _interopRequireDefault(require("https"));
 const _url = require("url");
 const _util = require("@middy/util");
-const _s3Js = _interopRequireDefault(require("aws-sdk/clients/s3.js"));
+const _clientS3 = require("@aws-sdk/client-s3");
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
-var _response;
 const defaults = {
-    AwsClient: _s3Js.default,
+    AwsClient: _clientS3.S3Client,
     awsClientOptions: {},
     awsClientAssumeRole: undefined,
     awsClientCapture: undefined,
@@ -63,12 +62,12 @@ const s3ObjectResponseMiddleware = (opts = {})=>{
         if (!client) {
             client = await (0, _util.createClient)(options, request);
         }
-        (_response = request.response).Body ?? (_response.Body = request.response.body);
+        request.response.Body ??= request.response.body;
         delete request.response.body;
-        await client.writeGetObjectResponse({
+        await client.send(new _clientS3.WriteGetObjectResponseCommand({
             ...request.response,
             ...request.internal.s3ObjectResponse
-        }).promise();
+        }));
         return {
             statusCode: 200
         };

package/index.d.ts

@@ -1,12 +1,12 @@
 import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
-import S3 from 'aws-sdk/clients/s3'
+import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3'
 import { ClientRequest } from 'http'
 
-interface Options<S = S3>
+interface Options<AwsS3Client = S3Client>
   extends Pick<
-  MiddyOptions<S, S3.Types.ClientConfiguration>,
+  MiddyOptions<AwsS3Client, S3ClientConfig>,
   | 'AwsClient'
   | 'awsClientOptions'
   | 'awsClientAssumeRole'

package/index.js

@@ -1,10 +1,9 @@
-var _response;
 import __https from 'https';
 import { URL } from 'url';
 import { canPrefetch, createPrefetchClient, createClient } from '@middy/util';
-import S3 from 'aws-sdk/clients/s3.js';
+import { S3Client, WriteGetObjectResponseCommand } from '@aws-sdk/client-s3';
 const defaults = {
-    AwsClient: S3,
+    AwsClient: S3Client,
     awsClientOptions: {},
     awsClientAssumeRole: undefined,
     awsClientCapture: undefined,
@@ -50,12 +49,12 @@ const s3ObjectResponseMiddleware = (opts = {})=>{
         if (!client) {
             client = await createClient(options, request);
         }
-        (_response = request.response).Body ?? (_response.Body = request.response.body);
+        request.response.Body ??= request.response.body;
         delete request.response.body;
-        await client.writeGetObjectResponse({
+        await client.send(new WriteGetObjectResponseCommand({
             ...request.response,
             ...request.internal.s3ObjectResponse
-        }).promise();
+        }));
         return {
             statusCode: 200
         };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@middy/s3-object-response",
-  "version": "3.6.1",
+  "version": "4.0.0-alpha.0",
   "description": "S3 object response handling 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/client-s3": "^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"
   },
-  "gitHead": "31a7f9f8e93a73a8be382b3022b9cfcbc13b2961"
+  "gitHead": "306fb9aa633d5757d11ced3dc192f046ef3c2685"
 }