Saltar al contenido principal
Funciona tanto en proyectos frontend como en backend Node.js. El objetivo es ayudarte a escribir menos código repetitivo, mantener las cosas consistentes y reutilizar lo que ya funciona—todo de manera modular. Ya sea que estés construyendo un plugin, un servicio o una integración de UI, esta biblioteca te ayuda a moverte más rápido y evitar sorpresas en el camino.

​
Cuándo usar

Usa lib-commons-js siempre que necesites lógica compartida que haya sido probada en el ecosistema de Lerian. Es especialmente útil cuando quieres:
  • Integrar con Midaz.
  • Compartir modelos de datos entre servicios.
  • Reducir código repetitivo en proyectos TypeScript.

​
Características clave

  • Arquitectura modular: Importa solo los componentes que necesitas para mantener tu proyecto limpio y enfocado.
  • Soporte TypeScript: Escrito en TypeScript desde cero para una mejor experiencia de desarrollador y seguridad de tipos.
  • Utilidades principales: Helpers listos para usar para logging, manejo de contexto, gestión de errores y procesamiento de transacciones.
  • Modelos compartidos: Modelos de datos centralizados que garantizan consistencia entre proyectos.
  • Lógica de negocio: Reglas y patrones comunes usados por múltiples servicios Midaz, empaquetados y listos para usar.

​
Estructura del repositorio

El repositorio está organizado para claridad y uso modular:
  • commons/: Módulos y utilidades principales.
  • Archivos de configuración: Incluye .eslintrc.js, .prettierrc y tsconfig.json para hacer cumplir la calidad del código.
  • Gestión de paquetes: Gestionado mediante package.json y package-lock.json.
  • Integración continua: Lanzamientos automatizados configurados con flujos de trabajo .github/ y .releaserc.yml.

​
Comenzando

​
Requisitos

Necesitarás Node.js v23 o posterior para usar esta biblioteca.

​
1. Instalar la biblioteca

npm install @lerian/lib-commons-js

​
2. Agregar la biblioteca a tu proyecto

Para usar lib-commons-js, importa el subpaquete relevante en el archivo donde lo necesitas. Las funciones estarán disponibles a través de la importación nombrada: 
import { transactions as lib } from '@lerian/lib-commons-js'

​
Contribuir

Damos la bienvenida a contribuciones. Si has escrito lógica que podría beneficiar a otros servicios, traigámosla a lib-commons-js. Asegúrate de que tu código siga nuestros estándares e incluya cobertura de pruebas.

​
Licencia

  • Apache 2.0 - consulta la página LICENSE para detalles.