@tileflow/core 0.1.0-alpha.34 → 0.1.0-alpha.35

package/README.md

@@ -60,7 +60,7 @@ Omitted fields inherit, but declaring a field does not imply a recursive merge:
 - `modules` merges by domain. Declaring `roads(...)` replaces that domain's inherited request and
   render contributions. Use `refine(...)` to patch it, `disable()` to remove it, and `reset()` for
   an explicit reset inside a supported patch.
-- `themes` replaces the complete collection and clears an inherited `systemThemes` mapping.
+- `themes` replaces the complete collection and clears inherited `systemThemes` and `timeOfDay` mappings.
   `defaultTheme` can select an inherited concrete theme; `systemThemes` replaces its complete mapping.
 - `icons` replaces the ordered contributor list. Omission inherits it; `[]` disables it. Local and
   package directories can be combined with explicit locked `iconSet('@team/set')` descriptors.
@@ -141,7 +141,7 @@ receipts must use a concrete theme such as `light` or `dark`.
 
 Because every theme of a map shares one structure, a browser map can cross-fade between themes or
 show a continuous blend of them on the same MapLibre instance, with no extra requests. See
-[theme transitions and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md).
+[theme transitions, time-of-day presets and blends](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/theme-transitions-and-blends.md).
 The same controller can make chosen modules recede and the map's labels fade so an application's
 own content reads first; see [map emphasis](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/map-emphasis.md).
 It also sets the style-wide states that themes read with `expr.globalState`, easing numbers so the
@@ -158,15 +158,15 @@ A theme can describe its sun and sky light (`lighting.sun`, `lighting.ambient`);
 returns the sun the map shows with `getSun()`, mixed during a blend, for an application's own 3D
 layers, and `setSun()` places it by direction or by the real sun of a date and place; see
 [sun and light](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/sun-and-light.md).
-`createTileflowBuildings3D` raises the map's buildings round the camera and lights them from that
-sun, with shadows on the buildings and the flat map, contact shadow and night light from the places
-they hold; it shows, hides and grows them without laying out any source; see
+`createTileflowBuildings3D` raises the map's buildings with their authored colours and native
+extrusion lighting. Height changes are immediate by default; scene sun lighting, shadows,
+illuminated edges, colour variation, night lights and animation are explicit options; see
 [3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/buildings-3d.md).
 `createTileflowStreetLights` lights the streets as the sun sets, from the lamps and lit streets the
 map's data holds; see
 [street lights](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/street-lights.md).
-`createTileflowTrees3D` stands the map's trees in 3D in the same light; see
-[3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md).
+`createTileflowVegetation` controls all trees using the map's `3d`, `flat` or `auto` policy; see
+[vegetation controls and 3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/docs/trees-3d.md).
 
 The semantic domains are `land`, `water`, `nautical`, `roads`, `buildings`, `boundaries`, `labels`,
 `poi`, `aeroways`, `transit`, `vegetation`, `addresses`, and `landforms`. Style stable geographic
@@ -238,10 +238,12 @@ package uses this contract for its mounted Map; it is not yet published.
 
 ## Data, terrain, and browser resources
 
-Tileflow World is the hosted primary-data path. `vectorTiles()` with `openMapTiles()` supports
-compatible externally supplied vector data for local/self-hosted use; it does not make that source
-eligible for hosted deployment. `hostedTileset()` and semantic overlay placement add named data
-sources. Local PMTiles inputs are for local tooling, not implicit production data publication.
+Tileflow World is the hosted primary source. `vectorTiles()` with `openMapTiles()` supports
+external local/self-hosted data; hosted eligibility is separate. `hostedTileset()` and semantic
+overlays add named sources. Local PMTiles inputs are tooling-only.
+
+`bathymetry({vectorLayers: {...}})` declares compatible contour/name layers; omission retains
+legacy band geometry.
 
 World attribution links to Tileflow's source notice, OpenMapTiles, and OpenStreetMap. External
 vector data retains the attribution supplied by its owner.

package/THIRD_PARTY_NOTICES.md

@@ -1,7 +1,9 @@
 # Third-party notices
 
-`@tileflow/core/browser` embeds `maplibre-contour` 0.1.0, `PMTiles` 4.4.0, `fflate` 0.8.3, and
-`earcut` 3.2.4 so contour, local archive, and 3D building rendering remain self-contained. The complete upstream licenses follow.
+`@tileflow/core/browser` embeds `maplibre-contour` 0.1.0, `PMTiles` 4.5.0, `fflate` 0.8.3, and
+`earcut` 3.2.4 so contour, local archive, and 3D building rendering remain self-contained.
+`@tileflow/core` and `@tileflow/core/browser` embed the decoder of `meshoptimizer` 1.3.0, loaded
+only to read a compressed 3D model file. The complete upstream licenses follow.
 
 ## maplibre-contour 0.1.0
 
@@ -168,7 +170,7 @@ See <https://github.com/nodejs/node/blob/main/LICENSE> for more information.
 
 ---
 
-## PMTiles 4.4.0
+## PMTiles 4.5.0
 
 The below license (BSD-3) applies to the reference implementations in this repository.
 
@@ -249,6 +251,32 @@ OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWA
 
 ---
 
+## meshoptimizer 1.3.0
+
+MIT License
+
+Copyright (c) 2016-2026 Arseny Kapoulkine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
 ## TypeScript helper code
 
 The bundled browser entry retains TypeScript helper code and its complete upstream notice:
@@ -267,11 +295,11 @@ OF THIS SOFTWARE.
 
 ---
 
-## whatwg-url 15.1.0 and tr46 6.0.0
+## whatwg-url 17.2.0 and tr46 7.0.0
 
 The native entry embeds the low-level `whatwg-url` parser and `tr46` IDNA processing. During the
-native build only, the parser's relative encoding module is replaced by Tileflow's private UTF-8
-codec. No upstream package is patched on disk and no global codec is installed. Both components
+native build only, the parser's encoding and query-encoding imports use Tileflow's private UTF-8
+codec; the legacy encoding bootstrap is replaced by that side-effect-free module. No upstream package is patched on disk and no global codec is installed. Both components
 are MIT-licensed:
 
 The MIT License (MIT)
@@ -348,3 +376,69 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+---
+
+## MapLibre GL JS 6.13.0 extrusion lighting
+
+The style-lighting shader in `buildings-3d-shaders.ts` adapts the native fill-extrusion
+lighting equations. The applicable upstream notices follow.
+
+Copyright (c) 2023, MapLibre contributors
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of MapLibre GL JS nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+Contains code from mapbox-gl-js v1.13 and earlier
+
+Version v1.13 of mapbox-gl-js and earlier are licensed under a BSD-3-Clause license
+
+Copyright (c) 2020, Mapbox
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of Mapbox GL JS nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/browser.d.ts

@@ -509,21 +509,50 @@ declare const tileflowPoiCategories: readonly ["arts-entertainment", "education"
 type TileflowPoiCategory = (typeof tileflowPoiCategories)[number];
 type TileflowPoiDensity = 1 | 2 | 3 | 4 | 5;
 type TileflowPoiColorMode = 'uniform' | 'category';
-type TileflowPoiCategoryStyle = Omit<TileflowMarkerSymbolStyle, 'priority'> & {
-    /** Optional category-local cap within the module's canonical density tiers. */
-    density?: TileflowPoiDensity;
-};
+/**
+ * How POI categories are placed against each other. `importance` places every category in one
+ * order, by World's ranks. `categories` gives each category its own layer and places the
+ * categories in the order they are listed, the first on top; ranks order each category only.
+ */
+type TileflowPoiPlacementOrder = 'categories' | 'importance';
+/**
+ * The appearance of one POI category. With the default `importance` order every category shares
+ * one placement layer, so categories may differ only in properties MapLibre evaluates per feature
+ * (image, size, colors, font, offsets); layer-wide properties such as zoom ranges, padding,
+ * overlap or `optional` must match, or the module uses `placement.order: 'categories'`.
+ */
+type TileflowPoiCategoryStyle = Omit<TileflowMarkerSymbolStyle, 'priority'>;
 type TileflowPoiModuleConfig = {
     type: 'poi';
     categories?: readonly TileflowPoiCategory[];
     color?: TileflowPoiColorMode;
+    /** One density for the whole module: World's ranks decide what each category shows. */
     density?: TileflowPoiDensity;
     icons?: boolean;
     labels?: boolean;
     minZoom?: number;
     placement?: {
+        /**
+         * Places each pictogram with its name as one unit that needs room for both. Defaults to
+         * `false`.
+         */
         coupleIconAndLabel?: boolean;
         iconPadding?: number;
+        /**
+         * World POI `type` values whose pictogram explains them. When pictograms and names are both
+         * drawn, every other POI needs a name, and these types are drawn as a pictogram alone.
+         * Defaults to parking and public toilets.
+         */
+        iconOnlyTypes?: readonly string[];
+        /** Defaults to `importance`. */
+        order?: TileflowPoiPlacementOrder;
+        /**
+         * With the `importance` order, POIs whose World `filter_rank` is at most this value are placed
+         * before the map's road and place labels, and the others after them. A map that gives street
+         * names priority over POIs (labels `collisionPriority: 'navigation'`) keeps its landmarks this
+         * way. Unset, every POI is placed at the module's own position.
+         */
+        prominentRank?: 0 | 1 | 2 | 3 | 4 | 5;
         textPadding?: number;
     };
     styles?: Partial<Record<TileflowPoiCategory, TileflowPoiCategoryStyle>>;
@@ -765,18 +794,57 @@ type TileflowBuildingMode = '3d' | 'flat';
  * building colour (its extrusion), else its roofs'.
  */
 type TileflowBuildingsThreeDimensionalStyle = {
-    /** How strongly roof outlines and outer corners catch the light, from 0 (none) to 1, the default. */
+    /** Use the style's extrusion light (default), or the theme controller's scene sun. */
+    lighting?: 'style' | 'sun';
+    /** Per-building brightness variation, from 0 to 1; defaults to 0 (authored colour). */
+    colorVariation?: TileflowThemeNumberValue;
+    /** How strongly roof outlines and outer corners catch the light, from 0 (default) to 1. */
     edges?: TileflowThemeNumberValue;
     /** Their own colour, drawn unlit; without it they take the building's colour, lightened. */
     edgeColor?: TileflowThemeColorValue;
-    /** How bright the buildings light the street at night, from 0 (none) to 2; defaults to 1. */
+    /** How bright the buildings light the street at night, from 0 (none) to 2; defaults to 0. */
     nightLight?: TileflowThemeNumberValue;
-    /** Contact shadow at the foot of the walls and in tight corners; defaults to true. */
+    /** Contact shadow at the foot of the walls and in tight corners; defaults to false. */
     occlusion?: boolean;
-    /** Shadows from the sun, on the buildings and the flat map; defaults to true. */
+    /** Shadows from the sun, on the buildings and the flat map; defaults to false. */
     shadows?: boolean;
-    /** Invented night windows, lit by rooms: decoration, not data. Defaults to false. */
+    /**
+     * Invented night windows, lit by rooms: decoration, not data. With World's `class`, none on sheds,
+     * barns, factories and churches, and homes lit apart from offices. Defaults to false.
+     */
     windows?: boolean;
+    /**
+     * Building models the map places in its city, from the glTF binaries in its `models`
+     * directories. Each stands in for the buildings under its footprint.
+     */
+    models?: readonly TileflowBuildingModelPlacementConfig[];
+    /** The colours of the models' parts; a part without one takes it from the building colour. */
+    modelColors?: Partial<Record<TileflowBuildingModelPart, TileflowThemeColorValue>>;
+    /**
+     * Tileflow's landmarks, such as the Eiffel Tower, drawn as models in place of the buildings
+     * under them. On by default with Tileflow World data; `false` switches them off, and `url` names
+     * the TileJSON of another landmarks tileset. The map's own `models` come first: a landmark with
+     * the same id as one, or whose footprint meets one's, is not drawn.
+     */
+    landmarks?: boolean | {
+        url: string;
+    };
+};
+/** The parts of a building model, as its materials name them. */
+type TileflowBuildingModelPart = 'surface' | 'secondary' | 'glass' | 'accent' | 'roof';
+/** Where a building model stands. */
+type TileflowBuildingModelPlacementConfig = {
+    /** The model's id: the name of its `.glb` file in the map's `models` directories. */
+    model: string;
+    /**
+     * The HTTPS address of the model's prepared file when it is served elsewhere, such as a model
+     * Tileflow hosts for its own maps; the map then needs no `.glb` of its own for it.
+     */
+    url?: string;
+    /** Longitude and latitude of the model's origin, where it stands on the ground. */
+    at: readonly [number, number];
+    /** Degrees clockwise from north that the model's own north (its +y) is turned to; defaults to 0. */
+    heading?: number;
 };
 type TileflowBuildingsModuleOptions = {
     businessCorridor?: TileflowAreaStyle;
@@ -1026,7 +1094,7 @@ type TileflowVegetation3D = Readonly<{
  */
 declare function readTileflowVegetation3D(metadata: unknown): TileflowVegetation3D | undefined;
 
-type TileflowVegetationMode = '3d' | 'flat';
+type TileflowVegetationMode = '3d' | 'flat' | 'auto';
 type TileflowVegetationThreeDimensionalStyle = {
     barkColor?: TileflowThemeColorValue;
     /** Sunlit leaf colours of broadleaf trees, from darkest to lightest; up to four are used. */
@@ -1074,7 +1142,12 @@ type TileflowVegetationThreeDimensionalStyle = {
 };
 type TileflowVegetationModuleOptions = {
     flat?: TileflowCircleStyle;
+    /** `3d` uses models at every pitch; `auto` follows the runtime's explicit 2D/3D view mode. */
     mode?: TileflowVegetationMode;
+    /** Representation when a renderer cannot draw models. Defaults to `flat`. */
+    fallback?: 'flat' | 'none';
+    /** Initial visibility; a runtime control may override it. Defaults to true. */
+    visible?: boolean;
     threeDimensional?: TileflowVegetationThreeDimensionalStyle;
 };
 type TileflowVegetationModuleConfig = TileflowVegetationModuleOptions & {
@@ -1084,10 +1157,14 @@ type TileflowVegetationModuleConfig = TileflowVegetationModuleOptions & {
 type TileflowWaterwayClass = 'canal' | 'other' | 'river' | 'stream';
 type TileflowWaterModuleOptions = {
     bathymetry?: TileflowFillStyle;
-    /** Opt-in approximate contours traced from discrete bathymetry polygon band edges. */
+    /** Contour lines when declared by Bathymetry; otherwise approximate polygon band edges. */
     bathymetryContours?: TileflowLineStyle;
-    /** Opt-in labels for bathymetry polygon band floors, not measured survey soundings. */
+    /** Contour-depth or legacy band-floor labels, not measured survey soundings. */
     bathymetryLabels?: TileflowSymbolStyle;
+    /** Names from an explicitly declared seafloor_landform layer. */
+    bathymetryLandforms?: TileflowSymbolStyle;
+    /** Names from an explicitly declared water_name layer. */
+    bathymetryWaterNames?: TileflowSymbolStyle;
     bodies?: TileflowAreaStyle;
     intermittent?: {
         bodies?: TileflowAreaStyle;
@@ -1310,6 +1387,21 @@ type TileflowLineProgressController = {
  */
 declare function createTileflowLineProgress(map: TileflowLineProgressMap, options: TileflowLineProgressOptions): TileflowLineProgressController;
 
+/** Bounded, read-only mesh snapshot for developer tooling. Positions are x east, y north, z up. */
+type TileflowModelInspection = Readonly<{
+    id: string;
+    module: string;
+    format: string;
+    vertices: number;
+    triangles: number;
+    bytes: number;
+    lods: number;
+    instances?: number;
+    positions: number[];
+    indices: number[];
+    colors?: string[];
+}>;
+
 type TileflowTileAddress = Readonly<{
     z: number;
     x: number;
@@ -1320,7 +1412,11 @@ type TileflowTile = TileflowTileAddress & Readonly<{
     layers: Readonly<Record<string, TileflowTileLayer>>;
 }>;
 /** Rewrites a tile request as a MapLibre map's `transformRequest` does. */
-type TileflowTileRequestTransform = (url: string, resourceType: 'Tile') => Readonly<{
+type TileflowTileRequestTransform = (url: string, resourceType: 'Tile') => Promise<Readonly<{
+    url: string;
+    headers?: Readonly<Record<string, string>>;
+    credentials?: RequestCredentials;
+}> | undefined> | Readonly<{
     url: string;
     headers?: Readonly<Record<string, string>>;
     credentials?: RequestCredentials;
@@ -1411,6 +1507,7 @@ type TileflowBuildings3DMap = {
         lng: number;
     };
     getBearing(): number;
+    getLight?(): unknown;
     getLayer(id: string): unknown;
     getPaintProperty(layer: string, name: string): unknown;
     getPitch(): number;
@@ -1447,26 +1544,31 @@ type TileflowBuildings3DOptions = Readonly<{
 type TileflowBuildings3DChange = Readonly<{
     transition?: Readonly<{
         duration?: number;
+        mode?: 'grow' | 'fade';
     }>;
 }>;
 type TileflowBuildings3D = {
-    /** Raises the buildings out of the ground; resolves once they stand. */
+    /** Read-only, bounded snapshots of resident prepared model meshes. */
+    inspectModels(): TileflowModelInspection[];
+    /** Shows buildings immediately; pass a transition duration to animate their rise. */
     show(options?: TileflowBuildings3DChange): Promise<void>;
-    /** Sinks the buildings back into the flat map; resolves once they are gone. */
+    /** Hides buildings immediately; pass a transition duration to animate their descent. */
     hide(options?: TileflowBuildings3DChange): Promise<void>;
-    /** Eases the buildings to `scale` of their height, from 0 (flat) to 1. */
+    /** Sets the height scale, from 0 (flat) to 1; animation requires a transition duration. */
     grow(scale: number, options?: TileflowBuildings3DChange): Promise<void>;
     /** The height scale shown now. */
     readonly scale: number;
     /**
      * Whether the map's style describes its 3D buildings (the buildings module's
-     * `threeDimensional`), tiles raised, buildings and vertices, for diagnostics.
+     * `threeDimensional`), tiles raised, buildings and vertices, and the placed models standing, for
+     * diagnostics.
      */
     readonly stats: Readonly<{
         declared: boolean;
         tiles: number;
         buildings: number;
         vertices: number;
+        models: number;
     }>;
     /** Takes the layer off the map and lets go of its buffers. */
     dispose(): void;
@@ -1493,6 +1595,12 @@ type TileflowBuildingMeshOptions = Readonly<{
      * the building its use.
      */
     places?: TileflowTileLayer;
+    /**
+     * Footprints of the building models standing here, as rings of tile units (0 to 8192): a
+     * building whose centre falls inside one, or that reaches more than half a metre into one, is not
+     * raised, since the model stands in for it.
+     */
+    masks?: readonly (readonly number[])[];
 }>;
 /** One tile's buildings, ready to upload. */
 type TileflowBuildingMesh = Readonly<{
@@ -1507,12 +1615,13 @@ type TileflowBuildingMesh = Readonly<{
 }>;
 /**
  * Meshes the buildings of one decoded tile layer, or returns undefined when it has none. It reads
- * World's `render_height`, `render_min_height`, `hide_3d`, `building_tone` and `night_use`. Vertex layout:
+ * World's `render_height`, `render_min_height`, `hide_3d`, `building_tone`, `class` and `night_use`.
+ * Vertex layout:
  * 0 position in the tile, 0 to 8192 (uint16 ×2); 4 base and top in decimetres (uint16 ×2); 8 the
  * wall's outward normal (int8 ×2, normalised); 10 raised to the top, part of a wall (uint8 ×2);
  * 12 decimetres along the wall (uint16); 14 a per-building jitter and seed (uint8 ×2, normalised);
- * 16 the building's centre in the tile (uint16 ×2); 20 tone and night use (uint8 ×2: none, dining,
- * entertainment, nightlife); 22 the wall's
+ * 16 the building's centre in the tile (uint16 ×2); 20 tone plus four times its class group, and
+ * night use (uint8 ×2: none, dining, entertainment, nightlife); 22 the wall's
  * tight corners, bit 0 at its start and bit 1 at its end, and bit 2 when it faces a courtyard, and
  * its length in metres up to 255
  * (uint8 ×2); 24 the building's feature index (uint16); 26 on a roof, the vertex's corner of its
@@ -1590,6 +1699,16 @@ declare const tileflowStreetLightsLayerId = "tileflow-street-lights";
  */
 declare function createTileflowStreetLights(options: TileflowStreetLightsOptions): TileflowStreetLights;
 
+/** The parts of a model, each coloured by the theme: the model's materials name them. */
+declare const tileflowModelParts: Readonly<{
+    surface: 0;
+    secondary: 1;
+    glass: 2;
+    accent: 3;
+    roof: 4;
+}>;
+type TileflowModelPart = keyof typeof tileflowModelParts;
+
 /** The style metadata key under which a compiled map describes its 3D buildings. */
 declare const tileflowBuildingsMetadataKey = "tileflow:buildings";
 /** A compiled map's 3D buildings, resolved for one theme. */
@@ -1607,6 +1726,12 @@ type TileflowBuildings3DDesign = Readonly<{
     color: string | readonly unknown[];
     /** How strongly roof outlines and outer corners catch the light, from 0 to 1. */
     edges: number;
+    /** Style extrusion light by default; scene sun lighting is opt-in. */
+    lighting: 'style' | 'sun';
+    /** Per-building brightness variation, from 0 to 1; 0 preserves the authored colour. */
+    colorVariation: number;
+    /** The authored extrusion's vertical wall gradient. */
+    verticalGradient: boolean;
     /** Their own colour, drawn unlit; without it they take the building's colour, lightened. */
     edgeColor?: string;
     /** How bright the buildings light the street at night, from 0 to 2. */
@@ -1616,12 +1741,36 @@ type TileflowBuildings3DDesign = Readonly<{
     /** Shadows from the sun, and contact shadow at the foot of the walls. */
     shadows: boolean;
     occlusion: boolean;
+    /** Building models the map places in its city, each replacing the buildings under it. */
+    models?: readonly TileflowBuildingModelPlacement[];
+    /** The colours of the models' parts; a part without one takes it from the building colour. */
+    modelColors?: Readonly<Partial<Record<TileflowModelPart, string>>>;
+    /**
+     * Tileflow's landmarks, drawn as models in place of the buildings under them: the TileJSON of
+     * their tileset. Without it, the map shows none.
+     */
+    landmarks?: Readonly<{
+        url: string;
+    }>;
+}>;
+/** A building model standing in the map's city. */
+type TileflowBuildingModelPlacement = Readonly<{
+    /** The model's id, its file's name in the map's `models` directories. */
+    model: string;
+    /** Where the prepared model file is served, absolute or relative to the page. */
+    url: string;
+    /** Longitude and latitude of the model's origin, where it stands on the ground. */
+    at: readonly [number, number];
+    /** Degrees clockwise from north that the model's own north is turned to. */
+    heading: number;
 }>;
 /**
  * Reads the 3D buildings a compiled style describes, or undefined when its metadata has none or a
  * version or shape this Core does not know.
  */
 declare function readTileflowBuildings3D(metadata: unknown): TileflowBuildings3DDesign | undefined;
+/** The most models one map places. */
+declare const tileflowBuildingModelPlacementLimit = 256;
 
 /** The MapLibre GL JS map capabilities the trees use. */
 type TileflowTrees3DMap = {
@@ -1666,6 +1815,8 @@ type TileflowTrees3DOptions = Readonly<{
     beforeId?: string;
     /** The map's request rules, for the tiles the layer reads. */
     transformRequest?: TileflowTileRequestTransform;
+    /** Let a vegetation controller own flat-layer visibility. Defaults to true. */
+    manageFlatLayers?: boolean;
 }>;
 type TileflowTrees3DChange = Readonly<{
     transition?: Readonly<{
@@ -1673,6 +1824,8 @@ type TileflowTrees3DChange = Readonly<{
     }>;
 }>;
 type TileflowTrees3D = {
+    /** Read-only snapshots of the meshes used by the active vegetation palette. */
+    inspectModels(): TileflowModelInspection[];
     /** Grows the trees out of the ground; resolves once they stand. */
     show(options?: TileflowTrees3DChange): Promise<void>;
     /** Sinks the trees back into the ground; resolves once they are gone. */
@@ -2042,6 +2195,50 @@ declare const tileflowPmtilesProtocol: "tileflow-pmtiles";
 /** Register only Tileflow's managed PMTiles namespace. Third-party `pmtiles://` remains untouched. */
 declare function registerTileflowPmtilesProtocol(registry: TileflowPmtilesProtocolRegistry, options?: TileflowPmtilesProtocolRegistrationOptions): void;
 
+type TileflowViewMode = '2d' | '3d';
+type TileflowVegetationRepresentation = 'none' | 'flat' | '3d';
+declare const tileflowVegetationDisplayMetadataKey = "tileflow:vegetation-display";
+/** Display policy, separate from the models' design and the camera's pitch. */
+type TileflowVegetationDisplay = Readonly<{
+    version: 1;
+    mode: TileflowVegetationMode;
+    fallback: 'flat' | 'none';
+    visible: boolean;
+    /** Authored visibility before the compiler applies the static fallback. */
+    flatLayers: readonly Readonly<{
+        id: string;
+        visible: boolean;
+    }>[];
+}>;
+declare function readTileflowVegetationDisplay(metadata: unknown): TileflowVegetationDisplay | undefined;
+declare function resolveTileflowVegetationRepresentation(policy: TileflowVegetationDisplay | undefined, options: {
+    visible?: boolean | undefined;
+    viewMode?: TileflowViewMode;
+    supports3D: boolean;
+}): TileflowVegetationRepresentation;
+
+type TileflowVegetationOptions = Omit<TileflowTrees3DOptions, 'manageFlatLayers' | 'map'> & {
+    map: TileflowTrees3DOptions['map'] & {
+        getCanvas?(): HTMLCanvasElement;
+    };
+    /** Overrides the map's visibility. Undefined restores the authored default. */
+    visible?: boolean | undefined;
+    /** Explicit application view mode, independent of pitch and building visibility. Defaults to 2d. */
+    viewMode?: TileflowViewMode;
+};
+type TileflowVegetationController = {
+    inspectModels: TileflowTrees3D['inspectModels'];
+    setVisible(visible: boolean | undefined): void;
+    setViewMode(mode: TileflowViewMode): void;
+    /** Reapplies the policy after application layer controls change. */
+    refresh(): void;
+    readonly representation: TileflowVegetationRepresentation;
+    readonly stats: TileflowTrees3D['stats'] | undefined;
+    dispose(): void;
+};
+/** Mount once per map. OFF hides every representation; mode selects how enabled trees are drawn. */
+declare function createTileflowVegetation(options: TileflowVegetationOptions): TileflowVegetationController;
+
 type TileflowMapReadinessState = 'error' | 'idle' | 'loading';
 /** Read the browser preference without persisting or mutating user state. */
 declare function getTileflowSystemColorScheme(): TileflowRuntimeColorScheme;
@@ -2279,4 +2476,4 @@ declare function createTileflowTransformRequest<TRequest extends TileflowTransfo
     worldRequestBridge?: TileflowWorldRequestBridge;
 }): TileflowTransformRequest<TRequest, TResourceType>;
 
-export { type TileflowAtmosphereMap, type TileflowBrowserThemeBlendSelection, type TileflowBuildingMesh, type TileflowBuildingMeshOptions, type TileflowBuildings3D, type TileflowBuildings3DChange, type TileflowBuildings3DDesign, type TileflowBuildings3DMap, type TileflowBuildings3DOptions, type TileflowBuildings3DThemes, 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 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, type TileflowMapLifecycleAttachment, type TileflowMapLifecycleEvent, type TileflowMapLifecycleSubscriber, type TileflowMapReadinessState, 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 TileflowStreetLights, type TileflowStreetLightsDesign, type TileflowStreetLightsMap, type TileflowStreetLightsOptions, type TileflowStyleFontLoadOptions, type TileflowStyleStateValue, type TileflowStyleSwitchMap, type TileflowSun, type TileflowSunPreset, type TileflowSunRequest, type TileflowThemeBlendRequest, type TileflowThemeBlendState, type TileflowThemeChangeOptions, type TileflowThemeController, type TileflowThemeTransition, type TileflowThemeTransitionOptions, type TileflowThemeTransitionPhase, type TileflowThemeTransitionResult, type TileflowTile, type TileflowTileAddress, type TileflowTileAreaRequest, type TileflowTileFeature, type TileflowTileGeometryType, type TileflowTileLayer, type TileflowTileReader, type TileflowTileReaderOptions, type TileflowTileRequestTransform, type TileflowTileSourceMap, type TileflowTransformRequest, type TileflowTransformRequestParameters, type TileflowTreeFields, type TileflowTreeForm, type TileflowTreeFormMix, type TileflowTreeFormRange, type TileflowTreeLayers, type TileflowTreePlacement, type TileflowTreePlacementOptions, type TileflowTreeRange, type TileflowTreeRegion, type TileflowTrees3D, type TileflowTrees3DChange, type TileflowTrees3DMap, type TileflowTrees3DOptions, type TileflowTrees3DThemes, type TileflowUserTransformRequest, type TileflowVectorTileDecodeOptions, type TileflowVegetation3D, type TileflowWorldProtocolHandler, type TileflowWorldProtocolRequest, type TileflowWorldProtocolResponse, type TileflowWorldRequestBridge, attachTileflowAtmosphere, attachTileflowFairUseNotice, attachTileflowMapLifecycle, createTileflowBuildings3D, createTileflowDepthMarkers, createTileflowGroundLayers, createTileflowLineProgress, createTileflowSessionStarter, createTileflowStreetLights, createTileflowThemeController, createTileflowTileReader, createTileflowTransformRequest, createTileflowTrees3D, decodeTileflowVectorTile, getTileflowSystemColorScheme, loadTileflowStyleFonts, meshTileflowBuildings, mixTileflowRouteInks, mixTileflowSunPresets, placeTileflowStreetLights, placeTileflowTrees, playTileflowShot, readTileflowBuildings3D, readTileflowMapTileSource, readTileflowRouteInks, readTileflowStreetLights, readTileflowSunPreset, readTileflowVegetation3D, registerTileflowContourProtocol, registerTileflowPmtilesProtocol, registerTileflowWorldRequestBridge, resolveTileflowSun, subscribeTileflowSystemColorScheme, tileflowBuildingExtent, tileflowBuildingVertexBytes, tileflowBuildings3DLayerId, tileflowBuildingsMetadataKey, tileflowDefaultRouteInks, tileflowDefaultSunPreset, tileflowDepthMarkerPlacement, tileflowFairUseNoticeMessage, tileflowGroundBeforeId, tileflowLayerDomainMetadataKey, tileflowLineProgressGradient, tileflowMaplibreContourVersion, tileflowPmtilesMaximumDirectoryDepth, tileflowPmtilesProtocol, tileflowRouteMetadataKey, tileflowShotStateAt, tileflowStreetLightBytes, tileflowStreetLightsLayerId, tileflowStreetLightsMetadataKey, tileflowStyleRouteInks, tileflowStyleSunPreset, tileflowSunDirection, tileflowSunLightMatrix, tileflowSunMetadataKey, tileflowSunPosition, tileflowTilePointToLngLat, tileflowTilesForBounds, tileflowTreeBytes, tileflowTreeFormOf, tileflowTreeForms, tileflowTrees3DLayerId, tileflowVegetationMetadataKey, validateTileflowBrowserThemeBlendSelection, validateTileflowEmphasis };
+export { type TileflowAtmosphereMap, type TileflowBrowserThemeBlendSelection, type TileflowBuildingMesh, type TileflowBuildingMeshOptions, type TileflowBuildingModelPlacement, type TileflowBuildings3D, type TileflowBuildings3DChange, type TileflowBuildings3DDesign, type TileflowBuildings3DMap, type TileflowBuildings3DOptions, type TileflowBuildings3DThemes, 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 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, type TileflowMapLifecycleAttachment, type TileflowMapLifecycleEvent, type TileflowMapLifecycleSubscriber, type TileflowMapReadinessState, 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 TileflowStreetLights, type TileflowStreetLightsDesign, type TileflowStreetLightsMap, type TileflowStreetLightsOptions, type TileflowStyleFontLoadOptions, type TileflowStyleStateValue, type TileflowStyleSwitchMap, type TileflowSun, type TileflowSunPreset, type TileflowSunRequest, type TileflowThemeBlendRequest, type TileflowThemeBlendState, type TileflowThemeChangeOptions, type TileflowThemeController, type TileflowThemeTransition, type TileflowThemeTransitionOptions, type TileflowThemeTransitionPhase, type TileflowThemeTransitionResult, type TileflowTile, type TileflowTileAddress, type TileflowTileAreaRequest, type TileflowTileFeature, type TileflowTileGeometryType, type TileflowTileLayer, type TileflowTileReader, type TileflowTileReaderOptions, type TileflowTileRequestTransform, type TileflowTileSourceMap, type TileflowTransformRequest, type TileflowTransformRequestParameters, type TileflowTreeFields, type TileflowTreeForm, type TileflowTreeFormMix, type TileflowTreeFormRange, type TileflowTreeLayers, type TileflowTreePlacement, type TileflowTreePlacementOptions, type TileflowTreeRange, type TileflowTreeRegion, type TileflowTrees3D, type TileflowTrees3DChange, type TileflowTrees3DMap, type TileflowTrees3DOptions, type TileflowTrees3DThemes, type TileflowUserTransformRequest, type TileflowVectorTileDecodeOptions, type TileflowVegetation3D, type TileflowVegetationController, type TileflowVegetationDisplay, type TileflowVegetationOptions, type TileflowVegetationRepresentation, type TileflowViewMode, type TileflowWorldProtocolHandler, type TileflowWorldProtocolRequest, type TileflowWorldProtocolResponse, type TileflowWorldRequestBridge, attachTileflowAtmosphere, attachTileflowFairUseNotice, attachTileflowMapLifecycle, createTileflowBuildings3D, createTileflowDepthMarkers, createTileflowGroundLayers, createTileflowLineProgress, createTileflowSessionStarter, createTileflowStreetLights, createTileflowThemeController, createTileflowTileReader, createTileflowTransformRequest, createTileflowTrees3D, createTileflowVegetation, decodeTileflowVectorTile, getTileflowSystemColorScheme, loadTileflowStyleFonts, meshTileflowBuildings, mixTileflowRouteInks, mixTileflowSunPresets, placeTileflowStreetLights, placeTileflowTrees, playTileflowShot, readTileflowBuildings3D, readTileflowMapTileSource, readTileflowRouteInks, readTileflowStreetLights, readTileflowSunPreset, readTileflowVegetation3D, readTileflowVegetationDisplay, registerTileflowContourProtocol, registerTileflowPmtilesProtocol, registerTileflowWorldRequestBridge, resolveTileflowSun, resolveTileflowVegetationRepresentation, subscribeTileflowSystemColorScheme, tileflowBuildingExtent, tileflowBuildingModelPlacementLimit, tileflowBuildingVertexBytes, tileflowBuildings3DLayerId, tileflowBuildingsMetadataKey, tileflowDefaultRouteInks, tileflowDefaultSunPreset, tileflowDepthMarkerPlacement, tileflowFairUseNoticeMessage, tileflowGroundBeforeId, tileflowLayerDomainMetadataKey, tileflowLineProgressGradient, tileflowMaplibreContourVersion, tileflowPmtilesMaximumDirectoryDepth, tileflowPmtilesProtocol, tileflowRouteMetadataKey, tileflowShotStateAt, tileflowStreetLightBytes, tileflowStreetLightsLayerId, tileflowStreetLightsMetadataKey, tileflowStyleRouteInks, tileflowStyleSunPreset, tileflowSunDirection, tileflowSunLightMatrix, tileflowSunMetadataKey, tileflowSunPosition, tileflowTilePointToLngLat, tileflowTilesForBounds, tileflowTreeBytes, tileflowTreeFormOf, tileflowTreeForms, tileflowTrees3DLayerId, tileflowVegetationDisplayMetadataKey, tileflowVegetationMetadataKey, validateTileflowBrowserThemeBlendSelection, validateTileflowEmphasis };