npm - @mapcomponents/react-maplibre - Versions diffs - 0.1.34 → 0.1.35 - Mend

@mapcomponents/react-maplibre 0.1.34 → 0.1.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (305) hide show

package/coverage/lcov-report/src/components/MlFeatureEditor/{MlFeatureEditor.js.html → MlFeatureEditor.tsx.html} RENAMED Viewed

@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
-    <title>Code coverage report for src/components/MlFeatureEditor/MlFeatureEditor.js</title>
+    <title>Code coverage report for src/components/MlFeatureEditor/MlFeatureEditor.tsx</title>
     <meta charset="utf-8" />
     <link rel="stylesheet" href="../../../prettify.css" />
     <link rel="stylesheet" href="../../../base.css" />
@@ -19,34 +19,34 @@
 <body>
 <div class='wrapper'>
     <div class='pad1'>
-        <h1><a href="../../../index.html">All files</a> / <a href="index.html">src/components/MlFeatureEditor</a> MlFeatureEditor.js</h1>
+        <h1><a href="../../../index.html">All files</a> / <a href="index.html">src/components/MlFeatureEditor</a> MlFeatureEditor.tsx</h1>
         <div class='clearfix'>
             <div class='fl pad1y space-right2'>
-                <span class="strong">82.92% </span>
+                <span class="strong">78.78% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>34/41</span>
+                <span class='fraction'>26/33</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">67.64% </span>
+                <span class="strong">68% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>23/34</span>
+                <span class='fraction'>17/25</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">77.77% </span>
+                <span class="strong">71.42% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>7/9</span>
+                <span class='fraction'>5/7</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">82.92% </span>
+                <span class="strong">78.78% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>34/41</span>
+                <span class='fraction'>26/33</span>
             </div>
@@ -61,7 +61,7 @@
             </div>
         </template>
     </div>
-    <div class='status-line high'></div>
+    <div class='status-line medium'></div>
     <pre><table class="coverage">
 <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
 <a name='L2'></a><a href='#L2'>2</a>
@@ -182,7 +182,27 @@
 <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></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<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>
+<a name='L130'></a><a href='#L130'>130</a>
+<a name='L131'></a><a href='#L131'>131</a>
+<a name='L132'></a><a href='#L132'>132</a>
+<a name='L133'></a><a href='#L133'>133</a>
+<a name='L134'></a><a href='#L134'>134</a>
+<a name='L135'></a><a href='#L135'>135</a>
+<a name='L136'></a><a href='#L136'>136</a>
+<a name='L137'></a><a href='#L137'>137</a>
+<a name='L138'></a><a href='#L138'>138</a>
+<a name='L139'></a><a href='#L139'>139</a>
+<a name='L140'></a><a href='#L140'>140</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>
@@ -195,49 +215,68 @@
 <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">12x</span>
-<span class="cline-any cline-yes">12x</span>
-<span class="cline-any cline-yes">12x</span>
-<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
-<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
-<span class="cline-any cline-no">&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">12x</span>
-<span class="cline-any cline-no">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">12x</span>
-<span class="cline-any cline-yes">4x</span>
-<span class="cline-any cline-yes">4x</span>
-<span class="cline-any cline-yes">2x</span>
-<span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">2x</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">12x</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-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">1x</span>
+<span class="cline-any cline-yes">16x</span>
+<span class="cline-any cline-yes">16x</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">16x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">16x</span>
+<span class="cline-any cline-yes">16x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">16x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">16x</span>
+<span class="cline-any cline-no">&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">16x</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">16x</span>
 <span class="cline-any cline-yes">12x</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">4x</span>
-<span class="cline-any cline-yes">4x</span>
-<span class="cline-any cline-yes">4x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</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>
@@ -260,6 +299,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-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">4x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">4x</span>
@@ -270,18 +310,17 @@
 <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">12x</span>
+<span class="cline-any cline-yes">16x</span>
 <span class="cline-any cline-yes">8x</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">4x</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">12x</span>
+<span class="cline-any cline-yes">16x</span>
 <span class="cline-any cline-yes">4x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-no">&nbsp;</span>
@@ -291,43 +330,75 @@
 <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">12x</span>
+<span class="cline-any cline-yes">16x</span>
 <span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-no">&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">12x</span>
+<span class="cline-any cline-yes">16x</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, { useState, useEffect, useContext, useRef } from "react";
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import React, { useState, useEffect, useRef } from "react";
 import "./MlFeatureEditor.css";
 &nbsp;
 import "@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css";
 import MapboxDraw from "@mapbox/mapbox-gl-draw";
-import CustomPolygonMode from "./custom-polygon-mode";
-import CustomSelectMode from "./custom-select-mode";
-import CustomDirectSelectMode from "./custom-direct-select-mode";
-import { v4 as uuidv4 } from "uuid";
+import CustomPolygonMode from "./custom-polygon-mode.js";
+import CustomSelectMode from "./custom-select-mode.js";
+import CustomDirectSelectMode from "./custom-direct-select-mode.js";
 &nbsp;
-import { MapContext } from "@mapcomponents/react-core";
+import useMap from "../../hooks/useMap";
 &nbsp;
-function MlFeatureEditor(props) {
-  const mapRef = useRef(null);
-  const draw = useRef(null);
-  const mapContext = useContext(MapContext);
-  const componentId = useRef(
-    (props.idPrefix ? <span class="branch-0 cbranch-no" title="branch not covered" >props.idPrefix </span>: "MlFeatureEditor-") + uuidv4()
-  );
+&nbsp;
+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
+}
+&nbsp;
+/**
+ * GeoJson Feature editor that allows to create or manipulate GeoJson data
+ */
+const MlFeatureEditor = (props:MlFeatureEditorProps) =&gt; {
+  const draw = useRef&lt;MapboxDraw&gt;();
+  const mapHook = useMap({
+    mapId: props.mapId,
+    waitForLayer: props.insertBeforeLayer,
+  });
   const onChangeRef = useRef(props.onChange);
 &nbsp;
-  const [drawToolsInitialized, setDrawToolsInitialized] = useState(false);
+  const drawToolsInitialized = useRef(false);
   const [drawToolsReady, setDrawToolsReady] = useState(false);
 &nbsp;
-  const [mouseUpTrigger, setMouseUpTrigger] = useState(false);
+  const [mouseUpTrigger, setMouseUpTrigger] = useState(0);
 &nbsp;
-  const modeChangeHandler = <span class="fstat-no" title="function not covered" >(e</span>) =&gt; {
+  const modeChangeHandler = <span class="fstat-no" title="function not covered" >(e</span>:any) =&gt; {
 <span class="cstat-no" title="statement not covered" >    console.log("MlFeatureEditor mode change to " + e.mode);</span>
     //setDrawMode(e.mode);
   };
@@ -335,40 +406,29 @@ function MlFeatureEditor(props) {
   const mouseUpHandler = <span class="fstat-no" title="function not covered" >()</span> =&gt; {
 <span class="cstat-no" title="statement not covered" >    setMouseUpTrigger(Math.random());</span>
   };
-&nbsp;
-  useEffect(() =&gt; {
-    let _componentId = componentId.current;
-    return () =&gt; {
-      if (mapRef.current) {
-        mapRef.current.cleanup(_componentId);
-        //mapRef.current.removeControl(draw.current, "top-left");
-        mapRef.current = null;
-      }
-    };
-  }, []);
 &nbsp;
   useEffect(() =&gt; {
     if (
-      mapContext.mapExists(props.mapId) &amp;&amp;
-      mapContext.getMap(props.mapId).style &amp;&amp;
-      !drawToolsInitialized
+      mapHook.map &amp;&amp;
+      !drawToolsInitialized.current
     ) {
-      mapRef.current = mapContext.getMap(props.mapId);
-      setDrawToolsInitialized(true);
+      drawToolsInitialized.current = true;
+&nbsp;
       <span class="missing-if-branch" title="if path not taken" >I</span>if (
-        mapRef.current &amp;&amp;
-        mapRef.current.style &amp;&amp;
-        mapRef.current.getSource("mapbox-gl-draw-cold") &amp;&amp;
-<span class="branch-3 cbranch-no" title="branch not covered" >        draw.current </span>&amp;&amp;
-<span class="branch-4 cbranch-no" title="branch not covered" >        typeof draw.current.remove !== "undefined"</span>
+        mapHook.map.map.style &amp;&amp;
+        mapHook.map.map.getSource("mapbox-gl-draw-cold") &amp;&amp;
+<span class="branch-2 cbranch-no" title="branch not covered" >        draw.current</span>
       ) {
         // remove old Mapbox-gl-Draw from Mapbox instance when hot-reloading this component during development
-<span class="cstat-no" title="statement not covered" >        draw.current.remove();</span>
+        // @ts-ignore
+<span class="cstat-no" title="statement not covered" >        draw.current?.remove();</span>
       }
 &nbsp;
       draw.current = new MapboxDraw({
         displayControlsDefault: false,
         defaultMode: props.mode || <span class="branch-1 cbranch-no" title="branch not covered" >"custom_select",</span>
+        // @ts-ignore
         modes: Object.assign(
           {
             custom_polygon: CustomPolygonMode,
@@ -379,23 +439,22 @@ function MlFeatureEditor(props) {
         ),
       });
 &nbsp;
-      mapRef.current.on("draw.modechange", modeChangeHandler, componentId.current);
+      mapHook.map.on("draw.modechange", modeChangeHandler, mapHook.componentId);
 &nbsp;
-      mapRef.current.addControl(draw.current, "top-left", componentId.current);
+      mapHook.map.addControl(draw.current, "top-left", mapHook.componentId);
 &nbsp;
-      mapRef.current.on("mouseup", mouseUpHandler, componentId.current);
+      mapHook.map.on("mouseup", mouseUpHandler, mapHook.componentId);
 &nbsp;
       setDrawToolsReady(true);
     }
-  }, [mapContext.map, mapContext, props, drawToolsInitialized]);
+  }, [mapHook.map,  props, drawToolsInitialized]);
 &nbsp;
   useEffect(() =&gt; {
     if (
       draw.current &amp;&amp;
-      props.geojson &amp;&amp;
-      props.geojson.geometry &amp;&amp;
-      props.geojson.geometry.coordinates
+      props.geojson?.geometry
     ) {
+      // @ts-ignore
       draw.current.set({ type: "FeatureCollection", features: [props.geojson] });
     }
   }, [props.geojson, drawToolsReady]);
@@ -412,11 +471,12 @@ function MlFeatureEditor(props) {
 &nbsp;
   useEffect(() =&gt; {
     <span class="missing-if-branch" title="if path not taken" >I</span>if (props.mode &amp;&amp; draw.current) {
+      // @ts-ignore
 <span class="cstat-no" title="statement not covered" >      draw.current.changeMode(props.mode);</span>
     }
   }, [props.mode]);
 &nbsp;
-  return &lt;&gt;&lt;/&gt;;
+  return (&lt;&gt;&lt;/&gt;);
 }
 &nbsp;
 export default MlFeatureEditor;
@@ -427,7 +487,7 @@ export default MlFeatureEditor;
             <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 Thu Mar 24 2022 19:39:33 GMT+0000 (Coordinated Universal Time)
+                at Wed Apr 20 2022 07:57:24 GMT+0000 (Coordinated Universal Time)
             </div>
         <script src="../../../prettify.js"></script>
         <script>

package/coverage/lcov-report/src/components/MlFeatureEditor/index.html CHANGED Viewed

@@ -23,30 +23,30 @@
         <div class='clearfix'>
             <div class='fl pad1y space-right2'>
-                <span class="strong">82.92% </span>
+                <span class="strong">78.78% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>34/41</span>
+                <span class='fraction'>26/33</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">67.64% </span>
+                <span class="strong">68% </span>
                 <span class="quiet">Branches</span>
-                <span class='fraction'>23/34</span>
+                <span class='fraction'>17/25</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">77.77% </span>
+                <span class="strong">71.42% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>7/9</span>
+                <span class='fraction'>5/7</span>
             </div>
             <div class='fl pad1y space-right2'>
-                <span class="strong">82.92% </span>
+                <span class="strong">78.78% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>34/41</span>
+                <span class='fraction'>26/33</span>
             </div>
@@ -61,7 +61,7 @@
             </div>
         </template>
     </div>
-    <div class='status-line high'></div>
+    <div class='status-line medium'></div>
     <div class="pad1">
 <table class="coverage-summary">
 <thead>
@@ -79,18 +79,18 @@
 </tr>
 </thead>
 <tbody><tr>
-	<td class="file high" data-value="MlFeatureEditor.js"><a href="MlFeatureEditor.js.html">MlFeatureEditor.js</a></td>
-	<td data-value="82.92" class="pic high">
-	<div class="chart"><div class="cover-fill" style="width: 82%"></div><div class="cover-empty" style="width: 18%"></div></div>
+	<td class="file medium" data-value="MlFeatureEditor.tsx"><a href="MlFeatureEditor.tsx.html">MlFeatureEditor.tsx</a></td>
+	<td data-value="78.78" class="pic medium">
+	<div class="chart"><div class="cover-fill" style="width: 78%"></div><div class="cover-empty" style="width: 22%"></div></div>
 	</td>
-	<td data-value="82.92" class="pct high">82.92%</td>
-	<td data-value="41" class="abs high">34/41</td>
-	<td data-value="67.64" class="pct medium">67.64%</td>
-	<td data-value="34" class="abs medium">23/34</td>
-	<td data-value="77.77" class="pct medium">77.77%</td>
-	<td data-value="9" class="abs medium">7/9</td>
-	<td data-value="82.92" class="pct high">82.92%</td>
-	<td data-value="41" class="abs high">34/41</td>
+	<td data-value="78.78" class="pct medium">78.78%</td>
+	<td data-value="33" class="abs medium">26/33</td>
+	<td data-value="68" class="pct medium">68%</td>
+	<td data-value="25" class="abs medium">17/25</td>
+	<td data-value="71.42" class="pct medium">71.42%</td>
+	<td data-value="7" class="abs medium">5/7</td>
+	<td data-value="78.78" class="pct medium">78.78%</td>
+	<td data-value="33" class="abs medium">26/33</td>
 	</tr>
 </tbody>
@@ -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 Thu Mar 24 2022 19:39:33 GMT+0000 (Coordinated Universal Time)
+                at Wed Apr 20 2022 07:57:24 GMT+0000 (Coordinated Universal Time)
             </div>
         <script src="../../../prettify.js"></script>
         <script>