@tileflow/capture 0.1.0-alpha.16 → 0.1.0-alpha.18

package/GENERATED_OUTPUT_LICENSE.md

@@ -0,0 +1,21 @@
+# Tileflow generated-output grant
+
+In addition to the rights granted by the Apache License, Version 2.0, Tileflow.dev contributors
+grant recipients a perpetual, worldwide, non-exclusive, no-charge, royalty-free right to use,
+reproduce, modify, display, perform, distribute, sublicense, and commercialize the Tileflow-owned
+parts of output generated by this SDK.
+
+Covered output includes compiled map styles, manifests, receipts, sprites, glyph artifacts, static
+render descriptions, and other build artifacts produced from Tileflow maps or application maps.
+Original Tileflow map definitions, icons, and patterns distributed by `@tileflow/maps` may likewise
+be used, modified, embedded, deployed, and redistributed as part of personal or commercial maps and
+applications.
+
+This grant does not relicense third-party software, fonts, icons, map data, datasets, imagery, or
+other input material. Their licenses, attribution requirements, notices, and use restrictions
+continue to apply to the relevant source and generated output. You are responsible for having the
+rights necessary to process and distribute your own inputs.
+
+This grant does not provide access to Tileflow hosted services or grant rights in Tileflow names,
+logos, or marks. The SDK and generated output are provided without warranties or conditions beyond
+those required by applicable law.

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 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 [yyyy] [name of copyright owner]
+
+   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,9 @@
+Tileflow SDK
+Copyright 2026 Tileflow.dev contributors
+
+This product includes software and original map artwork developed by Tileflow.dev contributors.
+
+Third-party materials distributed with a package remain subject to their own license and notice
+files. See THIRD_PARTY_NOTICES.md and asset-adjacent license files where present.
+
+The Tileflow names and marks are not licensed under the Apache License 2.0. See TRADEMARKS.md.

package/README.md

@@ -38,9 +38,10 @@ try {
 ```
 
 Sessions can also capture caller-provided scene definitions or a prepared `TileflowBuildArtifacts`
-snapshot. Results carry PNG bytes, dimensions, hashes, safe runtime identity, the canonical receipt,
-warnings, and a `networkDependent` flag. They never expose a Playwright page or browser as part of
-the capture result.
+snapshot. Every durable definition names one concrete theme; omission and the browser-only
+`system` selector are rejected. Results carry that theme, PNG bytes, dimensions, hashes, safe
+runtime identity, the canonical receipt, warnings, and a `networkDependent` flag. They never expose
+a Playwright page or browser as part of the capture result.
 
 Failures use `TileflowCaptureError` with a stable code and optional bounded details. The phase
 distinguishes style validation, browser start, resource loading, MapLibre load/idle, and screenshot
@@ -63,9 +64,11 @@ Tileflow does not start or discover the server. It accepts only loopback HTTP(S)
 context without reused profile/cookies/storage or service workers, confines redirects to the exact
 approved origin, finds exactly one target, waits for Tileflow's `data-tileflow-state="idle"` marker,
 and captures the element or viewport. The React, Vue, and Svelte wrappers expose the marker plus
-`data-tileflow-map` and optional `data-tileflow-capture-id`. A full one-off `appUrl`, selector, and
-frame can be supplied through the session options. The route and component props own application
-camera state; capture includes that camera in scene identity but does not rewrite it.
+`data-tileflow-map`, the resolved `data-tileflow-theme`, and optional `data-tileflow-capture-id`.
+Capture verifies the concrete theme before and after screenshot production. A full one-off
+`appUrl`, selector, and frame can be supplied through the session options. The route and component
+props own application camera state; capture includes that camera in scene identity but does not
+rewrite it.
 
 ## Prepared/offline browser setup
 
@@ -85,10 +88,28 @@ cost in advance or verify prepared CI, not as a prerequisite for normal capture.
 
 `createTileflowCaptureReceipt`, `parseTileflowCaptureReceipt`,
 `validateTileflowCaptureReceipt`, and `serializeTileflowCaptureReceipt` implement the strict,
-bounded schema-version-1 receipt contract. A receipt contains image/scene/style hashes, dimensions,
-renderer/platform identity, required nullable `source.tilesetVersion` evidence, and
-remote-dependency state; it contains no time, user, origin,
-repository, absolute path, config source, environment, or credential.
+bounded schema-version-4 receipt contract. A receipt contains the concrete theme,
+image/scene/style hashes, dimensions,
+renderer/platform identity, the required resolved `data` identity, explicit style/data verification,
+and remote-dependency state. Standalone map receipts mark configured style and data as `rendered`;
+application receipts mark them as `expected-unverified` because capture cannot inspect an arbitrary
+application's live MapLibre instance. Vector endpoints are represented by a query-free SHA-256
+fingerprint rather than a raw URL. Receipts contain no time, user, origin, path, query, signed token,
+repository, absolute filesystem path, config source, environment, or credential.
+
+For Tileflow World, Capture resolves the map's TileJSON selector once per session, requires
+`tileflow.world` to identify `world-v1` with exact release, descriptor, archive, data-contract, and
+product-contract SHA-256 values, and renders every standalone scene from the returned immutable tile
+template. Repeated scenes and retries reuse that one resolution; another selector in the same
+session fails instead of mixing releases. Existing canonical schema-v2 and schema-v3 receipts remain
+readable as historical evidence and are never reclassified as schema v4.
+
+Capture reuses Core's exact World V1 release-ID contract: 12–128 characters matching
+`^world-v1-[a-z0-9][a-z0-9._-]*[a-z0-9]$`. Selector responses and durable receipts reject rather
+than normalize uppercase, whitespace, another generation, or an incomplete boundary value.
+
+Receipt-only tooling can import these contracts from `@tileflow/capture/receipt` without loading the
+Playwright capture runtime.
 
 ```ts
 import {compareTileflowCaptureToBaseline} from '@tileflow/capture';
@@ -104,18 +125,61 @@ pixels. It classifies unchanged, changed, missing, scene-mismatch, and runtime-m
 reports exact RGBA changed pixels plus a fixed 0.1 perceptual metric, and returns an optional
 transparent high-contrast diff PNG. Exact RGBA inequality determines `changed`.
 
+To review two deliberate Tileflow renders that are allowed to use different maps, themes, and
+styles, use the separate review primitive:
+
+```ts
+import {
+  compareTileflowCapturesForReview,
+  createTileflowVisualReviewDocument,
+} from '@tileflow/capture';
+
+const review = await compareTileflowCapturesForReview(
+  {capture: leftCapture, definition: leftDefinition},
+  {capture: rightCapture, definition: rightDefinition},
+  {includeDiff: true, region: {x: 0, y: 0, width: 1200, height: 760}},
+);
+const document = createTileflowVisualReviewDocument(review);
+```
+
+Review requires each PNG, its schema-v4 receipt, and the exact normalized definition used to
+produce it. It authenticates both sides before comparing pixels. Different map/style/theme
+identities are intentional, but camera, viewport, target frame, physical dimensions, renderer, and
+resolved data identity must agree before exact or perceptual metrics are meaningful. Statuses are
+`comparable`, `frame-mismatch`, `dimensions-mismatch`, `runtime-mismatch`, and `data-mismatch`.
+Inputs are snapshotted from plain accessor-free data before asynchronous work, and both individual
+and aggregate PNG byte limits are enforced before hashing. Pixelmatch runs only for compatible
+captures; `includeDiff: false` does not allocate or encode a diff. The optional diff is contextual
+evidence only; this API never reads, writes, or approves a visual baseline.
+
+Every comparable review also reports `appearance: {region, left, right, rightMinusLeft}`. Profiles
+contain linear luminance, OKLab lightness/chroma (`mean`, `p10`, `p50`, `p90`), edge density, and
+local contrast. The optional region is one bounded physical-pixel rectangle from the top-left and
+affects only `appearance`; exact/perceptual metrics and the diff still describe the complete frame.
+
+Review documents are a schema-version-1 compatibility boundary, exposed through
+`tileflowVisualReviewSchemaVersion`. `tileflowVisualReviewLimits.maximumAggregatePngBytes` exposes
+the 256 MiB aggregate input cap; each input is also subject to the 256 MiB
+`tileflowVisualArtifactLimits.maximumPngBytes` cap and the shared decoded-pixel limits. Invalid,
+non-plain, unauthenticated, or over-limit inputs throw `TileflowVisualReviewError` with stable code
+`VISUAL_REVIEW_INVALID`. `createTileflowVisualReviewDocument` removes contextual `diffPng` bytes
+while retaining the versioned identities, status, metrics, and warnings.
+
 For an external design screenshot that has no Tileflow receipt, use the separate exploratory
 primitive:
 
 ```ts
 import {analyzeTileflowCaptureReference} from '@tileflow/capture';
 
-const analysis = await analyzeTileflowCaptureReference(result.captures[0], referencePng);
+const analysis = await analyzeTileflowCaptureReference(result.captures[0], referencePng, {
+  region: {x: 0, y: 0, width: 1200, height: 760},
+});
 ```
 
 It strictly validates the bounded non-interlaced PNG, reports dimensions and up to 16 deterministic
 quantized palette entries, and—only for equal dimensions—exact/perceptual changed pixels, mean
-absolute RGBA-channel difference, and a high-contrast diff PNG. It does not assert scene/runtime
+absolute RGBA-channel difference, a high-contrast diff PNG, and
+`appearance.actualMinusReference` with the same signed profile. It does not assert scene/runtime
 compatibility, accept a receipt for the reference, or create a baseline.
 
 ## Security and determinism boundary

package/THIRD_PARTY_NOTICES.md

@@ -4,13 +4,13 @@
 package distributions contain the complete license texts and notices; this file keeps the relevant
 attribution and browser-provisioning boundary visible in the Tileflow package itself.
 
-## Playwright 1.60.0
+## Playwright 1.62.1
 
 Copyright (c) Microsoft Corporation. Licensed under the Apache License, Version 2.0. Playwright
 contains code derived from Puppeteer, also available under Apache-2.0. The installed `playwright`
 and `playwright-core` packages include `LICENSE`, `NOTICE`, and `ThirdPartyNotices.txt` files.
 
-## Chromium headless shell revision 1223
+## Chromium headless shell revision 1234
 
 Chromium is licensed under the BSD license and includes third-party software under additional open
 source licenses. It is not contained in the `@tileflow/capture` npm tarball. Playwright provisions

package/TRADEMARKS.md

@@ -0,0 +1,10 @@
+# Tileflow trademarks
+
+The Apache License, Version 2.0, and the Tileflow generated-output grant do not grant permission to
+use the Tileflow name, `tileflow.dev`, logos, service marks, product names, or other Tileflow brand
+features except for reasonable and customary use that truthfully describes the origin of the SDK or
+compatibility with Tileflow, and for reproducing required notices.
+
+You may not use Tileflow brand features in a way that suggests sponsorship, endorsement, or an
+official Tileflow product when none exists. Third-party names and marks remain the property of their
+respective owners.