@mapcomponents/react-maplibre 0.1.77 → 0.1.79

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## [v0.1.79] - 2023-05-31
+
+### Added
+
+- f253071: Reliable & adjustable layer order (#105) …
+- c7c4fdf: add MlTerrainLayer component (#108) …
+- 70c18d7: optimize map libre map stories presentation (#103) …
+- a02db81: add missing catalogue descriptions (#109) …
+- bdd32ae: add SpeedDial UI component (#106) …
+
+### Changed
+
+- **Breaking:** 36be5ab: change MlFeatureEditor to useFeatureEditor hook, replace custom draw modes with default modes, draw mode strings require adjustment to the equivalent default mode (#110) …
+
+
+### Fixed
+
+- c0c302a: Feature/fix wmsloader featureinfo (#111) …
+- e743b79: Fix/cypress config (#104) …
+
+## [v0.1.78] - 2023-04-28
+
+### Added
+- cedf14b: add interval parameter to MlTemporalController
+
 ## [v0.1.77] - 2023-04-05
 
 
@@ -82,7 +107,7 @@
 ## [v0.1.69] - 2023-02-07
 
 ### Changed
-- readd dependencies to package.dependencies
+- read dependencies from package.dependencies
 
 ## [v0.1.68] - 2023-02-07
 
@@ -181,7 +206,7 @@
 
 ### Changed
 
-- 7687eec: change MlVectorTileLayer layers prop type from object to array
+- **Breaking:** 7687eec: change MlVectorTileLayer layers prop type from object to array
 
 ## [v0.1.59] - 2022-10-04
 

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

@@ -1,42 +1,5 @@
-/// <reference types="react" />
+import React from 'react';
+import { useFeatureEditorProps } from '../../hooks/useFeatureEditor';
 import './MlFeatureEditor.css';
-import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css';
-import { GeoJSONObject, Feature } from '@turf/turf';
-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?: Feature;
-    /**
-     * Callback function that is called each time the GeoJson data within has changed within MlFeatureEditor.
-     * First parameter is the new GeoJson feature.
-     */
-    onChange?: (para: GeoJSONObject[]) => void;
-    /**
-     * Callback function that is called each time the GeoJson data within has been finished within MlFeatureEditor.
-     * First parameter is the new GeoJson feature.
-     */
-    onFinish?: () => void;
-    /**
-     * 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;
+declare const MlFeatureEditor: React.FC<useFeatureEditorProps>;
 export default MlFeatureEditor;

package/dist/components/MlTemporalController/MlTemporalController.d.ts

@@ -87,6 +87,11 @@ export interface MlTemporalControllerProps {
      * By default it is set to 1.
      */
     step?: number;
+    /**
+     *  The time between each addition to the counter, expressed in milliseconds.
+     *  By default, 200 ms.
+     */
+    interval?: number;
     /**
      * A numeric value that sets how many steps before the feature starts to appear.
      * By default it is set to 5 steps.
@@ -161,6 +166,7 @@ declare const MlTemporalController: {
         ownLayer: boolean;
         type: string;
         step: number;
+        interval: number;
         fadeIn: number;
         fadeOut: number;
         labelFadeIn: number;

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

@@ -9,6 +9,7 @@ declare const storyoptions: {
             ownLayer: boolean;
             type: string;
             step: number;
+            interval: number;
             fadeIn: number;
             fadeOut: number;
             labelFadeIn: number;

package/dist/components/MlTemporalController/utils/TemporalControllerPlayer.d.ts

@@ -3,6 +3,7 @@ export interface TemporalControllerPlayerProps {
     currentVal: number;
     isPlaying: boolean;
     step: number;
+    interval: number;
     minVal: number;
     maxVal: number;
     returnCurrent: React.Dispatch<React.SetStateAction<number>>;

package/dist/components/MlTerrainLayer/MlTerrainLayer.cy.d.ts

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

package/dist/components/MlTerrainLayer/MlTerrainLayer.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+import { TerrainSpecification } from 'maplibre-gl';
+interface MlTerrainLayerProps {
+    /**
+     * Id of the target MapLibre instance in mapContext
+     */
+    mapId?: string;
+    /**
+     * Source of tiles with possibles options
+     */
+    sourceOptions?: object;
+    /**
+     * Options for new exaggeration value
+     */
+    terrainOptions?: TerrainSpecification;
+}
+export type { MlTerrainLayerProps };
+/**
+ * Create Terrain Layer Component
+ *
+ */
+declare const MlTerrainLayer: {
+    (props: MlTerrainLayerProps): JSX.Element;
+    defaultProps: {
+        mapId: undefined;
+    };
+};
+export default MlTerrainLayer;

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

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+declare const storyoptions: {
+    title: string;
+    component: {
+        (props: import("./MlTerrainLayer").MlTerrainLayerProps): JSX.Element;
+        defaultProps: {
+            mapId: undefined;
+        };
+    };
+    argTypes: {};
+    decorators: ((Story: any, context: any) => JSX.Element)[];
+};
+export default storyoptions;
+export declare const ExampleConfig: any;

package/dist/components/MlThreeJsLayer/MlThreeJsLayer.d.ts

@@ -1,15 +1,30 @@
-export default MlThreeJsLayer;
+/// <reference types="react" />
+import PropTypes from 'prop-types';
 /**
  * Renders obj or gltf 3D Models on the MapLibreMap referenced by props.mapId
  *
  * @component
  */
-declare function MlThreeJsLayer(props: any): JSX.Element;
-declare namespace MlThreeJsLayer {
-    namespace propTypes {
-        const mapId: PropTypes.Requireable<string>;
-        const init: PropTypes.Requireable<(...args: any[]) => any>;
-        const onDone: PropTypes.Requireable<(...args: any[]) => any>;
-    }
+export interface MlThreeJsLayerProps {
+    mapId?: string;
+    init?: object;
+    onDone?: () => void;
 }
-import PropTypes from "prop-types";
+declare const MlThreeJsLayer: {
+    (props: MlThreeJsLayerProps): JSX.Element;
+    propTypes: {
+        /**
+         * Id of the target MapLibre instance in mapContext
+         */
+        mapId: PropTypes.Requireable<string>;
+        /**
+         * function that gets called when initialized
+         */
+        init: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * function that gets called when models are loaded
+         */
+        onDone: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+};
+export default MlThreeJsLayer;

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

@@ -2,7 +2,7 @@
 declare const storyoptions: {
     title: string;
     component: {
-        (props: any): JSX.Element;
+        (props: import("./MlThreeJsLayer").MlThreeJsLayerProps): JSX.Element;
         propTypes: {
             mapId: import("prop-types").Requireable<string>;
             init: import("prop-types").Requireable<(...args: any[]) => any>;

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

@@ -1,14 +1,31 @@
 /// <reference types="react" />
 import { useWmsProps } from '../../hooks/useWms';
-import { LngLat } from 'maplibre-gl';
 import { Layer2 } from 'wms-capabilities';
 import { useWmsReturnType } from '../../hooks/useWms';
 export interface WmsConfig {
+    /**
+     * The URL to use for the getFeatureInfo request
+     */
     getFeatureInfoUrl: useWmsReturnType['getFeatureInfoUrl'];
+    /**
+     * The URL of the WMS service
+     */
     wmsUrl: useWmsReturnType['wmsUrl'];
+    /**
+     * The layers to display on the map
+     */
     layers: LayerType[];
+    /**
+     * If true, the WMS layer is visible
+     */
     visible: boolean;
+    /**
+     * If true, the WMS layer is open
+     */
     open: boolean;
+    /**
+     * The name of the WMS layer
+     */
     name?: string;
 }
 export interface MlWmsLoaderProps {
@@ -31,17 +48,46 @@ export interface MlWmsLoaderProps {
     wmsUrlParameters?: {
         [key: string]: string;
     };
+    /**
+     * If true, zooms to the extent of the WMS layer after loading the getCapabilities response
+     */
     zoomToExtent?: boolean;
-    lngLat?: LngLat;
-    idPrefix?: string;
+    /**
+     * The name of the ListItem element representing the WmsLoader
+     */
     name?: string;
+    /**
+     * If true, enables the feature info functionality
+     */
     featureInfoEnabled?: boolean;
+    /**
+     * If true, the feature info functionality is active
+     */
     featureInfoActive?: boolean;
+    /**
+     * A function to set the feature info active state
+     */
     setFeatureInfoActive?: (val: boolean | ((current: boolean) => boolean)) => void;
+    /**
+     * The WMS configuration object
+     */
     config?: WmsConfig;
+    /**
+     * A function to handle changes to the WMS configuration
+     */
     onConfigChange?: (config: WmsConfig | false) => void;
+    /**
+     * A function to update a LayerType config array that is passed to this component at props.config.layers
+     */
     setLayers?: (layers: LayerType[]) => void;
+    /**
+     * If true, shows the delete button for the WMSLoader
+     */
     showDeleteButton?: boolean;
+    /**
+     * Custom buttons to display for the WMSLoader
+     */
+    buttons?: JSX.Element;
 }
 export type LayerType = {
     visible: boolean;

package/dist/contexts/LayerContext.d.ts

@@ -36,6 +36,8 @@ export interface LayerContextType {
     vtLayerConfig: Partial<MlVectorTileLayerProps>;
     setTileUrl: (url: string) => void;
     tileUrl: string;
+    moveUp: (layerId: string) => void;
+    moveDown: (layerId: string) => void;
 }
 declare const LayerContext: React.Context<LayerContextType>;
 declare function LayerContextProvider(props: LayerContextProps): JSX.Element;

package/dist/decorators/TemporalControllerDecorator.d.ts

@@ -0,0 +1,2 @@
+export default decorators;
+declare const decorators: ((Story: any, context: any) => JSX.Element)[];

package/dist/hooks/useFeatureEditor.d.ts

@@ -0,0 +1,46 @@
+import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css';
+import MapboxDraw from '@mapbox/mapbox-gl-draw';
+import { GeoJSONObject, Feature } from '@turf/turf';
+export interface useFeatureEditorProps {
+    /**
+     * 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?: Feature;
+    /**
+     * Callback function that is called each time the GeoJson data within has changed within MlFeatureEditor.
+     * First parameter is the new GeoJson feature.
+     */
+    onChange?: (para: GeoJSONObject[]) => void;
+    /**
+     * Callback function that is called each time the GeoJson data within has been finished within MlFeatureEditor.
+     * First parameter is the new GeoJson feature.
+     */
+    onFinish?: () => void;
+    /**
+     * Feature editor modes:
+     * - draw_line_string
+     * - draw_polygon
+     * - draw_point
+     * - simple_select
+     * - direct_select
+     */
+    mode?: keyof MapboxDraw.Modes;
+}
+/**
+ * GeoJson Feature editor that allows to create or manipulate GeoJson data
+ */
+declare const useFeatureEditor: (props: useFeatureEditorProps) => {
+    feature: GeoJSONObject[] | undefined;
+    drawToolsReady: boolean;
+    draw: MapboxDraw | undefined;
+};
+export default useFeatureEditor;

package/dist/index.d.ts

@@ -34,6 +34,7 @@ export { default as MlWmsLoader } from "./components/MlWmsLoader/MlWmsLoader";
 export { default as MlTemporalController } from "./components/MlTemporalController/MlTemporalController";
 export { default as MlBasicComponent } from "./components/MlBasicComponent.js";
 export { default as MlOrderLayers } from "./components/MlOrderLayers/MlOrderLayers";
+export { default as MlTerrainLayer } from "./components/MlTerrainLayer/MlTerrainLayer";
 export { default as useCameraFollowPath } from "./hooks/useCameraFollowPath/useCameraFollowPath";
 export { default as useExportMap } from "./hooks/useExportMap";
 export { default as useGpx } from "./hooks/useGpx/useGpx";
@@ -47,6 +48,7 @@ export { default as useSource } from "./hooks/useSource";
 export { default as useWms } from "./hooks/useWms";
 export { default as useFilterData } from "./components/MlTemporalController/utils/useFilterData";
 export { default as useLayerContext } from "./hooks/useLayerContext";
+export { default as useFeatureEditor } from "./hooks/useFeatureEditor";
 export { MapComponentsProvider } from "./contexts/MapContext";
 export { default as MapContext } from "./contexts/MapContext";
 export { default as SimpleDataProvider } from "./contexts/SimpleDataProvider";
@@ -72,6 +74,7 @@ export { default as UploadButton } from './ui_components/UploadButton';
 export { default as SelectStyleButton } from './ui_components/SelectStyleButton/SelectStyleButton';
 export { default as SelectStylePopup } from './ui_components/SelectStyleButton/SelectStylePopup';
 export { default as ConfirmDialog } from './ui_components/ConfirmDialog';
+export { default as SpeedDial } from './ui_components/SpeedDial/SpeedDial';
 export { default as GruvboxStyle } from './omt_styles/gruvbox';
 export { default as MedievalKingdomStyle } from './omt_styles/medieval_kingdom';
 export { default as MonokaiStyle } from './omt_styles/monokai';