najm-middleware

najm-middleware

Middleware plugin for the Najm framework with decorator support.

Features

• Context storage middleware (Hono's async local storage)
• Request context middleware with ALS (Async Local Storage) integration
• User functional middleware support
• DI support in middleware classes
• Order-based execution system
• Path-based middleware application
• Decorator support with @Middleware() and @Use()

Installation

npm install najm-middleware

Usage

Basic (Auto-loaded)

// Server auto-loads middleware plugin
new Server()
  .load(MyController)
  .listen(3000);

With Functional Middleware

new Server()
  .middleware(cors(), compress(), helmet())
  .load(MyController)
  .listen(3000);

With @Middleware() Class

@Middleware({ order: 20, path: '/api/*' })
class AuthMiddleware {
  constructor(private auth: AuthService) {}

  async use(ctx: Context, next: Next) {
    const token = ctx.req.header('authorization');
    if (!token) throw new HttpError(401, 'Unauthorized');

    const user = await this.auth.verify(token);
    ctx.set('user', user);

    await next();
  }
}

new Server()
  .middleware(cors())
  .load(MyController, AuthMiddleware)
  .listen(3000);

With @Use() Decorator

@Service()
class MiddlewareConfig {
  @Use({ order: 10 })
  cors = cors({ origin: '*' });

  @Use({ order: 15 })
  compress = compress();

  @Use({ order: 20, path: '/api/*' })
  rateLimit = rateLimiter({ max: 100 });
}

new Server()
  .load(MyController, MiddlewareConfig)
  .listen(3000);

With Plugin Config

new Server()
  .use(middleware({
    debug: true,
    requestIdHeader: 'x-trace-id',
    exclude: ['/health', '/metrics'],
    use: [cors(), helmet()],
  }))
  .load(MyController)
  .listen(3000);

Execution Order

Order	Source	Example
1	Core	context-storage
2	Core	request-context (ALS)
10-49	Reserved	Future core middleware
50+	.middleware()	cors, compress, helmet
60+	.use(middleware({ use: [...] }))	Config middleware
100+	@Middleware()	AuthMiddleware
100+	@Use()	Property middleware

License

MIT