npm - @engjts/nexus - Versions diffs - 0.1.8 → 0.1.9 - Mend

@engjts/nexus 0.1.8 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (205) hide show

package/package.json +1 -1
package/BENCHMARK_REPORT.md +0 -343
package/documentation/01-getting-started.md +0 -240
package/documentation/02-context.md +0 -335
package/documentation/03-routing.md +0 -397
package/documentation/04-middleware.md +0 -483
package/documentation/05-validation.md +0 -514
package/documentation/06-error-handling.md +0 -465
package/documentation/07-performance.md +0 -364
package/documentation/08-adapters.md +0 -470
package/documentation/09-api-reference.md +0 -548
package/documentation/10-examples.md +0 -582
package/documentation/11-deployment.md +0 -477
package/documentation/12-sentry.md +0 -620
package/documentation/13-sentry-data-storage.md +0 -996
package/documentation/14-sentry-data-reference.md +0 -457
package/documentation/15-sentry-summary.md +0 -409
package/documentation/16-alerts-system.md +0 -745
package/documentation/17-alert-adapters.md +0 -696
package/documentation/18-alerts-implementation-summary.md +0 -385
package/documentation/19-class-based-routing.md +0 -840
package/documentation/20-websocket-realtime.md +0 -813
package/documentation/21-cache-system.md +0 -510
package/documentation/22-job-queue.md +0 -772
package/documentation/23-sentry-plugin.md +0 -551
package/documentation/24-testing-utilities.md +0 -1287
package/documentation/25-api-versioning.md +0 -533
package/documentation/26-context-store.md +0 -607
package/documentation/27-dependency-injection.md +0 -329
package/documentation/28-lifecycle-hooks.md +0 -521
package/documentation/29-package-structure.md +0 -196
package/documentation/30-plugin-system.md +0 -414
package/documentation/31-jwt-authentication.md +0 -597
package/documentation/32-cli.md +0 -268
package/documentation/ALERTS-COMPLETE-SUMMARY.md +0 -429
package/documentation/ALERTS-INDEX.md +0 -330
package/documentation/ALERTS-QUICK-REFERENCE.md +0 -286
package/documentation/README.md +0 -178
package/documentation/index.html +0 -34
package/modern_framework_paper.md +0 -1870
package/public/css/style.css +0 -87
package/public/index.html +0 -34
package/public/js/app.js +0 -27
package/src/advanced/cache/InMemoryCacheStore.ts +0 -68
package/src/advanced/cache/MultiTierCache.ts +0 -194
package/src/advanced/cache/RedisCacheStore.ts +0 -341
package/src/advanced/cache/index.ts +0 -5
package/src/advanced/cache/types.ts +0 -40
package/src/advanced/graphql/SimpleDataLoader.ts +0 -42
package/src/advanced/graphql/index.ts +0 -22
package/src/advanced/graphql/server.ts +0 -252
package/src/advanced/graphql/types.ts +0 -42
package/src/advanced/jobs/InMemoryQueueStore.ts +0 -68
package/src/advanced/jobs/JobQueue.ts +0 -556
package/src/advanced/jobs/RedisQueueStore.ts +0 -367
package/src/advanced/jobs/index.ts +0 -5
package/src/advanced/jobs/types.ts +0 -70
package/src/advanced/observability/APMManager.ts +0 -163
package/src/advanced/observability/AlertManager.ts +0 -109
package/src/advanced/observability/MetricRegistry.ts +0 -151
package/src/advanced/observability/ObservabilityCenter.ts +0 -304
package/src/advanced/observability/StructuredLogger.ts +0 -154
package/src/advanced/observability/TracingManager.ts +0 -117
package/src/advanced/observability/adapters.ts +0 -304
package/src/advanced/observability/createObservabilityMiddleware.ts +0 -63
package/src/advanced/observability/index.ts +0 -11
package/src/advanced/observability/types.ts +0 -174
package/src/advanced/playground/extractPathParams.ts +0 -6
package/src/advanced/playground/generateFieldExample.ts +0 -31
package/src/advanced/playground/generatePlaygroundHTML.ts +0 -1956
package/src/advanced/playground/generateSummary.ts +0 -19
package/src/advanced/playground/getTagFromPath.ts +0 -9
package/src/advanced/playground/index.ts +0 -8
package/src/advanced/playground/playground.ts +0 -250
package/src/advanced/playground/types.ts +0 -49
package/src/advanced/playground/zodToExample.ts +0 -16
package/src/advanced/playground/zodToParams.ts +0 -15
package/src/advanced/postman/buildAuth.ts +0 -31
package/src/advanced/postman/buildBody.ts +0 -15
package/src/advanced/postman/buildQueryParams.ts +0 -27
package/src/advanced/postman/buildRequestItem.ts +0 -36
package/src/advanced/postman/buildResponses.ts +0 -11
package/src/advanced/postman/buildUrl.ts +0 -33
package/src/advanced/postman/capitalize.ts +0 -4
package/src/advanced/postman/generateCollection.ts +0 -59
package/src/advanced/postman/generateEnvironment.ts +0 -34
package/src/advanced/postman/generateExampleFromZod.ts +0 -21
package/src/advanced/postman/generateFieldExample.ts +0 -45
package/src/advanced/postman/generateName.ts +0 -20
package/src/advanced/postman/generateUUID.ts +0 -11
package/src/advanced/postman/getTagFromPath.ts +0 -10
package/src/advanced/postman/index.ts +0 -28
package/src/advanced/postman/postman.ts +0 -156
package/src/advanced/postman/slugify.ts +0 -7
package/src/advanced/postman/types.ts +0 -140
package/src/advanced/realtime/index.ts +0 -18
package/src/advanced/realtime/websocket.ts +0 -231
package/src/advanced/sentry/index.ts +0 -1236
package/src/advanced/sentry/types.ts +0 -355
package/src/advanced/static/generateDirectoryListing.ts +0 -47
package/src/advanced/static/generateETag.ts +0 -7
package/src/advanced/static/getMimeType.ts +0 -9
package/src/advanced/static/index.ts +0 -32
package/src/advanced/static/isSafePath.ts +0 -13
package/src/advanced/static/publicDir.ts +0 -21
package/src/advanced/static/serveStatic.ts +0 -225
package/src/advanced/static/spa.ts +0 -24
package/src/advanced/static/types.ts +0 -159
package/src/advanced/swagger/SwaggerGenerator.ts +0 -66
package/src/advanced/swagger/buildOperation.ts +0 -61
package/src/advanced/swagger/buildParameters.ts +0 -61
package/src/advanced/swagger/buildRequestBody.ts +0 -21
package/src/advanced/swagger/buildResponses.ts +0 -54
package/src/advanced/swagger/capitalize.ts +0 -5
package/src/advanced/swagger/convertPath.ts +0 -9
package/src/advanced/swagger/createSwagger.ts +0 -12
package/src/advanced/swagger/generateOperationId.ts +0 -21
package/src/advanced/swagger/generateSpec.ts +0 -105
package/src/advanced/swagger/generateSummary.ts +0 -24
package/src/advanced/swagger/generateSwaggerUI.ts +0 -70
package/src/advanced/swagger/generateThemeCss.ts +0 -53
package/src/advanced/swagger/index.ts +0 -25
package/src/advanced/swagger/swagger.ts +0 -237
package/src/advanced/swagger/types.ts +0 -206
package/src/advanced/swagger/zodFieldToOpenAPI.ts +0 -94
package/src/advanced/swagger/zodSchemaToOpenAPI.ts +0 -50
package/src/advanced/swagger/zodToOpenAPI.ts +0 -22
package/src/advanced/testing/factory.ts +0 -509
package/src/advanced/testing/harness.ts +0 -612
package/src/advanced/testing/index.ts +0 -430
package/src/advanced/testing/load-test.ts +0 -618
package/src/advanced/testing/mock-server.ts +0 -498
package/src/advanced/testing/mock.ts +0 -670
package/src/cli/bin.ts +0 -9
package/src/cli/cli.ts +0 -158
package/src/cli/commands/add.ts +0 -178
package/src/cli/commands/build.ts +0 -73
package/src/cli/commands/create.ts +0 -166
package/src/cli/commands/dev.ts +0 -85
package/src/cli/commands/generate.ts +0 -99
package/src/cli/commands/help.ts +0 -95
package/src/cli/commands/init.ts +0 -91
package/src/cli/commands/version.ts +0 -38
package/src/cli/index.ts +0 -6
package/src/cli/templates/generators.ts +0 -359
package/src/cli/templates/index.ts +0 -680
package/src/cli/utils/exec.ts +0 -52
package/src/cli/utils/file-system.ts +0 -78
package/src/cli/utils/logger.ts +0 -111
package/src/core/adapter.ts +0 -88
package/src/core/application.ts +0 -1453
package/src/core/context-pool.ts +0 -79
package/src/core/context.ts +0 -856
package/src/core/index.ts +0 -94
package/src/core/middleware.ts +0 -272
package/src/core/performance/buffer-pool.ts +0 -108
package/src/core/performance/middleware-optimizer.ts +0 -162
package/src/core/plugin/PluginManager.ts +0 -435
package/src/core/plugin/builder.ts +0 -358
package/src/core/plugin/index.ts +0 -50
package/src/core/plugin/types.ts +0 -214
package/src/core/router/file-router.ts +0 -623
package/src/core/router/index.ts +0 -260
package/src/core/router/radix-tree.ts +0 -242
package/src/core/serializer.ts +0 -397
package/src/core/store/index.ts +0 -30
package/src/core/store/registry.ts +0 -178
package/src/core/store/request-store.ts +0 -240
package/src/core/store/types.ts +0 -233
package/src/core/types.ts +0 -616
package/src/database/adapter.ts +0 -35
package/src/database/adapters/index.ts +0 -1
package/src/database/adapters/mysql.ts +0 -669
package/src/database/database.ts +0 -70
package/src/database/dialect.ts +0 -388
package/src/database/index.ts +0 -12
package/src/database/migrations.ts +0 -86
package/src/database/optimizer.ts +0 -125
package/src/database/query-builder.ts +0 -404
package/src/database/realtime.ts +0 -53
package/src/database/schema.ts +0 -71
package/src/database/transactions.ts +0 -56
package/src/database/types.ts +0 -87
package/src/deployment/cluster.ts +0 -471
package/src/deployment/config.ts +0 -454
package/src/deployment/docker.ts +0 -599
package/src/deployment/graceful-shutdown.ts +0 -373
package/src/deployment/index.ts +0 -56
package/src/index.ts +0 -281
package/src/security/adapter.ts +0 -318
package/src/security/auth/JWTPlugin.ts +0 -234
package/src/security/auth/JWTProvider.ts +0 -316
package/src/security/auth/adapter.ts +0 -12
package/src/security/auth/jwt.ts +0 -234
package/src/security/auth/middleware.ts +0 -188
package/src/security/csrf.ts +0 -220
package/src/security/headers.ts +0 -108
package/src/security/index.ts +0 -60
package/src/security/rate-limit/adapter.ts +0 -7
package/src/security/rate-limit/memory.ts +0 -108
package/src/security/rate-limit/middleware.ts +0 -181
package/src/security/sanitization.ts +0 -75
package/src/security/types.ts +0 -240
package/src/security/utils.ts +0 -52
package/tsconfig.json +0 -39

package/documentation/02-context.md DELETED Viewed

@@ -1,335 +0,0 @@
-# Context API
-## Overview
-The **Context** is the heart of Nexus Framework. It replaces the traditional `req` and `res` pattern with a single, unified, immutable object that contains all request and response data.
-## Why Context?
-### Traditional Express.js
-```javascript
-app.get('/user/:id', (req, res) => {
-  const id = req.params.id;
-  const user = getUser(id);
-  res.json({ user });
-});
-```
-### Nexus Framework
-```typescript
-app.get('/user/:id', async (ctx) => {
-  const user = await getUser(ctx.params.id);
-  return { user }; // Auto-converted to JSON
-});
-```
-**Benefits:**
-- ✅ Single source of truth
-- ✅ Immutability enables better testing
-- ✅ Type inference works naturally
-- ✅ Easier to extend with custom properties
-## Context Properties
-### Request Data
-#### `ctx.method`
-HTTP method of the request.
-```typescript
-app.get('/info', async (ctx) => {
-  return { method: ctx.method }; // "GET"
-});
-```
-#### `ctx.path`
-Path of the request (without query string).
-```typescript
-app.get('/api/users', async (ctx) => {
-  return { path: ctx.path }; // "/api/users"
-});
-```
-#### `ctx.url`
-Full URL object.
-```typescript
-app.get('/info', async (ctx) => {
-  return {
-    host: ctx.url.host,
-    protocol: ctx.url.protocol
-  };
-});
-```
-#### `ctx.params`
-Route parameters extracted from the path.
-```typescript
-app.get('/users/:id/posts/:postId', async (ctx) => {
-  const { id, postId } = ctx.params;
-  return { userId: id, postId };
-});
-```
-#### `ctx.query`
-Query string parameters.
-```typescript
-// GET /search?q=nexus&limit=10
-app.get('/search', async (ctx) => {
-  const { q, limit } = ctx.query;
-  return { query: q, limit: parseInt(limit) };
-});
-```
-#### `ctx.body`
-Parsed request body (POST, PUT, PATCH).
-```typescript
-app.post('/users', async (ctx) => {
-  const { name, email } = ctx.body;
-  return { received: { name, email } };
-});
-```
-**Automatic parsing for:**
-- `application/json`
-- `application/x-www-form-urlencoded`
-- `text/*`
-#### `ctx.headers`
-Request headers.
-```typescript
-app.get('/auth', async (ctx) => {
-  const token = ctx.headers.authorization;
-  const userAgent = ctx.headers['user-agent'];
-  return { token, userAgent };
-});
-```
-#### `ctx.cookies`
-Cookie management.
-```typescript
-app.get('/profile', async (ctx) => {
-  // Get cookie
-  const sessionId = ctx.cookies.get('session');
-  // Set cookie
-  ctx.cookies.set('visited', 'true', {
-    maxAge: 86400, // 1 day in seconds
-    httpOnly: true,
-    secure: true,
-    sameSite: 'strict'
-  });
-  // Delete cookie
-  ctx.cookies.delete('old-cookie');
-  return { sessionId };
-});
-```
-## Response Methods
-### `ctx.json(data)`
-Return JSON response.
-```typescript
-app.get('/user', async (ctx) => {
-  return ctx.json({
-    name: 'John',
-    email: 'john@example.com'
-  });
-});
-// Or simply return the object (auto-converted)
-app.get('/user', async (ctx) => {
-  return { name: 'John', email: 'john@example.com' };
-});
-```
-### `ctx.html(content)`
-Return HTML response.
-```typescript
-app.get('/page', async (ctx) => {
-  return ctx.html(`
-    <!DOCTYPE html>
-    <html>
-      <head><title>My Page</title></head>
-      <body><h1>Welcome!</h1></body>
-    </html>
-  `);
-});
-```
-### `ctx.text(content)`
-Return plain text response.
-```typescript
-app.get('/robots.txt', async (ctx) => {
-  return ctx.text('User-agent: *\nDisallow: /admin/');
-});
-```
-### `ctx.redirect(url, status?)`
-Redirect to another URL.
-```typescript
-app.get('/old-page', async (ctx) => {
-  return ctx.redirect('/new-page', 301); // Permanent redirect
-});
-app.get('/login', async (ctx) => {
-  return ctx.redirect('/auth/login'); // Default 302
-});
-```
-### `ctx.stream(readable)`
-Stream a response (for large files).
-```typescript
-import { createReadStream } from 'fs';
-app.get('/download', async (ctx) => {
-  const stream = createReadStream('./large-file.zip');
-  return ctx.stream(stream);
-});
-```
-## Response Builder
-Use the response builder for custom status codes and headers:
-```typescript
-app.get('/custom', async (ctx) => {
-  return ctx.response
-    .status(201)
-    .header('X-Custom-Header', 'value')
-    .json({ created: true });
-});
-```
-## Raw Node.js Objects
-Access raw Node.js objects when needed:
-```typescript
-app.get('/raw', async (ctx) => {
-  // Access raw request
-  const req = ctx.raw.req;
-  const contentLength = req.headers['content-length'];
-  // Access raw response
-  const res = ctx.raw.res;
-  res.setHeader('X-Custom', 'value');
-  return { contentLength };
-});
-```
-## Custom Context Properties
-Middleware can add custom properties to the context:
-```typescript
-// Middleware adds user
-const auth = async (ctx: any, next: any) => {
-  ctx.user = await authenticateUser(ctx.headers.authorization);
-  return next(ctx);
-};
-app.get('/profile', {
-  middlewares: [auth],
-  handler: async (ctx: any) => {
-    // ctx.user is now available
-    return { user: ctx.user };
-  }
-});
-```
-For type-safe custom properties, see [Middleware Documentation](./04-middleware.md).
-## Context Pooling
-Nexus automatically pools context objects for performance. You don't need to do anything - it's built-in!
-**Performance benefit:** ~60-80% reduction in object allocations.
-```typescript
-// Get pool statistics
-const app = createApp();
-// ... after some requests
-const stats = app.getPoolStats();
-console.log(stats);
-// {
-//   poolSize: 50,
-//   maxSize: 100,
-//   created: 150,
-//   reused: 100,
-//   hitRate: 0.67
-// }
-```
-## Best Practices
-### ✅ DO: Return data directly
-```typescript
-app.get('/users', async (ctx) => {
-  const users = await getUsers();
-  return { users };
-});
-```
-### ❌ DON'T: Mutate the context
-```typescript
-// BAD - context is immutable
-app.get('/bad', async (ctx) => {
-  ctx.path = '/new-path'; // Won't work!
-});
-```
-### ✅ DO: Use typed custom properties
-```typescript
-interface AuthContext extends Context {
-  user: User;
-}
-const handler = async (ctx: AuthContext) => {
-  return { userId: ctx.user.id }; // Type-safe!
-};
-```
-### ✅ DO: Use cookies for session management
-```typescript
-app.post('/login', async (ctx) => {
-  const user = await authenticate(ctx.body);
-  ctx.cookies.set('session', user.sessionId, {
-    httpOnly: true,
-    secure: true,
-    sameSite: 'strict',
-    maxAge: 86400
-  });
-  return { success: true };
-});
-```
-## Next Steps
-- 🛤️ [Routing Guide](./03-routing.md) - Learn about routing
-- 🔌 [Middleware](./04-middleware.md) - Extend context with middleware
-- ✅ [Validation](./05-validation.md) - Validate context data
----
-[← Getting Started](./01-getting-started.md) | [API Reference →](./09-api-reference.md)

package/documentation/03-routing.md DELETED Viewed

@@ -1,397 +0,0 @@
-# Routing Guide
-## Overview
-Nexus uses a **Radix Tree** for routing, providing O(log n) lookup performance. The routing system supports static routes, dynamic parameters, and wildcards.
-## Basic Routes
-### Static Routes
-```typescript
-app.get('/about', async (ctx) => {
-  return { page: 'about' };
-});
-app.get('/api/users', async (ctx) => {
-  return { users: [] };
-});
-```
-### HTTP Methods
-```typescript
-app.get('/resource', async (ctx) => {
-  return { method: 'GET' };
-});
-app.post('/resource', async (ctx) => {
-  return { method: 'POST', body: ctx.body };
-});
-app.put('/resource/:id', async (ctx) => {
-  return { method: 'PUT', id: ctx.params.id };
-});
-app.patch('/resource/:id', async (ctx) => {
-  return { method: 'PATCH', id: ctx.params.id };
-});
-app.delete('/resource/:id', async (ctx) => {
-  return { method: 'DELETE', id: ctx.params.id };
-});
-```
-## Dynamic Routes
-### Single Parameter
-```typescript
-app.get('/users/:id', async (ctx) => {
-  const userId = ctx.params.id;
-  const user = await getUser(userId);
-  return { user };
-});
-```
-### Multiple Parameters
-```typescript
-app.get('/users/:userId/posts/:postId', async (ctx) => {
-  const { userId, postId } = ctx.params;
-  const post = await getPost(userId, postId);
-  return { post };
-});
-```
-### Parameter Naming
-Use descriptive parameter names:
-```typescript
-// Good
-app.get('/articles/:articleId/comments/:commentId', ...);
-// Avoid
-app.get('/articles/:id1/comments/:id2', ...);
-```
-## Wildcard Routes
-Capture the remaining path with `*`:
-```typescript
-app.get('/files/*filepath', async (ctx) => {
-  const filepath = ctx.params.filepath;
-  // filepath = "docs/guide/intro.md" for /files/docs/guide/intro.md
-  return { filepath };
-});
-app.get('/proxy/*', async (ctx) => {
-  const path = ctx.params.wildcard; // default name
-  return { proxiedPath: path };
-});
-```
-## Route Priority
-Routes are matched in this order:
-1. **Static** - Exact matches
-2. **Parameters** - Dynamic segments (`:param`)
-3. **Wildcards** - Catch-all (`*`)
-```typescript
-app.get('/users/active', ...);      // 1. Matched first
-app.get('/users/:id', ...);         // 2. Matched second
-app.get('/users/*', ...);           // 3. Matched last
-```
-Example:
-- `/users/active` → matches static route
-- `/users/123` → matches parameter route
-- `/users/admin/settings` → matches wildcard route
-## Declarative Route Definition
-Use the `route()` method for advanced configuration:
-```typescript
-import { z } from 'zod';
-app.route({
-  method: 'POST',
-  path: '/api/users',
-  // Schema validation
-  schema: {
-    body: z.object({
-      name: z.string().min(2),
-      email: z.string().email()
-    })
-  },
-  // Middleware
-  middlewares: [authenticate, rateLimit],
-  // Handler
-  handler: async (ctx) => {
-    const user = await createUser(ctx.body);
-    return { user };
-  },
-  // Metadata (for documentation)
-  meta: {
-    description: 'Create a new user',
-    tags: ['users'],
-    responses: {
-      201: 'User created',
-      400: 'Validation error'
-    }
-  }
-});
-```
-## Route Groups
-Organize routes by creating separate router modules:
-### `routes/users.ts`
-```typescript
-import { Router } from '../nexus';
-export const userRoutes = (app: Application) => {
-  app.get('/users', async (ctx) => {
-    return { users: await getUsers() };
-  });
-  app.get('/users/:id', async (ctx) => {
-    return { user: await getUser(ctx.params.id) };
-  });
-  app.post('/users', {
-    schema: { /* ... */ },
-    handler: async (ctx) => { /* ... */ }
-  });
-};
-```
-### `index.ts`
-```typescript
-import { createApp } from './nexus';
-import { userRoutes } from './routes/users';
-import { postRoutes } from './routes/posts';
-const app = createApp();
-userRoutes(app);
-postRoutes(app);
-app.listen(3000);
-```
-## Route Prefixes
-Create prefixed route groups:
-```typescript
-const createAPIRoutes = (app: Application, prefix: string) => {
-  app.get(`${prefix}/users`, ...);
-  app.get(`${prefix}/posts`, ...);
-  app.get(`${prefix}/comments`, ...);
-};
-createAPIRoutes(app, '/api/v1');
-createAPIRoutes(app, '/api/v2');
-```
-## Query Parameters
-Access query parameters via `ctx.query`:
-```typescript
-// GET /search?q=nexus&page=2&limit=20
-app.get('/search', async (ctx) => {
-  const query = ctx.query.q;
-  const page = parseInt(ctx.query.page) || 1;
-  const limit = parseInt(ctx.query.limit) || 10;
-  const results = await search(query, page, limit);
-  return { results, page, limit };
-});
-```
-### Type-Safe Query Validation
-```typescript
-import { z } from 'zod';
-app.get('/search', {
-  schema: {
-    query: z.object({
-      q: z.string().min(1),
-      page: z.string().regex(/^\d+$/).transform(Number).default('1'),
-      limit: z.string().regex(/^\d+$/).transform(Number).default('10')
-    })
-  },
-  handler: async (ctx) => {
-    // ctx.query is now typed and validated
-    const { q, page, limit } = ctx.query;
-    return await search(q, page, limit);
-  }
-});
-```
-## 404 Not Found
-Nexus automatically returns 404 for unmatched routes:
-```json
-{
-  "error": "Not Found"
-}
-```
-Custom 404 handler:
-```typescript
-// Add a wildcard route at the end
-app.get('/*', async (ctx) => {
-  return ctx.response.status(404).json({
-    error: 'Page not found',
-    path: ctx.path
-  });
-});
-```
-## Route Introspection
-Get all registered routes:
-```typescript
-const routes = app.getRoutes();
-console.log(routes);
-// [
-//   { method: 'GET', path: '/users' },
-//   { method: 'GET', path: '/users/:id' },
-//   { method: 'POST', path: '/users' }
-// ]
-```
-Useful for:
-- Generating API documentation
-- Debugging route conflicts
-- Creating route lists
-## Best Practices
-### ✅ DO: Use RESTful conventions
-```typescript
-app.get('/users', ...);           // List users
-app.get('/users/:id', ...);       // Get user
-app.post('/users', ...);          // Create user
-app.put('/users/:id', ...);       // Update user (full)
-app.patch('/users/:id', ...);     // Update user (partial)
-app.delete('/users/:id', ...);    // Delete user
-```
-### ✅ DO: Version your API
-```typescript
-app.get('/api/v1/users', ...);
-app.get('/api/v2/users', ...);
-```
-### ✅ DO: Use specific routes before wildcards
-```typescript
-// Correct order
-app.get('/admin/dashboard', ...);
-app.get('/admin/*', ...);
-// Wrong order - dashboard will never be reached
-app.get('/admin/*', ...);
-app.get('/admin/dashboard', ...);
-```
-### ❌ DON'T: Create ambiguous routes
-```typescript
-// Ambiguous - which route matches /users/123?
-app.get('/users/:id', ...);
-app.get('/users/:userId', ...);  // Same as above!
-```
-### ✅ DO: Use consistent naming
-```typescript
-// Good
-app.get('/users/:userId', ...);
-app.get('/users/:userId/posts/:postId', ...);
-// Inconsistent
-app.get('/users/:id', ...);
-app.get('/users/:userId/posts/:pid', ...);
-```
-## Performance
-### Route Matching
-Nexus uses a **Radix Tree** for O(log n) route lookup:
-```typescript
-// Fast - even with 1000+ routes
-app.get('/api/v1/users/:id', ...);
-// Lookup time: ~0.001ms
-```
-### Route Compilation
-Routes are compiled at startup for optimal performance:
-```typescript
-const app = createApp({
-  enableJIT: true  // Enable JIT compilation (default)
-});
-```
-## Advanced Patterns
-### Optional Parameters
-Use query parameters for optional data:
-```typescript
-// GET /users?role=admin&active=true
-app.get('/users', async (ctx) => {
-  const filters = {
-    role: ctx.query.role,
-    active: ctx.query.active === 'true'
-  };
-  return await getUsers(filters);
-});
-```
-### File Extensions
-```typescript
-app.get('/download/:filename', async (ctx) => {
-  const filename = ctx.params.filename;
-  // filename includes extension: "document.pdf"
-  return ctx.stream(createReadStream(filename));
-});
-```
-## Next Steps
-- ✅ [Schema Validation](./05-validation.md) - Validate route parameters
-- 🔌 [Middleware](./04-middleware.md) - Add route-specific middleware
-- 🔒 [Error Handling](./06-error-handling.md) - Handle route errors
----
-[← Context API](./02-context.md) | [Middleware →](./04-middleware.md)