0.0.28 • Published 3 years ago

@dslaporte/luizalabs_commons_nestjs v0.0.28

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
3 years ago

Luizalabs-commons-nestjs

O objetivo do pacote é a centralização do código para o desenvolvimento via Node.js + NestJS. O pacote propõe fornecer todas particularidades de customização de responses (de erros e sucessos), logs, autenticação de forma padronizada, fazendo com que quem deseja adotar o NestJS como solução de desenvolvimento, possa simplesmente fazer os imports, configurações e utilizar sem muita dificuldade. Sinta-se à vontade para contribuir com este projeto :)

Variáveis que devem ser exportadas para utilização do log via kibana:

APP_NAME = Nome do aplicativo (será exibido no log)

OWNER_NAME = Nome do proprietário do aplicativo (squad)

BURZUM_TOKEN = Token do burzum

BURZUM_HOST = Host do burzum/kibana (DEFAULT log.burzum.appsluiza.com.br)

BURZUM_PORT = Porta do burzum/kibana (DEFAULT 5030)

Modo de usar

Variáveis que devem ser exportadas para utilização da autenticação (JWT e Swagger)

AUTH_SECRET_KEY = Secret utilizada para geração do token

AUTH_USERS = Nome dos usuários/owners que possuem acesso ao seu microservice. Deve ser exportada entre vírgulas. EX: 'squad-carteira-outbound', 'squad-inbound', 'squad-armazenamento-enderecamento'

AUTH_USERS_APP = Nomes dos apps responsáveis por cada time, deve-se exportá-los como um array na posição de cada time. Ex: ['stockist-rules-api', 'stockist-orders-api], ['aba-digital'], ['cde-digital']. No exemplo dado, o primeiro array são os apps da primeira squad e os demais respsectivos das outras duas.

AUTH_ENABLED = Ativa/Desativa a autenticação

Modo de usar

Para uso, deve-se importar o módulo de autenticação dentro do módulo do app. Exemplo:

imports: [ AuthModule ]

Um dos requisitos é habilitar o parâmetro isGlobal dentro do seu ConfigModule, como a seguir:

ConfigModule.forRoot({
   isGlobal: true,
}),
Author: Daniel Sobrinho Laporte - daniel.laporte@luizalabs.com / @laporte