@middy/http-multipart-body-parser 4.0.0-alpha.4 → 4.0.1

package/README.md

@@ -36,69 +36,6 @@
 <p>You can read the documentation at: <a href="https://middy.js.org/docs/middlewares/http-multipart-body-parser">https://middy.js.org/docs/middlewares/http-multipart-body-parser</a></p>
 </div>
 
-
-Automatically parses HTTP requests with content type `multipart/form-data` and converts the body into an
-object. Also handles gracefully broken JSON as UnprocessableEntity (422 errors)
-if used in combination with `httpErrorHandler`.
-
-It can also be used in combination with validator so that the content can be validated.
-
-**Note**: by default this is going to parse only events that contain the header `Content-Type` (or `content-type`) set to `multipart/form-data`. If you want to support different casing for the header name (e.g. `Content-type`) then you should use the [`httpHeaderNormalizer`](#httpheadernormalizer) middleware before this middleware.
-
-
-
-## Install
-
-To install this middleware you can use NPM:
-
-```bash
-npm install --save @middy/http-multipart-body-parser
-```
-
-
-## 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)
-
-## Sample usage
-
-```javascript
-import middy from '@middy/core'
-import httpHeaderNormalizer from '@middy/http-header-normalizer'
-import httpMultipartBodyParser from '@middy/http-multipart-body-parser'
-const handler = middy((event, context) => {
-  return {}
-})
-handler
-  .use(httpHeaderNormalizer())
-  .use(httpMultipartBodyParser())
-
-// invokes the handler
-const event = {
-  headers: {
-    'Content-Type': 'multipart/form-data; boundary=----WebKitFormBoundaryppsQEwf2BVJeCe0M'
-  },
-  body: 'LS0tLS0tV2ViS2l0Rm9ybUJvdW5kYXJ5cHBzUUV3ZjJCVkplQ2UwTQ0KQ29udGVudC1EaXNwb3NpdGlvbjogZm9ybS1kYXRhOyBuYW1lPSJmb28iDQoNCmJhcg0KLS0tLS0tV2ViS2l0Rm9ybUJvdW5kYXJ5cHBzUUV3ZjJCVkplQ2UwTS0t',
-  isBase64Encoded: true
-}
-handler(event, {}, (_, body) => {
-  t.is(body,{ foo: 'bar' })
-})
-```
-
-## 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).
@@ -106,4 +43,3 @@ Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 [Luciano Mammino]
 <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%;">
 </a>
-

package/index.cjs

@@ -16,7 +16,8 @@ function _interopRequireDefault(obj) {
 const mimePattern = /^multipart\/form-data(;.*)?$/;
 const fieldnamePattern = /(.+)\[(.*)]$/;
 const defaults = {
-    busboy: {}
+    busboy: {},
+    charset: 'utf8'
 };
 const httpMultipartBodyParserMiddleware = (opts = {})=>{
     const options = {
@@ -27,7 +28,7 @@ const httpMultipartBodyParserMiddleware = (opts = {})=>{
         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)=>{
+        return parseMultipartData(request.event, options).then((multipartData)=>{
             request.event.body = multipartData;
         }).catch((cause)=>{
             throw (0, _util.createError)(422, 'Invalid or malformed multipart/form-data was provided', {
@@ -41,8 +42,9 @@ const httpMultipartBodyParserMiddleware = (opts = {})=>{
 };
 const parseMultipartData = (event, options)=>{
     const multipartData = {};
+    const charset = event.isBase64Encoded ? 'base64' : options.charset;
     const busboy = (0, _busboy.default)({
-        ...options,
+        ...options.busboy,
         headers: {
             'content-type': event.headers['Content-Type'] ?? event.headers['content-type']
         }
@@ -82,7 +84,7 @@ const parseMultipartData = (event, options)=>{
                 multipartData[matches[1]].push(value);
             }
         }).on('close', ()=>resolve(multipartData)).on('error', (e)=>reject(e));
-        busboy.write(event.body, event.isBase64Encoded ? 'base64' : 'utf8');
+        busboy.write(event.body, charset);
         busboy.end();
     });
 };

package/index.d.ts

@@ -19,6 +19,7 @@ interface Options {
       headerPairs?: number
     }
   }
+  charset?: string
 }
 
 export type Event = Omit<APIGatewayEvent, 'body'> & {

package/index.js

@@ -3,7 +3,8 @@ import { createError } from '@middy/util';
 const mimePattern = /^multipart\/form-data(;.*)?$/;
 const fieldnamePattern = /(.+)\[(.*)]$/;
 const defaults = {
-    busboy: {}
+    busboy: {},
+    charset: 'utf8'
 };
 const httpMultipartBodyParserMiddleware = (opts = {})=>{
     const options = {
@@ -14,7 +15,7 @@ const httpMultipartBodyParserMiddleware = (opts = {})=>{
         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)=>{
+        return parseMultipartData(request.event, options).then((multipartData)=>{
             request.event.body = multipartData;
         }).catch((cause)=>{
             throw createError(422, 'Invalid or malformed multipart/form-data was provided', {
@@ -28,8 +29,9 @@ const httpMultipartBodyParserMiddleware = (opts = {})=>{
 };
 const parseMultipartData = (event, options)=>{
     const multipartData = {};
+    const charset = event.isBase64Encoded ? 'base64' : options.charset;
     const busboy = BusBoy({
-        ...options,
+        ...options.busboy,
         headers: {
             'content-type': event.headers['Content-Type'] ?? event.headers['content-type']
         }
@@ -69,7 +71,7 @@ const parseMultipartData = (event, options)=>{
                 multipartData[matches[1]].push(value);
             }
         }).on('close', ()=>resolve(multipartData)).on('error', (e)=>reject(e));
-        busboy.write(event.body, event.isBase64Encoded ? 'base64' : 'utf8');
+        busboy.write(event.body, charset);
         busboy.end();
     });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-multipart-body-parser",
-  "version": "4.0.0-alpha.4",
+  "version": "4.0.1",
   "description": "Http event normalizer middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -62,13 +62,13 @@
   },
   "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "4.0.0-alpha.4",
+    "@middy/util": "4.0.1",
     "busboy": "1.6.0"
   },
   "devDependencies": {
-    "@middy/core": "4.0.0-alpha.4",
+    "@middy/core": "4.0.1",
     "@types/aws-lambda": "^8.10.101",
     "type-fest": "^3.0.0"
   },
-  "gitHead": "cbf2af8e31dab58ed28d26143cd77cca544657ae"
+  "gitHead": "c5ece2bfbb0d607dcdea5685bf194a6cc19acc8d"
 }