visual-regression-compare 1.0.0-beta.0 → 1.0.0-beta.1

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { Manifest, ManifestColorMetric, ManifestEntry, ManifestEntryPlatform, ManifestExtra, ManifestStatus, ManifestViewport } from 'visual-regression-manifest';
+import type { Manifest, ManifestColorMetric, ManifestEntry, ManifestEntryInput, ManifestEntryPlatform, ManifestExtra, ManifestStatus, ManifestViewport } from 'visual-regression-manifest';
 /** Decoded image: 8-bit RGBA, row by row. */
 export type RgbaImage = {
     width: number;
@@ -77,6 +77,39 @@ export type Matcher = {
     /** Where the baseline of an incoming image is (or should be); `null` skips the image. */
     baselineFor(incoming: ImageRef): ImageRef | null;
 };
+/**
+ * What a single call may change about the comparer's own settings, for this
+ * screenshot only. `limits`, `update`, `onMissingBaseline` and
+ * `onSizeMismatch` replace the comparer's value; `engineOptions` are merged
+ * over it.
+ */
+export type CompareOptions = {
+    limits?: Limits;
+    engineOptions?: EngineOptions;
+    update?: UpdatePolicy;
+    onMissingBaseline?: OnMissingBaseline;
+    onSizeMismatch?: SizeMismatch;
+};
+/**
+ * Files of one screenshot, as absolute paths, for a runner that already knows
+ * where everything lives. They replace the store, the layout and the matcher
+ * for this call. `actual` and `diff` default to the `.actual.png` and
+ * `.diff.png` files beside the baseline.
+ */
+export type CompareFiles = {
+    baseline: string;
+    actual?: string;
+    diff?: string;
+};
+/** Entry fields a runner states itself; they are recorded as given. */
+export type CompareEntryFields = Pick<ManifestEntryInput, 'options' | 'renderer' | 'attachments' | 'baselineExtra' | 'target' | 'subject'>;
+/** The images `compare` can hand back next to the entry. `baseline` and `actual` are the sizes that were compared (padded or cropped, when sizes differed). */
+export type ImagePart = 'baseline' | 'actual' | 'diff';
+export type CompareResult = {
+    entry: ManifestEntry;
+    /** PNG bytes of the requested parts that exist: there is no `diff` without a baseline, and none from an engine that makes none. */
+    images: Partial<Record<ImagePart, Uint8Array>>;
+};
 /** Identity of one compared screenshot, as an adapter or the CLI states it. */
 export type CompareInput = {
     /** Screenshot name; becomes the file name through the layout (unsafe characters are replaced). */
@@ -93,6 +126,12 @@ export type CompareInput = {
     extra?: ManifestExtra;
     /** Capture plus preceding time in milliseconds, recorded as the entry's `duration`. */
     duration?: number;
+    /** Settings for this screenshot only. */
+    options?: CompareOptions;
+    /** Where the files are, instead of the store and layout. */
+    files?: CompareFiles;
+    /** Entry fields recorded as given (the comparer's own `options` block is replaced by `entry.options`). */
+    entry?: CompareEntryFields;
 };
 /**
  * What hooks see of one comparison. `attachments` is reserved for extra inputs

package/dist/worker.js

@@ -137,13 +137,18 @@ var runCompare = async (job, engine) => {
     );
   }
   const { diff, ...result } = await engine.compare(baseline, actual);
+  const compared = (part, image) => job.include?.includes(part) ? {
+    [`${part}Png`]: resized ? encodePng(image) : job[part]
+  } : {};
   return {
     kind: "compared",
     baselineSize,
     actualSize,
     ...resized && { resized },
     ...result,
-    ...diff && { diffPng: encodePng(diff) }
+    ...diff && { diffPng: encodePng(diff) },
+    ...compared("baseline", baseline),
+    ...compared("actual", actual)
   };
 };
 var runJob = async (job) => runCompare(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "visual-regression-compare",
   "description": "Tool-agnostic image comparison for visual regression testing: pairs baseline and actual screenshots, runs a pluggable diff engine, applies limits, writes .actual and .diff files and a visual-regression-manifest run manifest. A CLI for folders of images and a library for test-runner adapters.",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "author": "Jakub Freisler <jakub.freisler@frsource.org>",
   "homepage": "https://visual-regression.dev/compare-cli",
   "repository": {