v0.5.0

[tkoehlerlg]

Add CommonJS Support for NestJS Compatibility

Summary

Adds dual module support (ESM + CommonJS) to make the SDK compatible with CommonJS-based frameworks like NestJS while maintaining backward compatibility with ESM projects.

Changes

1. Package Configuration (package.json)

• Dual exports: Added both import (ESM) and require (CJS) conditions
• Module fields:
  • main → ./dist/index.cjs (CJS for legacy/CommonJS)
  • module → ./dist/index.js (ESM for modern bundlers)
  • types → Separate type definitions for each format
• Build scripts: Refactored into modular commands
  • build:types - Generate TypeScript declarations
  • build:esm - Build ESM bundle
  • build:cjs - Build CommonJS bundle
  • build - Run all three in sequence
• Version: Bumped to 0.5.0 (minor version for new functionality)

2. Build Output (dist/)

• index.js - ESM bundle
• index.cjs - CommonJS bundle
• index.d.ts - ESM type declarations
• index.d.cts - CommonJS type declarations

3. Compatibility Tests (tests/compatibility.test.ts)

New comprehensive test suite with 13 tests validating:

• ESM imports: Bundle loading, exports, class instantiation
• CommonJS imports: Bundle loading via require(), exports, class instantiation
• Cross-module consistency: Identical APIs and behavior between ESM/CJS
• TypeScript definitions: Valid type declarations for both formats
• Build check: Fails fast with clear error if dist files missing

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!