@ingcreators/annot-playwright 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @ingcreators/annot-playwright
+
+## 0.1.0
+
+### Minor Changes
+
+- 408791f: Initial public release — headless annotator + Playwright fixture + SDK.
+
+### Patch Changes
+
+- Updated dependencies [408791f]
+  - @ingcreators/annot-annotator@0.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 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 2026 ingcreators
+
+   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

@@ -0,0 +1,166 @@
+# `@ingcreators/annot-playwright`
+
+Playwright fixture for [`@ingcreators/annot-annotator`](../annotator/README.md).
+Emit annotated screenshots from test failures without leaving the
+test file.
+
+> **Status:** Workspace package, not yet published to npm. Becomes
+> installable in Phase 3 of the headless-annotator track (gated on
+> Changesets). The Phase 1 annotator it depends on is also
+> workspace-only until then.
+
+## Install (post-publish)
+
+```sh
+pnpm add -D @playwright/test @ingcreators/annot-playwright
+```
+
+(`@playwright/test` is a peer dependency.)
+
+## Usage
+
+```ts
+import {
+  test,
+  expect,
+  rectForBoundingBox,
+} from "@ingcreators/annot-playwright";
+
+test("submit button is enabled", async ({ page, annotator }, testInfo) => {
+  await page.goto("/login");
+  const submitBtn = page.getByRole("button", { name: "Submit" });
+  try {
+    await expect(submitBtn).toBeEnabled();
+  } catch (err) {
+    const bbox = await submitBtn.boundingBox();
+    if (bbox) {
+      const png = await annotator.annotateScreenshot(page, {
+        annotationsSvg: rectForBoundingBox(bbox, { stroke: "red" }),
+      });
+      await testInfo.attach("failure.png", {
+        body: Buffer.from(png),
+        contentType: "image/png",
+      });
+    }
+    throw err;
+  }
+});
+```
+
+The `test` import is `@playwright/test`'s `test`, extended with an
+`annotator` fixture. Everything else (`test.describe`,
+`test.beforeEach`, `expect`, …) passes straight through.
+
+## Compose annotations with the helpers
+
+```ts
+import {
+  rectForBoundingBox,
+  arrowBetween,
+  textAt,
+} from "@ingcreators/annot-playwright";
+
+const bbox = await element.boundingBox();
+const annotationsSvg = [
+  rectForBoundingBox(bbox!, { stroke: "red" }),
+  arrowBetween({ x: 250, y: 100 }, { x: bbox!.x, y: bbox!.y }),
+  textAt({ x: 250, y: 90 }, "expected enabled"),
+].join("");
+
+const png = await annotator.annotateScreenshot(page, { annotationsSvg });
+```
+
+Each helper returns an SVG fragment string. Concatenate them to
+build up the overlay. For shapes the helpers don't cover, drop in
+raw SVG strings — the underlying annotator accepts anything resvg
+can render.
+
+## API
+
+### Re-exports from `@playwright/test`
+
+- `test` — Playwright's base test, extended with the `annotator`
+  fixture.
+- `expect` — passthrough.
+
+### Fixture surface
+
+```ts
+interface PlaywrightAnnotator {
+  /** Underlying Phase 1 annotator. Use for direct toPng / toSvg. */
+  raw: Annotator;
+  /** Take a screenshot of the page and overlay annotations. */
+  annotateScreenshot(
+    page: PageLike,
+    opts: { annotationsSvg: string; fullPage?: boolean },
+  ): Promise<Uint8Array>;
+}
+```
+
+Available as `{ annotator }` in any test.
+
+### Helpers
+
+| Function | Returns | Defaults |
+|---|---|---|
+| `rectForBoundingBox(bbox, opts?)` | `<rect>` fragment | red stroke, 2px, no fill |
+| `arrowBetween(from, to, opts?)` | `<defs>` + `<marker>` + `<line>` | red, 2px |
+| `textAt(at, content, opts?)` | `<text>` fragment | red, 14px, start-anchored |
+
+Each call to `arrowBetween` generates a unique marker id, so
+multiple arrows on the same screenshot don't collide.
+
+### Escape hatch — `annotateScreenshot` standalone
+
+If you compose your own Playwright fixture (e.g. adding extra
+auth fixtures), you can use `annotateScreenshot` directly:
+
+```ts
+import { createAnnotator } from "@ingcreators/annot-annotator";
+import { annotateScreenshot } from "@ingcreators/annot-playwright";
+
+const annotator = createAnnotator();
+const png = await annotateScreenshot(annotator, page, {
+  annotationsSvg: rectForBoundingBox(bbox),
+});
+```
+
+## How dimensions are picked
+
+`annotateScreenshot` parses the screenshot's PNG IHDR chunk to
+extract the actual pixel dimensions, then passes those to the
+annotator. This works correctly for clipped screenshots and
+full-page captures — `page.viewportSize()` would be wrong in
+both cases.
+
+## Limitations
+
+- **PNG output only.** Same constraint as the underlying
+  annotator. JPEG via `sharp` is planned for a follow-up release.
+- **Font registration is the caller's job.** The fixture passes
+  no fonts to the annotator by default. If your annotations
+  contain CJK / Arabic / Indic / Thai text, construct the
+  annotator yourself with `fontFiles` and pass it via
+  `annotateScreenshot(yourAnnotator, page, ...)`:
+
+```ts
+import { createAnnotator } from "@ingcreators/annot-annotator";
+const annotator = createAnnotator({
+  fontFiles: ["./fonts/NotoSans-Regular.ttf"],
+});
+// then use the standalone `annotateScreenshot` helper, not the
+// fixture's auto-constructed annotator.
+```
+
+  A future release will surface this on the fixture too.
+
+## See also
+
+- [`docs/plans/_done/headless-annotator-spike.md`](../../docs/plans/_done/headless-annotator-spike.md)
+  — Phase 0 feasibility report.
+- [`docs/plans/_done/annot-annotator-package.md`](../../docs/plans/_done/annot-annotator-package.md)
+  — Phase 1 annotator design.
+- [`docs/plans/annot-playwright-fixture.md`](../../docs/plans/annot-playwright-fixture.md)
+  — Phase 2 design (this package).
+- [`PRODUCT_DIRECTION.md`](../../PRODUCT_DIRECTION.md) — strategic
+  context.

package/dist/fixture.d.ts

@@ -0,0 +1,49 @@
+import { Annotator } from '@ingcreators/annot-annotator';
+/**
+ * Minimal Playwright `Page` surface the fixture relies on. The full
+ * `@playwright/test` `Page` type is much wider, but importing it
+ * directly forces our typecheck to load Playwright's full type
+ * graph — fine for callers but a lot of weight for our own unit
+ * tests. The structural alias below is fully compatible (a real
+ * Playwright `Page` satisfies it).
+ */
+export interface PageLike {
+    screenshot(options?: {
+        fullPage?: boolean;
+    }): Promise<Buffer>;
+}
+/**
+ * The Phase 1 annotator wrapped in a Playwright-aware surface.
+ *
+ * - `raw` is the underlying `Annotator` from
+ *   `@ingcreators/annot-annotator` — escape hatch for direct
+ *   `toPng` / `toSvg` calls.
+ * - `annotateScreenshot` is the convenience that takes a
+ *   Playwright `Page`, captures a screenshot, and overlays the
+ *   caller-supplied annotation SVG.
+ */
+export interface PlaywrightAnnotator {
+    raw: Annotator;
+    annotateScreenshot(page: PageLike, opts: {
+        annotationsSvg: string;
+        fullPage?: boolean;
+    }): Promise<Uint8Array>;
+}
+/**
+ * `test = base.extend({ annotator })` — drop-in replacement for
+ * `@playwright/test`'s `test` with an `annotator` fixture available
+ * in every test.
+ */
+export declare const test: import('@playwright/test').TestType<import('@playwright/test').PlaywrightTestArgs & import('@playwright/test').PlaywrightTestOptions & {
+    annotator: PlaywrightAnnotator;
+}, import('@playwright/test').PlaywrightWorkerArgs & import('@playwright/test').PlaywrightWorkerOptions>;
+/**
+ * Standalone version of the fixture's `annotateScreenshot` helper
+ * — exported so callers who build their own Playwright fixture
+ * (e.g. with extra fixtures composed on top) can still use the
+ * one-call screenshot+annotate flow.
+ */
+export declare function annotateScreenshot(annotator: Annotator, page: PageLike, opts: {
+    annotationsSvg: string;
+    fullPage?: boolean;
+}): Promise<Uint8Array>;

package/dist/helpers.d.ts

@@ -0,0 +1,43 @@
+export interface BoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface Point {
+    x: number;
+    y: number;
+}
+export interface RectOptions {
+    stroke?: string;
+    strokeWidth?: number;
+    fill?: string;
+}
+export interface ArrowOptions {
+    color?: string;
+    strokeWidth?: number;
+}
+export interface TextOptions {
+    color?: string;
+    fontSize?: number;
+    anchor?: "start" | "middle" | "end";
+}
+/**
+ * Outline a bounding box (e.g. from `locator.boundingBox()`) with
+ * an SVG `<rect>`. Defaults: red stroke, 2px width, no fill.
+ */
+export declare function rectForBoundingBox(bbox: BoundingBox, opts?: RectOptions): string;
+/**
+ * Draw an arrow from `from` to `to`. Inlines a unique-id `<marker>`
+ * definition so the helper is self-contained — call it twice and
+ * each call produces a distinct arrowhead marker (no collision
+ * across uses on the same SVG).
+ *
+ * Defaults: red color, 2px stroke.
+ */
+export declare function arrowBetween(from: Point, to: Point, opts?: ArrowOptions): string;
+/**
+ * Drop a text label at a position. Defaults: red, 14px,
+ * start-anchored.
+ */
+export declare function textAt(at: Point, content: string, opts?: TextOptions): string;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { expect } from '@playwright/test';
+export { annotateScreenshot, type PageLike, type PlaywrightAnnotator, test, } from './fixture.js';
+export { type ArrowOptions, arrowBetween, type BoundingBox, type Point, type RectOptions, rectForBoundingBox, type TextOptions, textAt, } from './helpers.js';

package/dist/index.js

@@ -0,0 +1,53 @@
+import { expect as e, test as t } from "@playwright/test";
+import { createAnnotator as n } from "@ingcreators/annot-annotator";
+//#region src/fixture.ts
+var r = t.extend({ annotator: async ({}, e) => {
+	let t = n();
+	await e({
+		raw: t,
+		annotateScreenshot: (e, n) => i(t, e, n)
+	});
+} });
+async function i(e, t, n) {
+	let r = await t.screenshot({ fullPage: n.fullPage }), { width: i, height: o } = a(r), s = `data:image/png;base64,${r.toString("base64")}`;
+	return e.toPng({
+		originalDataUrl: s,
+		annotationsSvg: n.annotationsSvg,
+		width: i,
+		height: o
+	});
+}
+function a(e) {
+	if (e.length < 24) throw Error("PNG too short to contain IHDR chunk");
+	let t = new DataView(e.buffer, e.byteOffset, e.byteLength);
+	return {
+		width: t.getUint32(16, !1),
+		height: t.getUint32(20, !1)
+	};
+}
+//#endregion
+//#region src/helpers.ts
+function o(e, t = {}) {
+	let n = t.stroke ?? "red", r = t.strokeWidth ?? 2, i = t.fill ?? "none";
+	return `<rect x="${e.x}" y="${e.y}" width="${e.width}" height="${e.height}" fill="${d(i)}" stroke="${d(n)}" stroke-width="${r}"/>`;
+}
+function s(e, t, n = {}) {
+	let r = n.color ?? "red", i = n.strokeWidth ?? 2, a = `annot-pw-arrow-${u()}`;
+	return `<defs><marker id="${a}" viewBox="0 0 10 10" refX="9" refY="5" markerWidth="6" markerHeight="6" orient="auto" markerUnits="strokeWidth"><path d="M 0 0 L 10 5 L 0 10 z" fill="${d(r)}"/></marker></defs><line x1="${e.x}" y1="${e.y}" x2="${t.x}" y2="${t.y}" stroke="${d(r)}" stroke-width="${i}" marker-end="url(#${a})"/>`;
+}
+function c(e, t, n = {}) {
+	let r = n.color ?? "red", i = n.fontSize ?? 14, a = n.anchor ?? "start";
+	return `<text x="${e.x}" y="${e.y}" fill="${d(r)}" font-size="${i}" text-anchor="${a}">` + f(t) + "</text>";
+}
+var l = 0;
+function u() {
+	return l = l + 1 | 0, l;
+}
+function d(e) {
+	return e.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
+}
+function f(e) {
+	return e.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+}
+//#endregion
+export { i as annotateScreenshot, s as arrowBetween, e as expect, o as rectForBoundingBox, r as test, c as textAt };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@ingcreators/annot-playwright",
+  "version": "0.1.0",
+  "description": "Playwright fixture for annotated screenshots — emit annotated PNGs from failing tests without leaving the test file. Pairs `test.extend({ annotator })` with the headless renderer from @ingcreators/annot-annotator.",
+  "license": "Apache-2.0",
+  "author": "ingcreators",
+  "homepage": "https://github.com/ingcreators/annot/tree/main/packages/playwright#readme",
+  "bugs": {
+    "url": "https://github.com/ingcreators/annot/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ingcreators/annot.git",
+    "directory": "packages/playwright"
+  },
+  "keywords": [
+    "annotation",
+    "screenshot",
+    "playwright",
+    "fixture",
+    "testing",
+    "ci",
+    "headless",
+    "svg",
+    "png"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.50.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.13",
+    "vite-plugin-dts": "^5.0.0"
+  },
+  "dependencies": {
+    "@ingcreators/annot-annotator": "0.1.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.40.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "typecheck": "tsc --noEmit"
+  }
+}