Skip to content

CHANGELOG.md

Latest commit

 

History

History
142 lines (104 loc) · 4.57 KB

CHANGELOG.md

File metadata and controls

142 lines (104 loc) · 4.57 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0 - 2025-11-18

Modernizes imguri to ES modules, removes 3 deprecated dependencies, adds comprehensive test coverage (89% with 54 tests), and simplifies architecture to 2 layers. Increases default size limit from 4KB to 128KB for practical modern usage.

Added

  • Modern JavaScript: Full ES modules (ESM) support with dual CJS/ESM exports
  • Promise-based API: Modern async/await API (breaking change from callbacks)
  • Native Fetch: Uses Node.js native fetch API (no deprecated request library)
  • Clean Architecture: Organized codebase with separation of concerns
  • Comprehensive Tests: 54 tests with 89% coverage using Vitest and nock for HTTP mocking
  • CI/CD: GitHub Actions workflow for automated testing
  • Code Quality Tools: ESLint and Prettier configuration
  • Concurrency Control: Configurable concurrent processing of multiple files
  • Backward Compatibility: Legacy callback API via encodeLegacy() function (deprecated, will be removed in v2.0)
  • Path Security: Validation to prevent path traversal attacks

Changed

  • Breaking: Minimum Node.js version is now 18.0.0 (for native fetch support)
  • Breaking: Default export changed from callback-based to promise-based API
  • Breaking: Results format changed from plain object to Map with structured results
  • Breaking: Default size limit increased from 4KB to 128KB
  • Improved: Better MIME type detection using mime-types library
  • Improved: More reliable file size validation before reading
  • Improved: HTTP requests now have proper timeout and abort support

Removed

  • Breaking: Removed deprecated async library dependency
  • Breaking: Removed deprecated request library (security vulnerability)
  • Breaking: Removed deprecated mime library (replaced with mime-types)
  • Breaking: Removed all deprecated Node.js APIs:
    • new Buffer() → Buffer.from()
    • fs.exists() → fs.access()
    • util.isArray() → Array.isArray()

Security

  • Eliminated all deprecated dependencies with known vulnerabilities
  • Updated to use only modern, actively maintained packages
  • Path traversal protection added to prevent directory escape attacks
  • Absolute path access validated in production environments

Dependencies

  • Added: mime-types@^2.1.35 (replacement for deprecated mime)
  • Removed: async@^2.6.0 (no longer needed with async/await)
  • Removed: request@^2.83.0 (replaced with native fetch)
  • Removed: mime@^2.2.0 (replaced with mime-types)

Testing

  • 54 comprehensive tests (18 unit, 36 integration) with 89.15% code coverage
  • HTTP client fully tested with nock for mocking (25 tests)
  • Remote URL functionality comprehensively tested (11 tests)
  • Path security validation tested
  • Tests use tmpdir for isolation, no file pollution

Documentation

  • Completely rewritten README with modern examples
  • Added comprehensive API documentation with JSDoc type annotations
  • Added migration guide from v0.x
  • Added architecture overview with concrete responsibilities
  • Replaced generic use cases with 2 complete working examples
  • Added SECURITY.md for vulnerability reporting
  • Removed AI-generated fluff, made all content actionable

0.0.6 - Previous Release

Changed

  • Package updates
  • Minor bug fixes

0.0.5 - Previous Release

Changed

  • Package updates
  • Dependency version bumps

Migration Guide: v0.x to v1.0

Before (v0.x)

const imguri = require('imguri');

imguri.encode(['image.png'], { force: false }, (err, results) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(results['image.png'].data);
});

After (v1.0) - Recommended

import { encode } from 'imguri';

const results = await encode(['image.png'], { force: false });
const result = results.get('image.png');

if (result.error) {
  console.error(result.error);
} else {
  console.log(result.data);
}

After (v1.0) - Using Legacy API

import { encodeLegacy } from 'imguri';

encodeLegacy(['image.png'], { force: false }, (err, results) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(results['image.png'].data);
});