Esta librería está pensada para ser utilizada en NestJS Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• 👨‍💻 Uso
• 📦 Paquetes re-exportados
• 📄 Changelog
• 📜 License MIT

📝 Requerimientos básicos

• NestJS Starter
• Node.js v22.21.1 or higher (Download)
• YARN ≥ 1.22.22 o NPM ≥ 11.6.4
• NestJS v11.1.11 or higher (Documentación)

🛠️ Instalar dependencia

npm install -S @tresdoce-nestjs-toolkit/paas

yarn add @tresdoce-nestjs-toolkit/paas

📦 Dependencias internas

Este paquete re-exporta los siguientes paquetes del toolkit:

| Paquete | Razón | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | @tresdoce-nestjs-toolkit/core | Tipos Typings.AppConfig, decoradores base y utilidades comunes | | @tresdoce-nestjs-toolkit/filters | Función buildErrorPayload y tipos de error normalizados | | @tresdoce-nestjs-toolkit/health | Endpoints /health/liveness y /health/readiness | | @tresdoce-nestjs-toolkit/rate-limit | Throttling de requests vía RateLimitModule | | @tresdoce-nestjs-toolkit/response-parser | Interceptor ResponseInterceptor para formateo de respuestas | | @tresdoce-nestjs-toolkit/tracing | Decorador @SkipTrace y contexto de OpenTelemetry | | @tresdoce-nestjs-toolkit/utils | Servicios FormatService, RedactService y BcryptService |

👨‍💻 Uso

@tresdoce-nestjs-toolkit/paas es una librería de re-exportación centralizada que agrupa en un único punto de entrada todos los paquetes esenciales para construir aplicaciones con el NestJS Starter. Al instalar paas, obtienes acceso directo a todos sus símbolos sin necesidad de instalar cada paquete por separado.

// Importar desde un único punto de entrada
import {
  // desde @tresdoce-nestjs-toolkit/core
  Typings,
  CsrfMiddleware,
  // desde @tresdoce-nestjs-toolkit/filters
  ExceptionsFilter,
  // desde @tresdoce-nestjs-toolkit/health
  HealthModule,
  // desde @tresdoce-nestjs-toolkit/response-parser
  ResponseInterceptor,
  // desde @tresdoce-nestjs-toolkit/tracing
  TracingModule,
  TracingService,
  TracingInterceptor,
  // desde @tresdoce-nestjs-toolkit/utils
  RedactModule,
  RedactService,
  FormatModule,
  FormatService,
  BcryptModule,
  BcryptService,
} from '@tresdoce-nestjs-toolkit/paas';

Ejemplo en AppModule

// ./src/app.module.ts
import {
  HealthModule,
  ExceptionsFilter,
  ResponseInterceptor,
  TracingModule,
  RedactModule,
  FormatModule,
  BcryptModule,
} from '@tresdoce-nestjs-toolkit/paas';
import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';

@Module({
  imports: [HealthModule, TracingModule, RedactModule, FormatModule, BcryptModule],
  providers: [
    { provide: APP_FILTER, useClass: ExceptionsFilter },
    { provide: APP_INTERCEPTOR, useClass: ResponseInterceptor },
  ],
})
export class AppModule {}

📦 Paquetes re-exportados

@tresdoce-nestjs-toolkit/paas re-exporta íntegramente los siguientes paquetes. Para conocer la configuración detallada de cada uno, referirse a su README correspondiente:

| Paquete | Descripción | README | | ------------------------------------------ | ----------------------------------------------------------------------------- | ------------------------------ | | @tresdoce-nestjs-toolkit/core | Funcionalidades a nivel core: typings, decoradores, validaciones, middlewares | Ver docs | | @tresdoce-nestjs-toolkit/filters | Filtro global de excepciones HTTP | Ver docs | | @tresdoce-nestjs-toolkit/health | Health check endpoints con @nestjs/terminus | Ver docs | | @tresdoce-nestjs-toolkit/response-parser | Interceptor para estandarizar la estructura de respuestas | Ver docs | | @tresdoce-nestjs-toolkit/tracing | Tracing distribuido con OpenTelemetry | Ver docs | | @tresdoce-nestjs-toolkit/utils | Utilidades: Redact, Format, Bcrypt | Ver docs |

Resumen de símbolos disponibles por sub-paquete

@tresdoce-nestjs-toolkit/core

• Namespace: Typings — tipos y tipados de la aplicación (AppConfig, etc.)
• Commons: utilidades y helpers a nivel core
• Decoradores: decoradores reutilizables
• Validaciones: helpers de validación con Joi

@tresdoce-nestjs-toolkit/filters

• ExceptionsFilter — filtro global de excepciones HTTP
• Constantes y tipos de errores

@tresdoce-nestjs-toolkit/health

• HealthModule — módulo de health checks

@tresdoce-nestjs-toolkit/response-parser

• ResponseInterceptor — interceptor para estandarizar respuestas

@tresdoce-nestjs-toolkit/tracing

• TracingModule — módulo de tracing con OpenTelemetry
• TracingService — servicio de tracing
• TracingInterceptor — interceptor de tracing
• Decoradores de tracing

@tresdoce-nestjs-toolkit/utils

• RedactModule / RedactService — ofuscamiento de datos sensibles
• FormatModule / FormatService — formateo de números y fechas
• BcryptModule / BcryptService — encriptación con bcrypt
• Constantes: DEFAULT_TIMEZONE, DEFAULT_LOCALE, DEFAULT_TIMEZONE_LOCALE, etc.
• Interfaces: RedactOptions, BcryptOptions, FormatNumberOptions, etc.

📄 Changelog

Todos los cambios notables de este paquete se documentarán en el archivo Changelog.