@moostjs/arbac

Advanced Role-Based Access Control (ARBAC) integration for MoostJS, enabling seamless authorization management with @prostojs/arbac while leveraging Moost's dependency injection and metadata-driven event processing capabilities.

Features

- MoostJS Integration – Provides decorators and utilities for enforcing access control.
- Role & Scope-Based Authorization – Supports fine-grained access control based on user roles and attributes.
- Dependency Injection Support – Utilizes MoostJS's DI system for injecting ARBAC services.
- Easy Decorators – Define resource-based access rules with simple decorators.

Installation

``sh
npm install @moostjs/arbac
`

or using pnpm:

`sh
pnpm i @moostjs/arbac
`

Quick Start

$3

To integrate ARBAC into your MoostJS application, define an instance of MoostArbac, register roles, and provide it as a dependency.

`typescript
import { createProvideRegistry } from 'moost'
import { MoostArbac } from '@moostjs/arbac'
import * as roles from './roles'
import type { TRoleScope, TUserAttrs } from './types'

export const ArbacProvideRegistry = createProvideRegistry([
MoostArbac,
() => {
const instance = new MoostArbac()
for (const role of roles) {
instance.registerRole(role)
}
return instance
},
])
`

$3

To integrate user attributes and roles dynamically, replace the generic ArbacUserProvider with an application-specific implementation.

`typescript
import { createReplaceRegistry } from 'moost'
import { ArbacUserProvider } from '@moostjs/arbac'
import { CustomUserProvider } from './custom-user-provider'

export const ArbacReplaceRegistry = createReplaceRegistry([ArbacUserProvider, CustomUserProvider])
`

$3

`typescript
import { App } from 'moost'
import { ArbacProvideRegistry, ArbacReplaceRegistry } from './arbac-setup'

const app = new App()
app.setProvideRegistry(ArbacProvideRegistry)
app.setReplaceRegistry(ArbacReplaceRegistry)
`

$3

`typescript
import { Authorized, Public } from '@moostjs/arbac'
import { Controller, Get } from 'moost'

@Controller('/data')
@ArbacAuthorized()
export class DataController {
@Get()
getProtectedData() {
return { data: 'secured' }
}

@Get('/public')
@ArbacPublic()
getPublicData() {
return { data: 'open' }
}
}
`

API

$3

Extends @prostojs/arbac` and integrates with MoostJS DI.

$3

Abstract class for defining user-related access control logic.

$3

Method decorator to enforce ARBAC checks.

$3

Marks a route as publicly accessible, bypassing authorization.

$3

Composable function for evaluating access control dynamically.

License

MIT