BKS.Padrao

A BKS.Padrao nasceu da ideia do nosso querido @lmatos com o objetivo de unificar regras e modelos de negócio comum aos Fronts Cartao e Consig, evitando a necessidade de criação e manutenção de código em duas bibliotecas (BKS.Cartao e BKS.Consig).

Desde a sua criação ela evoluiu e é utilizada hoje por vários módulos, como BKS.ApiCommons.

Ela se diferencia da BKS.Util que é mais genérica, voltada mais para utilidades para o desenvolvedores, com facilitadores baseados em tipos c# e nem tanto a regras de negócio especificas BKS, mesmo que ainda possam existir.

Este projeto contém uma série de funcionalidades úteis comuns aos produtos BKS Cartão e Consig/FGTS com foco em exceções, validações, modelos de dados, tipos e interfaces.

Estrutura do Projeto

Aqui está o que você vai encontrar nas pastas principais:

lib/

• Exceptions: Definição de exceções personalizadas como UnauthorizedException, NotFoundException e mais, para um controle melhor sobre erros e suas respostas.
• Interfaces: Interfaces úteis para os serviços e modelos, como ILogApiService e IBksException.
• Modelos: Contém as classes de modelos principais, como MensagemUsuario, OutputErrorApi e outros objetos de domínio.
• Modelos/Esteira: Envelope (EsteiraModeloArquivo), modelo (EsteiraModelo) e atividade (EsteiraAtividadeArquivo) do contrato compartilhado de importação/exportação de modelos de esteira entre Cartão e Consignado.
• Tipos: Tipos e enumerações gerais como TipoEndereco, TipoTelefone e TipoOperadora.
• Validators: Contém validadores baseados no FluentValidation, incluindo validação de endereços e telefones.

tests/

• Testes unitários para garantir o funcionamento correto das exceções, validadores e métodos da biblioteca.

Arquivos de Configuração

• .gitignore para ignorar arquivos desnecessários.
• .gitlab-ci.yml para configuração de CI/CD com GitLab.
• lib/BKS.Padrao.csproj concentra os metadados e a geração do pacote NuGet.

Funcionalidades

• Gerenciamento de Exceções: Fácil tratamento de erros e mensagens para o usuário, com suporte a exceções específicas e mensagens de erro formatadas.
• Contrato de esteira: Servicos/Esteira/EsteiraImportExportService serializa, desserializa e valida o arquivo JSON versionado (BKS.ESTEIRA.MODELO) de modelos de esteira, usado tanto pelo Cartão quanto pelo Consignado.
• Validação: Validação robusta de dados com o uso do FluentValidation para garantir que informações como endereços e telefones estejam corretas.
• Modelos e Tipos Comuns: Definições de tipos e modelos comuns para facilitar a construção de sistemas com uma base consistente.
• Licenciamento em runtime: validação compartilhada para os hosts consumidores. Consulte a documentação de licenciamento.

Como Usar

1. Clone o repositório para sua máquina local.
2. Adicione o projeto ao seu sistema e comece a usar as classes e funções para tratar exceções, validar dados e modelar suas entidades.
3. Para testar, execute os testes unitários presentes na pasta tests/.

Como Usar

1. Adicionar o Feed NuGet Privado: Adicione o feed NuGet privado à sua configuração de projeto para acessar o pacote BKS.Padrao. Você pode seguir o guia de configuração do feed NuGet nesse link

2. Instalar o Pacote NuGet: Após adicionar o feed, basta instalar o pacote BKS.Padrao no seu projeto. Você pode fazer isso executando o seguinte comando no Package Manager Console:

   Install-Package BKS.Padrao
   

3. Usar no Projeto: Após a instalação, você pode começar a usar as exceções, validadores e modelos disponíveis, conforme necessário no seu código.

4. Testar: Execute os testes unitários presentes na pasta tests/ para garantir que tudo esteja funcionando conforme esperado.

Como submódulo

A BKS.Padrao passou a ser utilizada não apenas como um pacote NuGet, mas também como submódulo Git dentro dos repositórios:

• Front Consig
• Front Cartão (em breve)
• BKS.ApiCommons (em breve)

Essa mudança tem como principal objetivo agilizar o desenvolvimento, facilitar a manutenção e melhorar a experiência de quem consome a biblioteca, permitindo que ela seja editada diretamente na mesma solution dos fronts.

https://git.banksofttecnologia.com.br/biblioteca/BPOPadrao/-/wikis/home#bkspadrao-como-subm%C3%B3dulo-nos-fronts-e-commons

Contribuindo

Se você quiser contribuir com melhorias ou correções, fique à vontade para abrir um MR ou issue.