@maptiler/client 2.6.0 → 2.7.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1355,17 +1355,17 @@ declare function expandMapStyle(style: any): string;
1355
1355
  * Type for object containing style details
1356
1356
  */
1357
1357
  type MapStylePreset = {
1358
- referenceStyleID: string;
1359
- name: string;
1360
- description: string;
1361
- variants: Array<{
1362
- deprecated?: boolean;
1363
- deprecationMessage?: string;
1364
- id: string;
1365
- name: string;
1366
- variantType: string;
1367
- description: string;
1368
- imageURL: string;
1358
+ readonly referenceStyleID: string;
1359
+ readonly name: string;
1360
+ readonly description: string;
1361
+ readonly variants: ReadonlyArray<{
1362
+ readonly id: string;
1363
+ readonly name: string;
1364
+ readonly variantType: string;
1365
+ readonly description: string;
1366
+ readonly imageURL: string;
1367
+ readonly deprecated?: boolean;
1368
+ readonly deprecationMessage?: string;
1369
1369
  }>;
1370
1370
  };
1371
1371
  /**
@@ -1561,338 +1561,723 @@ declare class ReferenceMapStyle {
1561
1561
  */
1562
1562
  getDefaultVariant(): MapStyleVariant;
1563
1563
  }
1564
- /**
1565
- * All the styles and variants maintained by MapTiler.
1566
- */
1567
- type MapStyleType = {
1568
- /**
1569
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings
1570
- */
1571
- STREETS: MapStyleType["STREETS_V2"];
1572
- /**
1573
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings
1574
- */
1575
- STREETS_V2: ReferenceMapStyle & {
1576
- /**
1577
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings.
1578
- */
1579
- DEFAULT: MapStyleVariant;
1580
- /**
1581
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, in dark mode.
1582
- */
1583
- DARK: MapStyleVariant;
1584
- /**
1585
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, in light mode.
1586
- */
1587
- LIGHT: MapStyleVariant;
1588
- /**
1589
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, in night mode.
1590
- */
1591
- NIGHT: MapStyleVariant;
1592
- /**
1593
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, with a pastel color palette.
1594
- */
1595
- PASTEL: MapStyleVariant;
1596
- };
1597
- /**
1598
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings
1599
- */
1600
- STREETS_V4: ReferenceMapStyle & {
1601
- /**
1602
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings.
1603
- */
1604
- DEFAULT: MapStyleVariant;
1605
- /**
1606
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, in dark mode.
1607
- */
1608
- DARK: MapStyleVariant;
1609
- /**
1610
- * Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings, with a pastel color palette.
1611
- */
1612
- PASTEL: MapStyleVariant;
1613
- };
1614
- BASE_V4: ReferenceMapStyle & {
1615
- /**
1616
- * Light and informative map, for general use.
1617
- */
1618
- DEFAULT: MapStyleVariant;
1619
- /**
1620
- * Darker version of the base style, for night use.
1621
- */
1622
- DARK: MapStyleVariant;
1623
- /**
1624
- * Light version of the base style, for day use.
1625
- */
1626
- LIGHT: MapStyleVariant;
1627
- /**
1628
- * A clear and informative map, for general use.
1629
- */
1630
- AI: MapStyleVariant;
1631
- };
1632
- /**
1633
- * Suitable for outdoor activities. With elevation isolines and hillshading.
1634
- */
1635
- OUTDOOR: ReferenceMapStyle & {
1636
- /**
1637
- * Suitable for outdoor activities. With elevation isolines and hillshading.
1638
- */
1639
- DEFAULT: MapStyleVariant;
1640
- /**
1641
- * Suitable for outdoor activities. With elevation isolines and hillshading, in dark mode.
1642
- */
1643
- DARK: MapStyleVariant;
1644
- };
1645
- /**
1646
- * Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading.
1647
- */
1648
- WINTER: ReferenceMapStyle & {
1649
- /**
1650
- * Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading.
1651
- */
1652
- DEFAULT: MapStyleVariant;
1653
- /**
1654
- * Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading, in dark mode.
1655
- */
1656
- DARK: MapStyleVariant;
1657
- };
1658
- /**
1659
- * High resolution imagery only, without any label.
1660
- */
1661
- SATELLITE: ReferenceMapStyle & {
1662
- /**
1663
- * High resolution imagery only, without any label.
1664
- */
1665
- DEFAULT: MapStyleVariant;
1666
- };
1667
- /**
1668
- * High resolution imagery with labels, political borders and roads.
1669
- */
1670
- HYBRID: ReferenceMapStyle & {
1671
- /**
1672
- * High resolution imagery with labels, political borders and roads.
1673
- */
1674
- DEFAULT: MapStyleVariant;
1675
- };
1676
- /**
1677
- * A minimalist street-oriented style without POI
1678
- */
1679
- BASIC: ReferenceMapStyle & {
1680
- /**
1681
- * A minimalist street-oriented style without POI
1682
- */
1683
- DEFAULT: MapStyleVariant;
1684
- /**
1685
- * A minimalist street-oriented style without POI, in dark mode
1686
- */
1687
- DARK: MapStyleVariant;
1688
- /**
1689
- * A minimalist street-oriented style without POI, in light mode
1690
- */
1691
- LIGHT: MapStyleVariant;
1692
- };
1693
- /**
1694
- * A minimalist street-oriented style without POI
1695
- */
1696
- BASIC_V2: ReferenceMapStyle & {
1697
- /**
1698
- * A minimalist street-oriented style without POI
1699
- */
1700
- DEFAULT: MapStyleVariant;
1701
- /**
1702
- * A minimalist street-oriented style without POI, in dark mode
1703
- */
1704
- DARK: MapStyleVariant;
1705
- /**
1706
- * A minimalist street-oriented style without POI, in light mode
1707
- */
1708
- LIGHT: MapStyleVariant;
1709
- };
1710
- /**
1711
- * A bright street-oriented style, a nice alternative to `streets`
1712
- */
1713
- BRIGHT: ReferenceMapStyle & {
1714
- /**
1715
- * A bright street-oriented style, a nice alternative to `streets`
1716
- */
1717
- DEFAULT: MapStyleVariant;
1718
- /**
1719
- * A bright street-oriented style, a nice alternative to `streets`, in dark mode
1720
- */
1721
- DARK: MapStyleVariant;
1722
- /**
1723
- * A bright street-oriented style, a nice alternative to `streets`, in light mode
1724
- */
1725
- LIGHT: MapStyleVariant;
1726
- /**
1727
- * A bright street-oriented style, a nice alternative to `streets`, with a soft pastel color palette
1728
- */
1729
- PASTEL: MapStyleVariant;
1730
- };
1731
- /**
1732
- * Classic OpenStreetMap style
1733
- */
1734
- OPENSTREETMAP: ReferenceMapStyle & {
1735
- DEFAULT: MapStyleVariant;
1736
- };
1737
- /**
1738
- * A nice high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details
1739
- */
1740
- TOPO: ReferenceMapStyle & {
1741
- /**
1742
- * A nice high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details
1743
- */
1744
- DEFAULT: MapStyleVariant;
1745
- /**
1746
- * A nice high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details, in dark mode
1747
- */
1748
- DARK: MapStyleVariant;
1749
- /**
1750
- * A nice high-contrast, and high saturation alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details
1751
- */
1752
- SHINY: MapStyleVariant;
1753
- /**
1754
- * A nice low-contrast, alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details, using a soft pastel color palette
1755
- */
1756
- PASTEL: MapStyleVariant;
1757
- /**
1758
- * A nice very high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details
1759
- */
1760
- TOPOGRAPHIQUE: MapStyleVariant;
1761
- };
1762
- /**
1763
- * A nice alternative to `streets` with a soft color palette
1764
- */
1765
- VOYAGER: ReferenceMapStyle & {
1766
- /**
1767
- * A nice alternative to `streets` with a soft color palette
1768
- *
1769
- */
1770
- DEFAULT: MapStyleVariant;
1771
- /**
1772
- * A nice alternative to `streets`, in very dark mode
1773
- */
1774
- DARK: MapStyleVariant;
1775
- /**
1776
- * A nice alternative to `streets`, in light mode
1777
- */
1778
- LIGHT: MapStyleVariant;
1779
- /**
1780
- * A nice alternative to `streets` with a soft sepia color palette and vintage look
1781
- */
1782
- VINTAGE: MapStyleVariant;
1783
- };
1784
- /**
1785
- * A bold very high contrast black and white (no gray!) style for the city
1786
- */
1787
- TONER: ReferenceMapStyle & {
1788
- /**
1789
- * A bold very high contrast black and white (no gray!) style for the city
1790
- */
1791
- DEFAULT: MapStyleVariant;
1792
- /**
1793
- * A bold very high contrast black and white (no gray!) style for the city, without any label
1794
- */
1795
- BACKGROUND: MapStyleVariant;
1796
- /**
1797
- * A bold very high contrast, yet faded, style for the city
1798
- */
1799
- LITE: MapStyleVariant;
1800
- /**
1801
- * A bold very high contrast black and white (no gray!) style for the city, with no building, only roads!
1802
- */
1803
- LINES: MapStyleVariant;
1804
- };
1805
- /**
1806
- * Minimalist style, perfect for data visualization
1807
- */
1808
- DATAVIZ: ReferenceMapStyle & {
1809
- /**
1810
- * Minimalist style, perfect for data visualization
1811
- */
1812
- DEFAULT: MapStyleVariant;
1813
- /**
1814
- * Minimalist style, perfect for data visualization in dark mode
1815
- */
1816
- DARK: MapStyleVariant;
1817
- /**
1818
- * Minimalist style, perfect for data visualization in light mode
1819
- */
1820
- LIGHT: MapStyleVariant;
1821
- };
1822
- /**
1823
- * Explore deep see trenches and mountains, with isolines and depth labels
1824
- */
1825
- OCEAN: ReferenceMapStyle & {
1826
- /**
1827
- * Explore deep see trenches and mountains, with isolines and depth labels
1828
- */
1829
- DEFAULT: MapStyleVariant;
1830
- };
1831
- /**
1832
- * Neutral greyscale style with hillshading suitable for colorful terrain-aware visualization
1833
- */
1834
- BACKDROP: ReferenceMapStyle & {
1835
- /**
1836
- * Neutral greyscale style with hillshading suitable for colorful terrain-aware visualization
1837
- */
1838
- DEFAULT: MapStyleVariant;
1839
- /**
1840
- * Dark greyscale style with hillshading suitable for colorful terrain-aware visualization
1841
- */
1842
- DARK: MapStyleVariant;
1843
- /**
1844
- * Light greyscale style with hillshading suitable for colorful terrain-aware visualization
1845
- */
1846
- LIGHT: MapStyleVariant;
1847
- };
1848
- LANDSCAPE: MapStyleType["LANDSCAPE_V2"];
1849
- LANDSCAPE_V2: ReferenceMapStyle & {
1850
- /**
1851
- * Light terrain map for data overlays and visualisations
1852
- */
1853
- DEFAULT: MapStyleVariant;
1854
- /**
1855
- * Dark terrain map for data overlays and visualisations
1856
- */
1857
- DARK: MapStyleVariant;
1858
- /**
1859
- * Vivid terrain map for data overlays and visualisations
1860
- */
1861
- VIVID: MapStyleVariant;
1862
- };
1863
- LANDSCAPE_V4: ReferenceMapStyle & {
1864
- /**
1865
- * Light terrain map for data overlays and visualisations
1866
- */
1867
- DEFAULT: MapStyleVariant;
1868
- /**
1869
- * Dark terrain map for data overlays and visualisations
1870
- */
1871
- DARK: MapStyleVariant;
1872
- /**
1873
- * Vivid terrain map for data overlays and visualisations
1874
- */
1875
- VIVID: MapStyleVariant;
1876
- };
1877
- /**
1878
- * Watercolor map for creative use
1879
- */
1880
- AQUARELLE: ReferenceMapStyle & {
1881
- /**
1882
- * Watercolor map for creative use
1883
- */
1884
- DEFAULT: MapStyleVariant;
1885
- /**
1886
- * Dark watercolor map for creative use
1887
- */
1888
- DARK: MapStyleVariant;
1889
- /**
1890
- * Vivid watercolor map for creative use
1891
- */
1892
- VIVID: MapStyleVariant;
1564
+ declare const MAP_STYLE_CONFIG: readonly [{
1565
+ readonly referenceStyleID: "STREETS_V2";
1566
+ readonly name: "Streets";
1567
+ readonly description: "";
1568
+ readonly variants: readonly [{
1569
+ readonly id: "streets-v2";
1570
+ readonly name: "Default v2";
1571
+ readonly variantType: "DEFAULT";
1572
+ readonly description: "";
1573
+ readonly imageURL: "";
1574
+ readonly deprecated: true;
1575
+ readonly deprecationMessage: "\"streets-v2\" is deprecated, use \"streets-v4\" instead";
1576
+ }, {
1577
+ readonly id: "streets-v2-dark";
1578
+ readonly name: "Dark v2";
1579
+ readonly variantType: "DARK";
1580
+ readonly description: "";
1581
+ readonly imageURL: "";
1582
+ readonly deprecated: true;
1583
+ readonly deprecationMessage: "\"streets-v2-dark\" is deprecated, use \"streets-v4-dark\" instead";
1584
+ }, {
1585
+ readonly id: "streets-v2-light";
1586
+ readonly name: "Light v2";
1587
+ readonly variantType: "LIGHT";
1588
+ readonly description: "";
1589
+ readonly imageURL: "";
1590
+ readonly deprecated: true;
1591
+ readonly deprecationMessage: "\"streets-v2-light\" is deprecated, use \"streets-v4-light\" instead";
1592
+ }, {
1593
+ readonly id: "streets-v2-night";
1594
+ readonly name: "Night v2";
1595
+ readonly variantType: "NIGHT";
1596
+ readonly description: "";
1597
+ readonly imageURL: "";
1598
+ readonly deprecated: true;
1599
+ readonly deprecationMessage: "\"streets-v2-night\" is deprecated, use \"streets-v4-night\" instead";
1600
+ }, {
1601
+ readonly id: "streets-v2-pastel";
1602
+ readonly name: "Pastel v2";
1603
+ readonly variantType: "PASTEL";
1604
+ readonly description: "";
1605
+ readonly imageURL: "";
1606
+ readonly deprecated: true;
1607
+ readonly deprecationMessage: "\"streets-v2-pastel\" is deprecated, use \"streets-v4-pastel\" instead";
1608
+ }];
1609
+ }, {
1610
+ readonly referenceStyleID: "STREETS_V4";
1611
+ readonly name: "Streets";
1612
+ readonly description: "";
1613
+ readonly variants: readonly [{
1614
+ readonly id: "streets-v4";
1615
+ readonly name: "Default";
1616
+ readonly variantType: "DEFAULT";
1617
+ readonly description: "";
1618
+ readonly imageURL: "";
1619
+ }, {
1620
+ readonly id: "streets-v4-dark";
1621
+ readonly name: "Dark";
1622
+ readonly variantType: "DARK";
1623
+ readonly description: "";
1624
+ readonly imageURL: "";
1625
+ }, {
1626
+ readonly id: "streets-v4-pastel";
1627
+ readonly name: "Pastel";
1628
+ readonly variantType: "PASTEL";
1629
+ readonly description: "";
1630
+ readonly imageURL: "";
1631
+ }];
1632
+ }, {
1633
+ readonly referenceStyleID: "BASE_V4";
1634
+ readonly name: "Base";
1635
+ readonly description: "";
1636
+ readonly variants: readonly [{
1637
+ readonly id: "base-v4";
1638
+ readonly name: "Default";
1639
+ readonly variantType: "DEFAULT";
1640
+ readonly description: "";
1641
+ readonly imageURL: "";
1642
+ }, {
1643
+ readonly id: "base-v4-dark";
1644
+ readonly name: "Dark";
1645
+ readonly variantType: "DARK";
1646
+ readonly description: "";
1647
+ readonly imageURL: "";
1648
+ }, {
1649
+ readonly id: "base-v4-light";
1650
+ readonly name: "Light";
1651
+ readonly variantType: "LIGHT";
1652
+ readonly description: "";
1653
+ readonly imageURL: "";
1654
+ }, {
1655
+ readonly id: "base-v4-ai";
1656
+ readonly name: "Base AI";
1657
+ readonly variantType: "AI";
1658
+ readonly description: "";
1659
+ readonly imageURL: "";
1660
+ }];
1661
+ }, {
1662
+ readonly referenceStyleID: "OUTDOOR";
1663
+ readonly name: "Outdoor";
1664
+ readonly description: "";
1665
+ readonly variants: readonly [{
1666
+ readonly id: "outdoor-v2";
1667
+ readonly name: "Default";
1668
+ readonly variantType: "DEFAULT";
1669
+ readonly description: "";
1670
+ readonly imageURL: "";
1671
+ readonly deprecated: true;
1672
+ readonly deprecationMessage: "\"outdoor-v2\" is deprecated, use \"outdoor-v4\" instead";
1673
+ }, {
1674
+ readonly id: "outdoor-v2-dark";
1675
+ readonly name: "Dark";
1676
+ readonly variantType: "DARK";
1677
+ readonly description: "";
1678
+ readonly imageURL: "";
1679
+ readonly deprecated: true;
1680
+ readonly deprecationMessage: "\"outdoor-v2-dark\" is deprecated, use \"outdoor-v4-dark\" instead";
1681
+ }];
1682
+ }, {
1683
+ readonly referenceStyleID: "WINTER_V2";
1684
+ readonly name: "Winter";
1685
+ readonly description: "";
1686
+ readonly variants: readonly [{
1687
+ readonly id: "winter-v2";
1688
+ readonly name: "Default";
1689
+ readonly variantType: "DEFAULT";
1690
+ readonly description: "";
1691
+ readonly imageURL: "";
1692
+ }, {
1693
+ readonly id: "winter-v2-dark";
1694
+ readonly name: "Dark";
1695
+ readonly variantType: "DARK";
1696
+ readonly description: "";
1697
+ readonly imageURL: "";
1698
+ }];
1699
+ }, {
1700
+ readonly referenceStyleID: "WINTER_V4";
1701
+ readonly name: "Winter";
1702
+ readonly description: "";
1703
+ readonly variants: readonly [{
1704
+ readonly id: "winter-v4";
1705
+ readonly name: "Default";
1706
+ readonly variantType: "DEFAULT";
1707
+ readonly description: "";
1708
+ readonly imageURL: "";
1709
+ }, {
1710
+ readonly id: "winter-v4-dark";
1711
+ readonly name: "Dark";
1712
+ readonly variantType: "DARK";
1713
+ readonly description: "";
1714
+ readonly imageURL: "";
1715
+ }];
1716
+ }, {
1717
+ readonly referenceStyleID: "SATELLITE_V2";
1718
+ readonly name: "Satellite";
1719
+ readonly description: "";
1720
+ readonly variants: readonly [{
1721
+ readonly id: "satellite";
1722
+ readonly name: "Default";
1723
+ readonly variantType: "DEFAULT";
1724
+ readonly description: "";
1725
+ readonly imageURL: "";
1726
+ readonly deprecated: true;
1727
+ readonly deprecationMessage: "\"satellite\" is deprecated, use \"satellite-v4\" instead";
1728
+ }];
1729
+ }, {
1730
+ readonly referenceStyleID: "HYBRID_V2";
1731
+ readonly name: "Hybrid";
1732
+ readonly description: "";
1733
+ readonly variants: readonly [{
1734
+ readonly id: "hybrid";
1735
+ readonly name: "Default";
1736
+ readonly variantType: "DEFAULT";
1737
+ readonly description: "";
1738
+ readonly imageURL: "";
1739
+ }];
1740
+ }, {
1741
+ readonly referenceStyleID: "HYBRID_V4";
1742
+ readonly name: "Hybrid";
1743
+ readonly description: "";
1744
+ readonly variants: readonly [{
1745
+ readonly id: "hybrid-v4";
1746
+ readonly name: "Default";
1747
+ readonly variantType: "DEFAULT";
1748
+ readonly imageURL: "";
1749
+ }, {
1750
+ readonly id: "hybrid-v4-dark";
1751
+ readonly name: "Dark";
1752
+ readonly variantType: "DARK";
1753
+ readonly imageURL: "";
1754
+ }];
1755
+ }, {
1756
+ readonly referenceStyleID: "BASIC_V2";
1757
+ readonly name: "Basic";
1758
+ readonly description: "";
1759
+ readonly variants: readonly [{
1760
+ readonly id: "basic-v2";
1761
+ readonly name: "Default";
1762
+ readonly variantType: "DEFAULT";
1763
+ readonly description: "";
1764
+ readonly imageURL: "";
1765
+ readonly deprecated: true;
1766
+ readonly deprecationMessage: "\"basic-v2\" is deprecated, use \"base-v4\" instead";
1767
+ }, {
1768
+ readonly id: "basic-v2-dark";
1769
+ readonly name: "Dark";
1770
+ readonly variantType: "DARK";
1771
+ readonly description: "";
1772
+ readonly imageURL: "";
1773
+ readonly deprecationMessage: "\"basic-v2\" is deprecated, use \"base-v4\" instead";
1774
+ }, {
1775
+ readonly id: "basic-v2-light";
1776
+ readonly name: "Light";
1777
+ readonly variantType: "LIGHT";
1778
+ readonly description: "";
1779
+ readonly imageURL: "";
1780
+ readonly deprecated: true;
1781
+ readonly deprecationMessage: "\"basic-v2\" is deprecated, use \"base-v4\" instead";
1782
+ }];
1783
+ }, {
1784
+ readonly referenceStyleID: "BRIGHT";
1785
+ readonly name: "Bright";
1786
+ readonly description: "";
1787
+ readonly variants: readonly [{
1788
+ readonly id: "bright-v2";
1789
+ readonly name: "Default";
1790
+ readonly variantType: "DEFAULT";
1791
+ readonly description: "";
1792
+ readonly imageURL: "";
1793
+ }, {
1794
+ readonly id: "bright-v2-dark";
1795
+ readonly name: "Dark";
1796
+ readonly variantType: "DARK";
1797
+ readonly description: "";
1798
+ readonly imageURL: "";
1799
+ }, {
1800
+ readonly id: "bright-v2-light";
1801
+ readonly name: "Light";
1802
+ readonly variantType: "LIGHT";
1803
+ readonly description: "";
1804
+ readonly imageURL: "";
1805
+ }, {
1806
+ readonly id: "bright-v2-pastel";
1807
+ readonly name: "Pastel";
1808
+ readonly variantType: "PASTEL";
1809
+ readonly description: "";
1810
+ readonly imageURL: "";
1811
+ }];
1812
+ }, {
1813
+ readonly referenceStyleID: "OPENSTREETMAP_V2";
1814
+ readonly name: "OpenStreetMap";
1815
+ readonly description: "";
1816
+ readonly variants: readonly [{
1817
+ readonly id: "openstreetmap";
1818
+ readonly name: "Default";
1819
+ readonly variantType: "DEFAULT";
1820
+ readonly description: "";
1821
+ readonly imageURL: "";
1822
+ }, {
1823
+ readonly id: "openstreetmap-dark";
1824
+ readonly name: "Dark";
1825
+ readonly variantType: "DARK";
1826
+ readonly description: "";
1827
+ readonly imageURL: "";
1828
+ }];
1829
+ }, {
1830
+ readonly referenceStyleID: "TOPO_V2";
1831
+ readonly name: "Topo";
1832
+ readonly description: "";
1833
+ readonly variants: readonly [{
1834
+ readonly id: "topo-v2";
1835
+ readonly name: "Default";
1836
+ readonly variantType: "DEFAULT";
1837
+ readonly description: "";
1838
+ readonly imageURL: "";
1839
+ readonly deprecated: true;
1840
+ readonly deprecationMessage: "\"topo-v2\" is deprecated, use \"topo-v4\" instead";
1841
+ }, {
1842
+ readonly id: "topo-v2-dark";
1843
+ readonly name: "Dark";
1844
+ readonly variantType: "DARK";
1845
+ readonly description: "";
1846
+ readonly imageURL: "";
1847
+ readonly deprecated: true;
1848
+ readonly deprecationMessage: "\"topo-v2-dark\" is deprecated, use \"topo-v4-dark\" instead";
1849
+ }, {
1850
+ readonly id: "topo-v2-shiny";
1851
+ readonly name: "Shiny";
1852
+ readonly variantType: "SHINY";
1853
+ readonly description: "";
1854
+ readonly imageURL: "";
1855
+ readonly deprecated: true;
1856
+ }, {
1857
+ readonly id: "topo-v2-pastel";
1858
+ readonly name: "Pastel";
1859
+ readonly variantType: "PASTEL";
1860
+ readonly description: "";
1861
+ readonly imageURL: "";
1862
+ readonly deprecated: true;
1863
+ readonly deprecationMessage: "\"topo-v2-pastel\" is deprecated, use \"topo-v4-pastel\" instead";
1864
+ }, {
1865
+ readonly id: "topo-v2-topographique";
1866
+ readonly name: "Topographique";
1867
+ readonly variantType: "TOPOGRAPHIQUE";
1868
+ readonly description: "";
1869
+ readonly imageURL: "";
1870
+ readonly deprecated: true;
1871
+ readonly deprecationMessage: "\"topo-v2-topographique\" is deprecated, use \"topo-v4-topographique\" instead";
1872
+ }];
1873
+ }, {
1874
+ readonly referenceStyleID: "VOYAGER_V2";
1875
+ readonly name: "Voyager";
1876
+ readonly description: "";
1877
+ readonly variants: readonly [{
1878
+ readonly id: "voyager-v2";
1879
+ readonly name: "Default";
1880
+ readonly deprecated: true;
1881
+ readonly variantType: "DEFAULT";
1882
+ readonly description: "";
1883
+ readonly imageURL: "";
1884
+ }, {
1885
+ readonly id: "voyager-v2-darkmatter";
1886
+ readonly name: "Darkmatter";
1887
+ readonly deprecated: true;
1888
+ readonly variantType: "DARK";
1889
+ readonly description: "";
1890
+ readonly imageURL: "";
1891
+ }, {
1892
+ readonly id: "voyager-v2-positron";
1893
+ readonly name: "Positron";
1894
+ readonly deprecated: true;
1895
+ readonly variantType: "LIGHT";
1896
+ readonly description: "";
1897
+ readonly imageURL: "";
1898
+ }, {
1899
+ readonly id: "voyager-v2-vintage";
1900
+ readonly name: "Vintage";
1901
+ readonly deprecated: true;
1902
+ readonly variantType: "VINTAGE";
1903
+ readonly description: "";
1904
+ readonly imageURL: "";
1905
+ }];
1906
+ }, {
1907
+ readonly referenceStyleID: "TONER_V2";
1908
+ readonly name: "Toner";
1909
+ readonly description: "";
1910
+ readonly deprecated: true;
1911
+ readonly deprecationMessage: "\"toner-v2\" is deprecated, and will be no longer be a default style in the future";
1912
+ readonly variants: readonly [{
1913
+ readonly id: "toner-v2";
1914
+ readonly name: "Default";
1915
+ readonly variantType: "DEFAULT";
1916
+ readonly description: "";
1917
+ readonly imageURL: "";
1918
+ readonly deprecated: true;
1919
+ readonly deprecationMessage: "\"toner-v2\" is deprecated, and may be removed in future versions.";
1920
+ }, {
1921
+ readonly id: "toner-v2-background";
1922
+ readonly name: "Background";
1923
+ readonly variantType: "BACKGROUND";
1924
+ readonly deprecated: true;
1925
+ readonly description: "";
1926
+ readonly imageURL: "";
1927
+ readonly deprecationMessage: "\"toner-v2-background\" is deprecated, and may be removed in future versions.";
1928
+ }, {
1929
+ readonly id: "toner-v2-lite";
1930
+ readonly name: "Lite";
1931
+ readonly variantType: "LITE";
1932
+ readonly description: "";
1933
+ readonly imageURL: "";
1934
+ readonly deprecated: true;
1935
+ readonly deprecationMessage: "\"toner-v2-lite\" is deprecated, and may be removed in future versions.";
1936
+ }, {
1937
+ readonly id: "toner-v2-lines";
1938
+ readonly name: "Lines";
1939
+ readonly variantType: "LINES";
1940
+ readonly description: "";
1941
+ readonly imageURL: "";
1942
+ readonly deprecated: true;
1943
+ readonly deprecationMessage: "\"toner-v2-lines\" is deprecated, and may be removed in future versions.";
1944
+ }];
1945
+ }, {
1946
+ readonly referenceStyleID: "DATAVIZ_V2";
1947
+ readonly name: "Dataviz";
1948
+ readonly description: "";
1949
+ readonly variants: readonly [{
1950
+ readonly id: "dataviz";
1951
+ readonly name: "Default";
1952
+ readonly variantType: "DEFAULT";
1953
+ readonly description: "";
1954
+ readonly imageURL: "";
1955
+ readonly deprecated: true;
1956
+ readonly deprecationMessage: "\"dataviz\" is deprecated, use \"dataviz-v4\" instead";
1957
+ }, {
1958
+ readonly id: "dataviz-dark";
1959
+ readonly name: "Dark";
1960
+ readonly variantType: "DARK";
1961
+ readonly description: "";
1962
+ readonly imageURL: "";
1963
+ readonly deprecated: true;
1964
+ readonly deprecationMessage: "\"dataviz-dark\" is deprecated, use \"dataviz-v4-dark\" instead";
1965
+ }, {
1966
+ readonly id: "dataviz-light";
1967
+ readonly name: "Light";
1968
+ readonly variantType: "LIGHT";
1969
+ readonly description: "";
1970
+ readonly imageURL: "";
1971
+ readonly deprecated: true;
1972
+ readonly deprecationMessage: "\"dataviz-light\" is deprecated, use \"dataviz-v4-light\" instead";
1973
+ }];
1974
+ }, {
1975
+ readonly referenceStyleID: "BACKDROP_V2";
1976
+ readonly name: "Backdrop";
1977
+ readonly description: "";
1978
+ readonly variants: readonly [{
1979
+ readonly id: "backdrop";
1980
+ readonly name: "Default";
1981
+ readonly variantType: "DEFAULT";
1982
+ readonly description: "";
1983
+ readonly imageURL: "";
1984
+ readonly deprecated: true;
1985
+ readonly deprecationMessage: "\"backdrop\" is deprecated, use \"backdrop-v4\" instead";
1986
+ }, {
1987
+ readonly id: "backdrop-dark";
1988
+ readonly name: "Dark";
1989
+ readonly variantType: "DARK";
1990
+ readonly description: "";
1991
+ readonly imageURL: "";
1992
+ readonly deprecated: true;
1993
+ readonly deprecationMessage: "\"backdrop-dark\" is deprecated, use \"backdrop-v4-dark\" instead";
1994
+ }, {
1995
+ readonly id: "backdrop-light";
1996
+ readonly name: "Light";
1997
+ readonly variantType: "LIGHT";
1998
+ readonly description: "";
1999
+ readonly imageURL: "";
2000
+ readonly deprecated: true;
2001
+ readonly deprecationMessage: "\"backdrop-light\" is deprecated, use \"backdrop-v4-light\" instead";
2002
+ }];
2003
+ }, {
2004
+ readonly referenceStyleID: "OCEAN_V2";
2005
+ readonly name: "Ocean";
2006
+ readonly description: "";
2007
+ readonly variants: readonly [{
2008
+ readonly id: "ocean";
2009
+ readonly name: "Default";
2010
+ readonly variantType: "DEFAULT";
2011
+ readonly description: "";
2012
+ readonly imageURL: "";
2013
+ readonly deprecated: true;
2014
+ readonly deprecationMessage: "\"ocean\" is deprecated, use \"ocean-v4\" instead";
2015
+ }];
2016
+ }, {
2017
+ readonly referenceStyleID: "AQUARELLE_V2";
2018
+ readonly name: "Aquarelle";
2019
+ readonly description: "Watercolor map for creative use";
2020
+ readonly variants: readonly [{
2021
+ readonly id: "aquarelle";
2022
+ readonly name: "Default";
2023
+ readonly variantType: "DEFAULT";
2024
+ readonly description: "";
2025
+ readonly imageURL: "";
2026
+ readonly deprecated: true;
2027
+ readonly deprecationMessage: "\"aquarelle\" is deprecated, use \"aquarelle-v4\" instead";
2028
+ }, {
2029
+ readonly id: "aquarelle-dark";
2030
+ readonly name: "Dark";
2031
+ readonly variantType: "DARK";
2032
+ readonly description: "";
2033
+ readonly imageURL: "";
2034
+ readonly deprecated: true;
2035
+ readonly deprecationMessage: "\"aquarelle-dark\" is deprecated, use \"aquarelle-v4-dark\" instead";
2036
+ }, {
2037
+ readonly id: "aquarelle-vivid";
2038
+ readonly name: "Vivid";
2039
+ readonly variantType: "VIVID";
2040
+ readonly description: "";
2041
+ readonly imageURL: "";
2042
+ readonly deprecated: true;
2043
+ readonly deprecationMessage: "\"aquarelle-vivid\" is deprecated, use \"aquarelle-v4-vivid\" instead";
2044
+ }];
2045
+ }, {
2046
+ readonly referenceStyleID: "LANDSCAPE_V2";
2047
+ readonly name: "Landscape";
2048
+ readonly description: "Terrain map for data overlays and visualisations";
2049
+ readonly variants: readonly [{
2050
+ readonly id: "landscape";
2051
+ readonly name: "Default";
2052
+ readonly variantType: "DEFAULT";
2053
+ readonly description: "";
2054
+ readonly imageURL: "";
2055
+ readonly deprecated: true;
2056
+ readonly deprecationMessage: "\"landscape\" is deprecated, use \"landscape-v4\" instead";
2057
+ }, {
2058
+ readonly id: "landscape-dark";
2059
+ readonly name: "Dark";
2060
+ readonly variantType: "DARK";
2061
+ readonly description: "";
2062
+ readonly imageURL: "";
2063
+ readonly deprecated: true;
2064
+ readonly deprecationMessage: "\"landscape-dark\" is deprecated, use \"landscape-v4-dark\" instead";
2065
+ }, {
2066
+ readonly id: "landscape-vivid";
2067
+ readonly name: "Vivid";
2068
+ readonly variantType: "VIVID";
2069
+ readonly description: "";
2070
+ readonly imageURL: "";
2071
+ readonly deprecated: true;
2072
+ readonly deprecationMessage: "\"landscape-vivid\" is deprecated, use \"landscape-v4-vivid\" instead";
2073
+ }];
2074
+ }, {
2075
+ readonly referenceStyleID: "LANDSCAPE_V4";
2076
+ readonly name: "Landscape";
2077
+ readonly description: "Terrain map for data overlays and visualisations";
2078
+ readonly variants: readonly [{
2079
+ readonly id: "landscape-v4";
2080
+ readonly name: "Default";
2081
+ readonly variantType: "DEFAULT";
2082
+ readonly description: "";
2083
+ readonly imageURL: "";
2084
+ }, {
2085
+ readonly id: "landscape-v4-dark";
2086
+ readonly name: "Dark";
2087
+ readonly variantType: "DARK";
2088
+ readonly description: "";
2089
+ readonly imageURL: "";
2090
+ }, {
2091
+ readonly id: "landscape-v4-vivid";
2092
+ readonly name: "Vivid";
2093
+ readonly variantType: "VIVID";
2094
+ readonly description: "";
2095
+ readonly imageURL: "";
2096
+ }];
2097
+ }, {
2098
+ readonly referenceStyleID: "SATELLITE_V4";
2099
+ readonly name: "Satellite v4";
2100
+ readonly description: "";
2101
+ readonly variants: readonly [{
2102
+ readonly id: "satellite-v4";
2103
+ readonly name: "Default";
2104
+ readonly variantType: "DEFAULT";
2105
+ readonly description: "";
2106
+ readonly imageURL: "";
2107
+ }, {
2108
+ readonly id: "satellite-v4-dark";
2109
+ readonly name: "Dark";
2110
+ readonly variantType: "DARK";
2111
+ readonly description: "";
2112
+ readonly imageURL: "";
2113
+ }];
2114
+ }, {
2115
+ readonly referenceStyleID: "DATAVIZ_V4";
2116
+ readonly name: "Dataviz";
2117
+ readonly description: "";
2118
+ readonly variants: readonly [{
2119
+ readonly id: "dataviz-v4";
2120
+ readonly name: "Default";
2121
+ readonly variantType: "DEFAULT";
2122
+ readonly description: "";
2123
+ readonly imageURL: "";
2124
+ }, {
2125
+ readonly id: "dataviz-v4-dark";
2126
+ readonly name: "Dark";
2127
+ readonly variantType: "DARK";
2128
+ readonly description: "";
2129
+ readonly imageURL: "";
2130
+ }, {
2131
+ readonly id: "dataviz-v4-light";
2132
+ readonly name: "Light";
2133
+ readonly variantType: "LIGHT";
2134
+ readonly description: "";
2135
+ readonly imageURL: "";
2136
+ }];
2137
+ }, {
2138
+ readonly referenceStyleID: "OUTDOOR_V4";
2139
+ readonly name: "Outdoor";
2140
+ readonly description: "";
2141
+ readonly variants: readonly [{
2142
+ readonly id: "outdoor-v4";
2143
+ readonly name: "Default";
2144
+ readonly variantType: "DEFAULT";
2145
+ readonly description: "";
2146
+ readonly imageURL: "";
2147
+ }, {
2148
+ readonly id: "outdoor-v4-dark";
2149
+ readonly name: "Dark";
2150
+ readonly variantType: "DARK";
2151
+ readonly description: "";
2152
+ readonly imageURL: "";
2153
+ }];
2154
+ }, {
2155
+ readonly referenceStyleID: "BACKDROP_V4";
2156
+ readonly name: "Backdrop";
2157
+ readonly description: "";
2158
+ readonly variants: readonly [{
2159
+ readonly id: "backdrop-v4";
2160
+ readonly name: "Default";
2161
+ readonly variantType: "DEFAULT";
2162
+ readonly description: "";
2163
+ readonly imageURL: "";
2164
+ }, {
2165
+ readonly id: "backdrop-v4-dark";
2166
+ readonly name: "Dark";
2167
+ readonly variantType: "DARK";
2168
+ readonly description: "";
2169
+ readonly imageURL: "";
2170
+ }, {
2171
+ readonly id: "backdrop-v4-light";
2172
+ readonly name: "Light";
2173
+ readonly variantType: "LIGHT";
2174
+ readonly description: "";
2175
+ readonly imageURL: "";
2176
+ }];
2177
+ }, {
2178
+ readonly referenceStyleID: "AQUARELLE_V4";
2179
+ readonly name: "Aquarelle";
2180
+ readonly description: "Watercolor map for creative use";
2181
+ readonly variants: readonly [{
2182
+ readonly id: "aquarelle-v4";
2183
+ readonly name: "Default";
2184
+ readonly variantType: "DEFAULT";
2185
+ readonly description: "";
2186
+ readonly imageURL: "";
2187
+ }, {
2188
+ readonly id: "aquarelle-v4-dark";
2189
+ readonly name: "Dark";
2190
+ readonly variantType: "DARK";
2191
+ readonly description: "";
2192
+ readonly imageURL: "";
2193
+ }, {
2194
+ readonly id: "aquarelle-v4-vivid";
2195
+ readonly name: "Vivid";
2196
+ readonly variantType: "VIVID";
2197
+ readonly description: "";
2198
+ readonly imageURL: "";
2199
+ }];
2200
+ }, {
2201
+ readonly referenceStyleID: "OCEAN_V4";
2202
+ readonly name: "Ocean";
2203
+ readonly description: "";
2204
+ readonly variants: readonly [{
2205
+ readonly id: "ocean-v4";
2206
+ readonly name: "Default";
2207
+ readonly variantType: "DEFAULT";
2208
+ readonly description: "";
2209
+ readonly imageURL: "";
2210
+ }, {
2211
+ readonly id: "ocean-v4-dark";
2212
+ readonly name: "Dark";
2213
+ readonly variantType: "DARK";
2214
+ readonly description: "";
2215
+ readonly imageURL: "";
2216
+ }];
2217
+ }, {
2218
+ readonly referenceStyleID: "TOPO_V4";
2219
+ readonly name: "Topo";
2220
+ readonly description: "";
2221
+ readonly variants: readonly [{
2222
+ readonly id: "topo-v4";
2223
+ readonly name: "Default";
2224
+ readonly variantType: "DEFAULT";
2225
+ readonly description: "";
2226
+ readonly imageURL: "";
2227
+ }, {
2228
+ readonly id: "topo-v4-dark";
2229
+ readonly name: "Dark";
2230
+ readonly variantType: "DARK";
2231
+ readonly description: "";
2232
+ readonly imageURL: "";
2233
+ }, {
2234
+ readonly id: "topo-v4-pastel";
2235
+ readonly name: "Pastel";
2236
+ readonly variantType: "PASTEL";
2237
+ readonly description: "";
2238
+ readonly imageURL: "";
2239
+ }, {
2240
+ readonly id: "topo-v4-topographique";
2241
+ readonly name: "Topographique";
2242
+ readonly variantType: "TOPOGRAPHIQUE";
2243
+ readonly description: "";
2244
+ readonly imageURL: "";
2245
+ }];
2246
+ }];
2247
+ /**
2248
+ * Map of default reference styles to their versioned counterparts.
2249
+ * This is make it easier to version the default reference styles.
2250
+ * Note: the type definition `MapStyleType` will need to be updated to reflect this.
2251
+ */
2252
+ declare const defaultReferenceStyleMap: {
2253
+ readonly STREETS: "STREETS_V2";
2254
+ readonly BASIC: "BASIC_V2";
2255
+ readonly LANDSCAPE: "LANDSCAPE_V2";
2256
+ readonly AQUARELLE: "AQUARELLE_V2";
2257
+ readonly SATELLITE: "SATELLITE_V2";
2258
+ readonly WINTER: "WINTER_V2";
2259
+ readonly HYBRID: "HYBRID_V2";
2260
+ readonly OCEAN: "OCEAN_V2";
2261
+ readonly TONER: "TONER_V2";
2262
+ readonly TOPO: "TOPO_V2";
2263
+ readonly OPENSTREETMAP: "OPENSTREETMAP_V2";
2264
+ readonly DATAVIZ: "DATAVIZ_V2";
2265
+ readonly BACKDROP: "BACKDROP_V2";
2266
+ readonly VOYAGER: "VOYAGER_V2";
2267
+ };
2268
+ type ConfigID = (typeof MAP_STYLE_CONFIG)[number]["referenceStyleID"];
2269
+ type ConfigVariant<T extends ConfigID> = Extract<(typeof MAP_STYLE_CONFIG)[number], {
2270
+ referenceStyleID: T;
2271
+ }>["variants"][number]["variantType"];
2272
+ type BaseMapStyleType = {
2273
+ [K in ConfigID]: ReferenceMapStyle & {
2274
+ [V in ConfigVariant<K>]: MapStyleVariant;
1893
2275
  };
1894
2276
  };
1895
- declare const mapStylePresetList: Array<MapStylePreset>;
2277
+ type MapStyleType = BaseMapStyleType & {
2278
+ [K in keyof typeof defaultReferenceStyleMap]: BaseMapStyleType[(typeof defaultReferenceStyleMap)[K] & ConfigID];
2279
+ };
2280
+ declare const mapStylePresetList: MapStylePreset[];
1896
2281
  declare function styleToStyle(style: string | ReferenceMapStyle | MapStyleVariant | null | undefined): string;
1897
2282
  /**
1898
2283
  * Contains all the reference map style created by MapTiler team as well as all the variants.