@geogdev/styles 0.1.0

package/dist/cjs/index.d.cts

@@ -0,0 +1,325 @@
+import { LayerSpecification, FilterSpecification, ExpressionSpecification, SymbolLayerSpecification, LineLayerSpecification } from '@maplibre/maplibre-gl-style-spec';
+
+interface LanguageScriptPair {
+    lang: string;
+    full_name: string;
+    script: string;
+}
+declare const LANGUAGE_SCRIPT_PAIRS: LanguageScriptPair[];
+declare function getCountryName(lang: string, script?: string): (string | (string | string[])[] | {
+    "text-font": (string | string[])[];
+} | {
+    "text-font"?: undefined;
+})[];
+declare function getMultilineName(lang: string, script?: string, regular?: string): (string | (string | (string | (string | string[])[] | {
+    "text-font": (string | string[])[];
+} | {
+    "text-font"?: undefined;
+})[] | (string | (string | {
+    "text-font"?: undefined;
+} | (string | (string | (string | string[])[])[])[] | {
+    "text-font": (string | (string | string[])[])[];
+})[])[])[] | (string | (string | (string | string[])[] | {
+    "text-font": (string | (string | string[])[])[];
+} | {
+    "text-font"?: undefined;
+})[] | (string | (string | (string | (string | string[])[])[])[] | (string | (string | string[])[] | {
+    "text-font": (string | (string | string[])[])[];
+} | {
+    "text-font"?: undefined;
+})[])[])[])[];
+
+/**
+ * Valid style name strings
+ */
+declare const STYLE_NAMES: readonly ["light", "dark", "gray", "warm"];
+/**
+ * Type for valid style names
+ */
+type StyleName = (typeof STYLE_NAMES)[number];
+/**
+ * Type guard to check if a string is a valid style name
+ */
+declare function isValidStyleName(name: string): name is StyleName;
+interface Style {
+    background: string;
+    earth: string;
+    park_a: string;
+    park_b: string;
+    hospital: string;
+    industrial: string;
+    school: string;
+    wood_a: string;
+    wood_b: string;
+    pedestrian: string;
+    scrub_a: string;
+    scrub_b: string;
+    glacier: string;
+    sand: string;
+    beach: string;
+    aerodrome: string;
+    runway: string;
+    water: string;
+    zoo: string;
+    military: string;
+    tunnel_other_casing: string;
+    tunnel_minor_casing: string;
+    tunnel_link_casing: string;
+    tunnel_major_casing: string;
+    tunnel_highway_casing: string;
+    tunnel_other: string;
+    tunnel_minor: string;
+    tunnel_link: string;
+    tunnel_major: string;
+    tunnel_highway: string;
+    pier: string;
+    buildings: string;
+    minor_service_casing: string;
+    minor_casing: string;
+    link_casing: string;
+    major_casing_late: string;
+    highway_casing_late: string;
+    other: string;
+    minor_service: string;
+    minor_a: string;
+    minor_b: string;
+    link: string;
+    major_casing_early: string;
+    major: string;
+    highway_casing_early: string;
+    highway: string;
+    railway: string;
+    boundaries: string;
+    bridges_other_casing: string;
+    bridges_minor_casing: string;
+    bridges_link_casing: string;
+    bridges_major_casing: string;
+    bridges_highway_casing: string;
+    bridges_other: string;
+    bridges_minor: string;
+    bridges_link: string;
+    bridges_major: string;
+    bridges_highway: string;
+    roads_label_minor: string;
+    roads_label_minor_halo: string;
+    roads_label_major: string;
+    roads_label_major_halo: string;
+    ocean_label: string;
+    subplace_label: string;
+    subplace_label_halo: string;
+    city_label: string;
+    city_label_halo: string;
+    state_label: string;
+    state_label_halo: string;
+    country_label: string;
+    address_label: string;
+    address_label_halo: string;
+    regular?: string;
+    bold?: string;
+    italic?: string;
+    medium?: string;
+    pois?: Pois;
+    landcover?: Landcover;
+    shields?: Shields;
+    transit_rail?: string;
+    transit_freight?: string;
+    transit_bus?: string;
+    transit_heritage?: string;
+}
+interface Pois {
+    blue: string;
+    green: string;
+    lapis: string;
+    pink: string;
+    red: string;
+    slategray: string;
+    tangerine: string;
+    turquoise: string;
+}
+interface Landcover {
+    barren: string;
+    farmland: string;
+    forest: string;
+    glacier: string;
+    grassland: string;
+    scrub: string;
+    urban_area: string;
+    rock: string;
+    wetland: string;
+}
+interface Shields {
+    interstate_fill: string;
+    interstate_stroke: string;
+    interstate_text: string;
+    us_highway_fill: string;
+    us_highway_stroke: string;
+    us_highway_text: string;
+    state_fill: string;
+    state_stroke: string;
+    state_text: string;
+    county_fill: string;
+    county_stroke: string;
+    county_text: string;
+    default_fill: string;
+    default_stroke: string;
+    default_text: string;
+    banner_text: string;
+    banner_text_halo: string;
+}
+declare const LIGHT: Style;
+declare const DARK: Style;
+declare const GRAY: Style;
+declare const WARM: Style;
+
+/**
+ * Creates background and base terrain layers
+ */
+declare function createBackgroundLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates water layers (polygons and waterways)
+ */
+declare function createWaterLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates administrative boundary layers
+ */
+declare function createBoundaryLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates building layers
+ */
+declare function createBuildingLayers(source: string, style: Style): LayerSpecification[];
+
+type FontStyle = "regular" | "italic" | "bold" | "medium";
+interface LabelLayerConfig {
+    id: string;
+    source: string;
+    sourceLayer: string;
+    style: Style;
+    lang: string;
+    script?: string;
+    filter?: FilterSpecification;
+    minzoom?: number;
+    maxzoom?: number;
+    fontStyle?: FontStyle;
+    textSize?: number | ExpressionSpecification;
+    textColor: string;
+    haloColor: string;
+    haloWidth?: number;
+    letterSpacing?: number;
+    maxWidth?: number;
+    textTransform?: "uppercase" | "lowercase" | "none";
+    symbolPlacement?: "point" | "line" | "line-center";
+    useCountryName?: boolean;
+}
+declare function createLabelLayer(config: LabelLayerConfig): SymbolLayerSpecification;
+/**
+ * Creates water label layers (ocean, lakes, waterways)
+ */
+declare function createWaterLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates road label layers
+ */
+declare function createRoadLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates place label layers (countries, states, cities, subplaces)
+ */
+declare function createPlaceLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates address and island labels
+ */
+declare function createMiscLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+/**
+ * Creates landcover layers (natural features)
+ */
+declare function createLandcoverLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates park layers
+ */
+declare function createParkLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates landuse layers (human-made features)
+ */
+declare function createLanduseLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates aeroway layers
+ */
+declare function createAerowayLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates POI (points of interest) layers
+ * Uses tiered zoom levels for progressive disclosure
+ */
+declare function createPoiLayers(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+type RoadCategory = "other" | "minor" | "link" | "major" | "highway";
+type BrunnelType = "tunnel" | "bridge" | null;
+interface RoadLayerConfig {
+    source: string;
+    style: Style;
+    brunnel: BrunnelType;
+    category: RoadCategory;
+    isCasing: boolean;
+    minzoom?: number;
+    maxzoom?: number;
+}
+declare function createRoadLayer(config: RoadLayerConfig): LineLayerSpecification;
+/**
+ * Creates all tunnel road layers (casing + fill for each category)
+ */
+declare function createTunnelLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all regular (non-tunnel, non-bridge) road layers
+ */
+declare function createRoadLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all bridge road layers (casing + fill for each category)
+ */
+declare function createBridgeLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates pier layer (special road type)
+ */
+declare function createPierLayer(source: string, style: Style): LayerSpecification;
+
+/**
+ * Creates transit infrastructure layers (rail, bus, ferry)
+ * Progressive disclosure: main rail z10, freight z11, heritage/bus z13
+ */
+declare function createTransitLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Layer generation module
+ *
+ * This module coordinates the creation of all MapLibre GL layers
+ * from the component modules.
+ */
+
+/**
+ * Creates all non-label layers (fills, lines, symbols without text)
+ */
+declare function nolabelsLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all label layers (text symbols)
+ */
+declare function labelsLayers(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+/**
+ * Returns a named style by string identifier
+ * @throws Error if style name is not found
+ */
+declare function namedStyle(name: string): Style;
+/**
+ * Generates all MapLibre GL layers for a given style
+ * @param source - The source ID to use for layers
+ * @param style - The style theme to apply
+ * @param options - Optional configuration
+ * @param options.labelsOnly - If true, only generate label layers
+ * @param options.lang - Language code for labels (required for label layers)
+ */
+declare function layers(source: string, style: Style, options?: {
+    labelsOnly?: boolean;
+    lang?: string;
+}): LayerSpecification[];
+
+export { DARK, GRAY, LANGUAGE_SCRIPT_PAIRS, LIGHT, type Landcover, type Pois, STYLE_NAMES, type Shields, type Style, type StyleName, WARM, createAerowayLayers, createBackgroundLayers, createBoundaryLayers, createBridgeLayers, createBuildingLayers, createLabelLayer, createLandcoverLayers, createLanduseLayers, createMiscLabels, createParkLayers, createPierLayer, createPlaceLabels, createPoiLayers, createRoadLabels, createRoadLayer, createRoadLayers, createTransitLayers, createTunnelLayers, createWaterLabels, createWaterLayers, getCountryName, getMultilineName, isValidStyleName, labelsLayers, layers, namedStyle, nolabelsLayers };

package/dist/esm/index.d.ts

@@ -0,0 +1,325 @@
+import { LayerSpecification, FilterSpecification, ExpressionSpecification, SymbolLayerSpecification, LineLayerSpecification } from '@maplibre/maplibre-gl-style-spec';
+
+interface LanguageScriptPair {
+    lang: string;
+    full_name: string;
+    script: string;
+}
+declare const LANGUAGE_SCRIPT_PAIRS: LanguageScriptPair[];
+declare function getCountryName(lang: string, script?: string): (string | (string | string[])[] | {
+    "text-font": (string | string[])[];
+} | {
+    "text-font"?: undefined;
+})[];
+declare function getMultilineName(lang: string, script?: string, regular?: string): (string | (string | (string | (string | string[])[] | {
+    "text-font": (string | string[])[];
+} | {
+    "text-font"?: undefined;
+})[] | (string | (string | {
+    "text-font"?: undefined;
+} | (string | (string | (string | string[])[])[])[] | {
+    "text-font": (string | (string | string[])[])[];
+})[])[])[] | (string | (string | (string | string[])[] | {
+    "text-font": (string | (string | string[])[])[];
+} | {
+    "text-font"?: undefined;
+})[] | (string | (string | (string | (string | string[])[])[])[] | (string | (string | string[])[] | {
+    "text-font": (string | (string | string[])[])[];
+} | {
+    "text-font"?: undefined;
+})[])[])[])[];
+
+/**
+ * Valid style name strings
+ */
+declare const STYLE_NAMES: readonly ["light", "dark", "gray", "warm"];
+/**
+ * Type for valid style names
+ */
+type StyleName = (typeof STYLE_NAMES)[number];
+/**
+ * Type guard to check if a string is a valid style name
+ */
+declare function isValidStyleName(name: string): name is StyleName;
+interface Style {
+    background: string;
+    earth: string;
+    park_a: string;
+    park_b: string;
+    hospital: string;
+    industrial: string;
+    school: string;
+    wood_a: string;
+    wood_b: string;
+    pedestrian: string;
+    scrub_a: string;
+    scrub_b: string;
+    glacier: string;
+    sand: string;
+    beach: string;
+    aerodrome: string;
+    runway: string;
+    water: string;
+    zoo: string;
+    military: string;
+    tunnel_other_casing: string;
+    tunnel_minor_casing: string;
+    tunnel_link_casing: string;
+    tunnel_major_casing: string;
+    tunnel_highway_casing: string;
+    tunnel_other: string;
+    tunnel_minor: string;
+    tunnel_link: string;
+    tunnel_major: string;
+    tunnel_highway: string;
+    pier: string;
+    buildings: string;
+    minor_service_casing: string;
+    minor_casing: string;
+    link_casing: string;
+    major_casing_late: string;
+    highway_casing_late: string;
+    other: string;
+    minor_service: string;
+    minor_a: string;
+    minor_b: string;
+    link: string;
+    major_casing_early: string;
+    major: string;
+    highway_casing_early: string;
+    highway: string;
+    railway: string;
+    boundaries: string;
+    bridges_other_casing: string;
+    bridges_minor_casing: string;
+    bridges_link_casing: string;
+    bridges_major_casing: string;
+    bridges_highway_casing: string;
+    bridges_other: string;
+    bridges_minor: string;
+    bridges_link: string;
+    bridges_major: string;
+    bridges_highway: string;
+    roads_label_minor: string;
+    roads_label_minor_halo: string;
+    roads_label_major: string;
+    roads_label_major_halo: string;
+    ocean_label: string;
+    subplace_label: string;
+    subplace_label_halo: string;
+    city_label: string;
+    city_label_halo: string;
+    state_label: string;
+    state_label_halo: string;
+    country_label: string;
+    address_label: string;
+    address_label_halo: string;
+    regular?: string;
+    bold?: string;
+    italic?: string;
+    medium?: string;
+    pois?: Pois;
+    landcover?: Landcover;
+    shields?: Shields;
+    transit_rail?: string;
+    transit_freight?: string;
+    transit_bus?: string;
+    transit_heritage?: string;
+}
+interface Pois {
+    blue: string;
+    green: string;
+    lapis: string;
+    pink: string;
+    red: string;
+    slategray: string;
+    tangerine: string;
+    turquoise: string;
+}
+interface Landcover {
+    barren: string;
+    farmland: string;
+    forest: string;
+    glacier: string;
+    grassland: string;
+    scrub: string;
+    urban_area: string;
+    rock: string;
+    wetland: string;
+}
+interface Shields {
+    interstate_fill: string;
+    interstate_stroke: string;
+    interstate_text: string;
+    us_highway_fill: string;
+    us_highway_stroke: string;
+    us_highway_text: string;
+    state_fill: string;
+    state_stroke: string;
+    state_text: string;
+    county_fill: string;
+    county_stroke: string;
+    county_text: string;
+    default_fill: string;
+    default_stroke: string;
+    default_text: string;
+    banner_text: string;
+    banner_text_halo: string;
+}
+declare const LIGHT: Style;
+declare const DARK: Style;
+declare const GRAY: Style;
+declare const WARM: Style;
+
+/**
+ * Creates background and base terrain layers
+ */
+declare function createBackgroundLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates water layers (polygons and waterways)
+ */
+declare function createWaterLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates administrative boundary layers
+ */
+declare function createBoundaryLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates building layers
+ */
+declare function createBuildingLayers(source: string, style: Style): LayerSpecification[];
+
+type FontStyle = "regular" | "italic" | "bold" | "medium";
+interface LabelLayerConfig {
+    id: string;
+    source: string;
+    sourceLayer: string;
+    style: Style;
+    lang: string;
+    script?: string;
+    filter?: FilterSpecification;
+    minzoom?: number;
+    maxzoom?: number;
+    fontStyle?: FontStyle;
+    textSize?: number | ExpressionSpecification;
+    textColor: string;
+    haloColor: string;
+    haloWidth?: number;
+    letterSpacing?: number;
+    maxWidth?: number;
+    textTransform?: "uppercase" | "lowercase" | "none";
+    symbolPlacement?: "point" | "line" | "line-center";
+    useCountryName?: boolean;
+}
+declare function createLabelLayer(config: LabelLayerConfig): SymbolLayerSpecification;
+/**
+ * Creates water label layers (ocean, lakes, waterways)
+ */
+declare function createWaterLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates road label layers
+ */
+declare function createRoadLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates place label layers (countries, states, cities, subplaces)
+ */
+declare function createPlaceLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+/**
+ * Creates address and island labels
+ */
+declare function createMiscLabels(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+/**
+ * Creates landcover layers (natural features)
+ */
+declare function createLandcoverLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates park layers
+ */
+declare function createParkLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates landuse layers (human-made features)
+ */
+declare function createLanduseLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates aeroway layers
+ */
+declare function createAerowayLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Creates POI (points of interest) layers
+ * Uses tiered zoom levels for progressive disclosure
+ */
+declare function createPoiLayers(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+type RoadCategory = "other" | "minor" | "link" | "major" | "highway";
+type BrunnelType = "tunnel" | "bridge" | null;
+interface RoadLayerConfig {
+    source: string;
+    style: Style;
+    brunnel: BrunnelType;
+    category: RoadCategory;
+    isCasing: boolean;
+    minzoom?: number;
+    maxzoom?: number;
+}
+declare function createRoadLayer(config: RoadLayerConfig): LineLayerSpecification;
+/**
+ * Creates all tunnel road layers (casing + fill for each category)
+ */
+declare function createTunnelLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all regular (non-tunnel, non-bridge) road layers
+ */
+declare function createRoadLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all bridge road layers (casing + fill for each category)
+ */
+declare function createBridgeLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates pier layer (special road type)
+ */
+declare function createPierLayer(source: string, style: Style): LayerSpecification;
+
+/**
+ * Creates transit infrastructure layers (rail, bus, ferry)
+ * Progressive disclosure: main rail z10, freight z11, heritage/bus z13
+ */
+declare function createTransitLayers(source: string, style: Style): LayerSpecification[];
+
+/**
+ * Layer generation module
+ *
+ * This module coordinates the creation of all MapLibre GL layers
+ * from the component modules.
+ */
+
+/**
+ * Creates all non-label layers (fills, lines, symbols without text)
+ */
+declare function nolabelsLayers(source: string, style: Style): LayerSpecification[];
+/**
+ * Creates all label layers (text symbols)
+ */
+declare function labelsLayers(source: string, style: Style, lang: string, script?: string): LayerSpecification[];
+
+/**
+ * Returns a named style by string identifier
+ * @throws Error if style name is not found
+ */
+declare function namedStyle(name: string): Style;
+/**
+ * Generates all MapLibre GL layers for a given style
+ * @param source - The source ID to use for layers
+ * @param style - The style theme to apply
+ * @param options - Optional configuration
+ * @param options.labelsOnly - If true, only generate label layers
+ * @param options.lang - Language code for labels (required for label layers)
+ */
+declare function layers(source: string, style: Style, options?: {
+    labelsOnly?: boolean;
+    lang?: string;
+}): LayerSpecification[];
+
+export { DARK, GRAY, LANGUAGE_SCRIPT_PAIRS, LIGHT, type Landcover, type Pois, STYLE_NAMES, type Shields, type Style, type StyleName, WARM, createAerowayLayers, createBackgroundLayers, createBoundaryLayers, createBridgeLayers, createBuildingLayers, createLabelLayer, createLandcoverLayers, createLanduseLayers, createMiscLabels, createParkLayers, createPierLayer, createPlaceLabels, createPoiLayers, createRoadLabels, createRoadLayer, createRoadLayers, createTransitLayers, createTunnelLayers, createWaterLabels, createWaterLayers, getCountryName, getMultilineName, isValidStyleName, labelsLayers, layers, namedStyle, nolabelsLayers };