fix documentation

Author: Melvynx

README.md

@@ -122,39 +122,9 @@ return { data: 'value' };
 
 ## Advanced Usage
 
-### Metadata
+### Static Parameters with Metadata
 
-You can add metadata to your route handler with the `defineMetadata` method. Metadata is optional and can be used to add additional information to your route handler.
-
-```ts
-const metadataSchema = z.object({
-  permission: z.string(),
-  role: z.enum(['admin', 'user']),
-});
-
-export const GET = createZodRoute()
-  .defineMetadata(metadataSchema)
-  .handler((request, context) => {
-    // Access metadata from context.metadata
-    const { permission, role } = context.metadata!;
-
-    return Response.json({ permission, role });
-  });
-```
-
-When calling the route, you can pass metadata as part of the context:
-
-```ts
-// In your Next.js page/component
-const response = await GET(request, {
-  params: Promise.resolve({}),
-  metadata: { permission: 'read', role: 'admin' },
-});
-```
-
-Metadata is optional by default. If you define a metadata schema but don't provide metadata in the context, the handler will still work. If you provide metadata, it will be validated against the schema.
-
-### Permission Checking with Metadata
+Metadata enable you to add **static parameters** to the route, for example to give permissions list to our application.
 
 One powerful use case for metadata is defining required permissions for routes and checking them in middleware. This allows you to:
 

docs/migrations/01-middleware-next.md

@@ -16,11 +16,11 @@ Version 0.2.0 introduces a completely revamped middleware system that provides m
 1. Middleware must now accept an object with:
 
    - `request`: The incoming request
-   - `context`: Current context from previous middleware
+   - `ctx`: Current context from previous middleware
    - `metadata`: Optional route metadata (type-safe)
    - `next`: Function to continue the chain
 
-2. Context is now passed explicitly via `next({ context: {...} })`
+2. Context is now passed explicitly via `next({ ctx: {...} })`
 
 3. Middleware can return:
    - A Response object to short-circuit
@@ -39,8 +39,8 @@ const authMiddleware = async () => {
 
 const route = createZodRoute()
   .use(authMiddleware)
-  .handler((req, ctx) => {
-    const { user } = ctx.data;
+  .handler((req, { ctx }) => {
+    const { user } = ctx;
     return { data: user.id };
   });
 ```
@@ -50,15 +50,15 @@ const route = createZodRoute()
 ```typescript
 const authMiddleware = async ({ next }) => {
   const response = await next({
-    context: { user: { id: 'user-123' } },
+    ctx: { user: { id: 'user-123' } },
   });
   return response;
 };
 
 const route = createZodRoute()
   .use(authMiddleware)
-  .handler((req, ctx) => {
-    const { user } = ctx.data;
+  .handler((req, { ctx }) => {
+    const { user } = ctx;
     return { data: user.id };
   });
 ```
@@ -102,7 +102,7 @@ const headerMiddleware = async ({ next }) => {
 ```typescript
 const middleware1 = async ({ next }) => {
   const response = await next({
-    context: { value1: 'first' },
+    ctx: { value1: 'first' },
   });
   return response;
 };
@@ -112,7 +112,7 @@ const middleware2 = async ({ context, next }) => {
   console.log(context.value1); // 'first'
 
   const response = await next({
-    context: { value2: 'second' },
+    ctx: { value2: 'second' },
   });
   return response;
 };
@@ -153,7 +153,7 @@ const permissionCheckMiddleware = async ({ next, metadata, request }) => {
 
   // If no required permissions in metadata, allow access
   if (!metadata?.requiredPermissions || metadata.requiredPermissions.length === 0) {
-    return next({ context: { authorized: true } });
+    return next({ ctx: { authorized: true } });
   }
 
   // Check if user has all required permissions
@@ -174,7 +174,7 @@ const permissionCheckMiddleware = async ({ next, metadata, request }) => {
   }
 
   // Continue with authorized context
-  return next({ context: { authorized: true } });
+  return next({ ctx: { authorized: true } });
 };
 
 // Use in your route handlers
@@ -208,7 +208,7 @@ const middleware = async () => {
 // After
 const middleware = async ({ request, next }) => {
   const token = request.headers.get('authorization');
-  return next({ context: { token } });
+  return next({ ctx: { token } });
 };
 ```
 
@@ -221,11 +221,11 @@ const middleware2 = async () => ({ value2: 'second' });
 
 // After
 const middleware1 = async ({ next }) => {
-  return next({ context: { value1: 'first' } });
+  return next({ ctx: { value1: 'first' } });
 };
 const middleware2 = async ({ context, next }) => {
   return next({
-    context: {
+    ctx: {
       ...context,
       value2: 'second'
     }
@@ -243,7 +243,7 @@ const middleware = async () => {
 
 // After
 const middleware = async ({ next }) => {
-  const response = await next({ context: { transform: true } });
+  const response = await next({ ctx: { transform: true } });
 
   // Now you can transform the response
   const data = await response.json();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-zod-route",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "A zod way to define route handlers in Next.js",
   "keywords": [
     "next",
@@ -41,9 +41,7 @@
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "lint": "tsc --noEmit && eslint .",
     "lint-staged": "lint-staged",
-    "pre:publish": "pnpm build",
     "prepare": "husky",
-    "publish": "pnpm publish",
     "release": "release-it",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",

src/routeHandlerBuilder.ts

@@ -121,6 +121,11 @@ export class RouteHandlerBuilder<
     });
   }
 
+  /**
+   * Set the metadata value for the route handler
+   * @param value - The metadata value that will be passed to middlewares
+   * @returns A new instance of the RouteHandlerBuilder
+   */
   metadata(value: z.infer<TMetadata>) {
     return new RouteHandlerBuilder<TParams, TQuery, TBody, TContext, TMetadata>({
       ...this,