@tileflow/core 0.1.0-alpha.30 → 0.1.0-alpha.32

package/dist/native-profile.js

@@ -8809,6 +8809,13 @@ var layerTransformationSchema = strictNativeObject({
     "Expected unique, ordered properties"
   )
 });
+var symbolOverlapTransformationSchema = strictNativeObject({
+  inputLayer: layerCountSchema,
+  properties: z4.array(z4.enum(["icon-overlap", "text-overlap"])).min(1).max(2).refine(
+    (properties2) => properties2.length === 1 || properties2[0] === "icon-overlap" && properties2[1] === "text-overlap",
+    "Expected unique, ordered properties"
+  )
+});
 var tileflowNativeStyleTransformationSchema = strictNativeObject({
   map: tileflowPortableIdSchema,
   theme: tileflowThemeNameSchema,
@@ -8817,7 +8824,8 @@ var tileflowNativeStyleTransformationSchema = strictNativeObject({
   inputLayers: layerCountSchema,
   outputLayers: layerCountSchema,
   projection: z4.enum(["none", "mercator-to-implicit", "globe-to-mercator"]),
-  layers: z4.array(layerTransformationSchema).max(tileflowNativeProfileLimits.maximumLayers)
+  layers: z4.array(layerTransformationSchema).max(tileflowNativeProfileLimits.maximumLayers),
+  symbolOverlap: z4.array(symbolOverlapTransformationSchema).max(tileflowNativeProfileLimits.maximumLayers)
 }).superRefine((style, context) => {
   let previous = -1;
   let added = 0;
@@ -8839,6 +8847,18 @@ var tileflowNativeStyleTransformationSchema = strictNativeObject({
       message: "Layer counts do not match transformation spans"
     });
   }
+  const partitioned = new Set(style.layers.map(({ inputLayer }) => inputLayer));
+  previous = -1;
+  for (const [index, layer] of style.symbolOverlap.entries()) {
+    if (layer.inputLayer <= previous || layer.inputLayer >= style.inputLayers || partitioned.has(layer.inputLayer)) {
+      context.addIssue({
+        code: "custom",
+        path: ["symbolOverlap", index],
+        message: "Invalid symbol overlap layer"
+      });
+    }
+    previous = layer.inputLayer;
+  }
 });
 var tileflowNativeBuildRecordSchema = strictNativeObject({
   schemaVersion: z4.literal(2),

package/dist/native.d.ts

@@ -26,12 +26,39 @@ declare function resolveTileflowNativeManifestUrl(value: unknown, options?: Tile
 /** Resolve a resource against its owner without fetching it or authorizing requests. */
 declare function resolveTileflowNativeResourceUrl(value: unknown, options: TileflowNativeResourceUrlOptions): string;
 
+type TileflowColor = `#${string}`;
 type TileflowViewConfig = {
     bearing?: number;
     center?: readonly [number, number];
     pitch?: number;
     zoom?: number;
 };
+type MapLibreSprite = string | Array<{
+    id: string;
+    url: string;
+}>;
+type TileflowProjection = 'globe' | 'mercator';
+type TileflowLight = {
+    anchor?: 'map' | 'viewport';
+    color?: TileflowColor;
+    intensity?: number;
+    position?: readonly [number, number, number];
+};
+type MapLibreStyle = {
+    sky?: Record<string, unknown>;
+    version: 8;
+    name: string;
+    glyphs?: string;
+    light?: TileflowLight;
+    projection?: {
+        type: TileflowProjection;
+    };
+    sprite?: MapLibreSprite;
+    sources: Record<string, Record<string, unknown>>;
+    layers: Array<Record<string, unknown>>;
+    terrain?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+};
 
 /** Runtime-ready logical map with all relative theme resources already resolved. */
 type TileflowRuntimeManifestMap = TileflowRuntimeManifestMapEntry & {
@@ -47,6 +74,24 @@ type TileflowStyleFontFace = {
     style?: 'italic' | 'normal' | 'oblique';
     weight?: '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
 };
+/**
+ * A continuous blend of named themes of one Tileflow map. `position` places the map between
+ * neighbouring themes: 0 is the first, 1 the second, and 1.25 a quarter of the way from the second
+ * to the third.
+ */
+type TileflowThemeBlendSelection = Readonly<{
+    /** From 0 to `themes.length - 1`. */
+    position: number;
+    /** Two to eight concrete theme names of the map, in blend order. */
+    themes: readonly string[];
+}>;
+declare const tileflowThemeBlendLimits: Readonly<{
+    maximumThemes: 8;
+    minimumThemes: 2;
+}>;
+declare function validateTileflowThemeBlendSelection(value: unknown): value is TileflowThemeBlendSelection;
+/** The theme nearest to a blend position, which a blend shows when it cannot blend. */
+declare function nearestTileflowBlendTheme(blend: TileflowThemeBlendSelection): string;
 
 /** The first and only public multi-theme runtime manifest contract. */
 declare const tileflowRuntimeManifestVersion: 1;
@@ -219,4 +264,92 @@ type TileflowNativeInitialViewOptions = {
 /** Resolve once or repeatedly without changing source generations, themes or acquisition. */
 declare function resolveTileflowNativeInitialView(options?: TileflowNativeInitialViewOptions): TileflowNativeInitialView;
 
-export { type TileflowNativeAbortSignal, type TileflowNativeInitialView, type TileflowNativeInitialViewOptions, type TileflowNativeManifestAcquire, type TileflowNativeManifestLoadOptions, type TileflowNativeManifestOperation, type TileflowNativeManifestReader, type TileflowNativeManifestResponse, type TileflowNativeManifestResult, type TileflowNativeNetworkOptions, type TileflowNativeResourceUrlOptions, type TileflowNativeSource, type TileflowNativeSourceController, TileflowNativeSourceError, type TileflowNativeSourceErrorCode, type TileflowNativeSourceErrorField, type TileflowNativeSourceOptions, type TileflowNativeSourceState, TileflowNativeUrlError, type TileflowNativeUrlErrorCode, type TileflowNativeUrlField, createTileflowNativeSourceController, loadTileflowNativeManifest, resolveTileflowNativeInitialView, resolveTileflowNativeManifestUrl, resolveTileflowNativeResourceUrl, tileflowNativeManifestLimits, tileflowNativeUrlLimits };
+/**
+ * Theme blending plans one MapLibre style that can show any point between the themes of one map.
+ *
+ * The themes of a Tileflow map compile to the same sources, layers, filters, and expressions; they
+ * differ only in token values: colours, numbers, and image names. A plan keeps the first theme's
+ * structure and records every value that differs as a template the browser fills in for a blend
+ * position: 0 is the first theme, 1 the second, and 1.25 a quarter of the way from the second to
+ * the third. Filling a template needs no expression parsing in the browser, so the renderer only
+ * receives plain values.
+ *
+ * Values that MapLibre evaluates per feature (data-driven values, such as a fill colour chosen by
+ * land-use class) are baked into tiles, and changing them re-lays the whole source out. A plan
+ * splits such a layer into one layer per branch that a feature can take through the value's
+ * decisions on feature data, each filtered to the features that take it, so each value depends
+ * only on zoom and the blend position. A value that reads feature data continuously is drawn once
+ * per theme instead, and the copies cross-fade by opacity. Images are mixed in their pixels.
+ * Values that read feature state cannot be split, because filters cannot read state; they switch
+ * when the dominant theme changes.
+ */
+/** A paint value that the browser sets as the blend moves. */
+type TileflowThemeBlendPaint = Readonly<{
+    layer: string;
+    property: string;
+    template: unknown;
+    /** Ground values follow the blend position; symbol values follow the label cross-fade. */
+    follows: TileflowThemeBlendClock;
+}>;
+/** Image names whose artwork differs between themes and is mixed in pixels. */
+type TileflowThemeBlendImage = Readonly<{
+    names: readonly string[];
+    follows: TileflowThemeBlendClock;
+}>;
+/** A value that can only change all at once, when the dominant theme changes. */
+type TileflowThemeBlendSwitch = Readonly<{
+    layer: string;
+    group: 'layout' | 'paint';
+    property: string;
+    values: readonly unknown[];
+}>;
+/**
+ * `position` values follow the blend; `dominant` values follow a short cross-fade that starts when
+ * the nearest theme changes. Labels use it because light lettering on a dark plate and dark
+ * lettering on a light plate meet in the same grey halfway.
+ */
+type TileflowThemeBlendClock = 'dominant' | 'position';
+type TileflowThemeBlendPlan = Readonly<{
+    /** Number of themes; blend positions run from 0 to `themes - 1`. */
+    themes: number;
+    paints: readonly TileflowThemeBlendPaint[];
+    images: readonly TileflowThemeBlendImage[];
+    switches: readonly TileflowThemeBlendSwitch[];
+    /** Root sky and light, when they differ between themes. */
+    sky?: unknown;
+    light?: unknown;
+    summary: Readonly<{
+        splitLayers: number;
+        copiedLayers: number;
+        /** Per-theme layers of which only the nearest theme's copy is shown. */
+        switchedLayers: number;
+        switchedValues: number;
+    }>;
+    /** The style at a blend position: every template filled, every switch at the nearest theme. */
+    styleAt(position: number): MapLibreStyle;
+}>;
+type TileflowThemeBlendOptions = Readonly<{
+    /**
+     * How icon images that differ between themes change. `mix` (the default) mixes their artwork in
+     * pixels under the first theme's image names. `switch` changes the image names when the nearest
+     * theme changes, for renderers that cannot replace an image's pixels while keeping its stretch
+     * and content metadata.
+     */
+    iconImages?: 'mix' | 'switch';
+    /**
+     * How values that read feature data change when they can be neither split nor cross-faded.
+     * `values` (the default) sets each value when the nearest theme changes. `layers` draws such a
+     * layer once per theme and shows only the nearest theme's copy, for renderers that cannot set
+     * data-driven values at run time reliably.
+     */
+    featureSwitches?: 'layers' | 'values';
+}>;
+declare class TileflowThemeBlendError extends Error {
+    name: string;
+}
+/** Plans a blend of two or more compiled themes of one map, in blend order. */
+declare function planTileflowThemeBlend(styles: readonly MapLibreStyle[], options?: TileflowThemeBlendOptions): TileflowThemeBlendPlan;
+/** Fills one blend template for a position. Plain values pass through unchanged. */
+declare function fillTileflowThemeBlendTemplate(template: unknown, position: number): unknown;
+
+export { type TileflowNativeAbortSignal, type TileflowNativeInitialView, type TileflowNativeInitialViewOptions, type TileflowNativeManifestAcquire, type TileflowNativeManifestLoadOptions, type TileflowNativeManifestOperation, type TileflowNativeManifestReader, type TileflowNativeManifestResponse, type TileflowNativeManifestResult, type TileflowNativeNetworkOptions, type TileflowNativeResourceUrlOptions, type TileflowNativeSource, type TileflowNativeSourceController, TileflowNativeSourceError, type TileflowNativeSourceErrorCode, type TileflowNativeSourceErrorField, type TileflowNativeSourceOptions, type TileflowNativeSourceState, TileflowNativeUrlError, type TileflowNativeUrlErrorCode, type TileflowNativeUrlField, type TileflowThemeBlendClock, TileflowThemeBlendError, type TileflowThemeBlendImage, type TileflowThemeBlendOptions, type TileflowThemeBlendPaint, type TileflowThemeBlendPlan, type TileflowThemeBlendSelection, type TileflowThemeBlendSwitch, createTileflowNativeSourceController, fillTileflowThemeBlendTemplate, loadTileflowNativeManifest, nearestTileflowBlendTheme, planTileflowThemeBlend, resolveTileflowNativeInitialView, resolveTileflowNativeManifestUrl, resolveTileflowNativeResourceUrl, tileflowNativeManifestLimits, tileflowNativeUrlLimits, tileflowThemeBlendLimits, validateTileflowThemeBlendSelection };