@tomtom-org/maps-sdk 0.57.0 → 0.58.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.
@@ -446,13 +446,11 @@ type GetPositionOptions = {
446
446
  * * tomtom-user-agent - Name and version of this SDK
447
447
  * * Authorization - Bearer token for experimental OAuth2 support.
448
448
  * Based on the apiAccessToken parameter.
449
- * Tracking-ID - @see https://docs.tomtom.com/search-api/documentation/search-service/fuzzy-search#trackingid-request
450
449
  * @ignore
451
450
  */
452
451
  type TomTomHeaders = {
453
452
  'tomtom-user-agent'?: string;
454
453
  Authorization?: string;
455
- 'Tracking-ID'?: string;
456
454
  };
457
455
  /**
458
456
  * Service-specific TomTom API headers, declared per-request by a service's
@@ -1613,14 +1611,14 @@ export type CommonPlaceProps = {
1613
1611
  /**
1614
1612
  * Properties for reverse geocoded places.
1615
1613
  *
1616
- * Extends common place properties with reverse geocoding-specific information
1617
- * like the original query position and address interpolation details.
1614
+ * Extends common place properties with the position the service matched. The feature's own
1615
+ * `geometry` holds the position that was queried.
1618
1616
  *
1619
1617
  * @group Place
1620
1618
  */
1621
1619
  export type RevGeoAddressProps = CommonPlaceProps & {
1622
1620
  /**
1623
- * Original coordinates used in the reverse geocoding query [longitude, latitude].
1621
+ * Coordinates the service matched the queried position to [longitude, latitude].
1624
1622
  */
1625
1623
  originalPosition: Position;
1626
1624
  };
@@ -1963,7 +1961,7 @@ type PoiDetailsDataSource = {
1963
1961
  /**
1964
1962
  * @group Place
1965
1963
  */
1966
- export declare const poiCategories: readonly ["ACCESS_GATEWAY", "ADVENTURE_SPORTS_FACILITY", "ADVENTURE_VEHICLE_TRAIL", "ADVERTISING_COMPANY", "AFGHAN_RESTAURANT", "AFRICAN_RESTAURANT", "AGRICULTURAL_SUPPLIES", "AGRICULTURAL_TECHNOLOGY", "AGRICULTURE", "AIRFIELD", "AIRLINE_ACCESS", "AIRLINE_COMPANY", "AIRPORT", "AMBULANCE_UNIT", "AMERICAN_RESTAURANT", "AMPHITHEATER", "AMUSEMENT_PARK", "AMUSEMENT_PLACE", "ANIMAL_SERVICES", "ANIMAL_SHELTER", "ANTIQUE_ART_SHOP", "APARTMENT_RENTAL", "AQUATIC_ZOO", "ARABIAN_RESTAURANT", "ARBORETA_BOTANICAL_GARDENS", "ARCH", "ARMENIAN_RESTAURANT", "ART_SCHOOL", "ASIAN_RESTAURANT", "ATHLETICS_TRACK", "ATM", "ATV_DEALER", "AUSTRALIAN_RESTAURANT", "AUSTRIAN_RESTAURANT", "AUTOMOBILE_COMPANY", "AUTOMOBILE_MANUFACTURING", "AUTOMOTIVE_DEALER", "BAGS_LEATHERWEAR", "BAKERY", "BANK", "BANQUET_ROOMS", "BAR", "BARBECUE_RESTAURANT", "BASEBALL_PARK", "BASKETBALL_ARENA", "BASQUE_RESTAURANT", "BATTLEFIELD", "BAY", "BEACH", "BEACH_CLUB", "BEAUTY_SALON", "BEAUTY_SUPPLIES", "BELGIAN_RESTAURANT", "BETTING_STATION", "BISTRO", "BLOOD_BANK", "BOATING_EQUIPMENT_ACCESSORIES", "BOAT_DEALER", "BOAT_LAUNCHING_RAMP", "BODYSHOP", "BOLIVIAN_RESTAURANT", "BOOK_SHOP", "BOWLING_CENTER", "BRAZILIAN_RESTAURANT", "BRIDGE", "BRITISH_RESTAURANT", "BUFFET_RESTAURANT", "BUILDING", "BULGARIAN_RESTAURANT", "BUNGALOW_RENTAL", "BURMESE_RESTAURANT", "BUSINESS_PARK", "BUSINESS_SERVICES", "BUS_CHARTER_COMPANY", "BUS_DEALER", "BUS_LINES", "BUS_STOP", "BUTCHER", "B_B_GUEST_HOUSE", "CABARET_THEATER", "CABINS_LODGES", "CABLE_TELEPHONE_COMPANY", "CAFE", "CAFETERIA", "CAFE_PUB", "CALIFORNIAN_RESTAURANT", "CAMBODIAN_RESTAURANT", "CAMERAS_PHOTOGRAPHY", "CAMPING_GROUND", "CANADIAN_RESTAURANT", "CAPE", "CARAVAN_SITE", "CARIBBEAN_RESTAURANT", "CARPET_FLOOR_COVERINGS", "CAR_DEALER", "CAR_GLASS_REPLACEMENT_SHOP", "CAR_REPAIR_AND_SERVICE", "CAR_WASH", "CASINO", "CATERING_SERVICES", "CAVE", "CEMETERY", "CHALET_RENTAL", "CHEMICAL_COMPANY", "CHICKEN_RESTAURANT", "CHILDRENS_CLOTHES", "CHILD_CARE_FACILITY", "CHINESE_RESTAURANT", "CHRISTMAS_HOLIDAY_SHOP", "CHURCH", "CINEMA", "CLEANING_SERVICES", "CLOTHING_SHOP", "CLUB_ASSOCIATION", "COCKTAIL_BAR", "COFFEE_SHOP", "COLLEGE_OR_UNIVERSITY", "COLLEGE_UNIVERSITY", "COLOMBIAN_RESTAURANT", "COMEDY_CLUB", "COMMERCIAL_BUILDING", "COMMUNITY_CENTER", "COMPANY", "COMPUTER_COMPUTER_SUPPLIES", "COMPUTER_DATA_SERVICES", "CONCERT_HALL", "CONSTRUCTION_COMPANY", "CONSTRUCTION_MATERIAL_EQUIPMENT", "CONSUMER_ELECTRONICS", "CONVENIENCE_STORE", "CORSICAN_RESTAURANT", "COTTAGE_RENTAL", "COURIER_DROP_BOX", "COURTHOUSE", "COVE", "CREOLE_RESTAURANT", "CREPERIE", "CRICKET_GROUND", "CUBAN_RESTAURANT", "CULTURAL_CENTER", "CURRENCY_EXCHANGE", "CURTAINS_TEXTILES", "CZECH_RESTAURANT", "C_DS_DVD_VIDEOS", "DAM", "DANCE_STUDIO_SCHOOL", "DANISH_RESTAURANT", "DELICATESSEN", "DELIVERY_SERVICE", "DENTIST", "DEPARTMENT_STORE", "DINNER_THEATER", "DISCO_CLUB", "DIVERSIFIED_FINANCIALS", "DOCTOR", "DONGBEI_RESTAURANT", "DOUGHNUT_RESTAURANT", "DO_IT_YOURSELF_CENTERS", "DRIVE_IN_MOVIES", "DRIVE_THROUGH_BOTTLE_SHOP", "DRIVING_SCHOOL", "DRUG_STORE", "DRY_CLEANER", "DUNE", "DUTCH_RESTAURANT", "EGYPTIAN_RESTAURANT", "ELECTRICAL_APPLIANCES_SHOP", "ELECTRIC_VEHICLE_STATION", "ELECTRONICS_COMPANY", "EMBASSY", "EMERGENCY_MEDICAL_SERVICE", "EMERGENCY_ROOM", "ENGLISH_RESTAURANT", "ENTERTAINMENT", "EQUIPMENT_RENTAL", "ETHIOPIAN_RESTAURANT", "EXCHANGE", "EXHIBITION_CONVENTION_CENTER", "FACTORY_OUTLET", "FAIRGROUND", "FARM", "FARMERS_MARKET", "FAST_FOOD", "FERRY_TERMINAL", "FINNISH_RESTAURANT", "FIRE_STATION_BRIGADE", "FISHING_HUNTING_AREA", "FISHMONGER", "FITNESS_CLUB_CENTER", "FLATS_APARTMENT_COMPLEX", "FLORISTS", "FONDUE_RESTAURANT", "FOOD_MARKET", "FOOTBALL_STADIUM", "FOOTWEAR_SHOE_REPAIRS", "FOREST_AREA", "FRENCH_RESTAURANT", "FRONTIER_CROSSING", "FUNERAL_SERVICE_MORTUARIES", "FURNITURE_HOME_FURNISHINGS", "FUSION_RESTAURANT", "GARDEN_CENTERS_SERVICES", "GAS_STATION", "GENERAL_HOSPITAL_AND_POLYCLINIC", "GENERAL_PRACTITIONER", "GEOGRAPHIC_FEATURE", "GERMAN_RESTAURANT", "GIFTS_CARDS_NOVELTIES_SOUVENIRS", "GLASSWARE_CERAMIC_SHOP", "GLASS_WINDOWS_STORE", "GOLD_EXCHANGE", "GOLF_COURSE", "GOVERNMENT_OFFICE", "GREEK_RESTAURANT", "GREENGROCER", "GRILL_RESTAURANT", "GROCERY_STORE", "GURUDWARA", "HAIRDRESSER", "HAMBURGER_RESTAURANT", "HARBOR", "HARDWARE_STORE", "HAWAIIAN_RESTAURANT", "HEALTH_CARE_SERVICE", "HELIPAD_HELICOPTER_LANDING", "HIGH_SCHOOL", "HIKING_TRAIL", "HILL", "HISTORICAL_PARK", "HISTORIC_SITE", "HOBBY_SHOP", "HOCKEY_CLUB", "HOLIDAY_RENTAL", "HOME_APPLIANCE_REPAIR", "HORSE_RACING_TRACK", "HORSE_RIDING_CENTER", "HORSE_RIDING_TRAIL", "HORTICULTURE", "HOSPITAL", "HOSPITAL_FOR_WOMEN_AND_CHILDREN", "HOSPITAL_OF_CHINESE_MEDICINE", "HOSTEL", "HOTEL", "HOTEL_MOTEL", "HOT_POT_RESTAURANT", "HOUSE_GARDEN_FURNITURE_FITTINGS", "HUNAN_RESTAURANT", "HUNGARIAN_RESTAURANT", "ICE_CREAM_PARLOR", "ICE_HOCKEY_ARENA", "ICE_SKATING_RINK", "IMPORT_EXPORT_AND_DISTRIBUTION", "INDIAN_RESTAURANT", "INDONESIAN_RESTAURANT", "INDUSTRIAL_BUILDING", "INFORMAL_MARKET", "INSURANCE_COMPANY", "INTERNATIONAL_RAILROAD_STATION", "INTERNATIONAL_RESTAURANT", "INTERNET_CAFE", "INVESTMENT_ADVISOR", "IRANIAN_RESTAURANT", "IRISH_RESTAURANT", "ISLAND", "ISRAELI_RESTAURANT", "ITALIAN_RESTAURANT", "JAMAICAN_RESTAURANT", "JAPANESE_RESTAURANT", "JAZZ_CLUB", "JEWELRY_CLOCKS_WATCHES", "JEWISH_RESTAURANT", "JUNIOR_COLLEGE_COMMUNITY_COLLEGE", "KARAOKE_CLUB", "KITCHENS_BATHROOMS", "KOREAN_RESTAURANT", "KOSHER_RESTAURANT", "LANGUAGE_SCHOOL", "LATIN_AMERICAN_RESTAURANT", "LAUNDRY", "LEBANESE_RESTAURANT", "LEGAL_SERVICES", "LEISURE_CENTER", "LEISURE_SPORTS_CENTER", "LIBRARY", "LIGHTING_SHOPS", "LOCALE", "LOCAL_SPECIALITIES_SHOP", "LOTTERY_SHOP", "MANUFACTURING_COMPANY", "MANUFACTURING_FACILITY", "MARIJUANA_DISPENSARY", "MARINA", "MARKET", "MARSH", "MAUSOLEUM_GRAVE", "MECHANICAL_ENGINEERING", "MEDIA_FACILITY", "MEDICAL_SUPPLIES_EQUIPMENT", "MEDICINAL_MARIJUANA_DISPENSARY", "MEDITERRANEAN_RESTAURANT", "MEMORIAL", "MENS_CLOTHING", "MEXICAN_RESTAURANT", "MICROBREWERY", "MIDDLE_EASTERN_RESTAURANT", "MIDDLE_SCHOOL", "MILITARY_AIRPORT", "MINERAL_HOT_SPRINGS", "MINING_COMPANY", "MOBILE_PHONE_SHOP", "MONGOLIAN_RESTAURANT", "MONUMENT", "MOROCCAN_RESTAURANT", "MOSQUE", "MOTEL", "MOTORCYCLE_DEALER", "MOTORCYCLE_REPAIR", "MOTORING_ORGANIZATION_OFFICE", "MOTOR_RACING_STADIUM", "MOUNTAIN_BIKE_TRAIL", "MOUNTAIN_PASS", "MOUNTAIN_PEAK", "MOVIE_THEATER", "MOVING_STORAGE_COMPANY", "MULTI_PURPOSE_STADIUM", "MUSEUM", "MUSIC_CENTER", "MUSIC_INSTRUMENTS_STORE", "NAIL_SALON", "NATIONAL_RAILROAD_STATION", "NATIVE_RESERVATION", "NATURAL_TOURIST_ATTRACTION", "NEPALESE_RESTAURANT", "NETBALL_STADIUM", "NEWSAGENTS_TOBACCONISTS", "NIGHTLIFE", "NON_GOVERNMENTAL_ORGANIZATION", "NORWEGIAN_RESTAURANT", "OASIS", "OBSERVATORY", "OFFICE_EQUIPMENT", "OIL_NATURAL_GAS", "OPEN_CAR_PARKING_AREA", "OPEN_PARKING_AREA", "OPERA_HOUSE", "OPTICIAN", "ORGANIC_FOOD_RESTAURANT", "ORIENTAL_RESTAURANT", "OTHER_FOOD_SHOPS", "OTHER_WINTER_SPORT", "PAGODA", "PAINTING_DECORATING", "PAKISTANI_RESTAURANT", "PARK", "PARKING_GARAGE", "PARKWAY", "PARK_RECREATION_AREA", "PASSENGER_TRANSPORT_TICKET_OFFICE", "PAWN_SHOP", "PERSONAL_CARE_FACILITY", "PERSONAL_SERVICE", "PERFORMING_ARTS_THEATER", "PERUVIAN_RESTAURANT", "PET_SUPPLIES", "PHARMACEUTICAL_COMPANY", "PHARMACY", "PHILIPPINE_RESTAURANT", "PHOTOCOPY_SHOP", "PHOTO_LAB_DEVELOPMENT", "PICNIC_AREA", "PIZZERIA", "PLACE_OF_WORSHIP", "PLAIN_FLAT", "PLANETARIUM", "PLATEAU", "POLICE_STATION", "POLISH_RESTAURANT", "POLYNESIAN_RESTAURANT", "PORTUGUESE_RESTAURANT", "PORT_WAREHOUSE_FACILITY", "POST_OFFICE", "PRE_SCHOOL", "PRIMARY_PRODUCER", "PRIMARY_RESOURCE_UTILITY", "PRIMARY_SCHOOL", "PRISON_CORRECTIONAL_FACILITY", "PRIVATE_AIRPORT", "PROTECTED_AREA", "PUB", "PUBLIC_AIRPORT", "PUBLIC_AMENITY", "PUBLIC_CALL_BOX", "PUBLIC_MARKET", "PUBLIC_TOILET", "PUBLIC_TRANSPORT_STOP", "PUBLISHING_TECHNOLOGIES", "PUB_FOOD", "QUARRY", "RACE_TRACK", "RAILWAY_STATION", "RAPIDS", "REAL_ESTATE_AGENT", "REAL_ESTATE_COMPANY", "RECREATIONAL_CAMPING_GROUND", "RECREATIONAL_MARIJUANA_DISPENSARY", "RECREATIONAL_VEHICLE_DEALER", "RECREATION_AREA", "RECYCLING_SHOP", "REEF", "RENT_A_CAR_FACILITY", "RENT_A_CAR_PARKING", "REPAIR_FACILITY", "RESEARCH_FACILITY", "RESERVOIR", "RESIDENTIAL_ACCOMMODATION", "RESORT", "RESTAURANT", "RESTAURANT_AREA", "REST_AREA", "REST_CAMP", "RETAIL_OUTLET", "RETIREMENT_COMMUNITY", "RIDGE", "RIVER_CROSSING", "ROAD_RESCUE", "ROAD_TRAFFIC_CONTROL_CENTER", "ROCKS", "ROCK_CLIMBING_TRAIL", "RUGBY_GROUND", "RUSSIAN_RESTAURANT", "SALAD_BAR", "SANDWICH_RESTAURANT", "SAUNA_SOLARIUM_MASSAGE", "SCANDINAVIAN_RESTAURANT", "SCENIC_PANORAMIC_VIEW", "SCHOOL", "SCHOOL_BUS_COMPANY", "SEAFOOD", "SECURED_ENTRANCE", "SECURITY_PRODUCTS", "SENIOR_HIGH_SCHOOL", "SERVICE_COMPANY", "SHANDONG_RESTAURANT", "SHOP", "SHOPPING_CENTER", "SHOPPING_SERVICE", "SICHUAN_RESTAURANT", "SKI_RESORT", "SNACKS_RESTAURANT", "SNOOKER_POOL_BILLIARD", "SOCCER_STADIUM", "SOFTWARE_COMPANY", "SOUL_FOOD", "SOUP_RESTAURANT", "SPANISH_RESTAURANT", "SPECIALIST", "SPECIALTY_CLOTHING_SHOP", "SPECIALTY_FOODS", "SPECIAL_HOSPITAL", "SPORTS_CENTER", "SPORTS_EQUIPMENT_CLOTHING", "SQUASH_COURT", "STADIUM", "STATION_ACCESS", "STATUE", "STEAK_HOUSE", "STOCK_EXCHANGE", "STREETCAR_STOP", "SUBWAY_STATION", "SUPERMARKETS_HYPERMARKETS", "SUSHI_RESTAURANT", "SWEDISH_RESTAURANT", "SWIMMING_POOL", "SWISS_RESTAURANT", "SYNAGOG", "SYRIAN_RESTAURANT", "TAILOR_SHOP", "TAIWANESE_RESTAURANT", "TAKEOUT_FOOD", "TAPAS_RESTAURANT", "TAXI_LIMOUSINE_SHUTTLE_SERVICE", "TAXI_STAND", "TAX_SERVICES", "TEA_HOUSE", "TELECOMMUNICATIONS", "TEMPLE", "TENNIS_COURT", "TEPPANYAKI_RESTAURANT", "THAI_RESTAURANT", "THEATER", "THEMATIC_SPORT_CENTER", "TIBETAN_RESTAURANT", "TIRE_SERVICE", "TOLL_GATE", "TOURIST_ATTRACTION", "TOURIST_INFORMATION_OFFICE", "TOWER", "TOYS_GAMES_SHOP", "TRAFFIC_CONTROL_DEPARTMENT", "TRAIL_SYSTEM", "TRANSPORT_AUTHORITY_VEHICLE_REGISTRATION", "TRANSPORT_COMPANY", "TRAVEL_AGENT", "TRUCK_DEALER", "TRUCK_REPAIR_AND_SERVICE", "TRUCK_STOP", "TUNISIAN_RESTAURANT", "TUNNEL", "TURKISH_RESTAURANT", "URBAN_STATION", "VALLEY", "VAN_DEALER", "VARIETY_STORE", "VEGETARIAN_RESTAURANT", "VENEZUELAN_RESTAURANT", "VETERINARIAN", "VIDEO_RENTAL_SHOP", "VIETNAMESE_RESTAURANT", "VILLA_RENTAL", "VOCATIONAL_SCHOOL", "WATER_HOLE", "WATER_SPORT", "WEDDING_SERVICES", "WEIGH_STATION", "WELFARE_ORGANIZATION", "WELL", "WESTERN_RESTAURANT", "WHOLESALE_CLUB", "WILDERNESS_AREA", "WILDLIFE_PARK", "WINERY", "WINE_SPIRITS", "WOMENS_CLOTHING", "YACHT_BASIN", "YOGURT_JUICE_BAR", "ZOO", "ZOOS_ARBORETA_BOTANICAL_GARDEN"];
1964
+ export declare const poiCategories: readonly ["ABORIGINAL_LAND", "ADVENTURE_SPORTS_FACILITY", "ADVENTURE_VEHICLE_TRAIL", "ADVERTISING_COMPANY", "AFGHAN_RESTAURANT", "AFRICAN_RESTAURANT", "AGRICULTURAL_SUPPLIES", "AGRICULTURAL_TECHNOLOGY", "AGRICULTURE", "AIRFIELD", "AIRLINE_ACCESS", "AIRLINE_COMPANY", "AIRPORT", "AMBULANCE_UNIT", "AMERICAN_RESTAURANT", "AMPHITHEATER", "AMUSEMENT_PARK", "AMUSEMENT_PLACE", "ANIMAL_SERVICE", "ANIMAL_SHELTER", "ANTIQUE_ART_SHOP", "APARTMENT_RENTAL", "AQUATIC_ZOO", "ARABIAN_RESTAURANT", "ARBORETA_AND_BOTANICAL_GARDENS", "ARCH", "ARMENIAN_RESTAURANT", "ART_SCHOOL", "ASIAN_RESTAURANT", "ATHLETICS_TRACK", "ATM", "ATV_DEALER", "AUSTRALIAN_RESTAURANT", "AUSTRIAN_RESTAURANT", "AUTOMOBILE_COMPANY", "AUTOMOBILE_MANUFACTURING", "BAGS_LEATHERWEAR", "BAKERY", "BANDB_OR_GUEST_HOUSE", "BANK", "BANQUET_ROOMS", "BAR", "BARBECUE_RESTAURANT", "BASEBALL_PARK", "BASKETBALL_ARENA", "BASQUE_RESTAURANT", "BATTLEFIELD", "BAY", "BEACH", "BEACH_CLUB", "BEAUTY_SALON", "BEAUTY_SUPPLIES", "BELGIAN_RESTAURANT", "BETTING_STATION", "BISTRO", "BLOOD_BANK", "BOATING_EQUIPMENT_AND_ACCESSORIES", "BOAT_DEALER", "BOAT_LAUNCHING_RAMP", "BODYSHOP", "BOLIVIAN_RESTAURANT", "BOOK_SHOP", "BORDER_CONTROL", "BOWLING_CENTER", "BRAZILIAN_RESTAURANT", "BRIDGE", "BRITISH_RESTAURANT", "BUFFET_RESTAURANT", "BUILDING", "BULGARIAN_RESTAURANT", "BUNGALOW_RENTAL", "BURMESE_RESTAURANT", "BUSINESS_PARK", "BUSINESS_SERVICES", "BUS_CHARTER_COMPANY", "BUS_DEALER", "BUS_LINES", "BUS_STOP", "BUTCHER", "CABARET_THEATER", "CABINS_LODGES", "CABLE_AND_TELEPHONE_COMPANY", "CAFE", "CAFETERIA", "CAFE_PUB", "CALIFORNIAN_RESTAURANT", "CAMBODIAN_RESTAURANT", "CAMERAS_AND_PHOTOGRAPHY", "CAMPING_GROUND", "CANADIAN_RESTAURANT", "CANNABIS_SHOP", "CAPE", "CARAVAN_SITE", "CARIBBEAN_RESTAURANT", "CARPET_FLOOR_COVERINGS", "CAR_DEALER", "CAR_GLASS_REPLACEMENT_SHOP", "CAR_RENTAL", "CAR_REPAIR_AND_SERVICE", "CAR_WASH", "CASINO_AND_GAMBLING", "CATERING_SERVICES", "CAVE", "CEMETERY", "CHALET_RENTAL", "CHARGING_LOCATION", "CHEMICAL_COMPANY", "CHICKEN_RESTAURANT", "CHILDCARE", "CHILDREN_S_CLOTHES", "CHILEAN_RESTAURANT", "CHINESE_RESTAURANT", "CHRISTMAS_OR_HOLIDAY_SHOP", "CHURCH", "CINEMA", "CLEANING_SERVICES", "CLOTHING_SHOP", "CLUB_AND_ASSOCIATION", "COCKTAIL_BAR", "COFFEE_SHOP", "COLLEGE_OR_UNIVERSITY", "COLOMBIAN_RESTAURANT", "COMEDY_CLUB", "COMMERCIAL_BUILDING", "COMMUNITY_CENTER", "COMPANY", "COMPUTER_AND_COMPUTER_SUPPLIES", "COMPUTER_AND_DATA_SERVICES", "CONCERT_HALL", "CONSTRUCTION_COMPANY", "CONSTRUCTION_MATERIAL_AND_EQUIPMENT", "CONSUMER_ELECTRONICS", "CONVENIENCE_STORE", "CORSICAN_RESTAURANT", "COTTAGE_RENTAL", "COURIER_DROP_BOX", "COURTHOUSE", "COVE", "CREOLE_RESTAURANT", "CREPERIE", "CRICKET_GROUND", "CUBAN_RESTAURANT", "CULTURAL_CENTER", "CURTAINS_TEXTILES", "CZECH_RESTAURANT", "C_DS_DVD_VIDEOS", "DAM", "DANCE_STUDIO_AND_SCHOOL", "DANISH_RESTAURANT", "DELICATESSEN", "DELIVERY_SERVICE", "DENTIST", "DEPARTMENT_STORE", "DINNER_THEATER", "DISCO_CLUB", "DIVERSIFIED_FINANCIALS", "DOCTOR", "DONGBEI_RESTAURANT", "DOUGHNUT_RESTAURANT", "DO_IT_YOURSELF_CENTERS", "DRIVE_IN_MOVIES", "DRIVE_THROUGH_BOTTLE_SHOP", "DRIVING_SCHOOL", "DRUG_STORE", "DRY_CLEANER", "DUNE", "DUTCH_RESTAURANT", "EGYPTIAN_RESTAURANT", "ELECTRICAL_APPLIANCES_SHOP", "ELECTRONICS_COMPANY", "EMBASSY", "EMERGENCY_MEDICAL_SERVICE", "EMERGENCY_ROOM", "ENGLISH_RESTAURANT", "ENTERTAINMENT", "EQUIPMENT_RENTAL", "ETHIOPIAN_RESTAURANT", "EXCHANGE", "EXHIBITION_CONVENTION_CENTER", "FACTORY_OUTLET", "FAIRGROUND", "FARM", "FARMERS_MARKET", "FAST_FOOD", "FERRY_TERMINAL", "FINNISH_RESTAURANT", "FIRE_STATION", "FISHING_AND_HUNTING_AREA", "FISHMONGER", "FITNESS_CLUB_AND_CENTER", "FLATS_OR_APARTMENT_COMPLEX", "FLORISTS", "FLYING_CLUB", "FONDUE_RESTAURANT", "FOOD_AND_DRINKS_SHOP", "FOOD_MARKET", "FOOTBALL_STADIUM", "FOOTWEAR_SHOE_REPAIRS", "FOREIGN_EXCHANGE", "FOREST_AREA", "FRENCH_RESTAURANT", "FUEL_STATION", "FUNERAL_SERVICE_AND_MORTUARIES", "FURNITURE_HOME_FURNISHINGS", "FUSION_RESTAURANT", "GARDEN_CENTERS_SERVICES", "GENERAL_HOSPITAL_AND_POLYCLINIC", "GENERAL_PRACTITIONER", "GERMAN_RESTAURANT", "GIFTS_CARDS_NOVELTIES_SOUVENIRS", "GLASSWARE_CERAMIC_SHOP", "GLASS_WINDOWS_STORE", "GOLD_EXCHANGE", "GOLF_COURSE", "GOVERNMENT_OFFICE", "GREEK_RESTAURANT", "GREENGROCER", "GRILL_RESTAURANT", "GROCERY_STORE", "GURUDWARA", "HAIRDRESSER", "HAMBURGER_RESTAURANT", "HARBOR", "HARDWARE_STORE", "HAWAIIAN_RESTAURANT", "HEALTHCARE_SERVICE", "HELIPORT_OR_HELIPAD", "HIGH_SCHOOL", "HIKING_TRAIL", "HILL", "HISTORICAL_PARK", "HISTORIC_SITE", "HOBBY_SHOP", "HOCKEY_CLUB", "HOLIDAY_RENTAL", "HOME_APPLIANCE_REPAIR", "HORSE_RACING_TRACK", "HORSE_RIDING", "HORSE_RIDING_TRAIL", "HORTICULTURE", "HOSPITAL", "HOSPITAL_FOR_WOMEN_AND_CHILDREN", "HOSPITAL_OF_CHINESE_MEDICINE", "HOSTEL", "HOTEL", "HOTEL_OR_MOTEL", "HOT_POT_RESTAURANT", "HOUSE_AND_GARDEN_FURNITURE_AND_FITTINGS", "HUNAN_RESTAURANT", "HUNGARIAN_RESTAURANT", "ICE_CREAM_PARLOR", "ICE_HOCKEY_ARENA", "ICE_RINK", "IMPORT_OR_EXPORT_AND_DISTRIBUTION", "INDIAN_RESTAURANT", "INDONESIAN_RESTAURANT", "INDUSTRIAL_BUILDING", "INFORMAL_MARKET", "INSURANCE_COMPANY", "INTERNATIONAL_RAILROAD_STATION", "INTERNATIONAL_RESTAURANT", "INTERNET_CAFE", "INVESTMENT_ADVISOR", "IRANIAN_RESTAURANT", "IRISH_RESTAURANT", "ISLAND", "ISRAELI_RESTAURANT", "ITALIAN_RESTAURANT", "JAMAICAN_RESTAURANT", "JAPANESE_RESTAURANT", "JAZZ_CLUB", "JEWELRY_CLOCKS_WATCHES", "JEWISH_RESTAURANT", "JUICE_BAR", "JUNIOR_COLLEGE_OR_COMMUNITY_COLLEGE", "KARAOKE_CLUB", "KITCHENS_BATHROOMS", "KOREAN_RESTAURANT", "KOSHER_RESTAURANT", "LANGUAGE_SCHOOL", "LATIN_AMERICAN_RESTAURANT", "LAUNDRY", "LEBANESE_RESTAURANT", "LEGAL_SERVICES", "LEISURE_CENTER", "LIGHTING_SHOPS", "LOCALE", "LOCAL_SPECIALITIES_SHOP", "LOTTERY_SHOP", "MALL", "MANUFACTURING_COMPANY", "MANUFACTURING_FACILITY", "MARINA", "MARKETPLACE", "MARSH", "MAUSOLEUM_OR_GRAVE", "MECHANICAL_ENGINEERING", "MEDIA_FACILITY", "MEDICAL_SUPPLIES_EQUIPMENT", "MEDICINAL_AND_RECREATIONAL_DISPENSARY", "MEDICINAL_MARIJUANA_DISPENSARY", "MEDITERRANEAN_RESTAURANT", "MEMORIAL", "MEN_S_CLOTHING", "MEXICAN_RESTAURANT", "MICROBREWERY", "MIDDLE_EASTERN_RESTAURANT", "MIDDLE_SCHOOL", "MILITARY_AIRPORT", "MINERAL_OR_HOT_SPRINGS", "MINING_COMPANY", "MOBILE_PHONE_SHOP", "MONGOLIAN_RESTAURANT", "MONUMENT", "MOROCCAN_RESTAURANT", "MOSQUE", "MOTEL", "MOTORCYCLE_DEALER", "MOTORCYCLE_REPAIR", "MOTORING_ORGANIZATION_OFFICE", "MOTOR_RACING_STADIUM", "MOUNTAIN_BIKE_TRAIL", "MOUNTAIN_PASS", "MOUNTAIN_PEAK", "MOVIE_THEATER", "MOVING_AND_STORAGE_COMPANY", "MULTI_PURPOSE_STADIUM", "MUSEUM", "MUSIC_CENTER", "MUSIC_INSTRUMENTS_STORE", "NAIL_SALON", "NATIONAL_RAILROAD_STATION", "NATURAL_FEATURE", "NATURAL_TOURIST_ATTRACTION", "NEPALESE_RESTAURANT", "NETBALL_STADIUM", "NEWSAGENTS_TOBACCONISTS", "NIGHTLIFE", "NON_GOVERNMENTAL_ORGANIZATION", "NORWEGIAN_RESTAURANT", "OASIS", "OBSERVATORY", "OFFICE_EQUIPMENT", "OIL_AND_NATURAL_GAS", "OPEN_CAR_PARKING_AREA", "OPERA_HOUSE", "OPTICIAN", "ORGANIC_FOOD_RESTAURANT", "ORIENTAL_RESTAURANT", "PAGODA", "PAINTING_DECORATING", "PAKISTANI_RESTAURANT", "PAN", "PARK", "PARKING_GARAGE", "PARKWAY", "PARK_AND_RECREATION_AREA", "PASSENGER_TRANSPORT_TICKET_OFFICE", "PAWN_SHOP", "PEDESTRIAN_SUBWAY", "PERSONAL_CARE_FACILITY", "PERSONAL_SERVICE", "PERUVIAN_RESTAURANT", "PET_SUPPLIES", "PHARMACEUTICAL_COMPANY", "PHARMACY", "PHILIPPINE_RESTAURANT", "PHOTOCOPY_SHOP", "PHOTO_LAB_OR_DEVELOPMENT", "PICNIC_AREA", "PIZZERIA", "PLAIN_OR_FLAT", "PLANETARIUM", "PLATEAU", "POLICE_STATION", "POLISH_RESTAURANT", "PORTUGUESE_RESTAURANT", "PORT_WAREHOUSE_FACILITY", "POST_OFFICE", "PRE_SCHOOL", "PRIMARY_PRODUCER", "PRIMARY_RESOURCE_UTILITY", "PRIMARY_SCHOOL", "PRISON", "PRIVATE_AIRPORT", "PROTECTED_LAND", "PUB", "PUBLIC_AIRPORT", "PUBLIC_AMENITY", "PUBLIC_BATHROOM", "PUBLIC_CALL_BOX", "PUBLIC_LIBRARY", "PUBLIC_MARKET", "PUBLIC_TRANSPORT_STOP", "PUBLISHING_TECHNOLOGIES", "QUARRY", "RACE_TRACK", "RAILWAY_STATION", "RAPIDS", "REAL_ESTATE_AGENT", "REAL_ESTATE_COMPANY", "RECREATIONAL_CAMPING_GROUND", "RECREATIONAL_MARIJUANA_DISPENSARY", "RECREATIONAL_VEHICLE_DEALER", "RECREATION_AREA", "RECYCLING_SHOP", "REEF", "RELIGIOUS_SITE", "RENTAL_CAR_PARKING", "RESCUE_SERVICE", "RESEARCH_FACILITY", "RESERVOIR", "RESIDENTIAL_ACCOMMODATION", "RESIDENTIAL_ENTRANCE", "RESORT", "RESTAURANT", "RESTAURANT_AREA", "REST_AREA", "REST_CAMP", "RETAIL_OUTLET", "RETIREMENT_COMMUNITY", "RIDGE", "RIVER_CROSSING", "ROCKS", "ROCK_CLIMBING_TRAIL", "RUGBY_GROUND", "RUSSIAN_RESTAURANT", "SALAD_BAR", "SANDWICH_RESTAURANT", "SAUNA_SOLARIUM_MASSAGE", "SCANDINAVIAN_RESTAURANT", "SCHOOL", "SCHOOL_BUS_COMPANY", "SEAFOOD", "SECURED_ENTRANCE", "SECURITY_PRODUCTS", "SENIOR_HIGH_SCHOOL", "SERVICE_COMPANY", "SHANDONG_RESTAURANT", "SHOPPING_SERVICE", "SHOP_OR_STORE", "SICHUAN_RESTAURANT", "SKI_RESORT", "SNACKS_RESTAURANT", "SOCCER_STADIUM", "SOFTWARE_COMPANY", "SOUL_FOOD", "SOUP_RESTAURANT", "SPANISH_RESTAURANT", "SPECIALIST", "SPECIALTY_CLOTHING_SHOP", "SPECIALTY_FOODS", "SPECIAL_HOSPITAL", "SPORTS_CENTER", "SPORTS_EQUIPMENT_AND_CLOTHING", "SQUASH_COURT", "STADIUM", "STATION_ACCESS", "STATUE", "STEAK_HOUSE", "STOCK_EXCHANGE", "STREETCAR_STOP", "SUBWAY_ENTRANCE", "SUBWAY_STATION", "SUPERMARKET", "SUSHI_RESTAURANT", "SWEDISH_RESTAURANT", "SWIMMING_POOL", "SWISS_RESTAURANT", "SYNAGOG", "SYRIAN_RESTAURANT", "TAILOR_SHOP", "TAIWANESE_RESTAURANT", "TAKEOUT_FOOD", "TAPAS_RESTAURANT", "TAXI_LIMOUSINE_AND_SHUTTLE_SERVICE", "TAXI_STAND", "TAX_SERVICES", "TEA_HOUSE", "TELECOMMUNICATIONS", "TEMPLE", "TENNIS_COURT", "TEPPANYAKI_RESTAURANT", "THAI_RESTAURANT", "THEATER", "THEMATIC_SPORT_CENTER", "TIBETAN_RESTAURANT", "TIRE_SERVICE", "TOLL_GATE", "TOURIST_ATTRACTION", "TOURIST_INFORMATION", "TOWER", "TOYS_GAMES_SHOP", "TRAFFIC_CONTROL_DEPARTMENT", "TRAIL_SYSTEM", "TRANSPORT_ACCESS", "TRANSPORT_AUTHORITY_VEHICLE_REGISTRATION", "TRANSPORT_COMPANY", "TRAVEL_AGENT", "TRUCK_DEALER", "TRUCK_REPAIR_AND_SERVICE", "TRUCK_STOP", "TUNISIAN_RESTAURANT", "TUNNEL", "TURKISH_RESTAURANT", "URBAN_STATION", "VALLEY", "VAN_DEALER", "VARIETY_STORE", "VEGETARIAN_RESTAURANT", "VEHICLE_DEALER", "VEHICLE_REPAIR", "VENEZUELAN_RESTAURANT", "VETERINARY", "VIDEO_RENTAL_SHOP", "VIETNAMESE_RESTAURANT", "VIEWPOINT", "VILLA_RENTAL", "VOCATIONAL_SCHOOL", "WATER_HOLE", "WATER_SPORT", "WEDDING_SERVICES", "WEIGH_STATION", "WELFARE_ORGANIZATION", "WELL", "WESTERN_RESTAURANT", "WHOLESALE_CLUB", "WILDERNESS_AREA", "WILDLIFE_PARK", "WINERY", "WINE_SPIRITS", "WOMEN_S_CLOTHING", "YACHT_BASIN", "ZOO", "ZOOS_ARBORETA_BOTANICAL_GARDEN"];
1967
1965
  /**
1968
1966
  * @group Place
1969
1967
  */
@@ -2078,7 +2076,7 @@ type POI = {
2078
2076
  /**
2079
2077
  * Standardized category identifiers for the POI.
2080
2078
  *
2081
- * Machine-readable category names from the {@link POICategory} enum (e.g., `'ITALIAN_RESTAURANT'`, `'GAS_STATION'`, `'HOTEL'`).
2079
+ * Machine-readable category names from the {@link POICategory} enum (e.g., `'ITALIAN_RESTAURANT'`, `'FUEL_STATION'`, `'HOTEL'`).
2082
2080
  * Use these for filtering, programmatic category matching, or mapping to icons.
2083
2081
  * Parsed from the numeric category IDs returned by the API.
2084
2082
  */
@@ -2592,24 +2590,15 @@ type RoutePathPoint = {
2592
2590
  travelTimeInSeconds: number;
2593
2591
  };
2594
2592
  /**
2595
- * Text with phonetic transcription.
2593
+ * A name shown in a guidance instruction: a street, road number, exit, intersection, tollgate or
2594
+ * country.
2596
2595
  * @group Route
2597
2596
  */
2598
- type TextWithPhonetics = {
2597
+ type InstructionText = {
2599
2598
  /**
2600
2599
  * The name as a text string.
2601
2600
  */
2602
2601
  text: string;
2603
- /**
2604
- * The phonetic transcription of the name.
2605
- * Included if phonetic transcription is available for the specific name, and phonetic transcriptions have been requested by the client.
2606
- * Note: The phonetic transcription can contain double quote characters ("). In this case those characters are escaped with a backslash (\).
2607
- */
2608
- phonetic?: string;
2609
- /**
2610
- * Encodes the language using an IETF language tag, e.g., en-GB, en-US.
2611
- */
2612
- phoneticLanguageCode?: string;
2613
2602
  };
2614
2603
  /**
2615
2604
  * Object describes a single road shield reference.
@@ -2637,10 +2626,10 @@ type RoadShield = {
2637
2626
  /**
2638
2627
  * The road number. Most road numbers have a 'letter' prefix, which is also returned.
2639
2628
  */
2640
- roadNumber: TextWithPhonetics;
2629
+ roadNumber: InstructionText;
2641
2630
  /**
2642
2631
  * Information allowing the client to build an image of the road shield using the TomTom RoadShield API.
2643
- * Included if instructionRoadShieldReferences was requested.
2632
+ * Included if a road shield image is available for this road.
2644
2633
  */
2645
2634
  roadShieldReference?: RoadShieldReference;
2646
2635
  /**
@@ -2666,7 +2655,7 @@ type RoadInformation = {
2666
2655
  * The street name for the road.
2667
2656
  * Included if street name is available for this road.
2668
2657
  */
2669
- streetName?: TextWithPhonetics;
2658
+ streetName?: InstructionText;
2670
2659
  /**
2671
2660
  * Lists the road shields for this road.
2672
2661
  * The list can be empty if no road shields are available.
@@ -2686,16 +2675,16 @@ type Signpost = {
2686
2675
  * Exit name of the controlled access road.
2687
2676
  * Included if an exit name is available for this signpost.
2688
2677
  */
2689
- exitName?: TextWithPhonetics;
2678
+ exitName?: InstructionText;
2690
2679
  /**
2691
2680
  * Exit number of the controlled access road. Included if an exit number is available for this signpost.
2692
2681
  * Multiple exit numbers can be encoded in the string, e.g. "E10/E12". If exit number is not available, the field will be absent.
2693
2682
  */
2694
- exitNumber?: TextWithPhonetics;
2683
+ exitNumber?: InstructionText;
2695
2684
  /**
2696
2685
  * The toward name from the signpost.
2697
2686
  */
2698
- towardName: TextWithPhonetics;
2687
+ towardName: InstructionText;
2699
2688
  };
2700
2689
  /**
2701
2690
  * Side road information.
@@ -2797,7 +2786,7 @@ type Instruction = {
2797
2786
  * Name of the intersection at which the maneuver must be performed.
2798
2787
  * Included if intersection name is available for this maneuver.
2799
2788
  */
2800
- intersectionName?: TextWithPhonetics;
2789
+ intersectionName?: InstructionText;
2801
2790
  /**
2802
2791
  * Indicates left-hand vs. right-hand side driving at the point of the maneuver.
2803
2792
  */
@@ -2911,7 +2900,7 @@ type Instruction = {
2911
2900
  * The name of the tollgate, if available.
2912
2901
  * Included if the maneuver is a tollgate maneuver, i.e., maneuver is TOLLGATE.
2913
2902
  */
2914
- tollgateName?: TextWithPhonetics;
2903
+ tollgateName?: InstructionText;
2915
2904
  /**
2916
2905
  * Included if the maneuver is a tollgate maneuver, i.e., maneuver is TOLLGATE.
2917
2906
  * Array containing one or more available toll payment options for this tollgate.
@@ -2926,7 +2915,7 @@ type Instruction = {
2926
2915
  * LEAVE_SHIP_FERRY
2927
2916
  * LEAVE_CAR_TRAIN
2928
2917
  */
2929
- countryCrossingFromName?: TextWithPhonetics;
2918
+ countryCrossingFromName?: InstructionText;
2930
2919
  /**
2931
2920
  * The code (ISO 3166-1 alpha-3) of the country the border crossing occurs from.
2932
2921
  * Included if the maneuver is a border crossing maneuver, i.e., maneuver is one of:
@@ -2946,7 +2935,7 @@ type Instruction = {
2946
2935
  * LEAVE_SHIP_FERRY
2947
2936
  * LEAVE_CAR_TRAIN
2948
2937
  */
2949
- countryCrossingToName?: TextWithPhonetics;
2938
+ countryCrossingToName?: InstructionText;
2950
2939
  /**
2951
2940
  * The code (ISO 3166-1 alpha-3) of the country the border crossing occurs to.
2952
2941
  * Included if the maneuver is a border crossing maneuver, i.e., maneuver is one of:
@@ -3429,12 +3418,10 @@ export type DelayMagnitude = 'unknown' | 'minor' | 'moderate' | 'major' | 'indef
3429
3418
  * @remarks
3430
3419
  * Strict subset of {@link fullTrafficIncidentCategories} — every value here is also
3431
3420
  * a valid response category. The two values omitted (`'animals-on-road'` and
3432
- * `'narrow-lanes'`) are documented as response-only: the upstream's default-values
3433
- * list is `0,1,2,3,4,5,6,7,8,9,10,11,14`, intentionally excluding iconCategory 12
3434
- * and 13. Including either makes the upstream reject the whole filter with
3435
- * `Unsupported categoryFilter parameter value`.
3421
+ * `'narrow-lanes'`) have no Incident Details category: they only appear on traffic
3422
+ * vector-tile features.
3436
3423
  *
3437
- * @see https://docs.tomtom.com/traffic-api/documentation/tomtom-orbis-maps/traffic-incidents/incident-details
3424
+ * @see https://docs.tomtom.com/traffic-api/documentation/tomtom-orbis-maps/v2/traffic-incidents/incident-details
3438
3425
  * @group Traffic
3439
3426
  */
3440
3427
  export declare const trafficIncidentRequestCategories: readonly ["accident", "broken-down-vehicle", "danger", "flooding", "fog", "frost", "jam", "lane-closed", "other", "rain", "road-closed", "roadworks", "wind"];
@@ -3443,9 +3430,9 @@ export declare const trafficIncidentRequestCategories: readonly ["accident", "br
3443
3430
  *
3444
3431
  * @remarks
3445
3432
  * Composed of {@link trafficIncidentRequestCategories} (categories that can be both
3446
- * sent as filter inputs and received in responses) plus the response-only categories
3447
- * `'animals-on-road'` and `'narrow-lanes'`, which appear in API responses and on
3448
- * vector-tile features but are rejected as `categoryFilter` inputs. Use this list
3433
+ * sent as filter inputs and received in responses) plus the tile-only categories
3434
+ * `'animals-on-road'` and `'narrow-lanes'`, which appear on vector-tile features
3435
+ * but never in an Incident Details response or filter. Use this list
3449
3436
  * when a category can be *received*; use {@link trafficIncidentRequestCategories}
3450
3437
  * when a category must be *sent* to the Incident Details API as a `categoryFilter`
3451
3438
  * input.
@@ -3508,51 +3495,6 @@ export type TrafficIncidentProbability = 'certain' | 'probable' | 'risk_of' | 'i
3508
3495
  * @group Traffic
3509
3496
  */
3510
3497
  export type TrafficIncidentTimeValidity = 'present' | 'future';
3511
- /**
3512
- * A single TMC (Traffic Message Channel) location point.
3513
- *
3514
- * @group Traffic
3515
- */
3516
- export type TrafficIncidentTMCPoint = {
3517
- /**
3518
- * TMC location code.
3519
- */
3520
- location: number;
3521
- /**
3522
- * Offset from the TMC location in the direction of the incident.
3523
- */
3524
- offset?: number;
3525
- };
3526
- /**
3527
- * Traffic Message Channel (TMC) data associated with a traffic incident.
3528
- *
3529
- * TMC is an international standard for encoding traffic and travel information
3530
- * in FM radio broadcasts (RDS-TMC) and digital data streams.
3531
- *
3532
- * @group Traffic
3533
- */
3534
- export type TrafficIncidentTMC = {
3535
- /**
3536
- * ISO 3166-1 alpha-2 country code.
3537
- */
3538
- countryCode: string;
3539
- /**
3540
- * TMC table number.
3541
- */
3542
- tableNumber: string;
3543
- /**
3544
- * TMC table version.
3545
- */
3546
- tableVersion: string;
3547
- /**
3548
- * Direction of the incident along the TMC path.
3549
- */
3550
- direction: 'positive' | 'negative';
3551
- /**
3552
- * Ordered list of TMC location points describing the incident extent.
3553
- */
3554
- points: TrafficIncidentTMCPoint[];
3555
- };
3556
3498
  /**
3557
3499
  * A single event contributing to a traffic incident.
3558
3500
  *
@@ -3653,10 +3595,6 @@ export type TrafficIncidentProperties = TrafficIncidentBaseProperties & {
3653
3595
  * Whether the incident is currently active or expected in the future.
3654
3596
  */
3655
3597
  timeValidity: TrafficIncidentTimeValidity;
3656
- /**
3657
- * TMC data for the incident, if available.
3658
- */
3659
- tmc?: TrafficIncidentTMC;
3660
3598
  };
3661
3599
  /**
3662
3600
  * A GeoJSON Feature representing a single traffic incident.
@@ -4457,76 +4395,123 @@ export type AreaAnalyticsMetrics = {
4457
4395
  networkLength?: number;
4458
4396
  };
4459
4397
  /**
4460
- * A single time-series data entry with temporal identifiers and metric values.
4398
+ * A `yearly` entry of {@link AreaAnalyticsTimedData}.
4461
4399
  *
4462
- * @remarks
4463
- * The identifiers present depend on the granularity:
4464
- * - `yearly`: `year`
4465
- * - `monthly`: `year`, `month`
4466
- * - `weekly`: `year`, `week`
4467
- * - `daily`: `date`
4468
- * - `hourly`: `date`, `hour`
4469
- * - `average`: `day`, `hour` (weekly pattern by day-of-week and hour)
4400
+ * @group Traffic
4401
+ */
4402
+ export type AreaAnalyticsYearlyEntry = AreaAnalyticsMetrics & {
4403
+ /**
4404
+ * Calendar year (e.g. 2024).
4405
+ */
4406
+ year: number;
4407
+ };
4408
+ /**
4409
+ * A `monthly` entry of {@link AreaAnalyticsTimedData}.
4410
+ *
4411
+ * @group Traffic
4412
+ */
4413
+ export type AreaAnalyticsMonthlyEntry = AreaAnalyticsYearlyEntry & {
4414
+ /**
4415
+ * Calendar month (1–12).
4416
+ */
4417
+ month: number;
4418
+ };
4419
+ /**
4420
+ * A `weekly` entry of {@link AreaAnalyticsTimedData}: an ISO 8601 week, from Monday.
4470
4421
  *
4471
4422
  * @group Traffic
4472
4423
  */
4473
- export type AreaAnalyticsTimedEntry = AreaAnalyticsMetrics & {
4424
+ export type AreaAnalyticsWeeklyEntry = AreaAnalyticsMetrics & {
4474
4425
  /**
4475
- * Date for daily and hourly entries.
4426
+ * ISO 8601 year that `week` counts in, which can differ from the calendar year at the turn of the year: the
4427
+ * week from Monday 30 December 2024 is week 1 of 2025.
4476
4428
  */
4477
- date?: Date;
4429
+ year: number;
4478
4430
  /**
4479
- * Calendar year (e.g. 2024) for yearly, monthly, and weekly entries.
4431
+ * ISO 8601 week number (1–53).
4480
4432
  */
4481
- year?: number;
4433
+ week: number;
4434
+ };
4435
+ /**
4436
+ * A `daily` entry of {@link AreaAnalyticsTimedData}.
4437
+ *
4438
+ * @group Traffic
4439
+ */
4440
+ export type AreaAnalyticsDailyEntry = AreaAnalyticsMetrics & {
4482
4441
  /**
4483
- * Calendar month (1–12) for monthly entries.
4442
+ * Calendar day, at midnight UTC: read it with `toISOString()` or `getUTCDate()`.
4484
4443
  */
4485
- month?: number;
4444
+ date: Date;
4445
+ };
4446
+ /**
4447
+ * An `hourly` entry of {@link AreaAnalyticsTimedData}.
4448
+ *
4449
+ * @group Traffic
4450
+ */
4451
+ export type AreaAnalyticsHourlyEntry = AreaAnalyticsDailyEntry & {
4486
4452
  /**
4487
- * ISO week number for weekly entries.
4453
+ * Hour of the day (0–23).
4488
4454
  */
4489
- week?: number;
4455
+ hour: number;
4456
+ };
4457
+ /**
4458
+ * An `average` entry of {@link AreaAnalyticsTimedData}: one hour of the average week.
4459
+ *
4460
+ * @group Traffic
4461
+ */
4462
+ export type AreaAnalyticsAverageEntry = AreaAnalyticsMetrics & {
4490
4463
  /**
4491
- * Hour of the day (0–23) for hourly and average entries.
4464
+ * Day of the week (1 = Monday … 7 = Sunday).
4492
4465
  */
4493
- hour?: number;
4466
+ day: 1 | 2 | 3 | 4 | 5 | 6 | 7;
4494
4467
  /**
4495
- * Day of the week (1 = Monday … 7 = Sunday) for average entries.
4468
+ * Hour of the day (0–23).
4496
4469
  */
4497
- day?: number;
4470
+ hour: number;
4498
4471
  };
4499
4472
  /**
4500
4473
  * Time-series traffic data organized by granularity level.
4501
4474
  *
4475
+ * Each granularity holds only the periods with data: an `hours` filter, a `days` list or a day without data
4476
+ * leaves entries out, so read an entry's time identifiers rather than its array index.
4477
+ *
4478
+ * Every time identifier is in UTC, as the `hours` filter is: the request names no region timezone, so the API
4479
+ * labels its periods in UTC.
4480
+ *
4502
4481
  * @group Traffic
4503
4482
  */
4504
4483
  export type AreaAnalyticsTimedData = {
4505
4484
  /**
4506
- * Yearly aggregated data.
4485
+ * Yearly aggregated data, oldest first.
4507
4486
  */
4508
- yearly?: AreaAnalyticsTimedEntry[];
4487
+ yearly?: AreaAnalyticsYearlyEntry[];
4509
4488
  /**
4510
- * Monthly aggregated data.
4489
+ * Monthly aggregated data, oldest first.
4511
4490
  */
4512
- monthly?: AreaAnalyticsTimedEntry[];
4491
+ monthly?: AreaAnalyticsMonthlyEntry[];
4513
4492
  /**
4514
- * Weekly aggregated data.
4493
+ * Weekly aggregated data, oldest first.
4515
4494
  */
4516
- weekly?: AreaAnalyticsTimedEntry[];
4495
+ weekly?: AreaAnalyticsWeeklyEntry[];
4517
4496
  /**
4518
- * Daily aggregated data.
4497
+ * Daily aggregated data, oldest first.
4519
4498
  */
4520
- daily?: AreaAnalyticsTimedEntry[];
4499
+ daily?: AreaAnalyticsDailyEntry[];
4521
4500
  /**
4522
- * Hourly aggregated data.
4501
+ * Hourly aggregated data, oldest first.
4523
4502
  */
4524
- hourly?: AreaAnalyticsTimedEntry[];
4503
+ hourly?: AreaAnalyticsHourlyEntry[];
4525
4504
  /**
4526
- * Average weekly traffic pattern organized by day-of-week and hour.
4505
+ * Average weekly traffic pattern: one entry per day of the week and hour, Monday first, then by hour.
4527
4506
  */
4528
- average?: AreaAnalyticsTimedEntry[];
4507
+ average?: AreaAnalyticsAverageEntry[];
4529
4508
  };
4509
+ /**
4510
+ * An entry of any {@link AreaAnalyticsTimedData} granularity.
4511
+ *
4512
+ * @group Traffic
4513
+ */
4514
+ export type AreaAnalyticsTimedEntry = NonNullable<AreaAnalyticsTimedData[keyof AreaAnalyticsTimedData]>[number];
4530
4515
  /**
4531
4516
  * Traffic metrics for a single geographic tile within the analysis region.
4532
4517
  *
@@ -4544,21 +4529,21 @@ export type AreaAnalyticsTileEntry = AreaAnalyticsMetrics & {
4544
4529
  tileCentre: Position;
4545
4530
  };
4546
4531
  /**
4547
- * A detected anomaly for a specific data type within the analysis period.
4532
+ * A run of hours in which one metric departs from its usual values, in UTC like {@link AreaAnalyticsTimedData}.
4548
4533
  *
4549
4534
  * @group Traffic
4550
4535
  */
4551
4536
  export type AreaAnalyticsAnomaly = {
4552
4537
  /**
4553
- * Start of the anomaly period.
4538
+ * Start of the first anomalous hour.
4554
4539
  */
4555
4540
  startDate: Date;
4556
4541
  /**
4557
- * End of the anomaly period.
4542
+ * End of the last anomalous hour, exclusive: the start of the hour after it.
4558
4543
  */
4559
4544
  endDate: Date;
4560
4545
  /**
4561
- * Labels describing the anomaly (e.g. `'Holiday'`, `'Weather event'`).
4546
+ * Names of the public holidays overlapping the anomaly in the region's country (e.g. `'Christmas Day'`), if any.
4562
4547
  */
4563
4548
  labels: string[];
4564
4549
  };
@@ -4573,9 +4558,9 @@ export type AreaAnalyticsFeatureProperties = {
4573
4558
  */
4574
4559
  name: string;
4575
4560
  /**
4576
- * IANA timezone identifier for the region (e.g. `'Europe/Amsterdam'`).
4561
+ * IANA timezone the API echoes from a request that names one; the SDK names none, so this is absent.
4577
4562
  */
4578
- timezone: string;
4563
+ timezone?: string;
4579
4564
  /**
4580
4565
  * Hierarchical level of the region in the analysis.
4581
4566
  */
@@ -4595,7 +4580,8 @@ export type AreaAnalyticsFeatureProperties = {
4595
4580
  tiles: AreaAnalyticsTileEntry[];
4596
4581
  };
4597
4582
  /**
4598
- * Detected anomalies keyed by metric, if anomaly detection was performed.
4583
+ * Detected anomalies keyed by metric. Empty for `trafficAreaAnalytics`: the service detects anomalies only over 35
4584
+ * days or more, beyond a request's 31-day limit.
4599
4585
  */
4600
4586
  anomalies?: Partial<Record<AreaAnalyticsMetricKey, AreaAnalyticsAnomaly[]>>;
4601
4587
  };
@@ -4621,11 +4607,11 @@ export type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFeaturePro
4621
4607
  */
4622
4608
  export type AreaAnalyticsCollectionProperties = {
4623
4609
  /**
4624
- * Start of the analysis period.
4610
+ * First analysed day, at midnight UTC: the range's `startDate`, or the earliest of the requested `days`.
4625
4611
  */
4626
4612
  startDate: Date;
4627
4613
  /**
4628
- * End of the analysis period.
4614
+ * Last analysed day (inclusive), at midnight UTC: the range's `endDate`, or the latest of the requested `days`.
4629
4615
  */
4630
4616
  endDate: Date;
4631
4617
  /**
@@ -4803,7 +4789,7 @@ export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined)
4803
4789
  * // Returns: [4.88, 52.36, 4.90, 52.38]
4804
4790
  *
4805
4791
  * // From a FeatureCollection (aggregates all features)
4806
- * const places = await search({ key: 'key', query: 'coffee' });
4792
+ * const places = await discoverPlaces({ key: 'key', query: 'coffee' });
4807
4793
  * const collectionBbox = bboxFromGeoJSON(places);
4808
4794
  * // Returns bbox encompassing all search results
4809
4795
  *
@@ -5369,17 +5355,17 @@ export declare const getRoutePlanningLocationType: (routePlanningLocation: Route
5369
5355
  */
5370
5356
  export declare const indexedMagnitudes: DelayMagnitude[];
5371
5357
  /**
5372
- * Maps an `iconCategory` integer from the Incident Details API to a {@link TrafficIncidentCategory}.
5358
+ * Maps an `iconCategory` integer from the traffic vector tiles to a {@link TrafficIncidentCategory}.
5373
5359
  * Integer values that do not correspond to a known category are mapped to `'other'`.
5374
5360
  *
5375
- * @param iconCategory - Integer category code from the API response
5361
+ * @param iconCategory - Integer category code from the tile
5376
5362
  * @returns The corresponding {@link TrafficIncidentCategory}
5377
5363
  *
5378
5364
  * @ignore
5379
5365
  */
5380
5366
  export declare const iconToTrafficIncidentCategory: (iconCategory: number) => TrafficIncidentCategory;
5381
5367
  /**
5382
- * Maps a {@link TrafficIncidentCategory} string to the `iconCategory` integer used by the API.
5368
+ * Maps a {@link TrafficIncidentCategory} string to the `iconCategory` integer used by the traffic vector tiles.
5383
5369
  * `'other'` and any unrecognised values map to `0`.
5384
5370
  *
5385
5371
  * @param category - The string category
@@ -5676,7 +5662,6 @@ export type RetryConfig = {
5676
5662
  * ```typescript
5677
5663
  * const config: GlobalConfig = {
5678
5664
  * apiKey: 'your-api-key',
5679
- * apiVersion: 1,
5680
5665
  * commonBaseURL: 'https://api.tomtom.com',
5681
5666
  * language: 'en-US',
5682
5667
  * displayUnits: {
@@ -5703,27 +5688,6 @@ export type GlobalConfig = {
5703
5688
  * * If provided, then the API key parameter will be ignored.
5704
5689
  * @experimental
5705
5690
  */
5706
- /**
5707
- * API version number for service endpoints.
5708
- *
5709
- * Each service may have its own default version. Consult the specific
5710
- * service documentation for available versions.
5711
- *
5712
- * @default 1 (but each service can override)
5713
- */
5714
- apiVersion: number;
5715
- /**
5716
- * Request identifier for tracing and support.
5717
- *
5718
- * Must match the pattern: `^[a-zA-Z0-9-]{1,100}$`
5719
- *
5720
- * Recommended format is UUID (e.g., `9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1`).
5721
- * When specified, it's included in the `Tracking-ID` response header.
5722
- * This is solely for support purposes and does not involve user tracking.
5723
- *
5724
- * @see {@link https://docs.tomtom.com/search-api/documentation/search-service/fuzzy-search#trackingid-response | Tracking-ID documentation}
5725
- */
5726
- trackingId?: string;
5727
5691
  /**
5728
5692
  * Language code for SDK services and map content.
5729
5693
  *
@@ -5737,12 +5701,14 @@ export type GlobalConfig = {
5737
5701
  */
5738
5702
  language?: Language;
5739
5703
  /**
5740
- * Base URL for all TomTom API services.
5704
+ * Base URL of every TomTom request: service calls, and the style, tile, sprite and glyph URLs the map fetches.
5741
5705
  *
5742
- * Individual services can override this with their own base URLs.
5743
- * Typically only changed for testing or enterprise deployments.
5706
+ * Change it only to route those requests through a proxy of your own. Leaving `apiKey` unset too
5707
+ * switches the SDK to proxy-credentials mode, where no key leaves the browser and requests carry the proxy's
5708
+ * session cookie.
5744
5709
  *
5745
5710
  * @default "https://api.tomtom.com"
5711
+ * @see [Proxying your API calls](https://docs.tomtom.com/maps-sdk-js/guides/security/proxying-api-calls)
5746
5712
  */
5747
5713
  commonBaseURL: string;
5748
5714
  /**
@@ -5763,6 +5729,20 @@ export type GlobalConfig = {
5763
5729
  */
5764
5730
  retry?: RetryConfig;
5765
5731
  };
5732
+ /**
5733
+ * {@link GlobalConfig} plus the options the SDK honours but keeps off the public types.
5734
+ *
5735
+ * `put` and every service call still accept them at runtime; only {@link mergeFromGlobal} types them.
5736
+ * @ignore
5737
+ */
5738
+ export type InternalGlobalConfig = GlobalConfig & {
5739
+ /**
5740
+ * API version for service endpoints. Services that need another one pin it themselves.
5741
+ *
5742
+ * @default 1
5743
+ */
5744
+ apiVersion: number;
5745
+ };
5766
5746
  /**
5767
5747
  * Default base URL for TomTom APIs. A `commonBaseURL` other than this signals a
5768
5748
  * proxy or custom backend.
@@ -5859,7 +5839,7 @@ export declare class TomTomConfig {
5859
5839
  * Merges the global configuration into the given one, with the latter having priority.
5860
5840
  * @ignore
5861
5841
  */
5862
- export declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenConfig?: T) => GlobalConfig & T;
5842
+ export declare const mergeFromGlobal: <T extends Partial<InternalGlobalConfig>>(givenConfig?: T) => InternalGlobalConfig & T;
5863
5843
  /**
5864
5844
  * Whether the SDK is configured for a credentials proxy such as the demos proxy
5865
5845
  * — no `apiKey` (the
@@ -5885,4 +5865,4 @@ export declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenCon
5885
5865
  */
5886
5866
  export declare const isProxyCredentialsMode: (config?: Partial<Pick<GlobalConfig, "apiKey" | "commonBaseURL">>) => boolean;
5887
5867
  //#endregion
5888
- export type { Anything, BBox, ChargingAvailabilityDataSource, ChargingPark, ChargingParkWithAvailability, ChargingPointAvailability, ChargingStationsAvailability, CombustionSummary, ConnectorAvailability, ConnectorCount, DrivingSide, EVChargingStationWithAvailabilityPlaceProps, ElectricSummary, FeatureCollectionWithProperties, Fuel, GeometryDataSource, GetPositionEntryPointOption, GetPositionOptions, Guidance, HasBBox, HasConnector, HasCount, HasLngLat, Instruction, Landmark, Language, LegSummary, Maneuver, ManeuverAngle, ManeuverView, Moment, OpeningHours, OpeningHoursMode, OptionalBBox, POI, PathLike, PlaceDataSources, PoiDetailsDataSource, PolygonFeature, PolygonFeatures, RelatedPOI, RoadInformation, RoadInformationProperty, RoadShield, RoadShieldReference, RoundaboutType, RoutePathPoint, RoutePlanningLocation, RoutePlanningLocationType, RouteSummary, SideRoad, SideRoadSide, Signpost, SummaryBase, SummaryWithConsumption, TextWithPhonetics, TimeRange, TimeZone, TollPaymentType, TomTomAPIHeaders, TomTomHeaders, Waypoint, WaypointLike, WaypointProps, Waypoints, languages };
5868
+ export type { Anything, BBox, ChargingAvailabilityDataSource, ChargingPark, ChargingParkWithAvailability, ChargingPointAvailability, ChargingStationsAvailability, CombustionSummary, ConnectorAvailability, ConnectorCount, DrivingSide, EVChargingStationWithAvailabilityPlaceProps, ElectricSummary, FeatureCollectionWithProperties, Fuel, GeometryDataSource, GetPositionEntryPointOption, GetPositionOptions, Guidance, HasBBox, HasConnector, HasCount, HasLngLat, Instruction, InstructionText, Landmark, Language, LegSummary, Maneuver, ManeuverAngle, ManeuverView, Moment, OpeningHours, OpeningHoursMode, OptionalBBox, POI, PathLike, PlaceDataSources, PoiDetailsDataSource, PolygonFeature, PolygonFeatures, RelatedPOI, RoadInformation, RoadInformationProperty, RoadShield, RoadShieldReference, RoundaboutType, RoutePathPoint, RoutePlanningLocation, RoutePlanningLocationType, RouteSummary, SideRoad, SideRoadSide, Signpost, SummaryBase, SummaryWithConsumption, TimeRange, TimeZone, TollPaymentType, TomTomAPIHeaders, TomTomHeaders, Waypoint, WaypointLike, WaypointProps, Waypoints, languages };