@mapcomponents/react-maplibre 0.1.48 → 0.1.52

package/dist/components/MapLibreMap/MapLibreMap.d.ts

@@ -0,0 +1,31 @@
+import { FC } from "react";
+import { MapOptions as MapOptionsType } from "maplibre-gl";
+import "maplibre-gl/dist/maplibre-gl.css";
+declare type MapLibreMapProps = {
+    /**
+     * Id of the MapLibreGl(Wrapper) instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Config object that is passed to the MapLibreGl constructor as first parameter.
+     * See https://maplibre.org/maplibre-gl-js-docs/api/map/ for a formal documentation of al
+     * available properties.
+     */
+    options?: Partial<MapOptionsType>;
+    /**
+     * css style definition passed to the map container DOM element
+     */
+    style?: object;
+};
+/**
+ * Creates a MapLibreGlWrapper instance and registers it in MapContext
+ * after the MapLibre-gl load event has fired.
+ *
+ * MapLibreMap returns the html node that will be used by MapLibre-gl to render the map.
+ * This Component must be kept unaware of any related components that interact with the MapLibre-gl
+ * instance.
+ *
+ * @category Map components
+ */
+declare const MapLibreMap: FC<MapLibreMapProps>;
+export default MapLibreMap;

package/dist/components/MapLibreMap/MapLibreMap.stories.d.ts

@@ -0,0 +1,15 @@
+export default storyoptions;
+export const ExampleConfig: any;
+export const StyleChangeConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MapLibreMap as component };
+    export namespace argTypes {
+        namespace options {
+            namespace control {
+                const type: string;
+            }
+        }
+    }
+}
+import MapLibreMap from "./MapLibreMap";

package/dist/components/MapLibreMap/MapLibreMap.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MapLibreMap/lib/MapLibreGlWrapper.d.ts

@@ -0,0 +1,76 @@
+import { IControl, MapOptions as MapOptionsType } from "!maplibre-gl";
+import { Map as MapType } from "maplibre-gl";
+declare type EventArgArray = [string, string | Function, Function?];
+declare type LayerState = {
+    id: string;
+    type: string;
+    visible: boolean;
+    baseLayer: boolean;
+};
+declare type ViewportState = {
+    center: {
+        lng: number;
+        lat: number;
+    };
+    zoom: number;
+    bearing: number;
+    pitch: number;
+};
+/**
+ * Creates a MapLibre-gl-js instance and offers all of the native MapLibre functions and properties as well as additional functionality such as element registration & cleanup and more events.
+ *
+ * @param {object} props
+ *
+ * @class
+ */
+declare class MapLibreGlWrapper {
+    registeredElements: {
+        [key: string]: {
+            layers: [string?];
+            sources: [string?];
+            images: [string?];
+            controls: [IControl?];
+            events: [EventArgArray?];
+            wrapperEvents: [EventArgArray?];
+        };
+    };
+    baseLayers: [string?];
+    firstSymbolLayer: string | undefined;
+    eventHandlers: {
+        layerchange: [Function?];
+        viewportchange: [Function?];
+    };
+    wrapper: {
+        on: Function;
+        off: Function;
+        fire: Function;
+        layerState: [LayerState?];
+        layerStateString: string;
+        oldLayerStateStrings: object;
+        buildLayerObject: Function;
+        buildLayerObjects: Function;
+        refreshLayerState: Function;
+        viewportState: ViewportState;
+        viewportStateString: string;
+        oldViewportStateString: string;
+        getViewport: Function;
+        refreshViewport: Function;
+    };
+    initRegisteredElements: Function;
+    addNativeMaplibreFunctionsAndProps: Function;
+    map: MapType;
+    style: object;
+    styleJson: object;
+    addLayer: Function;
+    addSource: Function;
+    addControl: Function;
+    addImage: Function;
+    on: Function;
+    cleanup: Function;
+    constructor(props: {
+        mapOptions: MapOptionsType;
+        onReady: Function;
+    });
+}
+export default MapLibreGlWrapper;
+export type { LayerState, ViewportState };

package/dist/components/MapLibreMap/lib/MapLibreGlWrapper.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlBasicComponent.d.ts

@@ -0,0 +1,5 @@
+export default MlBasicComponent;
+/**
+ * This component is deprecated and will be removed in the next major release
+ */
+declare function MlBasicComponent(props: any): JSX.Element;

package/dist/components/MlCenterPosition/MlCenterPosition.d.ts

@@ -0,0 +1,50 @@
+interface MlCenterPositionProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Active button font color
+     */
+    onColor?: string;
+    /**
+     * Inactive button font color
+     */
+    offColor?: string;
+    /**
+     * CSS style object that is applied to the button component
+     */
+    style?: any;
+}
+/**
+ * Component template
+ *
+ */
+declare const MlCenterPosition: {
+    (props: MlCenterPositionProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+        style: {
+            minWidth: string;
+            minHeight: string;
+            width: string;
+            height: string;
+            backgroundColor: string;
+            borderRadius: string;
+            margin: number;
+            fontSize: string;
+            ":hover": {
+                backgroundColor: string;
+                color: string;
+            };
+        };
+        onColor: string;
+        offColor: string;
+    };
+};
+export default MlCenterPosition;

package/dist/components/MlCenterPosition/MlCenterPosition.stories.d.ts

@@ -0,0 +1,17 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlCenterPosition as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+    export namespace parameters {
+        namespace docs {
+            namespace source {
+                const type: string;
+            }
+        }
+    }
+}
+import MlCenterPosition from "./MlCenterPosition";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlComponentTemplate/MlComponentTemplate.d.ts

@@ -0,0 +1,22 @@
+interface MlComponentTemplateProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     */
+    insertBeforeLayer?: string;
+}
+/**
+ * Component template
+ *
+ */
+declare const MlComponentTemplate: {
+    (props: MlComponentTemplateProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+    };
+};
+export default MlComponentTemplate;

package/dist/components/MlComponentTemplate/MlComponentTemplate.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlComponentTemplate as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlComponentTemplate from "./MlComponentTemplate";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlCreatePdfButton/MlCreatePdfButton.d.ts

@@ -0,0 +1,21 @@
+interface MlCreatePdfButtonProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     */
+    insertBeforeLayer?: string;
+}
+/**
+ * Renders a button that will create a PDF version of the current map view (dimensions adjusted to fit Din A4 Paper).
+ */
+declare const MlCreatePdfButton: {
+    (props: MlCreatePdfButtonProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+    };
+};
+export default MlCreatePdfButton;

package/dist/components/MlCreatePdfButton/MlCreatePdfButton.stories.d.ts

@@ -0,0 +1,10 @@
+export default storyoptions;
+export const ExampleConfig: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlCreatePdfButton as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlCreatePdfButton from "./MlCreatePdfButton";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlCreatePdfButton/lib/createPdf.d.ts

@@ -0,0 +1,2 @@
+declare const createPdf: Function;
+export default createPdf;

package/dist/components/MlCreatePdfButton/lib/nominatimMap.d.ts

@@ -0,0 +1,2 @@
+declare const nmConverter: Function;
+export default nmConverter;

package/dist/components/MlFeatureEditor/MlFeatureEditor.d.ts

@@ -0,0 +1,35 @@
+import "./MlFeatureEditor.css";
+import "@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css";
+interface MlFeatureEditorProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance to help specify the layer order
+     * This layer will be visually beneath the layer with the "insertBeforeLayer" id.
+     */
+    insertBeforeLayer?: string;
+    /**
+     * Input GeoJson data at initialization
+     */
+    geojson?: any;
+    /**
+     * Callback function that is called each time the GeoJson data within has changed within MlFeatureEditor.
+     * First parameter is the new GeoJson feature.
+     */
+    onChange?: Function;
+    /**
+     * Feature editor mode:
+     * - "custom_select" edit features
+     * - "custom_polygon" draw Polygon
+     * - "draw_point" draw Point
+     * - "draw_line_string" draw LineString
+     */
+    mode?: string;
+}
+/**
+ * GeoJson Feature editor that allows to create or manipulate GeoJson data
+ */
+declare const MlFeatureEditor: (props: MlFeatureEditorProps) => JSX.Element;
+export default MlFeatureEditor;

package/dist/components/MlFeatureEditor/MlFeatureEditor.stories.d.ts

@@ -0,0 +1,15 @@
+export default storyoptions;
+export const EditPolygon: any;
+export const EditPoint: any;
+export const EditLineString: any;
+export const DrawPolygon: any;
+export const DrawPoint: any;
+export const DrawLineString: any;
+declare namespace storyoptions {
+    export const title: string;
+    export { MlFeatureEditor as component };
+    export const argTypes: {};
+    export { mapContextDecorator as decorators };
+}
+import MlFeatureEditor from "./MlFeatureEditor";
+import mapContextDecorator from "../../decorators/MapContextDecorator";

package/dist/components/MlFeatureEditor/MlFeatureEditor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/MlFeatureEditor/custom-direct-select-mode.d.ts

@@ -0,0 +1,37 @@
+export default DirectSelect;
+declare namespace DirectSelect {
+    function fireUpdate(): void;
+    function fireActionable(state: any): void;
+    function startDragging(state: any, e: any): void;
+    function stopDragging(state: any): void;
+    function onVertex(state: any, e: any): void;
+    function onMidpoint(state: any, e: any): void;
+    function pathsToCoordinates(featureId: any, paths: any): any;
+    function onFeature(state: any, e: any): void;
+    function dragFeature(state: any, e: any, delta: any): void;
+    function dragVertex(state: any, e: any, delta: any): void;
+    function clickNoTarget(): void;
+    function clickInactive(): void;
+    function clickActiveFeature(state: any): void;
+    function onSetup(opts: any): {
+        featureId: any;
+        feature: any;
+        dragMoveLocation: any;
+        dragMoving: boolean;
+        canDragMove: boolean;
+        selectedCoordPaths: any[];
+        groupMove_vertices: any;
+    };
+    function onStop(): void;
+    function toDisplayFeatures(state: any, geojson: any, push: any): void;
+    function onTrash(state: any): void;
+    function onMouseMove(state: any, e: any): void;
+    function onMouseOut(state: any): void;
+    function onTouchStart(state: any, e: any): void;
+    function onMouseDown(state: any, e: any): void;
+    function onDrag(state: any, e: any): void;
+    function onClick(state: any, e: any): void;
+    function onTap(state: any, e: any): void;
+    function onTouchEnd(state: any): void;
+    function onMouseUp(state: any): void;
+}

package/dist/components/MlFeatureEditor/custom-polygon-mode.d.ts

@@ -0,0 +1,16 @@
+export default CustomPolygonMode;
+declare namespace CustomPolygonMode {
+    function onSetup(): {
+        polygon: any;
+        currentVertexPosition: number;
+    };
+    function clickAnywhere(state: any, e: any): any;
+    function clickOnVertex(state: any): any;
+    function onMouseMove(state: any, e: any): void;
+    function onTap(state: any, e: any): any;
+    function onClick(state: any, e: any): any;
+    function onKeyUp(state: any, e: any): void;
+    function onStop(state: any): void;
+    function toDisplayFeatures(state: any, geojson: any, display: any): any;
+    function onTrash(state: any): void;
+}

package/dist/components/MlFeatureEditor/custom-select-mode.d.ts

@@ -0,0 +1,37 @@
+export default CustomSelectMode;
+declare namespace CustomSelectMode {
+    function onSetup(opts: any): {
+        dragMoveLocation: null;
+        boxSelectStartLocation: null;
+        boxSelectElement: undefined;
+        boxSelecting: boolean;
+        canBoxSelect: boolean;
+        dragMoving: boolean;
+        canDragMove: boolean;
+        initiallySelectedFeatureIds: any;
+    };
+    function fireUpdate(): void;
+    function fireActionable(): void;
+    function getUniqueIds(allFeatures: any): any;
+    function stopExtendedInteractions(state: any): void;
+    function onStop(): void;
+    function onMouseMove(state: any): void;
+    function onMouseOut(state: any): void;
+    function onTap(state: any, e: any): any;
+    function onClick(state: any, e: any): any;
+    function clickAnywhere(state: any): void;
+    function clickOnVertex(state: any, e: any): void;
+    function startOnActiveFeature(state: any, e: any): void;
+    function clickOnFeature(state: any, e: any): any;
+    function onMouseDown(state: any, e: any): void;
+    function startBoxSelect(state: any, e: any): void;
+    function onTouchStart(state: any, e: any): void;
+    function onDrag(state: any, e: any): void;
+    function whileBoxSelect(state: any, e: any): void;
+    function dragMove(state: any, e: any): void;
+    function onMouseUp(state: any, e: any): void;
+    function toDisplayFeatures(state: any, geojson: any, display: any): void;
+    function onTrash(): void;
+    function onCombineFeatures(): void;
+    function onUncombineFeatures(): void;
+}

package/dist/components/MlFeatureEditor/lib/common_selectors.d.ts

@@ -0,0 +1,11 @@
+export function isOfMetaType(type: any): (e: any) => boolean;
+export function isShiftMousedown(e: any): boolean;
+export function isActiveFeature(e: any): boolean;
+export function isInactiveFeature(e: any): boolean;
+export function noTarget(e: any): boolean;
+export function isFeature(e: any): boolean;
+export function isVertex(e: any): boolean;
+export function isShiftDown(e: any): boolean;
+export function isEscapeKey(e: any): boolean;
+export function isEnterKey(e: any): boolean;
+export function isTrue(): boolean;

package/dist/components/MlFeatureEditor/lib/constants.d.ts

@@ -0,0 +1,85 @@
+export namespace classes {
+    const CONTROL_BASE: string;
+    const CONTROL_PREFIX: string;
+    const CONTROL_BUTTON: string;
+    const CONTROL_BUTTON_LINE: string;
+    const CONTROL_BUTTON_POLYGON: string;
+    const CONTROL_BUTTON_POINT: string;
+    const CONTROL_BUTTON_TRASH: string;
+    const CONTROL_BUTTON_COMBINE_FEATURES: string;
+    const CONTROL_BUTTON_UNCOMBINE_FEATURES: string;
+    const CONTROL_GROUP: string;
+    const ATTRIBUTION: string;
+    const ACTIVE_BUTTON: string;
+    const BOX_SELECT: string;
+}
+export namespace sources {
+    const HOT: string;
+    const COLD: string;
+}
+export namespace cursors {
+    const ADD: string;
+    const MOVE: string;
+    const DRAG: string;
+    const POINTER: string;
+    const NONE: string;
+}
+export namespace types {
+    const POLYGON: string;
+    const LINE: string;
+    const POINT: string;
+}
+export namespace geojsonTypes {
+    export const FEATURE: string;
+    const POLYGON_1: string;
+    export { POLYGON_1 as POLYGON };
+    export const LINE_STRING: string;
+    const POINT_1: string;
+    export { POINT_1 as POINT };
+    export const FEATURE_COLLECTION: string;
+    export const MULTI_PREFIX: string;
+    export const MULTI_POINT: string;
+    export const MULTI_LINE_STRING: string;
+    export const MULTI_POLYGON: string;
+}
+export namespace modes {
+    const DRAW_LINE_STRING: string;
+    const DRAW_POLYGON: string;
+    const DRAW_POINT: string;
+    const SIMPLE_SELECT: string;
+    const DIRECT_SELECT: string;
+    const STATIC: string;
+}
+export namespace events {
+    const CREATE: string;
+    const DELETE: string;
+    const UPDATE: string;
+    const SELECTION_CHANGE: string;
+    const MODE_CHANGE: string;
+    const ACTIONABLE: string;
+    const RENDER: string;
+    const COMBINE_FEATURES: string;
+    const UNCOMBINE_FEATURES: string;
+}
+export namespace updateActions {
+    const MOVE_1: string;
+    export { MOVE_1 as MOVE };
+    export const CHANGE_COORDINATES: string;
+}
+export namespace meta {
+    const FEATURE_1: string;
+    export { FEATURE_1 as FEATURE };
+    export const MIDPOINT: string;
+    export const VERTEX: string;
+}
+export namespace activeStates {
+    const ACTIVE: string;
+    const INACTIVE: string;
+}
+export const interactions: string[];
+export const LAT_MIN: -90;
+export const LAT_RENDERED_MIN: -85;
+export const LAT_MAX: 90;
+export const LAT_RENDERED_MAX: 85;
+export const LNG_MIN: -270;
+export const LNG_MAX: 270;

package/dist/components/MlFeatureEditor/lib/constrain_feature_movement.d.ts

@@ -0,0 +1,2 @@
+export default constrain_feature_movement;
+declare function constrain_feature_movement(geojsonFeatures: any, delta: any): any;

package/dist/components/MlFeatureEditor/lib/create_midpoint.d.ts

@@ -0,0 +1,15 @@
+export default create_midpoint;
+declare function create_midpoint(parent: any, startVertex: any, endVertex: any): {
+    type: string;
+    properties: {
+        meta: string;
+        parent: any;
+        lng: number;
+        lat: number;
+        coord_path: any;
+    };
+    geometry: {
+        type: string;
+        coordinates: number[];
+    };
+} | null;

package/dist/components/MlFeatureEditor/lib/create_supplementary_points.d.ts

@@ -0,0 +1,2 @@
+export default createSupplementaryPoints;
+declare function createSupplementaryPoints(geojson: any, options?: {}, basePath?: null): GeoJSON[];

package/dist/components/MlFeatureEditor/lib/create_vertex.d.ts

@@ -0,0 +1,13 @@
+export default create_vertex;
+/**
+ * Returns GeoJSON for a Point representing the
+ * vertex of another feature.
+ *
+ * @param {string} parentId
+ * @param {Array<number>} coordinates
+ * @param {string} path - Dot-separated numbers indicating exactly
+ *   where the point exists within its parent feature's coordinates.
+ * @param {boolean} selected
+ * @return {GeoJSON} Point
+ */
+declare function create_vertex(parentId: string, coordinates: Array<number>, path: string, selected: boolean): GeoJSON;

package/dist/components/MlFeatureEditor/lib/double_click_zoom.d.ts

@@ -0,0 +1,7 @@
+export default doubleClickZoom;
+declare namespace doubleClickZoom {
+    function enable(ctx: any): void;
+    function enable(ctx: any): void;
+    function disable(ctx: any): void;
+    function disable(ctx: any): void;
+}

package/dist/components/MlFeatureEditor/lib/euclidean_distance.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Code from https://github.com/mapbox/mapbox-gl-draw
+ * and licensed under ISC
+ */
+export default function _default(a: any, b: any): number;

package/dist/components/MlFeatureEditor/lib/features_at.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    export { featuresAtClick as click };
+    export { featuresAtTouch as touch };
+}
+export default _default;
+declare function featuresAtClick(event: any, bbox: any, ctx: any): any;
+declare function featuresAtTouch(event: any, bbox: any, ctx: any): any;

package/dist/components/MlFeatureEditor/lib/get_features_and_set_cursor.d.ts

@@ -0,0 +1 @@
+export default function getFeatureAtAndSetCursors(event: any, ctx: any): any;

package/dist/components/MlFeatureEditor/lib/is_click.d.ts

@@ -0,0 +1 @@
+export default function isClick(start: any, end: any, options?: {}): boolean;

package/dist/components/MlFeatureEditor/lib/is_event_at_coordinates.d.ts

@@ -0,0 +1,6 @@
+export default isEventAtCoordinates;
+/**
+ * Code from https://github.com/mapbox/mapbox-gl-draw
+ * and licensed under ISC
+ */
+declare function isEventAtCoordinates(event: any, coordinates: any): boolean;

package/dist/components/MlFeatureEditor/lib/is_tap.d.ts

@@ -0,0 +1,3 @@
+export default function isTap(start: any, end: any, options?: {}): boolean;
+export const TAP_TOLERANCE: 25;
+export const TAP_INTERVAL: 250;

package/dist/components/MlFeatureEditor/lib/map_event_to_bounding_box.d.ts

@@ -0,0 +1,12 @@
+export default mapEventToBoundingBox;
+/**
+ * Code from https://github.com/mapbox/mapbox-gl-draw
+ * and licensed under ISC
+ */
+/**
+ * Returns a bounding box representing the event's location.
+ *
+ * @param {Event} mapEvent - Mapbox GL JS map event, with a point properties.
+ * @return {Array<Array<number>>} Bounding box.
+ */
+declare function mapEventToBoundingBox(mapEvent: Event, buffer?: number): Array<Array<number>>;

package/dist/components/MlFeatureEditor/lib/mode_handler.d.ts

@@ -0,0 +1,24 @@
+export default ModeHandler;
+/**
+ * Code from https://github.com/mapbox/mapbox-gl-draw
+ * and licensed under ISC
+ */
+declare function ModeHandler(mode: any, DrawContext: any): {
+    render: any;
+    stop(): void;
+    trash(): void;
+    combineFeatures(): void;
+    uncombineFeatures(): void;
+    drag(event: any): void;
+    click(event: any): void;
+    mousemove(event: any): void;
+    mousedown(event: any): void;
+    mouseup(event: any): void;
+    mouseout(event: any): void;
+    keydown(event: any): void;
+    keyup(event: any): void;
+    touchstart(event: any): void;
+    touchmove(event: any): void;
+    touchend(event: any): void;
+    tap(event: any): void;
+};

package/dist/components/MlFeatureEditor/lib/mouse_event_point.d.ts

@@ -0,0 +1,11 @@
+export default mouseEventPoint;
+/**
+ * Returns a Point representing a mouse event's position
+ * relative to a containing element.
+ *
+ * @param {MouseEvent} mouseEvent
+ * @param {Node} container
+ * @returns {Point}
+ */
+declare function mouseEventPoint(mouseEvent: MouseEvent, container: Node): Point;
+import Point from "@mapbox/point-geometry";