@tomtom-org/maps-sdk 0.40.1 → 0.41.0

package/map/package.json

@@ -42,7 +42,7 @@
     "maplibre-gl": "catalog:"
   },
   "dependencies": {
-    "@turf/bearing": "^7.3.1",
+    "@turf/bearing": "^7.3.2",
     "core": "workspace:*",
     "lodash-es": "catalog:"
   }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tomtom-org/maps-sdk",
   "author": "TomTom International B.V.",
   "license": "See in LICENSE.txt",
-  "version": "0.40.1",
+  "version": "0.41.0",
   "description": "TomTom Maps for JavaScript",
   "keywords": [
     "tomtom",
@@ -22,7 +22,7 @@
     "@size-limit/file": "^11.2.0",
     "@size-limit/preset-app": "^11.2.0",
     "size-limit": "^11.2.0",
-    "typedoc": "^0.28.15",
+    "typedoc": "^0.28.16",
     "yaml": "^2.8.2"
   },
   "size-limit": [

package/services/dist/index.d.ts

@@ -2,6 +2,8 @@ import { $ZodError } from 'zod/v4/core';
 import { $ZodIssue } from 'zod/v4/core';
 import { AddressProperties } from '@tomtom-org/maps-sdk/core';
 import { Avoidable } from '@tomtom-org/maps-sdk/core';
+import { ChargingPark } from '@tomtom-org/maps-sdk/core';
+import { ChargingParkWithAvailability } from '@tomtom-org/maps-sdk/core';
 import { ChargingStation } from '@tomtom-org/maps-sdk/core';
 import { ChargingStationsAccessType } from '@tomtom-org/maps-sdk/core';
 import { ChargingStationsAvailability } from '@tomtom-org/maps-sdk/core';
@@ -12,7 +14,7 @@ import { Connector } from '@tomtom-org/maps-sdk/core';
 import { ConnectorType } from '@tomtom-org/maps-sdk/core';
 import { CurrentType } from '@tomtom-org/maps-sdk/core';
 import { EntryPoint } from '@tomtom-org/maps-sdk/core';
-import { EVChargingStationPlaceProps } from '@tomtom-org/maps-sdk/core';
+import { EVChargingStationWithAvailabilityPlaceProps } from '@tomtom-org/maps-sdk/core';
 import { Fuel } from '@tomtom-org/maps-sdk/core';
 import { GeographyType } from '@tomtom-org/maps-sdk/core';
 import { GeoJsonObject } from 'geojson';
@@ -791,80 +793,6 @@ declare const buildGeometrySearchRequest: (params: GeometrySearchParams) => Post
  */
 declare const buildPlaceByIdRequest: (params: PlaceByIdParams) => URL;
 
-/**
- * Enhance multiple places with real-time EV charging availability data.
- *
- * Fetches availability information for all EV charging stations in a collection
- * and merges it into their properties. Non-EV places are returned unchanged.
- *
- * @remarks
- * **Important**: Availability requests are made sequentially to avoid exceeding
- * API rate limits (QPS - Queries Per Second). For large result sets, this may
- * take some time.
- *
- * @param places - Collection of places to enhance
- * @param options - Configuration options
- *
- * @returns Promise resolving to places collection with merged availability
- *
- * @example
- * ```typescript
- * // Search for charging stations and add availability
- * const results = await search({
- *   query: 'EV charging',
- *   at: [4.9, 52.3],
- *   radius: 5000
- * });
- *
- * const withAvailability = await buildPlacesWithEVAvailability(results, {
- *   includeIfAvailabilityUnknown: false  // Filter out stations with unknown availability
- * });
- *
- * // Display only stations with known availability
- * withAvailability.features.forEach(place => {
- *   const available = place.properties.chargingPark?.availability?.chargingPointAvailability.count;
- *   console.log(`${place.properties.poi?.name}: ${available} chargers`);
- * });
- * ```
- *
- * @group EV Charging
- */
-export declare const buildPlacesWithEVAvailability: (places: Places_2, options?: {
-    /**
-     * If true, places with unknown availability will be still included. Otherwise, they will be filtered out.
-     * @default true
-     */
-    includeIfAvailabilityUnknown: boolean;
-}) => Promise<Places_2<EVChargingStationPlaceProps>>;
-
-/**
- * Enhance a place with real-time EV charging availability data.
- *
- * Fetches availability information for an EV charging station and merges it into
- * the place properties. Non-EV places are returned unchanged.
- *
- * @param place - The place to enhance with availability data
- *
- * @returns Promise resolving to the place with merged availability information
- *
- * @example
- * ```typescript
- * // After search, enhance place with availability
- * const searchResult = await search({ query: 'EV charging', ... });
- * const place = searchResult.features[0];
- *
- * const enhancedPlace = await buildPlaceWithEVAvailability(place);
- * const availability = enhancedPlace.properties.chargingPark?.availability;
- *
- * if (availability) {
- *   console.log('Available chargers:', availability.chargingPointAvailability.count);
- * }
- * ```
- *
- * @group EV Charging
- */
-export declare const buildPlaceWithEVAvailability: (place: Place) => Promise<Place<EVChargingStationPlaceProps>>;
-
 /**
  *
  * @param params
@@ -4631,6 +4559,77 @@ export declare type GeometrySearchResultAPI = CommonSearchPlaceResultAPI;
  */
 declare type GeometrySearchTemplate = ServiceTemplate<GeometrySearchParams, GeometrySearchRequestAPI, GeometrySearchResponseAPI, GeometrySearchResponse>;
 
+/**
+ * Enhance multiple places with real-time EV charging availability data.
+ *
+ * Fetches availability information for all EV charging stations in a collection
+ * and merges it into their properties. Non-EV places and EV stations without availability data are returned unchanged.
+ *
+ * @remarks
+ * **Important**: Availability requests are made sequentially to avoid exceeding
+ * API rate limits (QPS - Queries Per Second). For large result sets, this may
+ * take some time.
+ *
+ * @param places - Collection of places to enhance
+ * @param options - Configuration options
+ *
+ * @returns Promise resolving to places collection with merged availability
+ *
+ * @example
+ * ```typescript
+ * // Search for charging stations and add availability
+ * const results = await search({
+ *   query: 'EV charging',
+ *   at: [4.9, 52.3],
+ *   radius: 5000
+ * });
+ *
+ * const withAvailability = await getPlacesWithEVAvailability(results, {
+ *   excludeIfAvailabilityUnknown: true  // Filter out stations with unknown availability
+ * });
+ *
+ * // Display only stations with known availability
+ * withAvailability.features.forEach(place => {
+ *   const available = place.properties.chargingPark?.availability?.chargingPointAvailability.count;
+ *   console.log(`${place.properties.poi?.name}: ${available} chargers`);
+ * });
+ * ```
+ *
+ * @group EV Charging
+ */
+export declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = CommonPlaceProps>(places: Places_2<P>, options?: {
+    excludeIfAvailabilityUnknown: true;
+}): Promise<Places_2<EVChargingStationWithAvailabilityPlaceProps>>;
+
+/**
+ * Enhance a place with real-time EV charging availability data.
+ *
+ * Fetches availability information for an EV charging station and merges it into
+ * the place properties.
+ *
+ * @param place - The place to enhance with availability data
+ *
+ * @returns Promise resolving to the place with merged availability information
+ * @returns undefined if no availability data is present for the `place` input parameter.
+ *
+ * @example
+ * ```typescript
+ * // After search, enhance place with availability
+ * const searchResult = await search({ query: 'EV charging', ... });
+ * const place = searchResult.features[0];
+ *
+ * const enhancedPlace = await getPlaceWithEVAvailability(place);
+ * const availability = enhancedPlace.properties.chargingPark?.availability;
+ *
+ * if (availability) {
+ *   console.log('Available chargers:', availability.chargingPointAvailability.count);
+ * }
+ * ```
+ *
+ * @group EV Charging
+ */
+export declare const getPlaceWithEVAvailability: <P extends CommonPlaceProps = CommonPlaceProps>(place: Place<P>) => Promise<Place<EVChargingStationWithAvailabilityPlaceProps> | undefined>;
+
 /**
  * @ignore
  */
@@ -4688,6 +4687,16 @@ export declare type GuidanceParams = {
     roadShieldReferences?: 'all';
 };
 
+/**
+ * Type guard to check if a ChargingPark has availability data.
+ *
+ * @param chargingPark - The charging park to check
+ * @returns True if the charging park has availability data
+ *
+ * @group EV Charging
+ */
+export declare const hasChargingAvailability: (chargingPark: ChargingPark | ChargingParkWithAvailability | undefined) => chargingPark is ChargingParkWithAvailability;
+
 /**
  * Route section type that can be requested in routing parameters.
  *