@mapcomponents/react-maplibre 0.1.63 → 0.1.64

package/dist/components/MlLayerSwipe/MlLayerSwipe.d.ts

@@ -1,5 +1,6 @@
-import "./style.css";
-interface MlLayerSwipeProps {
+import React from 'react';
+import './style.css';
+export interface MlLayerSwipeProps {
     /**
      * Id of the first MapLibre instance.
      */
@@ -8,9 +9,18 @@ interface MlLayerSwipeProps {
      * Id of the second MapLibre instance.
      */
     map2Id: string;
+    /**
+     * object (React.CSSProperties) that is added to the button default style
+     */
+    buttonStyle: React.CSSProperties | undefined;
 }
 /**
  *	creates a split view of 2 synchronised maplibre instances
  */
-declare const MlLayerSwipe: (props: MlLayerSwipeProps) => JSX.Element;
+declare const MlLayerSwipe: {
+    (props: MlLayerSwipeProps): JSX.Element;
+    defaultProps: {
+        buttonStyle: {};
+    };
+};
 export default MlLayerSwipe;

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

@@ -1,11 +1,13 @@
+declare const storyoptions: {
+    title: string;
+    component: {
+        (props: import("./MlLayerSwipe").MlLayerSwipeProps): JSX.Element;
+        defaultProps: {
+            buttonStyle: {};
+        };
+    };
+    argTypes: {};
+    decorators: ((Story: any) => JSX.Element)[];
+};
 export default storyoptions;
-export const ExampleConfig: any;
-declare namespace storyoptions {
-    export const title: string;
-    export const name: string;
-    export { MlLayerSwipe as component };
-    export const argTypes: {};
-    export { multiMapContextDecorator as decorators };
-}
-import MlLayerSwipe from "./MlLayerSwipe";
-import multiMapContextDecorator from "../../decorators/MultiMapContextDecorator";
+export declare const ExampleConfig: any;

package/dist/components/MlSpatialElevationProfile/MlSpatialElevationProfile.d.ts

@@ -1,20 +1,39 @@
-export default MlSpatialElevationProfile;
+import { Feature, FeatureCollection } from '@turf/turf';
 /**
  * MlSpatialElevationProfile returns a Button that will add a standard OSM tile layer to the maplibre-gl instance.
  *
  * @component
  */
-declare function MlSpatialElevationProfile(props: any): JSX.Element;
-declare namespace MlSpatialElevationProfile {
-    namespace defaultProps {
-        const elevationFactor: number;
-    }
-    namespace propTypes {
-        export const mapId: PropTypes.Requireable<string>;
-        export const idPrefix: PropTypes.Requireable<string>;
-        const elevationFactor_1: PropTypes.Requireable<number>;
-        export { elevationFactor_1 as elevationFactor };
-        export const insertBeforeLayer: PropTypes.Requireable<string>;
-    }
+interface geojson {
+    features: Feature | FeatureCollection | undefined;
+}
+export interface MlSpatialElevationProfileProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * GeoJSON data that is supposed to be rendered by this component.
+     */
+    geojson: geojson | FeatureCollection | undefined;
+    /**
+     * Prefix of the component id this component uses when adding elements to the MapLibreGl-instance
+     */
+    idPrefix?: string;
+    /**
+     * Number describes the factor of the height of the elevation
+     */
+    elevationFactor?: number;
+    /**
+     * The layerId of an existing layer this layer should be rendered visually beneath
+     * https://maplibre.org/maplibre-gl-js-docs/api/map/#map#addlayer - see "beforeId" property
+     */
+    insertBeforeLayer?: string;
 }
-import PropTypes from "prop-types";
+declare const MlSpatialElevationProfile: {
+    (props: MlSpatialElevationProfileProps): JSX.Element;
+    defaultProps: {
+        elevationFactor: number;
+    };
+};
+export default MlSpatialElevationProfile;

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

@@ -1,16 +1,19 @@
+declare const storyoptions: {
+    title: string;
+    component: {
+        (props: import("./MlSpatialElevationProfile").MlSpatialElevationProfileProps): JSX.Element;
+        defaultProps: {
+            elevationFactor: number;
+        };
+    };
+    argTypes: {
+        options: {
+            control: {
+                type: string;
+            };
+        };
+    };
+    decorators: ((Story: any) => JSX.Element)[];
+};
 export default storyoptions;
-export const ExampleConfig: any;
-declare namespace storyoptions {
-    export const title: string;
-    export { MlSpatialElevationProfile as component };
-    export namespace argTypes {
-        namespace options {
-            namespace control {
-                const type: string;
-            }
-        }
-    }
-    export { mapContextDecorator as decorators };
-}
-import MlSpatialElevationProfile from "./MlSpatialElevationProfile";
-import mapContextDecorator from "../../decorators/MapContextDecorator";
+export declare const ExampleConfig: any;

package/dist/components/MlSpatialElevationProfile/util/getElevationData.d.ts

@@ -0,0 +1,14 @@
+interface geometry {
+    coordinates: Array<number>;
+}
+interface line {
+    geometry: geometry;
+}
+interface _geojsonInfo {
+    line: line;
+    min: number;
+}
+export default function getElevationData(_geojsonInfo: _geojsonInfo, elevationFactor: number): import("@turf/turf").FeatureCollection<GeoJSON.Geometry, {
+    [name: string]: any;
+}>;
+export {};

package/dist/components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer.d.ts

@@ -1,71 +1,7 @@
-import { Feature, FeatureCollection } from "@turf/turf";
-import { CircleLayerSpecification, FillLayerSpecification, LineLayerSpecification, MapLayerMouseEvent } from "maplibre-gl";
-interface MlTransitionGeoJsonLayerProps {
-    /**
-     * Id of the target MapLibre instance in mapContext
-     */
-    mapId: string;
-    /**
-     * GeoJSON data that is supposed to be rendered by this component.
-     */
-    geojson: Feature | FeatureCollection | undefined;
-    /**
-     * Type of the layer that will be added to the MapLibre instance.
-     * Possible values: "line", "circle", "fill"
-     */
-    type?: "fill" | "line" | "circle";
-    /**
-     * Paint property object, that is passed to the addLayer call.
-     * Possible props depend on the layer type.
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
-     */
-    paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
-    /**
-     * Layout property object, that is passed to the addLayer call.
-     * Possible props depend on the layer type.
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#line
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#circle
-     * https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#fill
-     */
-    layout?: CircleLayerSpecification['layout'] | FillLayerSpecification['layout'] | LineLayerSpecification['layout'];
-    /**
-     * Javascript object that is spread into the addLayer commands first parameter.
-     */
-    options?: CircleLayerSpecification | FillLayerSpecification | LineLayerSpecification;
-    /**
-     * Javascript object with optional properties "fill", "line", "circle" to override implicit layer type default paint properties.
-     */
-    defaultPaintOverrides?: {
-        circle?: CircleLayerSpecification['paint'];
-        fill?: FillLayerSpecification['paint'];
-        line?: LineLayerSpecification['paint'];
-    };
-    /**
-     * 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;
-    /**
-     * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
-     */
-    onHover?: MapLayerMouseEvent;
-    /**
-     * Click event handler that is executed whenever a geometry rendered by this component is clicked.
-     */
-    onClick?: MapLayerMouseEvent;
-    /**
-     * Leave event handler that is executed whenever a geometry rendered by this component is
-     * left/unhovered.
-     */
-    onLeave?: MapLayerMouseEvent;
-    /**
-     * Creates transition animation whenever the geojson prop changes.
-     * Only works with layer type "line" and LineString GeoJSON data.
-     */
+import { MlGeoJsonLayerProps } from '../MlGeoJsonLayer/MlGeoJsonLayer';
+type MlTransitionGeoJsonLayerProps = MlGeoJsonLayerProps & {
     transitionTime: number;
-}
+};
 /**
  * Adds source and layer of types "line", "fill" or "circle" to display GeoJSON data on the map.
  */

package/dist/components/MlWmsLayer/MlWmsLayer.d.ts

@@ -1,12 +1,15 @@
-import PropTypes from "prop-types";
+import PropTypes from 'prop-types';
+import { RasterLayerSpecification, RasterSourceSpecification } from 'maplibre-gl';
 interface MlWmsLayerProps {
-    urlParameters?: any;
+    urlParameters?: {
+        [key: string]: string;
+    };
     url: string;
     visible?: boolean;
     attribution?: string;
     mapId?: string;
-    sourceOptions?: any;
-    layerOptions?: any;
+    sourceOptions?: RasterSourceSpecification;
+    layerOptions?: RasterLayerSpecification;
     insertBeforeLayer?: string;
     layerId?: string;
 }

package/dist/components/MlWmsLoader/MlWmsLoader.d.ts

@@ -1,5 +1,7 @@
-import { LngLat } from "maplibre-gl";
-interface MlWmsLoaderProps {
+import { useWmsProps } from '../../hooks/useWms';
+import { LngLat } from 'maplibre-gl';
+import { Layer2 } from 'wms-capabilities';
+export interface MlWmsLoaderProps {
     /**
      * WMS URL
      */
@@ -11,18 +13,23 @@ interface MlWmsLoaderProps {
     /**
      * URL parameters that will be used in the getCapabilities request
      */
-    urlParameters: object;
+    urlParameters?: useWmsProps['urlParameters'];
     /**
      * URL parameters that will be added when requesting WMS capabilities
      */
-    wmsUrlParameters: object;
-    /**
-     * URL parameters that will be added when requesting tiles
-     */
-    layerUrlParameters: object;
-    lngLat: LngLat;
-    idPrefix: string;
+    wmsUrlParameters?: {
+        [key: string]: string;
+    };
+    lngLat?: LngLat;
+    idPrefix?: string;
 }
+export type LayerType = {
+    visible: boolean;
+    Name: string;
+    Attribution?: {
+        Title: string;
+    };
+} & Omit<Layer2, 'Layer'> & Partial<Pick<Layer2, 'Layer'>>;
 /**
  * Loads a WMS getCapabilities xml document and adds a MlWmsLayer component for each layer that is
  * offered by the WMS.

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

@@ -1,13 +1,24 @@
+declare const storyoptions: {
+    title: string;
+    component: {
+        (props: import("./MlWmsLoader").MlWmsLoaderProps): JSX.Element;
+        defaultProps: {
+            url: string;
+            urlParameters: {
+                SERVICE: string;
+                VERSION: string;
+                REQUEST: string;
+            };
+            wmsUrlParameters: {
+                TRANSPARENT: string;
+            };
+        };
+    };
+    argTypes: {
+        url: {};
+        layer: {};
+    };
+    decorators: ((Story: any) => JSX.Element)[];
+};
 export default storyoptions;
-export const ExampleConfig: any;
-declare namespace storyoptions {
-    export const title: string;
-    export { MlWmsLoader as component };
-    export namespace argTypes {
-        const url: {};
-        const layer: {};
-    }
-    export { mapContextDecorator as decorators };
-}
-import MlWmsLoader from "./MlWmsLoader";
-import mapContextDecorator from "../../decorators/MapContextDecorator";
+export declare const ExampleConfig: any;

package/dist/components/MlWmsLoader/utils/MlWmsLoaderInstructions.d.ts

@@ -0,0 +1,3 @@
+export default function MlWmsLoaderInstructions(props: {
+    open: boolean;
+}): JSX.Element;

package/dist/components/MlWmsLoader/utils/WMSLinks.d.ts

@@ -0,0 +1,6 @@
+export interface wmsLinksProps {
+    load: (str: string) => void;
+    open: boolean;
+    close: () => void;
+}
+export default function WMSLinks(props: wmsLinksProps): JSX.Element;

package/dist/decorators/ThemeWrapper.d.ts

@@ -1 +1,3 @@
-export default function ThemeWrapper(props: any): JSX.Element;
+export default function ThemeWrapper(props: {
+    children: unknown;
+}): JSX.Element;

package/dist/hooks/useGpx/lib/gpxConverter.d.ts

@@ -0,0 +1,11 @@
+export default toGeoJSON;
+declare namespace toGeoJSON {
+    function kml(doc: any): {
+        type: string;
+        features: never[];
+    };
+    function gpx(doc: any): {
+        type: string;
+        features: never[];
+    };
+}

package/dist/hooks/useGpx/useGpx.d.ts

@@ -0,0 +1,26 @@
+import { FeatureCollection } from '@turf/turf';
+interface useGpxProps {
+    /**
+     * a string containing GPX data that is supposed to be parsed and converted to GeoJSON by this hook
+     */
+    data?: string;
+}
+export interface MetadataType {
+    title: string;
+    value: string;
+    id: number;
+}
+/**
+ * useGpx hook converts GPX data to GeoJSON
+ *
+ */
+declare const useGpx: {
+    (props: useGpxProps): {
+        geojson: FeatureCollection<import("@turf/turf").Geometry | import("@turf/turf").GeometryCollection, import("@turf/turf").Properties> | undefined;
+        metadata: MetadataType[];
+    };
+    defaultProps: {
+        data: undefined;
+    };
+};
+export default useGpx;

package/dist/hooks/useGpx/useGpx.stories.d.ts

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

package/dist/hooks/useLayer.d.ts

@@ -1,16 +1,19 @@
 import { useMapType } from './useMap';
-import { SourceSpecification, LayerSpecification } from 'maplibre-gl';
+import { SourceSpecification, LayerSpecification, MapMouseEvent, GeoJSONFeature, Style, MapEventType, Map } from 'maplibre-gl';
 import MapLibreGlWrapper from '../components/MapLibreMap/lib/MapLibreGlWrapper';
-import { MapLayerMouseEvent } from 'maplibre-gl';
 import { GeoJSONObject } from '@turf/turf';
+type getLayerType = Style['getLayer'];
 type useLayerType = {
     map: MapLibreGlWrapper | undefined;
-    layer: LayerSpecification;
+    layer: ReturnType<getLayerType> | undefined;
     layerId: string;
     componentId: string;
     mapHook: useMapType;
 };
-interface useLayerProps {
+export type MapEventHandler = (ev: MapMouseEvent & {
+    features?: GeoJSONFeature[] | undefined;
+} & Record<string, unknown>) => void;
+export interface useLayerProps {
     mapId?: string;
     layerId?: string;
     idPrefix?: string;
@@ -19,9 +22,12 @@ interface useLayerProps {
     geojson?: GeoJSONObject;
     source?: SourceSpecification | string;
     options: Partial<LayerSpecification>;
-    onHover?: MapLayerMouseEvent;
-    onClick?: MapLayerMouseEvent;
-    onLeave?: MapLayerMouseEvent;
+    onHover?: (ev: MapEventType & unknown) => Map | void;
+    onClick?: (ev: MapEventType & unknown) => Map | void;
+    onLeave?: (ev: MapEventType & unknown) => Map | void;
 }
 declare function useLayer(props: useLayerProps): useLayerType;
+declare namespace useLayer {
+    var defaultProps: {};
+}
 export default useLayer;

package/dist/hooks/useLayerHoverPopup/useLayerHoverPopup.d.ts

@@ -0,0 +1,23 @@
+import { GeoJSONFeature } from 'maplibre-gl';
+interface useLayerHoverPopupProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Id of an existing layer in the mapLibre instance this event will be registered to
+     */
+    layerId?: string;
+    getPopupContent: (feature: GeoJSONFeature) => string;
+}
+/**
+ * useLayerHoverPopup hook registers a mouseenter event to display feature properties in a MapLibre popup if a feature on the configured layer is hovered
+ *
+ */
+declare const useLayerHoverPopup: {
+    (props: useLayerHoverPopupProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+    };
+};
+export default useLayerHoverPopup;

package/dist/hooks/useLayerHoverPopup/useLayerHoverPopup.stories.d.ts

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

package/dist/hooks/useMap.d.ts

@@ -6,7 +6,7 @@ type useMapType = {
     layers: (LayerState | undefined)[];
     cleanup: () => void;
 };
-declare function useMap(props: {
+declare function useMap(props?: {
     mapId?: string;
     waitForLayer?: string;
 }): useMapType;

package/dist/hooks/useMap.test.d.ts

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

package/dist/hooks/useSource.d.ts

@@ -1,9 +1,9 @@
 import { useMapType } from "./useMap";
 import MapLibreGlWrapper from "../components/MapLibreMap/lib/MapLibreGlWrapper";
-import { SourceSpecification } from "maplibre-gl";
+import { Source, SourceSpecification } from "maplibre-gl";
 type useSourceType = {
     map: MapLibreGlWrapper | undefined;
-    source: SourceSpecification;
+    source: Source | undefined;
     componentId: string;
     mapHook: useMapType;
 };

package/dist/hooks/useWms.d.ts

@@ -1,18 +1,26 @@
-export default useWms;
-declare function useWms(props: any): {
-    capabilities: undefined;
-    getFeatureInfoUrl: undefined;
-    wmsUrl: string;
-    error: undefined;
-    setUrl: import("react").Dispatch<any>;
-};
+import { WMSCapabilitiesJSON } from "wms-capabilities";
+export interface useWmsProps {
+    url?: string;
+    urlParameters?: {
+        [key: string]: string;
+    };
+}
+export interface useWmsReturnType {
+    capabilities: WMSCapabilitiesJSON | null | undefined;
+    getFeatureInfoUrl: string | undefined;
+    wmsUrl: string | undefined;
+    error: string | undefined;
+    setUrl: (value: string | undefined) => void;
+}
+declare function useWms(props: useWmsProps): useWmsReturnType;
 declare namespace useWms {
-    namespace defaultProps {
-        const url: string;
-        namespace urlParameters {
-            const SERVICE: string;
-            const VERSION: string;
-            const REQUEST: string;
-        }
-    }
+    var defaultProps: {
+        url: string;
+        urlParameters: {
+            SERVICE: string;
+            VERSION: string;
+            REQUEST: string;
+        };
+    };
 }
+export default useWms;

package/dist/index.d.ts

@@ -19,16 +19,16 @@ export { default as MlLayerMagnify } from "./components/MlLayerMagnify/MlLayerMa
 export { default as MlLayerSwipe } from "./components/MlLayerSwipe/MlLayerSwipe";
 export { default as MlTransitionGeoJsonLayer } from "./components/MlTransitionGeoJsonLayer/MlTransitionGeoJsonLayer";
 export { default as MlMarker } from "./components/MlMarker/MlMarker";
-export { default as MlGPXViewer } from "./components/MlGPXViewer/MlGPXViewer";
-export { default as GeoJsonProvider } from "./components/MlGPXViewer/util/GeoJsonProvider";
-export { default as GeoJsonContext } from "./components/MlGPXViewer/util/GeoJsonContext";
-export { default as MlSpatialElevationProfile } from "./components/MlSpatialElevationProfile/MlSpatialElevationProfile.js";
+export { default as MlGpxViewer } from "./components/MlGpxViewer/MlGpxViewer";
+export { default as GeoJsonProvider } from "./components/MlGpxViewer/util/GeoJsonProvider";
+export { default as GeoJsonContext } from "./components/MlGpxViewer/util/GeoJsonContext";
+export { default as MlSpatialElevationProfile } from "./components/MlSpatialElevationProfile/MlSpatialElevationProfile";
 export { default as MlOsmLayer } from "./components/MlOsmLayer/MlOsmLayer.js";
 export { default as MlBasicComponent } from "./components/MlBasicComponent.js";
 export { default as useLayer } from "./hooks/useLayer";
 export { default as useMapState } from "./hooks/useMapState";
 export { default as useMap } from "./hooks/useMap";
-export { default as useWms } from "./hooks/useWms.js";
+export { default as useWms } from "./hooks/useWms";
 export { default as useSource } from "./hooks/useSource";
 export { default as useExportMap } from "./hooks/useExportMap";
 export { default as useCameraFollowPath } from "./hooks/useCameraFollowPath/useCameraFollowPath";