@tileflow/core 0.1.0-alpha.40 → 0.1.0-alpha.42

package/dist/browser.d.ts

@@ -171,6 +171,8 @@ type TileflowPoiModuleConfig = {
     density?: TileflowPoiDensity;
     /** Category overrides of density, with the same zoom-dependent detail allowance. */
     densityByCategory?: Partial<Record<TileflowPoiCategory, TileflowPoiDensity>>;
+    /** Fixed maximum World filter rank per POI type (0–5), independent of zoom detail. */
+    maxRankByType?: Readonly<Record<string, 0 | 1 | 2 | 3 | 4 | 5>>;
     /** Zoom for the second extra rank of POI detail. Must exceed 16; defaults to 17. */
     detailZoom?: number;
     icons?: boolean;
@@ -412,16 +414,7 @@ type TileflowBuildingSurfaceDesign = {
     cornice?: Required<NonNullable<TileflowBuildingSurfaces['cornice']>>;
 };
 
-/** 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;
-/** Architectural roles control lighting independently of the model's palette slots. */
+/** Architectural roles control lighting independently of the model's parts. */
 declare const tileflowModelLightingRoles: Readonly<{
     unclassified: 0;
     wall: 1;
@@ -445,7 +438,7 @@ type TileflowBuildingsThreeDimensionalStyle = {
     colorVariation?: TileflowThemeNumberValue;
     /** How strongly roof outlines and outer corners catch the light, from 0 (default) to 1. */
     edges?: TileflowThemeNumberValue;
-    /** Radius in metres for softened exterior corners and roof lighting, from 0 to 1; defaults to 0.8. */
+    /** Radius in metres for softened exterior corners and roof lighting, from 0 to 1.5; defaults to 0.8. */
     edgeRadius?: number;
     /** Their own colour, drawn unlit; without it they take the building's colour, lightened. */
     edgeColor?: TileflowThemeColorValue;
@@ -466,7 +459,7 @@ type TileflowBuildingsThreeDimensionalStyle = {
         /** Wall radius as a fraction of building height; defaults to 1/3. */
         wallHeightRatio?: number;
     };
-    /** Per-role physical materials and emission, separate from palette slots and occlusion. */
+    /** Per-role physical materials and emission, separate from model parts and occlusion. */
     modelLighting?: Partial<Record<TileflowModelLightingRole, {
         emissiveStrength?: TileflowThemeNumberValue;
         /** Stable per-model addition to emission, from zero to this amount. */
@@ -485,6 +478,12 @@ type TileflowBuildingsThreeDimensionalStyle = {
         colorMix?: TileflowThemeNumberValue;
         metallic?: TileflowThemeNumberValue;
         roughness?: TileflowThemeNumberValue;
+        /** Normalize matte light to ordinary buildings, or retain physical glTF lighting (default). */
+        shading?: 'physical' | 'map';
+        /** Role multiplier for model ambient occlusion, from zero to one; defaults to one. */
+        ambientOcclusion?: TileflowThemeNumberValue;
+        /** Named-part colour contribution after the role tint, from zero to one; defaults to one. */
+        partColorMix?: TileflowThemeNumberValue;
         /** Independent HSL ranges, seeded by model identity; no window geometry is invented. */
         colorVariation?: {
             hue: readonly [TileflowThemeNumberValue, TileflowThemeNumberValue];
@@ -505,6 +504,8 @@ type TileflowBuildingsThreeDimensionalStyle = {
     };
     /** Contact shadow at the foot of the walls and in tight corners; defaults to true. */
     occlusion?: boolean;
+    /** Ground contact shadow strength, from 0 to 1; defaults to 0.16. Facade shading is independent. */
+    groundOcclusion?: TileflowThemeNumberValue;
     /** Prepared model ambient occlusion strength, from 0 to 1; defaults to 0.75. */
     modelOcclusion?: TileflowThemeNumberValue;
     /** Shadows from the sun, on the buildings and the flat map; defaults to true. */
@@ -521,7 +522,10 @@ type TileflowBuildingsThreeDimensionalStyle = {
      * 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. */
+    /**
+     * The colours of the models' parts, by the names their materials give them, such as `glass` or
+     * `water`. A part the map gives no colour keeps its material's own.
+     */
     modelColors?: Partial<Record<TileflowBuildingModelPart, TileflowThemeColorValue>>;
     /**
      * Tileflow's landmarks, such as the Eiffel Tower, drawn as models in place of the buildings
@@ -533,8 +537,11 @@ type TileflowBuildingsThreeDimensionalStyle = {
         url: string;
     };
 };
-/** The parts of a building model, as its materials name them. */
-type TileflowBuildingModelPart = 'surface' | 'secondary' | 'glass' | 'accent' | 'roof';
+/**
+ * A part of a building model, as its materials name it: lower-case words joined by hyphens or
+ * underscores, such as `surface`, `glass`, `roof` or `water`.
+ */
+type TileflowBuildingModelPart = string;
 /** Where a building model stands. */
 type TileflowBuildingModelPlacementConfig = {
     /** The model's id: the name of its `.glb` file in the map's `models` directories. */
@@ -1253,7 +1260,7 @@ type TileflowBuildingMeshOptions = Readonly<{
     tileMetres: number;
     /** Height used where a building has none, in metres; defaults to 5, World's own fallback. */
     defaultHeight?: number;
-    /** Exterior corner radius in metres, up to 1; 0 leaves the footprint unchanged. */
+    /** Exterior corner radius in metres, up to 1.5; 0 leaves the footprint unchanged. */
     edgeRadius?: number;
     /** Maximum turn per rounded segment; defaults to 30 degrees for close views. */
     cornerAngle?: number;
@@ -1322,6 +1329,12 @@ type TileflowModelRoleLighting = Readonly<{
     colorMix?: number;
     metallic?: number;
     roughness?: number;
+    /** Map shading normalizes sunlight to the surrounding extruded buildings. */
+    shading?: 'physical' | 'map';
+    /** Multiplier for the scene's model ambient occlusion. Defaults to one. */
+    ambientOcclusion?: number;
+    /** Contribution of named part colours after the role tint. Defaults to one. */
+    partColorMix?: number;
     colorVariation?: Readonly<{
         hue: readonly [number, number];
         saturation: readonly [number, number];
@@ -1371,7 +1384,7 @@ type TileflowBuildings3DDesign = Readonly<{
     nightLight: number;
     /** Height-selected light on ordinary buildings and the ground, independent of shop windows. */
     floodLight?: TileflowBuildingFloodLight;
-    /** Emission by architectural role, independent of model palette slots. */
+    /** Emission by architectural role, independent of the models' parts. */
     modelLighting?: Readonly<Partial<Record<TileflowModelLightingRole, TileflowModelRoleLighting>>>;
     /** Invented night windows, lit by rooms: decoration, not data. */
     windows: boolean;
@@ -1389,12 +1402,14 @@ type TileflowBuildings3DDesign = Readonly<{
     /** Shadows from the sun, and contact shadow at the foot of the walls. */
     shadows: boolean;
     occlusion: boolean;
+    /** Ground contact shadow strength; facade shading is independent. */
+    groundOcclusion?: number;
     /** Strength of prepared model ambient visibility; zero leaves the sky contribution unchanged. */
     modelOcclusion?: number;
     /** 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>>>;
+    /** The colours of the models' parts by name; a part without one keeps its material's colour. */
+    modelColors?: Readonly<Record<string, 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.
@@ -1969,6 +1984,8 @@ type TileflowContourProtocolRegistry = {
 type TileflowContourProtocolRegistrationOptions = {
     /** Test/integration override; the default lazily initializes the pinned, bundled module. */
     loadMaplibreContour?: () => Promise<unknown>;
+    /** Route the nested DEM template through an application-owned transport, preserving XYZ slots. */
+    transformDemUrl?: (url: string) => string;
 };
 /** Registers the one self-contained protocol emitted by every compiled contour source. */
 declare function registerTileflowContourProtocol(registry: TileflowContourProtocolRegistry, options?: TileflowContourProtocolRegistrationOptions): void;
@@ -1986,6 +2003,8 @@ type TileflowPmtilesProtocolRegistry = Readonly<{
 }>;
 type TileflowPmtilesProtocolRegistrationOptions = Readonly<{
     maximumDirectoryDepth?: number;
+    /** Route archive byte requests through an application-owned resource transport. */
+    transformArchiveUrl?: (url: string) => string;
 }>;
 declare const tileflowPmtilesMaximumDirectoryDepth: 32;
 declare const tileflowPmtilesProtocol: "tileflow-pmtiles";