blur-score 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.0.6
+
+- Expanded API documentation and documented limitations.
+
+## 1.0.5
+
+- Added CommonJS compatibility without changing the ESM API.
+
 ## 1.0.1
 
 - Documented package metadata and release baseline.

package/README.md

@@ -2,7 +2,7 @@
 
 ## Module format
 
-This package is ESM-only. Use `import` syntax in Node.js projects with `type: module`. CommonJS applications can load it with `await import("blur-score")`.
+This package supports both ESM and CommonJS. CommonJS calls return the same Promises as the ESM API.
 
 
 Detect how blurry an image is. Returns a sharpness score from `0` (very blurry) to `1` (very sharp) using the [variance of Laplacian](https://en.wikipedia.org/wiki/Discrete_Laplace_operator) method.
@@ -77,3 +77,7 @@ Real Laplacian variance is much lower than you might expect: a genuinely sharp h
 ## License
 
 MIT
+
+## Limitations
+
+Sharpness scores are heuristic and can vary with image size, noise, compression, and texture. They are not a camera-focus measurement.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blur-score",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Detect how blurry an image is (0-1 sharpness score) using Laplacian variance",
   "repository": {
     "type": "git",
@@ -15,8 +15,14 @@
   "types": "./src/index.d.ts",
   "exports": {
     ".": {
-      "types": "./src/index.d.ts",
-      "import": "./src/index.js"
+      "import": {
+        "types": "./src/index.d.ts",
+        "default": "./src/index.js"
+      },
+      "require": {
+        "types": "./src/index.d.cts",
+        "default": "./src/index.cjs"
+      }
     }
   },
   "files": [

package/src/index.cjs

@@ -0,0 +1,6 @@
+'use strict';
+let modulePromise;
+const load = () => (modulePromise ??= import('./index.js'));
+
+exports.getBlurScore = (...args) => load().then((module) => module.getBlurScore(...args));
+exports.isBlurry = (...args) => load().then((module) => module.isBlurry(...args));

package/src/index.d.cts

@@ -0,0 +1,27 @@
+export interface BlurScoreOptions {
+  /**
+   * Laplacian variance value that maps to a sharpness score of 0.5.
+   * Raise it if sharp images are being scored too high; lower it if
+   * blurry images are being scored too high. Default: 60.
+   */
+  calibration?: number;
+}
+
+/**
+ * Computes a sharpness score for an image in the range [0, 1].
+ * 1 means very sharp, 0 means very blurry.
+ */
+export function getBlurScore(
+  input: string | Buffer | Uint8Array,
+  options?: BlurScoreOptions
+): Promise<number>;
+
+/**
+ * Determines whether an image is blurry relative to a sharpness threshold.
+ * An image is considered blurry when its sharpness score is below `threshold`.
+ */
+export function isBlurry(
+  input: string | Buffer | Uint8Array,
+  threshold?: number,
+  options?: BlurScoreOptions
+): Promise<boolean>;