@tomtom-org/maps-sdk 0.36.5 → 0.37.0

package/map/dist/index.d.ts

@@ -64,8 +64,9 @@ declare abstract class AbstractEventProxy {
      * @param sourceWithLayers The sources and layers to added.
      * @param handlerFn Function that will handle the event.
      * @param type Type of event to listen to.
+     * @param config Optional configuration for the event handler.
      */
-    addEventHandler<T = MapGeoJSONFeature>(sourceWithLayers: SourceWithLayers, handlerFn: UserEventHandler<T>, type: EventType): void;
+    addEventHandler<T = MapGeoJSONFeature>(sourceWithLayers: SourceWithLayers, handlerFn: UserEventHandler<T>, type: EventType, config: EventHandlerConfig | undefined): void;
     /**
      * Removes the given sources and layers from the interactive list. When not present, nothing happens.
      * @param type The event type to be removed.
@@ -103,7 +104,7 @@ declare abstract class AbstractEventProxy {
  * handling map style changes by restoring the module's state when needed.
  *
  * @typeParam SOURCES_WITH_LAYERS - The type defining the sources and layers used by this module
- * @typeParam CFG - The configuration type for this module, or undefined if no configuration is needed
+ * @typeParam CFG - The configuration type for this module, or undefined if no configuration is needed. When defined, must extend MapModuleCommonConfig.
  *
  * @example
  * ```typescript
@@ -117,7 +118,7 @@ declare abstract class AbstractEventProxy {
  *
  * @group Shared
  */
-export declare abstract class AbstractMapModule<SOURCES_WITH_LAYERS extends SourcesWithLayers, CFG = undefined> {
+export declare abstract class AbstractMapModule<SOURCES_WITH_LAYERS extends SourcesWithLayers, CFG extends MapModuleCommonConfig | undefined = undefined> {
     private readonly sourceType;
     /**
      * @ignore
@@ -666,6 +667,7 @@ export declare class BaseMapModule extends AbstractMapModule<BaseSourceAndLayers
      * @ignore
      */
     protected _applyConfig(config: BaseMapModuleConfig | undefined): {
+        events?: EventHandlerConfig;
         visible?: boolean;
         layerGroupsVisibility?: BaseMapLayerGroupsVisibility;
     } | undefined;
@@ -825,7 +827,7 @@ export declare class BaseMapModule extends AbstractMapModule<BaseSourceAndLayers
  *
  * @group Base Map
  */
-export declare type BaseMapModuleConfig = {
+export declare type BaseMapModuleConfig = MapModuleCommonConfig & {
     /**
      * Controls the visibility of all layers associated with this module.
      *
@@ -964,7 +966,7 @@ export declare const buildRoutingLayers: (config?: RoutingModuleConfig, layerIDP
 
 /**
  * Parameters to identify a feature by its ID or index in a given features array.
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type ByIdOrIndex = {
     /**
@@ -1118,7 +1120,7 @@ export declare type ChargingStopTextConfig = {
  * };
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type CleanEventStateOptions = ByIdOrIndex & {
     /**
@@ -1156,7 +1158,7 @@ export declare type CleanEventStateOptions = ByIdOrIndex & {
  * };
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type CleanEventStatesOptions = {
     /**
@@ -1203,7 +1205,7 @@ export declare type CleanEventStatesOptions = {
  * const rightClick: ClickEventType = 'contextmenu';
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type ClickEventType = 'click' | 'contextmenu';
 
@@ -1226,6 +1228,13 @@ declare const colorPalettes: {
     pastelRainbow: string[];
 };
 
+/**
+ * Allowed CSS cursor styles for map interactions.
+ *
+ * @group User Interaction Events
+ */
+export declare type CSSCursor = 'alias' | 'all-scroll' | 'auto' | 'cell' | 'context-menu' | 'col-resize' | 'copy' | 'crosshair' | 'default' | 'e-resize' | 'ew-resize' | 'grab' | 'grabbing' | 'help' | 'move' | 'n-resize' | 'ne-resize' | 'nesw-resize' | 'ns-resize' | 'nw-resize' | 'nwse-resize' | 'no-drop' | 'none' | 'not-allowed' | 'pointer' | 'progress' | 'row-resize' | 's-resize' | 'se-resize' | 'sw-resize' | 'text' | 'vertical-text' | 'w-resize' | 'wait' | 'zoom-in' | 'zoom-out';
+
 /**
  * Basic structure to define custom map icons, which end up in the map sprite.
  *
@@ -1919,6 +1928,47 @@ declare type DisplayTrafficSectionProps = DisplaySectionProps & TrafficSectionPr
     title?: string;
 };
 
+/**
+ * Optional events configuration for a map module.
+ *
+ * @group User Interaction Events
+ */
+export declare type EventHandlerConfig = EventHandlerCursorConfig;
+
+/**
+ * Event configuration options related to how the cursor appears during interactions.
+ *
+ * @group User Interaction Events
+ */
+export declare type EventHandlerCursorConfig = {
+    /**
+     * Optional configuration to show custom cursor when hovering over interactive features.
+     *
+     * @remarks
+     * Accepts any valid CSS cursor value.
+     *
+     * @default 'pointer'
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
+     *
+     * @example
+     * ```typescript
+     * // Default pointer
+     * cursorOnHover: 'pointer'
+     *
+     * // Crosshair for precise selection
+     * cursorOnHover: 'crosshair'
+     *
+     * // Help cursor for info bubbles
+     * cursorOnHover: 'help'
+     *
+     * // Custom cursor image
+     * cursorOnHover: 'url(/cursors/custom.png), pointer'
+     * ```
+     */
+    cursorOnHover?: CSSCursor;
+};
+
 declare type EventHandlers = Record<string, SourceEventHandlers>;
 
 /**
@@ -2012,12 +2062,13 @@ declare type EventHandlers = Record<string, SourceEventHandlers>;
  * });
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare class EventsModule<T = MapGeoJSONFeature> {
     private readonly eventProxy;
     private readonly sourceWithLayers;
-    constructor(eventProxy: EventsProxy, sourceWithLayers: SourceWithLayers);
+    private readonly config;
+    constructor(eventProxy: EventsProxy, sourceWithLayers: SourceWithLayers, config: EventHandlerConfig | undefined);
     /**
      * Register an event handler for user interactions with map features.
      *
@@ -2183,7 +2234,6 @@ export declare class EventsProxy extends AbstractEventProxy {
     private lastClickedSourceWithLayers?;
     private lastCursorStyle;
     private readonly config;
-    private readonly defaultZoomLevel;
     constructor(map: Map_2, config?: MapEventsConfig);
     private listenToEvents;
     enable(enabled: boolean): void;
@@ -2198,7 +2248,7 @@ export declare class EventsProxy extends AbstractEventProxy {
     private onMouseDown;
     private onMouseUp;
     private onMouseMove;
-    private updateCursor;
+    private updateHoverCursor;
     private onMapClick;
 }
 
@@ -2215,7 +2265,7 @@ export declare class EventsProxy extends AbstractEventProxy {
  * const hoverEvent: EventType = 'long-hover';
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type EventType = ClickEventType | HoverEventType;
 
@@ -2376,7 +2426,7 @@ export declare const FINISH_INDEX = "finish";
  *
  * @group Traffic Flow
  */
-export declare type FlowConfig = {
+export declare type FlowConfig = MapModuleCommonConfig & {
     /**
      * Controls the visibility of the traffic flow layers.
      *
@@ -2440,10 +2490,10 @@ export declare class GeoJSONSourceWithLayers<T extends FeatureCollection = Featu
  * import { GeometriesModule } from '@tomtom-international/maps-sdk-js/map';
  *
  * // Initialize module
- * const geometries = await GeometriesModule.get(map);
+ * const geometriesModule = await GeometriesModule.get(map);
  *
  * // Display a polygon
- * await geometries.show({
+ * await geometriesModule.show({
  *   type: 'Feature',
  *   geometry: {
  *     type: 'Polygon',
@@ -2458,7 +2508,7 @@ export declare class GeoJSONSourceWithLayers<T extends FeatureCollection = Featu
  * @example
  * Custom styling:
  * ```typescript
- * const geometries = await GeometriesModule.get(map, {
+ * const geometriesModule = await GeometriesModule.get(map, {
  *   colorConfig: {
  *     fillColor: '#FF5733',
  *     fillOpacity: 0.3
@@ -2472,13 +2522,13 @@ export declare class GeoJSONSourceWithLayers<T extends FeatureCollection = Featu
  *   }
  * });
  *
- * await geometries.show(polygonFeatures);
+ * await geometriesModule.show(polygonFeatures);
  * ```
  *
  * @example
  * Multiple geometries with different colors:
  * ```typescript
- * await geometries.show({
+ * await geometriesModule.show({
  *   type: 'FeatureCollection',
  *   features: [
  *     {
@@ -2498,12 +2548,12 @@ export declare class GeoJSONSourceWithLayers<T extends FeatureCollection = Featu
  * @example
  * Event handling:
  * ```typescript
- * geometries.events.on('click', (feature, lngLat) => {
+ * geometriesModule.events.on('click', (feature, lngLat) => {
  *   console.log('Clicked geometry:', feature.properties.title);
  *   console.log('At coordinates:', lngLat);
  * });
  *
- * geometries.events.on('hover', (feature) => {
+ * geometriesModule.events.on('hover', (feature) => {
  *   showTooltip(feature.properties.title);
  * });
  * ```
@@ -2542,13 +2592,13 @@ export declare class GeometriesModule extends AbstractMapModule<GeometrySourcesW
      * @example
      * Default initialization:
      * ```typescript
-     * const geometries = await GeometriesModule.get(map);
+     * const geometriesModule = await GeometriesModule.get(map);
      * ```
      *
      * @example
      * With custom styling:
      * ```typescript
-     * const geometries = await GeometriesModule.get(map, {
+     * const geometriesModule = await GeometriesModule.get(map, {
      *   colorConfig: {
      *     fillColor: 'blue',
      *     fillOpacity: 0.25
@@ -2568,7 +2618,7 @@ export declare class GeometriesModule extends AbstractMapModule<GeometrySourcesW
      * @example
      * Data-driven styling:
      * ```typescript
-     * const geometries = await GeometriesModule.get(map, {
+     * const geometriesModule = await GeometriesModule.get(map, {
      *   colorConfig: {
      *     // Color based on feature properties
      *     fillColor: [
@@ -2838,7 +2888,7 @@ export declare class GeometriesModule extends AbstractMapModule<GeometrySourcesW
  *
  * @group Geometries
  */
-export declare type GeometriesModuleConfig = {
+export declare type GeometriesModuleConfig = MapModuleCommonConfig & {
     /**
      * Fill color and opacity configuration.
      *
@@ -3232,13 +3282,13 @@ export declare class HillshadeModule extends AbstractMapModule<HillshadeSourcesW
      * @example
      * Default initialization:
      * ```typescript
-     * const hillshade = await HillshadeModule.get(map);
+     * const hillshadeModule = await HillshadeModule.get(map);
      * ```
      *
      * @example
      * Auto-add to style if missing:
      * ```typescript
-     * const hillshade = await HillshadeModule.get(map, {
+     * const hillshadeModule = await HillshadeModule.get(map, {
      *   visible: true
      * });
      * ```
@@ -3246,7 +3296,7 @@ export declare class HillshadeModule extends AbstractMapModule<HillshadeSourcesW
      * @example
      * Start hidden:
      * ```typescript
-     * const hillshade = await HillshadeModule.get(map, {
+     * const hillshadeModule = await HillshadeModule.get(map, {
      *   visible: false
      * });
      * ```
@@ -3345,7 +3395,7 @@ export declare class HillshadeModule extends AbstractMapModule<HillshadeSourcesW
  *
  * @group Hillshade
  */
-export declare type HillshadeModuleConfig = {
+export declare type HillshadeModuleConfig = MapModuleCommonConfig & {
     /**
      * Controls the visibility of the hillshade layers.
      *
@@ -3377,7 +3427,7 @@ declare type HillshadeSourcesWithLayers = {
  * const sustainedHover: HoverEventType = 'long-hover';
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type HoverEventType = 'hover' | 'long-hover';
 
@@ -3456,7 +3506,7 @@ export declare type IncidentsCommonConfig = {
  *
  * @group Traffic Incidents
  */
-export declare type IncidentsConfig = IncidentsCommonConfig & {
+export declare type IncidentsConfig = MapModuleCommonConfig & IncidentsCommonConfig & {
     /**
      * Configuration specific to incident icon display.
      *
@@ -3543,9 +3593,57 @@ export declare const mapDisplayPoiCategoryMappings: Partial<Record<POICategory,
  * };
  * ```
  *
- * @group Map
+ * @group User Interaction Events
  */
-export declare type MapEventsConfig = {
+export declare type MapEventsConfig = EventHandlerCursorConfig & {
+    /**
+     * Optional configuration to show custom cursor when clicking (mouse down).
+     *
+     * @remarks
+     * Accepts any valid CSS cursor value. Provides visual feedback during the
+     * click action.
+     *
+     * @default 'grabbing'
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
+     *
+     * @example
+     * ```typescript
+     * // Grabbing hand
+     * cursorOnMouseDown: 'grabbing'
+     *
+     * // Move cursor
+     * cursorOnMouseDown: 'move'
+     *
+     * // Custom cursor
+     * cursorOnMouseDown: 'url(/cursors/drag.png), grabbing'
+     * ```
+     */
+    cursorOnMouseDown?: CSSCursor;
+    /**
+     * Optional configuration to show custom cursor on the map canvas when not interacting with any handled features.
+     *
+     * @remarks
+     * Accepts any valid CSS cursor value. This is the default cursor shown
+     * when not interacting with any features.
+     *
+     * @default 'default'
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
+     *
+     * @example
+     * ```typescript
+     * // Standard arrow
+     * cursorOnMap: 'default'
+     *
+     * // Open hand for draggable map
+     * cursorOnMap: 'grab'
+     *
+     * // Crosshair for measurement tools
+     * cursorOnMap: 'crosshair'
+     * ```
+     */
+    cursorOnMap?: CSSCursor;
     /**
      * Defines the event coordinates precision mode.
      *
@@ -3601,80 +3699,6 @@ export declare type MapEventsConfig = {
      * ```
      */
     paddingBoxPx?: number;
-    /**
-     * Optional configuration to show custom cursor when hovering over interactive features.
-     *
-     * @remarks
-     * Accepts any valid CSS cursor value.
-     *
-     * @default 'pointer'
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
-     *
-     * @example
-     * ```typescript
-     * // Default pointer
-     * cursorOnHover: 'pointer'
-     *
-     * // Crosshair for precise selection
-     * cursorOnHover: 'crosshair'
-     *
-     * // Help cursor for info bubbles
-     * cursorOnHover: 'help'
-     *
-     * // Custom cursor image
-     * cursorOnHover: 'url(/cursors/custom.png), pointer'
-     * ```
-     */
-    cursorOnHover?: string;
-    /**
-     * Optional configuration to show custom cursor when clicking (mouse down).
-     *
-     * @remarks
-     * Accepts any valid CSS cursor value. Provides visual feedback during the
-     * click action.
-     *
-     * @default 'grabbing'
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
-     *
-     * @example
-     * ```typescript
-     * // Grabbing hand
-     * cursorOnMouseDown: 'grabbing'
-     *
-     * // Move cursor
-     * cursorOnMouseDown: 'move'
-     *
-     * // Custom cursor
-     * cursorOnMouseDown: 'url(/cursors/drag.png), grabbing'
-     * ```
-     */
-    cursorOnMouseDown?: string;
-    /**
-     * Optional configuration to show custom cursor on the map canvas.
-     *
-     * @remarks
-     * Accepts any valid CSS cursor value. This is the default cursor shown
-     * when not interacting with any features.
-     *
-     * @default 'default'
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/cursor | MDN cursor documentation}
-     *
-     * @example
-     * ```typescript
-     * // Standard arrow
-     * cursorOnMap: 'default'
-     *
-     * // Open hand for draggable map
-     * cursorOnMap: 'grab'
-     *
-     * // Crosshair for measurement tools
-     * cursorOnMap: 'crosshair'
-     * ```
-     */
-    cursorOnMap?: string;
     /**
      * Delay to trigger a long-hover event when map has just moved (milliseconds).
      *
@@ -3803,9 +3827,20 @@ declare const mapFonts: readonly ["Noto-Regular", "NotoSans-MediumItalic", "Noto
  */
 export declare type MapLibreOptions = Omit<MapOptions, 'style' | 'attributionControl'>;
 
+/**
+ * Contains configuration options common to all map modules.
+ *
+ * @group Shared
+ */
+export declare type MapModuleCommonConfig = {
+    /**
+     * Optional configuration for user event handling that applies to this map module only.
+     */
+    events?: EventHandlerConfig;
+};
+
 /**
  * Whether a map module is based on a map style or on added GeoJSON data.
- * @ignore
  */
 declare type MapModuleSource = 'style' | 'geojson';
 
@@ -3866,22 +3901,22 @@ export declare type MapStyleLayerID = keyof typeof mapStyleLayerIDs;
  * **RoutingModule** - Positions route visualizations below labels for readability:
  * ```typescript
  * // Routes appear below labels but above the base map
- * const routing = await RoutingModule.get(map);
+ * const routingModule = await RoutingModule.get(map);
  * // Uses mapStyleLayerIDs.lowestLabel by default
  * ```
  *
  * **GeometriesModule** - Configurable layer positioning for polygon areas:
  * ```typescript
  * // Default: below labels
- * const geometries = await GeometriesModule.get(map);
+ * const geometriesModule = await GeometriesModule.get(map);
  *
  * // Custom: below buildings to show at ground level
- * const geometries = await GeometriesModule.get(map, {
+ * const geometriesModule = await GeometriesModule.get(map, {
  *   beforeLayerConfig: 'lowestBuilding'
  * });
  *
  * // On top of everything
- * const geometries = await GeometriesModule.get(map, {
+ * const geometriesModule = await GeometriesModule.get(map, {
  *   beforeLayerConfig: 'top'
  * });
  * ```
@@ -4306,7 +4341,7 @@ export declare type PlaceLayersConfig = {
  * @example
  * ```typescript
  * // Create places module with pin markers
- * const places = await PlacesModule.get(map, {
+ * const placesModule = await PlacesModule.get(map, {
  *   icon: {
  *     categoryIcons: []
  *   },
@@ -4317,14 +4352,14 @@ export declare type PlaceLayersConfig = {
  * });
  *
  * // Display places from search
- * await places.show(searchResults);
+ * await placesModule.show(searchResults);
  *
  * // Handle clicks
- * places.events.on('click', (feature) => {
+ * placesModule.events.on('click', (feature) => {
  *   console.log('Clicked:', feature.properties);
  * });
  *
- * places.events.on('hover', (feature) => {
+ * placesModule.events.on('hover', (feature) => {
  *   showTooltip(feature.properties.poi?.name);
  * });
  * ```
@@ -4383,13 +4418,13 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * ```typescript
      * // Switch to pin markers
-     * places.applyTheme('pin');
+     * placesModule.applyTheme('pin');
      *
      * // Use simple circles
-     * places.applyTheme('circle');
+     * placesModule.applyTheme('circle');
      *
      * // Match map's POI style (ideal to blend in)
-     * places.applyTheme('base-map');
+     * placesModule.applyTheme('base-map');
      * ```
      */
     applyTheme(theme: PlacesTheme): void;
@@ -4405,7 +4440,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      *
      * @example
      * ```typescript
-     * places.applyIconConfig({
+     * placesModule.applyIconConfig({
      *   categoryIcons: [
      *     { category: 'RESTAURANT', id: 'restaurant-icon', image: '/icons/food.png' }
      *   ]
@@ -4424,12 +4459,12 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * ```typescript
      * // Use function
-     * places.applyTextConfig({
+     * placesModule.applyTextConfig({
      *   field: (place) => place.properties.poi?.name || 'Unknown'
      * });
      *
      * // Use MapLibre expression
-     * places.applyTextConfig({
+     * placesModule.applyTextConfig({
      *   field: ['get', 'title'],
      *   size: 14,
      *   color: '#333'
@@ -4448,7 +4483,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      *
      * @example
      * ```typescript
-     * places.applyExtraFeatureProps({
+     * placesModule.applyExtraFeatureProps({
      *   category: (place) => place.properties.poi?.categories?.[0],
      *   rating: (place) => place.properties.poi?.rating || 0,
      *   isOpen: true
@@ -4484,14 +4519,14 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * ```typescript
      * import { search } from '@tomtom-international/maps-sdk-js/services';
      *
-     * const results = await search.search({ query: 'coffee' });
-     * await places.show(results.results);
+     * const results = await search({ query: 'coffee' });
+     * await placesModule.show(results);
      * ```
      *
      * @example
      * Display single place:
      * ```typescript
-     * await places.show({
+     * await placesModule.show({
      *   type: 'Feature',
      *   geometry: { type: 'Point', coordinates: [4.9041, 52.3676] },
      *   properties: {
@@ -4504,7 +4539,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * Display multiple places:
      * ```typescript
-     * await places.show([place1, place2, place3]);
+     * await placesModule.show([place1, place2, place3]);
      * ```
      */
     show(places: Place_2 | Place_2[] | Places): Promise<void>;
@@ -4518,7 +4553,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      *
      * @example
      * ```typescript
-     * await places.clear();
+     * await placesModule.clear();
      * ```
      */
     clear(): Promise<void>;
@@ -4533,7 +4568,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * ```typescript
      * // Make first place appear clicked
-     * places.putEventState({
+     * placesModule.putEventState({
      *   index: 0,
      *   state: 'click',
      *   mode: 'put'
@@ -4548,7 +4583,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      *
      * @example
      * ```typescript
-     * places.cleanEventState({ index: 0 });
+     * placesModule.cleanEventState({ index: 0 });
      * ```
      */
     cleanEventState(options: CleanEventStateOptions): void;
@@ -4560,10 +4595,10 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
      * @example
      * ```typescript
      * // Remove all event states
-     * places.cleanEventStates();
+     * placesModule.cleanEventStates();
      *
      * // Remove only hover states
-     * places.cleanEventStates({ states: ['hover'] });
+     * placesModule.cleanEventStates({ states: ['hover'] });
      * ```
      */
     cleanEventStates(options?: CleanEventStatesOptions): void;
@@ -4616,7 +4651,7 @@ export declare class PlacesModule extends AbstractMapModule<PlacesSourcesAndLaye
  *
  * @group Places
  */
-export declare type PlacesModuleConfig = {
+export declare type PlacesModuleConfig = MapModuleCommonConfig & {
     /**
      * Base style for all places.
      *
@@ -5031,24 +5066,24 @@ export declare const poiLayerIDs: string[];
  * import { POIsModule } from '@tomtom-international/maps-sdk-js/map';
  *
  * // Get module
- * const pois = await POIsModule.get(map);
+ * const poisModule = await POIsModule.get(map);
  *
  * // Toggle visibility
- * pois.setVisible(false);
- * pois.setVisible(true);
+ * poisModule.setVisible(false);
+ * poisModule.setVisible(true);
  * ```
  *
  * @example
  * Filter specific categories:
  * ```typescript
  * // Show only restaurants and hotels
- * pois.filterCategories({
+ * poisModule.filterCategories({
  *   show: 'only',
  *   values: ['RESTAURANT', 'HOTEL_MOTEL']
  * });
  *
  * // Hide parking garages
- * pois.filterCategories({
+ * poisModule.filterCategories({
  *   show: 'all_except',
  *   values: ['PARKING_GARAGE', 'OPEN_PARKING_AREA']
  * });
@@ -5058,7 +5093,7 @@ export declare const poiLayerIDs: string[];
  * Filter using category groups:
  * ```typescript
  * // Show only food and shopping POIs
- * pois.filterCategories({
+ * poisModule.filterCategories({
  *   show: 'only',
  *   values: ['FOOD_DRINKS_GROUP', 'SHOPPING_GROUP']
  * });
@@ -5104,13 +5139,13 @@ export declare class POIsModule extends AbstractMapModule<PoIsSourcesAndLayers,
      * @example
      * Default initialization:
      * ```typescript
-     * const pois = await POIsModule.get(map);
+     * const poisModule = await POIsModule.get(map);
      * ```
      *
      * @example
      * With initial filter:
      * ```typescript
-     * const pois = await POIsModule.get(map, {
+     * const poisModule = await POIsModule.get(map, {
      *   visible: true,
      *   filters: {
      *     categories: {
@@ -5298,7 +5333,7 @@ export declare class POIsModule extends AbstractMapModule<PoIsSourcesAndLayers,
  *
  * @group POIs
  */
-export declare type POIsModuleConfig = {
+export declare type POIsModuleConfig = MapModuleCommonConfig & {
     /**
      * Controls the visibility of the POI layers.
      *
@@ -5479,7 +5514,7 @@ export declare const preparePlacesForDisplay: (placesInput: Place | Place[] | Pl
  * };
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type PutEventStateOptions = ByIdOrIndex & {
     /**
@@ -6034,7 +6069,7 @@ export declare type RouteTheme = {
  * @example
  * ```typescript
  * // Create the module
- * const routing = await RoutingModule.getInstance(map, {
+ * const routingModule = await RoutingModule.getInstance(map, {
  *   displayUnits: {
  *     distance: { type: 'metric' }
  *   }
@@ -6053,7 +6088,7 @@ export declare type RouteTheme = {
  *   }
  * });
  *
- * await routing.showRoutes(result);
+ * await routingModule.showRoutes(result);
  * ```
  *
  * @see [Routing Guide](https://docs.tomtom.com/maps-sdk-js/guides/map/routing)
@@ -6088,13 +6123,13 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
      * @example
      * Default initialization:
      * ```typescript
-     * const routing = await RoutingModule.get(map);
+     * const routingModule = await RoutingModule.get(map);
      * ```
      *
      * @example
      * With custom configuration:
      * ```typescript
-     * const routing = await RoutingModule.get(map, {
+     * const routingModule = await RoutingModule.get(map, {
      *   displayUnits: 'imperial',
      *   waypointsSource: {
      *     entryPoints: 'main-when-available'
@@ -6116,7 +6151,7 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
     /**
      * @ignore
      */
-    protected restoreDataAndConfigImpl(): Promise<void>;
+    protected restoreDataAndConfigImpl(): void;
     private addImageIfNotExisting;
     /**
      * Displays the given routes on the map.
@@ -6203,13 +6238,13 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
      * @example
      * ```typescript
      * // Show multiple routes
-     * await routing.showRoutes(routes);
+     * await routingModule.showRoutes(routes);
      *
      * // User clicks alternative route
-     * await routing.selectRoute(1);
+     * await routingModule.selectRoute(1);
      *
      * // Switch back to first route
-     * await routing.selectRoute(0);
+     * await routingModule.selectRoute(0);
      * ```
      */
     selectRoute(index: number): Promise<void>;
@@ -6256,7 +6291,7 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
  *
  * @group Routing
  */
-export declare type RoutingModuleConfig = {
+export declare type RoutingModuleConfig = MapModuleCommonConfig & {
     /**
      * Units for displaying distances in route summaries and instructions.
      *
@@ -6393,6 +6428,7 @@ declare type SourceEventTypeHandler = {
     sourceWithLayers: SourceWithLayers;
     layerIDs: string[];
     fn: UserEventHandler<any>;
+    config?: EventHandlerConfig;
 };
 
 /**
@@ -6807,7 +6843,7 @@ export declare class StyleSourceWithLayers<SOURCE_SPEC extends SourceSpecificati
  * const normalProps: SupportsEvents = {};
  * ```
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type SupportsEvents = {
     /**
@@ -6967,7 +7003,7 @@ export declare type ToBeAddedLayerSpecWithoutSource<L extends LayerSpecification
  *       include: ['trafficFlow', 'trafficIncidents']
  *     },
  *     language: 'en-US',
- *     eventsConfig: {
+ *     events: {
  *       precisionMode: 'point-then-box',
  *       cursorOnHover: 'pointer'
  *     }
@@ -6995,7 +7031,7 @@ export declare class TomTomMap {
      * ```typescript
      * if (map.mapReady) {
      *   // Safe to initialize modules
-     *   const trafficModule = await TrafficFlowModule.get(map);
+     *   const trafficFlowModule = await TrafficFlowModule.get(map);
      * }
      * ```
      */
@@ -7103,7 +7139,7 @@ export declare class TomTomMap {
      *       include: ['trafficFlow', 'hillshade']
      *     },
      *     language: 'en-US',
-     *     eventsConfig: {
+     *     events: {
      *       precisionMode: 'point-then-box',
      *       paddingBoxPx: 10
      *     }
@@ -7118,7 +7154,7 @@ export declare class TomTomMap {
      * @see {@link https://maplibre.org/maplibre-gl-js-docs/api/map/ | MapLibre Map Parameters}
      * @see [Map Quickstart Guide](https://docs.tomtom.com/maps-sdk-js/guides/map/quickstart)
      * @see [Map Styles Guide](https://docs.tomtom.com/maps-sdk-js/guides/map/map-styles)
-     * @see [User Events Guide](https://docs.tomtom.com/maps-sdk-js/guides/map/user-events)
+     * @see [User Interaction Events Guide](https://docs.tomtom.com/maps-sdk-js/guides/map/user-events)
      */
     constructor(mapLibreOptions: MapLibreOptions, mapParams?: Partial<TomTomMapParams>);
     private loadRTLTextPlugin;
@@ -7468,7 +7504,7 @@ export declare class TomTomMap {
  *   center: [4.9041, 52.3676],
  *   zoom: 12,
  *   style: 'standardLight',
- *   eventsConfig: {
+ *   events: {
  *     onClick: (event) => console.log('Map clicked', event)
  *   }
  * };
@@ -7505,7 +7541,7 @@ export declare type TomTomMapParams = GlobalConfig & {
      *
      * @example
      * ```typescript
-     * eventsConfig: {
+     * events: {
      *   onClick: (event) => {
      *     console.log('Clicked at', event.lngLat);
      *   },
@@ -7515,7 +7551,7 @@ export declare type TomTomMapParams = GlobalConfig & {
      * }
      * ```
      */
-    eventsConfig?: MapEventsConfig;
+    events?: MapEventsConfig;
 };
 
 /**
@@ -7754,13 +7790,13 @@ export declare class TrafficFlowModule extends AbstractMapModule<TrafficFlowSour
      * @example
      * Default initialization:
      * ```typescript
-     * const trafficFlow = await TrafficFlowModule.get(map);
+     * const trafficFlowModule = await TrafficFlowModule.get(map);
      * ```
      *
      * @example
      * Auto-add to style:
      * ```typescript
-     * const trafficFlow = await TrafficFlowModule.get(map, {
+     * const trafficFlowModule = await TrafficFlowModule.get(map, {
      *   visible: true,
      *   filters: {
      *     any: [{
@@ -8003,23 +8039,23 @@ export declare type TrafficIncidentsFilters = {
  * import { TrafficIncidentsModule } from '@tomtom-international/maps-sdk-js/map';
  *
  * // Get module (auto-add to style if needed)
- * const incidents = await TrafficIncidentsModule.get(map, {
+ * const trafficIncidentsModule = await TrafficIncidentsModule.get(map, {
  *   visible: true
  * });
  *
  * // Toggle visibility
- * incidents.setVisible(false);
- * incidents.setVisible(true);
+ * trafficIncidentsModule.setVisible(false);
+ * trafficIncidentsModule.setVisible(true);
  *
  * // Control icons separately
- * incidents.setIconsVisible(false);
+ * trafficIncidentsModule.setIconsVisible(false);
  * ```
  *
  * @example
  * Filter by incident type:
  * ```typescript
  * // Show only accidents and road closures
- * incidents.filter({
+ * trafficIncidentsModule.filter({
  *   any: [{
  *     incidentCategories: {
  *       show: 'only',
@@ -8029,7 +8065,7 @@ export declare type TrafficIncidentsFilters = {
  * });
  *
  * // Hide construction
- * incidents.filter({
+ * trafficIncidentsModule.filter({
  *   any: [{
  *     incidentCategories: {
  *       show: 'all_except',
@@ -8107,13 +8143,13 @@ export declare class TrafficIncidentsModule extends AbstractMapModule<TrafficInc
      * @example
      * Default initialization:
      * ```typescript
-     * const incidents = await TrafficIncidentsModule.get(map);
+     * const trafficIncidentsModule = await TrafficIncidentsModule.get(map);
      * ```
      *
      * @example
      * With configuration:
      * ```typescript
-     * const incidents = await TrafficIncidentsModule.get(map, {
+     * const trafficIncidentsModule = await TrafficIncidentsModule.get(map, {
      *   visible: true,
      *   icons: { visible: true },
      *   filters: {
@@ -8352,7 +8388,7 @@ export declare const UNKNOWN_DELAY_COLOR = "#000000";
  *
  * @see {@link EventsModule.on} - For registering event handlers
  *
- * @group User Events
+ * @group User Interaction Events
  */
 export declare type UserEventHandler<T> = (topFeature: T, lngLat: LngLat, allEventFeatures: MapGeoJSONFeature[], sourceWithLayers: SourceWithLayers) => void;