@tileflow/core 0.1.0-alpha.38 → 0.1.0-alpha.39

package/dist/browser.d.ts

@@ -1,5 +1,5 @@
-import { T as TileflowSymbolStyle, a as TileflowThemeImageValue, b as TileflowThemeColorValue, c as TileflowMarkerSymbolStyle, d as TileflowAreaStyle, e as TileflowLineStackStyle, f as TileflowLineHatchStyle, g as TileflowIconStyle, h as TileflowLinePaint, i as TileflowThemeNumberValue, j as TileflowNumberStyleValue, k as TileflowCircleStyle, l as TileflowLineStyle, m as TileflowFillStyle, n as TileflowExtrusionStyle, o as TileflowBackgroundStyle, p as TileflowSymbolPlacement, q as TileflowVegetationModuleConfig, r as TileflowTileLayer, s as TileflowMap3DOptions, t as TileflowMap3D, u as TileflowViewMode, v as TileflowSun } from './3d-D9c3i78O.js';
-export { w as TileflowBuildings3D, x as TileflowBuildings3DChange, y as TileflowBuildings3DMap, z as TileflowBuildings3DOptions, A as TileflowBuildings3DThemes, B as TileflowMap3DMap, C as TileflowStreetLights, D as TileflowStreetLightsMap, E as TileflowStreetLightsOptions, F as TileflowSunPreset, G as TileflowTile, H as TileflowTileAddress, I as TileflowTileAreaRequest, J as TileflowTileFeature, K as TileflowTileGeometryType, L as TileflowTileReader, M as TileflowTileReaderOptions, N as TileflowTileRequestTransform, O as TileflowTileSourceMap, P as TileflowTreeFields, Q as TileflowTreeForm, R as TileflowTreeFormMix, S as TileflowTreeFormRange, U as TileflowTreeLayers, V as TileflowTreePlacement, W as TileflowTreePlacementOptions, X as TileflowTreeRange, Y as TileflowTreeRegion, Z as TileflowTrees3D, _ as TileflowTrees3DChange, $ as TileflowTrees3DMap, a0 as TileflowTrees3DOptions, a1 as TileflowTrees3DThemes, a2 as TileflowVectorTileDecodeOptions, a3 as TileflowVegetation3D, a4 as TileflowVegetationController, a5 as TileflowVegetationDisplay, a6 as TileflowVegetationOptions, a7 as TileflowVegetationRepresentation, a8 as createTileflowBuildings3D, a9 as createTileflowMap3D, aa as createTileflowStreetLights, ab as createTileflowTileReader, ac as createTileflowTrees3D, ad as createTileflowVegetation, ae as decodeTileflowVectorTile, af as mixTileflowSunPresets, ag as placeTileflowTrees, ah as readTileflowMapTileSource, ai as readTileflowSunPreset, aj as readTileflowVegetation3D, ak as readTileflowVegetationDisplay, al as resolveTileflowSun, am as resolveTileflowVegetationRepresentation, an as tileflowBuildings3DLayerId, ao as tileflowDefaultSunPreset, ap as tileflowStreetLightsLayerId, aq as tileflowStyleSunPreset, ar as tileflowSunDirection, as as tileflowSunMetadataKey, at as tileflowSunPosition, au as tileflowTilePointToLngLat, av as tileflowTilesForBounds, aw as tileflowTreeBytes, ax as tileflowTreeFormOf, ay as tileflowTreeForms, az as tileflowTrees3DLayerId, aA as tileflowVegetationDisplayMetadataKey, aB as tileflowVegetationMetadataKey } from './3d-D9c3i78O.js';
+import { T as TileflowSymbolStyle, a as TileflowThemeImageValue, b as TileflowThemeColorValue, c as TileflowMarkerSymbolStyle, d as TileflowAreaStyle, e as TileflowLineStackStyle, f as TileflowLineHatchStyle, g as TileflowIconStyle, h as TileflowLinePaint, i as TileflowThemeNumberValue, j as TileflowNumberStyleValue, k as TileflowCircleStyle, l as TileflowLineStyle, m as TileflowFillStyle, n as TileflowExtrusionStyle, o as TileflowBackgroundStyle, p as TileflowSymbolPlacement, q as TileflowVegetationModuleConfig, r as TileflowTileLayer, s as TileflowMap3DOptions, t as TileflowMap3D, u as TileflowViewMode, v as TileflowSun } from './3d-BkaJjwfk.js';
+export { w as TileflowBuildings3D, x as TileflowBuildings3DChange, y as TileflowBuildings3DMap, z as TileflowBuildings3DOptions, A as TileflowBuildings3DThemes, B as TileflowMap3DMap, C as TileflowStreetLights, D as TileflowStreetLightsMap, E as TileflowStreetLightsOptions, F as TileflowSunPreset, G as TileflowTile, H as TileflowTileAddress, I as TileflowTileAreaRequest, J as TileflowTileFeature, K as TileflowTileGeometryType, L as TileflowTileReader, M as TileflowTileReaderOptions, N as TileflowTileRequestTransform, O as TileflowTileSourceMap, P as TileflowTreeFields, Q as TileflowTreeForm, R as TileflowTreeFormMix, S as TileflowTreeFormRange, U as TileflowTreeLayers, V as TileflowTreePlacement, W as TileflowTreePlacementOptions, X as TileflowTreeRange, Y as TileflowTreeRegion, Z as TileflowTrees3D, _ as TileflowTrees3DChange, $ as TileflowTrees3DMap, a0 as TileflowTrees3DOptions, a1 as TileflowTrees3DThemes, a2 as TileflowVectorTileDecodeOptions, a3 as TileflowVegetation3D, a4 as TileflowVegetationController, a5 as TileflowVegetationDisplay, a6 as TileflowVegetationOptions, a7 as TileflowVegetationRepresentation, a8 as createTileflowBuildings3D, a9 as createTileflowMap3D, aa as createTileflowStreetLights, ab as createTileflowTileReader, ac as createTileflowTrees3D, ad as createTileflowVegetation, ae as decodeTileflowVectorTile, af as mixTileflowSunPresets, ag as placeTileflowTrees, ah as readTileflowMapTileSource, ai as readTileflowSunPreset, aj as readTileflowVegetation3D, ak as readTileflowVegetationDisplay, al as resolveTileflowSun, am as resolveTileflowVegetationRepresentation, an as tileflowBuildings3DLayerId, ao as tileflowDefaultSunPreset, ap as tileflowStreetLightsLayerId, aq as tileflowStyleSunPreset, ar as tileflowSunDirection, as as tileflowSunMetadataKey, at as tileflowSunPosition, au as tileflowTilePointToLngLat, av as tileflowTilesForBounds, aw as tileflowTreeBytes, ax as tileflowTreeFormOf, ay as tileflowTreeForms, az as tileflowTrees3DLayerId, aA as tileflowVegetationDisplayMetadataKey, aB as tileflowVegetationMetadataKey } from './3d-BkaJjwfk.js';
 
 type TileflowColor = `#${string}`;
 type TileflowRoadDetail = 'none' | 'highways' | 'major' | 'streets' | 'all';
@@ -302,7 +302,12 @@ type TileflowDynamicImageMap = {
     off(event: string, listener: () => void): unknown;
 };
 
-type TileflowFairUseNoticeState = 'GRACE' | 'MANAGED_REQUIRED';
+/**
+ * `GRACE` and `MANAGED_REQUIRED` come from the site's fair-use state. `LIMITED` means Tileflow is
+ * temporarily limiting anonymous World delivery for everyone: cached areas keep loading while some
+ * uncached areas fail, and a managed map is not affected.
+ */
+type TileflowFairUseNoticeState = 'GRACE' | 'MANAGED_REQUIRED' | 'LIMITED';
 type TileflowFairUseNotice = Readonly<{
     action: string;
     helpUrl: string;
@@ -331,6 +336,7 @@ type TileflowFairUseNoticeController = Readonly<{
 declare function registerTileflowWorldRequestBridge(input: {
     addProtocol: (name: string, handler: TileflowWorldProtocolHandler) => void;
     fetch?: typeof fetch;
+    now?: () => number;
     onNotice: (notice: TileflowFairUseNotice | null) => void;
 }): TileflowWorldRequestBridge;
 declare function tileflowFairUseNoticeMessage(state: TileflowFairUseNoticeState): string;
@@ -549,12 +555,22 @@ type TileflowLandformsModuleConfig = TileflowLandformsModuleOptions & {
     type: 'landforms';
 };
 
-/** Labels anchored inside polygon features; point-feature labels remain on their feature style. */
+/**
+ * Labels anchored inside polygon features, and the clearance labels of bridges and overhead cables;
+ * other point-feature labels remain on their feature style.
+ */
 type TileflowNauticalAreaLabelStyles = {
+    /**
+     * Vertical clearance of bridges, or their clearance closed and open, at bridge points and inside
+     * bridge polygons; bridge lines carry it at their centre.
+     */
+    bridges?: TileflowSymbolStyle;
     /** Provider coverage cells; hidden unless a map makes this style visible. */
     coverage?: TileflowSymbolStyle;
     hazards?: TileflowSymbolStyle;
     navigationAreas?: TileflowSymbolStyle;
+    /** Safe vertical clearance of overhead cables, at cable points and along cable lines. */
+    overheadCables?: TileflowSymbolStyle;
     reefs?: TileflowSymbolStyle;
     wrecks?: TileflowSymbolStyle;
 };
@@ -567,15 +583,33 @@ type TileflowNauticalAreaLabelStyles = {
 type TileflowNauticalModuleOptions = {
     /** Other aids: moorings, fog signals, racons, radio and signal stations, and virtual aids. */
     aids?: TileflowMarkerSymbolStyle;
+    /**
+     * Flash each light in its rhythm where a browser runtime animates the map. Defaults to `true`.
+     * `false` keeps every light steady, as do reduced motion, capture, and native renderers.
+     */
+    animateLights?: boolean;
     /** Fixed beacons and daymarks, coloured by their first colour. */
     beacons?: TileflowMarkerSymbolStyle;
+    /** Berth polygons; the outline also strokes berth lines and emphasises guest berths. */
+    berths?: TileflowAreaStyle;
+    /** Bridge polygons; the outline also strokes bridge lines. */
+    bridges?: TileflowAreaStyle;
     /** Buoys, light floats, and light vessels, coloured by their first colour. */
     buoys?: TileflowMarkerSymbolStyle;
     /** Submarine cable and pipeline lines. */
     cables?: TileflowLineStyle;
     /** Restrained indication of where a provider publishes marks. */
     coverage?: TileflowAreaStyle;
-    /** Harbour and marina points. */
+    /** Waterway distance marks with their distance and unit. */
+    distanceMarks?: TileflowMarkerSymbolStyle;
+    /**
+     * Small-craft facilities such as fuel, water, slipways, pump-out, visitor berths, boat hoists,
+     * and boatyards, at facility points, inside facility polygons, and at the centre of their lines.
+     */
+    facilities?: TileflowMarkerSymbolStyle;
+    /** Harbour and marina polygons. */
+    harbourAreas?: TileflowAreaStyle;
+    /** Harbour and marina points, and their symbol and name inside harbour polygons. */
     harbours?: TileflowMarkerSymbolStyle;
     /** Hazard areas; the outline also strokes linear hazards such as booms. */
     hazardAreas?: TileflowAreaStyle;
@@ -587,6 +621,10 @@ type TileflowNauticalModuleOptions = {
     lights?: TileflowMarkerSymbolStyle;
     /** Restricted, military, anchorage, traffic-separation, and other navigation areas. */
     navigationAreas?: TileflowAreaStyle;
+    /** Inland notice boards coloured by function, with the information they show. */
+    notices?: TileflowMarkerSymbolStyle;
+    /** Overhead cable lines. */
+    overheadCables?: TileflowLineStyle;
     /** Ports, sized by `size` and placed by `rank` from low zooms. */
     ports?: TileflowMarkerSymbolStyle;
     reefs?: TileflowAreaStyle;
@@ -817,6 +855,70 @@ type TileflowThemeMotionMap = {
     updateImage?: unknown;
 };
 
+declare const tileflowSkyLayerId = "tileflow-sky";
+/** The MapLibre GL JS map capabilities the sky layer uses; importing this module loads no renderer. */
+type TileflowSkyMap = {
+    addLayer(layer: object, beforeId?: string): unknown;
+    getBearing(): number;
+    getLayer(id: string): unknown;
+    getPitch(): number;
+    getSky?(): unknown;
+    getStyle(): unknown;
+    getTerrain?(): unknown;
+    getVerticalFieldOfView?(): number;
+    isStyleLoaded(): boolean | void;
+    off(event: string, listener: () => void): unknown;
+    on(event: string, listener: () => void): unknown;
+    removeLayer(id: string): unknown;
+};
+/**
+ * Light in the sky above the horizon, for maps that declare a sky: a glow on the horizon towards
+ * a low sun, the sun's disc as it sets or rises, and stars as the sky darkens. The sun is the one
+ * a theme controller shows, so a sun an application places by date brings its glow; without a
+ * controller, the theme's own sun. The layer sits under every other layer and draws only where
+ * nothing else has, so buildings and trees stand in front. Follows style replacements; the
+ * returned function removes the layer.
+ */
+declare function attachTileflowSky(map: TileflowSkyMap): () => void;
+
+declare const tileflowSkyHazeLayerId = "tileflow-sky-haze";
+/** The MapLibre GL JS map capabilities the haze reads; importing this module loads no renderer. */
+type TileflowSkyHazeView = {
+    getBearing?(): number;
+    getCanvas?(): {
+        clientHeight: number;
+    };
+    getCenter?(): {
+        lat: number;
+        lng: number;
+    };
+    getPitch(): number;
+    getSky?(): unknown;
+    getVerticalFieldOfView?(): number;
+    getZoom?(): number;
+};
+/** The map capabilities the haze layer uses. */
+type TileflowSkyHazeMap = TileflowSkyHazeView & {
+    addLayer(layer: object, beforeId?: string): unknown;
+    getLayer(id: string): unknown;
+    getLayersOrder?(): string[];
+    getStyle(): unknown;
+    getTerrain?(): unknown;
+    moveLayer?(id: string, beforeId?: string): unknown;
+    off(event: string, listener: () => void): unknown;
+    on(event: string, listener: () => void): unknown;
+    removeLayer(id: string): unknown;
+};
+/**
+ * The distance haze over the flat map, for maps with a sky: a band of the sky's horizon colour from
+ * where the haze starts up to the horizon, thickening with the flat ground's distance, so the
+ * ground meets the sky in the colour the sky starts with. It sits under the first 3D layer (or,
+ * without one, the first label layer); Tileflow's 3D buildings, trees and models haze themselves
+ * in their own shaders, and labels drawn above it stay clear. It shows only above 45° of pitch,
+ * costs one quad, and follows style replacements; the returned function removes it.
+ */
+declare function attachTileflowSkyHaze(map: TileflowSkyHazeMap): () => void;
+
 /** Structural MapLibre capabilities; importing this module never loads a renderer. */
 type TileflowAtmosphereMap = {
     getBearing(): number;
@@ -836,13 +938,64 @@ type TileflowAtmosphereMap = {
     } | undefined;
     on(event: 'move' | 'resize' | 'style.load' | 'remove', listener: () => void): unknown;
     off(event: 'move' | 'resize' | 'style.load' | 'remove', listener: () => void): unknown;
-};
+} & Partial<TileflowSkyMap> & Partial<TileflowSkyHazeMap>;
 /**
- * Render compiled globe atmosphere metadata. Call after constructing a browser map.
- * Follows style replacements and releases its canvas, listeners, and pending frame on disposal.
+ * Render compiled globe atmosphere metadata, and the stars and distance haze of a sky. Call after
+ * constructing a browser map. Follows style replacements and releases its canvas, layer,
+ * listeners, and pending frame on disposal.
  */
 declare function attachTileflowAtmosphere(map: TileflowAtmosphereMap): () => void;
 
+/**
+ * The steepest camera pitch Tileflow supports, in degrees from looking straight down. Every
+ * portable view admits pitch 0–85, and Tileflow's maps raise MapLibre's own default of 60 to this,
+ * so a street-level view looks along the street to the sky. A map's `mapOptions.maxPitch` lowers it.
+ */
+declare const tileflowMaxPitch = 85;
+
+declare const tileflowSkyMetadataKey = "tileflow:sky";
+/** One theme's sky colours, as a time of day lends them to a sky that follows the sun. */
+type TileflowSkyColours = Readonly<{
+    color: string;
+    horizonColor: string;
+    horizonBlend: number;
+    glowColor: string;
+}>;
+/** The skies of a theme's time-of-day family, from which a sky that follows the sun is mixed. */
+type TileflowSkyTimesOfDay = Readonly<Record<'day' | 'dawn' | 'dusk' | 'night', TileflowSkyColours>>;
+/**
+ * The versioned runtime payload: what the browser needs to draw the stars and the glow round the
+ * sun, and, for a theme in a time-of-day family, the family's skies, so that a sun an application
+ * places brings the sky of its hour.
+ */
+type TileflowSkyMetadata = Readonly<{
+    version: 1;
+    starIntensity: number;
+    glowColor: string;
+    timesOfDay?: TileflowSkyTimesOfDay;
+}>;
+/** Validate the runtime payload without loading authoring schemas. */
+declare function readTileflowSky(value: unknown): TileflowSkyMetadata | undefined;
+/**
+ * The sky of a sun at this height and direction, mixed from a time-of-day family's skies: the day
+ * sky above the golden hour, the dawn or dusk sky within two degrees of sunrise or sunset (dawn while the sun is in
+ * the eastern half of the sky), and the night sky once twilight ends. Every colour comes from the
+ * family's themes, so a monochrome or a client's own family keeps its palette.
+ */
+declare function tileflowSkyAtSun(times: TileflowSkyTimesOfDay, sun: Readonly<{
+    altitude: number;
+    azimuth: number;
+}>): TileflowSkyColours;
+
+/**
+ * The WebGL context a browser map asks for. Multisampling is on, so the thin edges of 3D models,
+ * buildings and trees resolve smoothly instead of breaking into stipple. Attributes the caller
+ * passes win, so `{antialias: false}` opts out.
+ */
+declare function tileflowCanvasContextAttributes<T extends object>(attributes?: T): T & {
+    antialias: boolean;
+};
+
 /**
  * Boundaries families. Each one has its own license, attribution, TileJSON path and style source
  * ID; families are never merged.
@@ -873,7 +1026,7 @@ type TileflowBoundaryValues = Readonly<{
     rows: readonly TileflowBoundaryRow[];
 }>;
 
-type FeatureTarget = {
+type FeatureTarget$1 = {
     id?: number | string;
     source: string;
     sourceLayer?: string;
@@ -886,8 +1039,8 @@ type TileflowFeatureStateMap = {
     } | undefined;
     off(type: 'styledata', listener: () => void): unknown;
     on(type: 'styledata', listener: () => void): unknown;
-    removeFeatureState(target: FeatureTarget, key?: string): void;
-    setFeatureState(target: FeatureTarget & {
+    removeFeatureState(target: FeatureTarget$1, key?: string): void;
+    setFeatureState(target: FeatureTarget$1 & {
         id: number | string;
     }, state: Record<string, unknown>): void;
 };
@@ -1548,6 +1701,182 @@ declare const tileflowNoticeLimits: Readonly<{
 /** Read bounded notices from style metadata; malformed entries are ignored, never rendered. */
 declare function readTileflowNotices(metadata: unknown): readonly TileflowMapNotice[];
 
+type FeatureId = number | string;
+type FeatureTarget = {
+    id: FeatureId;
+    source: string;
+    sourceLayer: string;
+};
+type TileflowNauticalLightsEvent = 'idle' | 'moveend' | 'remove' | 'sourcedata' | 'style.load' | 'styledata';
+/** Structural MapLibre capabilities; importing this module never loads a renderer. */
+type TileflowNauticalLightsMap = {
+    getContainer(): HTMLElement;
+    getLayer(id: string): {
+        maxzoom?: number;
+        minzoom?: number;
+    } | undefined;
+    getLayoutProperty(id: string, name: 'visibility'): unknown;
+    getSource(id: string): unknown;
+    getStyle(): {
+        metadata?: unknown;
+    } | undefined;
+    getZoom(): number;
+    off(event: TileflowNauticalLightsEvent, listener: (event?: {
+        sourceId?: unknown;
+    }) => void): unknown;
+    on(event: TileflowNauticalLightsEvent, listener: (event?: {
+        sourceId?: unknown;
+    }) => void): unknown;
+    queryRenderedFeatures(options: {
+        layers: string[];
+    }): readonly {
+        id?: unknown;
+        properties?: Record<string, unknown> | null;
+    }[];
+    removeFeatureState(target: FeatureTarget, key?: string): unknown;
+    setFeatureState(target: FeatureTarget, state: Record<string, number>): unknown;
+};
+/**
+ * Flash the Nautical lights of a compiled style in their rhythms. The style's
+ * `tileflow:nautical-lights` metadata names the light layers; for each light drawn in them, the
+ * helper derives its rhythm (`tileflowLightRhythm`) and writes the light's intensity and colour as
+ * MapLibre feature state whenever its phase changes. Lights that are in the same phase change
+ * together, and the helper wakes only for the next change.
+ *
+ * Nothing is written, and no timer runs, while the page is hidden, while no light layer is
+ * visible at the current zoom, or when no drawn light has a rhythm. When the person viewing the
+ * map prefers reduced motion, or on disposal or map `remove`, every light returns to steady.
+ * Lights are identified by the feature ID their source promotes; the compiled Nautical source
+ * promotes each light's unique `provenance`. A light without an ID stays steady.
+ */
+declare function attachTileflowNauticalLights(map: TileflowNauticalLightsMap): () => void;
+
+/** Style metadata key that names the layers whose Nautical lights flash in their rhythm. */
+declare const tileflowNauticalLightsMetadataKey: "tileflow:nautical-lights";
+/**
+ * MapLibre feature-state keys the light layers read. A runtime writes them per light feature; a
+ * light without them shows steadily, exactly as a map that is not animated.
+ */
+declare const tileflowNauticalLightStates: Readonly<{
+    /** Index of the colour shown, into the light's comma-separated `color` list. */
+    colour: "tileflowLightColour";
+    /** `1` while the light shines, `0` while it is eclipsed, in between for a fixed part. */
+    intensity: "tileflowLightIntensity";
+}>;
+/** The light layers of a compiled style and the source features they draw. */
+type TileflowNauticalLights = Readonly<{
+    layers: readonly string[];
+    source: string;
+    sourceLayer: string;
+    version: 1;
+}>;
+/** Read the bounded light declaration of style metadata; a malformed one is ignored. */
+declare function readTileflowNauticalLights(metadata: unknown): TileflowNauticalLights | undefined;
+
+/** One phase of a light's cycle. */
+type TileflowLightPhase = Readonly<{
+    /** Index of the colour shown, into the light's comma-separated `color` list. */
+    colour: number;
+    /** Seconds, with millisecond precision. */
+    duration: number;
+    /**
+     * `1` while the light shines, `0` while it is eclipsed, and
+     * `tileflowLightRhythmConventions.fixedIntensity` for the steady part of a fixed-and-flashing light.
+     */
+    intensity: number;
+}>;
+/** A light's repeating cycle. Lights with the same `key` flash identically. */
+type TileflowLightRhythm = Readonly<{
+    /** A canonical description of the phases; equal rhythms have equal keys. */
+    key: string;
+    /** Seconds, the sum of the phase durations. */
+    period: number;
+    phases: readonly TileflowLightPhase[];
+}>;
+/** What the light shows at a moment, and for how many more seconds. */
+type TileflowLightState = Readonly<{
+    colour: number;
+    intensity: number;
+    /** Seconds until the next phase begins; always positive. */
+    remaining: number;
+}>;
+/** The `nautical-v1` light fields that define a rhythm; other properties are ignored. */
+type TileflowLightCharacteristic = Readonly<{
+    character?: unknown;
+    color?: unknown;
+    group?: unknown;
+    period_s?: unknown;
+    sequence?: unknown;
+}>;
+/**
+ * The conventions used when a light publishes no `sequence`. Durations are in seconds.
+ *
+ * - `Fl`: flashes of `min(flash, flashShare × period / flashes)`. Flashes of one group are
+ *   separated by an eclipse of at most twice the flash, groups of a composite group such as
+ *   `2+1` by twice that eclipse, and the remainder of the period is the final eclipse.
+ * - `LFl`: the same layout with flashes of `longFlash`, or `flashShare × period / flashes` when
+ *   the period is too short for them.
+ * - `Q`, `VQ`, `UQ`: one flash per `quickCycle` (60, 120 and 240 per minute), lit for
+ *   `quickDuty` of each cycle. Without a group they flash continuously; with a group of `n` they
+ *   flash `n` times, then stay eclipsed until the period ends.
+ * - `IQ`, `IVQ`, `IUQ`: quick flashes for `interruptedShare` of the period, then an eclipse.
+ * - `Iso`: light and eclipse of equal length.
+ * - `Oc`: eclipses of `occultingShare × period / eclipses`, laid out like `Fl` with light and
+ *   eclipse exchanged, so the light is always longer than the eclipse.
+ * - `Mo`: the Morse letters of `group`, with dots of `morseUnit` (shortened to fit the
+ *   period), dashes of three units, one unit between signals and three between letters; the
+ *   remainder of the period, or seven units without one, is the eclipse.
+ * - `FFl`: a fixed light at `fixedIntensity` with full-intensity flashes laid out like `Fl`;
+ *   `F+LFl` does the same with long flashes.
+ * - `Q+LFl`, `VQ+LFl`, `UQ+LFl`, `Fl+LFl`: the group of the first part (six quick flashes when
+ *   absent), then one long flash, then the eclipse.
+ * - `Oc+Fl`: drawn as its occulting part.
+ * - `Al.<character>`: the rhythm of that character, each lit phase taking the next colour of
+ *   `color`; `Al` alone shows each colour for an equal share of the period.
+ * - Grouped `Q`/`VQ` and `Q+LFl`/`VQ+LFl` without a period use the cardinal-mark periods of
+ *   `cardinalPeriods`.
+ *
+ * `F`, an absent or unknown character, a missing period where one is needed, or a layout that
+ * does not fit its period leaves the light steady.
+ */
+declare const tileflowLightRhythmConventions: Readonly<{
+    cardinalPeriods: Readonly<{
+        Q: Readonly<{
+            3: 10;
+            6: 15;
+            9: 15;
+        }>;
+        'Q+LFl': 15;
+        VQ: Readonly<{
+            3: 5;
+            6: 10;
+            9: 10;
+        }>;
+        'VQ+LFl': 10;
+    }>;
+    fixedIntensity: 0.5;
+    flash: 1;
+    flashShare: 0.3;
+    interruptedShare: 0.6;
+    longFlash: 2;
+    morseUnit: 0.5;
+    occultingShare: 0.25;
+    quickCycle: Readonly<{
+        Q: 1;
+        UQ: 0.25;
+        VQ: 0.5;
+    }>;
+    quickDuty: 0.3;
+}>;
+/**
+ * The rhythm of one light, or `undefined` when it shows steadily: a fixed light, or one without a
+ * usable characteristic. `sequence` wins when it is well formed; otherwise the rhythm follows
+ * `tileflowLightRhythmConventions`.
+ */
+declare function tileflowLightRhythm(light: TileflowLightCharacteristic): TileflowLightRhythm | undefined;
+/** What `rhythm` shows `seconds` after the shared epoch of every rhythm. */
+declare function tileflowLightStateAt(rhythm: TileflowLightRhythm, seconds: number): TileflowLightState;
+
 declare const tileflowMaplibreContourVersion: "0.1.0";
 type TileflowContourProtocolRequest = Readonly<{
     url: string;
@@ -1873,4 +2202,4 @@ declare function createTileflowTransformRequest<TRequest extends TileflowTransfo
     worldRequestBridge?: TileflowWorldRequestBridge;
 }): TileflowTransformRequest<TRequest, TResourceType>;
 
-export { type AttachTileflowMap3DOptions, type CreateBoundaryFeatureStateOptions, type TileflowAtmosphereMap, type TileflowBoundaryFeatureState, type TileflowBrowserThemeBlendSelection, type TileflowBuildingMesh, type TileflowBuildingMeshOptions, type TileflowBuildingModelPlacement, type TileflowBuildings3DDesign, type TileflowComposedRequest, type TileflowContourProtocolHandler, type TileflowContourProtocolRegistrationOptions, type TileflowContourProtocolRegistry, type TileflowContourProtocolRequest, type TileflowContourProtocolResponse, type TileflowDepthMarker, type TileflowDepthMarkerHandle, type TileflowDepthMarkerMap, type TileflowDepthMarkers, type TileflowDepthMarkersOptions, type TileflowDynamicImage, type TileflowDynamicImageContext, type TileflowDynamicImageHandle, type TileflowEmphasis, type TileflowEmphasisArea, type TileflowEmphasisModule, type TileflowFairUseNotice, type TileflowFairUseNoticeController, type TileflowFairUseNoticeState, type TileflowFeatureStateMap, type TileflowFrameScheduler, type TileflowGroundLayer, type TileflowGroundLayers, type TileflowGroundLayersMap, type TileflowGroundLayersOptions, type TileflowGroundOrderMap, type TileflowLineProgressAnimation, type TileflowLineProgressController, type TileflowLineProgressGradientOptions, type TileflowLineProgressLayer, type TileflowLineProgressMap, type TileflowLineProgressOptions, type TileflowLineProgressShown, type TileflowLineProgressState, TileflowMap3D, type TileflowMap3DAttachment, type TileflowMap3DLoader, TileflowMap3DOptions, type TileflowMap3DSource, type TileflowMapLifecycleAttachment, type TileflowMapLifecycleEvent, type TileflowMapLifecycleSubscriber, type TileflowMapNotice, type TileflowMapReadinessState, type TileflowNoticeControl, type TileflowNoticeControlPosition, type TileflowNoticesMap, type TileflowNoticesOptions, type TileflowPmtilesProtocolHandler, type TileflowPmtilesProtocolRegistrationOptions, type TileflowPmtilesProtocolRegistry, type TileflowRouteInks, type TileflowSessionSender, type TileflowSessionStarter, type TileflowShotCamera, type TileflowShotCue, type TileflowShotKeyframe, type TileflowShotMotion, type TileflowShotPlayback, type TileflowShotPlaybackOptions, type TileflowShotPlayerMap, type TileflowShotState, type TileflowStreetLightEstimate, type TileflowStreetLightLayers, type TileflowStreetLightPlacement, type TileflowStreetLightPlacementOptions, type TileflowStreetLightsDesign, type TileflowStyleFontLoadOptions, type TileflowStyleStateValue, type TileflowStyleSwitchMap, TileflowSun, type TileflowSunRequest, type TileflowThemeBlendRequest, type TileflowThemeBlendState, type TileflowThemeChangeOptions, type TileflowThemeController, type TileflowThemeTransition, type TileflowThemeTransitionOptions, type TileflowThemeTransitionPhase, type TileflowThemeTransitionResult, TileflowTileLayer, type TileflowTransformRequest, type TileflowTransformRequestParameters, type TileflowUserTransformRequest, TileflowViewMode, type TileflowWorldProtocolHandler, type TileflowWorldProtocolRequest, type TileflowWorldProtocolResponse, type TileflowWorldRequestBridge, attachTileflowAtmosphere, attachTileflowFairUseNotice, attachTileflowMap3D, attachTileflowMapLifecycle, attachTileflowNotices, createBoundaryFeatureState, createTileflowDepthMarkers, createTileflowGroundLayers, createTileflowLineProgress, createTileflowSessionStarter, createTileflowThemeController, createTileflowTransformRequest, getTileflowSystemColorScheme, loadTileflowStyleFonts, meshTileflowBuildings, mixTileflowRouteInks, placeTileflowStreetLights, playTileflowShot, readTileflowBuildings3D, readTileflowNotices, readTileflowRouteInks, readTileflowStreetLights, readTileflowTeamModelName, registerTileflowContourProtocol, registerTileflowPmtilesProtocol, registerTileflowWorldRequestBridge, subscribeTileflowSystemColorScheme, tileflowBuildingExtent, tileflowBuildingModelPlacementLimit, tileflowBuildingVertexBytes, tileflowBuildingsMetadataKey, tileflowDefaultRouteInks, tileflowDepthMarkerPlacement, tileflowFairUseNoticeMessage, tileflowGroundBeforeId, tileflowLayerDomainMetadataKey, tileflowLineProgressGradient, tileflowMap3DDeclarations, tileflowMap3DMetadataKeys, tileflowMapDeclares3D, tileflowMaplibreContourVersion, tileflowNoticeLimits, tileflowNoticesMetadataKey, tileflowPmtilesMaximumDirectoryDepth, tileflowPmtilesProtocol, tileflowRouteMetadataKey, tileflowShotStateAt, tileflowStreetLightBytes, tileflowStreetLightsMetadataKey, tileflowStyleRouteInks, tileflowSunLightMatrix, tileflowTeamModelUrl, validateTileflowBrowserThemeBlendSelection, validateTileflowEmphasis };
+export { type AttachTileflowMap3DOptions, type CreateBoundaryFeatureStateOptions, type TileflowAtmosphereMap, type TileflowBoundaryFeatureState, type TileflowBrowserThemeBlendSelection, type TileflowBuildingMesh, type TileflowBuildingMeshOptions, type TileflowBuildingModelPlacement, type TileflowBuildings3DDesign, type TileflowComposedRequest, type TileflowContourProtocolHandler, type TileflowContourProtocolRegistrationOptions, type TileflowContourProtocolRegistry, type TileflowContourProtocolRequest, type TileflowContourProtocolResponse, type TileflowDepthMarker, type TileflowDepthMarkerHandle, type TileflowDepthMarkerMap, type TileflowDepthMarkers, type TileflowDepthMarkersOptions, type TileflowDynamicImage, type TileflowDynamicImageContext, type TileflowDynamicImageHandle, type TileflowEmphasis, type TileflowEmphasisArea, type TileflowEmphasisModule, type TileflowFairUseNotice, type TileflowFairUseNoticeController, type TileflowFairUseNoticeState, type TileflowFeatureStateMap, type TileflowFrameScheduler, type TileflowGroundLayer, type TileflowGroundLayers, type TileflowGroundLayersMap, type TileflowGroundLayersOptions, type TileflowGroundOrderMap, type TileflowLightCharacteristic, type TileflowLightPhase, type TileflowLightRhythm, type TileflowLightState, type TileflowLineProgressAnimation, type TileflowLineProgressController, type TileflowLineProgressGradientOptions, type TileflowLineProgressLayer, type TileflowLineProgressMap, type TileflowLineProgressOptions, type TileflowLineProgressShown, type TileflowLineProgressState, TileflowMap3D, type TileflowMap3DAttachment, type TileflowMap3DLoader, TileflowMap3DOptions, type TileflowMap3DSource, type TileflowMapLifecycleAttachment, type TileflowMapLifecycleEvent, type TileflowMapLifecycleSubscriber, type TileflowMapNotice, type TileflowMapReadinessState, type TileflowNauticalLights, type TileflowNauticalLightsMap, type TileflowNoticeControl, type TileflowNoticeControlPosition, type TileflowNoticesMap, type TileflowNoticesOptions, type TileflowPmtilesProtocolHandler, type TileflowPmtilesProtocolRegistrationOptions, type TileflowPmtilesProtocolRegistry, type TileflowRouteInks, type TileflowSessionSender, type TileflowSessionStarter, type TileflowShotCamera, type TileflowShotCue, type TileflowShotKeyframe, type TileflowShotMotion, type TileflowShotPlayback, type TileflowShotPlaybackOptions, type TileflowShotPlayerMap, type TileflowShotState, type TileflowSkyColours, type TileflowSkyHazeMap, type TileflowSkyMap, type TileflowSkyMetadata, type TileflowSkyTimesOfDay, type TileflowStreetLightEstimate, type TileflowStreetLightLayers, type TileflowStreetLightPlacement, type TileflowStreetLightPlacementOptions, type TileflowStreetLightsDesign, type TileflowStyleFontLoadOptions, type TileflowStyleStateValue, type TileflowStyleSwitchMap, TileflowSun, type TileflowSunRequest, type TileflowThemeBlendRequest, type TileflowThemeBlendState, type TileflowThemeChangeOptions, type TileflowThemeController, type TileflowThemeTransition, type TileflowThemeTransitionOptions, type TileflowThemeTransitionPhase, type TileflowThemeTransitionResult, TileflowTileLayer, type TileflowTransformRequest, type TileflowTransformRequestParameters, type TileflowUserTransformRequest, TileflowViewMode, type TileflowWorldProtocolHandler, type TileflowWorldProtocolRequest, type TileflowWorldProtocolResponse, type TileflowWorldRequestBridge, attachTileflowAtmosphere, attachTileflowFairUseNotice, attachTileflowMap3D, attachTileflowMapLifecycle, attachTileflowNauticalLights, attachTileflowNotices, attachTileflowSky, attachTileflowSkyHaze, createBoundaryFeatureState, createTileflowDepthMarkers, createTileflowGroundLayers, createTileflowLineProgress, createTileflowSessionStarter, createTileflowThemeController, createTileflowTransformRequest, getTileflowSystemColorScheme, loadTileflowStyleFonts, meshTileflowBuildings, mixTileflowRouteInks, placeTileflowStreetLights, playTileflowShot, readTileflowBuildings3D, readTileflowNauticalLights, readTileflowNotices, readTileflowRouteInks, readTileflowSky, readTileflowStreetLights, readTileflowTeamModelName, registerTileflowContourProtocol, registerTileflowPmtilesProtocol, registerTileflowWorldRequestBridge, subscribeTileflowSystemColorScheme, tileflowBuildingExtent, tileflowBuildingModelPlacementLimit, tileflowBuildingVertexBytes, tileflowBuildingsMetadataKey, tileflowCanvasContextAttributes, tileflowDefaultRouteInks, tileflowDepthMarkerPlacement, tileflowFairUseNoticeMessage, tileflowGroundBeforeId, tileflowLayerDomainMetadataKey, tileflowLightRhythm, tileflowLightRhythmConventions, tileflowLightStateAt, tileflowLineProgressGradient, tileflowMap3DDeclarations, tileflowMap3DMetadataKeys, tileflowMapDeclares3D, tileflowMaplibreContourVersion, tileflowMaxPitch, tileflowNauticalLightStates, tileflowNauticalLightsMetadataKey, tileflowNoticeLimits, tileflowNoticesMetadataKey, tileflowPmtilesMaximumDirectoryDepth, tileflowPmtilesProtocol, tileflowRouteMetadataKey, tileflowShotStateAt, tileflowSkyAtSun, tileflowSkyHazeLayerId, tileflowSkyLayerId, tileflowSkyMetadataKey, tileflowStreetLightBytes, tileflowStreetLightsMetadataKey, tileflowStyleRouteInks, tileflowSunLightMatrix, tileflowTeamModelUrl, validateTileflowBrowserThemeBlendSelection, validateTileflowEmphasis };