@ingcreators/annot-annotator 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ingcreators/annot-annotator
+
+## 0.1.0
+
+### Minor Changes
+
+- 408791f: Initial public release — headless annotator + Playwright fixture + SDK.

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,132 @@
+# `@ingcreators/annot-annotator`
+
+Headless annotator — produce annotated screenshots from Node without
+a browser. Reads an `ImageRecord`-shaped input (base image + saved
+annotations SVG) and emits a PNG or the merged SVG.
+
+> **Status:** Workspace package, not yet published to npm. The public
+> API is stable; the package becomes installable in Phase 3 of the
+> headless-annotator track (gated on Changesets).
+>
+> Companion package: `@ingcreators/annot-playwright` (Phase 2 of the
+> same track) — a Playwright fixture composing this annotator into
+> idiomatic `test.extend({ annotator })` form.
+
+## Install (post-publish)
+
+```sh
+npm install @ingcreators/annot-annotator
+# or
+pnpm add @ingcreators/annot-annotator
+```
+
+## Usage
+
+```ts
+import { createAnnotator } from "@ingcreators/annot-annotator";
+import { writeFileSync } from "node:fs";
+
+const annotator = createAnnotator({
+  // Optional — register fonts so CJK / Arabic / Indic / Thai glyphs
+  // render correctly. Without these, resvg-js falls back to its
+  // built-in font and unusual scripts may render as boxes.
+  fontFiles: ["./fonts/NotoSans-Regular.ttf"],
+  defaultFontFamily: "Noto Sans",
+});
+
+const png = annotator.toPng({
+  originalDataUrl: "data:image/png;base64,...",  // base bitmap
+  annotationsSvg: "<svg ...>...</svg>",          // editor's saved output
+  width: 1280,
+  height: 720,
+});
+
+writeFileSync("./annotated.png", png);
+```
+
+Or get just the merged SVG without rasterisation:
+
+```ts
+const svg: string = annotator.toSvg({ ... });
+```
+
+## API
+
+### `createAnnotator(options?: AnnotatorOptions): Annotator`
+
+Construct an annotator. The instance is stateless — reuse it across
+calls. Per-call inputs are passed to `toPng` / `toSvg`.
+
+`AnnotatorOptions`:
+
+| Field | Type | Default | Notes |
+|---|---|---|---|
+| `fontFiles` | `string[]` | `[]` | Absolute paths to TTF / OTF files |
+| `fontDirs` | `string[]` | `[]` | Absolute paths to directories of font files |
+| `loadSystemFonts` | `boolean` | `false` | `false` for CI determinism; opt in to system fonts |
+| `defaultFontFamily` | `string` | resvg default | Fallback when an annotation references an unknown family |
+
+`Annotator`:
+
+- `toPng(input: AnnotatorInput): Uint8Array` — rasterise to PNG bytes.
+- `toSvg(input: AnnotatorInput): string` — merged SVG (base image +
+  sanitised annotations); no rasterisation.
+
+`AnnotatorInput` is a structural subset of `ImageRecord` (a real
+`ImageRecord` from `@ingcreators/annot-core/storage` works):
+
+```ts
+interface AnnotatorInput {
+  originalDataUrl: string;   // base bitmap as data: URL
+  annotationsSvg: string;    // editor's saved annotations.svg
+  width: number;             // output pixel width
+  height: number;            // output pixel height
+}
+```
+
+## What the annotator does to the input SVG
+
+The editor's `exportAnnotationsSvgForIdb` already strips
+`#ui-overlay`, the base bitmap inside the wrapper, and the
+`<g id="annotations">` wrapper — but the `<style data-annot-fonts>`
+block survives, and we want defensive handling for any future code
+path that doesn't go through `exportAnnotationsSvgForIdb` first.
+
+The annotator's sanitiser:
+
+- Keeps `<defs>` but removes any `<style data-annot-fonts>` inside
+  (the editor injects this for self-contained SVG export; resvg
+  can't use it).
+- Skips top-level `<image>` with no `data-redact-style` (legacy
+  base-bitmap-in-wrapper). Mosaic / blur redact images carry
+  `data-redact-style` and survive.
+- Skips `<g id="ui-overlay">` and `<g id="annotations">` wrappers
+  (lifting the latter's children).
+- Passes everything else through unchanged.
+
+## Limitations (known, with Phase 1.5+ follow-ups planned)
+
+- **PNG output only.** JPEG round-trip parity with the browser-
+  side `renderImageRecord` requires `sharp` (or equivalent) to
+  pipe PNG → JPEG. Phase 1.5 brings this as an optional peer dep.
+- **No bundled fonts.** Pass `fontFiles` / `fontDirs` yourself.
+  For deterministic CI rendering across distros, bundle the fonts
+  with your test suite.
+
+## How this fits the bigger picture
+
+This package is Phase 1 of the headless-annotator track in the Annot
+productization roadmap (top-priority strategic moat per
+`PRODUCT_DIRECTION.md`). Phase 2 — `@ingcreators/annot-playwright` —
+wraps this annotator in a Playwright fixture so test engineers can
+emit annotated screenshots from failing assertions in CI.
+
+See also:
+
+- [`docs/plans/_done/headless-annotator-spike.md`](../../docs/plans/_done/headless-annotator-spike.md)
+  — Phase 0 feasibility report (`@resvg/resvg-js` vs
+  `@napi-rs/canvas` trade-offs; documented gaps).
+- [`docs/plans/annot-annotator-package.md`](../../docs/plans/annot-annotator-package.md)
+  — Phase 1 design + rationale for the public API shape.
+- [`PRODUCT_DIRECTION.md`](../../PRODUCT_DIRECTION.md) — strategic
+  context (Playwright + GitHub vectors).

package/dist/annotator.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Structural shape the annotator accepts. A real `ImageRecord`
+ * from `@ingcreators/annot-core/storage` satisfies this — the
+ * extra storage fields (path, tags, timestamps, …) are ignored.
+ */
+export interface AnnotatorInput {
+    /** Base image as a `data:` URL. PNG or JPEG accepted; output is PNG. */
+    originalDataUrl: string;
+    /**
+     * Editor's saved annotations SVG. Full `<svg>` wrapper expected.
+     * Editor-internal artefacts (`<style data-annot-fonts>`, legacy
+     * base-image, `#ui-overlay`, `#annotations` wrapper) are stripped
+     * before rasterisation.
+     */
+    annotationsSvg: string;
+    /** Output PNG width in pixels — should match the source bitmap. */
+    width: number;
+    /** Output PNG height in pixels — should match the source bitmap. */
+    height: number;
+}
+/** Annotator construction options. All optional. */
+export interface AnnotatorOptions {
+    /**
+     * Absolute paths to font files (TTF / OTF) that should be loaded
+     * into the rasteriser's font set. Forwarded to resvg-js's
+     * `font.fontFiles`.
+     */
+    fontFiles?: string[];
+    /**
+     * Absolute paths to directories whose font files should be loaded
+     * into the rasteriser's font set. Forwarded to resvg-js's
+     * `font.fontDirs`.
+     */
+    fontDirs?: string[];
+    /**
+     * Whether to load fonts from the OS. **Default: `false`** (one
+     * behaviour change vs resvg-js's `true` default — CI determinism
+     * matters more than "looks right on the dev's mac"). Opt in
+     * explicitly when you want system-resolved fonts.
+     */
+    loadSystemFonts?: boolean;
+    /**
+     * Fallback font family name used when an annotation references a
+     * font that isn't in the loaded set. Forwarded to resvg-js's
+     * `font.defaultFontFamily`.
+     */
+    defaultFontFamily?: string;
+}
+/**
+ * Annotator instance returned by {@link createAnnotator}. Use
+ * `toPng` to rasterise; use `toSvg` to get the merged SVG without
+ * rasterisation (useful for piping into another tool, or for
+ * inspecting what the annotator would render).
+ */
+export interface Annotator {
+    /**
+     * Rasterise the input to a PNG byte array. JPEG output is not
+     * yet supported — Phase 1.5 brings `sharp` as an optional peer
+     * dep.
+     */
+    toPng(input: AnnotatorInput): Uint8Array;
+    /**
+     * Build the rasterise-ready SVG string (base image + sanitised
+     * annotations). No rasterisation; returns the SVG as a string
+     * the caller can feed to any other SVG tool.
+     */
+    toSvg(input: AnnotatorInput): string;
+}
+/**
+ * Construct a headless annotator. Options are forwarded to the
+ * underlying resvg-js rasteriser (font registration, default
+ * family, etc.).
+ *
+ * The annotator is stateless — calling `toPng` / `toSvg` multiple
+ * times with different inputs is safe and concurrent-friendly.
+ * Construct one annotator per font set and reuse it.
+ */
+export declare function createAnnotator(options?: AnnotatorOptions): Annotator;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { type Annotator, type AnnotatorInput, type AnnotatorOptions, createAnnotator, } from './annotator.js';

package/dist/index.js

@@ -0,0 +1,80 @@
+import { Resvg as e } from "@resvg/resvg-js";
+import { DOMParser as t, XMLSerializer as n } from "@xmldom/xmldom";
+//#region ../core/src/editor/svg-format.ts
+var r = "data-annot-version";
+//#endregion
+//#region src/sanitise-svg.ts
+function i(e) {
+	if (!e || e.trim().length === 0) return "";
+	let r = new t(), i;
+	try {
+		i = r.parseFromString(e, "image/svg+xml");
+	} catch {
+		return "";
+	}
+	let o = i.documentElement;
+	if (!o) return "";
+	let s = new n(), c = "";
+	for (let e = 0; e < o.childNodes.length; e++) {
+		let t = o.childNodes.item(e);
+		if (!t || t.nodeType !== 1) continue;
+		let n = t, r = n.localName ?? n.tagName ?? "";
+		if (r === "defs") {
+			let e = a(n);
+			e !== null && (c += s.serializeToString(e));
+			continue;
+		}
+		if (!(r === "image" && !n.getAttribute("data-redact-style")) && n.getAttribute("id") !== "ui-overlay") {
+			if (n.getAttribute("id") === "annotations") {
+				for (let e = 0; e < n.childNodes.length; e++) {
+					let t = n.childNodes.item(e);
+					t && t.nodeType === 1 && (c += s.serializeToString(t));
+				}
+				continue;
+			}
+			c += s.serializeToString(n);
+		}
+	}
+	return c;
+}
+function a(e) {
+	let t = e.cloneNode(!0);
+	for (let e = t.childNodes.length - 1; e >= 0; e--) {
+		let n = t.childNodes.item(e);
+		if (!n || n.nodeType !== 1) continue;
+		let r = n;
+		(r.localName ?? r.tagName ?? "") === "style" && r.hasAttribute("data-annot-fonts") && t.removeChild(n);
+	}
+	return t.childNodes.length === 0 ? null : t;
+}
+//#endregion
+//#region src/annotator.ts
+function o(t = {}) {
+	let n = {
+		loadSystemFonts: t.loadSystemFonts ?? !1,
+		...t.fontFiles ? { fontFiles: t.fontFiles } : {},
+		...t.fontDirs ? { fontDirs: t.fontDirs } : {},
+		...t.defaultFontFamily ? { defaultFontFamily: t.defaultFontFamily } : {}
+	};
+	return {
+		toSvg(e) {
+			return s(e);
+		},
+		toPng(t) {
+			return new e(s(t), {
+				fitTo: {
+					mode: "width",
+					value: t.width
+				},
+				background: "rgba(0, 0, 0, 0)",
+				font: n
+			}).render().asPng();
+		}
+	};
+}
+function s(e) {
+	let t = i(e.annotationsSvg);
+	return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" ${r}="1" width="${e.width}" height="${e.height}" viewBox="0 0 ${e.width} ${e.height}"><image href="${e.originalDataUrl}" width="${e.width}" height="${e.height}"/>` + t + "</svg>";
+}
+//#endregion
+export { o as createAnnotator };

package/dist/sanitise-svg.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Strip editor-internal artefacts from a saved annotations SVG and
+ * return the **inner content** (no outer `<svg>` wrapper) so the
+ * caller can compose it with their own base image + outer wrapper.
+ *
+ * Walks the root `<svg>`'s children:
+ * - `<defs>` — kept; child `<style data-annot-fonts>` removed.
+ * - Top-level `<image>` with no `data-redact-style` attr — skipped
+ *   (it's a base bitmap; mosaic/blur redacts also use `<image>`
+ *   but carry `data-redact-style` so they survive).
+ * - `<g id="ui-overlay">` — skipped.
+ * - `<g id="annotations">` — children lifted into the inner XML.
+ * - Everything else — passed through unchanged.
+ *
+ * Returns the empty string for empty / whitespace-only input so
+ * the caller doesn't have to special-case it.
+ */
+export declare function sanitiseAnnotationsSvg(annotationsSvg: string): string;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@ingcreators/annot-annotator",
+  "version": "0.1.0",
+  "description": "Headless annotator — render annotated screenshots from Node without a browser. Built on @resvg/resvg-js. Pairs with @ingcreators/annot-playwright for fail-on-test annotated reports.",
+  "license": "Apache-2.0",
+  "author": "ingcreators",
+  "homepage": "https://github.com/ingcreators/annot/tree/main/packages/annotator#readme",
+  "bugs": {
+    "url": "https://github.com/ingcreators/annot/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ingcreators/annot.git",
+    "directory": "packages/annotator"
+  },
+  "keywords": [
+    "annotation",
+    "screenshot",
+    "headless",
+    "node",
+    "svg",
+    "png",
+    "resvg",
+    "playwright",
+    "ci",
+    "testing"
+  ],
+  "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": {
+    "typescript": "^6.0.3",
+    "vite": "^8.0.13",
+    "vite-plugin-dts": "^5.0.0",
+    "@ingcreators/annot-core": "0.1.0"
+  },
+  "dependencies": {
+    "@resvg/resvg-js": "^2.6.2",
+    "@xmldom/xmldom": "^0.9.10"
+  },
+  "scripts": {
+    "build": "vite build",
+    "typecheck": "tsc --noEmit"
+  }
+}