| name | hive-middleware |
| description | How to create and use middlewares in Hive framework |
| globs | ["src/middlewares/*.js"] |
| alwaysApply | false |
Middlewares
Location: /src/middlewares/{name}.js
Built-in Middlewares
| Name | Purpose |
|---|
allowNoAuth | Skip authentication |
isAuthorized | Require authenticated user |
shouldExist | Load resource, 404 if not found |
attachUser | Load user from token |
Creating Middleware
Simple:
export default async (ctx, next) => {
if (!ctx.state.user?.isAdmin) {
ctx.throw(403, 'Admin only');
}
return next();
};
With parameters:
export default (resourceName) => async (ctx, next) => {
const doc = await db.services[resourceName].findOne({
_id: ctx.params[`${resourceName}Id`],
});
if (!doc) ctx.throw(404, `${resourceName} not found`);
ctx.state[resourceName] = doc;
return next();
};
With runOrder (lower runs first):
const middleware = async (ctx, next) => {
ctx.state.isSkipAuth = true;
return next();
};
middleware.runOrder = -1;
export default middleware;
Using in Endpoints
export const middlewares = ['allowNoAuth'];
export const middlewares = [{ name: 'shouldExist', args: ['projects'] }];
import isAdmin from 'middlewares/isAdmin';
export const middlewares = [isAdmin];
import canEditProject from 'middlewares/canEditProject';
export const middlewares = [canEditProject((ctx) => ctx.params.projectId)];
export const middlewares = [
async (ctx, next) => {
return next();
},
];
Global Middleware
Create /src/middlewares/global.js to run on all endpoints:
import isAuthorized from 'middlewares/isAuthorized';
import attachRootProject from 'middlewares/attachRootProject';
export default async (ctx, next) => {
await isAuthorized(ctx, async () => {
await attachRootProject(ctx, next);
});
};
Rules
- Always call
next() or throw
- Use
runOrder to control execution order
- Factory functions for parameterized middlewares