ibfc_tools v4.5.20

IBFC Tools

Este pacote (que deve ser instalado com o NPM) é um acumulado de serviços utilitários e models para serem utilizados nos projetos do IBFC.

Instalação

npm install git+ssh://git@172.16.100.152:ibfc/ibfc_tools

O comando acima requer que haja uma chave SSH cadastrada no GitLab. Para gerar uma chave SSH, execute os seguintes passos

1. Gere a chave SSH utilizando o seu terminal local rodando o comando abaixo em qualquer diretório.

   ssh-keygen -t ed25519 -C  "email@example.com"  

2. Abra o arquivo .PUB gerado no passo acima (ex. bloco de notas) e copie o seu conteúdo (CTRL + C).

3. Cole o conteúdo copiado no GitLab (Settings / SSH Keys / Key) e clique em "Add key".

Utilização

const algumServico = require("ibfc_tools").services.nomeServico();
const algumaModel = require("ibfc_tools").models.nomeModel();

Serviços

Este pacote possui serviços utilitários de extrema importância para o fluxo de trabalho dos microserviços do projeto. Dentre eles:

• Auth: utilizado para autenticação do usuário
• Db: instância do banco de dados nas aplicações (utiliza Sequelize)
• Error: manipulador de erros das aplicações
• Logging: sistema de logs
• Permission: gerenciamento de permissões
• Request: encapsulamento de operações de requisição
• Validation: utilidades para validação

Ex. Importação: require("ibfc_tools").services.auth()

Ex. Localização: /services/auth.js

Obs: todas as funções dos serviços possuem DocBlocks que podem e devem ser consultados para a utilização de suas funções.

Models

As models do projeto são encontradas neste pacote. Todas as models devem ser implementadas, atualizadas e/ou removidas diretamente neste pacote.

Ex. Importação: require("ibfc_tools").models.ControleDeAcessoUsuario()

Ex. Localização: /models/ControleDeAcessoUsuario.js

Obs: para a criação de novas models, utilize o padrão utilizado na ControleDeAcessoUsuario (ajustando a definição das colunas conforme necessário).