@codepress/interactions-playwright 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
+# @codepress/interactions-playwright
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Playwright helpers that run the [CodePress Interactions](https://github.com/quantfive/codepress-interactions/blob/main/README.md) UI checks on a page under test: overlapping elements, content spilling out of its box, horizontal page scroll, controls out of reach, small tap targets (touch), clipped text and broken images.
+
+```sh
+npm install --save-dev @codepress/interactions-playwright
+```
+
+```ts
+import { test } from "@playwright/test";
+import { expectNoFindings, findIssues } from "@codepress/interactions-playwright";
+
+test("checkout has no layout findings", async ({ page }) => {
+  await page.goto("/checkout/42");
+  await expectNoFindings(page, { routeSegments: ["checkout"] });
+});
+```
+
+A failure lists one line per finding: the check, the elements (test ID, or a structural path such as `#cart/div/button` when there is none), the measured evidence and the fingerprint.
+
+```
+2 UI findings on /checkout/42. Pass a fingerprint in ignoreFingerprints to accept one.
+  "layout.overlap checkout × promo on /checkout/:id @1280x800: overlap_px=3520 … subject_blocked_points=5 … center_blocked subject_text_covered … [590f6922417e2a04f8d6c9341daf02c1]"
+```
+
+Findings are pointers, not verdicts: each says what was measured, and you decide whether it is a bug. Sorting puts blocked controls first, then covered or clipped text, then the rest, then decorative layers and content-free findings (stacked or cropped images); it never drops one.
+
+## API
+
+- `captureSnapshot(page, options?)` → `{ body, sha256 }`: walks the page with the SDK's snapshot walker in one pass, so the body is never torn.
+- `findIssues(page, options?)` → `Finding[]`: the checks on the page as it is now, sorted.
+- `expectNoFindings(page, options?)`: fails the test when `findIssues` returns anything.
+
+Options (all optional):
+
+| Option | Default | |
+| --- | --- | --- |
+| `root` | whole document | CSS selector of the subtree to walk |
+| `ignore` | none | extra selector for subtrees to leave out; `[data-layout-ignore]` always applies |
+| `route` | from the URL | route template recorded on findings and used by fingerprints |
+| `routeSegments` | `[]` | literal path segments kept in the default route template (others become `:id`) |
+| `maxElements` | 50000 | element limit |
+| `theme` | the page's `prefers-color-scheme` | `"light"`, `"dark"` or `"unknown"` to record, for apps with their own theme toggle (Playwright's `colorScheme` / `page.emulateMedia` set the default) |
+| `testId` | `defaultTestIdFilter` | `(value, element) => string \| null`: which `data-interaction-id` / `data-testid` values to record, as the browser SDK's [`testId` option](https://github.com/quantfive/codepress-interactions/blob/main/packages/browser/README.md#test-ids-and-privacy). It runs in the page, so it must be self-contained, like a `page.evaluate` callback; a name the page does not have fails the capture. A name the page does have, such as a test variable called `status`, or any other runtime error in the hook, drops the ID with no error, so check the snapshot's IDs when you write a hook. Write out the rule your app uses so fingerprints match production, calling `globalThis.__codepressInteractions.defaultTestIdFilter(value)` where it calls the default. `(value) => value` keeps every ID |
+| `ignoreFingerprints` | `[]` | fingerprints to leave out (known findings accepted for now) |
+| `events` | none | protocol v2 events to run the click and stability checks over too |
+| `checks` and thresholds | see [detect options](https://github.com/quantfive/codepress-interactions/blob/main/packages/browser/README.md#ui-checks) | |
+
+Fingerprints are stable across scroll offsets, runs and machines: they hash the check, the route template, the viewport width band and the elements' identities, never coordinates.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,113 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  captureSnapshot: () => captureSnapshot,
+  expectNoFindings: () => expectNoFindings,
+  findIssues: () => findIssues,
+  formatFinding: () => import_detect2.formatFinding,
+  sortFindings: () => import_detect2.sortFindings
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_crypto = require("crypto");
+var import_test = require("@playwright/test");
+var import_detect = require("@codepress/interactions-browser/detect");
+var import_page_script = require("@codepress/interactions-browser/page-script");
+var import_detect2 = require("@codepress/interactions-browser/detect");
+async function captureSnapshot(page, options = {}) {
+  const args = {
+    script: import_page_script.PAGE_SCRIPT,
+    options: {
+      root: options.root,
+      ignoreSelector: options.ignore,
+      routeTemplate: options.route,
+      routeSegments: options.routeSegments,
+      maxElements: options.maxElements,
+      theme: options.theme
+    },
+    testId: typeof options.testId === "function" ? String(options.testId) : null
+  };
+  const body = await page.evaluate(async ({ script, options: options2, testId }) => {
+    const scope = globalThis;
+    if (!scope.__codepressInteractions) (0, eval)(script);
+    if (testId === null) return scope.__codepressInteractions.walk(options2);
+    let filter;
+    try {
+      filter = (0, eval)(`(${testId})`);
+    } catch {
+      try {
+        filter = Object.values((0, eval)(`({${testId}})`))[0];
+      } catch {
+      }
+    }
+    if (typeof filter !== "function")
+      throw new Error("testId must be a self-contained function: bound and native functions cannot run in the page");
+    const hook = filter;
+    let missing = null;
+    const body2 = await scope.__codepressInteractions.walk({
+      ...options2,
+      testId: (value, element) => {
+        try {
+          return hook(value, element);
+        } catch (error) {
+          if (error instanceof ReferenceError) missing ??= error.message;
+          throw error;
+        }
+      }
+    });
+    if (missing !== null)
+      throw new Error(`testId runs in the page and must be self-contained: ${missing}`);
+    return body2;
+  }, args);
+  const sha256 = (0, import_node_crypto.createHash)("sha256").update(JSON.stringify(body)).digest("hex");
+  return { body, sha256 };
+}
+async function findIssues(page, options = {}) {
+  const { body, sha256 } = await captureSnapshot(page, options);
+  const findings = (0, import_detect.checkSnapshot)(body, { ...options, sha256 });
+  if (options.events?.length)
+    findings.push(...(0, import_detect.checkEvents)(options.events, { ...options, snapshots: [{ body, sha256 }] }));
+  const skip = new Set(options.ignoreFingerprints ?? []);
+  return (0, import_detect.sortFindings)(findings.filter((finding) => !skip.has(finding.fingerprint)));
+}
+async function expectNoFindings(page, options = {}) {
+  const findings = await findIssues(page, options);
+  const lines = findings.map(import_detect.formatFinding);
+  const where = (() => {
+    try {
+      return new URL(page.url()).pathname;
+    } catch {
+      return page.url();
+    }
+  })();
+  (0, import_test.expect)(
+    lines,
+    `${findings.length} UI finding${findings.length === 1 ? "" : "s"} on ${where}` + (findings.length ? ". Pass a fingerprint in ignoreFingerprints to accept one." : "")
+  ).toEqual([]);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  captureSnapshot,
+  expectNoFindings,
+  findIssues,
+  formatFinding,
+  sortFindings
+});

package/dist/index.d.cts

@@ -0,0 +1,49 @@
+import { Page } from '@playwright/test';
+import { DetectOptions, TimelineEvent, SnapshotBody, Finding } from '@codepress/interactions-browser/detect';
+export { CheckName, DetectOptions, Evidence, Finding, SnapshotBody, TimelineEvent, formatFinding, sortFindings } from '@codepress/interactions-browser/detect';
+
+interface CaptureOptions {
+    /** CSS selector of the subtree to walk. Default: the whole document. */
+    root?: string;
+    /** Extra selector for subtrees recorded as one ignored box. `[data-layout-ignore]` always applies. */
+    ignore?: string;
+    /** Route template to record, e.g. `/projects/:id`. Default: the SDK's default template of the URL, every segment `:id` unless listed in `routeSegments`. */
+    route?: string | null;
+    /** Literal path segments kept in the default route template. */
+    routeSegments?: string[];
+    /** Element limit. Default 50000. */
+    maxElements?: number;
+    /** Theme to record when the app has its own toggle. Default: the page's prefers-color-scheme (`colorScheme` in the Playwright config, or `page.emulateMedia`). */
+    theme?: "light" | "dark" | "unknown";
+    /**
+     * Test ID filter, as the browser SDK's `testId` option: return the value to
+     * keep it, `null` to drop it. Replaces the default (`defaultTestIdFilter`).
+     * It runs in the page, so like a `page.evaluate` callback it must be
+     * self-contained: no variables from the test file, no imports. Using one
+     * fails the capture. To extend the default, call
+     * `globalThis.__codepressInteractions.defaultTestIdFilter(value)`.
+     */
+    testId?: (value: string, element: Element) => string | null;
+}
+interface Snapshot {
+    body: SnapshotBody;
+    /** SHA-256 of the serialized body, as the browser SDK computes it. */
+    sha256: string;
+}
+interface FindIssuesOptions extends CaptureOptions, DetectOptions {
+    /** Fingerprints to leave out: known findings accepted for now. */
+    ignoreFingerprints?: readonly string[];
+    /** Protocol v2 events (for example from a sink) to run the click and stability checks over too. */
+    events?: readonly TimelineEvent[];
+}
+/** Walks the page with the SDK's snapshot walker in one pass (never torn). */
+declare function captureSnapshot(page: Page, options?: CaptureOptions): Promise<Snapshot>;
+/** Runs the checks on the page as it is now, sorted with blocked controls first. */
+declare function findIssues(page: Page, options?: FindIssuesOptions): Promise<Finding[]>;
+/**
+ * Fails the test when the checks find anything, listing one line per finding
+ * (check, elements, evidence, fingerprint) so the failure reads on its own.
+ */
+declare function expectNoFindings(page: Page, options?: FindIssuesOptions): Promise<void>;
+
+export { type CaptureOptions, type FindIssuesOptions, type Snapshot, captureSnapshot, expectNoFindings, findIssues };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { Page } from '@playwright/test';
+import { DetectOptions, TimelineEvent, SnapshotBody, Finding } from '@codepress/interactions-browser/detect';
+export { CheckName, DetectOptions, Evidence, Finding, SnapshotBody, TimelineEvent, formatFinding, sortFindings } from '@codepress/interactions-browser/detect';
+
+interface CaptureOptions {
+    /** CSS selector of the subtree to walk. Default: the whole document. */
+    root?: string;
+    /** Extra selector for subtrees recorded as one ignored box. `[data-layout-ignore]` always applies. */
+    ignore?: string;
+    /** Route template to record, e.g. `/projects/:id`. Default: the SDK's default template of the URL, every segment `:id` unless listed in `routeSegments`. */
+    route?: string | null;
+    /** Literal path segments kept in the default route template. */
+    routeSegments?: string[];
+    /** Element limit. Default 50000. */
+    maxElements?: number;
+    /** Theme to record when the app has its own toggle. Default: the page's prefers-color-scheme (`colorScheme` in the Playwright config, or `page.emulateMedia`). */
+    theme?: "light" | "dark" | "unknown";
+    /**
+     * Test ID filter, as the browser SDK's `testId` option: return the value to
+     * keep it, `null` to drop it. Replaces the default (`defaultTestIdFilter`).
+     * It runs in the page, so like a `page.evaluate` callback it must be
+     * self-contained: no variables from the test file, no imports. Using one
+     * fails the capture. To extend the default, call
+     * `globalThis.__codepressInteractions.defaultTestIdFilter(value)`.
+     */
+    testId?: (value: string, element: Element) => string | null;
+}
+interface Snapshot {
+    body: SnapshotBody;
+    /** SHA-256 of the serialized body, as the browser SDK computes it. */
+    sha256: string;
+}
+interface FindIssuesOptions extends CaptureOptions, DetectOptions {
+    /** Fingerprints to leave out: known findings accepted for now. */
+    ignoreFingerprints?: readonly string[];
+    /** Protocol v2 events (for example from a sink) to run the click and stability checks over too. */
+    events?: readonly TimelineEvent[];
+}
+/** Walks the page with the SDK's snapshot walker in one pass (never torn). */
+declare function captureSnapshot(page: Page, options?: CaptureOptions): Promise<Snapshot>;
+/** Runs the checks on the page as it is now, sorted with blocked controls first. */
+declare function findIssues(page: Page, options?: FindIssuesOptions): Promise<Finding[]>;
+/**
+ * Fails the test when the checks find anything, listing one line per finding
+ * (check, elements, evidence, fingerprint) so the failure reads on its own.
+ */
+declare function expectNoFindings(page: Page, options?: FindIssuesOptions): Promise<void>;
+
+export { type CaptureOptions, type FindIssuesOptions, type Snapshot, captureSnapshot, expectNoFindings, findIssues };

package/dist/index.js

@@ -0,0 +1,89 @@
+// src/index.ts
+import { createHash } from "crypto";
+import { expect } from "@playwright/test";
+import {
+  checkEvents,
+  checkSnapshot,
+  formatFinding,
+  sortFindings
+} from "@codepress/interactions-browser/detect";
+import { PAGE_SCRIPT } from "@codepress/interactions-browser/page-script";
+import { formatFinding as formatFinding2, sortFindings as sortFindings2 } from "@codepress/interactions-browser/detect";
+async function captureSnapshot(page, options = {}) {
+  const args = {
+    script: PAGE_SCRIPT,
+    options: {
+      root: options.root,
+      ignoreSelector: options.ignore,
+      routeTemplate: options.route,
+      routeSegments: options.routeSegments,
+      maxElements: options.maxElements,
+      theme: options.theme
+    },
+    testId: typeof options.testId === "function" ? String(options.testId) : null
+  };
+  const body = await page.evaluate(async ({ script, options: options2, testId }) => {
+    const scope = globalThis;
+    if (!scope.__codepressInteractions) (0, eval)(script);
+    if (testId === null) return scope.__codepressInteractions.walk(options2);
+    let filter;
+    try {
+      filter = (0, eval)(`(${testId})`);
+    } catch {
+      try {
+        filter = Object.values((0, eval)(`({${testId}})`))[0];
+      } catch {
+      }
+    }
+    if (typeof filter !== "function")
+      throw new Error("testId must be a self-contained function: bound and native functions cannot run in the page");
+    const hook = filter;
+    let missing = null;
+    const body2 = await scope.__codepressInteractions.walk({
+      ...options2,
+      testId: (value, element) => {
+        try {
+          return hook(value, element);
+        } catch (error) {
+          if (error instanceof ReferenceError) missing ??= error.message;
+          throw error;
+        }
+      }
+    });
+    if (missing !== null)
+      throw new Error(`testId runs in the page and must be self-contained: ${missing}`);
+    return body2;
+  }, args);
+  const sha256 = createHash("sha256").update(JSON.stringify(body)).digest("hex");
+  return { body, sha256 };
+}
+async function findIssues(page, options = {}) {
+  const { body, sha256 } = await captureSnapshot(page, options);
+  const findings = checkSnapshot(body, { ...options, sha256 });
+  if (options.events?.length)
+    findings.push(...checkEvents(options.events, { ...options, snapshots: [{ body, sha256 }] }));
+  const skip = new Set(options.ignoreFingerprints ?? []);
+  return sortFindings(findings.filter((finding) => !skip.has(finding.fingerprint)));
+}
+async function expectNoFindings(page, options = {}) {
+  const findings = await findIssues(page, options);
+  const lines = findings.map(formatFinding);
+  const where = (() => {
+    try {
+      return new URL(page.url()).pathname;
+    } catch {
+      return page.url();
+    }
+  })();
+  expect(
+    lines,
+    `${findings.length} UI finding${findings.length === 1 ? "" : "s"} on ${where}` + (findings.length ? ". Pass a fingerprint in ignoreFingerprints to accept one." : "")
+  ).toEqual([]);
+}
+export {
+  captureSnapshot,
+  expectNoFindings,
+  findIssues,
+  formatFinding2 as formatFinding,
+  sortFindings2 as sortFindings
+};

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@codepress/interactions-playwright",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.1.0",
+  "description": "Playwright helpers that run the CodePress Interactions UI checks in tests: capture a snapshot, list findings, assert none",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@codepress/interactions-browser": "^1.1.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quantfive/codepress-interactions.git",
+    "directory": "packages/playwright"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "playwright",
+    "layout",
+    "testing",
+    "ui-checks",
+    "overlap"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean --external @playwright/test",
+    "test:browser": "playwright test",
+    "typecheck": "tsc --noEmit",
+    "pack:check": "node scripts/pack-check.mjs"
+  }
 }