Pular para o conteúdo principal
lib-commons-js é uma biblioteca Node.js baseada em TypeScript desenvolvida pela Lerian Studio. Ela reúne blocos de construção comuns da nossa , tornando-os reutilizáveis em diferentes aplicações em um ambiente JavaScript. Ela funciona tanto em projetos frontend quanto em projetos backend Node.js. O objetivo é ajudar você a escrever menos boilerplate, manter a consistência e reutilizar o que já funciona — tudo de forma modular. Seja construindo um plugin, um serviço ou uma integração de UI, esta biblioteca ajuda você a avançar mais rápido e evitar surpresas pelo caminho.

​
Quando usar

Use lib-commons-js sempre que precisar de lógica compartilhada que foi testada no ecossistema da Lerian. É especialmente útil quando você quer:
  • Integrar com o Midaz.
  • Compartilhar modelos de dados entre serviços.
  • Reduzir boilerplate em projetos TypeScript.

​
Funcionalidades principais

  • Arquitetura modular: Importe apenas os componentes que você precisa para manter seu projeto limpo e focado.
  • Suporte a TypeScript: Escrita em TypeScript desde o início para uma melhor experiência de desenvolvimento e segurança de tipos.
  • Utilitários core: Helpers prontos para uso para logging, tratamento de contexto, gerenciamento de erros e processamento de transações.
  • Modelos compartilhados: Modelos de dados centralizados que garantem consistência entre projetos.
  • Lógica de negócio: Regras e padrões comuns usados por múltiplos serviços do Midaz, encapsulados e prontos para uso.

​
Estrutura do repositório

O repositório é organizado para clareza e uso modular:
  • commons/: Módulos e utilitários core.
  • Arquivos de configuração: Inclui .eslintrc.js, .prettierrc e tsconfig.json para garantir qualidade de código.
  • Gerenciamento de pacotes: Gerenciado via package.json e package-lock.json.
  • Integração contínua: Releases automatizados configurados com workflows .github/ e .releaserc.yml.

​
Primeiros passos

​
Requisitos

Você precisará do Node.js v23 ou posterior para usar esta biblioteca.

​
1. Instale a biblioteca

npm install @lerian/lib-commons-js

​
2. Adicione a biblioteca ao seu projeto

Para usar lib-commons-js, importe o subpacote relevante no arquivo onde você precisa dele. As funções estarão disponíveis através do import nomeado: 
import { transactions as lib } from '@lerian/lib-commons-js'

​
Contribuindo

Contribuições são bem-vindas. Se você escreveu lógica que poderia beneficiar outros serviços, vamos trazê-la para a lib-commons-js. Certifique-se de que seu código segue nossos padrões e inclui cobertura de testes.

​
Licença

  • Elastic License 2.0 - consulte a página de LICENSE para detalhes.