@maptiler/client 2.0.0 → 2.3.0

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.
@@ -103,7 +103,7 @@ declare const config: ClientConfig;
103
103
 
104
104
  type LanguageInfo = {
105
105
  /**
106
- * Two letter ISO code, such as `"en"` for English language.
106
+ * Two-letter ISO code, such as `"en"` for English language.
107
107
  * Can be `null` if the language is a flag to be evaluated at runtime,
108
108
  * as it is the case for some "modes".
109
109
  */
@@ -124,7 +124,7 @@ type LanguageInfo = {
124
124
  latin: boolean;
125
125
  /**
126
126
  * Some language descriptions corresponds to "modes" rather than to actual languages.
127
- * For instance the "visitor" mode consists in displaying bylingual labels.
127
+ * For instance the "visitor" mode consists in displaying bilingual labels.
128
128
  */
129
129
  isMode: boolean;
130
130
  /**
@@ -133,9 +133,9 @@ type LanguageInfo = {
133
133
  geocoding: boolean;
134
134
  };
135
135
  /**
136
- * The complete list of languages
136
+ * List of "non-ISO specific" languages.
137
137
  */
138
- declare const Language: {
138
+ declare const NonISOLanguage: {
139
139
  /**
140
140
  * Language mode to display the labels in the end user's device language.
141
141
  */
@@ -154,6 +154,15 @@ declare const Language: {
154
154
  * Using the local language generaly (but not always) means that every labels of a given region will use the dominant local language.
155
155
  */
156
156
  readonly LOCAL: LanguageInfo;
157
+ };
158
+ /**
159
+ * List of "country specific" languages.
160
+ */
161
+ declare const ISOLanguage: {
162
+ /**
163
+ * Albanian language
164
+ */
165
+ readonly ALBANIAN: LanguageInfo;
157
166
  /**
158
167
  * Amharic language
159
168
  */
@@ -162,30 +171,38 @@ declare const Language: {
162
171
  * Arabic language (right-to-left script)
163
172
  */
164
173
  readonly ARABIC: LanguageInfo;
174
+ /**
175
+ * Armenian language
176
+ */
177
+ readonly ARMENIAN: LanguageInfo;
165
178
  /**
166
179
  * Azerbaijani language
167
180
  */
168
181
  readonly AZERBAIJANI: LanguageInfo;
169
182
  /**
170
- * Belarusian langauge
183
+ * Basque language
171
184
  */
172
- readonly BELARUSIAN: LanguageInfo;
185
+ readonly BASQUE: LanguageInfo;
173
186
  /**
174
- * Bulgarian language
187
+ * Belarusian langauge
175
188
  */
176
- readonly BULGARIAN: LanguageInfo;
189
+ readonly BELARUSIAN: LanguageInfo;
177
190
  /**
178
191
  * Bengali language
179
192
  */
180
193
  readonly BENGALI: LanguageInfo;
194
+ /**
195
+ * Bosnian language
196
+ */
197
+ readonly BOSNIAN: LanguageInfo;
181
198
  /**
182
199
  * Breton language
183
200
  */
184
201
  readonly BRETON: LanguageInfo;
185
202
  /**
186
- * Bosnian language
203
+ * Bulgarian language
187
204
  */
188
- readonly BOSNIAN: LanguageInfo;
205
+ readonly BULGARIAN: LanguageInfo;
189
206
  /**
190
207
  * Catalan language
191
208
  */
@@ -207,17 +224,21 @@ declare const Language: {
207
224
  */
208
225
  readonly CORSICAN: LanguageInfo;
209
226
  /**
210
- * Czech language
227
+ * Croatian language
211
228
  */
212
- readonly CZECH: LanguageInfo;
229
+ readonly CROATIAN: LanguageInfo;
213
230
  /**
214
- * Welsh language
231
+ * Czech language
215
232
  */
216
- readonly WELSH: LanguageInfo;
233
+ readonly CZECH: LanguageInfo;
217
234
  /**
218
235
  * Danish language
219
236
  */
220
237
  readonly DANISH: LanguageInfo;
238
+ /**
239
+ * Dutch language
240
+ */
241
+ readonly DUTCH: LanguageInfo;
221
242
  /**
222
243
  * German language
223
244
  */
@@ -234,18 +255,10 @@ declare const Language: {
234
255
  * Esperanto language
235
256
  */
236
257
  readonly ESPERANTO: LanguageInfo;
237
- /**
238
- * Spanish language
239
- */
240
- readonly SPANISH: LanguageInfo;
241
258
  /**
242
259
  * Estonian language
243
260
  */
244
261
  readonly ESTONIAN: LanguageInfo;
245
- /**
246
- * Basque language
247
- */
248
- readonly BASQUE: LanguageInfo;
249
262
  /**
250
263
  * Finnish language
251
264
  */
@@ -259,13 +272,9 @@ declare const Language: {
259
272
  */
260
273
  readonly FRISIAN: LanguageInfo;
261
274
  /**
262
- * Irish language
263
- */
264
- readonly IRISH: LanguageInfo;
265
- /**
266
- * Scottish Gaelic language
275
+ * Georgian language
267
276
  */
268
- readonly SCOTTISH_GAELIC: LanguageInfo;
277
+ readonly GEORGIAN: LanguageInfo;
269
278
  /**
270
279
  * Hebrew language (right-to-left non-latin script)
271
280
  */
@@ -274,26 +283,22 @@ declare const Language: {
274
283
  * Hindi language
275
284
  */
276
285
  readonly HINDI: LanguageInfo;
277
- /**
278
- * Croatian language
279
- */
280
- readonly CROATIAN: LanguageInfo;
281
286
  /**
282
287
  * Hungarian language
283
288
  */
284
289
  readonly HUNGARIAN: LanguageInfo;
285
290
  /**
286
- * Armenian language
291
+ * Icelandic language
287
292
  */
288
- readonly ARMENIAN: LanguageInfo;
293
+ readonly ICELANDIC: LanguageInfo;
289
294
  /**
290
295
  * Indonesian language
291
296
  */
292
297
  readonly INDONESIAN: LanguageInfo;
293
298
  /**
294
- * Icelandic language
299
+ * Irish language
295
300
  */
296
- readonly ICELANDIC: LanguageInfo;
301
+ readonly IRISH: LanguageInfo;
297
302
  /**
298
303
  * Italian language
299
304
  */
@@ -319,17 +324,13 @@ declare const Language: {
319
324
  */
320
325
  readonly JAPANESE_LATIN: LanguageInfo;
321
326
  /**
322
- * Georgian language
327
+ * Kannada language
323
328
  */
324
- readonly GEORGIAN: LanguageInfo;
329
+ readonly KANNADA: LanguageInfo;
325
330
  /**
326
331
  * Kazakh language
327
332
  */
328
333
  readonly KAZAKH: LanguageInfo;
329
- /**
330
- * Kannada language
331
- */
332
- readonly KANNADA: LanguageInfo;
333
334
  /**
334
335
  * Korean language
335
336
  */
@@ -347,17 +348,17 @@ declare const Language: {
347
348
  */
348
349
  readonly CLASSICAL_LATIN: LanguageInfo;
349
350
  /**
350
- * Luxembourgish language
351
+ * Latvian language
351
352
  */
352
- readonly LUXEMBOURGISH: LanguageInfo;
353
+ readonly LATVIAN: LanguageInfo;
353
354
  /**
354
355
  * Lithuanian language
355
356
  */
356
357
  readonly LITHUANIAN: LanguageInfo;
357
358
  /**
358
- * Latvian language
359
+ * Luxembourgish language
359
360
  */
360
- readonly LATVIAN: LanguageInfo;
361
+ readonly LUXEMBOURGISH: LanguageInfo;
361
362
  /**
362
363
  * Macedonian language
363
364
  */
@@ -370,10 +371,6 @@ declare const Language: {
370
371
  * Maltese language
371
372
  */
372
373
  readonly MALTESE: LanguageInfo;
373
- /**
374
- * Dutch language
375
- */
376
- readonly DUTCH: LanguageInfo;
377
374
  /**
378
375
  * Norwegian language
379
376
  */
@@ -382,14 +379,18 @@ declare const Language: {
382
379
  * Occitan language
383
380
  */
384
381
  readonly OCCITAN: LanguageInfo;
382
+ /**
383
+ * Persian language
384
+ */
385
+ readonly PERSIAN: LanguageInfo;
385
386
  /**
386
387
  * Polish language
387
388
  */
388
389
  readonly POLISH: LanguageInfo;
389
390
  /**
390
- * Persian language
391
+ * Portuguese language
391
392
  */
392
- readonly PERSIAN: LanguageInfo;
393
+ readonly PORTUGUESE: LanguageInfo;
393
394
  /**
394
395
  * Punjabi language
395
396
  */
@@ -399,21 +400,29 @@ declare const Language: {
399
400
  */
400
401
  readonly WESTERN_PUNJABI: LanguageInfo;
401
402
  /**
402
- * Portuguese language
403
+ * Romanian language
403
404
  */
404
- readonly PORTUGUESE: LanguageInfo;
405
+ readonly ROMANIAN: LanguageInfo;
405
406
  /**
406
407
  * Romansh language
407
408
  */
408
409
  readonly ROMANSH: LanguageInfo;
409
- /**
410
- * Romanian language
411
- */
412
- readonly ROMANIAN: LanguageInfo;
413
410
  /**
414
411
  * Russian language
415
412
  */
416
413
  readonly RUSSIAN: LanguageInfo;
414
+ /**
415
+ * Serbian language (cyrillic script)
416
+ */
417
+ readonly SERBIAN_CYRILLIC: LanguageInfo;
418
+ /**
419
+ * Serbian language (latin script)
420
+ */
421
+ readonly SERBIAN_LATIN: LanguageInfo;
422
+ /**
423
+ * Scottish Gaelic language
424
+ */
425
+ readonly SCOTTISH_GAELIC: LanguageInfo;
417
426
  /**
418
427
  * Slovak language
419
428
  */
@@ -422,10 +431,299 @@ declare const Language: {
422
431
  * Slovene language
423
432
  */
424
433
  readonly SLOVENE: LanguageInfo;
434
+ /**
435
+ * Spanish language
436
+ */
437
+ readonly SPANISH: LanguageInfo;
438
+ /**
439
+ * Swedish language
440
+ */
441
+ readonly SWEDISH: LanguageInfo;
442
+ /**
443
+ * Tamil language
444
+ */
445
+ readonly TAMIL: LanguageInfo;
446
+ /**
447
+ * Telugu language
448
+ */
449
+ readonly TELUGU: LanguageInfo;
450
+ /**
451
+ * Thai language
452
+ */
453
+ readonly THAI: LanguageInfo;
454
+ /**
455
+ * Turkish language
456
+ */
457
+ readonly TURKISH: LanguageInfo;
458
+ /**
459
+ * Ukrainian language
460
+ */
461
+ readonly UKRAINIAN: LanguageInfo;
462
+ /**
463
+ * Vietnamese language (latin script)
464
+ */
465
+ readonly VIETNAMESE: LanguageInfo;
466
+ /**
467
+ * Welsh language
468
+ */
469
+ readonly WELSH: LanguageInfo;
470
+ };
471
+ /**
472
+ * The complete list of languages
473
+ */
474
+ declare const Language: {
425
475
  /**
426
476
  * Albanian language
427
477
  */
428
478
  readonly ALBANIAN: LanguageInfo;
479
+ /**
480
+ * Amharic language
481
+ */
482
+ readonly AMHARIC: LanguageInfo;
483
+ /**
484
+ * Arabic language (right-to-left script)
485
+ */
486
+ readonly ARABIC: LanguageInfo;
487
+ /**
488
+ * Armenian language
489
+ */
490
+ readonly ARMENIAN: LanguageInfo;
491
+ /**
492
+ * Azerbaijani language
493
+ */
494
+ readonly AZERBAIJANI: LanguageInfo;
495
+ /**
496
+ * Basque language
497
+ */
498
+ readonly BASQUE: LanguageInfo;
499
+ /**
500
+ * Belarusian langauge
501
+ */
502
+ readonly BELARUSIAN: LanguageInfo;
503
+ /**
504
+ * Bengali language
505
+ */
506
+ readonly BENGALI: LanguageInfo;
507
+ /**
508
+ * Bosnian language
509
+ */
510
+ readonly BOSNIAN: LanguageInfo;
511
+ /**
512
+ * Breton language
513
+ */
514
+ readonly BRETON: LanguageInfo;
515
+ /**
516
+ * Bulgarian language
517
+ */
518
+ readonly BULGARIAN: LanguageInfo;
519
+ /**
520
+ * Catalan language
521
+ */
522
+ readonly CATALAN: LanguageInfo;
523
+ /**
524
+ * Chinese language
525
+ */
526
+ readonly CHINESE: LanguageInfo;
527
+ /**
528
+ * Traditional Chinese language
529
+ */
530
+ readonly TRADITIONAL_CHINESE: LanguageInfo;
531
+ /**
532
+ * Simplified Chinese language
533
+ */
534
+ readonly SIMPLIFIED_CHINESE: LanguageInfo;
535
+ /**
536
+ * Corsican language
537
+ */
538
+ readonly CORSICAN: LanguageInfo;
539
+ /**
540
+ * Croatian language
541
+ */
542
+ readonly CROATIAN: LanguageInfo;
543
+ /**
544
+ * Czech language
545
+ */
546
+ readonly CZECH: LanguageInfo;
547
+ /**
548
+ * Danish language
549
+ */
550
+ readonly DANISH: LanguageInfo;
551
+ /**
552
+ * Dutch language
553
+ */
554
+ readonly DUTCH: LanguageInfo;
555
+ /**
556
+ * German language
557
+ */
558
+ readonly GERMAN: LanguageInfo;
559
+ /**
560
+ * Greek language
561
+ */
562
+ readonly GREEK: LanguageInfo;
563
+ /**
564
+ * English language
565
+ */
566
+ readonly ENGLISH: LanguageInfo;
567
+ /**
568
+ * Esperanto language
569
+ */
570
+ readonly ESPERANTO: LanguageInfo;
571
+ /**
572
+ * Estonian language
573
+ */
574
+ readonly ESTONIAN: LanguageInfo;
575
+ /**
576
+ * Finnish language
577
+ */
578
+ readonly FINNISH: LanguageInfo;
579
+ /**
580
+ * French language
581
+ */
582
+ readonly FRENCH: LanguageInfo;
583
+ /**
584
+ * Frisian language
585
+ */
586
+ readonly FRISIAN: LanguageInfo;
587
+ /**
588
+ * Georgian language
589
+ */
590
+ readonly GEORGIAN: LanguageInfo;
591
+ /**
592
+ * Hebrew language (right-to-left non-latin script)
593
+ */
594
+ readonly HEBREW: LanguageInfo;
595
+ /**
596
+ * Hindi language
597
+ */
598
+ readonly HINDI: LanguageInfo;
599
+ /**
600
+ * Hungarian language
601
+ */
602
+ readonly HUNGARIAN: LanguageInfo;
603
+ /**
604
+ * Icelandic language
605
+ */
606
+ readonly ICELANDIC: LanguageInfo;
607
+ /**
608
+ * Indonesian language
609
+ */
610
+ readonly INDONESIAN: LanguageInfo;
611
+ /**
612
+ * Irish language
613
+ */
614
+ readonly IRISH: LanguageInfo;
615
+ /**
616
+ * Italian language
617
+ */
618
+ readonly ITALIAN: LanguageInfo;
619
+ /**
620
+ * Japanese language
621
+ */
622
+ readonly JAPANESE: LanguageInfo;
623
+ /**
624
+ * Japanese language in Hiragana form
625
+ */
626
+ readonly JAPANESE_HIRAGANA: LanguageInfo;
627
+ /**
628
+ * Japanese language (latin script)
629
+ */
630
+ readonly JAPANESE_2018: LanguageInfo;
631
+ /**
632
+ * Japanese language in Kana form (non-latin script)
633
+ */
634
+ readonly JAPANESE_KANA: LanguageInfo;
635
+ /**
636
+ * Japanse language, romanized (latin script)
637
+ */
638
+ readonly JAPANESE_LATIN: LanguageInfo;
639
+ /**
640
+ * Kannada language
641
+ */
642
+ readonly KANNADA: LanguageInfo;
643
+ /**
644
+ * Kazakh language
645
+ */
646
+ readonly KAZAKH: LanguageInfo;
647
+ /**
648
+ * Korean language
649
+ */
650
+ readonly KOREAN: LanguageInfo;
651
+ /**
652
+ * Korean language (latin script)
653
+ */
654
+ readonly KOREAN_LATIN: LanguageInfo;
655
+ /**
656
+ * Kurdish language
657
+ */
658
+ readonly KURDISH: LanguageInfo;
659
+ /**
660
+ * Classical Latin language
661
+ */
662
+ readonly CLASSICAL_LATIN: LanguageInfo;
663
+ /**
664
+ * Latvian language
665
+ */
666
+ readonly LATVIAN: LanguageInfo;
667
+ /**
668
+ * Lithuanian language
669
+ */
670
+ readonly LITHUANIAN: LanguageInfo;
671
+ /**
672
+ * Luxembourgish language
673
+ */
674
+ readonly LUXEMBOURGISH: LanguageInfo;
675
+ /**
676
+ * Macedonian language
677
+ */
678
+ readonly MACEDONIAN: LanguageInfo;
679
+ /**
680
+ * Malayalm language
681
+ */
682
+ readonly MALAYALAM: LanguageInfo;
683
+ /**
684
+ * Maltese language
685
+ */
686
+ readonly MALTESE: LanguageInfo;
687
+ /**
688
+ * Norwegian language
689
+ */
690
+ readonly NORWEGIAN: LanguageInfo;
691
+ /**
692
+ * Occitan language
693
+ */
694
+ readonly OCCITAN: LanguageInfo;
695
+ /**
696
+ * Persian language
697
+ */
698
+ readonly PERSIAN: LanguageInfo;
699
+ /**
700
+ * Polish language
701
+ */
702
+ readonly POLISH: LanguageInfo;
703
+ /**
704
+ * Portuguese language
705
+ */
706
+ readonly PORTUGUESE: LanguageInfo;
707
+ /**
708
+ * Punjabi language
709
+ */
710
+ readonly PUNJABI: LanguageInfo;
711
+ /**
712
+ * Western Punjabi language
713
+ */
714
+ readonly WESTERN_PUNJABI: LanguageInfo;
715
+ /**
716
+ * Romanian language
717
+ */
718
+ readonly ROMANIAN: LanguageInfo;
719
+ /**
720
+ * Romansh language
721
+ */
722
+ readonly ROMANSH: LanguageInfo;
723
+ /**
724
+ * Russian language
725
+ */
726
+ readonly RUSSIAN: LanguageInfo;
429
727
  /**
430
728
  * Serbian language (cyrillic script)
431
729
  */
@@ -434,6 +732,22 @@ declare const Language: {
434
732
  * Serbian language (latin script)
435
733
  */
436
734
  readonly SERBIAN_LATIN: LanguageInfo;
735
+ /**
736
+ * Scottish Gaelic language
737
+ */
738
+ readonly SCOTTISH_GAELIC: LanguageInfo;
739
+ /**
740
+ * Slovak language
741
+ */
742
+ readonly SLOVAK: LanguageInfo;
743
+ /**
744
+ * Slovene language
745
+ */
746
+ readonly SLOVENE: LanguageInfo;
747
+ /**
748
+ * Spanish language
749
+ */
750
+ readonly SPANISH: LanguageInfo;
437
751
  /**
438
752
  * Swedish language
439
753
  */
@@ -462,30 +776,52 @@ declare const Language: {
462
776
  * Vietnamese language (latin script)
463
777
  */
464
778
  readonly VIETNAMESE: LanguageInfo;
779
+ /**
780
+ * Welsh language
781
+ */
782
+ readonly WELSH: LanguageInfo;
783
+ /**
784
+ * Language mode to display the labels in the end user's device language.
785
+ */
786
+ readonly AUTO: LanguageInfo;
787
+ /**
788
+ * The OSM language using latin script. MapTiler discourages its use as a primary language setting due to the lack of actual linguistic specificity,
789
+ * though it can be an handy fallback. This is not to be confused with the "Classical Latin" language, which is available under the tag `.CLASSICAL_LATIN`.
790
+ */
791
+ readonly LATIN: LanguageInfo;
792
+ /**
793
+ * The OSM language using non-latin script. MapTiler discourages its use as a primary language setting due to the lack of actual linguistic specificity,
794
+ * though it can be an handy fallback.
795
+ */
796
+ readonly NON_LATIN: LanguageInfo;
797
+ /**
798
+ * Using the local language generaly (but not always) means that every labels of a given region will use the dominant local language.
799
+ */
800
+ readonly LOCAL: LanguageInfo;
465
801
  };
466
802
  /**
467
803
  * Get language infos from a provided language key, the key being the no-whitespace capital name.
468
- * By default, the language dictionnary to look into is the one defined in this library, but another one could be provided
804
+ * By default, the language dictionary to look into is the one defined in this library, but another one could be provided
469
805
  * Returns `null` if not found.
470
806
  */
471
- declare function getLanguageInfoFromKey(languageKey: string, languageDictionnary?: {
807
+ declare function getLanguageInfoFromKey(languageKey: string, languageDictionary?: {
472
808
  [k: string]: LanguageInfo;
473
809
  }): LanguageInfo | null;
474
810
  /**
475
811
  * Get the language info from a provided 2-character iso code.
476
- * By default, the language dictionnary to look into is the one defined in this library, but another one could be provided
812
+ * By default, the language dictionary to look into is the one defined in this library, but another one could be provided
477
813
  * Returns `null` if not found.
478
814
  */
479
- declare function getLanguageInfoFromCode(languageCode: string, languageDictionnary?: {
815
+ declare function getLanguageInfoFromCode(languageCode: string, languageDictionary?: {
480
816
  [k: string]: LanguageInfo;
481
817
  }): LanguageInfo | null;
482
818
  /**
483
- * Get the language info from a language flag (eg. `"name:en"`).
819
+ * Get the language info from a language flag (e.g. `"name:en"`).
484
820
  * This is also handy to check is a given language flag is a supported language.
485
- * By default, the language dictionnary to look into is the one defined in this library, but another one could be provided
821
+ * By default, the language dictionary to look into is the one defined in this library, but another one could be provided
486
822
  * Returns `null` if not found.
487
823
  */
488
- declare function getLanguageInfoFromFlag(languageFlag: string, languageDictionnary?: {
824
+ declare function getLanguageInfoFromFlag(languageFlag: string, languageDictionary?: {
489
825
  [k: string]: LanguageInfo;
490
826
  }): LanguageInfo | null;
491
827
  /**
@@ -494,16 +830,16 @@ declare function getLanguageInfoFromFlag(languageFlag: string, languageDictionna
494
830
  declare function getAutoLanguage(): LanguageInfo;
495
831
  declare function isLanguageInfo(obj: unknown): obj is LanguageInfo;
496
832
  /**
497
- * By default, the language dictionnary to look into is the one defined in this library, but another one could be provided
833
+ * By default, the language dictionary to look into is the one defined in this library, but another one could be provided
498
834
  */
499
- declare function toLanguageInfo(lang: LanguageInfo | string, languageDictionnary?: {
835
+ declare function toLanguageInfo(lang: LanguageInfo | string, languageDictionary?: {
500
836
  [k: string]: LanguageInfo;
501
837
  }): LanguageInfo | null;
502
838
  /**
503
839
  * Tells if two languages are the same, even though possibly provided under different forms.
504
840
  * Note: this is not comparing object references, but values.
505
841
  */
506
- declare function areSameLanguages(langA: string | LanguageInfo, langB: string | LanguageInfo, languageDictionnary?: {
842
+ declare function areSameLanguages(langA: string | LanguageInfo, langB: string | LanguageInfo, languageDictionary?: {
507
843
  [k: string]: LanguageInfo;
508
844
  }): boolean;
509
845
 
@@ -513,20 +849,25 @@ type LanguageGeocodingOptions = {
513
849
  */
514
850
  language?: string | Array<string> | LanguageInfo | Array<LanguageInfo>;
515
851
  };
852
+ type GeocodingPlaceType = "continental_marine" | "country" | "major_landform" | "region" | "subregion" | "county" | "joint_municipality" | "joint_submunicipality" | "municipality" | "municipal_district" | "locality" | "neighbourhood" | "place" | "postal_code" | "address" | "road" | "poi";
516
853
  type CommonForwardAndReverseGeocodingOptions = LanguageGeocodingOptions & {
517
854
  /**
518
- * Custom MapTiler Cloud API key to use instead of the one in global `config`
855
+ * Custom MapTiler Cloud API key to use instead of the one in global `config`.
519
856
  */
520
857
  apiKey?: string;
521
858
  /**
522
- * Maximum number of results to show. Must be between 1 and 10. Default is 5 for forward and 1 for reverse geocoding.
859
+ * Maximum number of results to show. Must be between 1 and 10.
860
+ * For reverse geocoding with multiple `types` this must not be set or must be set to 1.
861
+ * Default is 5 for forward and 1 for reverse geocoding.
523
862
  */
524
863
  limit?: number;
525
864
  /**
526
- * Filter of feature types to return.
527
- * If not specified, feature of all available types except `poi` are returned (`types = ["poi"]`, `excludeTypes = true`).
865
+ * Features of specified types to query.
866
+ * If not specified, feature of all available types except `poi` and `major_landform` will be queried (`types = ["poi", "major_landform"]`, `excludeTypes = true`).
867
+ * In case of reverse geocoding if just a single type is specified, then multiple nearby features of the single type can be returned,
868
+ * otherwise single feature for every specified type (or default types) can be returned.
528
869
  */
529
- types?: ("country" | "region" | "subregion" | "county" | "joint_municipality" | "joint_submunicipality" | "municipality" | "municipal_district" | "locality" | "neighbourhood" | "place" | "postal_code" | "address" | "road" | "poi")[];
870
+ types?: GeocodingPlaceType[];
530
871
  /**
531
872
  * Set to `true` to use all available feature types except those mentioned in `types`. Default value is `false` if `types` is specified.
532
873
  */
@@ -636,7 +977,7 @@ type GeocodingFeature = Feature<Geometry, FeatureProperties> & FeatureBase & {
636
977
  * An array of feature types describing the feature.
637
978
  * Currently each feature has only single type but this may change in the future.
638
979
  */
639
- place_type: string[];
980
+ place_type: GeocodingPlaceType[];
640
981
  /**
641
982
  * Localized type of the place name, matches `place_type` property
642
983
  */
@@ -685,7 +1026,9 @@ type GeocodingSearchResult = {
685
1026
  * Performs a forward geocoding query to MapTiler API.
686
1027
  * Providing a human readable place name (of a city, country, street, etc.), the function returns
687
1028
  * a list of candidate locations including longitude and latitude.
1029
+ *
688
1030
  * Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#search-by-name-forward
1031
+ *
689
1032
  * @param query
690
1033
  * @param options
691
1034
  * @returns
@@ -694,7 +1037,9 @@ declare function forward(query: string, options?: GeocodingOptions): Promise<Geo
694
1037
  /**
695
1038
  * Perform a reverse geocoding query to MapTiler API.
696
1039
  * Providing a longitude and latitude, this function returns a set of human readable information about this place (country, city, street, etc.)
1040
+ *
697
1041
  * Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#search-by-coordinates-reverse
1042
+ *
698
1043
  * @param position
699
1044
  * @param options
700
1045
  * @returns
@@ -704,7 +1049,9 @@ declare function reverse(position: Position, options?: ReverseGeocodingOptions):
704
1049
  * Perform a geocoding query to MapTiler API to obtain fature by its ID.
705
1050
  * Providing a feature ID, this function returns a feature which includes its full geometry.
706
1051
  * Note that the feature ID is not stable and it changes when the database is re-indexed.
1052
+ *
707
1053
  * Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#search-by-feature-id
1054
+ *
708
1055
  * @param id
709
1056
  * @param options
710
1057
  * @returns
@@ -713,7 +1060,9 @@ declare function byId(id: string, options?: ByIdGeocodingOptions): Promise<Geoco
713
1060
  /**
714
1061
  * Perform a batch geocoding query to MapTiler API.
715
1062
  * Provide multiple queries in the array. Each query can be forward, reverse or by feature ID.
1063
+ *
716
1064
  * Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#batch-geocoding
1065
+ *
717
1066
  * @param queries
718
1067
  * @param options
719
1068
  * @returns
@@ -1330,6 +1679,7 @@ type MapStyleType = {
1330
1679
  VOYAGER: ReferenceMapStyle & {
1331
1680
  /**
1332
1681
  * A nice alternative to `streets` with a soft color palette
1682
+ *
1333
1683
  */
1334
1684
  DEFAULT: MapStyleVariant;
1335
1685
  /**
@@ -1409,6 +1759,37 @@ type MapStyleType = {
1409
1759
  */
1410
1760
  LIGHT: MapStyleVariant;
1411
1761
  };
1762
+ LANDSCAPE: ReferenceMapStyle & {
1763
+ /**
1764
+ * Light terrain map for data overlays and visualisations
1765
+ */
1766
+ DEFAULT: MapStyleVariant;
1767
+ /**
1768
+ * Dark terrain map for data overlays and visualisations
1769
+ */
1770
+ DARK: MapStyleVariant;
1771
+ /**
1772
+ * Vivid terrain map for data overlays and visualisations
1773
+ */
1774
+ VIVID: MapStyleVariant;
1775
+ };
1776
+ /**
1777
+ * Watercolor map for creative use
1778
+ */
1779
+ AQUARELLE: ReferenceMapStyle & {
1780
+ /**
1781
+ * Watercolor map for creative use
1782
+ */
1783
+ DEFAULT: MapStyleVariant;
1784
+ /**
1785
+ * Dark watercolor map for creative use
1786
+ */
1787
+ DARK: MapStyleVariant;
1788
+ /**
1789
+ * Vivid watercolor map for creative use
1790
+ */
1791
+ VIVID: MapStyleVariant;
1792
+ };
1412
1793
  };
1413
1794
  declare const mapStylePresetList: Array<MapStylePreset>;
1414
1795
  declare function styleToStyle(style: string | ReferenceMapStyle | MapStyleVariant | null | undefined): string;
@@ -1796,4 +2177,4 @@ declare const misc: {
1796
2177
  simplify: typeof simplify;
1797
2178
  };
1798
2179
 
1799
- export { type AutomaticStaticMapOptions, type BoundedStaticMapOptions, type BufferToPixelDataFunction, type ByIdGeocodingOptions, type CenteredStaticMapOptions, ClientConfig, type CommonForwardAndReverseGeocodingOptions, type CoordinateExport, type CoordinateGrid, type CoordinateId, type CoordinateSearch, type CoordinateSearchResult, type CoordinateTransformResult, type CoordinateTransformation, type Coordinates, type CoordinatesSearchOptions, type CoordinatesTransformOptions, type DefaultTransformation, type ElevationAtOptions, type ElevationBatchOptions, type FeatureHierarchy, type FetchFunction, type GeocodingFeature, type GeocodingOptions, type GeocodingSearchResult, type GeolocationInfoOptions, type GeolocationResult, type GetDataOptions, Language, type LanguageGeocodingOptions, type LanguageInfo, MapStyle, type MapStylePreset, type MapStyleType, MapStyleVariant, type PixelData, ReferenceMapStyle, type ReverseGeocodingOptions, ServiceError, type StaticMapBaseOptions, type StaticMapMarker, type TileJSON, type XYZ, areSameLanguages, bufferToPixelDataBrowser, circumferenceAtLatitude, config, coordinates, data, elevation, expandMapStyle, geocoding, geolocation, getAutoLanguage, getBufferToPixelDataParser, getLanguageInfoFromCode, getLanguageInfoFromFlag, getLanguageInfoFromKey, getTileCache, isLanguageInfo, mapStylePresetList, math, misc, staticMaps, styleToStyle, toLanguageInfo };
2180
+ export { type AutomaticStaticMapOptions, type BoundedStaticMapOptions, type BufferToPixelDataFunction, type ByIdGeocodingOptions, type CenteredStaticMapOptions, ClientConfig, type CommonForwardAndReverseGeocodingOptions, type CoordinateExport, type CoordinateGrid, type CoordinateId, type CoordinateSearch, type CoordinateSearchResult, type CoordinateTransformResult, type CoordinateTransformation, type Coordinates, type CoordinatesSearchOptions, type CoordinatesTransformOptions, type DefaultTransformation, type ElevationAtOptions, type ElevationBatchOptions, type FeatureHierarchy, type FetchFunction, type GeocodingFeature, type GeocodingOptions, type GeocodingPlaceType, type GeocodingSearchResult, type GeolocationInfoOptions, type GeolocationResult, type GetDataOptions, ISOLanguage, Language, type LanguageGeocodingOptions, type LanguageInfo, MapStyle, type MapStylePreset, type MapStyleType, MapStyleVariant, NonISOLanguage, type PixelData, ReferenceMapStyle, type ReverseGeocodingOptions, ServiceError, type StaticMapBaseOptions, type StaticMapMarker, type TileJSON, type XYZ, areSameLanguages, bufferToPixelDataBrowser, circumferenceAtLatitude, config, coordinates, data, elevation, expandMapStyle, geocoding, geolocation, getAutoLanguage, getBufferToPixelDataParser, getLanguageInfoFromCode, getLanguageInfoFromFlag, getLanguageInfoFromKey, getTileCache, isLanguageInfo, mapStylePresetList, math, misc, staticMaps, styleToStyle, toLanguageInfo };