@tomtom-org/maps-sdk 0.46.9 → 0.46.11

package/core/dist/index.d.ts

@@ -201,7 +201,7 @@ export declare type AreaAnalyticsCollectionProperties = {
     /**
      * Traffic metrics included in the report.
      */
-    dataTypes: AreaAnalyticsDataType[];
+    metrics: AreaAnalyticsMetricKey[];
     /**
      * Whether tile-level heatmap data is included.
      */
@@ -210,15 +210,13 @@ export declare type AreaAnalyticsCollectionProperties = {
      * Functional road classes included in the analysis (0–8).
      */
     frcs: number[];
+    /**
+     * Data-driven min/max value ranges computed from all tile entries.
+     * Only metrics present in the tile data will have a range entry.
+     */
+    ranges: Partial<Record<AreaAnalyticsMetricKey, AreaAnalyticsMetricRange>>;
 };
 
-/**
- * Available traffic analytical metrics for area analytics reports.
- *
- * @group Traffic
- */
-export declare type AreaAnalyticsDataType = 'NETWORK_LENGTH' | 'CONGESTION_LEVEL' | 'FREE_FLOW_SPEED' | 'TRAVEL_TIME' | 'SPEED';
-
 /**
  * A single region feature in the area analytics result.
  *
@@ -229,6 +227,10 @@ export declare type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFe
      * Unique identifier for this feature.
      */
     id: string;
+    /**
+     * Bounding box for this area analytics feature.
+     */
+    bbox: BBox;
 };
 
 /**
@@ -264,16 +266,40 @@ export declare type AreaAnalyticsFeatureProperties = {
         tiles: AreaAnalyticsTileEntry[];
     };
     /**
-     * Detected anomalies keyed by data type, if anomaly detection was performed.
+     * Detected anomalies keyed by metric, if anomaly detection was performed.
      */
-    anomalies?: Partial<Record<AreaAnalyticsDataType, AreaAnalyticsAnomaly[]>>;
+    anomalies?: Partial<Record<AreaAnalyticsMetricKey, AreaAnalyticsAnomaly[]>>;
+};
+
+/**
+ * Identifies a single traffic metric — a key of {@link AreaAnalyticsMetrics}.
+ *
+ * @group Traffic
+ */
+export declare type AreaAnalyticsMetricKey = (typeof areaAnalyticsMetricKeys)[number];
+
+/**
+ * All traffic metric identifiers, ordered consistently across the SDK.
+ *
+ * @group Traffic
+ */
+export declare const areaAnalyticsMetricKeys: readonly ["speed", "freeFlowSpeed", "congestionLevel", "travelTime", "networkLength"];
+
+/**
+ * Min/max value range for a single traffic metric across all tiles.
+ *
+ * @group Traffic
+ */
+export declare type AreaAnalyticsMetricRange = {
+    min: number;
+    max: number;
 };
 
 /**
  * Traffic metric values for an area or time period.
  *
  * @remarks
- * All fields are optional — only metrics included in the requested `dataTypes` will be present.
+ * All fields are optional — only metrics included in the requested `metrics` will be present.
  *
  * @group Traffic
  */
@@ -305,6 +331,11 @@ export declare type AreaAnalyticsMetrics = {
 /**
  * Traffic metrics for a single geographic tile within the analysis region.
  *
+ * @remarks
+ * All fields are optional — only metrics included in the requested `metrics` will be present.
+ * `networkLength` here represents the total length of road segments **within that tile** (meters),
+ * not the region aggregate.
+ *
  * @group Traffic
  */
 export declare type AreaAnalyticsTileEntry = AreaAnalyticsMetrics & {
@@ -4925,7 +4956,7 @@ export declare const toPointGeometry: (coordinates: Position) => Point;
  *   endDate: new Date('2024-08-06'),
  *   frcs: [0, 1, 2, 3],
  *   hours: [7, 8, 9],
- *   dataTypes: ['SPEED', 'CONGESTION_LEVEL'],
+ *   metrics: ['speed', 'congestionLevel'],
  *   feature: {
  *     type: 'Feature',
  *     geometry: {
@@ -4938,6 +4969,7 @@ export declare const toPointGeometry: (coordinates: Position) => Point;
  *
  * console.log(result.properties.startDate); // Date object: 2024-08-06T00:00:00.000Z
  * result.features[0].properties.baseData.speed; // avg speed in km/h
+ * result.properties.ranges.congestionLevel; // { min: 3, max: 42 } — data-driven range across all tiles
  * ```
  *
  * @group Traffic