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

package/dist/components/WeatherAlertIcon/WeatherAlertIcon.types.d.ts

@@ -0,0 +1,17 @@
+export declare enum WeatherAlertIconType {
+    CLOUD = "cloud",
+    CYCLONE = "cyclone",
+    FLOOD = "flood",
+    LANDSLIDE = "landslide",
+    SNOW = "snow",
+    STORM = "storm",
+    THUNDER = "thunder",
+    TORNADO = "tornado",
+    TSUNAMI = "tsunami",
+    WIND = "wind"
+}
+export type WeatherAlertIconOptions = {
+    category?: string;
+    strokeColor?: string;
+    iconColor?: string;
+};

package/dist/components/WeatherAlertIcon/WeatherAlertIconPopup.d.ts

@@ -0,0 +1,24 @@
+import { AerisWeatherAlert } from "../../apis/aerisWeather/aerisWeather.types";
+import "./WeatherAlertIconPopup.scss";
+export type WeatherAlertIconPopupOptions = {
+    alerts: AerisWeatherAlert[];
+};
+/**
+ * Creates a popup element for displaying weather alerts
+ *
+ * @param options - Options for creating the popup
+ * @returns HTMLElement containing the formatted alert names
+ *
+ * @example
+ * ```ts
+ * const popup = createWeatherAlertIconPopup({
+ *   alerts: [
+ *     { details: { name: "WINTER STORM WARNING" } },
+ *     { details: { name: "WINTER STORM WARNING" } },
+ *     { details: { name: "SNOW ADVISORY" } }
+ *   ]
+ * });
+ * // Returns popup showing: "Winter Storm Warning" and "Snow Advisory"
+ * ```
+ */
+export declare const createWeatherAlertIconPopup: (options: WeatherAlertIconPopupOptions) => HTMLElement;

package/dist/components/WeatherAlertIcon/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./WeatherAlertIcon";
+export * from "./WeatherAlertIcon.types";
+export * from "./WeatherAlertIconPopup";

package/dist/components/WeatherLegend/RainSnowIceLegend/RainSnowIceLegend.types.d.ts

@@ -9,6 +9,7 @@ export type RainSnowIceLegendOptions = {
     isVisible: boolean;
     parentElement: HTMLElement;
     accessToken: string;
+    baseApiUrl: string;
 };
 export type RainSnowIceLegendInstance = {
     show(): void;

package/dist/components/WeatherLegend/WeatherAlertsLegend/WeatherAlertsLegend.types.d.ts

@@ -3,6 +3,7 @@ export type WeatherAlertsLegendOptions = {
     isVisible: boolean;
     parentElement: HTMLElement;
     accessToken: string;
+    baseApiUrl: string;
 };
 export type WeatherAlertsLegendInstance = {
     show(): void;

package/dist/components/WeatherLegend/WeatherLegend.types.d.ts

@@ -4,6 +4,7 @@ export type WeatherLegendOptions = {
     fetchLegend: () => Promise<void>;
     renderData: () => string;
     accessToken: string;
+    baseApiUrl: string;
 };
 export type WeatherLegendInstance = {
     show(): void;

package/dist/components/WeatherLegend/WeatherTemperaturesLegend/WeatherTemperaturesLegend.types.d.ts

@@ -5,6 +5,7 @@ export type WeatherTemperaturesLegendOptions = {
     parentElement: HTMLElement;
     units: UnitsFormat;
     accessToken: string;
+    baseApiUrl: string;
 };
 export type WeatherTemperaturesLegendInstance = {
     show(): void;

package/dist/components/WeatherLegend/WeatherWindSpeedsLegend/WeatherWindSpeedsLegend.types.d.ts

@@ -5,6 +5,7 @@ export type WeatherWindSpeedsLegendOptions = {
     parentElement: HTMLElement;
     units: UnitsFormat;
     accessToken: string;
+    baseApiUrl: string;
 };
 export type WeatherWindSpeedsLegendInstance = {
     show(): void;

package/dist/components/index.d.ts

@@ -7,3 +7,4 @@ export * from "./Radio/RadioButton";
 export * from "./Radio/RadioButtonGroup";
 export * from "./Radio/Radio.types";
 export * from "./WeatherLegend";
+export * from "./WeatherAlertIcon";

package/dist/controls/createOverlayLayerControl.factory.d.ts

@@ -1,3 +1,3 @@
 import "./styles/overlayLayerControl.scss";
-import { ControlCreatorFactory, OverlayLayerControl } from "./types";
-export declare const createOverlayLayerControlFactory: ControlCreatorFactory<OverlayLayerControl>;
+import { ControlCreatorFactory, OverlayLayerControl, OverlayLayerControlCreatorOptions } from "./types";
+export declare const createOverlayLayerControlFactory: ControlCreatorFactory<OverlayLayerControl, OverlayLayerControlCreatorOptions>;

package/dist/controls/createWeatherLayerControl.factory.d.ts

@@ -1,3 +1,3 @@
 import "./styles/weatherLayerControl.scss";
-import { ControlCreatorFactory, WeatherLayerControl } from "./types";
-export declare const createWeatherLayerControlFactory: ControlCreatorFactory<WeatherLayerControl>;
+import { ControlCreatorFactory, WeatherLayerControl, WeatherLayerControlCreatorOptions } from "./types";
+export declare const createWeatherLayerControlFactory: ControlCreatorFactory<WeatherLayerControl, WeatherLayerControlCreatorOptions>;

package/dist/controls/types/controls.types.d.ts

@@ -43,13 +43,54 @@ export type ControlCreatorFactory<Control extends BaseMapControl, AdditionalOpti
  * @group Map Controls
  * @interface
  */
-type BaseControlCreatorOptions = {
+export type BaseControlCreatorOptions = {
     /**
      * Control position on a screen
      * @default "bottom-right"
      */
     position?: ControlPosition;
 };
+/**
+ * Weather layer type
+ *
+ * @group Map Controls
+ * @type
+ */
+export type WeatherLayerType = "radar" | "alerts" | "satellite" | "roadConditions" | "temperatures" | "windSpeeds";
+/**
+ * Weather layer control creator options
+ * @group Map Controls
+ * @interface
+ */
+export type WeatherLayerControlCreatorOptions = BaseControlCreatorOptions & {
+    /**
+     * Callback triggered when a weather layer is shown
+     * @param layerName - The name of the weather layer that was shown
+     */
+    onShow?: (layerName: WeatherLayerType) => void;
+    /**
+     * Callback triggered when a weather layer is hidden
+     * @param layerName - The name of the weather layer that was hidden
+     */
+    onHide?: (layerName: WeatherLayerType) => void;
+};
+/**
+ * Overlay layer control creator options
+ * @group Map Controls
+ * @interface
+ */
+export type OverlayLayerControlCreatorOptions = BaseControlCreatorOptions & {
+    /**
+     * Callback triggered when an overlay layer is shown
+     * @param layerName - The name of the overlay layer that was shown
+     */
+    onShow?: (layerName: OverlayLayerType) => void;
+    /**
+     * Callback triggered when an overlay layer is hidden
+     * @param layerName - The name of the overlay layer that was hidden
+     */
+    onHide?: (layerName: OverlayLayerType) => void;
+};
 /**
  * Attribution control
  * @group Map Controls
@@ -134,14 +175,12 @@ export type MapControlCreators = {
      * Creates and returns an overlay layer control instance.
      * @function
      */
-    createOverlayLayerControl: (options?: BaseControlCreatorOptions & {
-        accessToken: string;
-    }) => OverlayLayerControl;
+    createOverlayLayerControl: (options?: OverlayLayerControlCreatorOptions) => OverlayLayerControl;
     /**
      * Creates and returns a weather layer control instance.
      * @function
      */
-    createWeatherLayerControl: (options?: BaseControlCreatorOptions) => WeatherLayerControl;
+    createWeatherLayerControl: (options?: WeatherLayerControlCreatorOptions) => WeatherLayerControl;
     /**
      * Creates and returns a zoom control instance.
      * @function
@@ -153,4 +192,10 @@ export type MapControlCreators = {
      */
     createCurrentPositionControl: (options?: BaseControlCreatorOptions) => CurrentPositionControl;
 };
+/**
+ * Overlay layer type
+ * @group Map Controls
+ * @typeParam {WeatherLayerType} WeatherLayerType - Weather layer type
+ */
+export type OverlayLayerType = WeatherLayerType | "traffic" | "truck" | null;
 export {};

package/dist/controls/utils/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./weatherLayers.constants";
 export * from "./weatherLayers.helpers";
 export * from "./weatherLayers.rendering";
-export * from "./weatherLayers.types";

package/dist/controls/utils/weatherLayers.constants.d.ts

@@ -1,5 +1,4 @@
-import { WeatherLayer } from "../../types";
-import { WeatherLayerType } from "./weatherLayers.types";
+import { WeatherLayer, WeatherLayerType } from "../../types";
 export declare const WEATHER_LAYER_MAP: Record<WeatherLayerType, WeatherLayer | WeatherLayer[]>;
 export declare const WEATHER_LAYER_LABELS: Record<WeatherLayerType, string>;
 export declare const WEATHER_LAYER_OPTIONS: WeatherLayerType[];

package/dist/controls/utils/weatherLayers.helpers.d.ts

@@ -1,5 +1,5 @@
 import { WeatherLayerActions } from "../../actions/layer/types";
-import { WeatherLayerType } from "./weatherLayers.types";
+import { WeatherLayerType } from "../../types";
 export declare const getSelectedWeatherLayer: (weatherLayerActions: WeatherLayerActions) => WeatherLayerType | null;
 export declare const showWeatherLayer: (weatherLayerActions: WeatherLayerActions, layerType: WeatherLayerType) => void;
 export declare const hideWeatherLayer: (weatherLayerActions: WeatherLayerActions, layerType: WeatherLayerType) => void;

package/dist/controls/utils/weatherLayers.rendering.d.ts

@@ -1,2 +1,2 @@
-import { WeatherLayerType } from "./weatherLayers.types";
+import { WeatherLayerType } from "../types";
 export declare const renderWeatherLayerMenuItems: (selectedLayer: WeatherLayerType | null, radioGroupName: string) => string;

package/dist/createMap/createMap.d.ts

@@ -3,7 +3,7 @@ import { CreateMapProps, MapInstance } from "./types";
 /**
  * This is the main method that allows to mount the app and use all the features
  * @group Map Initialization
- * @param {CreateMapProps} options - Options to configure the map with
+ * @param {CreateMapProps} props - Options to configure the map with
  * @example
  * How to create map instance, with default streets map style
  * ```ts

package/dist/helpers/parseLonLatLikeToCoordinates.helper.d.ts

@@ -3,5 +3,6 @@ import { Coordinates, LonLatLike } from "../types";
  * Parse a {@link LonLatLike} to {@link Coordinates}
  * @group Helpers
  * @param lonLatLike - {@link LonLatLike} object to be parsed
+ * @param precision - Optional number of decimal places to round the coordinates to
  */
-export declare const parseLonLatLikeToCoordinates: (lonLatLike: LonLatLike) => Coordinates;
+export declare const parseLonLatLikeToCoordinates: (lonLatLike: LonLatLike, precision?: number) => Coordinates;

package/dist/helpers/runAsyncThread.d.ts

@@ -0,0 +1,30 @@
+import { FunctionType, MaybePromise } from "../utils/types";
+/**
+ * Runs an asynchronous callback in a separate thread using the EasyWebWorker class.
+ *
+ * Executes an asynchronous callback function in a separate thread using a web worker.
+ * Basically, it is JS multithreading handled with Promise and WebWorker for heavy calculations.
+ * Run given callback and arguments in separate thread.
+ * To pass primitive data, use the first argument which will be passed as callback arguments
+ * Worker automatically closes and removes itself on finally
+ *
+ * @IMPORTANT Callback does not have access to outer scope, because will be running in separate process
+ *
+ * @async
+ * @template DataType - The type of the input data for the asyncCallback.
+ * @template ReturnType - The type of the output data from the asyncCallback.
+ *
+ * @param {DataType} asyncCallbackData - The input data for the asyncCallback.
+ * @param {function(data: DataType): MaybePromise<ReturnType>} asyncCallback - The asynchronous callback function that takes the input data as a parameter and returns a value of the specified ReturnType.
+ * @param {Record<string, FunctionType>} declareHelpers Helper functions which will be declared in web worker callback scope
+ *
+ * !NOTE!
+ * When passing helpers using declareHelpers be sure to pass the correct name of helper like this
+ * {
+ *     [someHelper.name]: someHelper
+ * }
+ * Because the naming will be changed in production build
+ *
+ * @returns {Promise<ReturnType>} A promise that resolves with the value returned by the asyncCallback function.
+ */
+export declare const runAsyncThread: <Return, Data extends Record<string, unknown>, Helpers extends { [key in keyof Helpers]: FunctionType<Parameters<Helpers[key]>, ReturnType<Helpers[key]>>; }>(asyncCallbackData: Data, asyncCallback: (data: Data) => MaybePromise<Return>, declareHelpers?: Helpers | undefined) => Promise<Return>;