@vizzly-testing/honeydiff 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -0,0 +1,92 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.2] - 2025-12-01
+
+## What's Changed
+
+### Fixed
+- **ESM exports now work correctly in published package** - Fixed critical bug where ESM imports were broken in consuming projects (e.g., `import { compare } from '@vizzly-testing/honeydiff'` threw `SyntaxError: The requested module does not provide an export named 'compare'`). The package loader now auto-detects whether to use platform-specific binaries (published package) or the local development build. (#14)
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.4.1...v0.4.2
+
+## [0.4.1] - 2025-11-30
+
+## What's Changed
+
+### Changed
+- CHANGELOG.md is now included in the npm package, providing version history for offline reference
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.4.0...v0.4.1
+
+## [0.4.0] - 2025-11-30
+
+### Breaking Changes
+- **ESM-only package**: Switched from CommonJS (`module.exports`) to native ES modules (`export`). If you're using CommonJS, you'll need to use dynamic `import()` or update your project to ESM.
+
+### Added
+- Color blindness simulation API for accessibility testing:
+  - `simulateColorBlindness` / `simulateColorBlindnessSync` - Simulate how images appear to users with color vision deficiencies
+  - `saveColorBlindnessSimulation` / `saveColorBlindnessSimulationSync` - Save simulated images to disk
+  - `saveAllColorBlindnessSimulations` / `saveAllColorBlindnessSimulationsSync` - Generate all CVD type simulations at once
+  - `analyzeWcagForCvd` / `analyzeWcagForCvdSync` - Analyze WCAG contrast for a specific color blindness type
+  - `analyzeWcagAllCvd` / `analyzeWcagAllCvdSync` - Analyze WCAG contrast across all color blindness types
+  - `getColorBlindnessTypes` - Get list of supported color blindness types (protanopia, deuteranopia, tritanopia, achromatopsia)
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.3.1...v0.4.0
+
+## [0.3.1] - 2025-11-15
+
+### Fixed
+- Fixed release workflow to properly export WCAG functions (`analyzeWcagContrast`, `analyzeWcagContrastSync`, `saveWcagOverlay`, `saveWcagOverlaySync`)
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.3.0...v0.3.1
+
+## [0.3.0] - 2025-11-15
+
+### Added
+- WCAG accessibility testing API for analyzing color contrast compliance
+- `analyzeWcagContrast` / `analyzeWcagContrastSync` - Analyze images for WCAG color contrast violations
+- `saveWcagOverlay` / `saveWcagOverlaySync` - Generate visual overlays highlighting contrast issues
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.2.1...v0.3.0
+
+## [0.2.1] - 2025-11-11
+
+### Changed
+- Improved README documentation for better user experience
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.2.0...v0.2.1
+
+## [0.2.0] - 2025-11-10
+
+### Added
+- Node.js bindings for accessibility features (ignore colors mode, anti-aliasing detection settings)
+- Comprehensive accessibility features for visual regression testing
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.1.1...v0.2.0
+
+## [0.1.1] - 2025-10-25
+
+### Added
+- `getDimensions` / `getDimensionsSync` API to retrieve image dimensions without loading full image into memory
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/compare/v0.1.0...v0.1.1
+
+## [0.1.0] - 2025-10-21
+
+### Added
+- Initial release of `@vizzly-testing/honeydiff` Node.js bindings
+- Native Rust bindings via Neon for high-performance image diffing
+- `compare` / `compareSync` - Full image comparison with all options
+- `quickCompare` / `quickCompareSync` - Fast comparison returning only diff count and match status
+- Support for macOS ARM64, Linux x64/ARM64, and Windows x64
+- Async and sync variants of all APIs
+- TypeScript definitions included
+- 1.1B pixels/sec throughput for Full HD images
+
+**Full Changelog**: https://github.com/vizzly-testing/honeydiff/releases/tag/v0.1.0

package/index.js

@@ -2,31 +2,61 @@
  * @vizzly-testing/honeydiff - Native Node.js bindings for Honeydiff
  */
 
+import { existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const require = createRequire(import.meta.url);
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
 let addon;
 
-try {
-  // Load the platform-specific native addon
-  addon = require('./load-platform.js');
-} catch (e) {
-  throw new Error(
-    '@vizzly-testing/honeydiff failed to load native binary.\n' +
-    'Platform: ' + process.platform + ' ' + process.arch + '\n' +
-    'Original error: ' + e.message
-  );
+// Try to load the native addon:
+// 1. First try load-platform.js (exists in published npm package with multi-platform binaries)
+// 2. Fall back to index.node (exists in local development builds)
+const platformLoaderPath = join(__dirname, 'load-platform.js');
+
+if (existsSync(platformLoaderPath)) {
+  // Published package: use platform-specific loader
+  addon = require(platformLoaderPath);
+} else {
+  // Local development: use directly built index.node
+  try {
+    addon = require('./index.node');
+  } catch (e) {
+    throw new Error(
+      '@vizzly-testing/honeydiff: Failed to load native binary.\n' +
+        'If developing locally, run "cargo build --release" first.\n' +
+        'Original error: ' +
+        e.message
+    );
+  }
 }
 
-// Export all functions from the native addon
-module.exports = {
-  compare: addon.compare,
-  quickCompare: addon.quickCompare,
-  compareSync: addon.compareSync,
-  quickCompareSync: addon.quickCompareSync,
-  getDimensions: addon.getDimensions,
-  getDimensionsSync: addon.getDimensionsSync,
-
-  // WCAG Accessibility API
-  analyzeWcagContrast: addon.analyzeWcagContrast,
-  analyzeWcagContrastSync: addon.analyzeWcagContrastSync,
-  saveWcagOverlay: addon.saveWcagOverlay,
-  saveWcagOverlaySync: addon.saveWcagOverlaySync,
-};
+// Core comparison API
+export const compare = addon.compare;
+export const quickCompare = addon.quickCompare;
+export const compareSync = addon.compareSync;
+export const quickCompareSync = addon.quickCompareSync;
+export const getDimensions = addon.getDimensions;
+export const getDimensionsSync = addon.getDimensionsSync;
+
+// WCAG Accessibility API
+export const analyzeWcagContrast = addon.analyzeWcagContrast;
+export const analyzeWcagContrastSync = addon.analyzeWcagContrastSync;
+export const saveWcagOverlay = addon.saveWcagOverlay;
+export const saveWcagOverlaySync = addon.saveWcagOverlaySync;
+
+// Color Vision Deficiency (CVD) Simulation API
+export const simulateColorBlindness = addon.simulateColorBlindness;
+export const simulateColorBlindnessSync = addon.simulateColorBlindnessSync;
+export const saveColorBlindnessSimulation = addon.saveColorBlindnessSimulation;
+export const saveColorBlindnessSimulationSync = addon.saveColorBlindnessSimulationSync;
+export const saveAllColorBlindnessSimulations = addon.saveAllColorBlindnessSimulations;
+export const saveAllColorBlindnessSimulationsSync = addon.saveAllColorBlindnessSimulationsSync;
+export const analyzeWcagForCvd = addon.analyzeWcagForCvd;
+export const analyzeWcagForCvdSync = addon.analyzeWcagForCvdSync;
+export const analyzeWcagAllCvd = addon.analyzeWcagAllCvd;
+export const analyzeWcagAllCvdSync = addon.analyzeWcagAllCvdSync;
+export const getColorBlindnessTypes = addon.getColorBlindnessTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly-testing/honeydiff",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "High-performance image diffing for Node.js - Native bindings to Honeydiff Rust library",
   "type": "module",
   "main": "index.js",
@@ -51,11 +51,13 @@
     "load-platform.js",
     "platforms/*.node",
     "README.md",
+    "CHANGELOG.md",
     "index.js",
     "index.d.ts",
     "load-platform.js",
     "platforms/*.node",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=22.0.0"