@ingcreators/annot-mcp 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @ingcreators/annot-mcp
+
+## 0.1.0
+
+### Minor Changes
+
+- Initial public release of `@ingcreators/annot-mcp` — Model Context Protocol stdio server exposing the Annot headless annotator as five agent-callable tools: `annot_annotate_screenshot`, `annot_annotate_url` (locator-first), `annot_redact_screenshot`, `annot_redact_url`, `annot_compare_screenshots`. Pairs naturally with `@playwright/mcp` for multi-step browser flows; runs standalone for single-URL annotation + redaction + visual-diff workflows. See `docs/ai-agents.md`.

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,340 @@
+# `@ingcreators/annot-mcp`
+
+Model Context Protocol server exposing the
+[`@ingcreators/annot-annotator`](../annotator/README.md) headless
+annotator as agent-callable tools. Drop into Claude Desktop /
+Claude Code / Cursor / Continue and an AI agent can compose Annot
+with `@playwright/mcp` + GitHub MCP into autonomous
+browser-driven workflows:
+
+- **Bug-report autopilot** — agent navigates to a staging URL,
+  identifies a broken element, files a GitHub issue with an
+  annotated screenshot in one conversation turn.
+- **Visual-diff PR review** — agent screenshots the same page on
+  two branches, posts the diff with changed regions highlighted.
+- **Locator-first annotation** — agent says `{ type: "rect",
+  locator: "button:has-text('Submit')", intent: "error" }` in a
+  single MCP call; the server handles capture + locator
+  resolution + render.
+
+> **Status:** under construction. Phases 1–5 + 7 of
+> [`docs/plans/agent-mcp-integration.md`](../../docs/plans/agent-mcp-integration.md)
+> have landed; the package is `private: true` in the workspace
+> until Phase 8 (gated on
+> [`docs/plans/headless-annotator-publish.md`](../../docs/plans/headless-annotator-publish.md))
+> flips it for the first npm publish. Phase 6 (PPTX export) is
+> deferred indefinitely per the plan.
+
+## Installation
+
+After Phase 8 publish:
+
+```sh
+# Once globally (or via npx per-call)
+npm install -g @ingcreators/annot-mcp
+
+# Chromium runtime for `_url` tools — one-time, ~150 MB download
+npx playwright install chromium
+```
+
+Then wire into your MCP client config. For Claude Desktop
+(`~/Library/Application Support/Claude/claude_desktop_config.json`
+on macOS, `%APPDATA%\Claude\claude_desktop_config.json` on
+Windows):
+
+```json
+{
+  "mcpServers": {
+    "annot": {
+      "command": "npx",
+      "args": ["@ingcreators/annot-mcp"]
+    },
+    "playwright": {
+      "command": "npx",
+      "args": ["@playwright/mcp@latest"]
+    }
+  }
+}
+```
+
+Restart the client. The five `annot_*` tools appear alongside
+playwright-mcp's `browser_*` tools and any other MCP servers
+you've configured.
+
+## The five tools
+
+Each tool returns an MCP `image` content block (base64 PNG)
+inline in the agent's conversation, OR — when `output` is set
+to an absolute path — writes the PNG to disk and returns a
+text confirmation.
+
+### `annot_annotate_screenshot`
+
+Overlay annotations on a pre-captured PNG.
+
+**Inputs:**
+- `image` — `data:image/png;base64,...` URL or absolute path.
+- `annotations` — array of `BboxAnnotation` (see DSL below).
+- `output` (optional) — absolute path.
+
+### `annot_annotate_url`
+
+Open a URL in headless Chromium, capture, overlay annotations
+positioned by Playwright locator strings (or bboxes). The
+headline locator-first tool — one MCP call replaces the
+multi-step `playwright-mcp.browser_navigate` →
+`browser_screenshot` → `browser_locator` × N →
+`annot_annotate_screenshot` flow.
+
+**Inputs:**
+- `url` — page URL.
+- `annotations` — array of `LocatorAnnotation` (locator string
+  or coordinate).
+- `viewport` (optional) — `{ width, height, deviceScaleFactor }`,
+  default 1280×800 at 1×.
+- `fullPage` (optional, default `false`).
+- `waitFor` (optional, default `"load"`) — `"load"` /
+  `"domcontentloaded"` / `"networkidle"`.
+- `output` (optional).
+
+### `annot_redact_screenshot`
+
+Destructively burn redactions (solid / mosaic / blur) into a
+PNG. Original pixels under each region are irrecoverably
+replaced.
+
+**Inputs:**
+- `image` — same as `annot_annotate_screenshot`.
+- `regions` — array of `{ bbox, style?, color? }`. `style` is
+  `"solid"` (default) / `"mosaic"` / `"blur"`.
+- `output` (optional).
+
+### `annot_redact_url`
+
+Live-capture variant of redact. Regions accept locator strings
+or bboxes.
+
+**Inputs:**
+- `url` / `viewport` / `fullPage` / `waitFor` / `output` — same
+  as `annot_annotate_url`.
+- `regions` — array of `{ bbox | locator, style?, color? }`.
+
+### `annot_compare_screenshots`
+
+Pixel-perfect diff between two PNGs of identical dimensions.
+Returns a PNG of the `after` image with changed regions
+highlighted as `warning`-intent rects.
+
+**Inputs:**
+- `before` / `after` — PNG inputs (data URL or absolute path).
+- `threshold` (optional, default `0.1`) — pixelmatch
+  sensitivity (0 = strict, 1 = permissive).
+- `includeChangeList` (optional) — when `true`, append a text
+  content block listing the changed-region bboxes.
+- `output` (optional).
+
+## The annotation DSL
+
+Two flavours. `BboxAnnotation` (used by `_screenshot` tools)
+requires explicit positions; `LocatorAnnotation` (used by `_url`
+tools) accepts Playwright locator strings or coordinates.
+
+### Intent shorthand
+
+Every annotation accepts an `intent: "info" | "warning" | "error"
+| "success" | "neutral"` that resolves to the Annot design
+system's semantic colours:
+
+| Intent | Stroke | Text |
+|---|---|---|
+| `info` | `#3b82f6` | `#1e40af` |
+| `warning` | `#f59e0b` | `#92400e` |
+| `error` (default) | `#ef4444` | `#991b1b` |
+| `success` | `#10b981` | `#065f46` |
+| `neutral` | `#6b7280` | `#374151` |
+
+Explicit `stroke` / `color` / `fill` override the intent
+defaults.
+
+### Annotation types
+
+```ts
+// BboxAnnotation (for _screenshot tools).
+type BboxAnnotation =
+  | { type: "rect"; bbox: BBox; intent?: Intent; ... }
+  | { type: "circle"; center: Point; radius: number; ... }
+  | { type: "arrow"; from: Point; to: Point; ... }
+  | { type: "text"; at: Point; content: string; fontSize?: number; ... }
+  | { type: "callout"; at: Point; targetBbox: BBox; content: string; ... }
+  | { type: "raw"; svgFragment: string };
+
+// LocatorAnnotation (for _url tools). Same shapes — but you can
+// substitute `locator` (or `fromLocator` / `toLocator` /
+// `atLocator` / `targetLocator`) for any coordinate field.
+type LocatorAnnotation =
+  | { type: "rect"; bbox?: BBox; locator?: string; ... }
+  | { type: "circle"; center?: Point; radius?: number; locator?: string; ... }
+  | { type: "arrow"; from?: Point; fromLocator?: string;
+                     to?: Point; toLocator?: string; ... }
+  | { type: "text"; at?: Point; locator?: string; content: string; ... }
+  | { type: "callout"; at?: Point; atLocator?: string;
+                       targetBbox?: BBox; targetLocator?: string;
+                       content: string; ... }
+  | { type: "raw"; svgFragment: string };
+```
+
+### Non-rect locator adaptation
+
+When a `locator` resolves to a bounding box on a non-rect shape:
+
+- **circle** — center = bbox centroid; radius = `min(w, h) / 2`.
+- **arrow** endpoint — bbox centroid.
+- **text** — `at` = bbox top-left, raised one font line above so
+  the caption sits above the element.
+- **callout** — `targetLocator` becomes the highlighted rect;
+  `atLocator` becomes the caption anchor (also centroid).
+
+## Two end-to-end transcripts
+
+### A. Locator-first standalone — bug-report autopilot
+
+```
+USER: Go to https://staging.example.com/login, find any disabled
+      submit button, and file a GitHub issue against
+      ingcreators/example with an annotated screenshot.
+
+AGENT → annot.annot_annotate_url({
+          url: "https://staging.example.com/login",
+          annotations: [
+            { type: "rect",
+              locator: "button:has-text('Submit')",
+              intent: "error" },
+            { type: "callout",
+              atLocator: "form",
+              targetLocator: "button:has-text('Submit')",
+              content: "Submit button is disabled" }
+          ]
+        })
+        ← annotated PNG inline
+AGENT → github.create_issue({
+          repo: "ingcreators/example",
+          title: "Login form: Submit button disabled on staging",
+          body: "...", // PNG attached
+        })
+        ← issue URL
+AGENT: Filed https://github.com/ingcreators/example/issues/42.
+```
+
+### B. Composing with `@playwright/mcp` — multi-step flow
+
+For workflows that need interactivity (sign-in, click, wait)
+before the capture, drive the browser through
+`@playwright/mcp` and feed its screenshot output to
+`annot_annotate_screenshot`:
+
+```
+USER: Log in as alice@example.com on staging, navigate to the
+      dashboard, annotate the "team analytics" panel for the
+      onboarding doc.
+
+AGENT → playwright.browser_navigate({ url: ".../login" })
+AGENT → playwright.browser_fill({ selector: "[name=email]",
+                                  text: "alice@example.com" })
+AGENT → playwright.browser_fill({ selector: "[name=password]",
+                                  text: <secret> })
+AGENT → playwright.browser_click({ selector: "button:has-text('Sign in')" })
+AGENT → playwright.browser_wait_for_url({ pattern: "**/dashboard" })
+AGENT → playwright.browser_screenshot({ fullPage: true })
+        ← bytes
+AGENT → playwright.browser_locator({
+          selector: "[data-testid='team-analytics']" })
+        ← bbox
+AGENT → annot.annot_annotate_screenshot({
+          image: <PNG>,
+          annotations: [
+            { type: "rect", bbox, intent: "success" },
+            { type: "callout", at: { x: 20, y: bbox.y - 40 },
+              targetBbox: bbox,
+              content: "Team analytics — review weekly" }
+          ]
+        })
+        ← annotated PNG
+```
+
+The MCP server stays browser-free in this flow — Annot's
+`annot_annotate_url` is the one-shot path, `annot_annotate_screenshot`
+is the composable primitive.
+
+## Package boundaries
+
+| File / module | Role |
+|---|---|
+| `bin/annot-mcp.mjs` | CLI shim — boots the server over stdio |
+| `src/server.ts` | `createServer()` factory — wires tools + dispatch |
+| `src/transport.ts` | `runStdioServer()` — stdio transport |
+| `src/dsl/types.ts` | `BboxAnnotation` + `LocatorAnnotation` unions |
+| `src/dsl/schema.ts` | JSON Schema literals for MCP `inputSchema` |
+| `src/dsl/to-svg.ts` | DSL → SVG fragment converter |
+| `src/dsl/svg-primitives.ts` | Tier A SVG fragment builders |
+| `src/io/png-dimensions.ts` | PNG IHDR width/height parser |
+| `src/io/read-image.ts` | data URL / filesystem → bytes + dims |
+| `src/browser/pool.ts` | `BrowserPool` — refcounted lifecycle |
+| `src/browser/capture.ts` | `capturePage()` — Chromium navigate + screenshot |
+| `src/browser/resolve-locator.ts` | locator string → bbox + per-shape adaptation |
+| `src/redact/burn.ts` | `burnRedactions()` — canvas-side destructive overlay |
+| `src/compare/diff.ts` | `diffScreenshots()` — pixelmatch wrapper |
+| `src/compare/aggregate.ts` | `aggregateDiffRegions()` — flood-fill bbox extraction |
+| `src/tools/annotate-screenshot.ts` | `annot_annotate_screenshot` |
+| `src/tools/annotate-url.ts` | `annot_annotate_url` |
+| `src/tools/redact-screenshot.ts` | `annot_redact_screenshot` |
+| `src/tools/redact-url.ts` | `annot_redact_url` |
+| `src/tools/compare-screenshots.ts` | `annot_compare_screenshots` |
+
+## Runtime dependencies
+
+- `@modelcontextprotocol/sdk` — MCP protocol implementation.
+- `@ingcreators/annot-annotator` — Tier A headless rasteriser.
+- `@napi-rs/canvas` — Node canvas for redact + diff (~80 MB
+  native binding, prebuilt binaries per OS).
+- `playwright-core` — Chromium driver for `_url` tools. The
+  Chromium binary is a separate `npx playwright install chromium`
+  step the user runs once.
+- `pixelmatch` — pixel-perfect diff for `annot_compare_screenshots`.
+
+## Friendly errors
+
+The `_url` tools detect missing Chromium and return a structured
+error pointing to the install command:
+
+```
+ChromiumUnavailableError: Failed to launch Chromium.
+Run `npx playwright install chromium` to download the runtime,
+then retry.
+```
+
+Locator failures surface as `LocatorResolutionError` with the
+offending selector embedded:
+
+```
+LocatorResolutionError: Locator "button:has-text('Submit')"
+resolved to no visible element. Check the selector matches at
+least one element and the element is inside the captured
+viewport.
+```
+
+The agent sees these as MCP tool errors and can correct + retry.
+
+## See also
+
+- [`docs/ai-agents.md`](../../docs/ai-agents.md) — short intro
+  guide + "which doc do I want?" map; start here if you're new
+  to the MCP integration.
+- [`docs/plans/agent-mcp-integration.md`](../../docs/plans/agent-mcp-integration.md)
+  — full design + phase ledger.
+- [`@ingcreators/annot-annotator`](../annotator/README.md) — the
+  underlying Tier A headless renderer.
+- [`@ingcreators/annot-playwright`](../playwright/README.md) — the
+  test-engineer-facing Playwright fixture (sibling consumer of
+  the annotator).
+- Model Context Protocol spec: https://modelcontextprotocol.io/
+- Upstream `@playwright/mcp`: https://github.com/microsoft/playwright-mcp

package/bin/annot-mcp.mjs

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+
+// `annot-mcp` CLI shim. Boots the MCP server over stdio so an MCP
+// client (Claude Desktop, Claude Code, Cursor, …) can spawn this
+// binary and pipe JSON-RPC over stdin / stdout.
+//
+// Configure in `~/.config/Claude/claude_desktop_config.json` (or
+// the equivalent for other clients) as:
+//
+//   {
+//     "mcpServers": {
+//       "annot": { "command": "npx", "args": ["@ingcreators/annot-mcp"] }
+//     }
+//   }
+//
+// The actual server lives in `../dist/index.js` after `vite build`;
+// during workspace development run `pnpm --filter
+// @ingcreators/annot-mcp build` before invoking the bin.
+
+import { dirname, resolve } from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+const here = dirname(fileURLToPath(import.meta.url));
+const entry = resolve(here, "..", "dist", "index.js");
+
+// Windows dynamic import requires a `file://` URL; passing the raw
+// absolute path triggers `ERR_UNSUPPORTED_ESM_URL_SCHEME` ("Only
+// URLs with a scheme in: file, data, and node are supported"). Use
+// `pathToFileURL` so the same code works on Linux / macOS / Windows.
+const mod = await import(pathToFileURL(entry).href);
+await mod.runStdioServer();

package/dist/browser/capture.d.ts

@@ -0,0 +1,40 @@
+import { BrowserPool } from './pool.js';
+export interface ViewportOptions {
+    width: number;
+    height: number;
+    deviceScaleFactor?: number;
+}
+export interface CapturePageOptions {
+    url: string;
+    viewport?: ViewportOptions;
+    fullPage?: boolean;
+    waitFor?: "load" | "domcontentloaded" | "networkidle";
+}
+export interface PageHandle {
+    /** Page-shaped object (`playwright-core`'s `Page`). */
+    page: {
+        locator(selector: string): {
+            boundingBox(): Promise<{
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            } | null>;
+        };
+    };
+    /** Close the page and release the browser borrow. Idempotent. */
+    close(): Promise<void>;
+}
+export interface CapturePageResult {
+    pngBytes: Uint8Array;
+    handle: PageHandle;
+}
+/**
+ * Acquire a browser, open a new context + page, navigate to the
+ * given URL, take a screenshot, and return the bytes + a page
+ * handle for follow-up locator resolution.
+ *
+ * On any error after browser acquisition, the page + context are
+ * closed and the browser is released before the error propagates.
+ */
+export declare function capturePage(pool: BrowserPool, options: CapturePageOptions): Promise<CapturePageResult>;

package/dist/browser/pool.d.ts

@@ -0,0 +1,58 @@
+export interface BrowserLike {
+    /** Close the browser. Mirrors `playwright-core` `Browser.close`. */
+    close(): Promise<void>;
+}
+export interface BrowserLauncher {
+    /** Launch a headless browser instance. */
+    launch(): Promise<BrowserLike>;
+}
+export interface BrowserPoolOptions {
+    /** Milliseconds the pool will keep a browser alive after the last
+     *  release before closing it. Default 30000. */
+    idleTimeoutMs?: number;
+}
+export declare class BrowserPool {
+    #private;
+    constructor(launcher: BrowserLauncher, options?: BrowserPoolOptions);
+    /**
+     * Acquire a browser instance. The pool launches lazily on the
+     * first call. Subsequent acquires return the same shared
+     * instance until every borrow has been released and the idle
+     * timeout has elapsed.
+     *
+     * The caller MUST call {@link release} (typically in a `finally`)
+     * after they're done so the pool can track outstanding borrows
+     * accurately.
+     */
+    acquire(): Promise<BrowserLike>;
+    /**
+     * Release a previously-acquired browser. Decrements the
+     * refcount; when it reaches zero an idle timer starts. A
+     * follow-up `acquire` within the idle window reuses the same
+     * instance; otherwise the timer fires and the browser closes.
+     */
+    release(): void;
+    /**
+     * Close the pooled browser immediately, regardless of refcount.
+     * Intended for explicit teardown (e.g. SIGINT / SIGTERM
+     * handlers); regular flows should rely on the idle timer.
+     */
+    shutdown(): Promise<void>;
+    /** Refcount of outstanding borrows. Exposed for tests / metrics. */
+    get activeBorrows(): number;
+    /** Whether a browser is currently launched. Exposed for tests. */
+    get isLaunched(): boolean;
+}
+/**
+ * Construct a {@link BrowserPool} backed by `playwright-core`'s
+ * Chromium launcher. Uses dynamic import so consumers who never
+ * touch `_url` tools don't pay the playwright-core load cost on
+ * startup AND so we can surface a friendly error when the
+ * package is missing (e.g. accidentally stripped from
+ * dependencies).
+ */
+export declare function createChromiumPool(options?: BrowserPoolOptions): BrowserPool;
+export declare class ChromiumUnavailableError extends Error {
+    readonly cause: unknown;
+    constructor(message: string, cause?: unknown);
+}