@mapcomponents/react-maplibre 0.1.62 → 0.1.64

package/coverage/lcov-report/src/components/MlGeoJsonLayer/MlGeoJsonLayer.tsx.html

@@ -174,7 +174,25 @@
 <a name='L109'></a><a href='#L109'>109</a>
 <a name='L110'></a><a href='#L110'>110</a>
 <a name='L111'></a><a href='#L111'>111</a>
-<a name='L112'></a><a href='#L112'>112</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L112'></a><a href='#L112'>112</a>
+<a name='L113'></a><a href='#L113'>113</a>
+<a name='L114'></a><a href='#L114'>114</a>
+<a name='L115'></a><a href='#L115'>115</a>
+<a name='L116'></a><a href='#L116'>116</a>
+<a name='L117'></a><a href='#L117'>117</a>
+<a name='L118'></a><a href='#L118'>118</a>
+<a name='L119'></a><a href='#L119'>119</a>
+<a name='L120'></a><a href='#L120'>120</a>
+<a name='L121'></a><a href='#L121'>121</a>
+<a name='L122'></a><a href='#L122'>122</a>
+<a name='L123'></a><a href='#L123'>123</a>
+<a name='L124'></a><a href='#L124'>124</a>
+<a name='L125'></a><a href='#L125'>125</a>
+<a name='L126'></a><a href='#L126'>126</a>
+<a name='L127'></a><a href='#L127'>127</a>
+<a name='L128'></a><a href='#L128'>128</a>
+<a name='L129'></a><a href='#L129'>129</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -256,10 +274,7 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">11x</span>
-<span class="cline-any cline-yes">32x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">32x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -280,25 +295,50 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">11x</span>
 <span class="cline-any cline-yes">32x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">32x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import React from "react";
-&nbsp;
-import useLayer from "../../hooks/useLayer";
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">32x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import React from 'react';
 &nbsp;
-import { v4 as uuidv4 } from "uuid";
+import useLayer from '../../hooks/useLayer';
 &nbsp;
-import getDefaultPaintPropsByType from "./util/getDefaultPaintPropsByType";
-import getDefaulLayerTypeByGeometry from "./util/getDefaultLayerTypeByGeometry";
-import { Feature, FeatureCollection } from "@turf/turf";
+import { v4 as uuidv4 } from 'uuid';
 &nbsp;
+import getDefaultPaintPropsByType from './util/getDefaultPaintPropsByType';
+import getDefaulLayerTypeByGeometry from './util/getDefaultLayerTypeByGeometry';
+import { Feature, FeatureCollection } from '@turf/turf';
+import { useLayerProps } from '../../hooks/useLayer';
 &nbsp;
-import { LineLayerSpecification, CircleLayerSpecification, FillLayerSpecification,MapLayerMouseEvent, LayerSpecification } from "maplibre-gl";
+import {
+	LineLayerSpecification,
+	CircleLayerSpecification,
+	FillLayerSpecification,
+	LayerSpecification,
+	RasterLayerSpecification,
+} from 'maplibre-gl';
 &nbsp;
-type MlGeoJsonLayerProps = {
+export type MlGeoJsonLayerProps = {
 	/**
 	 * Id of the target MapLibre instance in mapContext
 	 */
@@ -306,7 +346,7 @@ type MlGeoJsonLayerProps = {
 	/**
 	 * 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.
-	 * This layer will not be added to the maplibre-gl instance until a layer with an 
+	 * This layer will not be added to the maplibre-gl instance until a layer with an
 	 * id that matches the value of insertBeforeLayer is created.
 	 */
 	insertBeforeLayer?: string;
@@ -320,67 +360,79 @@ type MlGeoJsonLayerProps = {
 	geojson: Feature | FeatureCollection | undefined;
 	/**
 	 * Type of the layer that will be added to the MapLibre instance.
-	 * Possible values: "line", "circle", "fill"
+	 * All types from LayerSpecification union type are supported except the type from
+	 * RasterLayerSpecification
 	 */
-	type?: "fill" | "line" | "circle";
+	type?: Exclude&lt;LayerSpecification['type'], RasterLayerSpecification['type']&gt;;
 	/**
 	 * Paint property object, that is passed to the addLayer call.
 	 * Possible props depend on the layer type.
+	 * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
+	 * Some examples are:
 	 * 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
+	 * All paint types from LayerSpecification union type are supported except the paint type from
+	 * RasterLayerSpecification
 	 */
-	paint?: CircleLayerSpecification['paint'] | FillLayerSpecification['paint'] | LineLayerSpecification['paint'];
+&nbsp;
+	paint?: Exclude&lt;LayerSpecification['paint'], RasterLayerSpecification['paint']&gt;;
 	/**
 	 * Layout property object, that is passed to the addLayer call.
 	 * Possible props depend on the layer type.
+	 * See https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/
+	 * Some examples are:
 	 * 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
+	 * All layout types from LayerSpecification union type are supported except the layout type from
+	 * RasterLayerSpecification
+&nbsp;
 	 */
-	layout?: CircleLayerSpecification['layout'] | FillLayerSpecification['layout'] | LineLayerSpecification['layout'];
+	layout?: Exclude&lt;LayerSpecification['layout'], RasterLayerSpecification['layout']&gt;;
+&nbsp;
 	/**
 	 * Javascript object that is spread into the addLayer commands first parameter.
 	 */
-	options?: CircleLayerSpecification | FillLayerSpecification | LineLayerSpecification;
+	options?: Exclude&lt;LayerSpecification, RasterLayerSpecification&gt;;
 	/**
 	 * 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'] };
+	defaultPaintOverrides?: {
+		circle?: CircleLayerSpecification['paint'];
+		fill?: FillLayerSpecification['paint'];
+		line?: LineLayerSpecification['paint'];
+	};
 	/**
 	 * Hover event handler that is executed whenever a geometry rendered by this component is hovered.
 	 */
-	onHover?: MapLayerMouseEvent;
+	onHover?: useLayerProps['onHover'];
 	/**
 	 * Click event handler that is executed whenever a geometry rendered by this component is clicked.
 	 */
-	onClick?: MapLayerMouseEvent;
+	onClick?: useLayerProps['onClick'];
 	/**
 	 * Leave event handler that is executed whenever a geometry rendered by this component is
 	 * left/unhovered.
 	 */
-	onLeave?: MapLayerMouseEvent;
-}
+	onLeave?: useLayerProps['onLeave'];
+};
 &nbsp;
 /**
- * Adds source and layer of types "line", "fill" or "circle" to display GeoJSON data on the map.
+ * Adds source and layer to display GeoJSON data on the map.
  *
  * @component
  */
+&nbsp;
 const MlGeoJsonLayer = (props: MlGeoJsonLayerProps) =&gt; {
 	const layerType = props.type || <span class="branch-1 cbranch-no" title="branch not covered" >getDefaulLayerTypeByGeometry(props.geojson);</span>
 	// Use a useRef hook to reference the layer object to be able to access it later inside useEffect hooks
 	useLayer({
 		mapId: props.mapId,
-		layerId: props.layerId || "MlGeoJsonLayer-" + uuidv4(),
+		layerId: props.layerId || 'MlGeoJsonLayer-' + uuidv4(),
 		geojson: props.geojson,
 		options: {
-			paint:
-				props.paint ||
-				getDefaultPaintPropsByType(
-					layerType,
-					props.defaultPaintOverrides
-				),
+			paint: props.paint || getDefaultPaintPropsByType(layerType, props.defaultPaintOverrides),
 			layout: props.layout || {},
 			...props.options,
 			type: layerType as LayerSpecification['type'],
@@ -391,10 +443,9 @@ const MlGeoJsonLayer = (props: MlGeoJsonLayerProps) =&gt; {
 		onLeave: props.onLeave,
 	});
 &nbsp;
-	return (&lt;&gt;&lt;/&gt;);
+	return &lt;&gt;&lt;/&gt;;
 };
 &nbsp;
-&nbsp;
 export default MlGeoJsonLayer;
 &nbsp;</pre></td></tr></table></pre>
 
@@ -403,7 +454,7 @@ export default MlGeoJsonLayer;
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at Sat Nov 26 2022 10:32:12 GMT+0000 (Coordinated Universal Time)
+                at 2023-01-15T17:55:43.336Z
             </div>
         <script src="../../../prettify.js"></script>
         <script>

package/coverage/lcov-report/src/components/MlGeoJsonLayer/index.html

@@ -101,7 +101,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at Sat Nov 26 2022 10:32:12 GMT+0000 (Coordinated Universal Time)
+                at 2023-01-15T17:55:43.336Z
             </div>
         <script src="../../../prettify.js"></script>
         <script>