choropleth-kit 0.0.0-stage → 0.2.0

package/dist/core.d.ts

@@ -0,0 +1,173 @@
+import { L as LonLatBounds, P as Point } from './drill-chain-C8hhHBnd.js';
+export { B as BoundsToTransformParams, a as Bubble, b as BubbleScaling, c as BuildLegendOptions, d as BuildProjectionChainParams, C as CATEGORICAL_PALETTES, e as CameraOptions, f as CameraSample, g as CameraTransform, h as CategoricalPaletteName, i as CategoricalScale, j as CategorySpec, k as ChainLevel, l as ChoroplethLabels, m as ChoroplethTheme, n as Classification, o as ColorScale, p as ColorScaleOptions, q as ConstrainAxisParams, r as ConstrainTransformParams, s as Corner, t as CreateCategoricalScaleOptions, u as CreateProjectionOptions, D as DEFAULT_ASPECT_RATIO, v as DEFAULT_BUBBLE_FILL, w as DEFAULT_CLASSES, x as DEFAULT_EMPTY_FILL, y as DEFAULT_FLIGHT_CURVATURE, z as DEFAULT_FOCUS_BOUNDS, A as DEFAULT_LEVEL_CACHE_SIZE, E as DEFAULT_MAX_RADIUS, F as DEFAULT_PADDING, G as DEFAULT_PROJECTION, H as DEFAULT_ZOOM_MAX, I as DEFAULT_ZOOM_MIN, J as DIVERGING_PALETTES, K as DivergingPaletteName, M as DrillContext, N as DrillCrumb, O as DrillDirection, Q as DrillLayer, R as DrillLayerRole, S as DrillMachineEvent, T as DrillMachineState, U as DrillPhase, V as Extent, W as FIT_TRANSFORM, X as FlightDurationParams, Y as GeographyData, Z as GeographyInput, _ as GetFocusExtentParams, $ as GetFocusGeometryParams, a0 as INERTIA_MIN_VELOCITY, a1 as INERTIA_TAU_MS, a2 as INERTIA_WINDOW_MS, a3 as InertiaOffsetParams, a4 as JoinDataOptions, a5 as JoinResult, a6 as LegendItem, a7 as LevelShape, a8 as LruCache, a9 as MAX_FLIGHT_MS, aa as MIN_FLIGHT_MS, ab as Padding, ac as PreserveViewParams, ad as ProjectionChain, ae as ProjectionName, af as RadiusScale, ag as RebaseParams, ah as RebaseResult, ai as ReleaseVelocityParams, aj as ResolveVariantOptions, ak as ResolveZoomTargetParams, al as ResolvedCategory, am as ResolvedZoom, an as SEQUENTIAL_PALETTES, ao as SequentialPaletteName, ap as Size, aq as SizeLegendItem, ar as THEMES, as as ThemeName, at as ToFeatureCollectionOptions, au as ToViewStateParams, av as TransitionResult, aw as VariantConfig, ax as VariantEntry, ay as VariantName, az as VariantResult, aA as ViewLevel, aB as ViewState, aC as ZoomControlsOptions, aD as ZoomEventLike, aE as ZoomFilterParams, aF as ZoomKeyAction, aG as ZoomOptions, aH as ZoomTarget, aI as applyTransform, aJ as boundsToTransform, aK as bubbleScale, aL as buildBreadcrumbs, aM as buildCategoricalLegend, aN as buildLegend, aO as buildProjectionChain, aP as buildSizeLegend, aQ as clampPath, aR as classIndex, aS as classifyDrill, aT as computeAspectRatio, aU as computeThresholds, aV as constrainAxis, aW as constrainTransform, aX as contextOf, aY as createCategoricalScale, aZ as createColorScale, a_ as createDrillState, a$ as createLruCache, b0 as createProjection, b1 as createRadiusScale, b2 as createZoomFilter, b3 as createZoomInterpolator, b4 as defaultFormatValue, b5 as defineTheme, b6 as drillDirectionBetween, b7 as drillReducer, b8 as en, b9 as es, ba as extendTheme, bb as finiteValues, bc as flightDuration, bd as geographyKeyFor, be as getAnchorPoint, bf as getFocusExtent, bg as getFocusGeometry, bh as inertiaOffset, bi as invertTransform, bj as isFitTransform, bk as isThemeName, bl as joinData, bm as layerKey, bn as normalizePadding, bo as preserveView, bp as projectBounds, bq as projectionFactory, br as rebaseProjection, bs as relativeTransform, bt as releaseVelocity, bu as resolveControls, bv as resolveDrillData, bw as resolveLabels, bx as resolveTheme, by as resolveVariant, bz as resolveZoomOptions, bA as resolveZoomTarget, bB as savedCameraFor, bC as themeToCssVars, bD as toFeatureCollection, bE as toViewState, bF as transformToZoomView, bG as unwrapGeography, bH as validateLevels, bI as zoomKeyAction } from './drill-chain-C8hhHBnd.js';
+import { FeatureCollection, Feature, MultiLineString } from 'geojson';
+import { Topology } from 'topojson-specification';
+import 'd3-geo';
+import 'd3-interpolate';
+import 'd3-scale-chromatic';
+
+type CreateBordersOptions = {
+    geography: Topology | FeatureCollection;
+    /** Same `objectName` that was passed to `toFeatureCollection`, so both read the same object. */
+    objectName?: string;
+    /**
+     * The same filter applied to the regions: a border is only drawn if BOTH sides are kept (otherwise
+     * the line of a country that is no longer there would remain).
+     */
+    filterFeatures?: (feature: Feature) => boolean;
+};
+/**
+ * INTERIOR borders as a single line (a shared border is drawn once).
+ *
+ * Only possible with TopoJSON: it knows which arcs two countries share. With GeoJSON each polygon
+ * carries its own outline and there is no reliable way to know which ones touch, so it returns `null`
+ * and the consumer must use `stroke` on each region.
+ *
+ * `a !== b` discards the arcs of the outer outline (coasts): a country's border with the sea is not
+ * a border and would duplicate the stroke of the silhouette.
+ */
+declare const createBorders: ({ geography, objectName, filterFeatures, }: CreateBordersOptions) => MultiLineString | null;
+
+type JoinDiagnosticsInput = {
+    unmatchedData: readonly string[];
+    featuresWithoutData: readonly string[];
+    duplicateDataIds: readonly string[];
+    /** Number of data rows. With 0 (still loading) there is nothing to diagnose. */
+    dataCount: number;
+};
+/**
+ * Turns the result of `joinData` into the warning text for the developer, or `null` if
+ * there is nothing to warn about. Pure: it does not write to the console, so it is tested without mocking it.
+ */
+declare const formatJoinDiagnostics: ({ unmatchedData, featuresWithoutData, duplicateDataIds, dataCount, }: JoinDiagnosticsInput) => string | null;
+
+/**
+ * Pure pieces of the drill's closing (step 34): the "intent" to go down (sustained hover) and the
+ * development warnings for navigation requests. No React or DOM: timers are injected.
+ */
+/** How long the pointer must stay over a drillable region to count as intent. */
+declare const DRILL_INTENT_MS = 150;
+type IntentTimer = {
+    /**
+     * What the pointer is over now. A different `key` restarts the wait; the same one does not extend
+     * it; `null` cancels it. When it elapses, `onIntent(key)` is called ONCE per dwell.
+     */
+    hover: (key: string | null) => void;
+    /** Cancels any pending wait (on unmount). */
+    dispose: () => void;
+};
+type IntentTimerOptions = {
+    onIntent: (key: string) => void;
+    delay?: number;
+    /** Injectable for tests; the globals by default. */
+    setTimer?: (callback: () => void, ms: number) => unknown;
+    clearTimer?: (handle: unknown) => void;
+};
+/**
+ * Intent timer. "Once per dwell": leaving and re-entering the same region (via another one or via
+ * `null`) counts as a new dwell.
+ */
+declare const createIntentTimer: ({ onIntent, delay, setTimer, clearTimer, }: IntentTimerOptions) => IntentTimer;
+type DrillRequestProblem = 
+/** The id does not exist at the level being drilled from. */
+{
+    kind: "unknown-id";
+    id: string;
+    depth: number;
+    levelId: string;
+}
+/** The level has `canDrill` set to `false` for that region. */
+ | {
+    kind: "cannot-drill";
+    id: string;
+    depth: number;
+    levelId: string;
+};
+/**
+ * Is it valid to go down to `id` from a level whose regions are `knownIds`? Returns the problem or
+ * `null`. `knownIds` is `undefined` if that level is not loaded yet: it cannot be judged and is let
+ * through. `drillable` is `undefined` if `canDrill` cannot be evaluated (no item with its datum).
+ */
+declare const checkDrillStep: ({ id, depth, levelId, knownIds, drillable, }: {
+    id: string;
+    depth: number;
+    levelId: string;
+    knownIds: ReadonlySet<string> | undefined;
+    drillable: boolean | undefined;
+}) => DrillRequestProblem | null;
+/** Warning text (in English, for the developer). `source` says who requested the navigation. */
+declare const formatDrillRequestProblem: (problem: DrillRequestProblem, source: string) => string;
+/** Requesting a route deeper than the defined levels: ignored (the last level cannot be drilled into). */
+declare const formatTooDeepRequest: (path: readonly string[], levelCount: number, source: string) => string;
+/**
+ * Warning that NO region of the level has an id (so no datum can join): almost always a
+ * `getFeatureId` that reads a property that does not exist. `null` if there is nothing to warn about.
+ */
+declare const formatNoIdsDiagnostic: ({ featureCount, idCount, levelId, customGetFeatureId, }: {
+    featureCount: number;
+    idCount: number;
+    levelId: string | null;
+    customGetFeatureId: boolean;
+}) => string | null;
+/**
+ * Extra hint for the join when there is a `drill` and NO datum joins with the displayed geometry: the
+ * usual cause is passing a fixed list from another level. `null` if it does not apply.
+ */
+declare const formatWrongLevelDataHint: ({ drillActive, dataIsSelector, dataCount, unmatchedCount, levelId, }: {
+    drillActive: boolean;
+    dataIsSelector: boolean;
+    dataCount: number;
+    unmatchedCount: number;
+    levelId: string | null;
+}) => string | null;
+
+/** A preset name (`"europe"`), an ISO 3166-1 alpha-2 code (`"ES"`), or a list mixing both. */
+type RegionInput = string | readonly string[];
+/** Preset name → alpha-2 ids it expands to. The table itself lives in `choropleth-kit/geo`. */
+type RegionPresets = Readonly<Record<string, readonly string[]>>;
+/**
+ * `region` → the set of alpha-2 ids that stay on the map.
+ *
+ * Each entry is a preset name (exact, camelCase: `"westernEurope"`) or an alpha-2 code (`"ES"`, case
+ * insensitive). A preset wins over a code, but no preset name is two letters long, so they never clash.
+ * It does not know the geography: an id that exists in no map simply matches nothing (the React layer
+ * warns if the whole region is empty).
+ *
+ * It throws, listing the valid preset names, on an unknown name and on an empty list: an empty region
+ * would draw a blank map with no error, which is the worst symptom to debug.
+ */
+declare const resolveRegion: (region: RegionInput, presets: RegionPresets) => ReadonlySet<string>;
+/** Country id → lon/lat boxes of its overseas territories. The table itself lives in `choropleth-kit/geo`. */
+type OverseasTable = Readonly<Record<string, readonly LonLatBounds[]>>;
+/**
+ * Drops the overseas territories listed in `territories` from the features: a polygon of country `id` goes
+ * away when the middle of its bounding box falls inside one of that country's boxes (France without Guiana, Norway without
+ * Svalbard, the US without Hawaii).
+ *
+ * Why a curated table and not a distance rule: `fitSize` frames the WHOLE geometry, so a single French
+ * Guiana polygon shrinks a map of Europe into a corner of the container. But no distance threshold
+ * separates Svalbard (overseas) from Peninsular Malaysia or Papua (not): measured on the world at 1:110m,
+ * every threshold either keeps Svalbard or drops half of Malaysia and Indonesia. Which polygons count as
+ * overseas is a political decision, so it is data.
+ *
+ * Boxes are in lon/lat and must not cross the antimeridian (`west <= east`). A feature that does not change
+ * comes back as the SAME object (the path memoization downstream relies on identity); the input is never
+ * mutated. A feature is never emptied: if the table would drop every polygon, it is returned untouched.
+ */
+declare const dropOverseas: (features: readonly Feature[], territories: OverseasTable) => Feature[];
+/**
+ * `[λ, φ]` rotation for the projection of a REGION whose geometry straddles the antimeridian, or `undefined`
+ * if it does not (then the map keeps the world's orientation, and drill continuity with it).
+ *
+ * Why: a flat projection cuts the world at ±180°. Oceania (Fiji, New Zealand, Samoa…) and Russia's Chukotka
+ * sit on both sides of that line, so `fitSize` would stretch the map over the whole world and
+ * tear the region across both edges. The fix is to cut the world somewhere else: in the middle of the widest
+ * stretch of longitudes the region does NOT use (the Atlantic for Oceania, the Americas for Russia).
+ * `points` are extra [lon, lat] that must land on the right side too (microstates drawn as dots).
+ *
+ * It is longitude only (`φ = 0`): the region is never tilted.
+ */
+declare const regionRotation: (features: readonly Feature[], points?: readonly Point[]) => [number, number] | undefined;
+
+export { DRILL_INTENT_MS, LonLatBounds, Point, checkDrillStep, createBorders, createIntentTimer, dropOverseas, formatDrillRequestProblem, formatJoinDiagnostics, formatNoIdsDiagnostic, formatTooDeepRequest, formatWrongLevelDataHint, regionRotation, resolveRegion };
+export type { CreateBordersOptions, DrillRequestProblem, IntentTimer, IntentTimerOptions, JoinDiagnosticsInput, OverseasTable, RegionInput, RegionPresets };

package/dist/core.js

@@ -0,0 +1,203 @@
+import {
+  CATEGORICAL_PALETTES,
+  DEFAULT_ASPECT_RATIO,
+  DEFAULT_BUBBLE_FILL,
+  DEFAULT_CLASSES,
+  DEFAULT_EMPTY_FILL,
+  DEFAULT_FLIGHT_CURVATURE,
+  DEFAULT_FOCUS_BOUNDS,
+  DEFAULT_LEVEL_CACHE_SIZE,
+  DEFAULT_MAX_RADIUS,
+  DEFAULT_PADDING,
+  DEFAULT_PROJECTION,
+  DEFAULT_ZOOM_MAX,
+  DEFAULT_ZOOM_MIN,
+  DIVERGING_PALETTES,
+  DRILL_INTENT_MS,
+  FIT_TRANSFORM,
+  INERTIA_MIN_VELOCITY,
+  INERTIA_TAU_MS,
+  INERTIA_WINDOW_MS,
+  MAX_FLIGHT_MS,
+  MIN_FLIGHT_MS,
+  SEQUENTIAL_PALETTES,
+  THEMES,
+  applyTransform,
+  boundsToTransform,
+  bubbleScale,
+  buildBreadcrumbs,
+  buildCategoricalLegend,
+  buildLegend,
+  buildProjectionChain,
+  buildSizeLegend,
+  checkDrillStep,
+  clampPath,
+  classIndex,
+  classifyDrill,
+  computeAspectRatio,
+  computeThresholds,
+  constrainAxis,
+  constrainTransform,
+  contextOf,
+  createBorders,
+  createCategoricalScale,
+  createColorScale,
+  createDrillState,
+  createIntentTimer,
+  createLruCache,
+  createProjection,
+  createRadiusScale,
+  createZoomFilter,
+  createZoomInterpolator,
+  defaultFormatValue,
+  defineTheme,
+  drillDirectionBetween,
+  drillReducer,
+  dropOverseas,
+  en,
+  es,
+  extendTheme,
+  finiteValues,
+  flightDuration,
+  formatDrillRequestProblem,
+  formatJoinDiagnostics,
+  formatNoIdsDiagnostic,
+  formatTooDeepRequest,
+  formatWrongLevelDataHint,
+  geographyKeyFor,
+  getAnchorPoint,
+  getFocusExtent,
+  getFocusGeometry,
+  inertiaOffset,
+  invertTransform,
+  isFitTransform,
+  isThemeName,
+  joinData,
+  layerKey,
+  normalizePadding,
+  preserveView,
+  projectBounds,
+  projectionFactory,
+  rebaseProjection,
+  regionRotation,
+  relativeTransform,
+  releaseVelocity,
+  resolveControls,
+  resolveDrillData,
+  resolveLabels,
+  resolveRegion,
+  resolveTheme,
+  resolveVariant,
+  resolveZoomOptions,
+  resolveZoomTarget,
+  savedCameraFor,
+  themeToCssVars,
+  toFeatureCollection,
+  toViewState,
+  transformToZoomView,
+  unwrapGeography,
+  validateLevels,
+  zoomKeyAction
+} from "./chunk-ZN6SLXL3.js";
+export {
+  CATEGORICAL_PALETTES,
+  DEFAULT_ASPECT_RATIO,
+  DEFAULT_BUBBLE_FILL,
+  DEFAULT_CLASSES,
+  DEFAULT_EMPTY_FILL,
+  DEFAULT_FLIGHT_CURVATURE,
+  DEFAULT_FOCUS_BOUNDS,
+  DEFAULT_LEVEL_CACHE_SIZE,
+  DEFAULT_MAX_RADIUS,
+  DEFAULT_PADDING,
+  DEFAULT_PROJECTION,
+  DEFAULT_ZOOM_MAX,
+  DEFAULT_ZOOM_MIN,
+  DIVERGING_PALETTES,
+  DRILL_INTENT_MS,
+  FIT_TRANSFORM,
+  INERTIA_MIN_VELOCITY,
+  INERTIA_TAU_MS,
+  INERTIA_WINDOW_MS,
+  MAX_FLIGHT_MS,
+  MIN_FLIGHT_MS,
+  SEQUENTIAL_PALETTES,
+  THEMES,
+  applyTransform,
+  boundsToTransform,
+  bubbleScale,
+  buildBreadcrumbs,
+  buildCategoricalLegend,
+  buildLegend,
+  buildProjectionChain,
+  buildSizeLegend,
+  checkDrillStep,
+  clampPath,
+  classIndex,
+  classifyDrill,
+  computeAspectRatio,
+  computeThresholds,
+  constrainAxis,
+  constrainTransform,
+  contextOf,
+  createBorders,
+  createCategoricalScale,
+  createColorScale,
+  createDrillState,
+  createIntentTimer,
+  createLruCache,
+  createProjection,
+  createRadiusScale,
+  createZoomFilter,
+  createZoomInterpolator,
+  defaultFormatValue,
+  defineTheme,
+  drillDirectionBetween,
+  drillReducer,
+  dropOverseas,
+  en,
+  es,
+  extendTheme,
+  finiteValues,
+  flightDuration,
+  formatDrillRequestProblem,
+  formatJoinDiagnostics,
+  formatNoIdsDiagnostic,
+  formatTooDeepRequest,
+  formatWrongLevelDataHint,
+  geographyKeyFor,
+  getAnchorPoint,
+  getFocusExtent,
+  getFocusGeometry,
+  inertiaOffset,
+  invertTransform,
+  isFitTransform,
+  isThemeName,
+  joinData,
+  layerKey,
+  normalizePadding,
+  preserveView,
+  projectBounds,
+  projectionFactory,
+  rebaseProjection,
+  regionRotation,
+  relativeTransform,
+  releaseVelocity,
+  resolveControls,
+  resolveDrillData,
+  resolveLabels,
+  resolveRegion,
+  resolveTheme,
+  resolveVariant,
+  resolveZoomOptions,
+  resolveZoomTarget,
+  savedCameraFor,
+  themeToCssVars,
+  toFeatureCollection,
+  toViewState,
+  transformToZoomView,
+  unwrapGeography,
+  validateLevels,
+  zoomKeyAction
+};
+//# sourceMappingURL=core.js.map