@middy/s3-object-response 3.0.0-alpha.6 → 3.0.0

package/README.md

@@ -1,26 +1,36 @@
-# Middy s3-object-response middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy s3-object-response middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>S3 object response middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fs3-object-response">
+  <a href="https://www.npmjs.com/package/@middy/s3-object-response?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fs3-object-response.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/s3-object-response">
+    <img src="https://packagephobia.com/badge?p=@middy/s3-object-response" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
+    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  </a>
+  <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
+    <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">
   </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
@@ -39,10 +49,10 @@ 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) (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.
+- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.STS 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:
@@ -55,6 +65,7 @@ NOTES:
 import zlib from 'zlib'
 import middy from '@middy/core'
 import s3ObjectResponse from '@middy/s3-object-response'
+import {captureAWSClient, captureHTTPsGlobal} from 'aws-xray-sdk-core'
 
 const handler = middy((event, context) => {
   const readStream = context.s3Object
@@ -66,6 +77,8 @@ const handler = middy((event, context) => {
 
 handler
   .use(s3ObjectResponse({
+    awsClientCapture: captureAWSClient,
+    httpsCapture:captureHTTPsGlobal,
     bodyType: 'stream'
   }))
 ```
@@ -75,6 +88,7 @@ handler
 import zlib from 'zlib'
 import middy from '@middy/core'
 import s3ObjectResponse from '@middy/s3-object-response'
+import {captureAWSClient, captureHTTPsGlobal} from 'aws-xray-sdk-core'
 
 const handler = middy(async (event, context) => {
   let body = await context.s3Object
@@ -86,6 +100,8 @@ const handler = middy(async (event, context) => {
 
 handler
   .use(s3ObjectResponse({
+    awsClientCapture: captureAWSClient,
+    httpsCapture:captureHTTPsGlobal,
     bodyType: 'promise'
   }))
 ```

package/index.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _https=_interopRequireDefault(require("https"));var _url=require("url");var _util=require("@middy/util");var _s3Js=_interopRequireDefault(require("aws-sdk/clients/s3.js"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}var _response;const defaults={AwsClient:_s3Js.default,awsClientOptions:{},awsClientAssumeRole:undefined,awsClientCapture:undefined,httpsCapture:undefined,disablePrefetch:false,bodyType:undefined,__https:_https.default};let https=_https.default;const s3ObjectResponseMiddleware=(opts={})=>{const options={...defaults,...opts};if(!["stream","promise"].includes(options.bodyType)){throw new Error("[s3-object-response] bodyType is invalid")}if(options.httpsCapture){https=options.httpsCapture(options.__https)}let client;if((0,_util).canPrefetch(options)){client=(0,_util).createPrefetchClient(options)}const s3ObjectResponseMiddlewareBefore=async request=>{const{inputS3Url,outputRoute,outputToken}=request.event.getObjectContext;request.internal.s3ObjectResponse={RequestRoute:outputRoute,RequestToken:outputToken};const parsedInputS3Url=new _url.URL(inputS3Url);const fetchOptions={method:"GET",host:parsedInputS3Url.hostname,path:parsedInputS3Url.pathname};request.context.s3Object=fetchType(options.bodyType,fetchOptions)};const s3ObjectResponseMiddlewareAfter=async request=>{if(!client){client=await (0,_util).createClient(options,request)}(_response=request.response).Body??(_response.Body=request.response.body);delete request.response.body;await client.writeGetObjectResponse({...request.response,...request.internal.s3ObjectResponse}).promise();return{statusCode:200}};return{before:s3ObjectResponseMiddlewareBefore,after:s3ObjectResponseMiddlewareAfter}};const fetchType=(type,fetchOptions)=>{if(type==="stream"){return fetchStream(fetchOptions)}else if(type==="promise"){return fetchPromise(fetchOptions)}};const fetchStream=fetchOptions=>{return https.request(fetchOptions)};const fetchPromise=fetchOptions=>{return new Promise((resolve,reject)=>{let data="";const stream=fetchStream(fetchOptions);stream.on("data",chunk=>{data+=chunk});stream.on("end",()=>resolve(data));stream.on("error",error=>reject(error))})};var _default=s3ObjectResponseMiddleware;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.js

@@ -1,102 +1,3 @@
-import __https from 'https';
-import { URL } from 'url';
-import { canPrefetch, createPrefetchClient, createClient } from '@middy/util';
-import S3 from 'aws-sdk/clients/s3.js';
-const defaults = {
-  AwsClient: S3,
-  awsClientOptions: {},
-  awsClientAssumeRole: undefined,
-  awsClientCapture: undefined,
-  httpsCapture: undefined,
-  disablePrefetch: false,
-  bodyType: undefined,
-  __https
-};
-let https = __https;
+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";const defaults={AwsClient:S3,awsClientOptions:{},awsClientAssumeRole:undefined,awsClientCapture:undefined,httpsCapture:undefined,disablePrefetch:false,bodyType:undefined,__https};let https=__https;const s3ObjectResponseMiddleware=(opts={})=>{const options={...defaults,...opts};if(!["stream","promise"].includes(options.bodyType)){throw new Error("[s3-object-response] bodyType is invalid")}if(options.httpsCapture){https=options.httpsCapture(options.__https)}let client;if(canPrefetch(options)){client=createPrefetchClient(options)}const s3ObjectResponseMiddlewareBefore=async request=>{const{inputS3Url,outputRoute,outputToken}=request.event.getObjectContext;request.internal.s3ObjectResponse={RequestRoute:outputRoute,RequestToken:outputToken};const parsedInputS3Url=new URL(inputS3Url);const fetchOptions={method:"GET",host:parsedInputS3Url.hostname,path:parsedInputS3Url.pathname};request.context.s3Object=fetchType(options.bodyType,fetchOptions)};const s3ObjectResponseMiddlewareAfter=async request=>{if(!client){client=await createClient(options,request)}(_response=request.response).Body??(_response.Body=request.response.body);delete request.response.body;await client.writeGetObjectResponse({...request.response,...request.internal.s3ObjectResponse}).promise();return{statusCode:200}};return{before:s3ObjectResponseMiddlewareBefore,after:s3ObjectResponseMiddlewareAfter}};const fetchType=(type,fetchOptions)=>{if(type==="stream"){return fetchStream(fetchOptions)}else if(type==="promise"){return fetchPromise(fetchOptions)}};const fetchStream=fetchOptions=>{return https.request(fetchOptions)};const fetchPromise=fetchOptions=>{return new Promise((resolve,reject)=>{let data="";const stream=fetchStream(fetchOptions);stream.on("data",chunk=>{data+=chunk});stream.on("end",()=>resolve(data));stream.on("error",error=>reject(error))})};export default s3ObjectResponseMiddleware
 
-const s3ObjectResponseMiddleware = (opts = {}) => {
-  const options = { ...defaults,
-    ...opts
-  };
-
-  if (!['stream', 'promise'].includes(options.bodyType)) {
-    throw new Error('[s3-object-response] bodyType is invalid');
-  }
-
-  if (options.httpsCapture) {
-    https = options.httpsCapture(options.__https);
-  }
-
-  let client;
-
-  if (canPrefetch(options)) {
-    client = createPrefetchClient(options);
-  }
-
-  const s3ObjectResponseMiddlewareBefore = async request => {
-    const {
-      inputS3Url,
-      outputRoute,
-      outputToken
-    } = request.event.getObjectContext;
-    request.internal.s3ObjectResponse = {
-      RequestRoute: outputRoute,
-      RequestToken: outputToken
-    };
-    const parsedInputS3Url = new URL(inputS3Url);
-    const fetchOptions = {
-      method: 'GET',
-      host: parsedInputS3Url.hostname,
-      path: parsedInputS3Url.pathname
-    };
-    request.context.s3Object = fetchType(options.bodyType, fetchOptions);
-  };
-
-  const s3ObjectResponseMiddlewareAfter = async request => {
-    var _request$response;
-
-    if (!client) {
-      client = await createClient(options, request);
-    }
-
-    (_request$response = request.response).Body ?? (_request$response.Body = request.response.body);
-    delete request.response.body;
-    await client.writeGetObjectResponse({ ...request.response,
-      ...request.internal.s3ObjectResponse
-    }).promise();
-    return {
-      statusCode: 200
-    };
-  };
-
-  return {
-    before: s3ObjectResponseMiddlewareBefore,
-    after: s3ObjectResponseMiddlewareAfter
-  };
-};
-
-const fetchType = (type, fetchOptions) => {
-  if (type === 'stream') {
-    return fetchStream(fetchOptions);
-  } else if (type === 'promise') {
-    return fetchPromise(fetchOptions);
-  }
-};
-
-const fetchStream = fetchOptions => {
-  return https.request(fetchOptions);
-};
-
-const fetchPromise = fetchOptions => {
-  return new Promise((resolve, reject) => {
-    let data = '';
-    const stream = fetchStream(fetchOptions);
-    stream.on('data', chunk => {
-      data += chunk;
-    });
-    stream.on('end', () => resolve(data));
-    stream.on('error', error => reject(error));
-  });
-};
-
-export default s3ObjectResponseMiddleware;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/s3-object-response",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0",
   "description": "S3 object response handling middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,10 +10,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "exports": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
   "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -46,14 +53,14 @@
   "bugs": {
     "url": "https://github.com/middyjs/middy/issues"
   },
-  "homepage": "https://github.com/middyjs/middy#readme",
+  "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.6"
+    "@middy/util": "^3.0.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.6",
+    "@middy/core": "^3.0.0",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
+  "gitHead": "01520fa8628a36c2f89e126cad656a16547ea0d6"
 }