@tomtom-org/maps-sdk 0.54.0 → 0.56.0

package/core/dist/index.d.ts

@@ -1352,6 +1352,9 @@ export type AddressRanges = {
  * - `main`: Primary entrance (at most one per place)
  * - `minor`: Secondary or alternative entrance (can have multiple)
  *
+ * Absent when the service does not classify its entry points, which is the case for
+ * reverse geocoding.
+ *
  * @group Place
  */
 export type EntryPointType = 'main' | 'minor';
@@ -1384,9 +1387,9 @@ export type EntryPoint = {
    */
   position: Position;
   /**
-   * Type of entry point (main or minor).
+   * Type of entry point (main or minor), when the service classifies it.
    */
-  type: EntryPointType;
+  type?: EntryPointType;
 };
 /**
  * @group Place
@@ -1573,7 +1576,8 @@ export type CommonPlaceProps = {
   /**
    * Physical entry points (entrances) to the place.
    *
-   * Useful for navigation to direct users to the correct entrance.
+   * Useful for navigation to direct users to the correct entrance. Reverse geocoding
+   * returns them unclassified, so their `type` is absent.
    */
   entryPoints?: EntryPoint[];
   /**
@@ -1615,10 +1619,6 @@ export type CommonPlaceProps = {
  * @group Place
  */
 export type RevGeoAddressProps = CommonPlaceProps & {
-  /**
-   * Physical access points (e.g. driveway entrances) for the address, when available.
-   */
-  accessPoints?: Position[];
   /**
    * Original coordinates used in the reverse geocoding query [longitude, latitude].
    */
@@ -3252,7 +3252,8 @@ type WaypointProps = {
    *
    * @remarks
    * - The wait counts towards the route's `travelTimeInSeconds`, not only its arrival time
-   * - Not supported on the destination: the routing service requires the last leg's wait to be 0
+   * - Not supported on the destination: the routing service requires the last leg's wait to be 0,
+   *   and `calculateRoute` rejects it at validation
    *
    * @example
    * ```typescript
@@ -3998,13 +3999,22 @@ export type SectionProps = {
  *   id: 'country-section-1',
  *   startPointIndex: 0,
  *   endPointIndex: 150,
- *   countryCodeISO3: 'NLD',  // Netherlands
+ *   countryCodeISO2: 'NL',   // Netherlands
+ *   countryCodeISO3: 'NLD',
  * };
  * ```
  *
  * @group Route
  */
 export type CountrySectionProps = SectionProps & {
+  /**
+   * Two-letter ISO 3166-1 alpha-2 country code.
+   *
+   * Examples: 'US', 'GB', 'NL', 'DE', 'FR'
+   *
+   * @see [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+   */
+  countryCodeISO2: string;
   /**
    * Three-letter ISO 3166-1 alpha-3 country code.
    *
@@ -5475,6 +5485,12 @@ export declare const formatDuration: (seconds: number | undefined, options?: Tim
  * @group Utils
  */
 export type DistanceUnitsType = 'metric' | 'imperial_us' | 'imperial_uk';
+/**
+ * Metres in one international mile — the factor behind every metric-to-imperial conversion in the SDK.
+ *
+ * @ignore
+ */
+export declare const MILE_IN_METERS = 1609.344;
 /**
  * Formatting is based on the number of meters passed and unit type. Less meters more precision.
  * @example