@milemaker/milemaker-js 1.0.0

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

@@ -0,0 +1,14 @@
+import { MapBaseLayer } from "../../types";
+export declare const DEFAULT_BASE_LAYER = MapBaseLayer.STREETS;
+export declare const DEFAULT_BASE_API_URL = "https://proxy-nodejs.dev.milemaker.com/proxy";
+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;
+export declare const MAP_DEFAULT_POLYLINE_STROKE_OPACITY = 1;
+export declare const NMAPS_TRAFFIC_PREFIX = "traffic";
+export declare const NMAPS_TRAFFIC_SOURCE_NAME = "ndrive-traffic";
+export declare const NMAPS_LAYOUT_PROPERTY_VISIBILITY_KEY = "visibility";
+export declare const NMAPSLAYOUT_PROPERTY_VISIBILITY_VALUES: {
+    visible: string;
+    none: string;
+};

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

@@ -0,0 +1 @@
+export * from "./actions.constants";

package/dist/actions/index.d.ts

@@ -0,0 +1,10 @@
+import { MapBaseLayer } from "../types";
+import { CreateActionsFactory, MapActions } from "./types";
+export * from "./zoom";
+export * from "./layer";
+export * from "./layer";
+export * from "./marker";
+export * from "./popup";
+export declare const createMapActionFactory: CreateActionsFactory<MapActions, {
+    defaultBaseLayer?: MapBaseLayer;
+}>;

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

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

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

@@ -0,0 +1,6 @@
+import { MapBaseLayer } from "../../types";
+import { CreateActionsFactory } from "../types";
+import { MapLayerActions } from "./types";
+export declare const layerActionsFactory: CreateActionsFactory<MapLayerActions, {
+    defaultBaseLayer?: MapBaseLayer;
+}>;

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

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

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

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

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

@@ -0,0 +1,62 @@
+import { MapBaseLayer } from "../../../types";
+/**
+ * Base layer actions
+ * @interface
+ * @group Actions
+ * @category Layers
+ */
+export type BaseLayerActions = {
+    /**
+     * Change current base layer
+     * @param baseLayer - Base layer to set
+     */
+    changeBaseLayer(baseLayer: MapBaseLayer): void;
+    /**
+     * Get current base layer
+     */
+    getCurrentBaseLayer(): MapBaseLayer;
+    /**
+     * Get is given base layer currently visible
+     */
+    getIsVisibleBaseLayer(baseLayer: MapBaseLayer): boolean;
+};
+/**
+ * Traffic layer actions
+ * @interface
+ * @group Actions
+ * @category Layers
+ */
+export type TrafficLayerActions = {
+    /**
+     * Show traffic layer
+     */
+    showTrafficLayer(): void;
+    /**
+     * Hide traffic layer
+     */
+    hideTrafficLayer(): void;
+    /**
+     * Get is traffic layer visible
+     */
+    getIsVisibleTrafficLayer(): boolean;
+    /**
+     * Toggle traffic layer visibility
+     */
+    toggle(): void;
+};
+/**
+ * Map layer actions
+ * @interface
+ * @group Actions
+ * @category Layers
+ */
+export type MapLayerActions = {
+    /**
+     * Base layer actions
+     */
+    baseLayerActions: BaseLayerActions;
+    /**
+     * Traffic layer actions
+     */
+    trafficLayerActions: TrafficLayerActions;
+};

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

@@ -0,0 +1,2 @@
+import { CreateActionsFactory, MarkerActions } from "../types";
+export declare const createMarkerActionFactory: CreateActionsFactory<MarkerActions["createMarker"]>;

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

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { MarkerActions } from "./types";
+export declare const createRouteStopMarkerActionFactory: CreateActionsFactory<MarkerActions["createStopMarker"]>;

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

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { MarkerActions } from "./types";
+export declare const createRouteStopMarkersActionFactory: CreateActionsFactory<MarkerActions["createStopMarkers"]>;

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

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

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

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

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

@@ -0,0 +1,217 @@
+import MapProvider from "../../../MapProvider";
+import { LonLatLike, Popup } from "../../../types";
+import { CreatePopupOptions, MapElement } from "../../types";
+/**
+ * Marker instance
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type Marker = {
+    /**
+     * Move marker to given coordinate
+     * @param lonLatLike - Coordinate to move marker
+     */
+    moveMarker(lonLatLike: LonLatLike): void;
+    /**
+     * Get marker's coordinate
+     */
+    getLonLatLike(): LonLatLike;
+    /**
+     * Get marker's element
+     */
+    getHtmlElement(): HTMLElement | undefined;
+    /**
+     * Set marker html icon
+     * @example
+     * ```ts
+     * const element = document.createElement("div");
+     * element.innerText = "Hello World!"
+     * marker.setHtmlIconElement(() => ({htmlElement: element}));
+     * ```
+     * @param getHtmlIconElement
+     */
+    setHtmlIconElement(
+    /**
+     * Callback function to set marker's element, with additional events
+     * @param marker - Marker's instance
+     */
+    getHtmlIconElement: (marker: Marker) => {
+        /**
+         * Element which marker will be using
+         */
+        htmlElement: HTMLElement;
+        /**
+         * Callback which is triggered when the marker is unmounted
+         * @event
+         */
+        onUnmount?: () => void;
+        /**
+         * Callback which is triggered when the marker is mounted
+         * @param marker - Marker instance
+         * @event
+         */
+        onMount?: (marker: Marker) => void;
+    }): Marker | undefined;
+    /**
+     * Marker popup
+     */
+    popup?: Popup;
+} & MapElement;
+/**
+ * Multiple markers instance
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type Markers = MapElement & {
+    markers: Marker[];
+};
+/**
+ * Marker's popup options
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type MarkerPopupOptions = {
+    /**
+     * Do toggle marker on click
+     */
+    toggleOnMarkerClick?: boolean;
+} & CreatePopupOptions;
+/**
+ * Create marker options
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type CreateMarkerOptions = {
+    /**
+     * Do show marker when created
+     * @default true
+     */
+    showOnMount?: boolean;
+    /**
+     * Do center on click
+     */
+    centerOnClick?: boolean;
+    /**
+     * Marker's popup options
+     */
+    popupOptions?: MarkerPopupOptions;
+    /**
+     * Function to set marker's element, with additional events
+     * @example
+     * ```ts
+     * const element = document.createElement("div");
+     * element.innerText = "Hello World!"
+     * map.actions.createMarker({
+     *  ...,
+     *  getHtmlIconElement: () => ({htmlElement: element})
+     * });
+     * ```
+     * @param marker - Marker's instance
+     */
+    getHtmlIconElement?(marker: Marker): {
+        /**
+         * Element which marker will be using
+         */
+        htmlElement: HTMLElement;
+        /**
+         * Callback which is triggered when the marker is unmounted
+         * @event
+         */
+        onUnmount?: () => void;
+        /**
+         * Callback which is triggered when the marker is mounted
+         * @param marker- Marker instance
+         * @event
+         */
+        onMount?: (marker: Marker) => void;
+    };
+    /**
+     * Event triggered when clicked on marker
+     * @event
+     */
+    onClick?(): void;
+    /**
+     * Event triggered when hovered the marker
+     * @event
+     */
+    onHover?(): {
+        /**
+         * Event triggered when mouse left the marker
+         * @event
+         */
+        onMouseLeave?(): void;
+    } | void;
+} & Omit<MapProvider.MarkerOptions, "element">;
+/**
+ * Create stop marker options with predefined icon, and color.
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type CreateStopMarkerOptions = {
+    /**
+     * Marker's color
+     */
+    color?: string;
+    /**
+     * Index of a stop
+     */
+    index: number;
+    /**
+     * Count of all stops in a route
+     */
+    length: number;
+} & CreateMarkerOptions;
+/**
+ * Markers popup options
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type MarkersPopupOptions = Pick<MarkerPopupOptions, "toggleOnMarkerClick" | "showOnMount" | "hideOnClickOutside">;
+/**
+ * Create stop markers options
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type CreateStopMarkersOptions = Pick<CreateMarkerOptions, "color" | "showOnMount" | "centerOnClick"> & {
+    /**
+     * Marker's popup options
+     */
+    popupOptions?: MarkersPopupOptions;
+    /**
+     * Callback to set every marker option individually
+     */
+    getMarkerOptions?: (item: LonLatLike, index: number, array: LonLatLike[]) => Partial<CreateStopMarkerOptions>;
+};
+/**
+ * Marker actions
+ * @interface
+ * @group Actions
+ * @category Marker
+ */
+export type MarkerActions = {
+    /**
+     * Create marker
+     * @param lonLatLike - Marker's coordinate to create
+     * @param options - Options to set
+     */
+    createMarker(lonLatLike: LonLatLike, options?: CreateMarkerOptions): Marker;
+    /**
+     * Create stop marker
+     * @param lonLatLike - Marker's coordinate to create
+     * @param options - Options to set
+     */
+    createStopMarker(lonLatLike: LonLatLike, options: CreateStopMarkerOptions): Marker;
+    /**
+     * Create markers
+     * @param stops - Markers coordinates to create
+     * @param options - Options to set
+     */
+    createStopMarkers(stops: LonLatLike[], options?: CreateStopMarkersOptions): Markers;
+};

package/dist/actions/popup/createPopupAction.factory.d.ts

@@ -0,0 +1,4 @@
+import { CreateActionsFactory } from "../types";
+import "./styles/popup.scss";
+import { PopupActions } from "./types";
+export declare const createPopupActionFactory: CreateActionsFactory<PopupActions["createPopup"]>;

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

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { PopupActions } from "./types";
+export declare const popupActionsFactory: CreateActionsFactory<PopupActions>;

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

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

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

@@ -0,0 +1,128 @@
+import MapProvider from "../../../MapProvider";
+import { LonLatLike } from "../../../types";
+import { MapElement, Marker } from "../../types";
+/**
+ * Popup instance
+ * @interface
+ * @group Actions
+ * @category Popup
+ */
+export type Popup = {
+    /**
+     * Move popup to given coordinate
+     * @param lonLatLike - Coordinate to move popup
+     */
+    movePopup(lonLatLike: LonLatLike): void;
+    /**
+     * Get popup's coordinate
+     */
+    getLonLatLike(): LonLatLike;
+    /**
+     * Get popup's element
+     */
+    getHtmlElement(): HTMLElement | undefined;
+    /**
+     * Set popup html content
+     * @example
+     * ```ts
+     * const element = document.createElement("div");
+     * element.innerText = "Hello World!"
+     * popup.setHtmlIconElement(() => ({htmlElement: element}));
+     * ```
+     */
+    setHtmlContentElement(
+    /**
+     * Callback function to set popup's element, with additional events
+     * @param Popup's instance
+     */
+    getHtmlContentElementCb: (popup: Popup) => {
+        /**
+         * Element which popup will be using as content
+         */
+        htmlElement: HTMLElement;
+        /**
+         * Callback which is triggered when the popup is unmounted
+         * @event
+         */
+        onUnmount?: () => void;
+        /**
+         * Callback which is triggered when the popup is mounted
+         * @param popup - Popup instance
+         * @event
+         */
+        onMount?: (popup: Popup) => void;
+    }): Popup | undefined;
+    /**
+     * Toggle popup visibility
+     */
+    toggle(): void;
+} & MapElement;
+/**
+ * Create popup options
+ * @interface
+ * @group Actions
+ * @category Popup
+ */
+export type CreatePopupOptions = {
+    /**
+     * If is created using {@link Marker}, will have marker instance.
+     */
+    marker?: Marker;
+    /**
+     * Do show popup when created
+     * @default true
+     */
+    showOnMount?: boolean;
+    /**
+     * Popup y-offset from the coordinate
+     */
+    offset?: number;
+    /**
+     * Hide popup when clicked an outside popup element
+     */
+    hideOnClickOutside?: boolean;
+    /**
+     * Set popup html content
+     * @example
+     * ```ts
+     * const element = document.createElement("div");
+     * element.innerText = "Hello World!"
+     * map.actions.createPopup({
+     *  ...,
+     *  getHtmlContentElement: () => ({htmlElement: element})
+     * });
+     * ```
+     * @param popup - Popup's instance
+     */
+    getHtmlContentElement?(popup: Popup): {
+        /**
+         * Element which popup will be using as content
+         */
+        htmlElement: HTMLElement;
+        /**
+         * Callback which is triggered when the popup is unmounted
+         * @event
+         */
+        onUnmount?(): void;
+        /**
+         * Callback which is triggered when the popup is mounted
+         * @param popup - Popup instance
+         * @event
+         */
+        onMount?(popup: Popup): void;
+    };
+} & MapProvider.PopupOptions;
+/**
+ * Popup actions
+ * @interface
+ * @group Actions
+ * @category Popup
+ */
+export type PopupActions = {
+    /**
+     * Create popup
+     * @param lonLatLike - Popup's coordinate to create
+     * @param options - Options to set
+     */
+    createPopup(lonLatLike: LonLatLike, options?: CreatePopupOptions): Popup;
+};

package/dist/actions/route/createRouteAction.factory.d.ts

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { RouteActions } from "./types";
+export declare const createRouteActionFactory: CreateActionsFactory<RouteActions["createRoute"]>;

package/dist/actions/route/createShapeAction.factory.d.ts

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { RouteActions } from "./types";
+export declare const createShapeActionFactory: CreateActionsFactory<RouteActions["createShape"]>;

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

@@ -0,0 +1,3 @@
+import { CreateActionsFactory } from "../types";
+import { RouteActions } from "./types";
+export declare const routeActionsFactory: CreateActionsFactory<RouteActions>;

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

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

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

@@ -0,0 +1,96 @@
+import { LonLatLike } from "../../../types";
+import { Markers } from "../../marker/types";
+import { CreateStopMarkersOptions, MapElement } from "../../types";
+/**
+ * Route instance
+ * @interface
+ * @group Actions
+ * @category Route
+ */
+export type Route = {
+    /**
+     * Route shape instance
+     */
+    shape: Shape;
+    /**
+     * Route markers instance
+     */
+    markers: Markers;
+} & MapElement;
+/**
+ * Shape instance
+ * @interface
+ * @group Actions
+ * @category Route
+ */
+export type Shape = {
+    /**
+     * Get shape's LonLatLike as an array
+     */
+    getLonLatLikes(): LonLatLike[];
+} & MapElement;
+/**
+ * Create shape options
+ * @interface
+ * @group Actions
+ * @category Route
+ */
+export type CreateShapeOptions = {
+    /**
+     * Do show shape when created
+     * @default true
+     */
+    showOnMount?: boolean;
+    /**
+     * Shape's color
+     */
+    color?: string;
+    /**
+     * Shape's opacity
+     */
+    opacity?: number;
+    /**
+     * Shape's stroke weight
+     */
+    weight?: number;
+};
+/**
+ * Create route options
+ * @interface
+ * @group Actions
+ * @category Route
+ */
+export type CreateRouteOptions = {
+    /**
+     * Do show route when created
+     * @default true
+     */
+    showOnMount?: boolean;
+    /**
+     * Shape options
+     */
+    shapeOptions?: CreateShapeOptions;
+    /**
+     * Stop markers options
+     */
+    stopMarkersOptions?: CreateStopMarkersOptions;
+};
+/**
+ * Route actions
+ * @interface
+ * @group Actions
+ * @category Route
+ */
+export type RouteActions = {
+    /**
+     * Create route
+     */
+    createRoute(props: {
+        shapes: string[] | LonLatLike[];
+        stops: LonLatLike[];
+    }, options?: CreateRouteOptions): Route;
+    /**
+     * Create shape
+     */
+    createShape(shape: string[] | LonLatLike[], options?: CreateShapeOptions): Shape;
+};

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

@@ -0,0 +1,11 @@
+export declare enum GeoJsonType {
+    FEATURE = "Feature"
+}
+export declare enum GeoJsonGeometryType {
+    LINE_STRING = "LineString"
+}
+export declare enum CursorType {
+    NONE = "",
+    POINTER = "pointer",
+    GRABBING = "grabbing"
+}

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

@@ -0,0 +1,60 @@
+import MapProvider from "../../MapProvider";
+import { MapLayerActions } from "../layer/types";
+import { MarkerActions } from "../marker/types";
+import { PopupActions } from "../popup/types";
+import { RouteActions } from "../route/types";
+import { ZoomActions } from "../zoom/types";
+/**
+ * Basic map element
+ * @group Common
+ * @category Abstract Instances
+ * @interface
+ */
+export type MapElement = {
+    /**
+     * Center map camera
+     */
+    center(): void;
+    /**
+     * Fit into an element bound with zooming.
+     * For coordinate items works the same as center but zooming.
+     * But for elements like shapes will fit it into screen bounds.
+     */
+    fitIntoBounds(): void;
+    /**
+     * Hides map element
+     */
+    hide(): void;
+    /**
+     * Shows map Element
+     */
+    show(): void;
+    /**
+     * Get is map element visible
+     */
+    getIsVisible(): boolean;
+};
+/**
+ * Base action factory props
+ * @interface
+ * @ignore
+ * @group Actions
+ */
+type BaseActionFactoryProps = {
+    map: MapProvider.Map;
+};
+/**
+ * Base action factory props
+ * @interface
+ * @group Actions
+ * @typeParam {Return} Return - An actions to return
+ * @typeParam {AdditionalOptions = void} AdditionalOptions - Additional actions options
+ * @ignore
+ */
+export type CreateActionsFactory<Return, AdditionalOptions = void> = (options: BaseActionFactoryProps & (AdditionalOptions extends void ? unknown : AdditionalOptions)) => Return;
+/**
+ * @interface
+ * @group Actions
+ */
+export type MapActions = ZoomActions & MapLayerActions & MarkerActions & PopupActions & RouteActions;
+export {};