@tomtom-org/maps-sdk 0.32.3 → 0.34.0

package/core/dist/index.d.ts

@@ -206,7 +206,7 @@ export declare type Anything = {
  * // Route will pass within 2km of Amsterdam center
  * ```
  *
- * @see [Waypoints Guide](https://docs.tomtom.com/maps-sdk-js/guides/services/routing/waypoints)
+ * @see [Locations Guide](https://docs.tomtom.com/maps-sdk-js/guides/services/routing/locations)
  *
  * @group Route
  */
@@ -392,30 +392,6 @@ export declare const bboxFromGeoJSON: (hasBBox: HasBBox) => OptionalBBox;
  */
 export declare const bboxOnlyIfWithArea: (bbox: OptionalBBox) => OptionalBBox;
 
-/**
- * Brand information for a POI.
- *
- * Identifies the commercial brand or chain associated with a location.
- * Useful for finding specific franchise locations or filtering by brand.
- *
- * @example
- * ```typescript
- * const brand: Brand = {
- *   name: 'Starbucks'
- * };
- * ```
- *
- * @group Place
- */
-export declare type Brand = {
-    /**
-     * Brand name.
-     *
-     * The commercial or franchise name (e.g., 'McDonald\'s', 'Shell', 'Hilton').
-     */
-    name: string;
-};
-
 /**
  * Traffic incident cause based on TPEG2-TEC standard.
  *
@@ -560,7 +536,7 @@ export declare type ChargingPark = {
      * For real-time availability, use the availability property instead.
      * This field shows total counts regardless of current operational status.
      */
-    connectorCounts: Omit<ConnectorAvailability, 'statusCounts'>[];
+    connectorCounts: ConnectorCount[];
 };
 
 /**
@@ -719,15 +695,7 @@ export declare type ChargingPoint = {
  *
  * @group Place
  */
-export declare type ChargingPointAvailability = {
-    /**
-     * Total number of charging points or connectors.
-     *
-     * Depends on context:
-     * - For ChargingPointAvailability: total number of charging points
-     * - For ConnectorAvailability: total number of connectors of this type
-     */
-    count: number;
+export declare type ChargingPointAvailability = HasCount & {
     /**
      * Breakdown of units by operational status.
      *
@@ -839,7 +807,13 @@ export declare type ChargingPointStatus = (typeof chargingPointStatus)[number];
 export declare const chargingPointStatus: readonly ["Available", "Reserved", "Occupied", "OutOfService", "Unknown"];
 
 /**
- * @group Route
+ * The charging speed classification of this charging connection.
+ *
+ * @remarks
+ * - `slow`: Typically up to 12 kW (Level 1 AC charging)
+ * - `regular`: Typically between 12 kW and 50 kW (Level 2 AC charging)
+ * - `fast`: Typically between 50 kW and 150 kW (DC fast charging)
+ * - `ultra-fast`: Typically above 150 kW (High-power DC fast charging)
  */
 export declare type ChargingSpeed = 'slow' | 'regular' | 'fast' | 'ultra-fast';
 
@@ -1402,6 +1376,16 @@ export declare type Connector = {
      * - 150-350 kW: DC ultra-fast charging
      */
     ratedPowerKW: number;
+    /**
+     * The charging speed classification of this charging connection.
+     *
+     * @remarks
+     * - `slow`: Typically up to 12 kW (Level 1 AC charging)
+     * - `regular`: Typically between 12 kW and 50 kW (Level 2 AC charging)
+     * - `fast`: Typically between 50 kW and 150 kW (DC fast charging)
+     * - `ultra-fast`: Typically above 150 kW (High-power DC fast charging)
+     */
+    chargingSpeed: ChargingSpeed;
     /**
      * Voltage in volts (V).
      *
@@ -1445,15 +1429,14 @@ export declare type Connector = {
  *
  * @group Place
  */
-export declare type ConnectorAvailability = ChargingPointAvailability & {
-    /**
-     * Connector specifications for this availability group.
-     *
-     * All connectors in this availability group share these specifications
-     * (same type, power rating, voltage, etc.).
-     */
-    connector: Connector;
-};
+export declare type ConnectorAvailability = HasConnector & ChargingPointAvailability;
+
+/**
+ * Count information for a specific connector type.
+ *
+ * @group Place
+ */
+export declare type ConnectorCount = HasConnector & HasCount;
 
 /**
  * Electric vehicle charging connector type.
@@ -2351,6 +2334,30 @@ export declare type Guidance = {
  */
 export declare type HasBBox = BBox | GeoJsonObject | GeoJsonObject[];
 
+/**
+ * Has an Electric vehicle charging connector.
+ *
+ * @group Place
+ */
+export declare type HasConnector = {
+    /**
+     * Electric vehicle charging connector.
+     */
+    connector: Connector;
+};
+
+/**
+ * Has a number representing a count.
+ *
+ * @group Place
+ */
+export declare type HasCount = {
+    /**
+     * Number representing the count of items.
+     */
+    count: number;
+};
+
 /**
  * Input type representing a geographic point location.
  *
@@ -3620,7 +3627,7 @@ export declare type RoadInformation = {
      * Lists the road shields for this road.
      * The list can be empty if no road shields are available.
      */
-    roadShields: RoadShield[];
+    roadShields?: RoadShield[];
 };
 
 /**
@@ -3645,7 +3652,7 @@ export declare type RoadShield = {
      * Information allowing the client to build an image of the road shield using the TomTom RoadShield API.
      * Included if instructionRoadShieldReferences was requested.
      */
-    roadShieldReference: RoadShieldReference;
+    roadShieldReference?: RoadShieldReference;
     /**
      * The state code of the state the shield is in (second part of an ISO 3166-2 identifier).
      * Included if state codes are available for the country the road shield is located in.
@@ -3673,7 +3680,7 @@ export declare type RoadShieldReference = {
     /**
      * An optional list of possible affixes that can be shown in addition to the shieldContent.
      */
-    affixes: string[];
+    affixes?: string[];
 };
 
 /**
@@ -4178,6 +4185,30 @@ export declare type SummaryBase = {
      * Only included if requested using the computeTravelTimeFor parameter.
      */
     liveTrafficIncidentsTravelTimeInSeconds?: number;
+    /**
+     * The distance (in meters) from the origin point to the first point where this route forks off from the reference route.
+     *
+     * @remarks
+     * * If the route is identical to the reference route, then this field is set to the length of the route.
+     * * Included in all alternative (but not reference) route summary fields.
+     */
+    deviationDistanceInMeters?: number;
+    /**
+     * The travel time (in seconds) from the origin point to the first point where this route forks off from the reference route.
+     *
+     * @remarks
+     * * If the route is identical to the reference route, then this field is set to the estimated travel time of the route.
+     * * Included in all alternative (but not reference) route summary fields.
+     */
+    deviationTimeInSeconds?: number;
+    /**
+     * The coordinates of the first point where this route forks off from the reference route.
+     *
+     * @remarks
+     * * If the route is identical to the reference route, then this field is set to the coordinates of the last point on the route.
+     * * Included in all alternative (but not reference) route summary fields.
+     */
+    deviationPoint?: Position;
 };
 
 /**
@@ -4201,11 +4232,11 @@ export declare type TextWithPhonetics = {
      * Included if phonetic transcription is available for the specific name, and phonetic transcriptions have been requested by the client.
      * Note: The phonetic transcription can contain double quote characters ("). In this case those characters are escaped with a backslash (\).
      */
-    phonetic: string;
+    phonetic?: string;
     /**
      * Encodes the language using an IETF language tag, e.g., en-GB, en-US.
      */
-    phoneticLanguageCode: string;
+    phoneticLanguageCode?: string;
 };
 
 /**
@@ -4447,7 +4478,7 @@ export declare type TrafficIncidentTEC = {
      *
      * TPEG2-TEC standard code indicating how traffic is affected.
      */
-    effectCode: number;
+    effectCode?: number;
     /**
      * List of causes for this traffic incident.
      *

package/map/dist/THIRD_PARTY.txt

@@ -63,7 +63,7 @@ terms above.
 ---
 
 Name: @tomtom-org/maps-sdk
-Version: 0.32.3
+Version: 0.34.0
 License: See in LICENSE.txt
 Private: false
 Description: TomTom Maps for JavaScript

package/map/dist/index.d.ts

@@ -29,6 +29,7 @@ import { MapOptions } from 'maplibre-gl';
 import { Place } from '../../../../core';
 import { Place as Place_2 } from '../../../core';
 import { Places } from '../../../core';
+import { Places as Places_2 } from '../../../../core';
 import { POICategory } from '../../../core';
 import { Point } from 'geojson';
 import { PolygonFeatures } from '../../../core';
@@ -948,8 +949,9 @@ declare type BaseSourceAndLayers = {
 /**
  * Builds the title of the place to display it on the map.
  * @param place The place to display.
+ * @ignore
  */
-export declare const buildPlaceTitle: (place: Place_2) => string;
+export declare const buildPlaceTitle: (place: Place) => string;
 
 /**
  * Generates the routing layers configuration for route visualization on the map.
@@ -1036,7 +1038,7 @@ export declare type ChargingStopIconMapping = {
     /**
      * The function which maps a ChargingStop to a sprite image ID.
      */
-    fn: ToStringFn<ChargingStop>;
+    fn: (stop: ChargingStop) => string;
 };
 
 /**
@@ -1386,6 +1388,40 @@ export declare type CustomStyle = {
     json?: StyleSpecification;
 };
 
+/**
+ * Configuration for the default place icon.
+ * * This is the icon that is used for clicked locations and addresses without a specific category.
+ *
+ * @group Places
+ */
+export declare type DefaultPlaceIconConfig = {
+    /**
+     * Base style options for the SVG default icon.
+     *
+     * @remarks
+     * Use this to set the fill color, outline color, and outline opacity for the default waypoint icon.
+     *
+     * Example:
+     * ```typescript
+     * baseStyle: {
+     *   fillColor: '#007AFF',
+     *   outlineColor: '#FFFFFF',
+     *   outlineOpacity: 0.8
+     * }
+     * ```
+     */
+    style?: SVGIconStyleOptions;
+    /**
+     * Custom image for the default icon.
+     *
+     * @remarks
+     * If provided, this image will be used instead of the default icon.
+     *
+     * If an SVG image is provided, the 'style' options can still apply. Otherwise, 'style' is ignored.
+     */
+    image?: Omit<CustomImage, 'id'>;
+};
+
 /**
  * Default routing layers configuration. Calls routingLayers with no parameters.
  *
@@ -3061,16 +3097,15 @@ export declare type GeometryTextConfig = {
 
 /**
  * Gets the map style sprite image ID to display on the map for the give place.
- * @param place The place to display.
- * @param config
+ * @ignore
  */
-export declare const getIconIDForPlace: (place: Place_2, config?: PlacesModuleConfig) => string;
+export declare const getIconIDForPlace: (place: Place, instanceIndex: number, config?: PlacesModuleConfig) => string;
 
 /**
  * Maps a Place category to the poi layer one, so the latter's style can apply it.
  * @ignore
  */
-export declare const getPOILayerCategoryForPlace: (place: Place_2) => string | undefined;
+export declare const getPOILayerCategoryForPlace: (place: Place) => string | undefined;
 
 /**
  * Gets the specified filtered categories icon IDs to be used in map filtering.
@@ -3337,6 +3372,11 @@ declare type HillshadeSourcesWithLayers = {
  */
 export declare type HoverEventType = 'hover' | 'long-hover';
 
+/**
+ * @ignore
+ */
+export declare const imageIDWithInstanceSuffix: (baseID: string, instanceIndex: number) => string;
+
 /**
  * Available traffic incident category identifiers.
  *
@@ -3446,6 +3486,14 @@ export declare type LayerSpecTemplate<L extends LayerSpecification> = Omit<L, 'i
  */
 export declare type LayerSpecWithSource = Exclude<LayerSpecification, BackgroundLayerSpecification>;
 
+/**
+ * Indicator of a light or dark theme.
+ * * Can be used to classify a map style as light or dark, or to apply light or dark configurations to map modules if they support it.
+ *
+ * @group Map Style
+ */
+export declare type LightDark = 'light' | 'dark';
+
 /**
  * @ignore
  */
@@ -4099,7 +4147,7 @@ export declare type PlaceDisplayProps = {
  * ```typescript
  * // Custom icons for specific categories
  * const iconConfig: PlaceIconConfig = {
- *   customIcons: [
+ *   categoryIcons: [
  *     { category: 'RESTAURANT', image: '/icons/food.png', pixelRatio: 2 },
  *     { category: 'HOTEL_MOTEL', image: '/icons/hotel.png', pixelRatio: 2 }
  *   ]
@@ -4109,13 +4157,28 @@ export declare type PlaceDisplayProps = {
  * @group Places
  */
 export declare type PlaceIconConfig = {
+    /**
+     * Configuration for the default place icon.
+     * * The default icon is the one used for clicked locations and addresses without a specific category, or via custom mapping.
+     */
+    default?: DefaultPlaceIconConfig;
     /**
      * Array of custom icons for specific place categories.
      *
      * When provided, places matching these categories will use the custom icons
      * instead of the default style.
      */
-    customIcons?: CustomImage<MapStylePOICategory>[];
+    categoryIcons?: CustomImage<MapStylePOICategory>[];
+    /**
+     * Custom mapping function to generate the icon ID for a given place.
+     *
+     * @remarks
+     * If provided, this function sets the iconID property on the place.
+     * This allows for full control on how to determine which icon to use for each place based on its properties.
+     *
+     * @param place The place to generate the icon ID for.
+     */
+    mapping?: (place: Place) => string;
 };
 
 /**
@@ -4174,12 +4237,14 @@ export declare type PlaceLayersConfig = {
      */
     main?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>;
     /**
-     * Selected/highlighted place marker layer specification.
+     * Selected place marker layer specification.
      *
      * @remarks
      * Controls the visual appearance of places when they are highlighted or selected
      * (e.g., on hover or click events). This layer is rendered on top of the main layer
      * to ensure selected places are always visible.
+     *
+     * This layer reacts to 'hover' and 'click' event states.
      */
     selected?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>;
 } & HasAdditionalLayersConfig;
@@ -4228,7 +4293,7 @@ export declare const PLACES_SOURCE_PREFIX_ID = "places";
  * // Create places module with pin markers
  * const places = await PlacesModule.get(map, {
  *   icon: {
- *     customIcons: []
+ *     categoryIcons: []
  *   },
  *   text: {
  *     field: (place) => place.properties.poi?.name || 'Unknown'
@@ -4264,6 +4329,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @private
      */
     private instanceIndex;
+    private defaultPlaceIconID;
     /**
      * Make sure the map is ready before create an instance of the module and any other interaction with the map
      * @param tomtomMap The TomTomMap instance.
@@ -4325,7 +4391,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * ```typescript
      * places.applyIconConfig({
-     *   customIcons: [
+     *   categoryIcons: [
      *     { category: 'RESTAURANT', id: 'restaurant-icon', image: '/icons/food.png' }
      *   ]
      * });
@@ -4378,6 +4444,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
         [key: string]: any;
     }): void;
     private updateLayersAndData;
+    private setupImages;
     private updateData;
     /**
      * Displays the given places on the map.
@@ -4514,7 +4581,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
  * const config: PlacesModuleConfig = {
  *   icon: {
  *     style: 'base-map',
- *     customIcons: [
+ *     categoryIcons: [
  *       { category: 'RESTAURANT', image: '/icons/restaurant.png' }
  *     ]
  *   },
@@ -4575,7 +4642,7 @@ export declare type PlacesModuleConfig = {
      *
      * @remarks
      * Useful for:
-     * - Adding computed flags for conditional styling
+     * - Adding computed flags for conditional styling via 'layers' config.
      * - Extracting nested properties for easier access
      * - Adding business logic properties
      *
@@ -5367,7 +5434,7 @@ declare type PoIsSourcesAndLayers = {
  * prepare places features to be displayed on map by adding needed  properties for title, icon and style
  * @ignore
  */
-export declare const preparePlacesForDisplay: (placesInput: Place_2 | Place_2[] | Places, map: Map_2, config?: PlacesModuleConfig) => Places<DisplayPlaceProps>;
+export declare const preparePlacesForDisplay: (placesInput: Place | Place[] | Places_2, instanceIndex: number, config?: PlacesModuleConfig) => Places_2<DisplayPlaceProps>;
 
 /**
  * Parameters to update the event state of a feature programmatically.
@@ -6953,11 +7020,12 @@ export declare class TomTomMap {
     /**
      * @ignore
      */
-    _eventsProxy: EventsProxy;
+    readonly _eventsProxy: EventsProxy;
     /**
      * @ignore
      */
     _params: TomTomMapParams;
+    styleLightDarkTheme: LightDark;
     private readonly styleChangeHandlers;
     /**
      * Constructs a new TomTom Map instance and attaches it to a DOM element.
@@ -7450,17 +7518,7 @@ export declare class TomTomMapSource<SOURCE_SPEC extends SourceSpecification = S
  * Transforms the input of a "show" call to FeatureCollection "Places".
  * @ignore
  */
-export declare const toPlaces: (places: Place_2 | Place_2[] | Places) => Places;
-
-/**
- * Function type for mapping a value to a string, typically used for icon sprite IDs.
- *
- * @typeParam T - The type of the input value to be mapped to a string.
- * @param key - The input value to map.
- * @returns The string representation or sprite image ID for the given value.
- * @group Routing
- */
-export declare type ToStringFn<T> = (key: T) => string;
+export declare const toPlaces: (places: Place | Place[] | Places_2) => Places_2;
 
 /**
  * Source identifier for traffic flow vector tiles.
@@ -8190,6 +8248,7 @@ export declare class TrafficIncidentsModule extends AbstractMapModule<TrafficInc
      * ```
      */
     setVisible(visible: boolean): void;
+    private _setVisible;
     /**
      * Checks if any traffic incident layers are currently visible.
      *