@blazediff/bin 3.1.0 → 3.2.0

package/README.md

@@ -4,6 +4,7 @@
 
 [![npm bundle size](https://img.shields.io/bundlephobia/min/%40blazediff%2Fbin)](https://www.npmjs.com/package/@blazediff/bin)
 [![NPM Downloads](https://img.shields.io/npm/dy/%40blazediff%2Fbin)](https://www.npmjs.com/package/@blazediff/bin)
+[![Crates.io](https://img.shields.io/crates/v/blazediff.svg)](https://crates.io/crates/blazediff)
 
 </div>
 
@@ -27,6 +28,8 @@ The fastest single-threaded image diff in the world. Native Rust implementation
 npm install @blazediff/bin
 ```
 
+Also available as a Rust crate: [`cargo install blazediff`](https://crates.io/crates/blazediff)
+
 Pre-built [binaries](https://github.com/teimurjan/blazediff/tree/main/packages/bin/binaries) are included for:
 - macOS ARM64 (Apple Silicon)
 - macOS x64 (Intel)
@@ -96,12 +99,6 @@ Compare two images (PNG or JPEG) and generate a diff image. Format is auto-detec
     <td>false</td>
     <td>Output only differences with transparent background</td>
   </tr>
-  <tr>
-    <td><code>failOnLayoutDiff</code></td>
-    <td>boolean</td>
-    <td>false</td>
-    <td>Fail immediately if images have different dimensions</td>
-  </tr>
 </table>
 
 ### Result Types
@@ -174,7 +171,6 @@ Options:
   -t, --threshold <THRESHOLD>  Color difference threshold (0.0-1.0) [default: 0.1]
   -a, --antialiasing           Enable anti-aliasing detection
       --diff-mask              Output only differences (transparent background)
-      --fail-on-layout         Fail on layout (size) difference
   -c, --compression <LEVEL>    PNG compression level (0-9, 0=fastest, 9=smallest) [default: 0]
   -q, --quality <QUALITY>      JPEG quality (1-100) [default: 90]
       --output-format <FORMAT> Output format (json or text) [default: json]
@@ -194,7 +190,7 @@ Input images can be mixed formats (e.g., compare PNG to JPEG). Output format is
 ### Exit Codes
 
 - `0` - Images are identical
-- `1` - Images differ (or layout mismatch with `--fail-on-layout`)
+- `1` - Images differ (includes layout/size mismatch)
 - `2` - Error (file not found, invalid format, etc.)
 
 ## Performance

package/dist/index.d.ts

@@ -5,8 +5,6 @@ interface BlazeDiffOptions {
     antialiasing?: boolean;
     /** Output only differences with transparent background */
     diffMask?: boolean;
-    /** Fail immediately if images have different dimensions */
-    failOnLayoutDiff?: boolean;
     /** PNG compression level (0-9, 0=fastest/largest, 9=slowest/smallest) */
     compression?: number;
     /** JPEG quality (1-100). Default: 90 */

package/dist/index.js

@@ -145,7 +145,6 @@ function convertToNapiOptions(options) {
     threshold: options?.threshold,
     antialiasing: options?.antialiasing,
     diffMask: options?.diffMask,
-    failOnLayout: options?.failOnLayoutDiff,
     compression: options?.compression,
     quality: options?.quality
   };
@@ -203,7 +202,6 @@ function buildArgs(diffOutput, options) {
     args.push(`--threshold=${options.threshold}`);
   if (options.antialiasing) args.push("--antialiasing");
   if (options.diffMask) args.push("--diff-mask");
-  if (options.failOnLayoutDiff) args.push("--fail-on-layout");
   if (options.compression !== void 0)
     args.push(`--compression=${options.compression}`);
   if (options.quality !== void 0) args.push(`--quality=${options.quality}`);

package/dist/index.mjs

@@ -103,7 +103,6 @@ function convertToNapiOptions(options) {
     threshold: options?.threshold,
     antialiasing: options?.antialiasing,
     diffMask: options?.diffMask,
-    failOnLayout: options?.failOnLayoutDiff,
     compression: options?.compression,
     quality: options?.quality
   };
@@ -161,7 +160,6 @@ function buildArgs(diffOutput, options) {
     args.push(`--threshold=${options.threshold}`);
   if (options.antialiasing) args.push("--antialiasing");
   if (options.diffMask) args.push("--diff-mask");
-  if (options.failOnLayoutDiff) args.push("--fail-on-layout");
   if (options.compression !== void 0)
     args.push(`--compression=${options.compression}`);
   if (options.quality !== void 0) args.push(`--quality=${options.quality}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazediff/bin",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Native Rust binaries for blazediff - the fastest image diff in the world",
   "private": false,
   "publishConfig": {
@@ -20,12 +20,12 @@
     "dist"
   ],
   "optionalDependencies": {
-    "@blazediff/bin-darwin-arm64": "3.1.0",
-    "@blazediff/bin-darwin-x64": "3.1.0",
-    "@blazediff/bin-linux-arm64": "3.1.0",
-    "@blazediff/bin-linux-x64": "3.1.0",
-    "@blazediff/bin-win32-arm64": "3.1.0",
-    "@blazediff/bin-win32-x64": "3.1.0"
+    "@blazediff/bin-darwin-arm64": "3.2.0",
+    "@blazediff/bin-darwin-x64": "3.2.0",
+    "@blazediff/bin-linux-arm64": "3.2.0",
+    "@blazediff/bin-linux-x64": "3.2.0",
+    "@blazediff/bin-win32-arm64": "3.2.0",
+    "@blazediff/bin-win32-x64": "3.2.0"
   },
   "keywords": [
     "image",
@@ -50,6 +50,7 @@
     "typescript": "5.9.2"
   },
   "scripts": {
+    "typecheck": "tsc --noEmit",
     "build": "tsup",
     "clean": "rm -rf dist"
   }

package/dist/index.d.mts

@@ -1,61 +0,0 @@
-interface BlazeDiffOptions {
-    /** Color difference threshold (0.0-1.0). Lower = more strict. Default: 0.1 */
-    threshold?: number;
-    /** Enable anti-aliasing detection to exclude AA pixels from diff count */
-    antialiasing?: boolean;
-    /** Output only differences with transparent background */
-    diffMask?: boolean;
-    /** Fail immediately if images have different dimensions */
-    failOnLayoutDiff?: boolean;
-    /** PNG compression level (0-9, 0=fastest/largest, 9=slowest/smallest) */
-    compression?: number;
-    /** JPEG quality (1-100). Default: 90 */
-    quality?: number;
-}
-type BlazeDiffResult = {
-    match: true;
-} | {
-    match: false;
-    reason: "layout-diff";
-} | {
-    match: false;
-    reason: "pixel-diff";
-    diffCount: number;
-    diffPercentage: number;
-} | {
-    match: false;
-    reason: "file-not-exists";
-    file: string;
-};
-/**
- * Compare two images (PNG or JPEG) and optionally generate a diff image.
- *
- * Uses native N-API bindings when available for ~10-100x better performance
- * on small images (no process spawn overhead). Falls back to execFile if
- * native bindings are unavailable.
- *
- * @example
- * ```ts
- * // With diff output
- * const result = await compare('expected.png', 'actual.png', 'diff.png');
- *
- * // Without diff output (faster, just returns comparison result)
- * const result = await compare('expected.png', 'actual.png');
- *
- * if (result.match) {
- *   console.log('Images identical');
- * } else if (result.reason === 'pixel-diff') {
- *   console.log(`${result.diffCount} pixels differ`);
- * }
- * ```
- */
-declare function compare(basePath: string, comparePath: string, diffOutput?: string, options?: BlazeDiffOptions): Promise<BlazeDiffResult>;
-/** Get the path to the blazediff binary for direct CLI usage. */
-declare function getBinaryPath(): string;
-/**
- * Check if native N-API bindings are available.
- * Returns true if the native module loaded successfully.
- */
-declare function hasNativeBinding(): boolean;
-
-export { type BlazeDiffOptions, type BlazeDiffResult, compare, getBinaryPath, hasNativeBinding };