nextjs-middleware-stack 1.0.0

package/LICENSE

@@ -0,0 +1,65 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Islam Yamor
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,153 @@
+# 🚣️ `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.
+
+Perfect for building layered request logic like authentication, logging, redirects, or feature flags in Next.js Edge or Node middlewares.
+
+---
+
+## ✨ Features
+
+- ✅ Simple pattern matching with support for:
+  - `:param` dynamic segments
+  - `**` wildcards (greedy)
+- ✅ `RegExp` support
+- ✅ Middleware short-circuiting (first matching response stops the stack)
+- ✅ Fully compatible with `next/server` and middleware in `apps/<name>/src/middleware.ts`
+
+---
+
+## 📦 Installation
+
+```bash
+npm install compare-path
+```
+
+---
+
+## 🧠 API
+
+### `middlewareStack(routes: [string | RegExp, MiddlewareHandler][])`
+
+Creates a Next.js-compatible middleware handler from an ordered list of route matchers and handler functions.
+
+#### Parameters:
+
+- `routes`: An array of tuples where:
+  - The first item is a string pattern (e.g., `/users/:id`) or a RegExp.
+  - The second item is a handler function `(req: NextRequest) => Response | void | Promise<Response | void>`.
+
+#### Returns:
+
+- A function `(req: NextRequest) => Promise<Response | void>` – ready to be exported as default from `middleware.ts`.
+
+---
+
+## 📊 Supported Path Shapes
+
+You can use either `string`-based shape patterns (powered by `compare-path`) or `RegExp`.
+
+| Shape           | Matches Path Example        |
+| --------------- | --------------------------- |
+| `/user/:id`     | `/user/42`                  |
+| `/users/[id]`   | `/users/42` (same as above) |
+| `/docs/**/edit` | `/docs/api/v1/intro/edit`   |
+| `/a/:x/**/b/:y` | `/a/1/foo/bar/b/2`          |
+
+> Use RegExp when you need full regex control.
+
+---
+
+## 🧪 Example Usage (Auth Middleware)
+
+```ts
+// File: apps/example-app/src/middleware.ts
+import { NextResponse } from 'next/server'
+import { middlewareStack } from './utils/middleware-stack'
+import { validateAuthToken } from './utils/validate-jwt'
+
+export default middlewareStack([
+  [
+    /^\/dashboard\/.*/,
+    async (req) => {
+      const token = req.cookies.get('AUTH_TOKEN')?.value
+      const isValid = token && (await validateAuthToken(token))
+      if (!isValid) return NextResponse.redirect(new URL('/login', req.url))
+    },
+  ],
+  [
+    '/public/:page',
+    async (req) => {
+      console.log('Logging public page hit')
+    },
+  ],
+])
+```
+
+---
+
+## 🧪 Example with String Matching
+
+```ts
+// File: apps/example-app/src/middleware.ts
+import { middlewareStack } from './utils/middleware-stack'
+
+export default middlewareStack([
+  [
+    '/users/:id',
+    async (req) => {
+      // Handle specific user route
+    },
+  ],
+  [
+    'cars/:id',
+    async (req) => {
+      // Same as above with different route
+    },
+  ],
+  [
+    'hello/**',
+    async (req) => {
+      // Match anything starting with /hello/
+    },
+  ],
+])
+```
+
+---
+
+## 🧹 Integration in Next.js
+
+You must also export the `config` to ensure the middleware applies to your desired routes:
+
+```ts
+export const config = {
+  matcher: [
+    '/((?!_next|.*\\..*).*)', // Skip static assets
+    '/(api|trpc)(.*)', // Always include API routes
+  ],
+  runtime: 'nodejs',
+}
+```
+
+---
+
+## 🧠 How It Works
+
+Internally, `middlewareStack` will iterate through your routes and:
+
+1. Compare the current path to each route (using `compare-path` or RegExp).
+2. If matched, execute the handler.
+3. If a `Response` is returned from the handler, it stops further execution and returns immediately.
+
+---
+
+## 💡 Tips
+
+- Middleware order matters! First match wins.
+- Use RegExp for more complex or legacy patterns.
+- Use string shapes for clean, readable routes with parameters.
+
+---
+
+Islam Yamor.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./main";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,QAAQ,CAAC"}

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,yCAAuB"}

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+import { NextRequest, NextResponse } from 'next/server';
+export type MiddlewareHandler = (req: NextRequest) => NextResponse | Response | void | Promise<NextResponse | Response | void>;
+export declare function middlewareStack(routes: [string | RegExp, MiddlewareHandler][]): (req: NextRequest) => Promise<Response | undefined>;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAEvD,MAAM,MAAM,iBAAiB,GAAG,CAC9B,GAAG,EAAE,WAAW,KACb,YAAY,GAAG,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC,CAAA;AAE7E,wBAAgB,eAAe,CAAC,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE,iBAAiB,CAAC,EAAE,IAC9D,KAAK,WAAW,mCAiB/B"}

package/dist/main.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.middlewareStack = middlewareStack;
+const compare_path_1 = require("compare-path");
+function middlewareStack(routes) {
+    return (req) => __awaiter(this, void 0, void 0, function* () {
+        const url = req.nextUrl.pathname;
+        for (const [pattern, handler] of routes) {
+            const isMatch = typeof pattern === 'string'
+                ? (0, compare_path_1.comparePath)(pattern, url)
+                : pattern instanceof RegExp
+                    ? pattern.test(url)
+                    : false;
+            if (isMatch) {
+                const result = yield handler(req);
+                if (result)
+                    return result; // short-circuit if a handler returns a response
+            }
+        }
+    });
+}
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA,0CAkBC;AAzBD,+CAA0C;AAO1C,SAAgB,eAAe,CAAC,MAA8C;IAC5E,OAAO,CAAO,GAAgB,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAA;QAEhC,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"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "nextjs-middleware-stack",
+  "version": "1.0.0",
+  "description": "Composable route-based middleware for Next.js Middleware.",
+  "author": "Islam Yamor",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "prettier": "@samislam/prettier-config/next",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "nextjs",
+    "next",
+    "next.js",
+    "middleware",
+    "nextjs-middleware",
+    "next-middleware",
+    "next-middleware-stack",
+    "nextjs-stack",
+    "edge",
+    "nextjs-edge"
+  ],
+  "devDependencies": {
+    "@clscripts/barrelsby": "^2.8.1",
+    "@clscripts/chokidar-cli": "^4.0.3",
+    "@clscripts/cl-common": "^1.0.4",
+    "@clscripts/concurrently": "^9.2.0",
+    "@clscripts/cross-env": "^7.0.3",
+    "@clscripts/del-cli": "^6.0.0",
+    "@clscripts/echo-cli": "^2.0.0",
+    "@clscripts/eslint": "^9.30.1",
+    "@clscripts/nodemon": "^3.1.10",
+    "@clscripts/prettier": "^3.6.2",
+    "@clscripts/ts-node": "^10.9.2",
+    "@clscripts/ts-node-dev": "^2.0.0",
+    "@clscripts/ts-patch": "^3.3.0",
+    "@eslint/js": "^9.30.1",
+    "@samislam/prettier-config": "^1.1.7",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.16.0",
+    "barrelsby": "^2.8.1",
+    "chalk": "4",
+    "chokidar-cli": "^3.0.0",
+    "cl-common": "^6.1.2",
+    "concurrently": "^9.2.0",
+    "cross-env": "^7.0.3",
+    "del-cli": "^6.0.0",
+    "echo-cli": "^2.0.0",
+    "eslint": "^9.30.1",
+    "jest": "^30.0.4",
+    "nodemon": "^3.1.10",
+    "prettier": "3.0.3",
+    "prettier-plugin-jsdoc": "^1.3.3",
+    "prettier-plugin-tailwindcss": "^0.6.13",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "ts-patch": "^3.3.0",
+    "tsx": "^4.20.3",
+    "typescript-eslint": "^8.36.0",
+    "typescript-transform-paths": "^3.5.5"
+  },
+  "dependencies": {
+    "compare-path": "^1.2.0",
+    "next": "^15.3.5"
+  },
+  "scripts": {
+    "test": "jest",
+    "dev": "tsx ./scripts/dev.ts",
+    "lint": "tsx ./scripts/lint.ts",
+    "clean": "tsx ./scripts/clean.ts",
+    "build": "tsx ./scripts/build.ts",
+    "format": "tsx ./scripts/format.ts"
+  }
+}