@tomtom-org/maps-sdk 0.53.0 → 0.54.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.53.0",
+  "version": "0.54.0",
   "description": "TomTom maps, search, geocoding, routing, isochrones, EV and traffic for JavaScript — typed GeoJSON services and a MapLibre GL JS map.",
   "homepage": "https://docs.tomtom.com/maps-sdk-js/introduction/overview",
   "repository": {
@@ -36,10 +36,14 @@
     "ev-charging",
     "navigation"
   ],
+  "nx": {
+    "includedScripts": []
+  },
   "devDependencies": {
     "@biomejs/biome": "^2.5.10",
     "@size-limit/file": "^13.0.3",
     "@size-limit/preset-app": "^13.0.3",
+    "nx": "22.7.12",
     "size-limit": "^13.0.3",
     "typedoc": "^0.28.20",
     "yaml": "^2.9.0"
@@ -94,41 +98,41 @@
   },
   "scripts": {
     "build": "pnpm build:sdk",
-    "build:api-reference": "typedoc",
-    "build:examples": "pnpm -F @tomtom-org/maps-sdk-examples build",
-    "build:examples:sandpack": "pnpm -F @tomtom-org/maps-sdk-examples build:sandpack",
-    "build:sdk": "pnpm -F core build  && pnpm -F services build && pnpm -F map build && pnpm build:third-party",
+    "build:api-reference": "nx run @tomtom-org/maps-sdk:typedoc",
+    "build:examples": "nx run-many -t build -p '@examples/*' --parallel=8 && nx run @tomtom-org/maps-sdk-examples:build",
+    "build:examples:sandpack": "nx run-many -t build:sandpack -p '@examples/*' --parallel=8",
+    "build:sdk": "nx run-many -t build -p core services map && pnpm build:third-party",
     "build:third-party": "node shared-configs/aggregateThirdParty.ts",
     "build:third-party:plugins": "node shared-configs/aggregateThirdParty.ts --plugins",
     "eval:explorer": "pnpm -F @testing/ai-eval-explorer dev",
-    "eval:explorer:build": "pnpm -F @testing/ai-eval-explorer build",
-    "build:agent-eval": "pnpm -F agent-eval build",
-    "build:plugins": "pnpm -F './plugins/*' build && pnpm build:third-party:plugins",
-    "clean": "pnpm -r --no-bail clean:dist && pnpm -r --no-bail clean:cache",
-    "e2e-test:agent-toolkit:sandbox": "pnpm -F @tomtom-org/maps-sdk-plugin-agent-toolkit test:e2e",
-    "e2e-test:examples": "pnpm -F @tomtom-org/maps-sdk-examples test:e2e",
-    "e2e-test:examples:sandpack": "pnpm -F @tomtom-org/maps-sdk-examples test:e2e:sandpack",
-    "e2e-test:examples:prod": "pnpm -F @tomtom-org/maps-sdk-examples test:e2e:prod",
-    "eval-test:examples": "pnpm -F @tomtom-org/maps-sdk-examples test:eval",
+    "eval:explorer:build": "nx run @testing/ai-eval-explorer:build",
+    "build:agent-eval": "nx run agent-eval:build",
+    "build:plugins": "nx run-many -t build -p '@tomtom-org/maps-sdk-plugin-*' && pnpm build:third-party:plugins",
+    "clean": "pnpm -r --no-bail clean:dist && pnpm -r --no-bail clean:cache && nx reset",
+    "e2e-test:agent-toolkit:sandbox": "nx run @tomtom-org/maps-sdk-plugin-agent-toolkit:test:e2e",
+    "e2e-test:examples": "nx run @tomtom-org/maps-sdk-examples:test:e2e",
+    "e2e-test:examples:sandpack": "nx run @tomtom-org/maps-sdk-examples:test:e2e:sandpack",
+    "e2e-test:examples:prod": "nx run @tomtom-org/maps-sdk-examples:test:e2e:prod",
+    "eval-test:examples": "nx run @tomtom-org/maps-sdk-examples:test:eval",
     "e2e-test:examples:update-all-snapshots": "pnpm -F @tomtom-org/maps-sdk-examples test:e2e:update-all-snapshots",
     "e2e-test:examples:update-snapshot": "pnpm -F @tomtom-org/maps-sdk-examples test:e2e:update-snapshot",
-    "e2e-test:sdk": "pnpm -F map-integration-tests test",
+    "e2e-test:sdk": "nx run map-integration-tests:test:e2e",
     "generate-thumbnails:examples": "pnpm -F @tomtom-org/maps-sdk-examples generate-thumbnails",
     "format": "biome format .",
     "format:fix": "biome format . --write",
     "lint": "biome lint .",
     "lint:fix": "biome check . --write && biome lint . --write",
-    "agent-tool-calling-test:agent-toolkit": "pnpm -F @tomtom-org/maps-sdk-plugin-agent-toolkit test:agent-tool-calling",
-    "agent-tool-calling-test:examples": "pnpm -F @tomtom-org/maps-sdk-examples test:agent-tool-calling",
+    "agent-tool-calling-test:agent-toolkit": "nx run @tomtom-org/maps-sdk-plugin-agent-toolkit:test:agent-tool-calling",
+    "agent-tool-calling-test:examples": "nx run-many -t test:agent-tool-calling -p '@examples/*' --parallel=1",
     "sync-docs-package-version": "bash documentation/scripts/update-sdk-version-in-docs.sh",
     "sync-examples-package-version": "bash examples/scripts/sync-examples-package-version.sh",
-    "test:agent-eval": "pnpm -F agent-eval test",
-    "test:sdk": "pnpm -F shared-configs test && pnpm -F core test && pnpm -F services test && pnpm -F map test",
-    "test:sdk:coverage": "pnpm -F shared-configs test:coverage && pnpm -F core test:coverage && pnpm -F services test:coverage && pnpm -F map test:coverage && pnpm -F plugins test:coverage",
-    "test:plugins": "pnpm --filter './plugins/*' run --if-present test",
-    "test:examples": "pnpm -F @tomtom-org/maps-sdk-examples test",
-    "type-check:examples": "pnpm -F @tomtom-org/maps-sdk-examples type-check",
-    "type-check:plugins": "pnpm -F plugins type-check",
-    "type-check:sdk": "pnpm -F core type-check && pnpm -F services type-check && pnpm -F map type-check && pnpm -F map-integration-tests type-check"
+    "test:agent-eval": "nx run agent-eval:test",
+    "test:sdk": "nx run-many -t test -p shared-configs core services map",
+    "test:sdk:coverage": "nx run-many -t test:coverage -p shared-configs core services map '@tomtom-org/maps-sdk-plugin-*'",
+    "test:plugins": "nx run-many -t test -p '@tomtom-org/maps-sdk-plugin-*'",
+    "test:examples": "nx run @tomtom-org/maps-sdk-examples:test",
+    "type-check:examples": "nx run-many -t type-check -p '@examples/*'",
+    "type-check:plugins": "nx run-many -t type-check -p '@tomtom-org/maps-sdk-plugin-*'",
+    "type-check:sdk": "nx run-many -t type-check -p core services map map-integration-tests"
   }
 }

package/services/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ZodError, ZodIssue, ZodObject } from "zod";
-import { AddressProperties, AreaAnalyticsMetricKey, Avoidable, BBox, ChargingPark, ChargingParkWithAvailability, ChargingStation, ChargingStationsAccessType, ChargingStationsAvailability, ChargingStopProps, CommonPlaceProps, Connector, ConnectorType, CurrentType, EVChargingStationWithAvailabilityPlaceProps, EntryPoint, Fuel, GeographyType, GetPositionEntryPointOption, GlobalConfig, HasBBox, HasLngLat, Instruction, MapcodeType, OpeningHours, OpeningHoursMode, POICategory, Place, PlaceType, Places, PlugType, PolygonFeature, PolygonFeatures, RevGeoAddressProps, RoadShieldReference, Route, RoutePlanningLocation, Routes, SearchPlaceProps, TimeZone, TomTomAPIHeaders, TomTomHeaders, TrafficAreaAnalytics, TrafficIncidentDetails, TrafficIncidentRequestCategory, TrafficIncidentTEC, TrafficIncidentTimeValidity, TravelMode, View, inputSectionTypes } from "@tomtom-org/maps-sdk/core";
+import { AddressProperties, AreaAnalyticsMetricKey, Avoidable, BBox, ChargingPark, ChargingParkWithAvailability, ChargingStation, ChargingStationsAccessType, ChargingStationsAvailability, ChargingStopProps, CommonPlaceProps, Connector, ConnectorType, CurrentType, EVChargingStationWithAvailabilityPlaceProps, EntryPoint, Fuel, GeographyType, GetPositionEntryPointOption, GlobalConfig, HasBBox, HasLngLat, MapcodeType, OpeningHours, OpeningHoursMode, POICategory, Place, PlaceType, Places, PlugType, PolygonFeature, PolygonFeatures, RevGeoAddressProps, RoadShieldReference, Route, RoutePlanningLocation, Routes, SearchPlaceProps, TimeZone, TomTomAPIHeaders, TomTomHeaders, TrafficAreaAnalytics, TrafficIncidentDetails, TrafficIncidentRequestCategory, TrafficIncidentTEC, TrafficIncidentTimeValidity, TravelMode, View, inputSectionTypes } from "@tomtom-org/maps-sdk/core";
 //#region src/shared/types/apiResponseErrorTypes.d.ts
 /**
  * @ignore
@@ -65,6 +65,13 @@ export type FetchInput<PostData = void> = ({
 } & GetObject) | ({
   method: 'POST';
 } & PostObject<PostData>);
+/**
+ * Per-call HTTP options threaded from service params down to `fetch`.
+ * @ignore
+ */
+export type RequestOptions = {
+  signal?: AbortSignal;
+};
 export type ParsedFetchResponse<T> = Promise<{
   data: Promise<T>;
   status: number;
@@ -155,6 +162,36 @@ export type CommonServiceParams<ApiRequest = any, ApiResponse = any> = Partial<G
    * @param apiResponse - The received raw (unparsed) API response
    */
   onAPIResponse?: (apiRequest: ApiRequest, apiResponse: ApiResponse) => void;
+  /**
+   * An `AbortSignal` used to cancel the request.
+   *
+   * @remarks
+   * Aborting rejects the call with an {@link SDKAbortError} (its `name` is `'AbortError'`)
+   * and cancels the underlying HTTP request, including while the SDK is waiting to retry
+   * a rate-limited (429) response. Aborting a call that already completed has no effect.
+   *
+   * Compose signals to add a deadline: `AbortSignal.any([mine, AbortSignal.timeout(5000)])`.
+   *
+   * @example
+   * Cancel the previous search whenever a new one starts:
+   * ```ts
+   * let controller: AbortController | undefined;
+   *
+   * const searchForQuery = async (query: string) => {
+   *     controller?.abort();
+   *     controller = new AbortController();
+   *     try {
+   *         return await search({ query, signal: controller.signal });
+   *     } catch (error) {
+   *         if (error instanceof SDKAbortError) return;
+   *         throw error;
+   *     }
+   * };
+   * ```
+   *
+   * @defaultValue `undefined` (the request cannot be cancelled)
+   */
+  signal?: AbortSignal;
 };
 /**
  * Function type for parsing API error responses into SDK service errors.
@@ -217,9 +254,10 @@ export type ServiceTemplate<Params extends CommonServiceParams<ApiRequest, ApiRe
    *
    * @param request - The request object to send
    * @param headers - Custom TomTom headers to include in the request
+   * @param options - Per-call HTTP options, such as the `AbortSignal` used to cancel the request
    * @returns A promise resolving to the parsed fetch response
    */
-  sendRequest: (request: ApiRequest, headers: TomTomHeaders) => ParsedFetchResponse<ApiResponse>;
+  sendRequest: (request: ApiRequest, headers: TomTomHeaders, options?: RequestOptions) => ParsedFetchResponse<ApiResponse>;
   /**
    * Parses the successful API response into the expected return type.
    *
@@ -336,6 +374,35 @@ export declare class SDKServiceError extends SDKError {
    */
   constructor(message: string, service: string, status?: number);
 }
+/**
+ * Error class for cancelled service calls.
+ *
+ * Thrown when the `signal` passed to a service call is aborted, either before the
+ * request is sent or while it is in flight. Its `name` is `'AbortError'`, matching
+ * the convention used by `fetch`, and the original abort reason — including a custom
+ * value passed to `AbortController.abort(reason)` — is available on `cause`.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await search({ query: 'cafe', signal: controller.signal });
+ * } catch (error) {
+ *   if (error instanceof SDKAbortError) return; // superseded by a newer search
+ *   throw error;
+ * }
+ * ```
+ *
+ * @group Errors
+ */
+export declare class SDKAbortError extends SDKError {
+  /**
+   * Creates a new SDKAbortError instance.
+   *
+   * @param service - Name of the service whose call was cancelled
+   * @param cause - The abort reason carried by the signal
+   */
+  constructor(service: string, cause?: unknown);
+}
 /**
  * @ignore
  * @param error
@@ -348,8 +415,9 @@ export declare const parseDefaultResponseError: ParseResponseError<DefaultAPIRes
  * @param error The error captured by a catch function.
  * @param serviceName The name of the service.
  * @param parseResponseError
+ * @param signal The signal given to the call, used to recognise a cancellation.
  */
-export declare const buildResponseError: (error: unknown, serviceName: ServiceName, parseResponseError?: ParseResponseError<unknown>) => SDKError;
+export declare const buildResponseError: (error: unknown, serviceName: ServiceName, parseResponseError?: ParseResponseError<unknown>, signal?: AbortSignal) => SDKError;
 /**
  * @ignore
  * @param error
@@ -5345,12 +5413,12 @@ type ReachableRangeRequestAPI = FetchInput;
 //#endregion
 //#region src/routing/types/apiResponseTypes.d.ts
 /**
- * V3 traffic section icon categories.
+ * Traffic section icon categories.
  * @ignore
  */
 type IconCategoryAPI = 'jam' | 'accident' | 'brokenDownVehicle' | 'dangerousConditions' | 'flooding' | 'fog' | 'ice' | 'laneClosed' | 'rain' | 'roadClosed' | 'roadWorks' | 'wind';
 /**
- * V3 delay magnitude values. `'undefined'` is the raw API value mapped to SDK `'indefinite'`.
+ * Delay magnitude values. `'undefined'` is the raw API value mapped to SDK `'indefinite'`.
  * @ignore
  */
 type DelayMagnitudeAPI = 'unknown' | 'minor' | 'moderate' | 'major' | 'undefined';
@@ -5395,7 +5463,7 @@ type ChargingStopAPI = Omit<ChargingStopProps, 'targetChargeInPCT' | 'chargingCo
   };
 };
 /**
- * V3 summary — field names changed from V2.
+ * Route summary as the API returns it.
  * @ignore
  */
 type SummaryAPI = {
@@ -5408,6 +5476,7 @@ type SummaryAPI = {
   deviationDistanceInMeters?: number;
   deviationDurationInSeconds?: number;
   deviationPoint?: Point;
+  originalWaypointIndexAtEndOfLeg?: number;
   historicTrafficTravelTimeInSeconds?: number;
   liveTrafficIncidentsTravelTimeInSeconds?: number;
   noTrafficTravelTimeInSeconds?: number;
@@ -5419,7 +5488,7 @@ type SummaryAPI = {
   chargingInformationAtEndOfLeg?: ChargingStopAPI;
 };
 /**
- * V3 leg — path is now a GeoJSON LineString instead of a points array.
+ * Route leg. Its path is a GeoJSON LineString, not a points array.
  * @ignore
  */
 type LegAPI = {
@@ -5427,7 +5496,7 @@ type LegAPI = {
   summary: SummaryAPI;
 };
 /**
- * V3 basic section — uses pathIndex instead of pointIndex.
+ * Basic section. Spans are expressed with pathIndex, not pointIndex.
  * @ignore
  */
 type BasicSectionAPI = {
@@ -5458,7 +5527,7 @@ type TrafficSectionAPI = BasicSectionAPI & {
   eventId?: string;
 };
 /**
- * V3 speed limit section — speed values live under `speedRestrictions` (typed maximum/minimum)
+ * Speed limit section — speed values live under `speedRestrictions` (typed maximum/minimum)
  * instead of the V2 flat `maxSpeedLimitInKmh`.
  * @ignore
  */
@@ -5469,7 +5538,7 @@ type SpeedLimitSectionAPI = BasicSectionAPI & {
   }[];
 };
 /**
- * V3 lanes section — directions/separators are camelCase strings (mapped to the SDK's
+ * Lanes section — directions/separators are camelCase strings (mapped to the SDK's
  * UPPER_SNAKE enums during parsing), and lanes are objects rather than flat direction lists.
  * @ignore
  */
@@ -5496,7 +5565,7 @@ type ImportantRoadStretchSectionAPI = BasicSectionAPI & {
   }[];
 };
 /**
- * V3 sections object — already grouped by type (no flat array + discriminator).
+ * Sections object, grouped by type rather than a flat array with a discriminator.
  * @ignore
  */
 type SectionsAPI = {
@@ -5518,11 +5587,12 @@ type SectionsAPI = {
   roadShields?: (BasicSectionAPI & {
     roadShieldReferences?: RoadShieldReference[];
   })[];
+  tollRoad?: BasicSectionAPI[];
   tollVignette?: CountrySectionAPI[];
   importantRoadStretch?: ImportantRoadStretchSectionAPI[];
 };
 /**
- * V3 lat/lon point used in guidance instructions (different from GeoJSON used elsewhere).
+ * Lat/lon point used in guidance instructions (different from the GeoJSON used elsewhere).
  * @ignore
  */
 type LatLonPointAPI = {
@@ -5530,7 +5600,7 @@ type LatLonPointAPI = {
   longitude: number;
 };
 /**
- * V3 routePath point — field names changed from V2.
+ * A point on the route path.
  * @ignore
  */
 type RoutePathPointAPI = {
@@ -5539,24 +5609,17 @@ type RoutePathPointAPI = {
   travelTimeFromRouteStartInSeconds: number;
 };
 /**
- * V3 phonetic transcription — an object keyed by phonetic alphabet, not a flat string as in V2.
- * @ignore
- */
-type PhoneticAPI = {
-  lhp?: string;
-  ipa?: string;
-};
-/**
- * V3 text-with-phonetics — `phonetic` is now an object (mapped to a flat string during parsing).
+ * Text with phonetics. `phonetic` is a flat string, already transcribed in the alphabet the
+ * request asked for via `instructionPhonetics` — there is no per-alphabet object to choose from.
  * @ignore
  */
 type TextWithPhoneticsAPI = {
   text: string;
-  phonetic?: PhoneticAPI;
+  phonetic?: string;
   phoneticLanguageCode?: string;
 };
 /**
- * V3 icon reference — same shape as the SDK's RoadShieldReference.
+ * Icon reference — same shape as the SDK's RoadShieldReference.
  * @ignore
  */
 type IconReferenceAPI = {
@@ -5565,7 +5628,7 @@ type IconReferenceAPI = {
   affixes?: string[];
 };
 /**
- * V3 road shield inside an instruction's road information. `iconReference` is EXPLICIT.
+ * Road shield inside an instruction's road information. `iconReference` is EXPLICIT.
  * @ignore
  */
 type InstructionRoadShieldAPI = {
@@ -5575,7 +5638,25 @@ type InstructionRoadShieldAPI = {
   iconReference?: IconReferenceAPI;
 };
 /**
- * V3 road information inside an instruction — field names changed from V2.
+ * Side road. `side` is lowercase on the wire, mapped to the SDK's UPPER_SNAKE `SideRoadSide`.
+ * @ignore
+ */
+type SideRoadAPI = {
+  side: string;
+  offsetFromManeuverInMeters: number;
+  isDrivable?: boolean;
+};
+/**
+ * Maneuver view. Both angle fields are relative-direction strings (`slightLeft`, `back`, …),
+ * not degrees, and are mapped to the SDK's UPPER_SNAKE `ManeuverAngle`.
+ * @ignore
+ */
+type ManeuverViewAPI = {
+  onRouteAngle?: string;
+  offRouteAngles?: string[];
+};
+/**
+ * Road information inside an instruction.
  * @ignore
  */
 type InstructionRoadInformationAPI = {
@@ -5583,13 +5664,16 @@ type InstructionRoadInformationAPI = {
   roadShields?: InstructionRoadShieldAPI[];
   roadNames?: Array<{
     identifier: TextWithPhoneticsAPI;
+    source?: string;
   }>;
   roadNumbers?: Array<{
     identifier: TextWithPhoneticsAPI;
+    source?: string;
   }>;
+  countryCodeIso2?: string;
 };
 /**
- * V3 signpost — adds an EXPLICIT `exitIconReference` (mapped to signpostRoadShieldReferences).
+ * Signpost. Carries an EXPLICIT `exitIconReference`, mapped to signpostRoadShieldReferences.
  * @ignore
  */
 type SignpostAPI = {
@@ -5599,7 +5683,7 @@ type SignpostAPI = {
   exitIconReference?: IconReferenceAPI;
 };
 /**
- * V3 instruction — raw response shape. Coordinates are lat/lon (not GeoJSON), and several field
+ * Instruction — raw response shape. Coordinates are lat/lon (not GeoJSON), and several field
  * names / value casings differ from the SDK's {@link Instruction}; the parser converts them.
  * @ignore
  */
@@ -5625,10 +5709,14 @@ type InstructionAPI = {
   countryCrossingFromCodeIso2?: string;
   countryCrossingToName?: TextWithPhoneticsAPI;
   countryCrossingToCodeIso2?: string;
-  sideRoads?: Instruction['sideRoads'];
+  sideRoads?: SideRoadAPI[];
+  /** Generated, localised instruction text. Present on every instruction. */
+  message?: string;
+  maneuverView?: ManeuverViewAPI;
+  roundaboutType?: string;
 };
 /**
- * V3 progress point — field names differ from the SDK's RouteProgressPoint.
+ * Progress point. Its field names differ from the SDK's RouteProgressPoint.
  * @ignore
  */
 type ProgressPointAPI = {
@@ -6294,7 +6382,7 @@ declare const customize$3: {
 //#endregion
 //#region src/routing/types/apiRequestTypes.d.ts
 /**
- * V3 charging model sent in the POST body of the LDEVR endpoint.
+ * Charging model sent in the POST body of the LDEVR endpoint.
  * @ignore
  */
 type ChargingParametersAPI = {
@@ -6311,7 +6399,7 @@ type RoutePlanningLocationsAPI = {
   waypoints?: MultiPoint;
 };
 /**
- * V3 avoid area rectangle expressed as a GeoJSON Feature with a bbox.
+ * Avoid area rectangle expressed as a GeoJSON Feature with a bbox.
  * @ignore
  */
 type AvoidRectangleAPI = {
@@ -6326,7 +6414,7 @@ type AvoidAreasAPI = {
   rectangles: AvoidRectangleAPI[];
 };
 /**
- * V3 per-stop request options, nested under the leg that arrives at the stop.
+ * Per-stop request options, nested under the leg that arrives at the stop.
  * @ignore
  */
 type RouteStopRequestAPI = {
@@ -6335,7 +6423,7 @@ type RouteStopRequestAPI = {
   preferredEntryPointIndex?: number;
 };
 /**
- * V3 per-leg request (used in the `legs` array for route reconstruction and per-stop options).
+ * Per-leg request, used in the `legs` array for route reconstruction and per-stop options.
  * @ignore
  */
 type LegRequestAPI = {
@@ -6347,7 +6435,7 @@ type LegRequestAPI = {
   routeStop?: RouteStopRequestAPI;
 };
 /**
- * V3 POST body for /routing/routes/calculate and (partially) /routing/calculateLongDistanceEVRoute.
+ * POST body for /routing/routes/calculate and (partially) /routing/calculateLongDistanceEVRoute.
  * Consumption model parameters are sent as URL query params, not in the POST body.
  * @ignore
  */
@@ -6437,6 +6525,36 @@ type InputSectionType = (typeof inputSectionTypes)[number];
  * @group Routing
  */
 type InputSectionTypes = InputSectionType[];
+/**
+ * The phonetic alphabet street names are transcribed in.
+ *
+ * @remarks
+ * - `LHP`: Language-specific phonetic representation
+ * - `IPA`: International Phonetic Alphabet
+ *
+ * @group Routing
+ */
+type Phonetics = 'LHP' | 'IPA';
+/**
+ * The accepted values of {@link ChargingStopsStrategy}.
+ * @group Routing
+ */
+declare const chargingStopsStrategies: readonly ["automaticFastest", "manualFastest", "automaticFastestWithFallbackToManual"];
+/**
+ * How the routing service should plan charging stops on an electric route.
+ *
+ * @remarks
+ * - `automaticFastest`: the service picks charging stops for the fastest journey. The default.
+ * - `manualFastest`: the service plans no charging stops of its own; only stops you pass as
+ *   waypoints are charged at.
+ * - `automaticFastestWithFallbackToManual`: automatic, falling back to manual when no chargeable
+ *   route exists.
+ *
+ * Requires `vehicle.preferences.chargingPreferences` to be set as well: the endpoint also needs a
+ * minimum charge at the destination, which only the preferences supply.
+ * @group Routing
+ */
+type ChargingStopsStrategy = (typeof chargingStopsStrategies)[number];
 /**
  * Configuration for turn-by-turn guidance instructions.
  *
@@ -6469,7 +6587,7 @@ type GuidanceParams = {
    *
    * @default 'IPA'
    */
-  phonetics?: 'LHP' | 'IPA';
+  phonetics?: Phonetics;
 };
 /**
  * Extended route representation options.
@@ -6715,6 +6833,21 @@ type CalculateRouteParams = CommonServiceParams<CalculateRouteRequestAPI, Calcul
    * ```
    */
   computeTravelTimeFor?: ComputeTravelTimeFor;
+  /**
+   * How the service should plan charging stops on an electric route.
+   *
+   * Only applies to electric routes, so `vehicle.preferences.chargingPreferences` must be set
+   * too — validation says so before the request is sent.
+   *
+   * @default 'automaticFastest' (the service's own default when unset)
+   *
+   * @example
+   * ```typescript
+   * // Plan the fastest journey, choosing charging stops along the way
+   * chargingStopsStrategy: 'automaticFastest'
+   * ```
+   */
+  chargingStopsStrategy?: ChargingStopsStrategy;
   /**
    * Request extended progress information at route polyline points.
    *
@@ -6809,7 +6942,7 @@ type CalculateRouteTemplate = ServiceTemplate<CalculateRouteParams, FetchInput<C
 //#region src/routing/requestBuilder.d.ts
 /**
  * Default function for building calculate route request from {@link CalculateRouteParams}
- * targeting the OrbisV3 routing API.
+ * targeting the Orbis routing API.
  * @param params The calculate route parameters, with global configuration already merged into them.
  */
 declare const buildCalculateRouteRequest: (params: CalculateRouteParams) => FetchInput<CalculateRoutePOSTDataAPI>;
@@ -8476,7 +8609,8 @@ export declare const calculateReachableRange: (params: ReachableRangeParams, cus
  * consider implementing your own parallel processing with appropriate throttling.
  *
  * @param paramsArray Array of reachable range parameters, one for each area to calculate
- * @param options.signal An `AbortSignal` to cancel in-flight requests between iterations.
+ * @param options.signal An `AbortSignal` to cancel the in-flight request and skip the remaining ones.
+ *   Composed with any per-entry `signal`, so either one cancels.
  * @param customTemplate Advanced customization for request/response handling
  *
  * @returns Promise resolving to a FeatureCollection of reachable area polygons
@@ -9275,4 +9409,4 @@ export declare const trafficAreaAnalytics: (params: TrafficAreaAnalyticsParams,
  */
 export declare const trafficIncidentDetails: (params: TrafficIncidentDetailsParams, customTemplate?: Partial<TrafficIncidentDetailsTemplate>) => Promise<TrafficIncidentDetails>;
 //#endregion
-export type { AdditionalDataAPI, AlongRouteSearchParams, AlongRouteSearchPayloadAPI, AlongRouteSearchRequestAPI, AlongRouteSearchResponse, AlongRouteSearchResponseAPI, AlongRouteSearchResultAPI, AlongRouteSortBy, AreaAnalyticsDateInput, AreaTag, ArrivalSide, AutocompleteGenericSearchSegment, AutocompleteSearchBrandSegment, AutocompleteSearchCategorySegment, AutocompleteSearchCategorySegmentAPI, AutocompleteSearchContext, AutocompleteSearchContextAPI, AutocompleteSearchMatch, AutocompleteSearchMatches, AutocompleteSearchParams, AutocompleteSearchPlaintextSegment, AutocompleteSearchResponse, AutocompleteSearchResponseAPI, AutocompleteSearchResult, AutocompleteSearchResultAPI, AutocompleteSearchResultGeoBias, AutocompleteSearchResultGeoBiasAPI, AutocompleteSearchSegment, AutocompleteSearchSegmentAPI, AutocompleteSearchSegmentType, BookmarkIntent, BookmarkIntentDetails, CalculateRouteParams, CanonicalAreaTag, ChargingStationsAvailabilityParams, Circle, CircleAPI, CommonServiceParamsWithZoom, ComputeTravelTimeFor, CoordinateIntent, CoordinateIntentAPI, CoordinateIntentDetails, CoordinateIntentDetailsAPI, ExplorationBrandAPI, ExplorationChargingParkAPI, ExplorationClassificationAPI, ExplorationOpeningHoursAPI, ExplorationOpeningIntervalAPI, ExplorationPOIAPI, ExplorationPlaceProps, ExplorationRecordType, ExplorationSearchParams, ExplorationSearchPayloadAPI, ExplorationSearchRequestAPI, ExplorationSearchResponse, ExplorationSearchResponseAPI, ExplorationSearchResultAPI, ExplorationViewportAPI, ExtendedRouteRepresentation, FunctionalRoadClass, FuzzySearchParams, FuzzySearchResponse, FuzzySearchResponseAPI, FuzzySearchResultAPI, GeocodingParams, GeocodingProps, GeocodingResponse, GeometriesInput, GeometryAPI, GeometryDataParams, GeometryDataResponseAPI, GeometryParams, GeometryPlaceParams, GeometrySearchFeatureCollectionProps, GeometrySearchParams, GeometrySearchPayloadAPI, GeometrySearchRequestAPI, GeometrySearchResponse, GeometrySearchResponseAPI, GeometrySearchResultAPI, GuidanceParams, InputSectionType, InputSectionTypes, LegCostModel, MaxNumberOfAlternatives, NearAPI, NearbyIntent, NearbyIntentAPI, NearbyIntentDetails, NearbyIntentDetailsAPI, POICategoriesParams, POICategoriesResponse, POICategoryResult, PlaceByIdMandatoryParams, PlaceByIdOptionalParams, PlaceByIdParams, PlaceByIdResponse, PlaceByIdResponseAPI, PlaceByIdResultAPI, PoiCategoriesResponseAPI, PoiCategoryAPI, PolygonAPI, PopulatedAreaTag, QueryIntent, QueryIntentAPI, ReverseGeocodingMandatoryParams, ReverseGeocodingOptionalParams, ReverseGeocodingParams, RoutePointAPI, RouteStopOptions, SearchGeometryInput, TrafficAreaAnalyticsDateRange, TrafficAreaAnalyticsDays, TrafficAreaAnalyticsParams, TrafficIncidentDetailsByBBoxParams, TrafficIncidentDetailsByIdsParams, TrafficIncidentDetailsParams, W3WIntent, W3WIntentDetails, arrivalSides, functionalRoadClasses, metricKeyToApiDataType };
+export type { AdditionalDataAPI, AlongRouteSearchParams, AlongRouteSearchPayloadAPI, AlongRouteSearchRequestAPI, AlongRouteSearchResponse, AlongRouteSearchResponseAPI, AlongRouteSearchResultAPI, AlongRouteSortBy, AreaAnalyticsDateInput, AreaTag, ArrivalSide, AutocompleteGenericSearchSegment, AutocompleteSearchBrandSegment, AutocompleteSearchCategorySegment, AutocompleteSearchCategorySegmentAPI, AutocompleteSearchContext, AutocompleteSearchContextAPI, AutocompleteSearchMatch, AutocompleteSearchMatches, AutocompleteSearchParams, AutocompleteSearchPlaintextSegment, AutocompleteSearchResponse, AutocompleteSearchResponseAPI, AutocompleteSearchResult, AutocompleteSearchResultAPI, AutocompleteSearchResultGeoBias, AutocompleteSearchResultGeoBiasAPI, AutocompleteSearchSegment, AutocompleteSearchSegmentAPI, AutocompleteSearchSegmentType, BookmarkIntent, BookmarkIntentDetails, CalculateRouteParams, CanonicalAreaTag, ChargingStationsAvailabilityParams, ChargingStopsStrategy, Circle, CircleAPI, CommonServiceParamsWithZoom, ComputeTravelTimeFor, CoordinateIntent, CoordinateIntentAPI, CoordinateIntentDetails, CoordinateIntentDetailsAPI, ExplorationBrandAPI, ExplorationChargingParkAPI, ExplorationClassificationAPI, ExplorationOpeningHoursAPI, ExplorationOpeningIntervalAPI, ExplorationPOIAPI, ExplorationPlaceProps, ExplorationRecordType, ExplorationSearchParams, ExplorationSearchPayloadAPI, ExplorationSearchRequestAPI, ExplorationSearchResponse, ExplorationSearchResponseAPI, ExplorationSearchResultAPI, ExplorationViewportAPI, ExtendedRouteRepresentation, FunctionalRoadClass, FuzzySearchParams, FuzzySearchResponse, FuzzySearchResponseAPI, FuzzySearchResultAPI, GeocodingParams, GeocodingProps, GeocodingResponse, GeometriesInput, GeometryAPI, GeometryDataParams, GeometryDataResponseAPI, GeometryParams, GeometryPlaceParams, GeometrySearchFeatureCollectionProps, GeometrySearchParams, GeometrySearchPayloadAPI, GeometrySearchRequestAPI, GeometrySearchResponse, GeometrySearchResponseAPI, GeometrySearchResultAPI, GuidanceParams, InputSectionType, InputSectionTypes, LegCostModel, MaxNumberOfAlternatives, NearAPI, NearbyIntent, NearbyIntentAPI, NearbyIntentDetails, NearbyIntentDetailsAPI, POICategoriesParams, POICategoriesResponse, POICategoryResult, Phonetics, PlaceByIdMandatoryParams, PlaceByIdOptionalParams, PlaceByIdParams, PlaceByIdResponse, PlaceByIdResponseAPI, PlaceByIdResultAPI, PoiCategoriesResponseAPI, PoiCategoryAPI, PolygonAPI, PopulatedAreaTag, QueryIntent, QueryIntentAPI, ReverseGeocodingMandatoryParams, ReverseGeocodingOptionalParams, ReverseGeocodingParams, RoutePointAPI, RouteStopOptions, SearchGeometryInput, TrafficAreaAnalyticsDateRange, TrafficAreaAnalyticsDays, TrafficAreaAnalyticsParams, TrafficIncidentDetailsByBBoxParams, TrafficIncidentDetailsByIdsParams, TrafficIncidentDetailsParams, W3WIntent, W3WIntentDetails, arrivalSides, chargingStopsStrategies, functionalRoadClasses, metricKeyToApiDataType };