ODS Common Utils

A comprehensive utility library for Node.js applications, providing authentication, logging, and more.

Table of Contents

1. Features
2. Installation
3. Dependencies
4. Configuration
5. Basic Usage
6. Advanced Usage
7. Testing

Features

• Authentication

  • JWT token creation and verification
  • Role-based access control
  • Authentication middleware
  • Token blacklisting

• Logging

  • Winston-based logging
  • Daily rotation
  • Structured metadata
  • Error tracking

• Error Handling

  • Custom error classes
  • Express error middleware
  • Standardized error responses
  • Error tracking integration

• HTTP Response

  • Standardized API responses
  • Status code management
  • Response formatting
  • Headers management

• Validation

  • Schema validation using Joi
  • Custom validators
  • Validation middleware
  • Error formatting

Installation

npm install ods-common-utils

Dependencies

• Node.js >= 14.x

Configuration

Configuration can be provided via environment variables or a configuration object. See README-Examples.md for detailed configuration examples.

Basic Usage

See README-Examples.md for detailed code examples.

Advanced Usage

The library supports several advanced patterns and features:

1. Monitoring & Observability

   • Prometheus metrics integration
   • OpenTelemetry tracing
   • Health checks
   • Performance monitoring

2. Security Best Practices

   • Input validation
   • CSRF protection
   • Token management
   • Data encryption

3. Advanced Patterns

   • Event Sourcing
   • CQRS
   • Saga Pattern
   • Circuit Breaker

4. Deployment

   • Docker support
   • Kubernetes configurations
   • Health checks
   • Resource management

Testing

# Run all tests
npm test

# Run specific test suite
npm test -- --grep "ErrorHandler"

# Run tests with coverage
npm run test:coverage