Skip to content

v2.0.0 - modernization

Latest
Compare
Choose a tag to compare
@cbschuld cbschuld released this 05 Sep 17:40
· 2 commits to master since this release
2e12f57

🚀 v2.0.0: Major Modernization Release

This release modernizes uuid-base58 with enhanced browser support, updated tooling, and better package management while maintaining 100% API compatibility.

⚠️ Breaking Changes

  • Node.js 14+ required (was previously unspecified)
  • Package exports enforced - only documented import paths supported
  • ESM package type - may affect some bundler configurations

✨ Key Improvements

  • Enhanced browser support with Web Crypto API (faster, more secure)
  • Modern tooling: ESLint replaces deprecated TSLint, updated TypeScript/Jest/Prettier
  • Better package structure with proper dual CJS/ESM builds and export maps
  • Working browser example with Vite demonstrating real-world usage
  • Zero security vulnerabilities after dependency updates

🔄 Migration Guide

Most users need zero code changes:

  • API functions remain identical: uuid58(), encode(), decode(), valid(), uuidV4NoDash()
  • Import syntax unchanged: import { uuid58 } from 'uuid-base58'
  • CommonJS still works: const { uuid58 } = require('uuid-base58')

📚 Documentation

  • Comprehensive migration guide in README
  • Clear breaking changes in CHANGELOG
  • Environment-specific usage examples (Node CJS/ESM, browser)
  • Working Vite example included