@tomtom-org/maps-sdk 0.48.2 → 0.48.3
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.
- package/CHANGELOG.md +7 -0
- package/core/dist/core.es.js +1 -1
- package/core/dist/core.es.js.map +1 -1
- package/core/dist/index.d.ts +14 -0
- package/package.json +1 -1
- package/services/dist/index.d.ts +339 -104
- package/services/dist/services.es.js +1 -1
- package/services/dist/services.es.js.map +1 -1
package/services/dist/index.d.ts
CHANGED
|
@@ -19,16 +19,14 @@ import { GeographyType } from '@tomtom-org/maps-sdk/core';
|
|
|
19
19
|
import { GeoJSON as GeoJSON_2 } from 'geojson';
|
|
20
20
|
import { GetPositionEntryPointOption } from '@tomtom-org/maps-sdk/core';
|
|
21
21
|
import { GlobalConfig } from '@tomtom-org/maps-sdk/core';
|
|
22
|
-
import { Guidance } from '@tomtom-org/maps-sdk/core';
|
|
23
22
|
import { HasBBox } from '@tomtom-org/maps-sdk/core';
|
|
24
23
|
import { HasLngLat } from '@tomtom-org/maps-sdk/core';
|
|
25
24
|
import { inputSectionTypes } from '@tomtom-org/maps-sdk/core';
|
|
26
25
|
import { Instruction } from '@tomtom-org/maps-sdk/core';
|
|
27
|
-
import { LaneDirection } from '@tomtom-org/maps-sdk/core';
|
|
28
|
-
import { LegSummary } from '@tomtom-org/maps-sdk/core';
|
|
29
26
|
import { LineString } from 'geojson';
|
|
30
27
|
import { Mapcode } from '@tomtom-org/maps-sdk/core';
|
|
31
28
|
import { MapcodeType } from '@tomtom-org/maps-sdk/core';
|
|
29
|
+
import { MultiPoint } from 'geojson';
|
|
32
30
|
import { MultiPolygon } from 'geojson';
|
|
33
31
|
import { OpeningHours } from '@tomtom-org/maps-sdk/core';
|
|
34
32
|
import { OpeningHoursMode } from '@tomtom-org/maps-sdk/core';
|
|
@@ -47,19 +45,16 @@ import { PolygonFeature } from '@tomtom-org/maps-sdk/core';
|
|
|
47
45
|
import { PolygonFeatures } from '@tomtom-org/maps-sdk/core';
|
|
48
46
|
import { PolygonFeatures as PolygonFeatures_2 } from '@tomtom-org/maps-sdk/core';
|
|
49
47
|
import { Position } from 'geojson';
|
|
50
|
-
import { PossibleLaneSeparator } from '@tomtom-org/maps-sdk/core';
|
|
51
48
|
import { RevGeoAddressProps } from '@tomtom-org/maps-sdk/core';
|
|
52
49
|
import { RoadShieldReference } from '@tomtom-org/maps-sdk/core';
|
|
53
50
|
import { Route } from '@tomtom-org/maps-sdk/core';
|
|
54
|
-
import { RoutePathPoint } from '@tomtom-org/maps-sdk/core';
|
|
55
51
|
import { RoutePlanningLocation } from '@tomtom-org/maps-sdk/core';
|
|
56
|
-
import { RouteProgressPoint } from '@tomtom-org/maps-sdk/core';
|
|
57
52
|
import { Routes } from '@tomtom-org/maps-sdk/core';
|
|
58
|
-
import { RouteSummary } from '@tomtom-org/maps-sdk/core';
|
|
59
53
|
import { SearchPlaceProps } from '@tomtom-org/maps-sdk/core';
|
|
60
54
|
import { SearchPlaceProps as SearchPlaceProps_2 } from '@tomtom-org/maps-sdk/core';
|
|
61
55
|
import { SideOfStreet } from '@tomtom-org/maps-sdk/core';
|
|
62
56
|
import { TimeZone } from '@tomtom-org/maps-sdk/core';
|
|
57
|
+
import { TomTomAPIHeaders } from '@tomtom-org/maps-sdk/core';
|
|
63
58
|
import { TomTomHeaders } from '@tomtom-org/maps-sdk/core';
|
|
64
59
|
import { TrafficAreaAnalytics } from '@tomtom-org/maps-sdk/core';
|
|
65
60
|
import { TrafficIncidentDetails } from '@tomtom-org/maps-sdk/core';
|
|
@@ -959,11 +954,13 @@ declare type AvoidAreasAPI = {
|
|
|
959
954
|
};
|
|
960
955
|
|
|
961
956
|
/**
|
|
957
|
+
* V3 avoid area rectangle expressed as a GeoJSON Feature with a bbox.
|
|
962
958
|
* @ignore
|
|
963
959
|
*/
|
|
964
960
|
declare type AvoidRectangleAPI = {
|
|
965
|
-
|
|
966
|
-
|
|
961
|
+
type: 'Feature';
|
|
962
|
+
bbox: [number, number, number, number];
|
|
963
|
+
geometry: null;
|
|
967
964
|
};
|
|
968
965
|
|
|
969
966
|
/**
|
|
@@ -978,6 +975,15 @@ declare interface BaseAPIResponseErrorBody {
|
|
|
978
975
|
};
|
|
979
976
|
}
|
|
980
977
|
|
|
978
|
+
/**
|
|
979
|
+
* V3 basic section — uses pathIndex instead of pointIndex.
|
|
980
|
+
* @ignore
|
|
981
|
+
*/
|
|
982
|
+
declare type BasicSectionAPI = {
|
|
983
|
+
startPathIndex: number;
|
|
984
|
+
endPathIndex: number;
|
|
985
|
+
};
|
|
986
|
+
|
|
981
987
|
declare type BatteryCurve = {
|
|
982
988
|
/**
|
|
983
989
|
* Minimum: 0
|
|
@@ -1101,6 +1107,7 @@ declare const buildAutocompleteSearchRequest: (params: AutocompleteSearchParams)
|
|
|
1101
1107
|
|
|
1102
1108
|
/**
|
|
1103
1109
|
* Default function for building calculate route request from {@link CalculateRouteParams}
|
|
1110
|
+
* targeting the OrbisV3 routing API.
|
|
1104
1111
|
* @param params The calculate route parameters, with global configuration already merged into them.
|
|
1105
1112
|
*/
|
|
1106
1113
|
declare const buildCalculateRouteRequest: (params: CalculateRouteParams) => FetchInput<CalculateRoutePOSTDataAPI>;
|
|
@@ -1505,9 +1512,12 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
|
|
|
1505
1512
|
* Route section types to include in the response.
|
|
1506
1513
|
*
|
|
1507
1514
|
* Sections help you display route characteristics like tolls, ferries, or traffic.
|
|
1508
|
-
* Leg sections are always included regardless of this parameter.
|
|
1515
|
+
* Leg sections are always included regardless of this parameter. A section type is only
|
|
1516
|
+
* present in the response if the route actually traverses it. The `lanes` section is
|
|
1517
|
+
* guidance-only and is returned solely when {@link GuidanceParams | `guidance`} is also
|
|
1518
|
+
* requested.
|
|
1509
1519
|
*
|
|
1510
|
-
* @default
|
|
1520
|
+
* @default When omitted, all section types are requested.
|
|
1511
1521
|
*
|
|
1512
1522
|
* @example
|
|
1513
1523
|
* ```typescript
|
|
@@ -1542,12 +1552,28 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
|
|
|
1542
1552
|
};
|
|
1543
1553
|
|
|
1544
1554
|
/**
|
|
1555
|
+
* V3 POST body for /routing/routes/calculate and (partially) /routing/calculateLongDistanceEVRoute.
|
|
1556
|
+
* Consumption model parameters are sent as URL query params, not in the POST body.
|
|
1545
1557
|
* @ignore
|
|
1546
1558
|
*/
|
|
1547
1559
|
declare type CalculateRoutePOSTDataAPI = {
|
|
1548
|
-
|
|
1549
|
-
|
|
1560
|
+
routePlanningLocations: RoutePlanningLocationsAPI;
|
|
1561
|
+
path?: LineString;
|
|
1562
|
+
legs?: LegRequestAPI[];
|
|
1563
|
+
routeType?: string;
|
|
1564
|
+
traffic?: string;
|
|
1565
|
+
avoids?: string[];
|
|
1566
|
+
travelMode?: string;
|
|
1567
|
+
maxPathAlternativeRoutes?: number;
|
|
1568
|
+
departureDateTime?: string;
|
|
1569
|
+
arrivalDateTime?: string;
|
|
1570
|
+
vehicleEngineType?: string;
|
|
1571
|
+
vehicleWeightInKilograms?: number;
|
|
1572
|
+
vehicleMaxSpeedInKilometersPerHour?: number;
|
|
1573
|
+
vehicleHeadingInDegrees?: number;
|
|
1550
1574
|
chargingParameters?: ChargingParametersAPI;
|
|
1575
|
+
guidance?: 'none' | 'instructions';
|
|
1576
|
+
instructionPhonetics?: 'ipa' | 'lhp';
|
|
1551
1577
|
avoidAreas?: AvoidAreasAPI;
|
|
1552
1578
|
};
|
|
1553
1579
|
|
|
@@ -1560,13 +1586,11 @@ declare type CalculateRouteRequestAPI = FetchInput<CalculateRoutePOSTDataAPI>;
|
|
|
1560
1586
|
* @ignore
|
|
1561
1587
|
*/
|
|
1562
1588
|
declare type CalculateRouteResponseAPI = {
|
|
1563
|
-
formatVersion: string;
|
|
1564
1589
|
routes: RouteAPI[];
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
report?: ReportAPI;
|
|
1590
|
+
/**
|
|
1591
|
+
* Base URL of the Road Shields service (EXPLICIT, top-level). Applied to every instruction's
|
|
1592
|
+
* `roadShieldAtlasReference`. Requested via the top-level `roadShieldAtlasReference` attribute.
|
|
1593
|
+
*/
|
|
1570
1594
|
roadShieldAtlasReference?: string;
|
|
1571
1595
|
};
|
|
1572
1596
|
|
|
@@ -1677,7 +1701,15 @@ declare type ChargingModel = {
|
|
|
1677
1701
|
chargingTimeOffsetInSec?: number;
|
|
1678
1702
|
};
|
|
1679
1703
|
|
|
1680
|
-
|
|
1704
|
+
/**
|
|
1705
|
+
* V3 charging model sent in the POST body of the LDEVR endpoint.
|
|
1706
|
+
* @ignore
|
|
1707
|
+
*/
|
|
1708
|
+
declare type ChargingParametersAPI = {
|
|
1709
|
+
batteryCurve?: BatteryCurve[];
|
|
1710
|
+
chargingConnectors?: ChargingConnector[];
|
|
1711
|
+
chargingTimeOffsetInSec?: number;
|
|
1712
|
+
};
|
|
1681
1713
|
|
|
1682
1714
|
/**
|
|
1683
1715
|
* @ignore
|
|
@@ -1690,7 +1722,10 @@ declare type ChargingParkAPI = {
|
|
|
1690
1722
|
* @ignore
|
|
1691
1723
|
*/
|
|
1692
1724
|
declare type ChargingParkLocationAPI = {
|
|
1693
|
-
coordinate:
|
|
1725
|
+
coordinate: {
|
|
1726
|
+
latitude: number;
|
|
1727
|
+
longitude: number;
|
|
1728
|
+
};
|
|
1694
1729
|
street?: string;
|
|
1695
1730
|
houseNumber?: string;
|
|
1696
1731
|
city?: string;
|
|
@@ -3418,6 +3453,13 @@ export declare type CostModel = {
|
|
|
3418
3453
|
routeType?: RouteType;
|
|
3419
3454
|
};
|
|
3420
3455
|
|
|
3456
|
+
/**
|
|
3457
|
+
* @ignore
|
|
3458
|
+
*/
|
|
3459
|
+
declare type CountrySectionAPI = BasicSectionAPI & {
|
|
3460
|
+
countryCodeIso2?: string;
|
|
3461
|
+
};
|
|
3462
|
+
|
|
3421
3463
|
/**
|
|
3422
3464
|
* @ignore
|
|
3423
3465
|
*/
|
|
@@ -3563,6 +3605,12 @@ declare interface DefaultAPIResponseErrorBody extends BaseAPIResponseErrorBody {
|
|
|
3563
3605
|
errorText?: string;
|
|
3564
3606
|
}
|
|
3565
3607
|
|
|
3608
|
+
/**
|
|
3609
|
+
* V3 delay magnitude values. `'undefined'` is the raw API value mapped to SDK `'indefinite'`.
|
|
3610
|
+
* @ignore
|
|
3611
|
+
*/
|
|
3612
|
+
declare type DelayMagnitudeAPI = 'unknown' | 'minor' | 'moderate' | 'major' | 'undefined';
|
|
3613
|
+
|
|
3566
3614
|
declare type DepartArriveOption = 'departAt' | 'arriveBy';
|
|
3567
3615
|
|
|
3568
3616
|
/**
|
|
@@ -4486,14 +4534,13 @@ declare type FeaturePropertiesAPI = {
|
|
|
4486
4534
|
|
|
4487
4535
|
/**
|
|
4488
4536
|
* Hybrid HTTP fetch input, supporting different HTTP methods such as GET and POST.
|
|
4489
|
-
* * GET method comes with a URL.
|
|
4490
|
-
* * POST method comes with a URL
|
|
4537
|
+
* * GET method comes with a URL and optional headers.
|
|
4538
|
+
* * POST method comes with a URL, optional POST data, and optional headers.
|
|
4491
4539
|
* @ignore
|
|
4492
4540
|
*/
|
|
4493
|
-
export declare type FetchInput<PostData = void> = {
|
|
4541
|
+
export declare type FetchInput<PostData = void> = ({
|
|
4494
4542
|
method: 'GET';
|
|
4495
|
-
|
|
4496
|
-
} | ({
|
|
4543
|
+
} & GetObject) | ({
|
|
4497
4544
|
method: 'POST';
|
|
4498
4545
|
} & PostObject<PostData>);
|
|
4499
4546
|
|
|
@@ -5555,6 +5602,15 @@ export declare type GeometrySearchResultAPI = CommonSearchPlaceResultAPI;
|
|
|
5555
5602
|
*/
|
|
5556
5603
|
declare type GeometrySearchTemplate = ServiceTemplate<GeometrySearchParams, GeometrySearchRequestAPI, GeometrySearchResponseAPI, GeometrySearchResponse>;
|
|
5557
5604
|
|
|
5605
|
+
/**
|
|
5606
|
+
* GET object with URL and optional service-specific API headers.
|
|
5607
|
+
* @ignore
|
|
5608
|
+
*/
|
|
5609
|
+
export declare type GetObject = {
|
|
5610
|
+
url: URL;
|
|
5611
|
+
headers?: TomTomAPIHeaders;
|
|
5612
|
+
};
|
|
5613
|
+
|
|
5558
5614
|
/**
|
|
5559
5615
|
* Enhance multiple places with real-time EV charging availability data.
|
|
5560
5616
|
*
|
|
@@ -5680,13 +5736,6 @@ export declare const getPOICategories: (params?: POICategoriesParams) => Promise
|
|
|
5680
5736
|
*/
|
|
5681
5737
|
export declare const getPOICategoryCodes: (params?: POICategoriesParams) => Promise<POICategory_2[]>;
|
|
5682
5738
|
|
|
5683
|
-
/**
|
|
5684
|
-
* @ignore
|
|
5685
|
-
*/
|
|
5686
|
-
declare type GuidanceAPI = Omit<Guidance, 'instructions'> & {
|
|
5687
|
-
instructions: InstructionAPI[];
|
|
5688
|
-
};
|
|
5689
|
-
|
|
5690
5739
|
/**
|
|
5691
5740
|
* Configuration for turn-by-turn guidance instructions.
|
|
5692
5741
|
*
|
|
@@ -5739,6 +5788,35 @@ export declare type GuidanceParams = {
|
|
|
5739
5788
|
*/
|
|
5740
5789
|
export declare const hasChargingAvailability: (chargingPark: ChargingPark | ChargingParkWithAvailability | undefined) => chargingPark is ChargingParkWithAvailability;
|
|
5741
5790
|
|
|
5791
|
+
/**
|
|
5792
|
+
* V3 traffic section icon categories.
|
|
5793
|
+
* @ignore
|
|
5794
|
+
*/
|
|
5795
|
+
declare type IconCategoryAPI = 'jam' | 'accident' | 'brokenDownVehicle' | 'dangerousConditions' | 'flooding' | 'fog' | 'ice' | 'laneClosed' | 'rain' | 'roadClosed' | 'roadWorks' | 'wind';
|
|
5796
|
+
|
|
5797
|
+
/**
|
|
5798
|
+
* V3 icon reference — same shape as the SDK's RoadShieldReference.
|
|
5799
|
+
* @ignore
|
|
5800
|
+
*/
|
|
5801
|
+
declare type IconReferenceAPI = {
|
|
5802
|
+
reference: string;
|
|
5803
|
+
shieldContent?: string;
|
|
5804
|
+
affixes?: string[];
|
|
5805
|
+
};
|
|
5806
|
+
|
|
5807
|
+
/**
|
|
5808
|
+
* @ignore
|
|
5809
|
+
*/
|
|
5810
|
+
declare type ImportantRoadStretchSectionAPI = BasicSectionAPI & {
|
|
5811
|
+
importantRoadStretchIndex: number;
|
|
5812
|
+
streetName?: {
|
|
5813
|
+
text: string;
|
|
5814
|
+
};
|
|
5815
|
+
roadNumbers?: {
|
|
5816
|
+
text: string;
|
|
5817
|
+
}[];
|
|
5818
|
+
};
|
|
5819
|
+
|
|
5742
5820
|
/**
|
|
5743
5821
|
* @ignore
|
|
5744
5822
|
*/
|
|
@@ -5844,6 +5922,7 @@ export declare type InputSectionType = (typeof inputSectionTypes)[number];
|
|
|
5844
5922
|
* - `lowEmissionZone`: Low emission zones
|
|
5845
5923
|
* - `speedLimit`: Speed limit changes
|
|
5846
5924
|
* - `roadShields`: Road shield information
|
|
5925
|
+
* - `importantRoadStretch`: Named important road stretches along the route
|
|
5847
5926
|
*
|
|
5848
5927
|
* @example
|
|
5849
5928
|
* ```typescript
|
|
@@ -5857,23 +5936,93 @@ export declare type InputSectionType = (typeof inputSectionTypes)[number];
|
|
|
5857
5936
|
* const sectionTypes: InputSectionTypes = [];
|
|
5858
5937
|
* ```
|
|
5859
5938
|
*
|
|
5860
|
-
* @
|
|
5939
|
+
* @remarks
|
|
5940
|
+
* A requested section type is only present in the response if the route actually traverses it
|
|
5941
|
+
* (e.g. `ferry` is omitted on a route with no water crossing). The `lanes` section is guidance-only:
|
|
5942
|
+
* it is returned solely when {@link GuidanceParams | `guidance`} is also requested, and is therefore
|
|
5943
|
+
* not part of this input list.
|
|
5944
|
+
*
|
|
5945
|
+
* @default When omitted, all section types are requested (equivalent to `inputSectionTypes`).
|
|
5861
5946
|
*
|
|
5862
5947
|
* @group Routing
|
|
5863
5948
|
*/
|
|
5864
5949
|
export declare type InputSectionTypes = InputSectionType[];
|
|
5865
5950
|
|
|
5866
5951
|
/**
|
|
5952
|
+
* V3 instruction — raw response shape. Coordinates are lat/lon (not GeoJSON), and several field
|
|
5953
|
+
* names / value casings differ from the SDK's {@link Instruction}; the parser converts them.
|
|
5867
5954
|
* @ignore
|
|
5868
5955
|
*/
|
|
5869
|
-
declare type InstructionAPI =
|
|
5870
|
-
|
|
5871
|
-
|
|
5956
|
+
declare type InstructionAPI = {
|
|
5957
|
+
routeOffsetInMeters: number;
|
|
5958
|
+
maneuver?: string;
|
|
5959
|
+
maneuverPoint: LatLonPointAPI;
|
|
5960
|
+
routePath?: RoutePathPointAPI[];
|
|
5961
|
+
nextRoadInformation?: InstructionRoadInformationAPI;
|
|
5962
|
+
previousRoadInformation?: InstructionRoadInformationAPI;
|
|
5963
|
+
signpost?: SignpostAPI;
|
|
5964
|
+
intersectionName?: TextWithPhoneticsAPI;
|
|
5965
|
+
drivingSide?: 'left' | 'right';
|
|
5966
|
+
landmark?: string;
|
|
5967
|
+
distanceToPreviousTrafficLightInMeters?: number;
|
|
5968
|
+
ambiguousExitOffsetFromManeuverInMeters?: number;
|
|
5969
|
+
roundaboutExitNumber?: number;
|
|
5970
|
+
isManeuverObligatory?: boolean;
|
|
5971
|
+
changeOfAngleInDegrees?: number;
|
|
5972
|
+
tollgateName?: TextWithPhoneticsAPI;
|
|
5973
|
+
tollPaymentTypes?: string[];
|
|
5974
|
+
countryCrossingFromName?: TextWithPhoneticsAPI;
|
|
5975
|
+
countryCrossingFromCodeIso2?: string;
|
|
5976
|
+
countryCrossingToName?: TextWithPhoneticsAPI;
|
|
5977
|
+
countryCrossingToCodeIso2?: string;
|
|
5978
|
+
sideRoads?: Instruction['sideRoads'];
|
|
5872
5979
|
};
|
|
5873
5980
|
|
|
5874
5981
|
/**
|
|
5982
|
+
* V3 road information inside an instruction — field names changed from V2.
|
|
5983
|
+
* @ignore
|
|
5984
|
+
*/
|
|
5985
|
+
declare type InstructionRoadInformationAPI = {
|
|
5986
|
+
properties?: string[];
|
|
5987
|
+
roadShields?: InstructionRoadShieldAPI[];
|
|
5988
|
+
roadNames?: Array<{
|
|
5989
|
+
identifier: TextWithPhoneticsAPI;
|
|
5990
|
+
}>;
|
|
5991
|
+
roadNumbers?: Array<{
|
|
5992
|
+
identifier: TextWithPhoneticsAPI;
|
|
5993
|
+
}>;
|
|
5994
|
+
};
|
|
5995
|
+
|
|
5996
|
+
/**
|
|
5997
|
+
* V3 road shield inside an instruction's road information. `iconReference` is EXPLICIT.
|
|
5998
|
+
* @ignore
|
|
5999
|
+
*/
|
|
6000
|
+
declare type InstructionRoadShieldAPI = {
|
|
6001
|
+
roadNumber?: TextWithPhoneticsAPI;
|
|
6002
|
+
countryCodeIso2?: string;
|
|
6003
|
+
countrySubdivisionCodeIso?: string;
|
|
6004
|
+
iconReference?: IconReferenceAPI;
|
|
6005
|
+
};
|
|
6006
|
+
|
|
6007
|
+
/**
|
|
6008
|
+
* V3 lanes section — directions/separators are camelCase strings (mapped to the SDK's
|
|
6009
|
+
* UPPER_SNAKE enums during parsing), and lanes are objects rather than flat direction lists.
|
|
6010
|
+
* @ignore
|
|
6011
|
+
*/
|
|
6012
|
+
declare type LanesSectionAPI = BasicSectionAPI & {
|
|
6013
|
+
lanes?: {
|
|
6014
|
+
directions: string[];
|
|
6015
|
+
follow?: string;
|
|
6016
|
+
laneType?: string;
|
|
6017
|
+
tollPaymentTypes?: string[];
|
|
6018
|
+
}[];
|
|
6019
|
+
laneSeparators?: string[];
|
|
6020
|
+
properties?: string[];
|
|
6021
|
+
};
|
|
6022
|
+
|
|
6023
|
+
/**
|
|
6024
|
+
* Lat/lon point used by non-routing services (e.g. reachable-range).
|
|
5875
6025
|
* @ignore
|
|
5876
|
-
* @see {@link https://docs.tomtom.com/routing-api/documentation/routing/common-routing-parameters point}
|
|
5877
6026
|
*/
|
|
5878
6027
|
declare type LatitudeLongitudePointAPI = {
|
|
5879
6028
|
latitude: number;
|
|
@@ -5895,13 +6044,31 @@ declare type LatLonAPI = {
|
|
|
5895
6044
|
};
|
|
5896
6045
|
|
|
5897
6046
|
/**
|
|
6047
|
+
* V3 lat/lon point used in guidance instructions (different from GeoJSON used elsewhere).
|
|
6048
|
+
* @ignore
|
|
6049
|
+
*/
|
|
6050
|
+
declare type LatLonPointAPI = {
|
|
6051
|
+
latitude: number;
|
|
6052
|
+
longitude: number;
|
|
6053
|
+
};
|
|
6054
|
+
|
|
6055
|
+
/**
|
|
6056
|
+
* V3 leg — path is now a GeoJSON LineString instead of a points array.
|
|
5898
6057
|
* @ignore
|
|
5899
6058
|
*/
|
|
5900
6059
|
declare type LegAPI = {
|
|
5901
|
-
|
|
6060
|
+
path: LineString;
|
|
5902
6061
|
summary: SummaryAPI_2;
|
|
5903
6062
|
};
|
|
5904
6063
|
|
|
6064
|
+
/**
|
|
6065
|
+
* V3 per-leg request (used in the `legs` array for route reconstruction).
|
|
6066
|
+
* @ignore
|
|
6067
|
+
*/
|
|
6068
|
+
declare type LegRequestAPI = {
|
|
6069
|
+
path?: LineString;
|
|
6070
|
+
};
|
|
6071
|
+
|
|
5905
6072
|
/**
|
|
5906
6073
|
* Basic low/normal/high intensity level option.
|
|
5907
6074
|
*
|
|
@@ -6194,6 +6361,15 @@ declare const parseTrafficAreaAnalyticsResponse: (apiResponse: AreaAnalyticsResp
|
|
|
6194
6361
|
*/
|
|
6195
6362
|
declare const parseTrafficIncidentDetailsResponse: (apiResponse: IncidentDetailsResponseAPI) => TrafficIncidentDetails;
|
|
6196
6363
|
|
|
6364
|
+
/**
|
|
6365
|
+
* V3 phonetic transcription — an object keyed by phonetic alphabet, not a flat string as in V2.
|
|
6366
|
+
* @ignore
|
|
6367
|
+
*/
|
|
6368
|
+
declare type PhoneticAPI = {
|
|
6369
|
+
lhp?: string;
|
|
6370
|
+
ipa?: string;
|
|
6371
|
+
};
|
|
6372
|
+
|
|
6197
6373
|
/**
|
|
6198
6374
|
* Retrieve detailed information about a place using its unique identifier.
|
|
6199
6375
|
*
|
|
@@ -6569,14 +6745,6 @@ export declare type POICategoryResult = {
|
|
|
6569
6745
|
synonyms: string[];
|
|
6570
6746
|
};
|
|
6571
6747
|
|
|
6572
|
-
/**
|
|
6573
|
-
* @ignore
|
|
6574
|
-
*/
|
|
6575
|
-
declare type PointWaypointAPI = {
|
|
6576
|
-
waypointSourceType: 'USER_DEFINED' | 'AUTO_GENERATED';
|
|
6577
|
-
supportingPointIndex: number;
|
|
6578
|
-
};
|
|
6579
|
-
|
|
6580
6748
|
/**
|
|
6581
6749
|
* @ignore
|
|
6582
6750
|
*/
|
|
@@ -6622,12 +6790,13 @@ export declare const POPULATED_AREA_TAGS: readonly ["village", "small_town", "mi
|
|
|
6622
6790
|
export declare type PopulatedAreaTag = (typeof POPULATED_AREA_TAGS)[number];
|
|
6623
6791
|
|
|
6624
6792
|
/**
|
|
6625
|
-
* POST object with URL and optional
|
|
6793
|
+
* POST object with URL, optional payload, and optional service-specific API headers.
|
|
6626
6794
|
* @ignore
|
|
6627
6795
|
*/
|
|
6628
6796
|
export declare type PostObject<D> = {
|
|
6629
6797
|
url: URL;
|
|
6630
6798
|
data?: D;
|
|
6799
|
+
headers?: TomTomAPIHeaders;
|
|
6631
6800
|
};
|
|
6632
6801
|
|
|
6633
6802
|
/**
|
|
@@ -6682,6 +6851,16 @@ declare type PredefinedVehicleModel = {
|
|
|
6682
6851
|
variantId: string;
|
|
6683
6852
|
};
|
|
6684
6853
|
|
|
6854
|
+
/**
|
|
6855
|
+
* V3 progress point — field names differ from the SDK's RouteProgressPoint.
|
|
6856
|
+
* @ignore
|
|
6857
|
+
*/
|
|
6858
|
+
declare type ProgressPointAPI = {
|
|
6859
|
+
pathIndex: number;
|
|
6860
|
+
distanceInMeters?: number;
|
|
6861
|
+
travelDurationInSeconds?: number;
|
|
6862
|
+
};
|
|
6863
|
+
|
|
6685
6864
|
/**
|
|
6686
6865
|
* Union type for all possible query intents.
|
|
6687
6866
|
*
|
|
@@ -6992,16 +7171,6 @@ declare type ReachableRangeTemplate = ServiceTemplate<ReachableRangeParams, Reac
|
|
|
6992
7171
|
*/
|
|
6993
7172
|
export declare type RelatedPoisRequest = 'child' | 'parent' | 'all' | 'off';
|
|
6994
7173
|
|
|
6995
|
-
/**
|
|
6996
|
-
* @ignore
|
|
6997
|
-
*/
|
|
6998
|
-
declare type ReportAPI = {
|
|
6999
|
-
effectiveSettings: {
|
|
7000
|
-
key: string;
|
|
7001
|
-
value: string;
|
|
7002
|
-
}[];
|
|
7003
|
-
};
|
|
7004
|
-
|
|
7005
7174
|
/**
|
|
7006
7175
|
* Configuration for services request validation.
|
|
7007
7176
|
* @ignore
|
|
@@ -7350,17 +7519,29 @@ export declare type RoadUse = 'LimitedAccess' | 'Arterial' | 'Terminal' | 'Ramp'
|
|
|
7350
7519
|
*/
|
|
7351
7520
|
declare type RouteAPI = {
|
|
7352
7521
|
legs: LegAPI[];
|
|
7353
|
-
sections
|
|
7522
|
+
sections?: SectionsAPI;
|
|
7354
7523
|
summary: SummaryAPI_2;
|
|
7355
|
-
|
|
7356
|
-
|
|
7524
|
+
instructions?: InstructionAPI[];
|
|
7525
|
+
progressPoints?: ProgressPointAPI[];
|
|
7526
|
+
};
|
|
7527
|
+
|
|
7528
|
+
/**
|
|
7529
|
+
* V3 routePath point — field names changed from V2.
|
|
7530
|
+
* @ignore
|
|
7531
|
+
*/
|
|
7532
|
+
declare type RoutePathPointAPI = {
|
|
7533
|
+
point: LatLonPointAPI;
|
|
7534
|
+
distanceFromRouteStartInMeters: number;
|
|
7535
|
+
travelTimeFromRouteStartInSeconds: number;
|
|
7357
7536
|
};
|
|
7358
7537
|
|
|
7359
7538
|
/**
|
|
7360
7539
|
* @ignore
|
|
7361
7540
|
*/
|
|
7362
|
-
declare type
|
|
7363
|
-
|
|
7541
|
+
declare type RoutePlanningLocationsAPI = {
|
|
7542
|
+
origin: Point;
|
|
7543
|
+
destination: Point;
|
|
7544
|
+
waypoints?: MultiPoint;
|
|
7364
7545
|
};
|
|
7365
7546
|
|
|
7366
7547
|
/**
|
|
@@ -7847,38 +8028,32 @@ export declare type SearchSummary = {
|
|
|
7847
8028
|
};
|
|
7848
8029
|
|
|
7849
8030
|
/**
|
|
8031
|
+
* V3 sections object — already grouped by type (no flat array + discriminator).
|
|
7850
8032
|
* @ignore
|
|
7851
8033
|
*/
|
|
7852
|
-
declare type
|
|
7853
|
-
|
|
7854
|
-
|
|
7855
|
-
|
|
7856
|
-
|
|
7857
|
-
|
|
7858
|
-
|
|
7859
|
-
|
|
7860
|
-
|
|
7861
|
-
|
|
7862
|
-
|
|
7863
|
-
|
|
7864
|
-
|
|
7865
|
-
|
|
7866
|
-
|
|
7867
|
-
|
|
7868
|
-
|
|
7869
|
-
|
|
7870
|
-
|
|
7871
|
-
|
|
7872
|
-
|
|
7873
|
-
text: string;
|
|
7874
|
-
}[];
|
|
8034
|
+
declare type SectionsAPI = {
|
|
8035
|
+
carTrain?: BasicSectionAPI[];
|
|
8036
|
+
ferry?: BasicSectionAPI[];
|
|
8037
|
+
tunnel?: BasicSectionAPI[];
|
|
8038
|
+
motorway?: BasicSectionAPI[];
|
|
8039
|
+
pedestrian?: BasicSectionAPI[];
|
|
8040
|
+
toll?: BasicSectionAPI[];
|
|
8041
|
+
country?: CountrySectionAPI[];
|
|
8042
|
+
travelMode?: TravelModeSectionAPI[];
|
|
8043
|
+
traffic?: TrafficSectionAPI[];
|
|
8044
|
+
carpool?: BasicSectionAPI[];
|
|
8045
|
+
urban?: BasicSectionAPI[];
|
|
8046
|
+
unpaved?: BasicSectionAPI[];
|
|
8047
|
+
lowEmissionZone?: BasicSectionAPI[];
|
|
8048
|
+
speedLimit?: SpeedLimitSectionAPI[];
|
|
8049
|
+
lanes?: LanesSectionAPI[];
|
|
8050
|
+
roadShields?: (BasicSectionAPI & {
|
|
8051
|
+
roadShieldReferences?: RoadShieldReference[];
|
|
8052
|
+
})[];
|
|
8053
|
+
tollVignette?: CountrySectionAPI[];
|
|
8054
|
+
importantRoadStretch?: ImportantRoadStretchSectionAPI[];
|
|
7875
8055
|
};
|
|
7876
8056
|
|
|
7877
|
-
/**
|
|
7878
|
-
* @ignore
|
|
7879
|
-
*/
|
|
7880
|
-
declare type SectionTypeAPI = 'CAR_TRAIN' | 'COUNTRY' | 'FERRY' | 'MOTORWAY' | 'PEDESTRIAN' | 'TOLL' | 'TOLL_VIGNETTE' | 'TRAFFIC' | 'TRAVEL_MODE' | 'TUNNEL' | 'UNPAVED' | 'URBAN' | 'CARPOOL' | 'LOW_EMISSION_ZONE' | 'LANES' | 'SPEED_LIMIT' | 'ROAD_SHIELDS' | 'IMPORTANT_ROAD_STRETCH';
|
|
7881
|
-
|
|
7882
8057
|
/**
|
|
7883
8058
|
* Name of a service managed by the SDK.
|
|
7884
8059
|
*/
|
|
@@ -7956,6 +8131,29 @@ export declare type ServiceTemplate<Params extends CommonServiceParams<ApiReques
|
|
|
7956
8131
|
parseResponseError?: ParseResponseError<any>;
|
|
7957
8132
|
};
|
|
7958
8133
|
|
|
8134
|
+
/**
|
|
8135
|
+
* V3 signpost — adds an EXPLICIT `exitIconReference` (mapped to signpostRoadShieldReferences).
|
|
8136
|
+
* @ignore
|
|
8137
|
+
*/
|
|
8138
|
+
declare type SignpostAPI = {
|
|
8139
|
+
exitName?: TextWithPhoneticsAPI;
|
|
8140
|
+
exitNumber?: TextWithPhoneticsAPI;
|
|
8141
|
+
towardName?: TextWithPhoneticsAPI;
|
|
8142
|
+
exitIconReference?: IconReferenceAPI;
|
|
8143
|
+
};
|
|
8144
|
+
|
|
8145
|
+
/**
|
|
8146
|
+
* V3 speed limit section — speed values live under `speedRestrictions` (typed maximum/minimum)
|
|
8147
|
+
* instead of the V2 flat `maxSpeedLimitInKmh`.
|
|
8148
|
+
* @ignore
|
|
8149
|
+
*/
|
|
8150
|
+
declare type SpeedLimitSectionAPI = BasicSectionAPI & {
|
|
8151
|
+
speedRestrictions?: {
|
|
8152
|
+
type: 'maximum' | 'minimum';
|
|
8153
|
+
inKilometersPerHour: number;
|
|
8154
|
+
}[];
|
|
8155
|
+
};
|
|
8156
|
+
|
|
7959
8157
|
/**
|
|
7960
8158
|
* Specifies the speed-dependent component of consumption.
|
|
7961
8159
|
* Provided as an unordered list of speed/consumption-rate pairs.
|
|
@@ -7986,15 +8184,28 @@ declare type SummaryAPI = Omit<SearchSummary, 'geoBias'> & {
|
|
|
7986
8184
|
};
|
|
7987
8185
|
|
|
7988
8186
|
/**
|
|
7989
|
-
*
|
|
7990
|
-
|
|
7991
|
-
|
|
7992
|
-
|
|
7993
|
-
|
|
8187
|
+
* V3 summary — field names changed from V2.
|
|
8188
|
+
* @ignore
|
|
8189
|
+
*/
|
|
8190
|
+
declare type SummaryAPI_2 = {
|
|
8191
|
+
lengthInMeters: number;
|
|
8192
|
+
travelDurationInSeconds: number;
|
|
8193
|
+
trafficDelayDurationInSeconds?: number;
|
|
8194
|
+
trafficLengthInMeters?: number;
|
|
8195
|
+
departureDateTime: string;
|
|
8196
|
+
arrivalDateTime: string;
|
|
8197
|
+
deviationDistanceInMeters?: number;
|
|
8198
|
+
deviationDurationInSeconds?: number;
|
|
8199
|
+
deviationPoint?: Point;
|
|
8200
|
+
historicTrafficTravelTimeInSeconds?: number;
|
|
8201
|
+
liveTrafficIncidentsTravelTimeInSeconds?: number;
|
|
8202
|
+
noTrafficTravelTimeInSeconds?: number;
|
|
8203
|
+
totalChargingTimeInSeconds?: number;
|
|
8204
|
+
batteryConsumptionInkWh?: number;
|
|
8205
|
+
batteryConsumptionInKilowattHours?: number;
|
|
8206
|
+
remainingChargeAtArrivalInkWh?: number;
|
|
8207
|
+
fuelConsumptionInLiters?: number;
|
|
7994
8208
|
chargingInformationAtEndOfLeg?: ChargingStopAPI;
|
|
7995
|
-
deviationDistance?: number;
|
|
7996
|
-
deviationTime?: number;
|
|
7997
|
-
deviationPoint?: LatitudeLongitudePointAPI;
|
|
7998
8209
|
};
|
|
7999
8210
|
|
|
8000
8211
|
/**
|
|
@@ -8010,6 +8221,16 @@ declare type SummaryAPI_2 = Omit<RouteSummary & LegSummary, 'arrivalTime' | 'dep
|
|
|
8010
8221
|
*/
|
|
8011
8222
|
declare type SummaryQueryType = 'NEARBY' | 'NON_NEAR';
|
|
8012
8223
|
|
|
8224
|
+
/**
|
|
8225
|
+
* V3 text-with-phonetics — `phonetic` is now an object (mapped to a flat string during parsing).
|
|
8226
|
+
* @ignore
|
|
8227
|
+
*/
|
|
8228
|
+
declare type TextWithPhoneticsAPI = {
|
|
8229
|
+
text: string;
|
|
8230
|
+
phonetic?: PhoneticAPI;
|
|
8231
|
+
phoneticLanguageCode?: string;
|
|
8232
|
+
};
|
|
8233
|
+
|
|
8013
8234
|
/**
|
|
8014
8235
|
* @ignore
|
|
8015
8236
|
*/
|
|
@@ -8291,11 +8512,6 @@ export declare type TrafficAreaAnalyticsParams = CommonServiceParams & TrafficAr
|
|
|
8291
8512
|
*/
|
|
8292
8513
|
declare type TrafficAreaAnalyticsTemplate = ServiceTemplate<TrafficAreaAnalyticsParams, FetchInput<AreaAnalyticsRequestBody>, AreaAnalyticsResponseAPI, TrafficAreaAnalytics>;
|
|
8293
8514
|
|
|
8294
|
-
/**
|
|
8295
|
-
* @ignore
|
|
8296
|
-
*/
|
|
8297
|
-
declare type TrafficCategoryAPI = 'JAM' | 'ROAD_WORK' | 'ROAD_CLOSURE' | 'OTHER';
|
|
8298
|
-
|
|
8299
8515
|
/**
|
|
8300
8516
|
* Fetch detailed information about traffic incidents.
|
|
8301
8517
|
*
|
|
@@ -8557,6 +8773,25 @@ declare type TrafficIncidentDetailsTemplate = ServiceTemplate<TrafficIncidentDet
|
|
|
8557
8773
|
*/
|
|
8558
8774
|
export declare type TrafficInput = 'live' | 'historical';
|
|
8559
8775
|
|
|
8776
|
+
/**
|
|
8777
|
+
* @ignore
|
|
8778
|
+
*/
|
|
8779
|
+
declare type TrafficSectionAPI = BasicSectionAPI & {
|
|
8780
|
+
effectiveSpeedInKilometersPerHour?: number;
|
|
8781
|
+
delayDurationInSeconds?: number;
|
|
8782
|
+
delayMagnitude?: DelayMagnitudeAPI;
|
|
8783
|
+
tec?: TrafficIncidentTEC;
|
|
8784
|
+
iconCategory?: IconCategoryAPI;
|
|
8785
|
+
eventId?: string;
|
|
8786
|
+
};
|
|
8787
|
+
|
|
8788
|
+
/**
|
|
8789
|
+
* @ignore
|
|
8790
|
+
*/
|
|
8791
|
+
declare type TravelModeSectionAPI = BasicSectionAPI & {
|
|
8792
|
+
travelMode?: TravelMode | 'other';
|
|
8793
|
+
};
|
|
8794
|
+
|
|
8560
8795
|
/**
|
|
8561
8796
|
* Validate Error Class for validating params input, this will be used by SDKError class.
|
|
8562
8797
|
* @ignore
|