@tracktor/map 1.3.1 → 1.4.0

package/dist/Features/Bounds/FitsBounds.d.ts

@@ -10,5 +10,32 @@ interface FitBoundsProps {
     animationKey?: unknown;
     openPopup?: boolean;
 }
+/**
+ * FitBounds Component
+ * -------------------
+ * Automatically adjusts the map viewport to fit visible markers or GeoJSON features.
+ *
+ * Workflow:
+ * 1. Collects coordinates from valid markers and/or GeoJSON features.
+ * 2. Computes bounding box (`LngLatBounds`) for all visible points.
+ * 3. Applies `map.fitBounds()` or `map.flyTo()` depending on the data (single vs multiple points).
+ * 4. Reacts to changes via `animationKey` — prevents redundant animations on repeated renders.
+ *
+ * Props:
+ * - `markers`: array of marker objects (`{ id, lat, lng }`) to fit into view.
+ * - `features`: GeoJSON data (Feature, FeatureCollection, or array of Features).
+ * - `padding`: padding (px) around fitted bounds (default: 50).
+ * - `duration`: animation duration in ms (default: 1000).
+ * - `disableAnimation`: disables map animations when true.
+ * - `fitBounds`: whether bounds fitting is enabled.
+ * - `animationKey`: dependency key to control when to re-run fitting logic.
+ * - `openPopup`: if true, temporarily skips bounds updates to avoid interfering with popups.
+ *
+ * Dependencies:
+ * - `react-map-gl` for Mapbox context.
+ * - `mapbox-gl` for geometry calculations and view transitions.
+ * - `isValidMarker` from local types — filters out invalid marker objects.
+ * - `@tracktor/react-utils` helpers for type-safe checks.
+ */
 declare const FitBounds: ({ markers, features, padding, duration, disableAnimation, fitBounds, animationKey, openPopup, }: FitBoundsProps) => null;
 export default FitBounds;

package/dist/Features/Itinerary/Itinerary.d.ts

@@ -1,10 +1,33 @@
-import { ItineraryLineStyle } from '../../types/MarkerMapProps.ts';
+import { Engine, ItineraryLineStyle, Profile } from '../../types/MarkerMapProps.ts';
 type ItineraryProps = {
     from?: [number, number];
     to?: [number, number];
-    profile?: "driving" | "walking" | "cycling";
-    routeService?: "OSRM" | "Mapbox";
+    profile?: Profile;
+    engine?: Engine;
     itineraryLineStyle?: Partial<ItineraryLineStyle>;
 };
-declare const Itinerary: ({ profile, routeService, to, from, itineraryLineStyle }: ItineraryProps) => import("react/jsx-runtime").JSX.Element | null;
+/**
+ * Itinerary Component
+ * -------------------
+ * Renders a route line between two geographical points on a Mapbox map.
+ *
+ * Workflow:
+ * 1. Fetches the route geometry between `from` and `to` coordinates.
+ * 2. Uses either OSRM or Mapbox routing services depending on the `routeService` prop.
+ * 3. Displays the resulting route as a line layer via `react-map-gl`.
+ *
+ * Props:
+ * - `from`: starting point [lng, lat].
+ * - `to`: destination point [lng, lat].
+ * - `profile`: routing mode ("driving", "walking", or "cycling").
+ * - `routeService`: which routing engine to use ("OSRM" or "Mapbox").
+ * - `itineraryLineStyle`: optional line style overrides (color, opacity, width).
+ *
+ * Dependencies:
+ * - `OSRMRoute`: returns a GeoJSON LineString from OSRM.
+ * - `mapboxRoute`: returns a GeoJSON LineString from Mapbox Directions API.
+ * - `react-map-gl`: used for rendering the map layers.
+ *
+ */
+declare const Itinerary: ({ profile, engine, to, from, itineraryLineStyle }: ItineraryProps) => import("react/jsx-runtime").JSX.Element | null;
 export default Itinerary;

package/dist/Features/MarkerMap/MarkerMap.d.ts

@@ -1,4 +1,4 @@
 import { ReactElement } from 'react';
 import { MarkerMapProps } from '../../types/MarkerMapProps';
-declare const _default: import('react').MemoExoticComponent<({ containerStyle, square, loading, height, width, center, zoom, popupMaxWidth, openPopup, openPopupOnHover, markers, fitBounds, fitBoundsPadding, fitBoundDuration, fitBoundsAnimationKey, disableAnimation, mapStyle, onMapClick, baseMapView, cooperativeGestures, doubleClickZoom, projection, theme, features, from, to, profile, itineraryLineStyle, routeService, findNearestMarker, onNearestFound, }: MarkerMapProps) => ReactElement>;
+declare const _default: import('react').MemoExoticComponent<({ containerStyle, square, loading, height, width, center, zoom, popupMaxWidth, openPopup, openPopupOnHover, markers, fitBounds, fitBoundsPadding, fitBoundDuration, fitBoundsAnimationKey, disableAnimation, mapStyle: baseMapStyle, onMapClick, baseMapView, cooperativeGestures, doubleClickZoom, projection, theme: themeOverride, features, from, to, profile, itineraryLineStyle, engine, findNearestMarker, onNearestFound, }: MarkerMapProps) => ReactElement>;
 export default _default;

package/dist/Features/NearestPointItinerary/NearestPointItinary.d.ts

@@ -4,5 +4,5 @@ export interface NearestResult {
     point: [number, number];
     distance: number;
 }
-declare const _default: import('react').MemoExoticComponent<({ origin, maxDistanceMeters, destinations, onNearestFound }: FindNearestMarkerParams) => import("react/jsx-runtime").JSX.Element | null>;
+declare const _default: import('react').MemoExoticComponent<({ origin, maxDistanceMeters, destinations, onNearestFound, profile, engine, }: FindNearestMarkerParams) => import("react/jsx-runtime").JSX.Element | null>;
 export default _default;