@tileflow/capture 0.1.0-alpha.30 → 0.1.0-alpha.32

package/README.md

@@ -1,5 +1,10 @@
 # @tileflow/capture
 
+For the complete CLI workflow, use `describe`, `inspect`, `capture`, `compare`, and Map DevTools (`preview`)
+as described in the [CLI guide](https://github.com/tileflow/tileflow-sdk/blob/main/packages/cli/README.md).
+New still captures include their normalized `definition` for later review. The CLI stores immutable
+capture IDs so `compare --before <id> --after <id>` can reuse evidence without rendering again.
+
 Headless Tileflow map capture for Node.js. Produce PNGs with versioned receipts, compare reviewed
 baselines, or inspect differences between deliberate renders. Use the
 [CLI](https://github.com/tileflow/tileflow-sdk/blob/main/packages/cli/README.md) for ordinary terminal
@@ -243,7 +248,9 @@ the perceptual metric and optional diff image are additional evidence. Never upd
 merely to make a failing comparison pass.
 
 `compareTileflowCapturesForReview` compares two deliberate renders with different styles while
-requiring compatible framing, renderer, and data identity. `analyzeTileflowCaptureReference` analyzes
+requiring compatible framing, renderer, and data identity. It accepts captures with or without a
+retained `definition`; when present, that definition must match the explicit review definition.
+`analyzeTileflowCaptureReference` analyzes
 an external PNG without claiming receipt compatibility. Neither operation approves a baseline.
 See the [receipt and comparison reference](https://github.com/tileflow/tileflow-sdk/blob/main/packages/capture/docs/receipts-and-comparison.md),
 also included under `docs/` in the installed package, for identities, metrics, and limits.

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Browser } from 'playwright';
 import { T as TileflowCaptureRendererIdentity, a as TileflowShotReceiptV1, b as TileflowCaptureReceipt, c as TileflowCaptureDataInput, d as TileflowCaptureWorldIdentity } from './receipt-CfZkzyXd.js';
 export { C as CreateTileflowCaptureReceiptInput, e as CreateTileflowShotReceiptInput, f as TileflowCaptureDataBindings, g as TileflowCaptureDataCapabilities, h as TileflowCaptureDataIdentity, i as TileflowCaptureDataSemantics, j as TileflowCaptureDataSource, k as TileflowCaptureVectorIdentity, l as TileflowCaptureVerification, m as createTileflowCaptureReceipt, n as createTileflowCaptureRendererIdentity, o as createTileflowShotReceipt, p as parseTileflowCaptureReceipt, q as parseTileflowShotReceipt, s as serializeTileflowCaptureReceipt, r as serializeTileflowShotReceipt, t as tileflowCaptureReceiptLimits, u as tileflowCaptureReceiptSchemaVersion, v as tileflowCaptureRuntime, w as tileflowShotReceiptLimits, x as tileflowShotReceiptSchemaVersion, y as validateTileflowCaptureReceipt, z as validateTileflowShotReceipt } from './receipt-CfZkzyXd.js';
-import { NormalizedTileflowCaptureShot, TileflowCaptureScene, MapLibreStyle, NormalizedTileflowCaptureScene } from '@tileflow/core';
+import { NormalizedTileflowCaptureShot, NormalizedTileflowCaptureScene, TileflowCaptureScene, MapLibreStyle } from '@tileflow/core';
 import { TileflowBuildAsset, TileflowIconResolutionOptions, TileflowBuildArtifacts } from '@tileflow/dev/artifacts';
 
 type TileflowBrowserInstallProgress = 'installing' | 'installed';
@@ -90,6 +90,10 @@ type TileflowCaptureOptions = {
 };
 type CreateTileflowCaptureSessionOptions = Omit<TileflowCaptureOptions, 'scenes'>;
 type TileflowCapture = {
+    /** Concrete normalized frame retained for later review without rendering again. */
+    definition?: NormalizedTileflowCaptureScene & {
+        theme: string;
+    };
     scene: string;
     map: string;
     theme: string;

package/dist/index.js

@@ -350,6 +350,7 @@ var tileflowBrowserModule = `${readFileSync2(
 globalThis.__tileflowRegisterContourProtocol = registerTileflowContourProtocol;
 globalThis.__tileflowRegisterPmtilesProtocol = registerTileflowPmtilesProtocol;
 globalThis.__tileflowAttachAtmosphere = attachTileflowAtmosphere;
+globalThis.__tileflowAttachNotices = attachTileflowNotices;
 globalThis.__tileflowCreateThemeController = createTileflowThemeController;`;
 async function captureStandaloneTileflowScene(input) {
   if (input.scene.target.kind !== "map") {
@@ -1010,6 +1011,8 @@ window.__tileflowCaptureLoad = async function(input) {
     window.__tileflowMap = map;
     window.__tileflowCaptureStyle = input.style;
     window.__tileflowAttachAtmosphere(map);
+    // Notices such as "Not for navigation" are part of the map, so captured images keep them.
+    window.__tileflowAttachNotices(map);
     return await waitForMapEvent(map, "load", input.mapEventTimeoutMs);
   } catch (error) {
     return {status: "failed", reason: "error", message: String(error?.message || error || "")};
@@ -2689,6 +2692,7 @@ var TileflowCaptureSessionImpl = class {
         width: rendered.width
       });
       captures.push({
+        definition: scene,
         scene: sceneName,
         map: scene.map,
         theme: scene.theme,
@@ -3769,7 +3773,9 @@ function snapshotReviewInputs(leftInput, rightInput) {
 }
 function inspectReviewInput(input, role) {
   const wrapper = readPlainDataRecord(input, `${role} review input`, ["capture", "definition"]);
-  const capture = readPlainDataRecord(wrapper.capture, `${role} capture`, reviewCaptureKeys);
+  const capture = readPlainDataRecord(wrapper.capture, `${role} capture`, reviewCaptureKeys, [
+    "definition"
+  ]);
   const definition = clonePlainDataValue(
     wrapper.definition,
     `${role} definition`
@@ -3786,6 +3792,12 @@ function inspectReviewInput(input, role) {
   const png = requireReviewPng(capture.png, role);
   return {
     capture: {
+      ...capture.definition === void 0 ? {} : {
+        definition: clonePlainDataValue(
+          capture.definition,
+          `${role} capture.definition`
+        )
+      },
       scene: capture.scene,
       map: capture.map,
       theme: capture.theme,
@@ -3940,7 +3952,7 @@ function clonePlainDataValue(value, path, state = {
     state.ancestors.delete(value);
   }
 }
-function readPlainDataRecord(value, path, expectedKeys) {
+function readPlainDataRecord(value, path, expectedKeys, optionalKeys = []) {
   if (!value || typeof value !== "object" || Array.isArray(value)) {
     throw invalidReview(`The ${path} must be a plain data object.`);
   }
@@ -3964,7 +3976,7 @@ function readPlainDataRecord(value, path, expectedKeys) {
     entries.push([key, descriptor.value]);
   }
   if (expectedKeys) {
-    const actual = entries.map(([key]) => key).sort(compareCodeUnits5);
+    const actual = entries.map(([key]) => key).filter((key) => !optionalKeys.includes(key)).sort(compareCodeUnits5);
     const wanted = [...expectedKeys].sort(compareCodeUnits5);
     if (actual.length !== wanted.length || actual.some((key, index) => key !== wanted[index])) {
       throw invalidReview(`The ${path} contains missing or unsupported fields.`);
@@ -3983,6 +3995,9 @@ async function validateReviewCapture(input, role) {
   if (!sameCanonicalValue(input.definition, definition)) {
     throw invalidReview(`The ${role} review definition must be the exact normalized shape.`);
   }
+  if (input.capture.definition !== void 0 && !sameCanonicalValue(input.capture.definition, definition)) {
+    throw invalidReview(`The ${role} retained capture definition does not match its review.`);
+  }
   let parsedReceipt;
   try {
     parsedReceipt = validateTileflowCaptureReceipt(input.capture.receipt);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tileflow/capture",
-  "version": "0.1.0-alpha.30",
+  "version": "0.1.0-alpha.32",
   "license": "Apache-2.0",
   "description": "Deterministic local visual capture and comparison for Tileflow maps.",
   "engines": {
@@ -48,8 +48,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@tileflow/core": ">=0.1.0-alpha.34 <0.1.0-beta.0",
-    "@tileflow/dev": ">=0.1.0-alpha.31 <0.1.0-beta.0",
+    "@tileflow/core": ">=0.1.0-alpha.37 <0.1.0-beta.0",
+    "@tileflow/dev": ">=0.1.0-alpha.34 <0.1.0-beta.0",
     "maplibre-gl": "6.13.0",
     "pixelmatch": "7.2.0",
     "playwright": "1.62.1",
@@ -68,12 +68,12 @@
     "vite": "^8.0.16",
     "vue": "^3.5.43",
     "webpack": "5.108.3",
-    "@tileflow/maps": "0.1.0-alpha.8",
     "@tileflow/next": "0.1.0-alpha.25",
-    "@tileflow/react": "0.1.0-alpha.29",
-    "@tileflow/svelte": "0.1.0-alpha.28",
+    "@tileflow/maps": "0.1.0-alpha.11",
+    "@tileflow/react": "0.1.0-alpha.32",
+    "@tileflow/svelte": "0.1.0-alpha.30",
     "@tileflow/vite": "0.1.0-alpha.25",
-    "@tileflow/vue": "0.1.0-alpha.28",
+    "@tileflow/vue": "0.1.0-alpha.30",
     "@tileflow/webpack": "0.1.0-alpha.25"
   },
   "scripts": {