@milemaker/milemaker-js 1.1.0-alpha.1 → 2.0.0-alpha.1

package/dist/actions/constants/actions.constants.d.ts

@@ -1,6 +1,7 @@
-import { MapBaseLayer } from "../../types";
+import { GeneralAppSettings, MapBaseLayer } from "../../types";
 export declare const DEFAULT_BASE_LAYER = MapBaseLayer.STREETS;
-export declare const DEFAULT_BASE_API_URL = "https://proxy-nodejs.prd.milemaker.com/proxy";
+export declare const DEFAULT_GENERAL_APP_SETTINGS: GeneralAppSettings;
+export declare const DEFAULT_BASE_API_URL = "https://proxy-nodejs.prd.milemaker.com";
 export declare const DEFAULT_ROUTE_COLOR = "rgba(0, 0, 0, 0.87)";
 export declare const MAP_FIT_INTO_BOUNDS_DEFAULT_PADDING = 100;
 export declare const MAP_DEFAULT_POLYLINE_STROKE_WIDTH = 5;

package/dist/actions/index.d.ts

@@ -1,4 +1,4 @@
-import { MapBaseLayer } from "../types";
+import { GeneralAppSettings, MapBaseLayer } from "../types";
 import { CreateActionsFactory, MapActions } from "./types";
 export * from "./zoom";
 export * from "./layer";
@@ -6,5 +6,8 @@ export * from "./layer";
 export * from "./marker";
 export * from "./popup";
 export declare const createMapActionFactory: CreateActionsFactory<MapActions, {
+    accessToken: string;
+    baseApiUrl: string;
     defaultBaseLayer?: MapBaseLayer;
+    generalAppSettings?: GeneralAppSettings;
 }>;

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

@@ -2,5 +2,5 @@ import { MapBaseLayer } from "../../types";
 import { CreateActionsFactory } from "../types";
 import { BaseLayerActions } from "./types";
 export declare const baseLayerActionsFactory: CreateActionsFactory<BaseLayerActions, {
-    defaultBaseLayer?: MapBaseLayer;
+    defaultBaseLayer: MapBaseLayer;
 }>;

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

@@ -1,6 +1,9 @@
-import { MapBaseLayer } from "../../types";
+import { GeneralAppSettings, MapBaseLayer } from "../../types";
 import { CreateActionsFactory } from "../types";
 import { MapLayerActions } from "./types";
 export declare const layerActionsFactory: CreateActionsFactory<MapLayerActions, {
-    defaultBaseLayer?: MapBaseLayer;
+    accessToken: string;
+    baseApiUrl: string;
+    defaultBaseLayer: MapBaseLayer;
+    generalAppSettings: GeneralAppSettings;
 }>;

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

@@ -1,4 +1,4 @@
-import { MapBaseLayer } from "../../../types";
+import { MapBaseLayer, WeatherLayer } from "../../../types";
 /**
  * Base layer actions
  * @interface
@@ -10,15 +10,15 @@ export type BaseLayerActions = {
      * Change current base layer
      * @param baseLayer - Base layer to set
      */
-    changeBaseLayer(baseLayer: MapBaseLayer): void;
+    change(baseLayer: MapBaseLayer): void;
     /**
      * Get current base layer
      */
-    getCurrentBaseLayer(): MapBaseLayer;
+    getCurrent(): MapBaseLayer;
     /**
      * Get is given base layer currently visible
      */
-    getIsVisibleBaseLayer(baseLayer: MapBaseLayer): boolean;
+    getIsVisible(baseLayer: MapBaseLayer): boolean;
 };
 /**
  * Traffic layer actions
@@ -30,15 +30,15 @@ export type TrafficLayerActions = {
     /**
      * Show traffic layer
      */
-    showTrafficLayer(): void;
+    show(): void;
     /**
      * Hide traffic layer
      */
-    hideTrafficLayer(): void;
+    hide(): void;
     /**
      * Get is traffic layer visible
      */
-    getIsVisibleTrafficLayer(): boolean;
+    getIsVisible(): boolean;
     /**
      * Toggle traffic layer visibility
      */
@@ -54,20 +54,40 @@ export type TruckRestrictionsLayerActions = {
     /**
      * Show truck restrictions layer
      */
-    showTruckRestrictionsLayer(): void;
+    show(): void;
     /**
      * Hide truck restrictions layer
      */
-    hideTruckRestrictionsLayer(): void;
+    hide(): void;
     /**
      * Get is truck restrictions layer visible
      */
-    getIsVisibleTruckRestrictionsLayer(): boolean;
+    getIsVisible(): boolean;
     /**
      * Toggle truck restrictions layer visibility
      */
     toggle(): void;
 };
+/**
+ * Weather layer actions
+ * @interface
+ * @group Actions
+ * @category Layers
+ */
+export type WeatherLayerActions = {
+    /**
+     * Show weather layer
+     */
+    show(weatherLayer: WeatherLayer | WeatherLayer[]): void;
+    /**
+     * Hide weather layer
+     */
+    hide(weatherLayer: WeatherLayer | WeatherLayer[]): void;
+    /**
+     * Get is weather layer visible
+     */
+    getIsVisible(weatherLayer: WeatherLayer | WeatherLayer[]): boolean;
+};
 /**
  * Map layer actions
  * @interface
@@ -87,4 +107,8 @@ export type MapLayerActions = {
      * Truck restrictions layer actions
      */
     truckRestrictionsLayerActions: TruckRestrictionsLayerActions;
+    /**
+     * Weather layer actions
+     */
+    weatherLayerActions: WeatherLayerActions;
 };

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

@@ -0,0 +1,8 @@
+import { GeneralAppSettings } from "../../types";
+import { CreateActionsFactory } from "../types";
+import { WeatherLayerActions } from "./types";
+export declare const weatherLayerActionsFactory: CreateActionsFactory<WeatherLayerActions, {
+    accessToken: string;
+    baseApiUrl: string;
+    generalAppSettings: GeneralAppSettings;
+}>;

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

@@ -12,7 +12,7 @@ export type Marker = {
      * Move marker to given coordinate
      * @param lonLatLike - Coordinate to move marker
      */
-    moveMarker(lonLatLike: LonLatLike): void;
+    move(lonLatLike: LonLatLike): void;
     /**
      * Get marker's coordinate
      */

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

@@ -12,7 +12,7 @@ export type Popup = {
      * Move popup to given coordinate
      * @param lonLatLike - Coordinate to move popup
      */
-    movePopup(lonLatLike: LonLatLike): void;
+    move(lonLatLike: LonLatLike): void;
     /**
      * Get popup's coordinate
      */

package/dist/components/Popper/Popper.d.ts

@@ -1,3 +1,3 @@
 import "./Popper.scss";
 import { PopperInstance, PopperOptions } from "./Popper.types";
-export declare const createPopper: (anchorElement: HTMLElement, content: string, options?: PopperOptions) => PopperInstance;
+export declare const createPopper: (anchorElement: HTMLElement, content: string, options: PopperOptions) => PopperInstance;

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

@@ -10,6 +10,8 @@ export type PopperOffset = {
     y?: number;
 };
 export type PopperOptions = {
+    id: string;
+    header?: string;
     placement?: PopperPlacement;
     offset?: PopperOffset;
     flip?: boolean;
@@ -26,4 +28,5 @@ export type PopperInstance = {
     show(): void;
     hide(): void;
     getIsVisible(): boolean;
+    getId(): string;
 };

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

@@ -0,0 +1,3 @@
+import "./RainSnowIceLegend.scss";
+import { RainSnowIceLegendInstance, RainSnowIceLegendOptions } from "./RainSnowIceLegend.types";
+export declare const createRainSnowIceLegend: (options: RainSnowIceLegendOptions) => RainSnowIceLegendInstance;

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

@@ -0,0 +1,18 @@
+export declare enum LegendType {
+    RAIN = "rain",
+    SNOW = "snow",
+    ICE = "ice"
+}
+export type LegendColors = Record<LegendType, string[]>;
+export type RainSnowIceLegendOptions = {
+    title: string;
+    isVisible: boolean;
+    parentElement: HTMLElement;
+    accessToken: string;
+};
+export type RainSnowIceLegendInstance = {
+    show(): void;
+    hide(): void;
+    destroy(): void;
+    getIsVisible(): boolean;
+};

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

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

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

@@ -0,0 +1,2 @@
+export declare const LEGEND_URL = "https://legends.aerisapi.com/advisories-r7-col5-p15,5.svg";
+export declare const SEVERE_LABELS_MATCHES: string[];

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

@@ -0,0 +1,3 @@
+import "./WeatherAlertsLegend.scss";
+import { WeatherAlertsLegendInstance, WeatherAlertsLegendOptions } from "./WeatherAlertsLegend.types";
+export declare const createWeatherAlertsLegend: (options: WeatherAlertsLegendOptions) => WeatherAlertsLegendInstance;

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

@@ -0,0 +1,12 @@
+export type WeatherAlertsLegendOptions = {
+    title: string;
+    isVisible: boolean;
+    parentElement: HTMLElement;
+    accessToken: string;
+};
+export type WeatherAlertsLegendInstance = {
+    show(): void;
+    hide(): void;
+    destroy(): void;
+    getIsVisible(): boolean;
+};

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

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

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

@@ -0,0 +1,3 @@
+import "./WeatherLegend.scss";
+import { WeatherLegendInstance, WeatherLegendOptions } from "./WeatherLegend.types";
+export declare const createWeatherLegend: (parentElement: HTMLElement, options: WeatherLegendOptions) => WeatherLegendInstance;

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

@@ -0,0 +1,19 @@
+export type WeatherLegendOptions = {
+    title: string;
+    isVisible: boolean;
+    fetchLegend: () => Promise<void>;
+    renderData: () => string;
+    accessToken: string;
+};
+export type WeatherLegendInstance = {
+    show(): void;
+    hide(): void;
+    update(options: Partial<WeatherLegendOptions>): void;
+    destroy(): void;
+    getIsVisible(): boolean;
+};
+export declare enum WeatherLegendState {
+    LOADING = "loading",
+    ERROR = "error",
+    SUCCESS = "success"
+}

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

@@ -0,0 +1,2 @@
+import { UnitsFormat } from "../../../types";
+export declare const LEGEND_TEMPERATURES_URLS_PER_UNITS: Record<UnitsFormat, string>;

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

@@ -0,0 +1,3 @@
+import "./WeatherTemperaturesLegend.scss";
+import { WeatherTemperaturesLegendInstance, WeatherTemperaturesLegendOptions } from "./WeatherTemperaturesLegend.types";
+export declare const createWeatherTemperaturesLegend: (options: WeatherTemperaturesLegendOptions) => WeatherTemperaturesLegendInstance;

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

@@ -0,0 +1,15 @@
+import { UnitsFormat } from "../../../types";
+export type WeatherTemperaturesLegendOptions = {
+    title: string;
+    isVisible: boolean;
+    parentElement: HTMLElement;
+    units: UnitsFormat;
+    accessToken: string;
+};
+export type WeatherTemperaturesLegendInstance = {
+    show(): void;
+    hide(): void;
+    destroy(): void;
+    getIsVisible(): boolean;
+    updateUnits(units: UnitsFormat): void;
+};

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

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

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

@@ -0,0 +1,6 @@
+import { UnitsFormat } from "../../../types";
+export declare const LEGEND_WIND_SPEEDS_URLS_PER_UNITS: Record<UnitsFormat, string>;
+export declare const LEGEND_WIND_SPEEDS_UNITS_LABELS: {
+    imperial: string;
+    metric: string;
+};

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

@@ -0,0 +1,3 @@
+import "./WeatherWindSpeedsLegend.scss";
+import { WeatherWindSpeedsLegendInstance, WeatherWindSpeedsLegendOptions } from "./WeatherWindSpeedsLegend.types";
+export declare const createWeatherWindSpeedsLegend: (options: WeatherWindSpeedsLegendOptions) => WeatherWindSpeedsLegendInstance;

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

@@ -0,0 +1,15 @@
+import { UnitsFormat } from "../../../types";
+export type WeatherWindSpeedsLegendOptions = {
+    title: string;
+    isVisible: boolean;
+    parentElement: HTMLElement;
+    units: UnitsFormat;
+    accessToken: string;
+};
+export type WeatherWindSpeedsLegendInstance = {
+    show(): void;
+    hide(): void;
+    destroy(): void;
+    getIsVisible(): boolean;
+    updateUnits(units: UnitsFormat): void;
+};

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

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

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

@@ -0,0 +1,6 @@
+export * from "./WeatherLegend";
+export * from "./WeatherLegend.types";
+export * from "./RainSnowIceLegend";
+export * from "./WeatherTemperaturesLegend";
+export * from "./WeatherWindSpeedsLegend";
+export * from "./WeatherAlertsLegend";

package/dist/components/index.d.ts

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

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

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

package/dist/controls/index.d.ts

@@ -4,4 +4,5 @@ export * from "./createCurrentPositionControl.factory";
 export * from "./createTrafficLayerControl.factory";
 export * from "./createTruckRestrictionsLayerControl.factory";
 export * from "./createOverlayLayerControl.factory";
+export * from "./createWeatherLayerControl.factory";
 export * from "./createZoomControl.factory";

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

@@ -97,6 +97,12 @@ export type TruckRestrictionsLayerControl = BaseMapControl;
  * @interface
  */
 export type OverlayLayerControl = BaseMapControl;
+/**
+ * Weather layer control
+ * @group Map Controls
+ * @interface
+ */
+export type WeatherLayerControl = BaseMapControl;
 /**
  * Zoom control
  * @group Map Controls
@@ -128,7 +134,14 @@ export type MapControlCreators = {
      * Creates and returns an overlay layer control instance.
      * @function
      */
-    createOverlayLayerControl: (options?: BaseControlCreatorOptions) => OverlayLayerControl;
+    createOverlayLayerControl: (options?: BaseControlCreatorOptions & {
+        accessToken: string;
+    }) => OverlayLayerControl;
+    /**
+     * Creates and returns a weather layer control instance.
+     * @function
+     */
+    createWeatherLayerControl: (options?: BaseControlCreatorOptions) => WeatherLayerControl;
     /**
      * Creates and returns a zoom control instance.
      * @function

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

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

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

@@ -0,0 +1,5 @@
+import { WeatherLayer } from "../../types";
+import { WeatherLayerType } from "./weatherLayers.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

@@ -0,0 +1,12 @@
+import { WeatherLayerActions } from "../../actions/layer/types";
+import { WeatherLayerType } from "./weatherLayers.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;
+export declare const isWeatherLayerType: (value: string | null) => value is WeatherLayerType;
+export declare const fetchSvgRectAndExtractColors: (svgUrl: string) => Promise<string[]>;
+export declare const fetchSvgCircleAndExtractColorsAndLabels: (svgUrl: string, labelsMatches?: string[]) => Promise<{
+    color: string;
+    label: string;
+}[]>;
+export declare const fetchImageAsObjectUrl: (imageUrl: string) => Promise<string>;

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

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

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

@@ -0,0 +1 @@
+export type WeatherLayerType = "radar" | "alerts" | "satellite" | "roadConditions" | "temperatures" | "windSpeeds";

package/dist/createMap/errorMap/createMap.error.d.ts

@@ -3,7 +3,8 @@ import "./styles/errorMap.scss";
 type RenderErrorMapProps = {
     container: HTMLElement | string;
     onRetry(): Promise<MapInstance>;
-    error: Error;
+    error: unknown;
+    accessToken: string;
 };
-export declare const renderErrorMap: ({ container, onRetry, error }: RenderErrorMapProps) => void;
+export declare const renderErrorMap: ({ container, onRetry, error, accessToken }: RenderErrorMapProps) => void;
 export {};

package/dist/createMap/types/createMap.types.d.ts

@@ -1,6 +1,6 @@
 import { MapActions } from "../../actions/types";
 import { AttributionControl, MapControlCreators } from "../../controls/types";
-import { LonLatLike, MapBaseLayer } from "../../types";
+import { GeneralAppSettings, LonLatLike, MapBaseLayer } from "../../types";
 /**
  * Map initialization options.
  * @group Map Initialization
@@ -17,7 +17,7 @@ export type CreateMapProps = {
     accessToken: string;
     /**
      * Base Api Url
-     * @default https://proxy-nodejs.prd.milemaker.com/proxy
+     * @default https://proxy-nodejs.prd.milemaker.com
      */
     baseApiUrl?: string;
     /**
@@ -35,6 +35,11 @@ export type CreateMapProps = {
      * @default [-97.98373685376561, 35.87721419596477]
      */
     initialCenter?: LonLatLike;
+    /**
+     * General application settings
+     * @default {units: UnitsFormat.IMPERIAL}
+     */
+    generalAppSettings?: GeneralAppSettings;
     /**
      * Callback function to be called when the map is ready. It receives a MapInstance as a parameter.
      * @event

package/dist/helpers/parseStringAsJson.d.ts

@@ -1 +1 @@
-export declare const parseStringAsJson: (stg: string) => any;
+export declare const parseStringAsJson: (stg?: string | undefined) => any;