@middy/http-multipart-body-parser 3.0.0-alpha.6 → 3.0.0

package/README.md

@@ -1,26 +1,36 @@
-# Middy http-multipart-body-parser 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 http-multipart-body-parser middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>HTTP json body parser 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%2Fhttp-json-body-parser">
-    <img src="https://badge.fury.io/js/%40middy%2Fhttp-json-body-parser.svg" alt="npm version" style="max-width:100%;">
+  <a href="https://www.npmjs.com/package/@middy/http-multipart-body-parser?activeTab=versions">
+    <img src="https://badge.fury.io/js/%40middy%2Fhttp-multipart-body-parser.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://packagephobia.com/result?p=@middy/http-multipart-body-parser">
+    <img src="https://packagephobia.com/badge?p=@middy/http-multipart-body-parser" 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>
@@ -47,7 +57,7 @@ npm install --save @middy/http-multipart-body-parser
 
 ## Options
 
-- `busboy` (object) (optional): defaults to `{}` and it can be used to pass extraparameters to the internal `busboy` instance at creation time. Checkout [the official documentation](https://www.npmjs.com/package/busboy#busboy-methods) for more information on the supported options.
+- `busboy` (object) (default `{}`): it can be used to pass extraparameters to the internal `busboy` instance at creation time. Checkout [the official documentation](https://www.npmjs.com/package/busboy#busboy-methods) for more information on the supported options.
 
 **Note**: this middleware will buffer all the data as it is processed internally by `busboy`, so, if you are using this approach to parse significantly big volumes of data, keep in mind that all the data will be allocated in memory. This is somewhat inevitable with Lambdas (as the data is already encoded into the JSON in memory as Base64), but it's good to keep this in mind and evaluate the impact on you application.  
 If you really have to deal with big files, then you might also want to consider to allowing your users to [directly upload files to S3](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-UsingHTTPPOST.html)

package/index.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _busboy=_interopRequireDefault(require("busboy"));var _util=require("@middy/util");function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}const mimePattern=/^multipart\/form-data(;.*)?$/;const fieldnamePattern=/(.+)\[(.*)]$/;const defaults={busboy:{}};const httpMultipartBodyParserMiddleware=(opts={})=>{const options={...defaults,...opts};const httpMultipartBodyParserMiddlewareBefore=async request=>{const{headers}=request.event;const contentType=headers["Content-Type"]??headers["content-type"];if(!mimePattern.test(contentType))return;return parseMultipartData(request.event,options.busboy).then(multipartData=>{request.event.body=multipartData}).catch(cause=>{const error=(0,_util).createError(422,"Invalid or malformed multipart/form-data was provided");error.cause=cause;throw error})};return{before:httpMultipartBodyParserMiddlewareBefore}};const parseMultipartData=(event,options)=>{const multipartData={};const busboy=(0,_busboy).default({...options,headers:{"content-type":event.headers["Content-Type"]??event.headers["content-type"]}});return new Promise((resolve,reject)=>{busboy.on("file",(fieldname,file,filename,encoding,mimetype)=>{const attachment={filename,mimetype,encoding};const chunks=[];file.on("data",data=>{chunks.push(data)});file.on("end",()=>{attachment.truncated=file.truncated;attachment.content=Buffer.concat(chunks);if(!multipartData[fieldname]){multipartData[fieldname]=attachment}else{const current=multipartData[fieldname];multipartData[fieldname]=[attachment].concat(current)}})}).on("field",(fieldname,value)=>{const matches=fieldname.match(fieldnamePattern);if(!matches){multipartData[fieldname]=value}else{if(!multipartData[matches[1]]){multipartData[matches[1]]=[]}multipartData[matches[1]].push(value)}}).on("close",()=>resolve(multipartData)).on("error",e=>reject(e));busboy.write(event.body,event.isBase64Encoded?"base64":"utf8");busboy.end()})};var _default=httpMultipartBodyParserMiddleware;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.js

@@ -1,81 +1,3 @@
-import BusBoy from 'busboy';
-import { createError } from '@middy/util';
-const mimePattern = /^multipart\/form-data(;.*)?$/;
-const fieldnamePattern = /(.+)\[(.*)]$/;
-const defaults = {
-  busboy: {}
-};
+import BusBoy from"busboy";import{createError}from"@middy/util";const mimePattern=/^multipart\/form-data(;.*)?$/;const fieldnamePattern=/(.+)\[(.*)]$/;const defaults={busboy:{}};const httpMultipartBodyParserMiddleware=(opts={})=>{const options={...defaults,...opts};const httpMultipartBodyParserMiddlewareBefore=async request=>{const{headers}=request.event;const contentType=headers["Content-Type"]??headers["content-type"];if(!mimePattern.test(contentType))return;return parseMultipartData(request.event,options.busboy).then(multipartData=>{request.event.body=multipartData}).catch(cause=>{const error=createError(422,"Invalid or malformed multipart/form-data was provided");error.cause=cause;throw error})};return{before:httpMultipartBodyParserMiddlewareBefore}};const parseMultipartData=(event,options)=>{const multipartData={};const busboy=BusBoy({...options,headers:{"content-type":event.headers["Content-Type"]??event.headers["content-type"]}});return new Promise((resolve,reject)=>{busboy.on("file",(fieldname,file,filename,encoding,mimetype)=>{const attachment={filename,mimetype,encoding};const chunks=[];file.on("data",data=>{chunks.push(data)});file.on("end",()=>{attachment.truncated=file.truncated;attachment.content=Buffer.concat(chunks);if(!multipartData[fieldname]){multipartData[fieldname]=attachment}else{const current=multipartData[fieldname];multipartData[fieldname]=[attachment].concat(current)}})}).on("field",(fieldname,value)=>{const matches=fieldname.match(fieldnamePattern);if(!matches){multipartData[fieldname]=value}else{if(!multipartData[matches[1]]){multipartData[matches[1]]=[]}multipartData[matches[1]].push(value)}}).on("close",()=>resolve(multipartData)).on("error",e=>reject(e));busboy.write(event.body,event.isBase64Encoded?"base64":"utf8");busboy.end()})};export default httpMultipartBodyParserMiddleware
 
-const httpMultipartBodyParserMiddleware = (opts = {}) => {
-  const options = { ...defaults,
-    ...opts
-  };
-
-  const httpMultipartBodyParserMiddlewareBefore = async request => {
-    const {
-      headers
-    } = request.event;
-    const contentType = headers['Content-Type'] ?? headers['content-type'];
-    if (!mimePattern.test(contentType)) return;
-    return parseMultipartData(request.event, options.busboy).then(multipartData => {
-      request.event.body = multipartData;
-    }).catch(cause => {
-      const error = createError(422, 'Invalid or malformed multipart/form-data was provided');
-      error.cause = cause;
-      throw error;
-    });
-  };
-
-  return {
-    before: httpMultipartBodyParserMiddlewareBefore
-  };
-};
-
-const parseMultipartData = (event, options) => {
-  const multipartData = {};
-  const busboy = BusBoy({ ...options,
-    headers: {
-      'content-type': event.headers['Content-Type'] ?? event.headers['content-type']
-    }
-  });
-  return new Promise((resolve, reject) => {
-    busboy.on('file', (fieldname, file, filename, encoding, mimetype) => {
-      const attachment = {
-        filename,
-        mimetype,
-        encoding
-      };
-      const chunks = [];
-      file.on('data', data => {
-        chunks.push(data);
-      });
-      file.on('end', () => {
-        attachment.truncated = file.truncated;
-        attachment.content = Buffer.concat(chunks);
-
-        if (!multipartData[fieldname]) {
-          multipartData[fieldname] = attachment;
-        } else {
-          const current = multipartData[fieldname];
-          multipartData[fieldname] = [attachment].concat(current);
-        }
-      });
-    }).on('field', (fieldname, value) => {
-      const matches = fieldname.match(fieldnamePattern);
-
-      if (!matches) {
-        multipartData[fieldname] = value;
-      } else {
-        if (!multipartData[matches[1]]) {
-          multipartData[matches[1]] = [];
-        }
-
-        multipartData[matches[1]].push(value);
-      }
-    }).on('close', () => resolve(multipartData)).on('error', e => reject(e));
-    busboy.write(event.body, event.isBase64Encoded ? 'base64' : 'utf8');
-    busboy.end();
-  });
-};
-
-export default httpMultipartBodyParserMiddleware;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-multipart-body-parser",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0",
   "description": "Http event normalizer 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,13 +53,13 @@
   "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",
     "busboy": "1.4.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.6"
+    "@middy/core": "^3.0.0"
   },
-  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
+  "gitHead": "01520fa8628a36c2f89e126cad656a16547ea0d6"
 }