@storyshelf/image 0.7.0 → 0.8.0

package/dist/async.d.mts

@@ -2,7 +2,6 @@ import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { DiffOptions, DiffResult } from "./options.mjs";
 import { ImageSettings } from "./settings.mjs";
-//#region src/async.d.ts
 /** Environment variable overriding the pool size; `0` runs diffs in-thread. */
 declare const DIFF_WORKERS_ENV = "STORYSHELF_DIFF_WORKERS";
 /**
@@ -25,6 +24,5 @@ declare function configureImages(settings: ImageSettings): void;
 declare function diffImagesAsync(baseline: Buffer, current: Buffer, options: DiffOptions): Promise<DiffResult>;
 /** Stop the shared pool's workers. A later `diffImagesAsync` starts a fresh pool. */
 declare function shutdownDiffPool(): Promise<void>;
-//#endregion
 export { DIFF_WORKERS_ENV, configureImages, diffImagesAsync, shutdownDiffPool };
 //# sourceMappingURL=async.d.mts.map

package/dist/async.mjs

@@ -4,7 +4,7 @@ import.meta.url;
 import { DiffPool } from "./pool.mjs";
 import { appliedImageSettings, configuredThreadCount, currentImageEngine, setImageSettings } from "./settings.mjs";
 import { availableParallelism } from "node:os";
-//#region src/async.ts
+// src/async.ts
 /** `diffImagesAsync`: `diffImages` on a lazily created, process-wide worker pool, plus `configureImages`. */
 /** Environment variable overriding the pool size; `0` runs diffs in-thread. */
 const DIFF_WORKERS_ENV = "STORYSHELF_DIFF_WORKERS";
@@ -58,7 +58,6 @@ function resolveDiffWorkers(env, parallelism = availableParallelism()) {
 function defaultWorkerUrl() {
 	return import.meta.url.endsWith(".ts") ? new URL("worker.ts", import.meta.url) : new URL("worker.mjs", import.meta.url);
 }
-//#endregion
 export { DIFF_WORKERS_ENV, configureImages, diffImagesAsync, resolveDiffWorkers, shutdownDiffPool };
 
 //# sourceMappingURL=async.mjs.map

package/dist/codec.d.mts

@@ -1,6 +1,5 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
-//#region src/codec.d.ts
 /** Image codecs: how PNGs become raw RGBA pixels and back. The comparison itself is always pixelmatch. */
 /** Engine names accepted by `images.engine` and `STORYSHELF_IMAGE_ENGINE`. */
 declare const IMAGE_ENGINES: readonly ["pngjs", "sharp"];
@@ -33,6 +32,5 @@ declare function isImageEngine(value: unknown): value is ImageEngine;
  * missing means the default. An unknown name throws so a typo cannot silently fall back.
  */
 declare function resolveImageEngine(raw: string | undefined): ImageEngine;
-//#endregion
 export { DEFAULT_IMAGE_ENGINE, IMAGE_ENGINES, IMAGE_ENGINE_ENV, ImageCodec, ImageEngine, RgbaImage, isImageEngine, resolveImageEngine };
 //# sourceMappingURL=codec.d.mts.map

package/dist/codec.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/codec.ts
+// src/codec.ts
 /** Image codecs: how PNGs become raw RGBA pixels and back. The comparison itself is always pixelmatch. */
 /** Engine names accepted by `images.engine` and `STORYSHELF_IMAGE_ENGINE`. */
 const IMAGE_ENGINES = ["pngjs", "sharp"];
@@ -23,7 +23,6 @@ function resolveImageEngine(raw) {
 	if (!isImageEngine(value)) throw new Error(`Unknown image engine "${value}". Use one of: ${IMAGE_ENGINES.join(", ")}.`);
 	return value;
 }
-//#endregion
 export { DEFAULT_IMAGE_ENGINE, IMAGE_ENGINES, IMAGE_ENGINE_ENV, isImageEngine, resolveImageEngine };
 
 //# sourceMappingURL=codec.mjs.map

package/dist/codecs.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/codecs.ts
+// src/codecs.ts
 const loaded = /* @__PURE__ */ new Map();
 /** The codec for an engine, loaded once per thread. Rejects when its dependency is unavailable. */
 async function loadCodec(engine) {
@@ -22,7 +22,6 @@ async function importPngjsCodec() {
 async function importSharpCodec() {
 	return await (await import("./sharp.mjs")).createSharpCodec();
 }
-//#endregion
 export { loadCodec };
 
 //# sourceMappingURL=codecs.mjs.map

package/dist/downscale.d.mts

@@ -1,8 +1,6 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
-//#region src/downscale.d.ts
 /** Downscale a PNG so its long edge is at most `maxEdge`, using the configured image engine. */
 declare function downscalePng(buffer: Uint8Array, maxEdge: number): Promise<Uint8Array>;
-//#endregion
 export { downscalePng };
 //# sourceMappingURL=downscale.d.mts.map

package/dist/downscale.mjs

@@ -3,13 +3,12 @@ import "node:url";
 import.meta.url;
 import { loadCodec } from "./codecs.mjs";
 import { currentImageEngine } from "./settings.mjs";
-//#region src/downscale.ts
+// src/downscale.ts
 /** PNG thumbnails on the configured engine (output stays PNG). */
 /** Downscale a PNG so its long edge is at most `maxEdge`, using the configured image engine. */
 async function downscalePng(buffer, maxEdge) {
 	return await (await loadCodec(currentImageEngine())).downscale(buffer, maxEdge);
 }
-//#endregion
 export { downscalePng };
 
 //# sourceMappingURL=downscale.mjs.map

package/dist/engine.d.mts

@@ -2,7 +2,6 @@ import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { DiffOptions, DiffResult } from "./options.mjs";
 import { ImageCodec } from "./codec.mjs";
-//#region src/engine.d.ts
 /**
  * Compare baseline and current screenshots, returning pass/fail and a diff image.
  *
@@ -13,6 +12,5 @@ import { ImageCodec } from "./codec.mjs";
  * @returns The diff result with pixel counts and an optional overlay image.
  */
 declare function diffImages(baseline: Buffer, current: Buffer, options: DiffOptions, codec?: ImageCodec): Promise<DiffResult>;
-//#endregion
 export { diffImages };
 //# sourceMappingURL=engine.d.mts.map

package/dist/engine.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { pngjsCodec } from "./pngjs.mjs";
 import pixelmatch from "pixelmatch";
-//#region src/engine.ts
+// src/engine.ts
 /**
 * Compare baseline and current screenshots, returning pass/fail and a diff image.
 *
@@ -138,7 +138,6 @@ async function compareRegions({ width, height, baseline, current }, options, cod
 		diffImage: await codec.encode(overlay)
 	};
 }
-//#endregion
 export { diffImages, identicalResult };
 
 //# sourceMappingURL=engine.mjs.map

package/dist/options.d.mts

@@ -1,6 +1,5 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
-//#region src/options.d.ts
 /** Options that control how two images are compared. */
 interface DiffOptions {
   /** Per-pixel difference threshold (0-1) above which a pixel counts as different. */
@@ -37,6 +36,5 @@ interface DiffResult {
 }
 /** Default diff settings used when no project overrides are present. */
 declare const DEFAULT_DIFF_OPTIONS: DiffOptions;
-//#endregion
 export { DEFAULT_DIFF_OPTIONS, DiffOptions, DiffResult };
 //# sourceMappingURL=options.d.mts.map

package/dist/options.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/options.ts
+// src/options.ts
 /** Default diff settings used when no project overrides are present. */
 const DEFAULT_DIFF_OPTIONS = {
 	pixelThreshold: .1,
@@ -9,7 +9,6 @@ const DEFAULT_DIFF_OPTIONS = {
 	includeAntialiasing: false,
 	failOnSizeChange: true
 };
-//#endregion
 export { DEFAULT_DIFF_OPTIONS };
 
 //# sourceMappingURL=options.mjs.map

package/dist/pngjs-downscale.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { PNG } from "pngjs";
-//#region src/pngjs-downscale.ts
+// src/pngjs-downscale.ts
 /** Box-sampling PNG downscale on pngjs. */
 /** Downscale a PNG so its long edge is at most `maxEdge` (box sampling). */
 function downscaleWithPngjs(buffer, maxEdge) {
@@ -45,7 +45,6 @@ function writePixel(dst, col, row, rgba) {
 	const at = (row * dst.width + col) * 4;
 	for (let channel = 0; channel < 4; channel += 1) dst.data[at + channel] = rgba[channel] ?? 0;
 }
-//#endregion
 export { downscaleWithPngjs };
 
 //# sourceMappingURL=pngjs-downscale.mjs.map

package/dist/pngjs.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { downscaleWithPngjs } from "./pngjs-downscale.mjs";
 import { PNG } from "pngjs";
-//#region src/pngjs.ts
+// src/pngjs.ts
 /** The default codec: pure JavaScript (pngjs), runs on every runtime. */
 const pngjsCodec = {
 	name: "pngjs",
@@ -25,7 +25,6 @@ const pngjsCodec = {
 	},
 	downscale: downscaleWithPngjs
 };
-//#endregion
 export { pngjsCodec };
 
 //# sourceMappingURL=pngjs.mjs.map

package/dist/pool.mjs

@@ -4,7 +4,7 @@ import.meta.url;
 import { loadCodec } from "./codecs.mjs";
 import { diffImages, identicalResult } from "./engine.mjs";
 import { fromTransferred, toTransferable } from "./transfer.mjs";
-//#region src/pool.ts
+// src/pool.ts
 /** Workers dying before `ready` in a row, after one has started fine, before the pool gives up. */
 const MAX_START_FAILURES = 3;
 const livePools = /* @__PURE__ */ new Set();
@@ -233,7 +233,6 @@ function settle(task, message) {
 	error.name = message.name;
 	task.reject(error);
 }
-//#endregion
 export { DiffPool };
 
 //# sourceMappingURL=pool.mjs.map

package/dist/settings.d.mts

@@ -1,7 +1,6 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { ImageEngine } from "./codec.mjs";
-//#region src/settings.d.ts
 /** What `createShelfApp` passes down: `images.engine` and `compare.threads`. */
 interface ImageSettings {
   /** Image library: `"pngjs"` (default) or `"sharp"`; falls back to `STORYSHELF_IMAGE_ENGINE`. */
@@ -17,6 +16,5 @@ declare function currentImageEngine(): ImageEngine;
  * so it returns at once and never delays startup (or the first capture).
  */
 declare function verifyImageEngine(): Promise<ImageEngine>;
-//#endregion
 export { ImageSettings, currentImageEngine, verifyImageEngine };
 //# sourceMappingURL=settings.d.mts.map

package/dist/settings.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { loadCodec } from "./codecs.mjs";
 import { resolveImageEngine } from "./codec.mjs";
-//#region src/settings.ts
+// src/settings.ts
 /** Process-wide image settings, set once at app boot and read by the diff pool and thumbnails. */
 let configuredEngine;
 let configuredThreads;
@@ -42,7 +42,6 @@ async function verifyImageEngine() {
 	if (engine !== "pngjs") await loadCodec(engine);
 	return engine;
 }
-//#endregion
 export { appliedImageSettings, configuredThreadCount, currentImageEngine, setImageSettings, verifyImageEngine };
 
 //# sourceMappingURL=settings.mjs.map

package/dist/sharp.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { isMainThread } from "node:worker_threads";
-//#region src/sharp.ts
+// src/sharp.ts
 /** The optional native codec: libvips via `sharp`. Several times faster than pngjs on large PNGs. */
 /**
 * Load `sharp` and build the codec. Throws a readable error when the optional peer is missing
@@ -54,7 +54,6 @@ async function downscaleWithSharp(sharp, png, maxEdge) {
 	}).png().toBuffer();
 	return new Uint8Array(out);
 }
-//#endregion
 export { createSharpCodec };
 
 //# sourceMappingURL=sharp.mjs.map

package/dist/transfer.mjs

@@ -1,7 +1,7 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/transfer.ts
+// src/transfer.ts
 /** Zero-copy hand-off of Buffers across the worker boundary. */
 /**
 * A Uint8Array that may be transferred (detached from the caller) without corrupting anything.
@@ -18,7 +18,6 @@ function toTransferable(buffer) {
 function fromTransferred(bytes) {
 	return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength);
 }
-//#endregion
 export { fromTransferred, toTransferable };
 
 //# sourceMappingURL=transfer.mjs.map

package/dist/worker.mjs

@@ -5,7 +5,7 @@ import { loadCodec } from "./codecs.mjs";
 import { diffImages } from "./engine.mjs";
 import { fromTransferred, toTransferable } from "./transfer.mjs";
 import { parentPort } from "node:worker_threads";
-//#region src/worker.ts
+// src/worker.ts
 /** Worker-thread entry for the diff pool: runs the same `diffImages` as the in-thread path. */
 const port = parentPort;
 async function handle(request) {
@@ -41,7 +41,6 @@ port?.on("message", (request) => {
 	});
 });
 port?.postMessage({ type: "ready" });
-//#endregion
 export {};
 
 //# sourceMappingURL=worker.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyshelf/image",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "StoryShelf image engine: pixel diffing, overlay rendering and thumbnails on a worker-thread pool, with pngjs (default) or sharp codecs.",
   "keywords": [
     "diff",
@@ -69,7 +69,7 @@
     "sharp": "^0.35.5",
     "tsdown": "^0.22.14",
     "typescript": "^7.0.2",
-    "vitest": "^5.0.0"
+    "vitest": "^5.0.5"
   },
   "peerDependencies": {
     "sharp": ">=0.34.0"