@tomtom-org/maps-sdk 0.35.4 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1963,7 +1963,7 @@ export declare const formatDuration: (seconds: number | undefined, options?: Tim
1963
1963
  export declare type Fuel = 'Petrol' | 'LPG' | 'Diesel' | 'Biodiesel' | 'DieselForCommercialVehicles' | 'E85' | 'LNG' | 'CNG' | 'Hydrogen' | 'AdBlue';
1964
1964
 
1965
1965
  /**
1966
- * Generate random id for layers
1966
+ * Generate random id for map features
1967
1967
  * @ignore
1968
1968
  */
1969
1969
  export declare const generateId: () => string;
@@ -3729,7 +3729,14 @@ export declare type RoadShieldSectionProps = SectionProps & {
3729
3729
  *
3730
3730
  * @group Route
3731
3731
  */
3732
- export declare type Route<P extends RouteProps = RouteProps> = Feature<LineString, P>;
3732
+ export declare type Route<P extends RouteProps = RouteProps> = Omit<Feature<LineString, P>, 'id'> & {
3733
+ /**
3734
+ * Unique identifier for this route.
3735
+ *
3736
+ * Randomly generated to distinguish between multiple route alternatives.
3737
+ */
3738
+ id: string;
3739
+ };
3733
3740
 
3734
3741
  /**
3735
3742
  * Route path point and its metadata.
@@ -3839,12 +3846,6 @@ export declare type RouteProgressPoint = {
3839
3846
  * @group Route
3840
3847
  */
3841
3848
  export declare type RouteProps = {
3842
- /**
3843
- * Unique identifier for this route.
3844
- *
3845
- * Randomly generated to distinguish between multiple route alternatives.
3846
- */
3847
- id: string;
3848
3849
  /**
3849
3850
  * Summary statistics for the entire route.
3850
3851
  *
@@ -3910,7 +3911,12 @@ export declare type RouteProps = {
3910
3911
  *
3911
3912
  * @group Route
3912
3913
  */
3913
- export declare type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>;
3914
+ export declare type Routes<P extends RouteProps = RouteProps, FeatureCollectionProps = unknown> = Omit<FeatureCollectionWithProperties<LineString, P, FeatureCollectionProps>, 'features'> & {
3915
+ /**
3916
+ * Array of route features.
3917
+ */
3918
+ features: Route<P>[];
3919
+ };
3914
3920
 
3915
3921
  /**
3916
3922
  * Complete summary information for an entire route.
@@ -63,7 +63,7 @@ terms above.
63
63
  ---
64
64
 
65
65
  Name: @tomtom-org/maps-sdk
66
- Version: 0.35.4
66
+ Version: 0.36.0
67
67
  License: See in LICENSE.txt
68
68
  Private: false
69
69
  Description: TomTom Maps for JavaScript
@@ -346,7 +346,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
346
346
  ---
347
347
 
348
348
  Name: maplibre-gl
349
- Version: 5.12.0
349
+ Version: 5.14.0
350
350
  License: BSD-3-Clause
351
351
  Private: false
352
352
  Description: BSD licensed community fork of mapbox-gl, a WebGL interactive maps library
@@ -956,9 +956,11 @@ export declare const buildPlaceTitle: (place: Place) => string;
956
956
  /**
957
957
  * Generates the routing layers configuration for route visualization on the map.
958
958
  * @param config - Optional routing module configuration to customize layer properties.
959
+ * @param layerIDPrefix - Optional prefix to add to layer IDs for supporting multiple instances.
960
+ * @param instanceIndex - Optional instance index for image ID suffixes.
959
961
  * @ignore
960
962
  */
961
- export declare const buildRoutingLayers: (config?: RoutingModuleConfig) => Required<RouteLayersConfig>;
963
+ export declare const buildRoutingLayers: (config?: RoutingModuleConfig, layerIDPrefix?: string, instanceIndex?: number) => Required<RouteLayersConfig>;
962
964
 
963
965
  /**
964
966
  * Parameters to identify a feature by its ID or index in a given features array.
@@ -1651,6 +1653,13 @@ export declare type DisplayRouteProps = RouteProps & RouteStateProps & SupportsE
1651
1653
  * @group Routing
1652
1654
  */
1653
1655
  export declare type DisplayRouteRelatedProps = RouteStateProps & {
1656
+ /**
1657
+ * Unique identifier for the object to ensure it can be displayed on MapLibre.
1658
+ *
1659
+ * @remarks
1660
+ * This id es expected to become the main feature id by MapLibre via the 'promotedId' property.
1661
+ */
1662
+ id: string;
1654
1663
  /**
1655
1664
  * Zero-based index of this route in the routes array.
1656
1665
  *
@@ -3372,11 +3381,6 @@ declare type HillshadeSourcesWithLayers = {
3372
3381
  */
3373
3382
  export declare type HoverEventType = 'hover' | 'long-hover';
3374
3383
 
3375
- /**
3376
- * @ignore
3377
- */
3378
- export declare const imageIDWithInstanceSuffix: (baseID: string, instanceIndex: number) => string;
3379
-
3380
3384
  /**
3381
3385
  * Available traffic incident category identifiers.
3382
3386
  *
@@ -4052,10 +4056,8 @@ export declare type PlaceDisplayProps = {
4052
4056
  * Unique identifier for the place feature.
4053
4057
  *
4054
4058
  * @remarks
4055
- * Typically SDK features have IDs at the GeoJSON Feature root level, as per specification.
4056
- * However, MapLibre does not reuse the given feature ID. Either we generate it on the fly
4059
+ * MapLibre does not reuse the feature IDs. Either we generate it on the fly
4057
4060
  * or use the one from properties via promotedId value.
4058
- * We must generate "id" property based on the feature id on the fly in "prepareForDisplay" functions.
4059
4061
  *
4060
4062
  * Used for:
4061
4063
  * - Feature identification in events
@@ -4066,10 +4068,9 @@ export declare type PlaceDisplayProps = {
4066
4068
  * ```typescript
4067
4069
  * id: 'place-123'
4068
4070
  * id: 'poi-456'
4069
- * id: 1234 // Numeric IDs also supported
4070
4071
  * ```
4071
4072
  */
4072
- id: string | number;
4073
+ id: string;
4073
4074
  /**
4074
4075
  * Display title for the place on the map.
4075
4076
  *
@@ -4249,17 +4250,6 @@ export declare type PlaceLayersConfig = {
4249
4250
  selected?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>;
4250
4251
  } & HasAdditionalLayersConfig;
4251
4252
 
4252
- /**
4253
- * Source identifier prefix for places (geocoding results) features.
4254
- *
4255
- * @remarks
4256
- * Combined with a unique identifier to create source IDs for place markers
4257
- * displayed via the Places module.
4258
- *
4259
- * @group Places
4260
- */
4261
- export declare const PLACES_SOURCE_PREFIX_ID = "places";
4262
-
4263
4253
  /**
4264
4254
  * Map module for displaying and managing place markers.
4265
4255
  *
@@ -6046,7 +6036,15 @@ export declare type RouteTheme = {
6046
6036
  * @group Routing
6047
6037
  */
6048
6038
  export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithLayers, RoutingModuleConfig> {
6039
+ private static lastInstanceIndex;
6049
6040
  private layersSpecs;
6041
+ private layerIDPrefix;
6042
+ /**
6043
+ * The index of this instance, to generate unique source and layer IDs.
6044
+ * * Starts with 0 and each instance increments it by one.
6045
+ * @private
6046
+ */
6047
+ private instanceIndex;
6050
6048
  /**
6051
6049
  * Make sure the map is ready before create an instance of the module and any other interaction with the map
6052
6050
  * @param tomtomMap The TomTomMap instance.
@@ -6085,7 +6083,7 @@ export declare class RoutingModule extends AbstractMapModule<RoutingSourcesWithL
6085
6083
  /**
6086
6084
  * @ignore
6087
6085
  */
6088
- protected _initSourcesWithLayers(config?: RoutingModuleConfig): RoutingSourcesWithLayers;
6086
+ protected _initSourcesWithLayers(config?: RoutingModuleConfig, restore?: boolean): RoutingSourcesWithLayers;
6089
6087
  /**
6090
6088
  * @ignore
6091
6089
  */