inspectra-engine 0.0.0-stage → 1.0.3

package/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+All notable changes to Inspectra will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.3] - 2026-10-30
+
+### Changed
+
+- Pin Shivax to version `1.0.2`.
+- Update Playwright and its test runner to `^1.64.1`, axe-core's Playwright
+  integration to `^4.14.0`, CSpell to `^10.4.0` and Lighthouse to `^13.6.0`.
+
+## [1.0.2] - 2026-10-28
+
+### Added
+
+- Project attribution NOTICE file, included in the published npm package.
+- npm package description, source and issue links, and feature-specific discovery keywords.
+- README use cases and FAQs covering UI testing, accessibility, design baselines
+  and supported execution environments.
+- Include this changelog in the published npm package.
+
+### Changed
+
+- Replace outdated phase notes and repository boilerplate in the README with a
+  feature overview, installation requirements, basic imports and function examples.
+- Correct documented imports to use the published `inspectra-engine` package name.
+
+## [1.0.1] - 2026-10-27
+
+### Added
+
+- This changelog, including the published version history and contribution conventions.
+
+### Changed
+
+- Increase the local runner's default bootstrap token lifetime from 5 to 15 minutes.
+  Explicit shorter lifetimes remain supported; the maximum stays at 15 minutes.
+  Tokens still expire and do not renew automatically.
+
+## [1.0.0] - 2026-10-03
+
+### Added
+
+- Local Playwright capture of baseline and target pages, including semantic nodes,
+  typography, layout, hierarchy, screenshots and viewport metadata.
+- Shivax-compatible UI snapshots with measurement provenance and confidence.
+- URL comparisons using Shivax, with JSON reports and screenshot artifacts.
+- Structured Figma baselines and PNG baselines with OCR-assisted observations.
+- Accessibility checks and optional UI styling, layout and spelling checks.
+- A local HTTP runner with scan sessions, streamed events, previews, cancellation
+  and report retrieval.
+- Node.js APIs, a browser client, TypeScript declarations and the `inspectra` CLI.
+- Explicit company/personal scopes and separate output directories for captures.
+- Apache-2.0 licensing.
+
+## [0.0.0-stage] - 2026-10-26
+
+### Added
+
+- Initial staging publication of `inspectra-engine` on npm, preceding version 1.0.0.
+
+[1.0.3]: https://www.npmjs.com/package/inspectra-engine/v/1.0.3
+[1.0.2]: https://www.npmjs.com/package/inspectra-engine/v/1.0.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Urvesh Gohil
+
+   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/NOTICE

@@ -0,0 +1,11 @@
+Inspectra (inspectra-engine)
+Copyright 2026 Urvesh Gohil
+
+Inspectra is distributed under the Apache License, Version 2.0.
+See the LICENSE file for the full license text.
+
+Project: https://gitlab.com/urveshgohil.developer/inspectra
+
+Third-party dependencies retain their respective copyright notices and
+licenses. Refer to the license and notice files distributed with each
+dependency for its attribution and licensing terms.

package/README.md

@@ -1,3 +1,133 @@
-# Temporary Holding Version
+# Inspectra: Playwright UI Testing and Accessibility for Node.js
 
-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.
+Inspectra (`inspectra-engine`) is a Node.js package for UI testing, visual regression testing, design QA and automated accessibility checks. Developers and QA teams can compare a live website against a URL, Figma design or PNG baseline, inspect rendered layout and typography, and export JSON reports with screenshot evidence. Inspectra captures pages with Playwright and uses Shivax to compare structured UI snapshots.
+
+Published on npm as **`inspectra-engine`**. Requires **Node.js 22.15+**. ESM imports and TypeScript declarations are included.
+
+[npm package](https://www.npmjs.com/package/inspectra-engine) · [Source code](https://gitlab.com/urveshgohil.developer/inspectra) · [Report an issue](https://gitlab.com/urveshgohil.developer/inspectra/-/issues) · [Changelog](CHANGELOG.md)
+
+## Features
+
+- Baseline and target capture with consistent viewport and device-pixel-ratio settings.
+- Semantic content, typography, spacing, dimensions, hierarchy and layout extraction.
+- UI comparison through Shivax using structured measurements, with screenshots as supporting evidence.
+- URL, Figma and PNG baselines. Inferred measurements carry provenance and confidence.
+- Accessibility checks powered by axe-core, plus optional UI styling, layout and spelling checks.
+- JSON reports, screenshots, scan events, cancellation and a local HTTP runner.
+- Explicit company and personal scopes for organizing scan data.
+
+## Use cases
+
+| Task | Inspectra capability |
+| --- | --- |
+| Visual regression testing | Compare baseline and target UI snapshots to identify measured design differences. |
+| Figma design QA | Compare structured Figma design data against a rendered website. |
+| Frontend layout testing | Inspect dimensions, padding, margins, gaps, typography and element relationships. |
+| Responsive UI testing | Capture pages at specified viewports and device pixel ratios. |
+| Accessibility testing | Run axe-core checks and include findings alongside UI comparison reports. |
+| Screenshot baseline review | Compare a PNG baseline with a website using OCR-assisted observations and confidence annotations. |
+
+## Installation
+
+```sh
+npm install inspectra-engine
+npx playwright install chromium
+```
+
+Figma capture needs a Figma token supplied to the Node.js process. PNG text extraction needs local Tesseract OCR or a supplied OCR provider.
+
+## Basic usage
+
+### Compare two pages
+
+```js
+import { compare } from 'inspectra-engine';
+
+const result = await compare({
+  baseline: 'https://example.com',
+  target: 'https://example.org',
+  viewport: { width: 1440, height: 900 },
+  scope: { kind: 'company', id: 'my-company' },
+  output: `./reports/scan-${Date.now()}`,
+});
+
+console.log(result.issues);
+console.log(result.artifacts.report);
+```
+
+The output directory must be new. A completed comparison writes `report.json`, `baseline.png` and `target.png`. Accessibility checks are enabled by default; use `accessibility: false` to disable them. For URL comparisons, use `uiChecks: true` to include additional UI checks, and `spelling: true` alongside it for spelling checks.
+
+### Capture a snapshot and check accessibility
+
+```js
+import { chromium } from 'playwright';
+import { captureUISnapshot, scanAccessibility } from 'inspectra-engine';
+
+const browser = await chromium.launch();
+try {
+  const page = await browser.newPage({
+    viewport: { width: 1440, height: 900 },
+    deviceScaleFactor: 1,
+  });
+  await page.goto('https://example.com', { waitUntil: 'load' });
+
+  const snapshot = await captureUISnapshot(page, {
+    scope: { kind: 'personal', id: 'local-user' },
+  });
+  const accessibility = await scanAccessibility(page);
+
+  console.log(snapshot.nodes);
+  console.log(accessibility.violations);
+} finally {
+  await browser.close();
+}
+```
+
+## Main functions
+
+Import these from `inspectra-engine` or `inspectra-engine/node`.
+
+| Function | Purpose |
+| --- | --- |
+| `compare(options)` | Compare a URL, Figma or PNG baseline against a target page and save artifacts. |
+| `captureUISnapshot(page, options)` | Convert an existing Playwright page into a Shivax UI snapshot. |
+| `captureUIPage(page, options)` | Capture a snapshot, extraction metadata and an optional screenshot. |
+| `captureUISnapshotPair(options)` | Capture baseline and target URLs using matching browser settings. |
+| `scanAccessibility(page, options)` | Run axe-core accessibility checks on an existing page. |
+| `captureFigmaBaseline(source, options)` | Capture structured Figma data and its preview. |
+| `capturePNGBaseline(source, options)` | Convert a PNG baseline into an evidence-tagged snapshot. |
+| `startLocalRunner(options)` | Start the loopback HTTP runner for an application integration. |
+
+Node APIs execute outside the browser. Browser applications can import report types and `COMPARISON_VERSION` from `inspectra-engine/client`; this entry does not run scans. Application UI, login and licensing belong to the consuming application. Scope metadata does not replace authentication or storage access controls.
+
+The HTTP runner's bootstrap token lasts 15 minutes by default and does not renew automatically.
+
+## Frequently asked questions
+
+### Is Inspectra a standalone application or a Playwright package?
+
+Inspectra is an npm package that uses Playwright for browser capture. Import its functions into a Node.js application or use the included `inspectra` CLI. Visynq Workstation is a separate application that consumes Inspectra.
+
+### Can Inspectra compare Figma designs or screenshots with a website?
+
+Yes. `compare()` accepts a URL string, a structured Figma baseline or a PNG baseline. Figma capture requires a token, and PNG capture requires viewport metadata and an OCR provider. PNG-derived observations are inferred and require review.
+
+### Does Inspectra primarily compare screenshots pixel by pixel?
+
+No. The main comparison flow uses structured snapshots and Shivax analysis. Browser captures expose rendered geometry and computed styles; screenshots provide visual evidence. Measurements inferred from PNGs retain confidence and provenance rather than being presented as original CSS values.
+
+### Can Inspectra run inside a React application in the browser?
+
+The scanner requires Node.js and Playwright outside the browser. The `inspectra-engine/client` entry provides browser-safe report contracts and a version constant, but does not execute scans. React applications need a separate execution environment for the scanner.
+
+### Does Inspectra require a hosted scanning service?
+
+No. Its Node.js APIs run in the environment supplied by the consuming application, including a local development process or an application-owned worker. Inspectra does not require an Inspectra-hosted scanner backend.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+
+## License
+
+[Apache-2.0](LICENSE). Copyright 2026 Urvesh Gohil. Third-party dependencies retain their own licenses.

package/bin/inspectra.mjs

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+import { parseArgs, parseEnv } from 'node:util';
+import { readFileSync } from 'node:fs';
+
+const help = `Usage:
+  inspectra compare --baseline <URL> --target <URL> --viewport <WIDTHxHEIGHT>
+    --output <new-directory> --scope-kind <company|personal> --scope-id <id>
+  # Figma baseline: add --figma-node <node-id> [--figma-scale <design-units-per-css-px>]
+  # PNG baseline: --baseline <image.png> --png-metadata <metadata.json>
+  inspectra dev [--env <.env>] [--port <4317>] [--origin <http://localhost:5173>]
+  inspectra help
+
+Runs Chromium locally, compares measured snapshots with Shivax, and writes
+report.json, baseline.png and target.png. Output must not already exist.
+Dev reads .env in the current directory; shell variables and flags take precedence.
+Viewport defaults to 1440x900. Accessibility checks use WCAG A/AA.
+Exit codes: 0 success (including findings), 1 error, 130 cancelled.
+`;
+const controller = new AbortController();
+const abort = () => controller.abort();
+process.once('SIGINT', abort);
+process.once('SIGTERM', abort);
+try {
+  const [command, ...args] = process.argv.slice(2);
+  if (!command || command === 'help' || command === '--help') {
+    process.stdout.write(help);
+  } else if (command === 'dev') {
+    const { values } = parseArgs({ args, options: { env: { type: 'string' }, port: { type: 'string' }, origin: { type: 'string', multiple: true } } });
+    try {
+      const env = parseEnv(readFileSync(values['env'] ?? '.env', 'utf8'));
+      for (const [name, value] of Object.entries(env)) if (process.env[name] === undefined) process.env[name] = value;
+    }
+    catch (error) { if (values['env'] || error.code !== 'ENOENT') throw error; }
+    const { devOptions } = await import('../node/dev-config.mjs');
+    const { startLocalRunner } = await import('../node/index.mjs');
+    const runner = await startLocalRunner({ ...devOptions(values), signal: controller.signal });
+    process.stdout.write(JSON.stringify({ origin: runner.origin, token: runner.token, expiresAt: runner.expiresAt }) + '\n');
+    await new Promise(resolve => {
+      if (controller.signal.aborted) resolve();
+      else controller.signal.addEventListener('abort', resolve, { once: true });
+    });
+    await runner.close();
+  } else if (command === 'compare') {
+    const { values } = parseArgs({ args, options: Object.fromEntries(
+      ['baseline', 'target', 'viewport', 'output', 'scope-kind', 'scope-id', 'figma-node', 'figma-scale', 'png-metadata'].map(name => [name, { type: 'string' }])) });
+    const match = values.viewport === undefined ? undefined : /^(\d+)x(\d+)$/.exec(values.viewport);
+    if (values.viewport !== undefined && !match) throw new TypeError('viewport must be WIDTHxHEIGHT');
+    const { compare } = await import('../node/index.mjs');
+    const figma = values['figma-node'] !== undefined || /^https:\/\/(?:www\.)?figma\.com\//.test(values.baseline ?? '');
+    if (values['figma-scale'] !== undefined && !figma) throw new TypeError('figma-scale requires a Figma baseline');
+    const png = values['png-metadata'] !== undefined || (!/^[a-z]+:\/\//i.test(values.baseline ?? '') && /\.png$/i.test(values.baseline ?? ''));
+    if (png && figma) throw new TypeError('Choose one baseline source type');
+    if (png && !values['png-metadata']) throw new TypeError('PNG requires --png-metadata with screenshot viewport metadata');
+    const baseline = png ? { ...JSON.parse(readFileSync(values['png-metadata'], 'utf8')), type: 'png', path: values.baseline } : figma ? { type: 'figma', url: values.baseline, ...(values['figma-node'] ? { nodeId: values['figma-node'] } : {}), unitsPerCssPixel: Number(values['figma-scale'] ?? 1) } : values.baseline;
+    const result = await compare({ baseline, target: values.target, output: values.output,
+      viewport: match ? { width: Number(match[1]), height: Number(match[2]) } : undefined,
+      scope: { kind: values['scope-kind'], id: values['scope-id'] }, signal: controller.signal });
+    process.stdout.write(JSON.stringify({ issues: result.issues.length, artifacts: result.artifacts }) + '\n');
+  } else {
+    throw new TypeError(`Unknown command: ${command}. Run inspectra help.`);
+  }
+} catch (error) {
+  process.stderr.write(`inspectra: ${error.message}\n`);
+  process.exitCode = controller.signal.aborted ? 130 : 1;
+} finally {
+  process.removeListener('SIGINT', abort);
+  process.removeListener('SIGTERM', abort);
+}

package/client/index.d.mts

@@ -0,0 +1,85 @@
+import type { UISnapshot, UIAnalysisResult } from 'shivax';
+export type { UISnapshot, UIAnalysisOptions, UIAnalysisResult, UIIssue, Measurement, SourceProvenance } from 'shivax';
+export declare const COMPARISON_VERSION: 1;
+export interface UIHighlightRect { x: number; y: number; width: number; height: number }
+export interface UICheckFinding {
+  severity: 'high' | 'medium' | 'low' | 'info';
+  type: string; detail: string; elements?: string[]; text?: string;
+  refRects?: UIHighlightRect[]; tgtRects?: UIHighlightRect[]; rects?: UIHighlightRect[];
+  diffs?: { prop: string; ref: string; act: string }[];
+}
+export interface SpellingFinding { word: string; suggestions: string[]; tag: string; context: string; rects: UIHighlightRect[] }
+export interface UICheckResult {
+  completeness: UICheckFinding[]; layout: UICheckFinding[]; styling: UICheckFinding[];
+  spelling: SpellingFinding[]; spellingRan: boolean;
+  provenance: { method: 'inspectra-ui-check'; kind: 'inferred'; confidence: null };
+}
+export interface ComparisonResult {
+  /** Optional existing Inspectra UI-check results, measured on the same captured pages. */
+  uiCheck?: UICheckResult;
+  version: 1;
+  scope: UISnapshot['scope'];
+  baseline: UISnapshot;
+  target: UISnapshot;
+  analysis: UIAnalysisResult;
+  issues: UIAnalysisResult['issues'];
+  evidence: { baseline: unknown; target: unknown };
+  accessibility: { baseline: unknown; target: unknown } | null;
+  artifacts: { report: string; baselineScreenshot: string; targetScreenshot: string; baselineHighlights?: string; targetHighlights?: string };
+  review?: { status: 'needs_review'; issues: { id: string; status: 'needs_review' }[]; uncertain: UIAnalysisResult['matching']['uncertain']; uncertainTarget: UIAnalysisResult['matching']['uncertainTarget'] };
+  matches?: { id: string; baselineNodeId: string; targetNodeId: string; baseline: UIHighlightRect; target: UIHighlightRect; confidence: UIAnalysisResult['matching']['matches'][number]['confidence']; status: 'needs_review' }[];
+}
+
+export type ScanState = 'queued' | 'loading' | 'extracting' | 'matching' | 'comparing' | 'completed' | 'failed' | 'cancelled';
+export interface FigmaBaseline {
+  type: 'figma';
+  url: string;
+  /** Canonical colon node ID or copied URL-style hyphen node ID. */
+  nodeId?: string;
+  /** Explicit design units per CSS pixel; never inferred from viewport or DPR. */
+  unitsPerCssPixel?: number;
+  /** Optional explicit presentation/ARIA roles keyed by Figma node ID. */
+  roleMappings?: Record<string, string>;
+}
+export interface PngBaseline {
+  type: 'png';
+  /** Raw base64 or data:image/png;base64,...; local HTTP runner rejects file paths. */
+  data: string;
+  viewport: { width: number; height: number; devicePixelRatio: number };
+  fullPage?: boolean;
+  /** CSS-pixel scroll offset of a viewport screenshot; full-page screenshots use zero. */
+  scroll?: { x: number; y: number };
+}
+export interface ScanRequest {
+  baseline: string | FigmaBaseline | PngBaseline;
+  target: string;
+  scope: UISnapshot['scope'];
+  viewport?: { width: number; height: number };
+  timeout?: number;
+  maxNodes?: number;
+  includeText?: boolean;
+  ignoreSelectors?: string[];
+  requiredAssets?: string[];
+  analysisOptions?: import('shivax').UIAnalysisOptions;
+  accessibility?: boolean;
+  uiChecks?: boolean;
+  spelling?: boolean;
+}
+export interface ScanStatus {
+  id: string;
+  state: ScanState;
+  scope: UISnapshot['scope'];
+  expiresAt: number;
+  error: { name: string; message: string } | null;
+  lastEventId: number;
+}
+export interface ScanSession extends ScanStatus { token: string }
+export type ScanEvent = { id: number; sessionId: string; timestamp: string } & (
+  { type: 'state'; state: ScanState; side?: 'baseline' | 'target'; error?: ScanStatus['error'] } |
+  { type: 'page'; name: 'domcontentloaded' | 'requestfailed'; side: 'baseline' | 'target'; error?: string } |
+  { type: 'snapshot'; side: 'baseline' | 'target'; nodes: number } |
+  { type: 'preview'; side: 'baseline' | 'target'; bytes: number } |
+  { type: 'preview-error'; side: 'baseline' | 'target'; message: string } |
+  { type: 'issue'; issue: UIAnalysisResult['issues'][number]; status?: 'needs_review' } |
+  { type: 'analysis'; diagnostics: UIAnalysisResult['diagnostics']; work: number }
+);

package/client/index.mjs

@@ -0,0 +1,2 @@
+/** Browser-safe wire-contract version. Runtime scanning lives in inspectra/node. */
+export const COMPARISON_VERSION = 1;