@tileflow/core 0.1.0-alpha.41 → 0.1.0-alpha.43

package/dist/native.d.ts

@@ -362,4 +362,90 @@ declare function planTileflowThemeBlend(styles: readonly MapLibreStyle[], option
 /** 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, type TileflowTimeOfDay, type TileflowTimeOfDayVariants, createTileflowNativeSourceController, fillTileflowThemeBlendTemplate, loadTileflowNativeManifest, nearestTileflowBlendTheme, planTileflowThemeBlend, resolveTileflowNativeInitialView, resolveTileflowNativeManifestUrl, resolveTileflowNativeResourceUrl, tileflowNativeManifestLimits, tileflowNativeUrlLimits, tileflowThemeBlendLimits, validateTileflowThemeBlendSelection };
+/**
+ * Boundaries families. Each one has its own license, attribution, TileJSON path and style source
+ * ID; families are never merged.
+ */
+declare const tileflowBoundaryFamilies: Readonly<{
+    boundaries: Readonly<{
+        attribution: "© OpenStreetMap contributors";
+        license: "ODbL-1.0";
+        path: "/tiles/boundaries/tiles.json";
+        sourceId: "tileflow-boundaries";
+    }>;
+}>;
+type TileflowBoundaryFamily = keyof typeof tileflowBoundaryFamilies;
+
+/** A value a choropleth can colour: a number for scales, a string for categories. */
+type TileflowBoundaryValue = number | string;
+/** One row of an application's data, keyed by a registry ID or an official code. */
+type TileflowBoundaryRow = Readonly<{
+    key: number | string;
+    /** `null` leaves the area without a value. */
+    value: TileflowBoundaryValue | null;
+}>;
+/** Keys present on every `boundary_area` polygon, usable without the lookup table. */
+type TileflowBoundaryFeatureKey = 'id' | 'iso_3166_1' | 'ref';
+/** Rows joined to areas by one polygon key. */
+type TileflowBoundaryValues = Readonly<{
+    joinBy: TileflowBoundaryFeatureKey;
+    rows: readonly TileflowBoundaryRow[];
+}>;
+
+type FeatureTarget = {
+    id?: number | string;
+    source: string;
+    sourceLayer?: string;
+};
+/** The part of a MapLibre map the controller uses. */
+type TileflowFeatureStateMap = {
+    getSource(id: string): unknown;
+    getStyle?(): {
+        sources?: Record<string, unknown>;
+    } | undefined;
+    off(type: 'styledata', listener: () => void): unknown;
+    on(type: 'styledata', listener: () => void): unknown;
+    removeFeatureState(target: FeatureTarget, key?: string): void;
+    setFeatureState(target: FeatureTarget & {
+        id: number | string;
+    }, state: Record<string, unknown>): void;
+};
+type CreateBoundaryFeatureStateOptions = Readonly<{
+    /** Defaults to `boundaries`. */
+    family?: TileflowBoundaryFamily;
+    /** Also set the values on `boundary_label` points, for labels styled by value. */
+    labels?: boolean;
+    /** Feature-state key; it must match the choropleth's `state`. Defaults to `value`. */
+    state?: string;
+}>;
+type TileflowBoundaryFeatureState = Readonly<{
+    /** Remove every value this controller set. */
+    clear: () => void;
+    /** Remove the values and stop following style reloads. */
+    dispose: () => void;
+    /**
+     * Replace the values. Rows must be keyed by the source's feature ID: `id` by default, or `ref`
+     * when the map declares `promoteId: 'ref'`. Rows with a `null` value are removed.
+     */
+    set: (values: TileflowBoundaryValues) => void;
+}>;
+/**
+ * Keep Boundaries feature-state in sync with application rows. Values survive a style reload: the
+ * controller sets them again once the source is back.
+ */
+declare function createBoundaryFeatureState(map: TileflowFeatureStateMap, options?: CreateBoundaryFeatureStateOptions): TileflowBoundaryFeatureState;
+
+/** Public selectors only; authority is acquired separately for each protected resource. */
+type TileflowMobileDiscovery = Readonly<{
+    version: 1;
+    mapId: string;
+    deploymentVersion: number;
+    representations: Readonly<Partial<Record<'native-v1' | 'webview-v1', Readonly<{
+        manifestUrl: string;
+    }>>>>;
+}>;
+declare const tileflowMobileDiscoveryMaximumBytes = 4096;
+/** Bind every advertised representation to the exact Hosted origin and Map being requested. */
+declare function parseTileflowMobileDiscovery(value: unknown, discoveryUrl: string): TileflowMobileDiscovery;
+
+export { type CreateBoundaryFeatureStateOptions, type TileflowBoundaryFamily, type TileflowBoundaryFeatureState, type TileflowBoundaryRow, type TileflowBoundaryValues, type TileflowFeatureStateMap, type TileflowMobileDiscovery, 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, type TileflowTimeOfDay, type TileflowTimeOfDayVariants, createBoundaryFeatureState, createTileflowNativeSourceController, fillTileflowThemeBlendTemplate, loadTileflowNativeManifest, nearestTileflowBlendTheme, parseTileflowMobileDiscovery, planTileflowThemeBlend, resolveTileflowNativeInitialView, resolveTileflowNativeManifestUrl, resolveTileflowNativeResourceUrl, tileflowBoundaryFamilies, tileflowMobileDiscoveryMaximumBytes, tileflowNativeManifestLimits, tileflowNativeUrlLimits, tileflowThemeBlendLimits, validateTileflowThemeBlendSelection };