nextjs-middleware-stack 1.0.2 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # 🚣️ `middlewareStack` – A Lightweight Middleware Router for Next.js
 
-A composable middleware stack for Next.js, supporting both `string`-based route patterns (with dynamic parameters and wildcards) and raw `RegExp` objects.
+A composable middleware stack for Next.js, supporting `string`-based route patterns (with dynamic parameters and wildcards), raw `RegExp` objects, and custom sync/async predicate functions.
 
 Perfect for building layered request logic like authentication, logging, redirects, or feature flags in Next.js Edge or Node middlewares.
 
@@ -12,6 +12,7 @@ Perfect for building layered request logic like authentication, logging, redirec
   - `:param` dynamic segments
   - `**` wildcards (greedy)
 - ✅ `RegExp` support
+- ✅ Custom `PatternFn` support: `(req) => boolean | Promise<boolean>`
 - ✅ Middleware short-circuiting (first matching response stops the stack)
 - ✅ Fully compatible with `next/server` and middleware in `apps/<name>/src/middleware.ts`
 
@@ -27,14 +28,22 @@ npm install compare-path
 
 ## 🧠 API
 
-### `middlewareStack(routes: [string | RegExp, MiddlewareHandler][])`
+### `middlewareStack(routes: [Pattern, MiddlewareHandler][])`
 
 Creates a Next.js-compatible middleware handler from an ordered list of route matchers and handler functions.
 
+```ts
+export type PatternFn = (req: Request) => boolean | Promise<boolean>
+export type Pattern = PatternFn | string | RegExp
+```
+
 #### Parameters:
 
 - `routes`: An array of tuples where:
-  - The first item is a string pattern (e.g., `/users/:id`) or a RegExp.
+  - The first item is a `Pattern`:
+    - a string pattern (e.g., `/users/:id`)
+    - a `RegExp`
+    - a function/async function `(req) => boolean | Promise<boolean>`
   - The second item is a handler function `(req: NextRequest) => Response | void | Promise<Response | void>`.
 
 #### Returns:
@@ -45,7 +54,7 @@ Creates a Next.js-compatible middleware handler from an ordered list of route ma
 
 ## 📊 Supported Path Shapes
 
-You can use either `string`-based shape patterns (powered by `compare-path`) or `RegExp`.
+You can use `string`-based shape patterns (powered by `compare-path`), `RegExp`, or predicate functions.
 
 | Shape           | Matches Path Example        |
 | --------------- | --------------------------- |
@@ -56,6 +65,8 @@ You can use either `string`-based shape patterns (powered by `compare-path`) or
 
 > Use RegExp when you need full regex control.
 
+Use a predicate function when matching depends on request headers, cookies, or any custom runtime logic.
+
 ---
 
 ## 🧪 Example Usage (Auth Middleware)
@@ -116,6 +127,26 @@ export default middlewareStack([
 
 ---
 
+## 🧪 Example with `PatternFn`
+
+```ts
+import { middlewareStack } from './utils/middleware-stack'
+
+export default middlewareStack([
+  [
+    async (req) => {
+      // Match only API requests that include an auth header
+      return req.url.includes('/api/') && !!req.headers.get('authorization')
+    },
+    async (req) => {
+      // Custom logic for authenticated API requests
+    },
+  ],
+])
+```
+
+---
+
 ## 🧹 Integration in Next.js
 
 You must also export the `config` to ensure the middleware applies to your desired routes:
@@ -136,7 +167,7 @@ export const config = {
 
 Internally, `middlewareStack` will iterate through your routes and:
 
-1. Compare the current path to each route (using `compare-path` or RegExp).
+1. Compare the current request to each route pattern (`compare-path`, `RegExp`, or `PatternFn`).
 2. If matched, execute the handler.
 3. If a `Response` is returned from the handler, it stops further execution and returns immediately.
 
@@ -147,7 +178,8 @@ Internally, `middlewareStack` will iterate through your routes and:
 - Middleware order matters! First match wins.
 - Use RegExp for more complex or legacy patterns.
 - Use string shapes for clean, readable routes with parameters.
+- Use `PatternFn` for request-aware matching (cookies, headers, auth, geo, etc).
 
 ---
 
-Islam Yamor.
+Islam Yamor.

package/dist/main.d.ts

@@ -1,3 +1,5 @@
 export type MiddlewareHandler<T = Request, R = Response> = (req: T) => R | void | Promise<R | void>;
-export declare function middlewareStack<T = Request, R = Response>(routes: [string | RegExp, MiddlewareHandler<T, R>][]): (req: T) => Promise<R | void>;
+export type PatternFn = (req: Request) => boolean | Promise<boolean>;
+export type Pattern = PatternFn | string | RegExp;
+export declare function middlewareStack<T = Request, R = Response>(routes: [Pattern, MiddlewareHandler<T, R>][]): (req: T) => Promise<R | void>;
 //# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;AAEnG,wBAAgB,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,QAAQ,EACvD,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAEtC,KAAK,CAAC,KAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAkBzC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;AACnG,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AACpE,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAA;AAEjD,wBAAgB,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,QAAQ,EACvD,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAE9B,KAAK,CAAC,KAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAoBzC"}

package/dist/main.js

@@ -20,7 +20,9 @@ function middlewareStack(routes) {
                 ? (0, compare_path_1.comparePath)(pattern, url)
                 : pattern instanceof RegExp
                     ? pattern.test(url)
-                    : false;
+                    : typeof pattern === 'function'
+                        ? yield pattern(req)
+                        : false;
             if (isMatch) {
                 const result = yield handler(req);
                 if (result)

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,0CAqBC;AAzBD,+CAA0C;AAI1C,SAAgB,eAAe,CAC7B,MAAoD;IAEpD,OAAO,CAAO,GAAM,EAAqB,EAAE;;QAEzC,MAAM,GAAG,GAAG,MAAA,MAAC,GAAwB,CAAC,OAAO,0CAAE,QAAQ,mCAAK,GAAe,CAAC,GAAG,CAAA;QAE/E,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,MAAM,EAAE,CAAC;YACxC,MAAM,OAAO,GACX,OAAO,OAAO,KAAK,QAAQ;gBACzB,CAAC,CAAC,IAAA,0BAAW,EAAC,OAAO,EAAE,GAAG,CAAC;gBAC3B,CAAC,CAAC,OAAO,YAAY,MAAM;oBAC3B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;oBACnB,CAAC,CAAC,KAAK,CAAA;YAEX,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;gBACjC,IAAI,MAAM;oBAAE,OAAO,MAAM,CAAA,CAAC,gDAAgD;YAC5E,CAAC;QACH,CAAC;IACH,CAAC,CAAA,CAAA;AACH,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;AAMA,0CAuBC;AA7BD,+CAA0C;AAM1C,SAAgB,eAAe,CAC7B,MAA4C;IAE5C,OAAO,CAAO,GAAM,EAAqB,EAAE;;QAEzC,MAAM,GAAG,GAAG,MAAA,MAAC,GAAwB,CAAC,OAAO,0CAAE,QAAQ,mCAAK,GAAe,CAAC,GAAG,CAAA;QAE/E,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,MAAM,EAAE,CAAC;YACxC,MAAM,OAAO,GACX,OAAO,OAAO,KAAK,QAAQ;gBACzB,CAAC,CAAC,IAAA,0BAAW,EAAC,OAAO,EAAE,GAAG,CAAC;gBAC3B,CAAC,CAAC,OAAO,YAAY,MAAM;oBAC3B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;oBACnB,CAAC,CAAC,OAAO,OAAO,KAAK,UAAU;wBAC/B,CAAC,CAAC,MAAM,OAAO,CAAC,GAAc,CAAC;wBAC/B,CAAC,CAAC,KAAK,CAAA;YAEX,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;gBACjC,IAAI,MAAM;oBAAE,OAAO,MAAM,CAAA,CAAC,gDAAgD;YAC5E,CAAC;QACH,CAAC;IACH,CAAC,CAAA,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nextjs-middleware-stack",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Composable route-based middleware for Next.js Middleware.",
   "author": "Islam Yamor",
   "license": "Apache-2.0",