@tomtom-org/maps-sdk 0.35.5 → 0.36.1

package/core/dist/index.d.ts

@@ -2165,7 +2165,7 @@ export declare type GetPositionOptions = {
  * }
  * ```
  *
- * @group Shared
+ * @ignore
  */
 export declare const getPositionStrict: (hasLngLat: HasLngLat, options?: GetPositionOptions) => Position;
 
@@ -3432,6 +3432,15 @@ export declare type POI = {
     timeZone?: TimeZone;
 };
 
+/**
+ * POI categories were retrieved from https://docs.tomtom.com/search-api/documentation/poi-categories-service/poi-categories
+ * so it can be passed to search endpoints in a human-readable format in addition to being able to use POI category ID directly
+ * categories were put in this format trying to match them poi classification codes as much as possible.
+ *
+ * @ignore
+ */
+export declare const poiCategoriesToID: Record<POICategory, number>;
+
 /**
  * @group Place
  */
@@ -3470,6 +3479,13 @@ export declare type PoiDetailsDataSource = {
     sourceName?: string;
 };
 
+/**
+ * Inverted mapping of POI category IDs to their corresponding category names.
+ *
+ * @ignore
+ */
+export declare const poiIDsToCategories: Record<number, POICategory>;
+
 /**
  * GeoJSON Feature containing polygon or multi-polygon geometry.
  *
@@ -3729,7 +3745,14 @@ export declare type RoadShieldSectionProps = SectionProps & {
  *
  * @group Route
  */
-export declare type Route<P extends RouteProps = RouteProps> = Feature<LineString, P>;
+export declare type Route<P extends RouteProps = RouteProps> = Omit<Feature<LineString, P>, 'id'> & {
+    /**
+     * Unique identifier for this route.
+     *
+     * Randomly generated to distinguish between multiple route alternatives.
+     */
+    id: string;
+};
 
 /**
  * Route path point and its metadata.
@@ -3839,12 +3862,6 @@ export declare type RouteProgressPoint = {
  * @group Route
  */
 export declare type RouteProps = {
-    /**
-     * Unique identifier for this route.
-     *
-     * Randomly generated to distinguish between multiple route alternatives.
-     */
-    id: string;
     /**
      * Summary statistics for the entire route.
      *
@@ -3910,7 +3927,12 @@ export declare type RouteProps = {
  *
  * @group Route
  */
-export declare type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>;
+export declare type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>, 'features'> & {
+    /**
+     * Array of route features.
+     */
+    features: Route<P>[];
+};
 
 /**
  * Complete summary information for an entire route.
@@ -4441,9 +4463,8 @@ export declare type TomTomHeaders = {
 
 /**
  * @ignore
- * @param lngLat
  */
-export declare const toPointFeature: (lngLat: Position) => Feature<Point>;
+export declare const toPointFeature: (coordinates: Position) => Feature<Point>;
 
 /**
  * All possible traffic incident categories.

package/map/dist/THIRD_PARTY.txt

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

package/map/dist/index.d.ts

@@ -956,9 +956,11 @@ export declare const buildPlaceTitle: (place: Place) => string;
 /**
  * Generates the routing layers configuration for route visualization on the map.
  * @param config - Optional routing module configuration to customize layer properties.
+ * @param layerIDPrefix - Optional prefix to add to layer IDs for supporting multiple instances.
+ * @param instanceIndex - Optional instance index for image ID suffixes.
  * @ignore
  */
-export declare const buildRoutingLayers: (config?: RoutingModuleConfig) => Required<RouteLayersConfig>;
+export declare const buildRoutingLayers: (config?: RoutingModuleConfig, layerIDPrefix?: string, instanceIndex?: number) => Required<RouteLayersConfig>;
 
 /**
  * Parameters to identify a feature by its ID or index in a given features array.
@@ -3379,11 +3381,6 @@ 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.
  *
@@ -3507,9 +3504,10 @@ export declare type LightDark = 'light' | 'dark';
 export declare const MAJOR_DELAY_COLOR = "#AD0000";
 
 /**
+ * POI category mappings that have a direct equivalent in Map Display POI categories.
  * @ignore
  */
-declare const mapDisplayPoiCategoryMappings: Partial<Record<POICategory, string>>;
+export declare const mapDisplayPoiCategoryMappings: Partial<Record<POICategory, string>>;
 
 /**
  * Configuration options for map user event handling.
@@ -4174,15 +4172,39 @@ export declare type PlaceIconConfig = {
      */
     categoryIcons?: CustomImage<MapStylePOICategory>[];
     /**
-     * Custom mapping function to generate the icon ID for a given place.
+     * Custom mapping to determine the icon 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.
+     * Supports two mapping strategies:
+     *
+     * - **`imageID`**: Directly returns the icon image ID to use for the place.
+     *   This provides full control over icon selection.
+     *
+     * - **`poiCategory`**: Returns a POI category, which is then resolved to an icon
+     *   using the existing category-to-icon logic. This reuses the standard category mapping.
+     *
+     * @example
+     * ```typescript
+     * // Direct image ID mapping
+     * mapping: {
+     *   to: 'imageID',
+     *   fn: (place) => place.properties.poi?.name?.includes('urgent') ? 'urgent-icon' : 'default-icon'
+     * }
      *
-     * @param place The place to generate the icon ID for.
+     * // POI category mapping
+     * mapping: {
+     *   to: 'poiCategory',
+     *   fn: (place) => place.properties.customCategory || 'RESTAURANT'
+     * }
+     * ```
      */
-    mapping?: (place: Place) => string;
+    mapping?: {
+        to: 'imageID';
+        fn: (place: Place) => string;
+    } | {
+        to: 'poiCategory';
+        fn: (place: Place) => MapStylePOICategory;
+    };
 };
 
 /**
@@ -4253,17 +4275,6 @@ export declare type PlaceLayersConfig = {
     selected?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>;
 } & HasAdditionalLayersConfig;
 
-/**
- * Source identifier prefix for places (geocoding results) features.
- *
- * @remarks
- * Combined with a unique identifier to create source IDs for place markers
- * displayed via the Places module.
- *
- * @group Places
- */
-export declare const PLACES_SOURCE_PREFIX_ID = "places";
-
 /**
  * Map module for displaying and managing place markers.
  *
@@ -6050,7 +6061,15 @@ export declare type RouteTheme = {
  * @group Routing
  */
 export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithLayers, RoutingModuleConfig> {
+    private static lastInstanceIndex;
     private layersSpecs;
+    private layerIDPrefix;
+    /**
+     * The index of this instance, to generate unique source and layer IDs.
+     * * Starts with 0 and each instance increments it by one.
+     * @private
+     */
+    private instanceIndex;
     /**
      * 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.
@@ -6089,7 +6108,7 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
     /**
      * @ignore
      */
-    protected _initSourcesWithLayers(config?: RoutingModuleConfig): RoutingSourcesWithLayers;
+    protected _initSourcesWithLayers(config?: RoutingModuleConfig, restore?: boolean): RoutingSourcesWithLayers;
     /**
      * @ignore
      */
@@ -6861,6 +6880,11 @@ export declare const tertiaryRoadCategories: readonly ["connecting", "major_loca
  */
 export declare type TertiaryRoadCategory = (typeof tertiaryRoadCategories)[number];
 
+/**
+ * @ignore
+ */
+export declare const toBaseMapPOICategory: (category: POICategory) => string;
+
 /**
  * Layer to be added to the existing style, and may include extra config such as the ID of the layer to add it under.
  * * e.g. GeoJSON layers.
@@ -6893,11 +6917,6 @@ export declare type ToBeAddedLayerSpecTemplate<L extends LayerSpecification = La
  */
 export declare type ToBeAddedLayerSpecWithoutSource<L extends LayerSpecification = LayerSpecification> = Omit<ToBeAddedLayerSpec<L>, 'source'>;
 
-/**
- * @ignore
- */
-export declare const toMapDisplayPOICategory: (category: POICategory) => string;
-
 /**
  * Main TomTom Map class for displaying interactive maps in web applications.
  *