@cevek/screentest 0.2.2 → 0.2.3

package/dist/runner.d.ts

@@ -1,21 +1,40 @@
-import type { BrowserContext, BrowserContextOptions, Page } from 'playwright';
+import type { BrowserContext, BrowserContextOptions, Page, PageScreenshotOptions } from 'playwright';
 
 /**
- * Capture a full-page PNG, save under
+ * Extra Playwright screenshot options the caller can pass through to
+ * `compareSnapshot` (e.g. `clip`, `mask`, `omitBackground`, `fullPage: false`).
+ * `type` and `path` are reserved — the runner always shoots PNG and writes
+ * into `node_modules/.cache/screentest/actual/...`.
+ */
+export type CompareSnapshotOptions = Omit<PageScreenshotOptions, 'type' | 'path'>;
+
+/**
+ * Capture a PNG, save under
  * `<project>/node_modules/.cache/screentest/actual/<...path>.png`, and
  * compare its SHA256 against the hash in `<project>/snapshot.json`.
  *
  * The snapshot path is built automatically from the surrounding
  * `describe(...)` + `it(...)` chain, plus `name` as the leaf. Prefix `name`
  * with `/` to opt out of auto-grouping and use an absolute path.
+ *
+ * Pass `opts` to forward extra Playwright screenshot options (clip, mask,
+ * etc.). Defaults: `fullPage: true`, `animations: 'disabled'`,
+ * `caret: 'hide'`.
  */
-export function compareSnapshot(page: Page, name: string): Promise<void>;
+export function compareSnapshot(
+  page: Page,
+  name: string,
+  opts?: CompareSnapshotOptions,
+): Promise<void>;
 
 /**
  * Freeze `Date` inside `ctx`. `when` may be an ISO string, unix-ms number,
  * or `Date`. Must be called BEFORE the first navigation in the context.
  */
-export function freezeDate(ctx: BrowserContext, when: string | number | Date): Promise<void>;
+export function freezeDate(
+  ctx: BrowserContext,
+  when: string | number | Date,
+): Promise<void>;
 
 /**
  * Wait for `document.fonts.ready` and every `<img>` to reach `complete`.

package/dist/runner.js

@@ -96,7 +96,7 @@ function currentTestChain() {
   if (!full) return [];
   return full.split(" > ");
 }
-async function compareSnapshot(page, name) {
+async function compareSnapshot(page, name, opts = {}) {
   const explicit = name.split("/").filter(Boolean);
   const path = name.startsWith("/") ? explicit : [...currentTestChain(), ...explicit];
   if (path.length === 0) throw new Error("compareSnapshot: empty name");
@@ -107,9 +107,11 @@ async function compareSnapshot(page, name) {
   await waitForVisualStable(page);
   const actualBuf = await page.screenshot({
     fullPage: true,
-    type: "png",
     animations: "disabled",
-    caret: "hide"
+    caret: "hide",
+    ...opts,
+    type: "png"
+    // always — we hash PNG bytes
   });
   await writeFile(absFile, actualBuf);
   const actualHash = createHash("sha256").update(actualBuf).digest("hex");

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Local desktop tool for visual screenshot-test review — CLI, runner helpers, and review UI shipped as a single package.",
   "license": "MIT",
   "type": "module",