@vperms/nest
v0.0.6
Published
NestJS integration for VeguiPerms.
Maintainers
Readme
VeguiPerms NestJS
@vperms/nest integrates VeguiPerms with NestJS 11 through a dynamic module,
global guard, permission decorators and request-context parameter decorators.
NestJS guide · API reference · GitHub
Install
In an existing NestJS 11 application:
npm install @vperms/nest vpermsRegister the module and protect a controller
import { Controller, Get, Module } from "@nestjs/common";
import { Permission, VPermsModule } from "@vperms/nest";
import { createVPerms, VeguiPermsMemoryAdapter } from "vperms";
const adapter = new VeguiPermsMemoryAdapter();
const perms = createVPerms({ adapter });
@Controller("posts")
class PostsController {
@Get()
@Permission("posts.read")
list() {
return [];
}
}
@Module({
imports: [VPermsModule.forRoot({
adapter,
workspace: perms.workspaceId,
resolver: () => null, // replace with your authenticated subject ID
})],
controllers: [PostsController],
})
export class AppModule {}Grant permissions with perms.setPermission(subject, permission, value) using
the same adapter and default root workspace. @Permission()
requires all listed permissions; @AnyPermission() requires one. The global guard
hydrates request state, but only permission metadata makes a route restricted.
Use @Ability(), @Subject() and @Kind() to access the hydrated context.
Enable TypeScript's experimentalDecorators and emitDecoratorMetadata options.
Build and coverage badges describe the whole VeguiPerms repository. License: MIT.
