@tomtom-org/maps-sdk 0.63.0 → 0.64.0

package/core/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BBox as BBox$1, POICategory as POICategory$1 } from "@tomtom-org/maps-sdk/core";
+import { BBox as BBox$1 } from "@tomtom-org/maps-sdk/core";
 //#region src/types/generic.d.ts
 /**
  * Generic object type with string keys and unknown values.
@@ -479,18 +479,6 @@ type GetPositionOptions = {
 };
 //#endregion
 //#region src/types/headers.d.ts
-/**
- * Interface for TomTom custom headers
- * Those headers are added in every request to TomTom services
- * * tomtom-user-agent - Name and version of this SDK
- * * Authorization - Bearer token for experimental OAuth2 support.
- * Based on the apiAccessToken parameter.
- * @ignore
- */
-type TomTomHeaders = {
-  'tomtom-user-agent'?: string;
-  Authorization?: string;
-};
 /**
  * Service-specific TomTom API headers, declared per-request by a service's
  * request builder (not added globally). Widen this type when a new service
@@ -4477,6 +4465,34 @@ export declare const inputSectionTypesWithGuidance: SectionType[];
  */
 export declare const sectionTypes: SectionType[];
 //#endregion
+//#region src/types/sdkErrorCode.d.ts
+/**
+ * Every value an SDK error's `code` takes: services' `SDKError` and the map's `TomTomMapError` share them.
+ * @group Errors
+ */
+export declare const sdkErrorCodes: readonly ["INVALID_REQUEST", "INSECURE_BASE_URL", "API_KEY_REJECTED", "NOT_FOUND", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "NETWORK_ERROR", "ABORTED", "WEBGL_UNSUPPORTED", "WEBGL_CONTEXT_LOST", "STYLE_LOAD_FAILED", "UNEXPECTED"];
+/**
+ * What went wrong, as an SDK error names it in its `code`.
+ *
+ * | Code | When |
+ * | --- | --- |
+ * | `INVALID_REQUEST` | The SDK's request validation failed, or the API answered `400` or another `4xx` not below |
+ * | `INSECURE_BASE_URL` | `commonBaseURL` is not `https:`, and not a loopback address either |
+ * | `API_KEY_REJECTED` | The API answered `401` or `403`: the key is missing, invalid, expired, or not enabled for that API |
+ * | `NOT_FOUND` | The API answered `404` |
+ * | `RATE_LIMITED` | The API answered `429`, still after the retries `retry` allows |
+ * | `SERVICE_UNAVAILABLE` | The API answered a `5xx` |
+ * | `NETWORK_ERROR` | No response arrived: offline, DNS, TLS or CORS failure |
+ * | `ABORTED` | The call's `signal` was aborted |
+ * | `WEBGL_UNSUPPORTED` | The browser cannot create the WebGL2 context the map draws with |
+ * | `WEBGL_CONTEXT_LOST` | The browser took the map's WebGL context away, for example after a GPU reset |
+ * | `STYLE_LOAD_FAILED` | The map style failed to load, and not because of an HTTP status above |
+ * | `UNEXPECTED` | Anything else |
+ *
+ * @group Errors
+ */
+export type SDKErrorCode = (typeof sdkErrorCodes)[number];
+//#endregion
 //#region src/types/traffic/areaAnalytics.d.ts
 /**
  * Min/max value range for a single traffic metric across all tiles.
@@ -4741,7 +4757,7 @@ export type AreaAnalyticsFeature = Omit<Feature<Polygon, AreaAnalyticsFeaturePro
 /**
  * Metadata for the area analytics result collection.
  *
- * @group Traffic Analytics
+ * @group Traffic
  */
 export type AreaAnalyticsCollectionProperties = {
   /**
@@ -4780,17 +4796,13 @@ export type AreaAnalyticsCollectionProperties = {
  * ```typescript
  * const result = await trafficAreaAnalytics({
  *   startDate: new Date('2024-08-06'),
- *   endDate: new Date('2024-08-06'),
- *   frcs: [0, 1, 2, 3],
+ *   endDate: new Date('2024-08-07'),
+ *   functionalRoadClasses: ['MOTORWAY', 'MAJOR_ROAD', 'OTHER_MAJOR_ROAD', 'SECONDARY_ROAD'],
  *   hours: [7, 8, 9],
  *   metrics: ['speed', 'congestionLevel'],
- *   feature: {
- *     type: 'Feature',
- *     geometry: {
- *       type: 'Polygon',
- *       coordinates: [[[4.89, 52.37], [4.91, 52.37], [4.91, 52.39], [4.89, 52.39], [4.89, 52.37]]]
- *     },
- *     properties: {}
+ *   geometry: {
+ *     type: 'Polygon',
+ *     coordinates: [[[4.89, 52.37], [4.91, 52.37], [4.91, 52.39], [4.89, 52.39], [4.89, 52.37]]]
  *   }
  * });
  *
@@ -4815,45 +4827,17 @@ export type TrafficAreaAnalytics = {
 //#endregion
 //#region src/util/bbox.d.ts
 /**
- * Calculates whether the given bbox has area (width and height).
- * @ignore
- * @param bbox The BBox to verify. If undefined, false is returned.
+ * Whether the bounding box has both a width and a height: `false` for a single point, a line, or `undefined`.
  */
 export declare const isBBoxWithArea: (bbox: OptionalBBox) => boolean;
 /**
- * Returns the given bbox if it has area, or undefined otherwise.
- * @ignore
- * @param bbox The BBox to verify. If undefined, undefined is returned.
- */
-export declare const bboxOnlyIfWithArea: (bbox: OptionalBBox) => OptionalBBox;
-/**
- * Expands the given bounding box with the given position.
- * * If the given bounding box is undefined, the given position is considered alone.
- * This results in a zero-sized bounding box.
- * @ignore
- * @param positionToContain
- * @param bboxToExpand
- */
-export declare const bboxExpandedWithPosition: (positionToContain: Position, bboxToExpand?: BBox) => OptionalBBox;
-/**
- * @ignore
- * @param bboxToContain
- * @param bboxToExpand
- */
-export declare const bboxExpandedWithBBox: (bboxToContain: OptionalBBox, bboxToExpand?: BBox) => OptionalBBox;
-/**
- * Calculates the bounding box which contains all the given bounding boxes.
- * @ignore
- * @param bboxes
+ * The bounding box that contains all the given ones, skipping `undefined` entries.
  */
 export declare const bboxFromBBoxes: (bboxes: OptionalBBox[]) => OptionalBBox;
 /**
- * Calculates a bounding box from an array of coordinates.
- * * If the array is beyond a certain size, it doesn't scan it fully,
- * for performance, but still ensures a decent accuracy.
+ * The bounding box of an array of `[longitude, latitude]` positions, `undefined` for none.
  *
- * @ignore
- * @param coordinates Should always be passed, but undefined is also supported, resulting in undefined bbox.
+ * A very long array is sampled rather than scanned in full, which keeps the box close to exact.
  */
 export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined) => OptionalBBox;
 /**
@@ -4876,7 +4860,7 @@ export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined)
  * @example
  * ```typescript
  * // From a Feature with existing bbox
- * const place = await geocode({ key: 'key', query: 'Amsterdam' });
+ * const place = await geocodeOne('Amsterdam');
  * const bbox = bboxFromGeoJSON(place);
  * // Returns the bbox that came with the place
  *
@@ -4895,13 +4879,12 @@ export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined)
  * // Returns: [4.88, 52.36, 4.90, 52.38]
  *
  * // From a FeatureCollection (aggregates all features)
- * const places = await discoverPlaces({ key: 'key', query: 'coffee' });
+ * const places = await discoverPlaces({ query: 'coffee' });
  * const collectionBbox = bboxFromGeoJSON(places);
  * // Returns bbox encompassing all search results
  *
  * // From a LineString (calculates from coordinates)
  * const route = await calculateRoute({
- *   key: 'key',
  *   locations: [[4.9, 52.3], [4.5, 51.9]]
  * });
  * const routeBbox = bboxFromGeoJSON(route.features[0].geometry);
@@ -4916,24 +4899,14 @@ export declare const bboxFromCoordsArray: (coordinates: Position[] | undefined)
  */
 export declare const bboxFromGeoJSON: (hasBBox: HasBBox) => OptionalBBox;
 /**
- * Expands the given bounding box with the given GeoJSON.
- * * If the feature has also a bounding box, the latter is considered instead.
- * * If the given bounding box is undefined, the given point is considered alone.
- * This results in a zero-sized bounding box or the point bbox if it exists.
- * @ignore
- * @param geoJson
- * @param bboxToExpand
+ * The `[longitude, latitude]` centre of a bounding box.
  */
-export declare const bboxExpandedWithGeoJSON: (geoJson: GeoJSON, bboxToExpand?: BBox) => OptionalBBox;
-/**
- * Calculate the center of bbox
- * @ignore
- * @param bbox
- * */
 export declare const bboxCenter: (bbox: BBox) => Position;
 /**
  * Creates a GeoJSON Polygon Feature representing the area of the given bounding box.
  * @param bbox The bounding box defined as [west, south, east, north]
+ *
+ * @group Utils
  */
 export declare const polygonFromBBox: (bbox: BBox) => Feature<Polygon>;
 //#endregion
@@ -4950,13 +4923,6 @@ export declare const generateId: () => string;
  * @ignore
  */
 export declare const TOMTOM_USER_AGENT_SDK_NAME = "MapsSDKJS";
-/**
- * Generates an object with TomTom custom header values for the given common parameters.
- *
- * @ignore
- * @param params Global SDK configuration
- */
-export declare const generateTomTomHeaders: (params: Partial<GlobalConfig>) => TomTomHeaders;
 //#endregion
 //#region src/util/lngLat.d.ts
 /**
@@ -5010,72 +4976,6 @@ export declare const generateTomTomHeaders: (params: Partial<GlobalConfig>) => T
  * @group Utils
  */
 export declare const getPosition: (hasLngLat: HasLngLat | undefined, options?: GetPositionOptions) => Position | null;
-/**
- * Extracts the lng-lat position from various input formats (strict version).
- *
- * Similar to {@link getPosition}, but throws an error if the input doesn't contain
- * a valid position. Use this when you expect the input to always be valid and want
- * to fail fast on invalid data.
- *
- * @param hasLngLat An object which either is or contains a lng-lat position.
- * @param options Additional options to control how we extract the position.
- * @returns The extracted position as `[longitude, latitude]`.
- * @throws Error if the input object is undefined or does not contain a lng-lat position.
- *
- * @example
- * ```typescript
- * // Valid input
- * getPositionStrict([4.9, 52.3]); // Returns: [4.9, 52.3]
- *
- * // Invalid input throws error
- * try {
- *   getPositionStrict(undefined);
- * } catch (error) {
- *   console.error(error);
- *   // Error: The received object does not have lng-lat coordinates: undefined
- * }
- *
- * // Invalid object throws error
- * try {
- *   getPositionStrict({ invalid: 'object' });
- * } catch (error) {
- *   console.error(error);
- *   // Error: The received object does not have lng-lat coordinates: {"invalid":"object"}
- * }
- * ```
- *
- * @ignore
- */
-export declare const getPositionStrict: (hasLngLat: HasLngLat, options?: GetPositionOptions) => Position;
-/**
- * @ignore
- */
-export declare const toPointGeometry: (coordinates: Position) => Point;
-/**
- * @ignore
- */
-export declare const toPointFeature: (coordinates: Position) => Feature<Point>;
-//#endregion
-//#region src/util/poiCategoriesToID.d.ts
-/**
- * Primary mapping: POICategory names to all TomTom numeric IDs that represent them.
- * Each array is sorted smallest-first; poiCategoriesToID picks ids[0] as the canonical ID.
- *
- * @ignore
- */
-export declare const poiCategoriesToIDs: Record<POICategory$1, number[]>;
-/**
- * Derived mapping: POICategory names to their primary numeric ID (first/smallest in the array).
- *
- * @ignore
- */
-export declare const poiCategoriesToID: Record<POICategory$1, number>;
-/**
- * Derived mapping: all TomTom POI category numeric IDs to their POICategory name.
- *
- * @ignore
- */
-export declare const poiIDsToCategories: Record<number, POICategory$1>;
 //#endregion
 //#region src/util/route.d.ts
 /**
@@ -5314,7 +5214,7 @@ export declare const getRouteProgressBetween: (route: Route, startPathIndex: num
  *
  * @example
  * ```typescript
- * const section = route.properties.sections.countries[0];
+ * const section = route.properties.sections.country[0];
  * const result = getRouteProgressForSection(route, section);
  * if (result) {
  *   console.log(`Section starts ${result.start.distanceInMeters} m from route origin`);
@@ -5346,7 +5246,7 @@ export declare const getRouteProgressForSection: (route: Route, section: Section
  *
  * @example
  * ```typescript
- * const section = route.properties.sections.countries[0];
+ * const section = route.properties.sections.country[0];
  * // section = { id: 'section-1', startPointIndex: 0, endPointIndex: 3, countryCodeISO3: 'NLD' }
  *
  * const bbox = getSectionBBox(route, section);
@@ -5391,7 +5291,7 @@ export type RouteProgressQuery = {
  * @param query A discriminated union — provide exactly one of:
  *   - `{ traveledTimeInSeconds }` — elapsed seconds from route start
  *   - `{ traveledDistanceInMeters }` — meters traveled from route start
- *   - `{ clockTime }` — absolute `Date`; elapsed seconds are derived from `route.summary.departureTime`
+ *   - `{ clockTime }` — absolute `Date`; elapsed seconds are derived from `route.properties.summary.departureTime`
  * @returns Interpolated {@link RouteCoordinateAtProgress}, or `undefined` when:
  *   - the route has no `progress` data
  *   - `clockTime` is before the route departure time
@@ -5440,46 +5340,12 @@ export declare const getCoordinateAtRouteProgress: (route: Route, query: RoutePr
  */
 export declare const getProgressAtNearestRoutePoint: (route: Route, point: HasLngLat) => RouteCoordinateAtProgress | undefined;
 //#endregion
-//#region src/util/routePlanningLocations.d.ts
-/**
- * Determines the type of geographic input (waypoint or path).
- *
- * This function inspects the structure of a RoutePlanningLocation to classify it as either:
- * - **waypoint**: A single point location (coordinate pair, Point geometry, or Point Feature)
- * - **path**: A line or route (array of coordinates, LineString geometry, or LineString Feature)
- *
- * @param routePlanningLocation The geographic input to classify. Can be coordinates, GeoJSON geometry, or GeoJSON Feature.
- * @returns The type of the input: 'waypoint' for point locations or 'path' for line geometries.
- *
- * @ignore
- */
-export declare const getRoutePlanningLocationType: (routePlanningLocation: RoutePlanningLocation) => RoutePlanningLocationType;
-//#endregion
 //#region src/util/traffic.d.ts
 /**
- * @ignore
+ * Every {@link DelayMagnitude}, each at the index the Traffic API's `magnitudeOfDelay` code gives it.
+ * @group Traffic
  */
 export declare const indexedMagnitudes: DelayMagnitude[];
-/**
- * Maps an `iconCategory` integer from the traffic vector tiles to a {@link TrafficIncidentCategory}.
- * Integer values that do not correspond to a known category are mapped to `'other'`.
- *
- * @param iconCategory - Integer category code from the tile
- * @returns The corresponding {@link TrafficIncidentCategory}
- *
- * @ignore
- */
-export declare const iconToTrafficIncidentCategory: (iconCategory: number) => TrafficIncidentCategory;
-/**
- * Maps a {@link TrafficIncidentCategory} string to the `iconCategory` integer used by the traffic vector tiles.
- * `'other'` and any unrecognised values map to `0`.
- *
- * @param category - The string category
- * @returns The corresponding integer icon category code
- *
- * @ignore
- */
-export declare const trafficIncidentToIconCategory: (category: TrafficIncidentCategory) => number;
 //#endregion
 //#region src/util/unitFormatters.d.ts
 /**
@@ -5577,12 +5443,6 @@ export declare const formatDuration: (seconds: number | undefined, options?: Tim
  * @group Utils
  */
 export type DistanceUnitsType = 'metric' | 'imperial_us' | 'imperial_uk';
-/**
- * Metres in one international mile — the factor behind every metric-to-imperial conversion in the SDK.
- *
- * @ignore
- */
-export declare const MILE_IN_METERS = 1609.344;
 /**
  * Formatting is based on the number of meters passed and unit type. Less meters more precision.
  * @example
@@ -5719,7 +5579,7 @@ export type DisplayUnits = {
  *   retry: {
  *     initialWaitMs: 0.447,
  *     backoffFactor: 1.618,
- *     timeoutMs: 60000,
+ *     timeoutMs: 40000,
  *   }
  * });
  * ```
@@ -5750,7 +5610,7 @@ export type RetryConfig = {
    * If the next retry wait would exceed this timeout (measured from the
    * first request), the SDK returns the 429 error to the caller.
    *
-   * @default 60000
+   * @default 40000
    */
   timeoutMs?: number;
 };
@@ -5800,7 +5660,7 @@ export type GlobalConfig = {
    * Accepts IETF language codes (case-insensitive). Affects search results,
    * routing instructions, and map labels.
    *
-   * @default "NGT" (Neutral Ground Truth - uses local language for each location)
+   * @default "ngt" (Neutral Ground Truth - uses local language for each location)
    *
    * @see {@link https://docs.tomtom.com/search-api/documentation/product-information/supported-languages | Search supported languages}
    * @see {@link https://docs.tomtom.com/routing-api/documentation/product-information/supported-languages | Routing supported languages}
@@ -5823,10 +5683,23 @@ export type GlobalConfig = {
    * switches the SDK to proxy-credentials mode, where no key leaves the browser and requests carry the proxy's
    * session cookie.
    *
+   * It must be `https:`, or relative to the page; `http:` is accepted only for a loopback address (`localhost`,
+   * `127.0.0.0/8`, `[::1]`). Otherwise service calls reject, and the map constructor throws, with code `INSECURE_BASE_URL`.
+   *
    * @default "https://api.tomtom.com"
    * @see [Proxying your API calls](https://docs.tomtom.com/maps-sdk-js/guides/security/proxying-api-calls)
    */
   commonBaseURL: string;
+  /**
+   * Whether requests to TomTom carry the `tomtom-user-agent` header, naming the SDK and its version.
+   *
+   * TomTom reads it to tell which SDK versions are in use. Turn it off when that header must not
+   * leave the page, or when a proxy of yours should not have to allow it in its CORS preflight answer.
+   *
+   * @default true
+   * @see [What the SDK sends](https://docs.tomtom.com/maps-sdk-js/guides/security/what-the-sdk-sends)
+   */
+  sendUserAgentHeader?: boolean;
   /**
    * Custom display units for time and distance.
    *
@@ -5839,7 +5712,7 @@ export type GlobalConfig = {
    * Configuration for automatic retry on rate-limited (429) responses.
    *
    * When set, the SDK automatically retries requests that receive a 429 status code
-   * using exponential backoff. All fields have sensible defaults.
+   * using exponential backoff. A field left out takes its default; `undefined` disables retrying.
    *
    * @see {@link RetryConfig}
    */
@@ -5898,8 +5771,8 @@ export declare class TomTomConfig {
   /**
    * Merge configuration values into the global configuration.
    *
-   * New values override existing ones. This performs a shallow merge,
-   * so nested objects are replaced entirely rather than merged.
+   * New values override existing ones. This performs a shallow merge, so nested objects are replaced
+   * entirely, except that a `retry` object takes its missing fields from the default retry config.
    *
    * @param config - Partial configuration to merge
    *
@@ -5937,11 +5810,6 @@ export declare class TomTomConfig {
    */
   get(): GlobalConfig;
 }
-/**
- * Merges the global configuration into the given one, with the latter having priority.
- * @ignore
- */
-export declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenConfig?: T) => GlobalConfig & T;
 /**
  * Whether the SDK is configured for a credentials proxy such as the demos proxy
  * — no `apiKey` (the
@@ -5966,4 +5834,4 @@ export declare const mergeFromGlobal: <T extends Partial<GlobalConfig>>(givenCon
  */
 export declare const isProxyCredentialsMode: (config?: Partial<Pick<GlobalConfig, "apiKey" | "commonBaseURL">>) => boolean;
 //#endregion
-export type { Anything, BBox, ChargingAvailabilityDataSource, ChargingPark, ChargingParkWithAvailability, ChargingPointAvailability, ChargingStationsAvailability, CombustionSummary, ConnectorAvailability, ConnectorCount, DrivingSide, EVChargingStationWithAvailabilityPlaceProps, ElectricSummary, FeatureCollectionWithProperties, Fuel, GeometryDataSource, GetPositionEntryPointOption, GetPositionOptions, Guidance, HasBBox, HasConnector, HasCount, HasLngLat, Instruction, InstructionText, Landmark, Language, LegSummary, Maneuver, ManeuverAngle, ManeuverView, Moment, OpeningHours, OpeningHoursMode, OptionalBBox, POI, PathLike, PlaceDataSources, PoiDetailsDataSource, PolygonFeature, PolygonFeatures, RelatedPOI, RoadInformation, RoadInformationProperty, RoadShield, RoadShieldReference, RoundaboutType, RoutePathPoint, RoutePlanningLocation, RoutePlanningLocationType, RouteSummary, SideRoad, SideRoadSide, Signpost, SummaryBase, SummaryWithConsumption, TimeRange, TimeZone, TollPaymentType, TomTomAPIHeaders, TomTomHeaders, Waypoint, WaypointLike, WaypointProps, Waypoints, languages };
+export type { Anything, BBox, ChargingAvailabilityDataSource, ChargingPark, ChargingParkWithAvailability, ChargingPointAvailability, ChargingStationsAvailability, CombustionSummary, ConnectorAvailability, ConnectorCount, DrivingSide, EVChargingStationWithAvailabilityPlaceProps, ElectricSummary, FeatureCollectionWithProperties, Fuel, GeometryDataSource, GetPositionEntryPointOption, GetPositionOptions, Guidance, HasBBox, HasConnector, HasCount, HasLngLat, Instruction, InstructionText, Landmark, Language, LegSummary, Maneuver, ManeuverAngle, ManeuverView, Moment, OpeningHours, OpeningHoursMode, OptionalBBox, POI, PathLike, PlaceDataSources, PoiDetailsDataSource, PolygonFeature, PolygonFeatures, RelatedPOI, RoadInformation, RoadInformationProperty, RoadShield, RoadShieldReference, RoundaboutType, RoutePathPoint, RoutePlanningLocation, RoutePlanningLocationType, RouteSummary, SideRoad, SideRoadSide, Signpost, SummaryBase, SummaryWithConsumption, TimeRange, TimeZone, TollPaymentType, TomTomAPIHeaders, Waypoint, WaypointLike, WaypointProps, Waypoints, languages };

package/map/dist/chunks/maplibre-gl-worker.js

@@ -0,0 +1,2 @@
+import MapLibreWorker from"maplibre-gl/dist/maplibre-gl-worker.mjs";Reflect.has(self,"worker")||Reflect.set(self,"worker",new MapLibreWorker(self));
+//# sourceMappingURL=maplibre-gl-worker.js.map

package/map/dist/chunks/maplibre-gl-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maplibre-gl-worker.js","names":["MapLibreWorker","Reflect","has","self","set"],"sources":["../../src/init/mapLibreWorkerEntry.ts"],"sourcesContent":["import MapLibreWorker from 'maplibre-gl/dist/maplibre-gl-worker.mjs';\n\n// maplibre-gl declares its dist side-effect free, so a bundler keeps this module only for an import it uses,\n// and may then drop the module's own start (`self.worker = new Worker(self)`).\nif (!Reflect.has(self, 'worker')) {\n    Reflect.set(self, 'worker', new MapLibreWorker(self));\n}\n"],"mappings":"oEAIKC,QAAQC,IAAIC,KAAM,WACnBF,QAAQG,IAAID,KAAM,SAAU,IAAIH,eAAeG"}