styleproof 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -7,6 +7,26 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [3.7.0] - 2026-07-04
+
+### Added
+
+- **Inventory guard** — StyleProof can now assert the navigable UI doesn't silently
+  shrink. Opt in with `captureStyleMap(page, { inventory: true })` and each surface's
+  navigable affordances — internal route links, `role=tab`, `role=menuitem`,
+  button-only nav — are harvested (keyed stably) into `StyleMap.inventory`.
+  `styleproof-diff` then unions the reachable set across both sides and **exits 1 on
+  any affordance present on base but absent on head** — a feature that stopped being
+  reachable — unless it's acknowledged in `styleproof.inventory.json` (`{"<key>":
+"<why>"}`, path overridable via `STYLEPROOF_INVENTORY`; a stale acknowledgement is
+  flagged so the ledger can't rot). Closes the certification diff's blind spot for the
+  information-architecture / replacement class: a redesign staged as a new surface, or
+  a nav item / route that disappears, which a same-surface computed-style diff catches
+  only incidentally. **Off by default (no map carries inventory ⇒ the CLI is
+  byte-for-byte unchanged); the certification diff itself is untouched.** The
+  programmatic entry point `auditRunInventory(baseMaps, headMaps, allowRemoved)`
+  stays available for custom gates. See `docs/inventory-guard.md`.
+
 ## [3.6.0] - 2026-07-03
 
 ### Changed

package/bin/styleproof-diff.mjs

@@ -39,9 +39,77 @@ import {
   showHelpAndExit,
   unknownFlagMessage,
 } from '../dist/cli-errors.js';
+import { loadStyleMap } from '../dist/capture.js';
+import { auditRunInventory } from '../dist/inventory.js';
 
 const COMMAND = path.basename(process.argv[1] ?? 'styleproof-diff').replace(/\.mjs$/, '');
 
+// ── inventory guard (opt-in) ────────────────────────────────────────────────────
+// Surfaces the navigable-inventory audit through the CLI. When captures carry
+// `inventory` (from captureStyleMap({ inventory: true })), an affordance base
+// offered and head no longer does BLOCKS unless acknowledged. Inert when no map
+// carries inventory, so every existing capture behaves exactly as before.
+
+// Mirror of indexDir() in diff.ts — the capture-dir file filter, kept local so the
+// bin needn't reach into diff internals for one small read.
+function dirInventories(dir) {
+  return fs
+    .readdirSync(dir)
+    .filter((f) => f !== 'styleproof-manifest.json' && /\.json(\.gz)?$/.test(f))
+    .map((f) => loadStyleMap(path.join(dir, f)))
+    .map((m) => (m.inventory ? { inventory: m.inventory } : {}));
+}
+
+// `key -> reason` acknowledged removals. Optional file; absent → none. Malformed
+// JSON fails loud (exit 2) rather than silently un-acknowledging a real removal.
+function loadAllowRemoved() {
+  const p = path.resolve(process.env.STYLEPROOF_INVENTORY ?? 'styleproof.inventory.json');
+  if (!fs.existsSync(p)) return {};
+  try {
+    return JSON.parse(fs.readFileSync(p, 'utf8'));
+  } catch (e) {
+    console.error(`${COMMAND}: ${p} is not valid JSON — ${e.message}`);
+    process.exit(2);
+  }
+}
+
+// Read both sides' inventory and audit removals. MUST run before any cached-map
+// cleanup deletes the restored dirs. Returns null when no capture carries inventory.
+function readInventoryAudit(dirA, dirB) {
+  const baseInv = dirInventories(dirA);
+  const headInv = dirInventories(dirB);
+  if (![...baseInv, ...headInv].some((m) => m.inventory?.length)) return null;
+  const allowed = loadAllowRemoved();
+  return { allowed, ...auditRunInventory(baseInv, headInv, allowed) };
+}
+
+// Print the Inventory section from a prior audit; return the count of UNACKNOWLEDGED
+// removals (which block). No-op/0 when there was nothing with inventory to audit.
+function printInventoryAudit(audit) {
+  if (!audit) return 0;
+  const { delta, unexplained, staleAllowances, allowed } = audit;
+  if (!delta.added.length && !delta.removed.length && !staleAllowances.length) {
+    console.log('\n📐 Inventory: navigable set unchanged across captured surfaces');
+    return 0;
+  }
+  console.log('\n📐 Inventory (navigable affordances — route links, tabs, menu items, nav buttons):');
+  for (const it of delta.removed) {
+    const why = allowed[it.key];
+    console.log(
+      why
+        ? `  removed: ${it.key} ("${it.label}") — acknowledged: ${why}`
+        : `  ✗ REMOVED, unacknowledged: ${it.key} ("${it.label}")`,
+    );
+  }
+  for (const it of delta.added) console.log(`  + added: ${it.key} ("${it.label}")`);
+  for (const k of staleAllowances) console.log(`  ⚠ stale allowRemoved (key is not actually removed): ${k}`);
+  if (unexplained.length)
+    console.log(
+      `  → ${unexplained.length} unacknowledged removal(s): restore the affordance, or record the decision in styleproof.inventory.json {"<key>":"<why>"}.`,
+    );
+  return unexplained.length;
+}
+
 const HELP = `${COMMAND} — certify a CSS refactor by diffing two computed-style map captures
 
 usage: ${COMMAND} [baseRef] [options]
@@ -132,9 +200,13 @@ if (args.length <= 1) {
 }
 
 let result;
+let inventoryAudit = null;
 try {
   assertCompatibleMapDirs(dirA, dirB);
   result = diffStyleMapDirs(dirA, dirB);
+  // Read inventory here, while the (possibly cached/restored) dirs still exist —
+  // the finally below deletes them in cached-map mode.
+  inventoryAudit = readInventoryAudit(dirA, dirB);
 } catch (e) {
   console.error(e.message);
   process.exit(2);
@@ -170,6 +242,8 @@ for (const sd of surfaces) {
   if (lines.length > MAX) console.log(`  ... and ${lines.length - MAX} more lines (re-run with --max ${lines.length})`);
 }
 
+const invRemovals = printInventoryAudit(inventoryAudit);
+
 if (jsonOut) fs.writeFileSync(jsonOut, JSON.stringify({ counts, surfaces, compared }, null, 2));
 
 const total = counts.dom + counts.style + counts.state;
@@ -177,13 +251,14 @@ const newSurfaces = surfaces.filter((s) => s.missing).length;
 // One SurfaceDiff per distinct surface across both sides (incl. missing-on-one-side).
 const surfaceCount = surfaces.length;
 const newNote = newSurfaces ? ` (+${newSurfaces} new surface(s) with no baseline)` : '';
+const invNote = invRemovals ? ` + ${invRemovals} unacknowledged inventory removal(s)` : '';
 console.log(
-  total === 0
+  total === 0 && invRemovals === 0
     ? newSurfaces === 0
       ? `\n✓ 0 changed surfaces across ${compared} captured surface(s): every computed style, pseudo-element, and hover/focus/active state matches`
       : `\nℹ ${newSurfaces} new surface(s) captured with no baseline to compare — review before baselining`
-    : `\n✗ ${counts.dom} DOM change(s), ${counts.style} computed-style difference(s), ${counts.state} state-delta difference(s) across ${surfaceCount} surfaces${newNote}`,
+    : `\n✗ ${counts.dom} DOM change(s), ${counts.style} computed-style difference(s), ${counts.state} state-delta difference(s) across ${surfaceCount} surfaces${newNote}${invNote}`,
 );
-// 0 = identical, 1 = reviewable differences, 3 = only new surfaces (no baseline,
-// nothing to review). 2 stays reserved for usage/capture errors.
-process.exit(total > 0 ? 1 : newSurfaces > 0 ? 3 : 0);
+// 0 = identical, 1 = reviewable differences (incl. unacknowledged inventory
+// removals), 3 = only new surfaces (no baseline). 2 reserved for usage/capture errors.
+process.exit(total > 0 || invRemovals > 0 ? 1 : newSurfaces > 0 ? 3 : 0);

package/dist/capture.d.ts

@@ -1,4 +1,5 @@
 import type { Page } from '@playwright/test';
+import { type NavigableItem } from './inventory.js';
 /**
  * Computed-style capture: the browser's final resolved value for every CSS
  * longhand on every element, keyed by DOM structure (never by class name, so
@@ -124,6 +125,13 @@ export type StyleMap = {
      * surface from the document root; per-subtree overrides aren't tracked.
      */
     tokens?: Record<string, string>;
+    /**
+     * The surface's navigable inventory — user-reachable affordances (route links,
+     * tabs, menu items, button-only nav), keyed stably. Present only when captured
+     * with `inventory: true`. Diffed by the inventory guard (a removal gates), never
+     * by the certification diff. See docs/inventory-guard.md.
+     */
+    inventory?: NavigableItem[];
 };
 export type CaptureOptions = {
     /**
@@ -135,6 +143,12 @@ export type CaptureOptions = {
      * is volatile without paying the settle wait for it.
      */
     ignore?: string[];
+    /**
+     * Harvest the surface's navigable inventory (route links, tabs, menu items,
+     * button-only nav) into `StyleMap.inventory`, for the inventory guard. Off by
+     * default; advisory to the certification diff — a removal gates separately.
+     */
+    inventory?: boolean;
     /**
      * Settle the page before capturing, and auto-exclude live regions (default
      * on). StyleProof polls the (motion-frozen) page until its computed-style map
@@ -234,12 +248,6 @@ export declare function trackInflightRequests(page: Page): {
     pending: () => number;
     dispose: () => void;
 };
-/**
- * Capture the page's complete style map. Drive the page to the state you want
- * first (navigate, open menus); by default the capture then auto-settles the
- * page and excludes live regions (see `stabilize`), so a fetch/stream that
- * paints after `go()` resolves is captured loaded, not mid-load.
- */
 export declare function captureStyleMap(page: Page, options?: CaptureOptions): Promise<StyleMap>;
 /** Write a style map to disk; gzipped when the path ends in `.gz`. */
 export declare function saveStyleMap(filePath: string, map: StyleMap): void;

package/dist/capture.js

@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { gzipSync, gunzipSync } from 'node:zlib';
+import { classifyInventory, collectNavAffordances } from './inventory.js';
 const INTERACTIVE = 'a, button, input, textarea, select, summary, [role="button"], [tabindex]';
 // Freeze motion so every captured value is a settled end state, not a frame
 // of an animation or a mid-flight transition after a forced :hover.
@@ -354,6 +355,7 @@ function detectOverlayCandidates({ ignore }) {
 }
 /** Full (unpruned) computed styles for an element and its descendants, pseudo-elements included. */
 // Serialized into the browser by page.evaluate; cannot call module helpers.
+// fallow-ignore-next-line complexity -- pre-existing (cog 16); in-page fn can't call module helpers, so it can't be split. Exposed here only because the inventory feature edits this file. Refactor separately.
 function snapSubtree({ selector, index }) {
     const el = document.querySelectorAll(selector)[index];
     const pathOf = (n) => {
@@ -665,6 +667,13 @@ function mergeMotion(elements, motion) {
  * page and excludes live regions (see `stabilize`), so a fetch/stream that
  * paints after `go()` resolves is captured loaded, not mid-load.
  */
+/**
+ * Harvest the surface's navigable inventory when enabled; `[]` otherwise. Kept out
+ * of captureStyleMap so that function stays within the complexity budget.
+ */
+async function harvestInventoryFor(page, enabled) {
+    return enabled ? classifyInventory(await page.evaluate(collectNavAffordances)) : [];
+}
 export async function captureStyleMap(page, options = {}) {
     // Framework/non-visual noise is always skipped, so it can't read as a DOM
     // change; the caller's `ignore` adds to it (not replaces it).
@@ -730,6 +739,7 @@ export async function captureStyleMap(page, options = {}) {
         statesSkipped = forced.skipped;
     }
     const tokens = await page.evaluate(capturePageTokens);
+    const inventory = await harvestInventoryFor(page, options.inventory);
     return {
         ...(options.metadata ? { metadata: options.metadata } : {}),
         defaults: base.defaults,
@@ -740,6 +750,7 @@ export async function captureStyleMap(page, options = {}) {
         ...(liveCandidates.length ? { liveCandidates } : {}),
         ...(overlays.length ? { overlays } : {}),
         ...(Object.keys(tokens).length ? { tokens } : {}),
+        ...(inventory.length ? { inventory } : {}),
     };
 }
 /** Write a style map to disk; gzipped when the path ends in `.gz`. */

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { captureStyleMap, saveStyleMap, loadStyleMap, trackInflightRequests } from './capture.js';
+export * from './inventory.js';
 export { captureUrlToDir, runCaptureUrl, parseCaptureUrlArgs, UsageError } from './capture-url.js';
 export type { CaptureUrlOptions, CaptureUrlResult } from './capture-url.js';
 export { crawlAndCapture, CRAWL_DEFAULTS } from './crawl-surfaces.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export { captureStyleMap, saveStyleMap, loadStyleMap, trackInflightRequests } from './capture.js';
+export * from './inventory.js';
 export { captureUrlToDir, runCaptureUrl, parseCaptureUrlArgs, UsageError } from './capture-url.js';
 export { crawlAndCapture, CRAWL_DEFAULTS } from './crawl-surfaces.js';
 export { loadSetupSteps } from './capture-url.js';

package/dist/inventory.d.ts

@@ -0,0 +1,70 @@
+/** One user-reachable navigation affordance, keyed stably across base/head. */
+export type NavigableItem = {
+    /**
+     * Stable identity across captures. `route:<pathname><search>` for internal
+     * links; `<role>:<slug(name)>` for tabs / menu items / button-only nav — so a
+     * tab labelled "MODEL CONFIG" keys as `tab:model-config` regardless of styling,
+     * and lines up with an app's own view id.
+     */
+    key: string;
+    kind: 'link' | 'tab' | 'menuitem' | 'nav-button';
+    /** Visible accessible name at capture time (for the report). */
+    label: string;
+    /** Resolved same-origin path, for `kind: 'link'`. */
+    href?: string;
+};
+export type InventoryDelta = {
+    /** Present on head, absent on base — a newly-offered affordance (informational). */
+    added: NavigableItem[];
+    /** Present on base, absent on head — a feature the UI stopped offering (gates). */
+    removed: NavigableItem[];
+};
+/** `key -> reason` — removals that are intentional, reviewed, and on the record. */
+export type AllowedRemovals = Record<string, string>;
+/** One raw navigable affordance as read from the DOM, before classification. */
+export type RawAffordance = {
+    tag: string;
+    role: string;
+    name: string;
+    /** pathname+search for a same-origin `<a href>`; null otherwise. Resolved in-page. */
+    internalPath: string | null;
+};
+/** In-page: collect visible navigable affordances. No classification. */
+export declare function collectNavAffordances(): RawAffordance[];
+/** Pure: turn raw affordances into keyed, deduped, sorted navigable items. */
+export declare function classifyInventory(raw: RawAffordance[]): NavigableItem[];
+/** Harvest a page's inventory: thin in-page collect + pure classify. */
+export declare function harvestInventory(page: {
+    evaluate: <T>(fn: () => T) => Promise<T>;
+}): Promise<NavigableItem[]>;
+/** Union the per-surface inventories of a whole run into one reachable set. */
+export declare function unionInventory(perSurface: Array<{
+    inventory?: NavigableItem[];
+} | undefined>): NavigableItem[];
+/** Base vs head reachable sets → what the UI newly offers / stopped offering. */
+export declare function diffInventory(base: NavigableItem[], head: NavigableItem[]): InventoryDelta;
+/**
+ * The gate. Removals that aren't acknowledged in `allowed` (key -> reason) are
+ * unexplained — the caller fails on a non-empty result. An `allowed` key that
+ * isn't actually removed is a stale acknowledgement, returned separately so the
+ * ledger can't quietly rot (mirrors the `exclude` coverage guard).
+ */
+export declare function auditRemovals(delta: InventoryDelta, allowed?: AllowedRemovals): {
+    unexplained: NavigableItem[];
+    staleAllowances: string[];
+};
+/**
+ * Run-level entry point: union both sides' per-surface `map.inventory`, diff, and
+ * audit removals. This is what a gate calls — pass every base map and every head
+ * map (the reachable set is the union across all surfaces). `unexplained` non-empty
+ * ⇒ the gate should fail; `staleAllowances` non-empty ⇒ prune the ledger.
+ */
+export declare function auditRunInventory(baseMaps: Array<{
+    inventory?: NavigableItem[];
+} | undefined>, headMaps: Array<{
+    inventory?: NavigableItem[];
+} | undefined>, allowed?: AllowedRemovals): {
+    delta: InventoryDelta;
+    unexplained: NavigableItem[];
+    staleAllowances: string[];
+};

package/dist/inventory.js

@@ -0,0 +1,135 @@
+// Inventory guard — assert the navigable UI doesn't silently shrink.
+//
+// StyleProof's certification diff answers "did surface X change between base and
+// head?" — a same-key regression check. It is structurally blind to a whole class
+// of high-stakes change: a redesign delivered as a NEW surface beside the old one
+// (the diff is old-vs-old, clean), or a nav item / route that DISAPPEARS (a feature
+// stops being reachable). Those aren't restyles — they're the reachable set of the
+// UI shrinking, which is an information-architecture change the pixel diff catches
+// only incidentally, if at all.
+//
+// This module harvests the *navigable inventory* of each captured surface — the
+// user-reachable affordances (route links, tabs, menu items, button-only SPA nav) —
+// keyed by a stable id, then diffs the UNION across a run. A key present on base but
+// absent on head is a REMOVAL: a feature the UI no longer offers. Removals gate
+// (like the `exclude` coverage ledger) unless explicitly acknowledged with a reason,
+// so "we dropped Model Config" is a decision on the record, never a silent green.
+//
+// The harvest (`collectNavAffordances`) runs in-page, mirroring
+// `detectOverlayCandidates`; the diff/union/guard are pure and unit-testable.
+// ── in-page harvest ───────────────────────────────────────────────────────────
+// Split in two: the DOM-touching half stays thin (and serializable to the page,
+// like detectOverlayCandidates); the classification is pure and unit-testable.
+/** In-page: collect visible navigable affordances. No classification. */
+export function collectNavAffordances() {
+    const visible = (el) => {
+        if (el.hidden || el.getAttribute('aria-hidden') === 'true')
+            return false;
+        const r = el.getBoundingClientRect();
+        const s = getComputedStyle(el);
+        return r.width > 0 && r.height > 0 && s.display !== 'none' && s.visibility !== 'hidden';
+    };
+    const nameOf = (el) => (el.getAttribute('aria-label') || el.textContent || '').replace(/\s+/g, ' ').trim().slice(0, 80);
+    const internalPath = (el) => {
+        const raw = (el.getAttribute('href') || '').trim();
+        if (!raw || raw.startsWith('#'))
+            return null;
+        try {
+            const u = new URL(raw, location.href);
+            return u.origin === location.origin ? `${u.pathname}${u.search}` : null;
+        }
+        catch {
+            return null;
+        }
+    };
+    // Semantic nav first (a[href], role=tab/menuitem, <nav>/tablist buttons); then a
+    // conservative class heuristic for button-only navs that skip ARIA — a container
+    // whose class strongly implies navigation (nav / navtab / subnav / tabs / subtab).
+    // Erring broad is correct here: a stray non-nav button is harmless noise, but a
+    // MISSED nav item defeats the guard. Prefer semantic markup (role=tablist) for
+    // fully reliable harvesting; see docs/inventory-guard.md.
+    const SEL = 'a[href], [role="tab"], [role="menuitem"], [role="menuitemradio"], [role="menuitemcheckbox"], nav button, [role="navigation"] button, [role="tablist"] button, [class*="navtab" i] button, [class*="nav-tab" i] button, [class*="subnav" i] button, [class*="subtab" i] button, [class*="tabs" i] button';
+    return Array.from(document.querySelectorAll(SEL))
+        .filter(visible)
+        .map((el) => ({
+        tag: el.tagName.toLowerCase(),
+        role: (el.getAttribute('role') || '').toLowerCase(),
+        name: nameOf(el),
+        internalPath: el.tagName === 'A' ? internalPath(el) : null,
+    }));
+}
+const slug = (s) => s
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .slice(0, 60);
+/** Pure: turn raw affordances into keyed, deduped, sorted navigable items. */
+export function classifyInventory(raw) {
+    const items = new Map();
+    const add = (key, kind, label, href) => {
+        if (key && !items.has(key))
+            items.set(key, href ? { key, kind, label, href } : { key, kind, label });
+    };
+    for (const c of raw) {
+        if (c.tag === 'a' && c.internalPath) {
+            add(`route:${c.internalPath}`, 'link', c.name || c.internalPath, c.internalPath);
+        }
+        else if (c.name && c.role === 'tab') {
+            add(`tab:${slug(c.name)}`, 'tab', c.name);
+        }
+        else if (c.name && c.role.startsWith('menuitem')) {
+            add(`menuitem:${slug(c.name)}`, 'menuitem', c.name);
+        }
+        else if (c.name && c.tag === 'button') {
+            add(`nav-button:${slug(c.name)}`, 'nav-button', c.name);
+        }
+    }
+    return Array.from(items.values()).sort((a, b) => a.key.localeCompare(b.key));
+}
+/** Harvest a page's inventory: thin in-page collect + pure classify. */
+export async function harvestInventory(page) {
+    return classifyInventory(await page.evaluate(collectNavAffordances));
+}
+// ── pure diff / union / guard ───────────────────────────────────────────────────
+/** Union the per-surface inventories of a whole run into one reachable set. */
+export function unionInventory(perSurface) {
+    const byKey = new Map();
+    for (const map of perSurface) {
+        for (const item of map?.inventory ?? [])
+            if (!byKey.has(item.key))
+                byKey.set(item.key, item);
+    }
+    return Array.from(byKey.values()).sort((a, b) => a.key.localeCompare(b.key));
+}
+/** Base vs head reachable sets → what the UI newly offers / stopped offering. */
+export function diffInventory(base, head) {
+    const headKeys = new Set(head.map((i) => i.key));
+    const baseKeys = new Set(base.map((i) => i.key));
+    return {
+        added: head.filter((i) => !baseKeys.has(i.key)),
+        removed: base.filter((i) => !headKeys.has(i.key)),
+    };
+}
+/**
+ * The gate. Removals that aren't acknowledged in `allowed` (key -> reason) are
+ * unexplained — the caller fails on a non-empty result. An `allowed` key that
+ * isn't actually removed is a stale acknowledgement, returned separately so the
+ * ledger can't quietly rot (mirrors the `exclude` coverage guard).
+ */
+export function auditRemovals(delta, allowed = {}) {
+    const removedKeys = new Set(delta.removed.map((i) => i.key));
+    return {
+        unexplained: delta.removed.filter((i) => !(i.key in allowed)),
+        staleAllowances: Object.keys(allowed).filter((k) => !removedKeys.has(k)),
+    };
+}
+/**
+ * Run-level entry point: union both sides' per-surface `map.inventory`, diff, and
+ * audit removals. This is what a gate calls — pass every base map and every head
+ * map (the reachable set is the union across all surfaces). `unexplained` non-empty
+ * ⇒ the gate should fail; `staleAllowances` non-empty ⇒ prune the ledger.
+ */
+export function auditRunInventory(baseMaps, headMaps, allowed = {}) {
+    const delta = diffInventory(unionInventory(baseMaps), unionInventory(headMaps));
+    return { delta, ...auditRemovals(delta, allowed) };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "styleproof",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Catch every CSS change before it ships — review PRs and certify refactors by the browser's computed styles, not pixels. Works with any styling system.",
   "keywords": [
     "playwright",