@remix-run/form-data-middleware 0.1.4 → 0.2.0

package/README.md

@@ -1,11 +1,11 @@
 # form-data-middleware
 
-Form body parsing middleware for Remix. It parses incoming [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) and exposes `context.formData` and uploaded files on `context.files`.
+Form body parsing middleware for Remix. It parses incoming [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) and exposes it via `context.get(FormData)`.
 
 ## Features
 
 - **Request Form Parsing** - Parses request body form data once per request
-- **File Access** - Exposes uploaded files as `context.files`
+- **File Access** - Uploaded files are available from `context.get(FormData)`
 - **Custom Upload Handling** - Supports pluggable upload handlers for file processing
 - **Error Control** - Optional suppression for malformed form data
 
@@ -17,9 +17,9 @@ npm i remix
 
 ## Usage
 
-Use the `formData()` middleware at the router level to parse `FormData` from the request body and make it available on the request context as `context.formData`.
+Use the `formData()` middleware at the router level to parse `FormData` from the request body and make it available on request context via `context.get(FormData)`.
 
-`context.files` will also be available as a map of `File` objects keyed by the name of the form field.
+Uploaded files are available in the parsed `FormData` object. For a single file field, use `formData.get(name)`. For repeated file fields, use `formData.getAll(name)`.
 
 ```ts
 import { createRouter } from 'remix/fetch-router'
@@ -30,13 +30,14 @@ let router = createRouter({
 })
 
 router.post('/users', async (context) => {
-  let name = context.formData.get('name')
-  let email = context.formData.get('email')
+  let formData = context.get(FormData)
+  let name = formData.get('name')
+  let email = formData.get('email')
 
   // Handle file uploads
-  let avatar = context.files?.get('avatar')
+  let avatar = formData.get('avatar')
 
-  return Response.json({ name, email, hasAvatar: !!avatar })
+  return Response.json({ name, email, hasAvatar: avatar instanceof File })
 })
 ```
 
@@ -62,9 +63,27 @@ let router = createRouter({
 })
 ```
 
+### Limit Multipart Growth
+
+`formData()` forwards multipart limit options to `parseFormData()`, so you can cap uploads with
+`maxHeaderSize`, `maxFiles`, `maxFileSize`, `maxParts`, and `maxTotalSize`.
+
+```ts
+let router = createRouter({
+  middleware: [
+    formData({
+      maxFiles: 5,
+      maxFileSize: 10 * 1024 * 1024,
+      maxParts: 25,
+      maxTotalSize: 12 * 1024 * 1024,
+    }),
+  ],
+})
+```
+
 ### Suppress Parse Errors
 
-Some requests may contain invalid form data that cannot be parsed. You can suppress parse errors by setting `suppressErrors` to `true`. In these cases, `context.formData` will be an empty `FormData` object.
+Some requests may contain invalid form data that cannot be parsed. You can suppress those malformed-body parse errors by setting `suppressErrors` to `true`. In these cases, `context.get(FormData)` will be an empty `FormData` object. Multipart limit violations from `maxHeaderSize`, `maxFiles`, `maxFileSize`, `maxParts`, or `maxTotalSize` are never suppressed.
 
 ```ts
 let router = createRouter({

package/dist/lib/form-data.d.ts

@@ -1,11 +1,13 @@
 import { type FileUploadHandler, type ParseFormDataOptions } from '@remix-run/form-data-parser';
 import type { Middleware } from '@remix-run/fetch-router';
+type SetFormDataContextTransform = readonly [readonly [typeof FormData, FormData]];
 /**
- * Options for the `formData` middleware.
+ * Options for the {@link formData} middleware.
  */
 export interface FormDataOptions extends ParseFormDataOptions {
     /**
-     * Set `true` to suppress parse errors.
+     * Set `true` to suppress malformed form-data parse errors. Multipart limit violations always
+     * surface as errors even when suppression is enabled.
      *
      * @default false
      */
@@ -18,10 +20,11 @@ export interface FormDataOptions extends ParseFormDataOptions {
     uploadHandler?: FileUploadHandler;
 }
 /**
- * Middleware that parses `FormData` from the request body and populates `context.formData`.
+ * Middleware that parses `FormData` from the request body and populates request context.
  *
  * @param options Options for parsing form data
  * @returns A middleware function that parses form data
  */
-export declare function formData(options?: FormDataOptions): Middleware;
+export declare function formData(options?: FormDataOptions): Middleware<any, any, SetFormDataContextTransform>;
+export {};
 //# sourceMappingURL=form-data.d.ts.map

package/dist/lib/form-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form-data.d.ts","sourceRoot":"","sources":["../../src/lib/form-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC1B,MAAM,6BAA6B,CAAA;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEzD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAA;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,UAAU,CA6B9D"}
+{"version":3,"file":"form-data.d.ts","sourceRoot":"","sources":["../../src/lib/form-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC1B,MAAM,6BAA6B,CAAA;AACpC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAEzD,KAAK,2BAA2B,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAA;AAYlF;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,oBAAoB;IAC3D;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAA;CAClC;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,OAAO,CAAC,EAAE,eAAe,GACxB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,2BAA2B,CAAC,CAiCnD"}

package/dist/lib/form-data.js

@@ -1,6 +1,13 @@
-import { FormDataParseError, parseFormData, } from '@remix-run/form-data-parser';
+import { MaxFilesExceededError, MaxFileSizeExceededError, MaxHeaderSizeExceededError, MaxPartsExceededError, MaxTotalSizeExceededError, parseFormData, } from '@remix-run/form-data-parser';
+function isMultipartLimitError(error) {
+    return (error instanceof MaxFilesExceededError ||
+        error instanceof MaxHeaderSizeExceededError ||
+        error instanceof MaxFileSizeExceededError ||
+        error instanceof MaxPartsExceededError ||
+        error instanceof MaxTotalSizeExceededError);
+}
 /**
- * Middleware that parses `FormData` from the request body and populates `context.formData`.
+ * Middleware that parses `FormData` from the request body and populates request context.
  *
  * @param options Options for parsing form data
  * @returns A middleware function that parses form data
@@ -9,6 +16,9 @@ export function formData(options) {
     let suppressErrors = options?.suppressErrors ?? false;
     let uploadHandler = options?.uploadHandler;
     return async (context) => {
+        if (context.has(FormData)) {
+            return;
+        }
         if (context.method === 'GET' || context.method === 'HEAD') {
             return;
         }
@@ -16,17 +26,17 @@ export function formData(options) {
         if (contentType == null ||
             (!contentType.startsWith('multipart/') &&
                 !contentType.startsWith('application/x-www-form-urlencoded'))) {
-            context.formData = new FormData();
+            context.set(FormData, new FormData());
             return;
         }
         try {
-            context.formData = await parseFormData(context.request, options, uploadHandler);
+            context.set(FormData, await parseFormData(context.request, options, uploadHandler));
         }
         catch (error) {
-            if (!suppressErrors || !(error instanceof FormDataParseError)) {
+            if (!suppressErrors || isMultipartLimitError(error)) {
                 throw error;
             }
-            context.formData = new FormData();
+            context.set(FormData, new FormData());
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/form-data-middleware",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Middleware for parsing FormData from request bodies",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -28,12 +28,12 @@
   "devDependencies": {
     "@types/node": "^24.6.0",
     "@typescript/native-preview": "7.0.0-dev.20251125.1",
-    "@remix-run/fetch-router": "0.17.0",
-    "@remix-run/form-data-parser": "0.15.0"
+    "@remix-run/fetch-router": "0.18.0",
+    "@remix-run/form-data-parser": "0.16.0"
   },
   "dependencies": {
-    "@remix-run/form-data-parser": "^0.15.0",
-    "@remix-run/fetch-router": "^0.17.0"
+    "@remix-run/fetch-router": "^0.18.0",
+    "@remix-run/form-data-parser": "^0.16.0"
   },
   "keywords": [
     "fetch",
@@ -46,7 +46,7 @@
   "scripts": {
     "build": "tsgo -p tsconfig.build.json",
     "clean": "git clean -fdX",
-    "test": "node --disable-warning=ExperimentalWarning --test",
+    "test": "node --test",
     "typecheck": "tsgo --noEmit"
   }
 }

package/src/lib/form-data.ts

@@ -1,17 +1,34 @@
 import {
-  FormDataParseError,
+  MaxFilesExceededError,
+  MaxFileSizeExceededError,
+  MaxHeaderSizeExceededError,
+  MaxPartsExceededError,
+  MaxTotalSizeExceededError,
   parseFormData,
   type FileUploadHandler,
   type ParseFormDataOptions,
 } from '@remix-run/form-data-parser'
 import type { Middleware } from '@remix-run/fetch-router'
 
+type SetFormDataContextTransform = readonly [readonly [typeof FormData, FormData]]
+
+function isMultipartLimitError(error: unknown): boolean {
+  return (
+    error instanceof MaxFilesExceededError ||
+    error instanceof MaxHeaderSizeExceededError ||
+    error instanceof MaxFileSizeExceededError ||
+    error instanceof MaxPartsExceededError ||
+    error instanceof MaxTotalSizeExceededError
+  )
+}
+
 /**
- * Options for the `formData` middleware.
+ * Options for the {@link formData} middleware.
  */
 export interface FormDataOptions extends ParseFormDataOptions {
   /**
-   * Set `true` to suppress parse errors.
+   * Set `true` to suppress malformed form-data parse errors. Multipart limit violations always
+   * surface as errors even when suppression is enabled.
    *
    * @default false
    */
@@ -25,16 +42,22 @@ export interface FormDataOptions extends ParseFormDataOptions {
 }
 
 /**
- * Middleware that parses `FormData` from the request body and populates `context.formData`.
+ * Middleware that parses `FormData` from the request body and populates request context.
  *
  * @param options Options for parsing form data
  * @returns A middleware function that parses form data
  */
-export function formData(options?: FormDataOptions): Middleware {
+export function formData(
+  options?: FormDataOptions,
+): Middleware<any, any, SetFormDataContextTransform> {
   let suppressErrors = options?.suppressErrors ?? false
   let uploadHandler = options?.uploadHandler
 
   return async (context) => {
+    if (context.has(FormData)) {
+      return
+    }
+
     if (context.method === 'GET' || context.method === 'HEAD') {
       return
     }
@@ -45,18 +68,18 @@ export function formData(options?: FormDataOptions): Middleware {
       (!contentType.startsWith('multipart/') &&
         !contentType.startsWith('application/x-www-form-urlencoded'))
     ) {
-      context.formData = new FormData()
+      context.set(FormData, new FormData())
       return
     }
 
     try {
-      context.formData = await parseFormData(context.request, options, uploadHandler)
+      context.set(FormData, await parseFormData(context.request, options, uploadHandler))
     } catch (error) {
-      if (!suppressErrors || !(error instanceof FormDataParseError)) {
+      if (!suppressErrors || isMultipartLimitError(error)) {
         throw error
       }
 
-      context.formData = new FormData()
+      context.set(FormData, new FormData())
     }
   }
 }