@ingcreators/annot-playwright 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @ingcreators/annot-playwright
 
+## 0.5.0
+
+### Minor Changes
+
+- Editable screenshots (`page.screenshot({ annot: { … } })`) now
+  stamp schema-2.0 provenance into the XMP packet: the page URL as
+  `annot:sourceUrl`, the capture moment as `annot:createdAt`, and
+  `annot:producer = "playwright"`.
+
+### Patch Changes
+
+- Updated dependencies
+- Updated dependencies
+  - @ingcreators/annot-annotator@0.7.0
+  - @ingcreators/annot-core@0.4.0
+
+## 0.4.2
+
+### Patch Changes
+
+- Updated dependencies [b47d896]
+  - @ingcreators/annot-core@0.3.1
+  - @ingcreators/annot-annotator@0.6.0
+
 ## 0.4.1
 
 ### Patch Changes

package/dist/element-tree-adapter.d.ts

@@ -48,8 +48,12 @@ export declare function playwrightYamlToElementTree(opts: PlaywrightYamlToElemen
  * resolving its `match: { role, name }` against the live page.
  */
 export interface AttachAttributesOptions {
-    /** Whitelist of HTML attribute names to capture. Same shape as
-     *  `DEFAULT_ATTR_WHITELIST` in `@ingcreators/annot-product-docs`. */
+    /** Whitelist of HTML attribute names to capture. Callers should
+     *  pass the canonical `ELEMENT_TREE_ATTR_WHITELIST` from
+     *  `@ingcreators/annot-core/element-tree` (which
+     *  `@ingcreators/annot-product-docs` re-exports as its
+     *  `DEFAULT_ATTR_WHITELIST`) unless they have a reason to
+     *  diverge. */
     whitelist: readonly string[];
 }
 /**

package/dist/index.js

@@ -255,7 +255,7 @@ function F(e) {
 	let n = e.screenshot;
 	e.screenshot = async function(e = {}) {
 		let t = e?.annot;
-		return I(t) ? z.call(this, n, e) : n.call(this, e);
+		return I(t) ? B.call(this, n, e) : n.call(this, e);
 	}, t[M] = !0;
 }
 function I(e) {
@@ -270,7 +270,14 @@ function L(e) {
 function R(e) {
 	return L(e) ? e.page() : e;
 }
-async function z(e, t) {
+function z(e) {
+	try {
+		return typeof e.url == "function" ? e.url() : "";
+	} catch {
+		return "";
+	}
+}
+async function B(e, t) {
 	let { annot: n, path: r, ...i } = t, a = i, o = n.editable ?? !0, s = {
 		annot: n,
 		page: R(this),
@@ -278,19 +285,20 @@ async function z(e, t) {
 	}, c = (await Promise.all(N.map((e) => e(s)))).filter((e) => e !== null), l = (n.overlays?.length ?? 0) > 0 || !!n.tags;
 	if (c.length === 0 && !l) return e.call(this, t);
 	for (let e of c) e.prepare && await e.prepare();
-	let u = await B(this, t.clip), f = await H({
-		rawBytes: V(await e.call(this, {
+	let u = await V(this, t.clip), f = await U({
+		rawBytes: H(await e.call(this, {
 			...a,
 			path: void 0
 		})),
 		annot: n,
 		editable: o,
 		clip: u,
-		contributions: c
+		contributions: c,
+		sourceUrl: z(R(this))
 	});
 	return r && await d(r, f), Buffer.from(f);
 }
-async function B(e, t) {
+async function V(e, t) {
 	if (L(e)) {
 		let t = await e.boundingBox();
 		if (!t) throw Error("locator.screenshot({ annot }): locator has no bounding box (probably not visible). Re-test with a stable selector / waitFor().");
@@ -298,11 +306,11 @@ async function B(e, t) {
 	}
 	return t ?? null;
 }
-function V(e) {
+function H(e) {
 	return e instanceof Uint8Array && !(e instanceof Buffer) ? e : new Uint8Array(e.buffer, e.byteOffset, e.byteLength);
 }
-async function H(e) {
-	let { rawBytes: t, annot: n, editable: r, clip: a, contributions: o } = e, s = K(t), c = [], l = a ? {
+async function U(e) {
+	let { rawBytes: t, annot: n, editable: r, clip: a, contributions: o } = e, s = q(t), c = [], l = a ? {
 		width: a.x + a.width,
 		height: a.y + a.height
 	} : s;
@@ -314,11 +322,11 @@ async function H(e) {
 	let u;
 	if (a) {
 		let { kept: e, dropped: t } = g(c, a);
-		u = e, t.length > 0 && W(t);
+		u = e, t.length > 0 && G(t);
 	} else u = c;
 	let d = o.length > 0 || !!n.overlays;
 	if (d && !r) {
-		let e = U(u), r = `data:image/png;base64,${Buffer.from(t).toString("base64")}`, a = i({ loadSystemFonts: !0 }).toPng({
+		let e = W(u), r = `data:image/png;base64,${Buffer.from(t).toString("base64")}`, a = i({ loadSystemFonts: !0 }).toPng({
 			originalDataUrl: r,
 			annotationsSvg: e,
 			width: s.width,
@@ -327,25 +335,28 @@ async function H(e) {
 		return n.tags ? f(a, n.tags) : a;
 	}
 	if (d) {
-		let e = U(u), r = `data:image/png;base64,${Buffer.from(t).toString("base64")}`;
+		let r = W(u), a = `data:image/png;base64,${Buffer.from(t).toString("base64")}`;
 		return i({ loadSystemFonts: !0 }).toEditablePng({
-			originalDataUrl: r,
-			annotationsSvg: e,
+			originalDataUrl: a,
+			annotationsSvg: r,
 			width: s.width,
 			height: s.height,
-			tags: n.tags
+			tags: n.tags,
+			sourceUrl: e.sourceUrl,
+			createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+			producer: "playwright"
 		});
 	}
 	return n.tags ? f(t, n.tags) : t;
 }
-function U(e) {
+function W(e) {
 	return e.length === 0 ? "<svg xmlns=\"http://www.w3.org/2000/svg\"></svg>" : `<svg xmlns="http://www.w3.org/2000/svg">${r(e)}</svg>`;
 }
-function W(e) {
+function G(e) {
 	let t = e.map(j).join(", "), n = `annot fixture: dropped ${e.length} overlay(s) outside the screenshot clip — ${t}`;
-	console.warn(n), G(n, e);
+	console.warn(n), K(n, e);
 }
-function G(e, t) {
+function K(e, t) {
 	try {
 		let n = l.info?.();
 		if (!n?.annotations) return;
@@ -355,7 +366,7 @@ function G(e, t) {
 		});
 	} catch {}
 }
-function K(e) {
+function q(e) {
 	if (e.length < 24) throw Error("Playwright annot fixture: raw screenshot too short to contain PNG IHDR.");
 	let t = new DataView(e.buffer, e.byteOffset, e.byteLength);
 	return {
@@ -365,20 +376,20 @@ function K(e) {
 }
 //#endregion
 //#region src/fixture.ts
-var q = l.extend({
+var J = l.extend({
 	annotator: async ({}, e) => {
 		let t = i();
 		await e({
 			raw: t,
-			annotateScreenshot: (e, n) => J(t, e, n)
+			annotateScreenshot: (e, n) => Y(t, e, n)
 		});
 	},
 	page: async ({ page: e }, t) => {
 		F(Object.getPrototypeOf(e)), F(Object.getPrototypeOf(e.locator("html"))), await t(e);
 	}
 });
-async function J(t, n, i) {
-	let o = await n.screenshot({ fullPage: i.fullPage }), { width: s, height: c } = Y(o), l = `data:image/png;base64,${o.toString("base64")}`, u = "annotations" in i && i.annotations !== void 0 ? r(i.annotations) : i.annotationsSvg ?? "", d = t.toPng({
+async function Y(t, n, i) {
+	let o = await n.screenshot({ fullPage: i.fullPage }), { width: s, height: c } = X(o), l = `data:image/png;base64,${o.toString("base64")}`, u = "annotations" in i && i.annotations !== void 0 ? r(i.annotations) : i.annotationsSvg ?? "", d = t.toPng({
 		originalDataUrl: l,
 		annotationsSvg: u,
 		width: s,
@@ -389,7 +400,7 @@ async function J(t, n, i) {
 		...i.encode
 	})).bytes;
 }
-function Y(e) {
+function X(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 {
@@ -398,4 +409,4 @@ function Y(e) {
 	};
 }
 //#endregion
-export { M as ANNOT_PATCHED, N as annotSourceResolvers, J as annotateScreenshot, t as arrowBetween, m as attachAttributes, n as bboxAnnotationsToSvg, h as captureElementTree, j as describeAnnotation, c as expect, F as patchScreenshot, p as playwrightYamlToElementTree, g as rebaseAnnotations, o as rectForBoundingBox, q as test, s as textAt };
+export { M as ANNOT_PATCHED, N as annotSourceResolvers, Y as annotateScreenshot, t as arrowBetween, m as attachAttributes, n as bboxAnnotationsToSvg, h as captureElementTree, j as describeAnnotation, c as expect, F as patchScreenshot, p as playwrightYamlToElementTree, g as rebaseAnnotations, o as rectForBoundingBox, J as test, s as textAt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingcreators/annot-playwright",
-  "version": "0.4.1",
+  "version": "0.5.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",
@@ -44,12 +44,12 @@
   "devDependencies": {
     "@playwright/test": "^1.61.1",
     "typescript": "^6.0.3",
-    "vite": "^8.0.16",
+    "vite": "^8.1.3",
     "vite-plugin-dts": "^5.0.3"
   },
   "dependencies": {
-    "@ingcreators/annot-annotator": "0.6.0",
-    "@ingcreators/annot-core": "0.3.0"
+    "@ingcreators/annot-annotator": "0.7.0",
+    "@ingcreators/annot-core": "0.4.0"
   },
   "peerDependencies": {
     "@playwright/test": "^1.40.0"