@milemaker/milemaker-js 1.0.0

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

@@ -0,0 +1,7 @@
+export * from "../types/actions.enums";
+export * from "../types/actions.types";
+export * from "../layer/types";
+export * from "../marker/types";
+export * from "../popup/types";
+export * from "../route/types";
+export * from "../zoom/types";

package/dist/actions/zoom/createZoomActions.factory.d.ts

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

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

@@ -0,0 +1,2 @@
+import { CreateActionsFactory, ZoomActions } from "../types";
+export declare const zoomActionsFactory: CreateActionsFactory<ZoomActions>;

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

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

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

@@ -0,0 +1,76 @@
+import { LonLatLike } from "../../../types";
+/**
+ * Center by coordinates options
+ * @interface
+ * @group Actions
+ * @category Zoom
+ */
+export type CenterByCoordinatesOptions = {
+    /**
+     * Zoom
+     */
+    zoom?: boolean;
+    /**
+     * Animate
+     * @default true
+     */
+    animate?: boolean;
+    /**
+     * Zoom step
+     * @default 4
+     */
+    zoomStep?: number;
+    /**
+     * Zoom value
+     */
+    zoomValue?: number;
+};
+/**
+ * Zoom actions
+ * @interface
+ * @group Actions
+ * @category Zoom
+ */
+export type ZoomActions = {
+    /**
+     * Reset camera pan
+     */
+    resetPan(options?: {
+        animate?: boolean;
+    }): void;
+    /**
+     * Zoom in by given step
+     */
+    zoomIn(step?: number): void;
+    /**
+     * Zoom in by given step
+     */
+    zoomOut(step?: number): void;
+    /**
+     * Get is disabled zoom in
+     */
+    getIsDisabledZoomIn(): boolean;
+    /**
+     * Get is disabled zoom out
+     */
+    getIsDisabledZoomOut(): boolean;
+    /**
+     * Fit into given bounds with zooming.
+     */
+    mapFlyToBounds(lonLatLikeArray: LonLatLike[], options?: {
+        /**
+         * Padding
+         * @default 100
+         */
+        padding?: number;
+        /**
+         * Animate
+         * @default true
+         */
+        animate?: boolean;
+    }): void;
+    /**
+     * centerByCoordinates
+     */
+    centerByCoordinates(lonLatLike: LonLatLike, options?: CenterByCoordinatesOptions): void;
+};

package/dist/constants/common.constants.d.ts

@@ -0,0 +1,4 @@
+import { LonLatTuple } from "../types";
+export declare const MAP_INITIAL_CENTER: LonLatTuple;
+export declare const MAP_DEFAULT_ZOOM_STEP = 4;
+export declare const MAP_INITIAL_ZOOM = 4;

package/dist/constants/index.d.ts

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

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

@@ -0,0 +1,8 @@
+export declare const CONTROL_POSITION_CLASS_MAP: {
+    "top-left": string;
+    "top-right": string;
+    "bottom-left": string;
+    "bottom-right": string;
+};
+export declare const CONTROLS_EDGE_GAP = 20;
+export declare const CONTROLS_GAP = 8;

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

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

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

@@ -0,0 +1,4 @@
+import { AttributionControl, ControlCreatorFactory } from "./types";
+export declare const createAttributionControlFactory: ControlCreatorFactory<AttributionControl, {
+    customAttribution?: string[];
+}>;

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

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

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

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

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

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

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

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

package/dist/controls/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./createAttributionControl.factory";
+export * from "./createBaseLayerControl.factory";
+export * from "./createCurrentPositionControl.factory";
+export * from "./createTrafficLayerControl.factory";
+export * from "./createZoomControl.factory";

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

@@ -0,0 +1,11 @@
+/**
+ * Control position enum
+ * @enum
+ * @group Map Controls
+ */
+export declare enum ControlPosition {
+    TOP_LEFT = "top-left",
+    TOP_RIGHT = "top-right",
+    BOTTOM_LEFT = "bottom-left",
+    BOTTOM_RIGHT = "bottom-right"
+}

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

@@ -0,0 +1,121 @@
+import MapProvider from "../../MapProvider";
+import { MapActions } from "../../actions/types";
+import { ControlPosition } from "./controls.enums";
+/**
+ * Basic map control
+ * @interface
+ * @group Map Controls
+ */
+type BaseMapControl = {
+    /**
+     * Hide map control
+     */
+    hide(): void;
+    /**
+     * Show map control
+     */
+    show(): void;
+    /**
+     * Get is map control visible
+     */
+    getIsVisible(): boolean;
+};
+/**
+ * Basic control creator factory options
+ * @group Map Controls
+ * @ignore
+ * @interface
+ */
+type BaseControlCreatorFactoryOptions = {
+    map: MapProvider.Map;
+    actions: MapActions;
+};
+/**
+ * Control creator factory
+ * @group Map Controls
+ * @ignore
+ * @typeParam {Control extends BaseMapControl} Return - A control to return
+ * @typeParam {AdditionalOptions = void} AdditionalOptions - Additional creator options
+ */
+export type ControlCreatorFactory<Control extends BaseMapControl, AdditionalOptions = void> = (props: BaseControlCreatorFactoryOptions) => (options?: BaseControlCreatorOptions & (AdditionalOptions extends void ? unknown : AdditionalOptions)) => Control;
+/**
+ * Basic control creator options
+ * @group Map Controls
+ * @interface
+ */
+type BaseControlCreatorOptions = {
+    /**
+     * Control position on a screen
+     * @default "bottom-right"
+     */
+    position?: ControlPosition;
+};
+/**
+ * Attribution control
+ * @group Map Controls
+ * @interface
+ */
+export type AttributionControl = {
+    /**
+     * Add custom attribution string
+     * @param customAttribution - Custom attribution or array of attributions to add
+     */
+    addAttribution(customAttribution: string | string[]): void;
+    /**
+     * Remove custom attribution by a string match
+     * @param customAttribution - Custom attribution to remove by string match
+     */
+    removeAttribution(customAttribution: string): void;
+} & BaseMapControl;
+/**
+ * Base layer control
+ * @group Map Controls
+ * @interface
+ */
+export type BaseLayerControl = BaseMapControl;
+/**
+ * Current position control
+ * @group Map Controls
+ * @interface
+ */
+export type CurrentPositionControl = BaseMapControl;
+/**
+ * Traffic layer control
+ * @group Map Controls
+ * @interface
+ */
+export type TrafficLayerControl = BaseMapControl;
+/**
+ * Zoom control
+ * @group Map Controls
+ * @interface
+ */
+export type ZoomControl = BaseMapControl;
+/**
+ * Map control creators
+ * @group Map Controls
+ * @interface
+ */
+export type MapControlCreators = {
+    /**
+     * Creates and returns a base layer control instance.
+     * @function
+     */
+    createBaseLayerControl: (options?: BaseControlCreatorOptions) => BaseLayerControl;
+    /**
+     * Creates and returns a traffic layer control instance.
+     * @function
+     */
+    createTrafficLayerControl: (options?: BaseControlCreatorOptions) => TrafficLayerControl;
+    /**
+     * Creates and returns a zoom control instance.
+     * @function
+     */
+    createZoomControl: (options?: BaseControlCreatorOptions) => ZoomControl;
+    /**
+     * Creates and returns a current position control instance.
+     * @function
+     */
+    createCurrentPositionControl: (options?: BaseControlCreatorOptions) => CurrentPositionControl;
+};
+export {};

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

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

package/dist/createMap/constants/createMap.constants.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULTER_MAP_MIN_ZOOM = 2.5;

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

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

package/dist/createMap/createMap.d.ts

@@ -0,0 +1,23 @@
+import "../styles/styles.scss";
+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
+ * @example
+ * How to create map instance, with default streets map style
+ * ```ts
+ * const containerElement = document.getElementById("map");
+ *
+ * if (!containerElement) {
+ *  ...
+ *  return;
+ * }
+ *
+ * const mapInstance: MapInstance = await createMap({
+ *  container: containerElement,
+ *  accessToken: "*ACCESS_TOKEN*",
+ * });
+ * ```
+ */
+export declare const createMap: ({ container, baseApiUrl, accessToken, initialZoom, initialCenter, baseLayer, onReady, onError }: CreateMapProps) => Promise<MapInstance>;

package/dist/createMap/index.d.ts

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

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

@@ -0,0 +1,67 @@
+import { MapActions } from "../../actions/types";
+import { AttributionControl, MapControlCreators } from "../../controls/types";
+import { LonLatLike, MapBaseLayer } from "../../types";
+/**
+ * Map initialization options.
+ * @group Map Initialization
+ * @interface
+ */
+export type CreateMapProps = {
+    /**
+     * Element to mount the map, or element id
+     */
+    container: HTMLElement | string;
+    /**
+     * Access token
+     */
+    accessToken: string;
+    /**
+     * Base Api Url
+     * @default https://localhost/proxy
+     */
+    baseApiUrl?: string;
+    /**
+     * Base layer token
+     * @default MapBaseLayer.STREETS
+     */
+    baseLayer?: MapBaseLayer;
+    /**
+     * Map initial zoom
+     * @default 4
+     */
+    initialZoom?: number;
+    /**
+     * Map initial zoom
+     * @default [-97.98373685376561, 35.87721419596477]
+     */
+    initialCenter?: LonLatLike;
+    /**
+     * Callback function to be called when the map is ready. It receives a MapInstance as a parameter.
+     * @event
+     */
+    onReady?(result: MapInstance): void;
+    /**
+     * Callback function to be called when an error occurs. It receives an Error as a parameter.
+     * @event
+     */
+    onError?(error: Error): void;
+};
+/**
+ * Map instance.
+ * @group Map Initialization
+ * @interface
+ */
+export type MapInstance = {
+    /**
+     * The attribution control instance.
+     */
+    attributionControl: AttributionControl;
+    /**
+     * The map control creators.
+     */
+    controls: MapControlCreators;
+    /**
+     * The map actions.
+     */
+    actions: MapActions;
+};

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

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

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

@@ -0,0 +1,7 @@
+import { LonLatTuple } from "../types";
+/**
+ * Decode a polyline string with precision 6
+ * @group Helpers
+ * @param str - A shape polyline string to decode
+ */
+export declare const decodeRoutePolylineString: (str: string[]) => LonLatTuple[];

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

@@ -0,0 +1 @@
+export declare const generateUuid: () => string;

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

@@ -0,0 +1,6 @@
+import MapProvider from "../MapProvider";
+import { ControlPosition } from "../controls/types";
+export declare const getControlAbsolutePosition: ({ map, position }: {
+    map: MapProvider.Map;
+    position: ControlPosition;
+}) => string;

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

@@ -0,0 +1,8 @@
+import { LonLatLike } from "../types";
+/**
+ * Parse a {@link LonLatLike} to {@link Coordinates}
+ * @group Helpers
+ * @param initialCoordinates - {@link LonLatLike} object to be parsed
+ * @param targetCoordinates - {@link LonLatLike} object to be parsed
+ */
+export declare function getDistanceBetweenPoints(initialCoordinates: LonLatLike, targetCoordinates: LonLatLike): number;

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

@@ -0,0 +1,5 @@
+/**
+ * Check is browser is supported
+ * @group Helpers
+ */
+export declare const getIsSupported: () => boolean;

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

@@ -0,0 +1,7 @@
+import { LonLatLike } from "../types";
+export declare const getMapFlyToAnimationDuration: ({ initialPixelCoordinates, targetPixelCoordinates, initialZoom, targetZoom }: {
+    initialPixelCoordinates: LonLatLike;
+    targetPixelCoordinates: LonLatLike;
+    initialZoom?: number | undefined;
+    targetZoom?: number | undefined;
+}) => number;

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

@@ -0,0 +1,14 @@
+import { CenterByCoordinatesOptions, LonLatTuple } from "../types";
+export declare const getMapFlyToOptions: ({ currentZoom, targetLonLatLike, transformLonLatToPoint, currentCenter, animate, zoom, zoomValue, zoomStep }: {
+    currentCenter: LonLatTuple;
+    targetLonLatLike: LonLatTuple;
+    currentZoom: number;
+    transformLonLatToPoint(lonLatLike: LonLatTuple): {
+        x: number;
+        y: number;
+    } & object;
+} & CenterByCoordinatesOptions) => {
+    zoom: number;
+    duration: number;
+    animate: boolean;
+};

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

@@ -0,0 +1,9 @@
+declare const TIME_IN_MILLISECONDS: {
+    millisecond: number;
+    second: number;
+    minute: number;
+    hour: number;
+    day: number;
+};
+export declare const getNumberOfTimeUnites: (number: number, unit: keyof typeof TIME_IN_MILLISECONDS, inUnit?: keyof typeof TIME_IN_MILLISECONDS | undefined) => number;
+export {};

package/dist/helpers/htmlRender.d.ts

@@ -0,0 +1,29 @@
+type StateItem<T> = {
+    getValue: () => T;
+    setValue: (value: T | ((current: T) => T)) => void;
+};
+type Props<State extends Record<string, unknown> = Record<string, unknown>> = {
+    elementId: string;
+    parentElement: HTMLElement;
+    className?: string;
+    style?: string;
+    state?: State;
+    render(state: {
+        [Key in keyof State]: State[Key];
+    }): string;
+    onmount?(): (() => void) | void;
+    listeners?: Record<string, Record<`on${keyof GlobalEventHandlersEventMap}` | string, (events: Event) => void>>;
+};
+type Returns<State extends Record<string, unknown> = Record<string, unknown>> = {
+    render(): void;
+    unmount(): void;
+    mount(): void;
+    state: {
+        [Key in keyof State]: StateItem<State[Key]>;
+    };
+    mountedElementRef: {
+        current: HTMLElement | null;
+    };
+};
+export declare const htmlRender: <State extends Record<string, unknown> = Record<string, unknown>>({ elementId, parentElement, className, style, onmount, listeners, state: initialState, render: renderProp }: Props<State>) => Returns<State>;
+export {};

package/dist/helpers/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./decodeRoutePolylineString.helper";
+export * from "./parseLonLatLikeToCoordinates.helper";
+export * from "./parseLonLatLikeToTuple.helper";
+export * from "./replaceMatchInSvg.helper";
+export * from "./getIsSupported.helper";

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

@@ -0,0 +1,7 @@
+export declare const injectHtmlElement: ({ id, parentElement, htmlContent, className, style }: {
+    id: string;
+    parentElement: HTMLElement;
+    htmlContent: string;
+    className?: string | undefined;
+    style?: string | undefined;
+}) => HTMLElement;

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

@@ -0,0 +1,7 @@
+import { Coordinates, LonLatLike } from "../types";
+/**
+ * Parse a {@link LonLatLike} to {@link Coordinates}
+ * @group Helpers
+ * @param lonLatLike - {@link LonLatLike} object to be parsed
+ */
+export declare const parseLonLatLikeToCoordinates: (lonLatLike: LonLatLike) => Coordinates;

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

@@ -0,0 +1,7 @@
+import { LonLatLike, LonLatTuple } from "../types";
+/**
+ * Parse a {@link LonLatLike} to {@link LonLatTuple}
+ * @group Helpers
+ * @param lonLatLike - {@link LonLatLike} object to be parsed
+ */
+export declare const parseLonLatLikeToTuple: (lonLatLike: LonLatLike) => LonLatTuple;

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

@@ -0,0 +1,16 @@
+/**
+ * Replace a match in svg string
+ * @group Helpers
+ * @example
+ * ```ts
+ * replaceMatch({ searchValue: /{fill}/g, value: color, stringSvg });
+ * ```
+ * @param searchValue - Search to replace
+ * @param value - Value to be placed
+ * @param stringSvg - Svg string
+ */
+export declare function replaceMatchInSvg({ searchValue, stringSvg, value }: {
+    searchValue: RegExp;
+    stringSvg: string;
+    value: number | string;
+}): string;