@tomtom-org/maps-sdk 0.32.3 → 0.34.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tomtom-org/maps-sdk",
   "author": "TomTom International B.V.",
   "license": "See in LICENSE.txt",
-  "version": "0.32.3",
+  "version": "0.34.0",
   "description": "TomTom Maps for JavaScript",
   "keywords": [
     "tomtom",

package/services/dist/index.d.ts

@@ -2,7 +2,6 @@ import { $ZodError } from 'zod/v4/core';
 import { $ZodIssue } from 'zod/v4/core';
 import { AddressProperties } from '../../../../core';
 import { Avoidable } from '../../../../core';
-import { Brand } from '../../../../core';
 import { ChargingStation } from '../../../../core';
 import { ChargingStationsAccessType } from '../../../../core';
 import { ChargingStationsAvailability } from '../../../core';
@@ -68,7 +67,7 @@ import { ZodMiniObject } from 'zod/v4-mini';
  */
 export declare type AdditionalDataAPI = {
     providerID: string;
-    error: string;
+    error?: string;
     geometryData: GeoJsonObject;
 };
 
@@ -709,6 +708,18 @@ declare type BoundingBoxSouthWestAPI = {
  */
 declare type BoundingBoxTopLeftAPI = ViewportAPI;
 
+/**
+ * @ignore
+ */
+declare type BrandAPI = {
+    /**
+     * Brand name.
+     *
+     * The commercial or franchise name (e.g., 'McDonald\'s', 'Shell', 'Hilton').
+     */
+    name: string;
+};
+
 /**
  * Type of budget constraint for reachable range calculation.
  *
@@ -883,9 +894,9 @@ export declare const calculateRoute: (params: CalculateRouteParams, customTempla
  *     engineType: 'electric',
  *     model: {
  *       engine: {
+ *         charging: { maxChargeKWH: 85 },
  *         consumption: {
- *           charging: { maxChargeKWH: 85 },
- *           speedToConsumption: [
+ *           speedsToConsumptionsKWH: [
  *             { speedKMH: 50, consumptionUnitsPer100KM: 8 },
  *             { speedKMH: 80, consumptionUnitsPer100KM: 12 },
  *             { speedKMH: 120, consumptionUnitsPer100KM: 18 }
@@ -915,7 +926,8 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
      * - Path arrays for route reconstruction
      * - (not supported) Waypoint objects with radius for circle waypoints
      *
-     * @see [POST data parameters](https://docs.tomtom.com/routing-api/documentation/routing/calculate-route#post-data-parameters)
+     * @see [POST data parameters](https://docs.tomtom.com/routing-api/documentation/tomtom-maps/calculate-route#post-data-parameters)
+     * @see [Response structure](https://docs.tomtom.com/routing-api/documentation/tomtom-maps/calculate-route#structure-of-a-successful-response)
      *
      * @example
      * ```typescript
@@ -969,10 +981,10 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
     /**
      * Request additional travel time calculations for different traffic scenarios.
      *
-     * When set to 'all', the response includes travel times for:
-     * - Free-flow (no traffic)
-     * - Historic traffic patterns
-     * - Current live traffic
+     * When set to 'all', the returned route summary will contain extra fields:
+     * - `noTrafficTravelTimeInSeconds` – Free-flow (no traffic)
+     * - `historicTrafficTravelTimeInSeconds` – Historic traffic patterns
+     * - `liveTrafficIncidentsTravelTimeInSeconds` – Current live traffic
      *
      * Useful for comparing traffic impact and displaying "X minutes saved by leaving now".
      *
@@ -980,7 +992,6 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
      *
      * @example
      * ```typescript
-     * // Get all traffic-based estimates
      * computeAdditionalTravelTimeFor: 'all'
      * ```
      */
@@ -989,6 +1000,11 @@ export declare type CalculateRouteParams = CommonServiceParams<CalculateRouteReq
      * Request extended progress information at route polyline points.
      *
      * Includes cumulative distance and/or time from start to each coordinate.
+     * When non-empty, the route features will contain additional property "progress" with an array of objects containing:
+     * - `pointIndex` – Index of the coordinate in the route geometry
+     * - `travelTimeInSeconds` - Cumulative travel time from start to this point (if "travelTime" is requested)
+     * - `distanceInMeters` - Cumulative distance from start to this point (if "distance" is requested)
+     *
      * Useful for displaying progress during navigation or animating route visualization.
      *
      * @default ['distance', 'travelTime']
@@ -1564,7 +1580,7 @@ declare type CombustionEngineModel = {
  *     engine: {
  *       consumption: {
  *         fuelEnergyDensityInMJoulesPerLiter: 34.2,
- *         speedToConsumption: [
+ *         speedsToConsumptionsLiters: [
  *           { speedKMH: 50, consumptionUnitsPer100KM: 6.5 },
  *           { speedKMH: 90, consumptionUnitsPer100KM: 7.2 },
  *           { speedKMH: 120, consumptionUnitsPer100KM: 9.0 }
@@ -2604,7 +2620,7 @@ export declare type CommonSearchParams<ApiRequest, ApiResponse> = CommonPlacesPa
 /**
  * @ignore
  */
-declare type CommonSearchPlaceResultAPI = Omit<SearchPlaceProps, 'distance' | 'position' | 'addressRanges' | 'geographyType' | 'entryPoints' | 'chargingPark'> & {
+declare type CommonSearchPlaceResultAPI = Omit<SearchPlaceProps, 'distance' | 'position' | 'addressRanges' | 'geographyType' | 'entryPoints' | 'chargingPark' | 'poi'> & {
     id: string;
     position: LatLonAPI;
     dist?: number;
@@ -2738,7 +2754,7 @@ export declare type ComputeTravelTimeFor = 'none' | 'all';
 /**
  * @ignore
  */
-declare type ConnectorAPI = Omit<Connector, 'type'> & {
+declare type ConnectorAPI = Omit<Connector, 'type' | 'chargingSpeed'> & {
     connectorType: ConnectorType;
 };
 
@@ -3070,8 +3086,6 @@ declare type DepartArriveOption = 'departAt' | 'arriveBy';
  * - Account for time-dependent road restrictions
  *
  * **Important Notes:**
- * - Past dates will default to departing immediately
- * - Impossible dates (e.g., imminent arrival for long routes) default to departing now
  * - Times are processed in the timezone of the origin/destination
  *
  * @example
@@ -3188,17 +3202,41 @@ declare type ElectricEngineModel = {
  *       weightKG: 2000
  *     },
  *     engine: {
+ *       charging: {
+ *         maxChargeKWH: 75,
+ *         batteryCurve: [
+ *           { stateOfChargeInkWh: 50, maxPowerInkW: 200 },
+ *           { stateOfChargeInkWh: 70, maxPowerInkW: 100 },
+ *           { stateOfChargeInkWh: 80, maxPowerInkW: 40 },
+ *         ],
+ *         chargingConnectors: [
+ *           {
+ *             currentType: 'AC3',
+ *             plugTypes: [
+ *               'IEC_62196_Type_2_Outlet',
+ *               'IEC_62196_Type_2_Connector_Cable_Attached',
+ *               'Combo_to_IEC_62196_Type_2_Base',
+ *             ],
+ *             efficiency: 0.9,
+ *             baseLoadInkW: 0.2,
+ *             maxPowerInkW: 11,
+ *           },
+ *           {
+ *             currentType: 'DC',
+ *             plugTypes: [
+ *               'IEC_62196_Type_2_Outlet',
+ *               'IEC_62196_Type_2_Connector_Cable_Attached',
+ *               'Combo_to_IEC_62196_Type_2_Base',
+ *             ],
+ *             voltageRange: { minVoltageInV: 0, maxVoltageInV: 500 },
+ *             efficiency: 0.9,
+ *             baseLoadInkW: 0.2,
+ *             maxPowerInkW: 150,
+ *           },
+ *         ]
+ *       },
  *       consumption: {
- *         charging: {
- *           maxChargeKWH: 75,
- *           chargingCurve: [
- *             { chargeKWH: 0, timeToChargeMinutes: 0 },
- *             { chargeKWH: 37.5, timeToChargeMinutes: 30 },
- *             { chargeKWH: 75, timeToChargeMinutes: 75 }
- *           ],
- *           connectorTypes: ['IEC_62196_TYPE_2']
- *         },
- *         speedToConsumption: [
+ *         speedsToConsumptionsKWH: [
  *           { speedKMH: 50, consumptionUnitsPer100KM: 15 },
  *           { speedKMH: 90, consumptionUnitsPer100KM: 18 },
  *           { speedKMH: 120, consumptionUnitsPer100KM: 23 }
@@ -3580,75 +3618,6 @@ export declare type FetchInput<PostData = void> = {
     method: 'POST';
 } & PostObject<PostData>);
 
-/**
- * Search for places using free-text queries with fuzzy matching.
- *
- * The Fuzzy Search service provides a flexible search that handles typos, abbreviations,
- * and incomplete addresses. It searches across POIs (Points of Interest), addresses,
- * and geographic areas to find the best matches for your query.
- *
- * @remarks
- * Key features:
- * - **Typo tolerance**: Handles misspellings and typing errors
- * - **Partial matching**: Works with incomplete queries
- * - **Multi-category search**: Searches POIs, addresses, and places simultaneously
- * - **Position bias**: Prioritizes results near a given location
- * - **Flexible input**: Accepts natural language queries
- *
- * The service is ideal for:
- * - User-facing search boxes where typos are common
- * - Location lookup without knowing exact names
- * - General "find anything" search functionality
- * - Autocomplete with final selection
- *
- * @param params Fuzzy search parameters including the search query
- * @param customTemplate Advanced customization for request/response handling
- *
- * @returns Promise resolving to a collection of matching places
- *
- * @example
- * ```typescript
- * // Basic search with typo tolerance
- * const results = await fuzzySearch({
- *   key: 'your-api-key',
- *   query: 'amstrdam'  // Typo: missing 'e'
- * });
- * // Still finds "Amsterdam"
- *
- * // Search near a specific location
- * const nearby = await fuzzySearch({
- *   key: 'your-api-key',
- *   query: 'pizza',
- *   at: [4.9041, 52.3676],  // Amsterdam
- *   radius: 2000,  // Within 2km
- *   limit: 10
- * });
- *
- * // Search with category filter
- * const restaurants = await fuzzySearch({
- *   key: 'your-api-key',
- *   query: 'italian',
- *   categorySet: [7315],  // Restaurant category
- *   at: [4.9041, 52.3676]
- * });
- *
- * // Partial address search
- * const addresses = await fuzzySearch({
- *   key: 'your-api-key',
- *   query: '123 main st',
- *   countrySet: ['US'],
- *   limit: 5
- * });
- * ```
- *
- * @see [Fuzzy Search API Documentation](https://docs.tomtom.com/search-api/documentation/search-service/fuzzy-search)
- * @see [Places Quickstart Guide](https://docs.tomtom.com/maps-sdk-js/guides/services/places/quickstart)
- * @see [Search Guide](https://docs.tomtom.com/maps-sdk-js/guides/services/places/search)
- *
- * @group Search
- */
-export declare const fuzzySearch: (params: FuzzySearchParams, customTemplate?: Partial<FuzzySearchTemplate>) => Promise<FuzzySearchResponse>;
-
 /**
  * Additional properties for fuzzy search feature collection.
  *
@@ -5119,7 +5088,7 @@ declare type PlaceByIdTemplate = ServiceTemplate<PlaceByIdParams, URL, PlaceById
 declare type POIAPI = {
     name: string;
     phone?: string;
-    brands?: Brand[];
+    brands?: BrandAPI[];
     url?: string;
     categorySet?: CategoryAPI[];
     categories?: string[];
@@ -5795,18 +5764,28 @@ declare type ReverseGeocodingResponseAPI = {
     addresses: [
         {
         address: AddressProperties & {
-            boundingBox: {
+            boundingBox?: {
                 northEast: string;
                 southWest: string;
                 entity: 'position';
             };
-            sideOfStreet: SideOfStreet;
-            offsetPosition: string;
+            sideOfStreet?: SideOfStreet;
+            offsetPosition?: string;
+            [key: string]: any;
         };
-        dataSources: PlaceDataSources;
-        entityType: PlaceType;
+        linkedAddress?: AddressProperties & {
+            boundingBox?: {
+                northEast: string;
+                southWest: string;
+                entity: 'position';
+            };
+            [key: string]: any;
+        };
+        dataSources?: PlaceDataSources;
+        entityType?: PlaceType;
         mapcodes?: Mapcode[];
         position: string;
+        roadUse?: string[];
     }
     ];
 };
@@ -5935,8 +5914,8 @@ declare type SchemaRefinement<T = any> = {
  * @group Errors
  */
 export declare class SDKError extends Error {
-    private readonly service;
-    private readonly issues?;
+    readonly service: string;
+    readonly issues?: $ZodIssue[] | undefined;
     /**
      * Creates a new SDKError instance.
      *
@@ -6323,7 +6302,9 @@ declare type SectionAPI = {
     streetName?: {
         text: string;
     };
-    roadNumbers?: string[];
+    roadNumbers?: {
+        text: string;
+    }[];
 };
 
 /**
@@ -6440,10 +6421,13 @@ declare type SummaryAPI = Omit<SearchSummary, 'geoBias'> & {
 /**
  * @ignore
  */
-declare type SummaryAPI_2 = Omit<RouteSummary & LegSummary, 'arrivalTime' | 'departureTime' | 'batteryConsumptionInPCT' | 'remainingChargeAtArrivalInPCT' | 'chargingInformationAtEndOfLeg'> & {
+declare type SummaryAPI_2 = Omit<RouteSummary & LegSummary, 'arrivalTime' | 'departureTime' | 'batteryConsumptionInPCT' | 'remainingChargeAtArrivalInPCT' | 'chargingInformationAtEndOfLeg' | 'deviationPoint'> & {
     arrivalTime: string;
     departureTime: string;
     chargingInformationAtEndOfLeg?: ChargingStopAPI;
+    deviationDistance?: number;
+    deviationTime?: number;
+    deviationPoint?: LatitudeLongitudePointAPI;
 };
 
 /**