Initial commit

.gitignore

@@ -0,0 +1,9 @@
+# node
+/node_modules
+
+# testing
+/coverage
+/dist
+
+# typescript
+next-env.d.ts

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Barnhill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,147 @@
+# Trail Middleware
+
+Trail Middleware is a lightweight and efficient middleware wrapper for Next.js. It provides a simple interface to manage and organize your middleware.
+
+> ⚠️ **Important**: This package is currently in an **experimental** stage. Please be aware that its API, functionality, and behavior are subject to change in upcoming releases. Use it cautiously in production environments, and keep track of updates to stay informed of breaking changes or enhancements.
+
+## Features
+
+- Easily integrates with your existing Next.js middleware
+- Lightweight and minimalistic
+- Customizable middleware stack
+
+## Installation
+
+You can install Trail Middleware using npm:
+
+```bash
+npm i trail-middleware
+```
+
+## Getting Started
+
+### Basic Example
+
+```javascript
+import { withTrailMiddleware } from 'trail-middleware';
+
+// Example middleware for logging request data
+const const loggerMiddleware = (request: NextRequest) => {
+  logger(`User Agent: ${req.headers.get('user-agent')}`);
+  logger(`Path: ${req.nextUrl.pathname}`);
+}
+
+// Main Next.js middleware with TrailMiddleware wrapper
+export const middleware = withTrailMiddleware((trail) => {
+  // Use logger middleware on all routes
+  trail('/*allroutes', loggerMiddleware);
+});
+```
+
+### Multiple Routes and Middleware
+
+Trail Middleware also supports multiple routes:
+
+```javascript
+// Example middleware for authenticating users
+const authMiddleware = (request: NextRequest) {
+  const cookie = req.cookies.get('jwt');
+
+  if (cookie) {
+    return NextResponse.next();
+  }
+
+  return NextResponse.redirect(new URL('/login', req.nextUrl.href));
+}
+
+export const middleware = withTrailMiddleware((trail) => {
+  // When any of these routes are visited, logger middleware
+  // will be called
+  trail(['/route-one', '/route-two'], authMiddleware);
+});
+```
+
+and multiple middleware:
+
+```javascript
+export const middleware = withTrailMiddleware((trail) => {
+  // When this route is visited, auth middleware and logger middleware
+  // will both be called sequentially
+  trail("/route-one", [authMiddleware, loggerMiddleware]);
+});
+```
+
+### Organization
+
+Instead of having everything in one monolithic file, easily organize your middleware into separate files:
+
+```javascript
+import { withTrailMiddleware } from "trail-middleware";
+
+import { loggerMiddleware } from "./middleware/logger";
+import { authMiddleware } from "./middleware/auth";
+
+export const middleware = withTrailMiddleware((trail) => {
+  // Use logger middleware on all routes
+  trail("/*routes", loggerMiddleware);
+
+  // Use auth middleware on protected routes
+  trail("/protected/*routes", authMiddleware);
+
+  // Etc...
+});
+```
+
+## API Reference
+
+### Types
+
+- `MiddlewareFunction: (req: NextRequest) => Promise<NextResponse<unknown>> | NextResponse<unknown>`
+- `SetupFunction: (trail: TrailFunction, req: NextRequest) => void`
+- `TrailFunction: (routes: string | string[], middleware: MiddlewareFunction | MiddlewareFunction[]) => void`
+
+### Functions
+
+#### `withTrailMiddleware(setup: SetupFunction) => Promise<MiddlewareFunction>`
+
+This function enhances the standard Next.js middleware by allowing for a better organized and customizable middleware stack.
+
+##### Parameters
+
+- **`setup`**: `SetupFunction`
+
+  This is the function that will contain your middleware organization code. It is passed two parameters: `trail` (a function used for creating route middleware) and `request` (a standard Next.js NextRequest).
+
+##### Returns
+
+- **MiddlewareFunction**: A middleware function that can be used to handle requests in Next.js with additional route-specific processing via the `trail` function.
+
+#### `trail(routes: string | string[], middleware: MiddlewareFunction | MiddlewareFunction[]) => void`
+
+This function is passed to `setup` in `withTrailMiddleware`. It's used to assign middleware to your routes.
+
+##### Parameters
+
+- **`routes`**: `string | string[]`
+
+  A route or an array of routes where the supplied middleware will be called. Each route is matched according to the rules of the `match` function from [Path-to-RegExp](https://github.com/pillarjs/path-to-regexp).
+
+  **Matching Examples**
+
+  ```javascript
+  trail("/route", myMiddleware); // Matches '/route'. Doesn't match '/route-one'.
+  trail("/*allroutes", myMiddleware); // Matches '/route', '/login', '/user/signup', and all other routes.
+  trail("/movies/*movie", myMiddleware); // Matches '/movies/10394234', `/movies/action/8345983`. Doesn't match '/movies'.
+  ```
+
+- **`middleware`**: `MiddlewareFunction | MiddlewareFunction[]`
+
+  A middleware function or an array of middleware functions to be executed for the specified routes.
+
+##### Returns
+
+- **void**
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

eslint.config.js

@@ -0,0 +1,26 @@
+import eslintPluginPrettier from "eslint-plugin-prettier";
+import eslintConfigPrettier from "eslint-config-prettier";
+import typescriptParser from "@typescript-eslint/parser";
+
+export default [
+  {
+    files: ["src/**/*.{js,ts}"],
+    languageOptions: {
+      globals: {
+        global: true,
+        process: true,
+        __dirname: true,
+      },
+      ecmaVersion: 2021,
+      sourceType: "module",
+      parser: typescriptParser,
+    },
+    plugins: {
+      prettier: eslintPluginPrettier,
+    },
+    rules: {
+      "prettier/prettier": "error",
+    },
+  },
+  eslintConfigPrettier,
+];

jest.config.js

@@ -0,0 +1,5 @@
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/*.spec.ts'],
+};