@middy/s3-object-response 2.5.6 → 3.0.0-alpha.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -25,8 +25,6 @@
 </p>
 </div>
 
-** This middleware is a Proof of Concept and requires real world testing before use, not recommended for production **
-
 Fetches S3 object as a stream and writes back to s3 object response.
 
 ## Install
@@ -40,8 +38,9 @@ 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.STS class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
+- `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) (optional): Options to pass to AWS.STS 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.
 - `httpsCapture` (function) (optional): 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.
@@ -104,7 +103,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.js

@@ -1,25 +1,29 @@
-let https = require('https')
-const { URL } = require('url')
+import __https from 'https'
+import { URL } from 'url'
 
-const {
+import {
   canPrefetch,
   createPrefetchClient,
   createClient
-} = require('@middy/util')
+} from '@middy/util'
 
-const S3 = require('aws-sdk/clients/s3') // v2
-// const { S3 } = require('@aws-sdk/client-s3') // v3
+import S3 from 'aws-sdk/clients/s3.js' // v2
+// import { S3 } from '@aws-sdk/client-s3' // v3
 
 const defaults = {
-  AwsClient: S3, // Allow for XRay
+  AwsClient: S3,
   awsClientOptions: {},
   awsClientAssumeRole: undefined,
   awsClientCapture: undefined,
   httpsCapture: undefined,
   disablePrefetch: false,
-  bodyType: undefined
+  bodyType: undefined,
+
+  // For mocking out only, rewire doesn't support ES Modules :(
+  __https
 }
 
+let https = __https
 const s3ObjectResponseMiddleware = (opts = {}) => {
   const options = { ...defaults, ...opts }
 
@@ -28,7 +32,7 @@ const s3ObjectResponseMiddleware = (opts = {}) => {
   }
 
   if (options.httpsCapture) {
-    https = options.httpsCapture(https)
+    https = options.httpsCapture(options.__https)
   }
 
   let client
@@ -63,16 +67,17 @@ const s3ObjectResponseMiddleware = (opts = {}) => {
       client = await createClient(options, request)
     }
 
-    request.response.Body = request.response.Body ?? request.response.body
+    request.response.Body ??= request.response.body
     delete request.response.body
 
-    return client
+    await client
       .writeGetObjectResponse({
         ...request.response,
         ...request.internal.s3ObjectResponse
       })
       .promise()
-      .then(() => ({ statusCode: 200 })) // TODO test if needed
+
+    return { statusCode: 200 }
   }
 
   return {
@@ -106,4 +111,4 @@ const fetchPromise = (fetchOptions) => {
   })
 }
 
-module.exports = s3ObjectResponseMiddleware
+export default s3ObjectResponseMiddleware

package/package.json

@@ -1,23 +1,25 @@
 {
   "name": "@middy/s3-object-response",
-  "version": "2.5.6",
+  "version": "3.0.0-alpha.3",
   "description": "S3 object response handling middleware for the middy framework",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts"
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -46,12 +48,12 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^2.5.6"
+    "@middy/util": "^3.0.0-alpha.3"
   },
   "devDependencies": {
-    "@middy/core": "^2.5.6",
+    "@middy/core": "^3.0.0-alpha.3",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "0c789f55b4adf691f977b0d9904d1a805bb3bb2b"
+  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
 }