@milemaker/milemaker-js 2.0.0-alpha.3 → 2.0.0-alpha.7

package/dist/actions/layer/trafficLayerActions.factory.d.ts

@@ -1,3 +1,6 @@
+import { GeneralAppSettings } from "../../types";
 import { CreateActionsFactory } from "../types";
 import { TrafficLayerActions } from "./types";
-export declare const trafficLayerActionsFactory: CreateActionsFactory<TrafficLayerActions>;
+export declare const trafficLayerActionsFactory: CreateActionsFactory<TrafficLayerActions, {
+    generalAppSettings: GeneralAppSettings;
+}>;

package/dist/actions/marker/createClusterMarkersAction.factory.d.ts

@@ -0,0 +1,5 @@
+import { CreateActionsFactory, MarkerActions } from "../types";
+export declare const createClusterMarkersActionFactory: CreateActionsFactory<MarkerActions["createClusterMarkers"], {
+    accessToken: string;
+    baseApiUrl: string;
+}>;

package/dist/actions/marker/index.d.ts

@@ -1,3 +1,6 @@
 import { CreateActionsFactory } from "../types";
 import { MarkerActions } from "./types";
-export declare const markerActionsFactory: CreateActionsFactory<MarkerActions>;
+export declare const markerActionsFactory: CreateActionsFactory<MarkerActions, {
+    accessToken: string;
+    baseApiUrl: string;
+}>;

package/dist/actions/marker/types/markerActions.types.d.ts

@@ -1,5 +1,5 @@
 import MapProvider from "../../../MapProvider";
-import { LonLatLike, Popup } from "../../../types";
+import { Anchor, LonLatLike, Popup } from "../../../types";
 import { CreatePopupOptions, MapElement } from "../../types";
 /**
  * Marker instance
@@ -78,6 +78,11 @@ export type MarkerPopupOptions = {
      * Do toggle marker on click
      */
     toggleOnMarkerClick?: boolean;
+    /**
+     * Show popup on marker hover and hide on mouse leave
+     * @default false
+     */
+    toggleOnMarkerHover?: boolean;
 } & CreatePopupOptions;
 /**
  * Create marker options
@@ -95,6 +100,11 @@ export type CreateMarkerOptions = {
      * Do center on click
      */
     centerOnClick?: boolean;
+    /**
+     * Marker's anchor
+     * @default "bottom"
+     */
+    anchor?: Anchor;
     /**
      * Marker's popup options
      */
@@ -145,7 +155,7 @@ export type CreateMarkerOptions = {
          */
         onMouseLeave?(): void;
     } | void;
-} & Omit<MapProvider.MarkerOptions, "element">;
+} & Omit<MapProvider.MarkerOptions, "element" | "anchor">;
 /**
  * Create stop marker options with predefined icon, and color.
  * @interface
@@ -172,7 +182,7 @@ export type CreateStopMarkerOptions = {
  * @group Actions
  * @category Marker
  */
-export type MarkersPopupOptions = Pick<MarkerPopupOptions, "toggleOnMarkerClick" | "showOnMount" | "hideOnClickOutside">;
+export type MarkersPopupOptions = Pick<MarkerPopupOptions, "toggleOnMarkerClick" | "toggleOnMarkerHover" | "showOnMount" | "hideOnClickOutside">;
 /**
  * Create stop markers options
  * @interface
@@ -189,6 +199,121 @@ export type CreateStopMarkersOptions = Pick<CreateMarkerOptions, "color" | "show
      */
     getMarkerOptions?: (item: LonLatLike, index: number, array: LonLatLike[]) => Partial<CreateStopMarkerOptions>;
 };
+/**
+ * Base interface for cluster marker items
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type BaseClusterMarkerItem = {
+    /**
+     * Unique identifier for the item
+     */
+    id: string;
+    /**
+     * Coordinate of the item
+     */
+    lonLatLike: LonLatLike;
+};
+/**
+ * Cluster information with marker instance
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type ClusterInfo<T extends BaseClusterMarkerItem = BaseClusterMarkerItem> = {
+    /**
+     * MapBox cluster ID (undefined for single points)
+     */
+    clusterId?: number;
+    /**
+     * Array of all items in this cluster
+     */
+    clusteredItems: T[];
+    /**
+     * Representative item for this cluster (middle item from clusteredItems)
+     */
+    clusterItem: T;
+    /**
+     * Coordinates where the cluster marker is placed
+     */
+    clusterLonLatLike: LonLatLike;
+    /**
+     * Marker instance for this cluster
+     */
+    clusterMarker: Marker | undefined;
+};
+/**
+ * Cluster markers instance
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type ClusterMarkers<T extends BaseClusterMarkerItem = BaseClusterMarkerItem> = MapElement & {
+    /**
+     * Original items passed to createClusterMarkers
+     */
+    items: T[];
+    /**
+     * Get current clusters with their markers
+     */
+    getClusters(): ClusterInfo<T>[];
+};
+/**
+ * Create cluster markers options
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type CreateClusterMarkersOptions<T extends BaseClusterMarkerItem = BaseClusterMarkerItem> = {
+    /**
+     * Array of items to cluster
+     */
+    items: T[];
+    /**
+     * Show markers on creation
+     * @default true
+     */
+    showAtMount?: boolean;
+    /**
+     * Do zoom on cluster click
+     * @default true
+     */
+    doZoomOnClick?: boolean;
+    /**
+     * Radius in pixels to cluster points
+     * @default 40
+     */
+    clusterRadius?: number;
+    /**
+     * Cluster item radius - size of invisible circle for clustering calculations
+     * @default 20
+     */
+    clusterItemRadius?: number;
+    /**
+     * Place cluster markers on existing item positions (middle item)
+     * @default true
+     */
+    doPlaceOnExistingItems?: boolean;
+    /**
+     * Create marker options for cluster or point
+     * @param cluster - Cluster information
+     */
+    createMarkerOptions(cluster: {
+        /**
+         * Coordinates where the cluster marker is placed
+         */
+        clusterLonLatLike: LonLatLike;
+        /**
+         * Representative item for this cluster (middle item)
+         */
+        clusterItem: T;
+        /**
+         * Array of all items in this cluster
+         */
+        clusteredItems: T[];
+    }): CreateMarkerOptions;
+};
 /**
  * Marker actions
  * @interface
@@ -214,4 +339,9 @@ export type MarkerActions = {
      * @param options - Options to set
      */
     createStopMarkers(stops: LonLatLike[], options?: CreateStopMarkersOptions): Markers;
+    /**
+     * Create cluster markers with dynamic clustering
+     * @param options - Clustering options
+     */
+    createClusterMarkers<T extends BaseClusterMarkerItem = BaseClusterMarkerItem>(options: CreateClusterMarkersOptions<T>): ClusterMarkers<T>;
 };

package/dist/actions/popup/types/popupActions.types.d.ts

@@ -111,7 +111,7 @@ export type CreatePopupOptions = {
          */
         onMount?(popup: Popup): void;
     };
-} & MapProvider.PopupOptions;
+} & Omit<MapProvider.PopupOptions, "offset">;
 /**
  * Popup actions
  * @interface

package/dist/actions/types/actions.types.d.ts

@@ -3,6 +3,7 @@ import { MapLayerActions } from "../layer/types";
 import { MarkerActions } from "../marker/types";
 import { PopupActions } from "../popup/types";
 import { RouteActions } from "../route/types";
+import { WeatherActions } from "../weather/types";
 import { ZoomActions } from "../zoom/types";
 /**
  * Basic map element
@@ -56,5 +57,5 @@ export type CreateActionsFactory<Return, AdditionalOptions = void> = (options: B
  * @interface
  * @group Actions
  */
-export type MapActions = ZoomActions & MapLayerActions & MarkerActions & PopupActions & RouteActions;
+export type MapActions = ZoomActions & MapLayerActions & MarkerActions & PopupActions & RouteActions & WeatherActions;
 export {};

package/dist/actions/types/index.d.ts

@@ -5,3 +5,4 @@ export * from "../marker/types";
 export * from "../popup/types";
 export * from "../route/types";
 export * from "../zoom/types";
+export * from "../weather/types";

package/dist/actions/weather/index.d.ts

@@ -0,0 +1,46 @@
+import { CreateActionsFactory } from "../types";
+import { WeatherActions } from "./types";
+/**
+ * Weather actions factory
+ *
+ * Creates weather-related actions for the map including weather alerts.
+ *
+ * @example
+ * ```ts
+ * const weatherActions = weatherActionsFactory({
+ *   map: mapInstance,
+ *   accessToken: "your-access-token"
+ * });
+ *
+ * // Show weather alerts for a route with configuration
+ * await weatherActions.weatherAlertsActions.show(routeCoordinates, {
+ *   strokeColor: "#9333EA",
+ *   showAtMount: true,
+ *   doZoomOnClick: true,
+ *   clusterRadius: 60,
+ *   createMarkerOptions: ({ clusteredItems, clusterItem }) => ({
+ *     getHtmlIconElement: () => ({
+ *       htmlElement: createCustomWeatherAlertIcon(clusterItem)
+ *     }),
+ *     popupOptions: {
+ *       getHtmlContentElement: () => ({
+ *         htmlElement: createCustomWeatherAlertPopup(clusteredItems)
+ *       })
+ *     }
+ *   })
+ * });
+ *
+ * // Hide weather alerts
+ * weatherActions.weatherAlertsActions.hide();
+ *
+ * // Check visibility
+ * const isVisible = weatherActions.weatherAlertsActions.getIsVisible();
+ * ```
+ *
+ * @group Actions
+ * @category Weather
+ */
+export declare const weatherActionsFactory: CreateActionsFactory<WeatherActions, {
+    baseApiUrl: string;
+    accessToken: string;
+}>;

package/dist/actions/weather/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./weather.types";

package/dist/actions/weather/types/weather.types.d.ts

@@ -0,0 +1,115 @@
+import type { AerisWeatherResponseItemAlert, AlertResponseItemPerLonLatLike } from "../../../apis/aerisWeather/aerisWeather.types";
+import type { LonLatLike } from "../../../types";
+import type { BaseClusterMarkerItem, ClusterMarkers, CreateMarkerOptions } from "../../types";
+/**
+ * Weather alert cluster item
+ *
+ * @group Actions
+ * @category Weather
+ */
+export type WeatherAlertClusterItem = BaseClusterMarkerItem & {
+    /** Alert response data from Aeris API */
+    alertResponseItem: AerisWeatherResponseItemAlert;
+};
+/**
+ * Create weather alert cluster marker options
+ * @interface
+ * @group Actions
+ * @category Weather
+ */
+export type CreateWeatherAlertClusterMarkerOptions = {
+    /**
+     * Array of all items in this cluster
+     */
+    clusteredItems: WeatherAlertClusterItem[];
+    /**
+     * Coordinates where the cluster marker is placed
+     */
+    clusterLonLatLike: LonLatLike;
+    /**
+     * Representative item for this cluster (middle item from clusteredItems)
+     */
+    clusterItem: WeatherAlertClusterItem;
+};
+/**
+ * Weather alerts options
+ * @interface
+ * @group Actions
+ * @category Weather
+ */
+export type WeatherAlertsOptions = {
+    /**
+     * Function to create marker options for each cluster
+     */
+    createMarkerOptions?: (options: CreateWeatherAlertClusterMarkerOptions) => CreateMarkerOptions;
+    /**
+     * Stroke color for weather alert icon triangle border (hex format)
+     * @example "#FF0000"
+     * @default "#000000"
+     */
+    strokeColor?: string;
+    /**
+     * Show markers on mount
+     * @default true
+     */
+    showAtMount?: boolean;
+    /**
+     * Do zoom on cluster click
+     * @default true
+     */
+    doZoomOnClick?: boolean;
+    /**
+     * Cluster radius in pixels
+     * @default 40
+     */
+    clusterRadius?: number;
+    /**
+     * Cluster item radius - size of invisible circle for clustering calculations
+     * @default 20
+     */
+    clusterItemRadius?: number;
+};
+/**
+ * Weather alerts actions
+ * @interface
+ * @group Actions
+ * @category Weather
+ */
+export type WeatherAlertsActions = {
+    /**
+     * Show weather alerts layer
+     * @param lonLatLikes - Array of coordinates along the route
+     * @param options - Optional options for weather alerts display
+     */
+    show(lonLatLikes: LonLatLike[], options?: WeatherAlertsOptions): Promise<void>;
+    /**
+     * Hide weather alerts layer
+     */
+    hide(): void;
+    /**
+     * Get is weather alerts layer visible
+     */
+    getIsVisible(): boolean;
+    /**
+     * Get cluster markers instance
+     */
+    getClusterMarkers(): ClusterMarkers<WeatherAlertClusterItem> | null;
+    /**
+     * Get weather alerts for given coordinates
+     * @param lonLatLikes - Array of coordinates to fetch alerts for
+     * @returns Promise resolving to array of alert items with alerts (filtered to only include items that have alerts)
+     */
+    getAlerts(lonLatLikes: LonLatLike[]): Promise<AlertResponseItemPerLonLatLike[]>;
+};
+/**
+ * Weather actions
+ * @interface
+ * @group Actions
+ * @category Weather
+ */
+export type WeatherActions = {
+    /**
+     * Weather alerts actions
+     */
+    weatherAlertsActions: WeatherAlertsActions;
+};

package/dist/actions/weather/weatherAlertsActions.factory.d.ts

@@ -0,0 +1,6 @@
+import { CreateActionsFactory } from "../types";
+import { WeatherAlertsActions } from "./types";
+export declare const weatherAlertsActionsFactory: CreateActionsFactory<WeatherAlertsActions, {
+    accessToken: string;
+    baseApiUrl: string;
+}>;

package/dist/apis/aerisWeather/aerisWeather.api.d.ts

@@ -0,0 +1,75 @@
+import { LonLatLike } from "../../types";
+export declare const aerisWeatherApi: {
+    getWeatherAlertsResponseItems: ({ lonLatLikes, baseApiUrl, accessToken }: {
+        lonLatLikes: LonLatLike[];
+        baseApiUrl: string;
+        accessToken: string;
+    }) => Promise<{
+        type: "Feature";
+        geometry: {
+            coordinates: [number, number];
+            type: "Point";
+        };
+        properties: {
+            request: {
+                id: string;
+                skipped: boolean;
+                success: boolean;
+                error: {
+                    code: string;
+                    description: string;
+                } | null;
+            };
+            response: {
+                id: string;
+                loc: {
+                    lat: number;
+                    long: number;
+                };
+                dataSource: string;
+                details: {
+                    type: string;
+                    name: string;
+                    loc: string;
+                    emergency: boolean;
+                    priority: number;
+                    color: string;
+                    cat: string;
+                    body: string;
+                    bodyFull: string;
+                };
+                timestamps: {
+                    issued: number;
+                    issuedISO: string;
+                    begins: number;
+                    beginsISO: string;
+                    expires: number;
+                    expiresISO: string;
+                    updated: number;
+                    updateISO: string;
+                    added: number;
+                    addedISO: string;
+                    created: number;
+                    createdISO: string;
+                };
+                poly: string;
+                geoPoly: null;
+                includes: {
+                    fips: string[];
+                    counties: string[];
+                    wxzones: string[];
+                    zipcodes: string[];
+                };
+                place: {
+                    name: string;
+                    state: string;
+                    country: string;
+                };
+                profile: {
+                    tz: string;
+                };
+                active: boolean;
+            }[] | null;
+        };
+    }[]>;
+};