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

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { Browser } from 'playwright';
-import { T as TileflowCaptureRendererIdentity, a as TileflowCaptureReceiptV4, b as TileflowCaptureDataInput, c as TileflowCaptureWorldIdentityV3, d as TileflowCaptureReceipt } from './receipt-Q7wQ68tG.js';
-export { C as CreateTileflowCaptureReceiptInput, e as TileflowCaptureDataBindingsV2, f as TileflowCaptureDataCapabilitiesV2, g as TileflowCaptureDataIdentityV2, h as TileflowCaptureDataIdentityV3, i as TileflowCaptureDataSemanticsV2, j as TileflowCaptureDataSourceV2, k as TileflowCaptureReceiptV2, l as TileflowCaptureReceiptV3, m as TileflowCaptureVectorIdentityV3, n as TileflowCaptureVerificationV2, o as createTileflowCaptureReceipt, p as createTileflowCaptureRendererIdentity, q as parseTileflowCaptureReceipt, s as serializeTileflowCaptureReceipt, t as tileflowCaptureReceiptLimits, r as tileflowCaptureReceiptSchemaVersion, u as tileflowCaptureRuntime, v as validateTileflowCaptureReceipt } from './receipt-Q7wQ68tG.js';
-import { TileflowCaptureScene, MapLibreStyle, NormalizedTileflowCaptureScene } from '@tileflow/core';
-import { TileflowIconResolutionOptions, TileflowBuildArtifacts, TileflowBuildAsset } from '@tileflow/dev/artifacts';
+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 { TileflowBuildAsset, TileflowIconResolutionOptions, TileflowBuildArtifacts } from '@tileflow/dev/artifacts';
 
 type TileflowBrowserInstallProgress = 'installing' | 'installed';
 type TileflowBrowserLaunchOptions = {
@@ -24,6 +24,49 @@ declare class TileflowCaptureBrowserManager {
     close(): Promise<void>;
 }
 
+declare const tileflowSyntheticAssetOrigin = "https://tileflow.local.invalid";
+type TileflowCaptureAsset = TileflowBuildAsset & {
+    url?: string;
+};
+
+type TileflowShotVideoCodec = 'vp8' | 'vp9';
+
+type TileflowShotFormat = 'frames' | 'webm';
+/** One rendered frame, delivered in order while a shot renders. */
+type TileflowShotFrame = {
+    shot: string;
+    index: number;
+    png: Uint8Array;
+    sha256: string;
+};
+type TileflowShotCapture = {
+    shot: string;
+    map: string;
+    theme: string;
+    format: TileflowShotFormat;
+    /** WebM bytes for the `webm` format. Frames reach `onFrame` and are not retained. */
+    video?: Uint8Array;
+    codec?: TileflowShotVideoCodec;
+    /** SHA-256 of the video, or of the frame set (`framesSha256`) for the `frames` format. */
+    sha256: string;
+    framesSha256: string;
+    frameSha256s: string[];
+    shotSha256: string;
+    styleSha256: string;
+    fps: NormalizedTileflowCaptureShot['fps'];
+    frameCount: number;
+    durationMs: number;
+    width: number;
+    height: number;
+    dpr: 1 | 2;
+    networkDependent: boolean;
+    renderer: TileflowCaptureRendererIdentity;
+    receipt: TileflowShotReceiptV1;
+    warnings: string[];
+};
+/** SHA-256 of each frame's PNG SHA-256 in lowercase hex, one per line, in frame order. */
+declare function tileflowShotFramesSha256(frameSha256s: readonly string[]): Promise<string>;
+
 declare const tileflowCaptureResultSchemaVersion: 1;
 type TileflowCaptureOptions = {
     allowBrowserInstall?: boolean;
@@ -61,25 +104,46 @@ type TileflowCapture = {
     networkDependent: boolean;
     renderer: TileflowCaptureRendererIdentity;
     /** Newly captured evidence is always the concrete-theme receipt contract. */
-    receipt: TileflowCaptureReceiptV4;
+    receipt: TileflowCaptureReceipt;
     warnings: string[];
 };
 type TileflowCaptureResult = {
     schemaVersion: 1;
     captures: TileflowCapture[];
 };
+type TileflowShotCaptureOptions = {
+    /** `webm` (the default) encodes a VP9 or VP8 video; `frames` delivers only PNG frames. */
+    format?: TileflowShotFormat;
+    /** Receives each frame's PNG in order while the shot renders. */
+    onFrame?: (frame: TileflowShotFrame) => Promise<void> | void;
+    signal?: AbortSignal;
+};
+type TileflowShotCaptureResult = {
+    schemaVersion: 1;
+    shots: TileflowShotCapture[];
+};
+type CaptureTileflowShotOptions = CreateTileflowCaptureSessionOptions & Omit<TileflowShotCaptureOptions, 'signal'> & {
+    shot: string;
+};
 type TileflowCaptureSession = {
     capture(scenes: string[], signal?: AbortSignal): Promise<TileflowCaptureResult>;
     captureAll(signal?: AbortSignal): Promise<TileflowCaptureResult>;
     captureDefinitions(scenes: Record<string, TileflowCaptureScene>, signal?: AbortSignal): Promise<TileflowCaptureResult>;
     captureArtifacts(artifacts: TileflowBuildArtifacts, requestedScenes: string[], signal?: AbortSignal): Promise<TileflowCaptureResult>;
+    /** Renders one committed shot. */
+    captureShot(shot: string, options?: TileflowShotCaptureOptions): Promise<TileflowShotCapture>;
+    /** Renders committed shots in name order from one compiled artifact snapshot. */
+    captureShots(shots: string[], options?: TileflowShotCaptureOptions): Promise<TileflowShotCaptureResult>;
+    captureAllShots(options?: TileflowShotCaptureOptions): Promise<TileflowShotCaptureResult>;
     close(): Promise<void>;
 };
 declare function captureTileflowScenes(options: TileflowCaptureOptions): Promise<TileflowCaptureResult>;
+/** Renders one committed shot with a temporary session. */
+declare function captureTileflowShot(options: CaptureTileflowShotOptions): Promise<TileflowShotCapture>;
 declare function createTileflowCaptureSession(options?: CreateTileflowCaptureSessionOptions): TileflowCaptureSession;
 
-type TileflowCaptureErrorCode = 'ABORTED' | 'APPLICATION_ORIGIN_REQUIRED' | 'APPLICATION_ORIGIN_INVALID' | 'APPLICATION_NAVIGATION_FAILED' | 'APPLICATION_TARGET_NOT_FOUND' | 'APPLICATION_TARGET_AMBIGUOUS' | 'APPLICATION_ERROR' | 'BASELINE_INVALID' | 'BROWSER_INSTALL_FAILED' | 'BROWSER_MISSING' | 'BROWSER_START_FAILED' | 'CAPTURE_TIMEOUT' | 'INVALID_PNG' | 'MAP_LOAD_FAILED' | 'RENDER_FAILED' | 'RESOURCE_FAILED' | 'SCENE_NOT_FOUND' | 'SCREENSHOT_FAILED' | 'STYLE_INVALID' | 'SYNTHETIC_ASSET_NOT_FOUND' | 'WORLD_RESOLUTION_FAILED';
-type TileflowCapturePhase = 'style-validation' | 'browser-start' | 'resource-load' | 'map-load' | 'map-idle' | 'screenshot';
+type TileflowCaptureErrorCode = 'ABORTED' | 'APPLICATION_ORIGIN_REQUIRED' | 'APPLICATION_ORIGIN_INVALID' | 'APPLICATION_NAVIGATION_FAILED' | 'APPLICATION_TARGET_NOT_FOUND' | 'APPLICATION_TARGET_AMBIGUOUS' | 'APPLICATION_ERROR' | 'BASELINE_INVALID' | 'BROWSER_INSTALL_FAILED' | 'BROWSER_MISSING' | 'BROWSER_START_FAILED' | 'CAPTURE_TIMEOUT' | 'INVALID_PNG' | 'MAP_LOAD_FAILED' | 'RENDER_FAILED' | 'RESOURCE_FAILED' | 'SCENE_NOT_FOUND' | 'SCREENSHOT_FAILED' | 'SHOT_NOT_FOUND' | 'STYLE_INVALID' | 'SYNTHETIC_ASSET_NOT_FOUND' | 'VIDEO_ENCODE_FAILED' | 'VIDEO_ENCODER_UNAVAILABLE' | 'WORLD_RESOLUTION_FAILED';
+type TileflowCapturePhase = 'style-validation' | 'browser-start' | 'resource-load' | 'map-load' | 'theme-blend' | 'map-idle' | 'screenshot' | 'video-encode';
 type TileflowCaptureDiagnostic = {
     message: string;
     path: string;
@@ -106,11 +170,6 @@ declare class TileflowCaptureError extends Error {
 }
 declare function captureErrorMessage(error: unknown, fallback: string): string;
 
-declare const tileflowSyntheticAssetOrigin = "https://tileflow.local.invalid";
-type TileflowCaptureAsset = TileflowBuildAsset & {
-    url?: string;
-};
-
 declare const tileflowWorldCurrentTileJsonUrl: "https://api.tileflow.dev/tiles/world/tiles.json";
 type FetchTileJson = (input: string, init: {
     cache: 'no-store';
@@ -118,7 +177,7 @@ type FetchTileJson = (input: string, init: {
     signal?: AbortSignal;
 }) => Promise<Pick<Response, 'ok' | 'status' | 'text'>>;
 type TileflowCaptureResolvedWorldV1 = Readonly<{
-    identity: Omit<TileflowCaptureWorldIdentityV3, 'kind' | 'schema' | 'schemaVersion' | 'semantics' | 'sourceId'>;
+    identity: Omit<TileflowCaptureWorldIdentity, 'kind' | 'schema' | 'schemaVersion' | 'semantics' | 'sourceId'>;
     tileJsonUrl: string;
     tileJson: string;
     tiles: readonly [string];
@@ -321,13 +380,13 @@ type TileflowVisualReviewFrameIdentity = {
     };
 };
 type TileflowVisualReviewSide = {
-    scene: TileflowCaptureReceiptV4['scene'];
-    style: TileflowCaptureReceiptV4['style'];
+    scene: TileflowCaptureReceipt['scene'];
+    style: TileflowCaptureReceipt['style'];
     frame: TileflowVisualReviewFrameIdentity;
     image: TileflowVisualImageIdentity;
-    runtime: Pick<TileflowCaptureReceiptV4, 'renderer' | 'platform'>;
-    data: TileflowCaptureReceiptV4['data'];
-    verification: TileflowCaptureReceiptV4['verification'];
+    runtime: Pick<TileflowCaptureReceipt, 'renderer' | 'platform'>;
+    data: TileflowCaptureReceipt['data'];
+    verification: TileflowCaptureReceipt['verification'];
     palette: TileflowVisualPaletteColor[];
 };
 type TileflowVisualReviewComparison = {
@@ -365,4 +424,4 @@ declare const tileflowVisualReviewLimits: Readonly<{
     maximumAggregatePngBytes: number;
 }>;
 
-export { type CreateTileflowCaptureSessionOptions, type PreparedTileflowCaptureStyle, type TileflowBrowserInstallProgress, type TileflowBrowserLaunchOptions, type TileflowCapture, TileflowCaptureBrowserManager, TileflowCaptureDataInput, type TileflowCaptureDiagnostic, TileflowCaptureError, type TileflowCaptureErrorCode, type TileflowCaptureErrorDetails, type TileflowCaptureOptions, type TileflowCapturePhase, TileflowCaptureReceipt, TileflowCaptureReceiptV4, TileflowCaptureRendererIdentity, type TileflowCaptureResolvedWorldV1, type TileflowCaptureResourceDiagnostic, type TileflowCaptureResourceKind, type TileflowCaptureResult, type TileflowCaptureSession, TileflowCaptureWorldIdentityV3, TileflowCaptureWorldSession, type TileflowVisualAppearanceDelta, type TileflowVisualAppearanceProfile, type TileflowVisualAppearanceStatistics, type TileflowVisualBaseline, type TileflowVisualComparison, type TileflowVisualComparisonDocument, type TileflowVisualComparisonStatus, type TileflowVisualImageIdentity, type TileflowVisualPaletteColor, type TileflowVisualPixelMetric, type TileflowVisualReferenceAnalysis, type TileflowVisualReferenceAnalysisDocument, type TileflowVisualReferenceAnalysisOptions, type TileflowVisualReferenceAppearance, type TileflowVisualRegion, type TileflowVisualReviewAppearance, type TileflowVisualReviewCapture, type TileflowVisualReviewComparison, type TileflowVisualReviewDefinition, type TileflowVisualReviewDocument, TileflowVisualReviewError, type TileflowVisualReviewFrameIdentity, type TileflowVisualReviewOptions, type TileflowVisualReviewSide, type TileflowVisualReviewStatus, type TileflowVisualRuntimeIdentity, type TileflowVisualSceneIdentity, analyzeTileflowCaptureReference, captureErrorMessage, captureTileflowScenes, compareTileflowCaptureToBaseline, compareTileflowCapturesForReview, createTileflowCaptureBrowserEnvironment, createTileflowCaptureSession, createTileflowVisualComparisonDocument, createTileflowVisualReferenceAnalysisDocument, createTileflowVisualReviewDocument, launchTileflowCaptureBrowser, resolveTileflowApplicationUrl, resolveTileflowCaptureWorldTileJson, serializeTileflowVisualComparison, setupTileflowCaptureBrowser, tileflowCaptureResultSchemaVersion, tileflowSyntheticAssetOrigin, tileflowVisualArtifactLimits, tileflowVisualComparisonSchemaVersion, tileflowVisualEdgeThreshold, tileflowVisualPerceptualThreshold, tileflowVisualReviewLimits, tileflowVisualReviewSchemaVersion, tileflowWorldCurrentTileJsonUrl, validateTileflowVisualReferencePng };
+export { type CaptureTileflowShotOptions, type CreateTileflowCaptureSessionOptions, type PreparedTileflowCaptureStyle, type TileflowBrowserInstallProgress, type TileflowBrowserLaunchOptions, type TileflowCapture, TileflowCaptureBrowserManager, TileflowCaptureDataInput, type TileflowCaptureDiagnostic, TileflowCaptureError, type TileflowCaptureErrorCode, type TileflowCaptureErrorDetails, type TileflowCaptureOptions, type TileflowCapturePhase, TileflowCaptureReceipt, TileflowCaptureRendererIdentity, type TileflowCaptureResolvedWorldV1, type TileflowCaptureResourceDiagnostic, type TileflowCaptureResourceKind, type TileflowCaptureResult, type TileflowCaptureSession, TileflowCaptureWorldIdentity, TileflowCaptureWorldSession, type TileflowShotCapture, type TileflowShotCaptureOptions, type TileflowShotCaptureResult, type TileflowShotFormat, type TileflowShotFrame, TileflowShotReceiptV1, type TileflowShotVideoCodec, type TileflowVisualAppearanceDelta, type TileflowVisualAppearanceProfile, type TileflowVisualAppearanceStatistics, type TileflowVisualBaseline, type TileflowVisualComparison, type TileflowVisualComparisonDocument, type TileflowVisualComparisonStatus, type TileflowVisualImageIdentity, type TileflowVisualPaletteColor, type TileflowVisualPixelMetric, type TileflowVisualReferenceAnalysis, type TileflowVisualReferenceAnalysisDocument, type TileflowVisualReferenceAnalysisOptions, type TileflowVisualReferenceAppearance, type TileflowVisualRegion, type TileflowVisualReviewAppearance, type TileflowVisualReviewCapture, type TileflowVisualReviewComparison, type TileflowVisualReviewDefinition, type TileflowVisualReviewDocument, TileflowVisualReviewError, type TileflowVisualReviewFrameIdentity, type TileflowVisualReviewOptions, type TileflowVisualReviewSide, type TileflowVisualReviewStatus, type TileflowVisualRuntimeIdentity, type TileflowVisualSceneIdentity, analyzeTileflowCaptureReference, captureErrorMessage, captureTileflowScenes, captureTileflowShot, compareTileflowCaptureToBaseline, compareTileflowCapturesForReview, createTileflowCaptureBrowserEnvironment, createTileflowCaptureSession, createTileflowVisualComparisonDocument, createTileflowVisualReferenceAnalysisDocument, createTileflowVisualReviewDocument, launchTileflowCaptureBrowser, resolveTileflowApplicationUrl, resolveTileflowCaptureWorldTileJson, serializeTileflowVisualComparison, setupTileflowCaptureBrowser, tileflowCaptureResultSchemaVersion, tileflowShotFramesSha256, tileflowSyntheticAssetOrigin, tileflowVisualArtifactLimits, tileflowVisualComparisonSchemaVersion, tileflowVisualEdgeThreshold, tileflowVisualPerceptualThreshold, tileflowVisualReviewLimits, tileflowVisualReviewSchemaVersion, tileflowWorldCurrentTileJsonUrl, validateTileflowVisualReferencePng };