@remix-run/method-override-middleware 0.1.3 → 0.1.5

package/README.md

@@ -1,13 +1,17 @@
 # method-override-middleware
 
-Middleware for overriding HTTP request methods from form data for use with [`@remix-run/fetch-router`](https://github.com/remix-run/remix/tree/main/packages/fetch-router).
+Method override middleware for Remix. It allows HTML forms to simulate `PUT`, `PATCH`, and `DELETE` requests using a hidden form field.
 
-Allows HTML forms (which only support GET and POST) to submit with other HTTP methods like PUT, PATCH, or DELETE by including a special form field.
+## Features
+
+- **Form Method Overrides** - Translate posted form fields into request methods
+- **HTML Form Friendly** - Supports REST-style routes from standard browser forms
+- **Configurable Field Name** - Choose a custom override field key
 
 ## Installation
 
 ```sh
-npm install @remix-run/method-override-middleware
+npm i remix
 ```
 
 ## Usage
@@ -15,9 +19,9 @@ npm install @remix-run/method-override-middleware
 This middleware runs after [the `formData` middleware](https://github.com/remix-run/remix/tree/main/packages/form-data-middleware) and updates the request context's `context.method` with the value of the method override field. This is useful for simulating RESTful API request methods like PUT and DELETE using HTML forms.
 
 ```ts
-import { createRouter } from '@remix-run/fetch-router'
-import { formData } from '@remix-run/form-data-middleware'
-import { methodOverride } from '@remix-run/method-override-middleware'
+import { createRouter } from 'remix/fetch-router'
+import { formData } from 'remix/form-data-middleware'
+import { methodOverride } from 'remix/method-override-middleware'
 
 let router = createRouter({
   // methodOverride must come AFTER formData middleware

package/dist/lib/method-override.d.ts

@@ -1,6 +1,6 @@
 import type { Middleware } from '@remix-run/fetch-router';
 /**
- * Options for the `methodOverride` middleware.
+ * Options for the {@link methodOverride} middleware.
  */
 export interface MethodOverrideOptions {
     /**
@@ -13,8 +13,9 @@ export interface MethodOverrideOptions {
 /**
  * Middleware that overrides `context.method` with the value of the method override field.
  *
- * Note: This middleware must be placed after the `formData` middleware in the middleware chain, or
- * some other middleware that provides `context.formData`.
+ * Note: This middleware must be placed after the
+ * {@link import('@remix-run/form-data-middleware').formData} middleware in the middleware
+ * chain, or some other middleware that provides `context.get(FormData)`.
  *
  * @param options Options for the method override middleware
  * @returns A middleware that overrides `context.method` with the value of the method override field

package/dist/lib/method-override.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"method-override.d.ts","sourceRoot":"","sources":["../../src/lib/method-override.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAiC,MAAM,yBAAyB,CAAA;AAExF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,UAAU,CAe1E"}
+{"version":3,"file":"method-override.d.ts","sourceRoot":"","sources":["../../src/lib/method-override.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAiC,MAAM,yBAAyB,CAAA;AAExF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,UAAU,CAe1E"}

package/dist/lib/method-override.js

@@ -2,8 +2,9 @@ import { RequestMethods } from '@remix-run/fetch-router';
 /**
  * Middleware that overrides `context.method` with the value of the method override field.
  *
- * Note: This middleware must be placed after the `formData` middleware in the middleware chain, or
- * some other middleware that provides `context.formData`.
+ * Note: This middleware must be placed after the
+ * {@link import('@remix-run/form-data-middleware').formData} middleware in the middleware
+ * chain, or some other middleware that provides `context.get(FormData)`.
  *
  * @param options Options for the method override middleware
  * @returns A middleware that overrides `context.method` with the value of the method override field
@@ -11,7 +12,7 @@ import { RequestMethods } from '@remix-run/fetch-router';
 export function methodOverride(options) {
     let fieldName = options?.fieldName ?? '_method';
     return (context) => {
-        let method = context.formData?.get(fieldName);
+        let method = context.has(FormData) ? context.get(FormData).get(fieldName) : null;
         if (typeof method !== 'string') {
             return;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/method-override-middleware",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Middleware for overriding HTTP request methods from form data",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "license": "MIT",
@@ -28,11 +28,11 @@
   "devDependencies": {
     "@types/node": "^24.6.0",
     "@typescript/native-preview": "7.0.0-dev.20251125.1",
-    "@remix-run/fetch-router": "0.16.0",
-    "@remix-run/form-data-middleware": "0.1.3"
+    "@remix-run/fetch-router": "0.18.0",
+    "@remix-run/form-data-middleware": "0.2.0"
   },
   "dependencies": {
-    "@remix-run/fetch-router": "^0.16.0"
+    "@remix-run/fetch-router": "^0.18.0"
   },
   "keywords": [
     "fetch",
@@ -44,7 +44,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/method-override.ts

@@ -2,7 +2,7 @@ import { RequestMethods } from '@remix-run/fetch-router'
 import type { Middleware, RequestContext, RequestMethod } from '@remix-run/fetch-router'
 
 /**
- * Options for the `methodOverride` middleware.
+ * Options for the {@link methodOverride} middleware.
  */
 export interface MethodOverrideOptions {
   /**
@@ -16,8 +16,9 @@ export interface MethodOverrideOptions {
 /**
  * Middleware that overrides `context.method` with the value of the method override field.
  *
- * Note: This middleware must be placed after the `formData` middleware in the middleware chain, or
- * some other middleware that provides `context.formData`.
+ * Note: This middleware must be placed after the
+ * {@link import('@remix-run/form-data-middleware').formData} middleware in the middleware
+ * chain, or some other middleware that provides `context.get(FormData)`.
  *
  * @param options Options for the method override middleware
  * @returns A middleware that overrides `context.method` with the value of the method override field
@@ -26,7 +27,7 @@ export function methodOverride(options?: MethodOverrideOptions): Middleware {
   let fieldName = options?.fieldName ?? '_method'
 
   return (context: RequestContext) => {
-    let method = context.formData?.get(fieldName)
+    let method = context.has(FormData) ? context.get(FormData).get(fieldName) : null
     if (typeof method !== 'string') {
       return
     }