choropleth-kit 0.0.0-stage → 0.2.0

package/dist/geo.d.ts

@@ -0,0 +1,89 @@
+import { Topology } from 'topojson-specification';
+
+/**
+ * ISO 3166-1 numeric → alpha-2 (`"724"` → `"ES"`). For anyone using `world-atlas` directly
+ * (its ids are numeric) who has alpha-2 data: `getFeatureId={(f) => isoNumericToAlpha2[f.id]}`.
+ */
+declare const isoNumericToAlpha2: Readonly<Record<string, string>>;
+
+/** Point [x, y] in pixels or [lon, lat] in degrees, depending on context. */
+type Point = readonly [number, number];
+
+/** Geographic bounds [[lonW, latS], [lonE, latN]]. If `lonE < lonW`, they cross the antimeridian. */
+type LonLatBounds = readonly [Point, Point];
+
+/**
+ * [lon, lat] of the countries and territories that `world-110m` does NOT draw (at 1:110m the
+ * microstates and most islands disappear). Pass it as `fallbackPoints` so a datum for Andorra or
+ * Singapore shows up as a colored dot instead of silently getting lost.
+ *
+ * It is not exhaustive: it covers the missing independent countries and the territories most common
+ * in business data (Hong Kong, Macao, Gibraltar, the Faroe Islands…). Add your own with a spread.
+ */
+declare const worldFallbackPoints: Readonly<Record<string, Point>>;
+
+declare const REGION_PRESETS: {
+    africa: string[];
+    asia: string[];
+    europe: string[];
+    northAmerica: string[];
+    southAmerica: readonly string[];
+    oceania: string[];
+    northernAfrica: readonly string[];
+    easternAfrica: readonly string[];
+    middleAfrica: readonly string[];
+    southernAfrica: readonly string[];
+    westernAfrica: readonly string[];
+    centralAsia: readonly string[];
+    easternAsia: readonly string[];
+    southeasternAsia: readonly string[];
+    southernAsia: readonly string[];
+    westernAsia: readonly string[];
+    northernEurope: readonly string[];
+    westernEurope: readonly string[];
+    southernEurope: readonly string[];
+    easternEurope: readonly string[];
+    usAndCanada: readonly string[];
+    centralAmerica: readonly string[];
+    caribbean: readonly string[];
+    australiaAndNewZealand: readonly string[];
+    melanesia: readonly string[];
+    micronesia: readonly string[];
+    polynesia: readonly string[];
+    eu27: readonly string[];
+    nordics: readonly string[];
+    iberia: readonly string[];
+    latam: readonly string[];
+    mena: readonly string[];
+};
+type RegionPresetName = keyof typeof REGION_PRESETS;
+
+/**
+ * Overseas territories that `region` drops, by country: lon/lat boxes `[[west, south], [east, north]]`. A
+ * polygon of the country whose middle (of its bounding box) falls inside a box is not drawn (nor framed).
+ *
+ * It is CURATED, not computed: no distance rule separates Svalbard (overseas) from Peninsular Malaysia
+ * (not). It only lists what `world110m` actually draws, and each entry is covered by a test. At 1:110m
+ * Spain, Portugal and the Netherlands have no overseas polygons (the Canary Islands, the Azores and the
+ * Caribbean are not in the data); when a 1:50m geometry is added, its territories are added here.
+ *
+ * Alaska stays on purpose: it is part of the North American mass and a `northAmerica` map without it
+ * would be wrong. Showing or hiding territories per country is FEAT-023.
+ */
+declare const OVERSEAS_TERRITORIES: Readonly<Record<string, readonly LonLatBounds[]>>;
+
+/**
+ * World at 1:110m (Natural Earth, public domain) as TopoJSON, with **ISO 3166-1 alpha-2 in `id`**
+ * (`"ES"`) and the English name in `properties.name`. Use the `countries` object.
+ *
+ * It is `world-atlas` with the ids converted (see `scripts/build-geo/build-world-110m.mjs`), plus
+ * Kosovo as `"XK"`. Northern Cyprus and Somaliland still have no id: they are painted as a
+ * non-interactive layer. At this scale microstates are missing: use `worldFallbackPoints`.
+ *
+ * ⚠️ Disputed borders (Western Sahara, Crimea, Kashmir…) are Natural Earth's.
+ * Validate them before showing a map in a product.
+ */
+declare const world110m: Topology;
+
+export { OVERSEAS_TERRITORIES, REGION_PRESETS, isoNumericToAlpha2, world110m, worldFallbackPoints };
+export type { RegionPresetName };