@cartoriocriciuma/rbac-backend v1.0.0-alpha.2

@cartoriocriciuma/rbac-backend

Backend para o sistema RBAC centralizado.

Descrição

Este pacote fornece os componentes de backend para um sistema de Controle de Acesso Baseado em Funções (RBAC) para arquiteturas de microfrontends. Implementa uma abordagem baseada em adaptadores que permite integração com diferentes tecnologias de persistência e frameworks.

Instalação

npm install @cartoriocriciuma/rbac-backend @cartoriocriciuma/rbac-types

Componentes Principais

Adaptadores

Interfaces para integração com diferentes tecnologias:

• StorageAdapter: Para persistência de dados
• LoggerAdapter: Para logging
• EventEmitterAdapter: Para comunicação via eventos

Repositórios

Camada de acesso a dados:

• PermissionsRepository: Gerenciamento de permissões e grupos
• RolesRepository: Gerenciamento de papéis e suas permissões
• ManifestRepository: Gerenciamento de manifestos de permissões

Serviços

Lógica de negócio:

• PermissionsService: Gerenciamento de permissões
• RolesService: Gerenciamento de papéis
• ManifestService: Processamento de manifestos

Integração com NestJS

Componentes para integração com NestJS:

• Decorador @RequirePermission(): Protege rotas com permissão única
• Decorador @RequirePermissions(): Protege rotas com múltiplas permissões
• Guarda PermissionGuard: Implementa verificação de permissões

Utilitários

Funções auxiliares:

• Verificação de permissões
• Manipulação de códigos de permissão
• Agrupamento de permissões

Exemplos de Uso

Configuração Básica (NestJS)

// app.module.ts
import { Module } from '@nestjs/common';
import { 
  PermissionsService, 
  RolesService,
  StorageAdapter,
  PermissionsRepository,
  RolesRepository
} from '@cartoriocriciuma/rbac-backend';
import { MongoPermissionStorage } from './adapters/MongoPermissionStorage';

@Module({
  providers: [
    {
      provide: StorageAdapter,
      useClass: MongoPermissionStorage
    },
    PermissionsRepository,
    RolesRepository,
    PermissionsService,
    RolesService
  ],
  exports: [
    PermissionsService,
    RolesService
  ]
})
export class RbacModule {}

Proteção de Rotas (NestJS)

// users.controller.ts
import { Controller, Get, UseGuards } from '@nestjs/common';
import { 
  RequirePermission,
  RequirePermissions,
  PermissionsStrategy,
  PermissionGuard 
} from '@cartoriocriciuma/rbac-backend';
import { AuthGuard } from './auth.guard';

@Controller('users')
export class UsersController {
  @Get()
  @UseGuards(AuthGuard, PermissionGuard)
  @RequirePermission('users:view')
  findAll() {
    // Só é executado se o usuário tem a permissão 'users:view'
    return this.usersService.findAll();
  }
  
  @Get('/reports')
  @UseGuards(AuthGuard, PermissionGuard)
  @RequirePermissions({
    permissions: ['reports:view', 'users:view'],
    strategy: PermissionsStrategy.ALL
  })
  getReports() {
    // Só é executado se o usuário tem ambas as permissões
    return this.reportsService.getUserReports();
  }
}

Serviços e Repositórios

// Exemplo de uso do serviço de permissões
import { Injectable } from '@nestjs/common';
import { PermissionsService } from '@cartoriocriciuma/rbac-backend';

@Injectable()
export class AppService {
  constructor(private permissionsService: PermissionsService) {}
  
  async createPermission() {
    return this.permissionsService.createPermission({
      codigo: 'users:create',
      name: 'Criar Usuários',
      description: 'Permite criar novos usuários no sistema',
      recurso: 'users',
      acao: 'create'
    });
  }
}

Licença

ISC