npm - @mapcomponents/react-maplibre - Versions diffs - 0.1.56 → 0.1.58 - Mend

@mapcomponents/react-maplibre 0.1.56 → 0.1.58

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 (277) hide show

package/coverage/lcov-report/src/hooks/useLayerEvent.js.html ADDED Viewed

@@ -0,0 +1,232 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for src/hooks/useLayerEvent.js</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="../../prettify.css" />
+    <link rel="stylesheet" href="../../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(../../sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="../../index.html">All files</a> / <a href="index.html">src/hooks</a> useLayerEvent.js</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>0/23</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>0/16</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>0/3</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">0% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>0/21</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input oninput="onInput()" type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line low'></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>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a>
+<a name='L48'></a><a href='#L48'>48</a>
+<a name='L49'></a><a href='#L49'>49</a>
+<a name='L50'></a><a href='#L50'>50</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>
+<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-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&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-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&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-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&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-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&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-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</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-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import React from 'react';
+import { useEffect } from 'react';
+import useMapState from './useMapState';
+import useMap from './useMap';
+&nbsp;
+const touchEquivalents = <span class="cstat-no" title="statement not covered" >{</span>
+	mousedown: 'touchstart',
+	mouseup: 'touchend',
+	mousemove: 'touchmove',
+};
+const touchEquivalentsKeys = <span class="cstat-no" title="statement not covered" >Object.keys(touchEquivalents);</span>
+function <span class="fstat-no" title="function not covered" >useLayerEvent(</span>props) {
+	const mapState = <span class="cstat-no" title="statement not covered" >useMapState({ mapId: props.mapId, watch: { layers: true } });</span>
+	const mapHook = <span class="cstat-no" title="statement not covered" >useMap({ mapId: props.mapId });</span>
+&nbsp;
+<span class="cstat-no" title="statement not covered" >	useEffect(<span class="fstat-no" title="function not covered" >()</span> =&gt; {</span>
+<span class="cstat-no" title="statement not covered" >		if (!mapHook.map) <span class="cstat-no" title="statement not covered" >return true;</span></span>
+<span class="cstat-no" title="statement not covered" >		if (typeof props.condition !== 'undefined' &amp;&amp; props.condition === false) <span class="cstat-no" title="statement not covered" >return;</span></span>
+		//console.log('useLayerEvent');
+		//console.log(mapState);
+&nbsp;
+<span class="cstat-no" title="statement not covered" >		if (mapHook.map.map.getLayer(props.layerId)) {</span>
+			//console.log("layer avail");
+			var _event = <span class="cstat-no" title="statement not covered" >props.event;</span>
+			var _layerId = <span class="cstat-no" title="statement not covered" >props.layerId;</span>
+			var _eventHandler = <span class="cstat-no" title="statement not covered" >props.eventHandler;</span>
+&nbsp;
+			//console.log(_event);
+<span class="cstat-no" title="statement not covered" >			mapHook.map.on(_event, _layerId, _eventHandler, mapHook.componentId);</span>
+<span class="cstat-no" title="statement not covered" >			if (props?.addTouchEvents === true) {</span>
+<span class="cstat-no" title="statement not covered" >				if (touchEquivalentsKeys.indexOf(_event) !== -1) {</span>
+<span class="cstat-no" title="statement not covered" >					mapHook.map.on(touchEquivalents[_event], _layerId, _eventHandler, mapHook.componentId);</span>
+				}
+			}
+<span class="cstat-no" title="statement not covered" >			return <span class="fstat-no" title="function not covered" >()</span> =&gt; {</span>
+<span class="cstat-no" title="statement not covered" >				mapHook.map.off(_event, _layerId, _eventHandler);</span>
+<span class="cstat-no" title="statement not covered" >				if (props?.addTouchEvents === true) {</span>
+<span class="cstat-no" title="statement not covered" >					if (touchEquivalentsKeys.indexOf(_event) !== -1) {</span>
+<span class="cstat-no" title="statement not covered" >						mapHook.map.off(touchEquivalents[_event], _layerId, _eventHandler, mapHook.componentId);</span>
+					}
+				}
+			};
+		}
+	}, [props, mapState, mapHook.map]);
+&nbsp;
+<span class="cstat-no" title="statement not covered" >	return {};</span>
+}
+&nbsp;
+export default useLayerEvent;
+&nbsp;</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <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 Tue Oct 04 2022 11:59:51 GMT+0000 (Coordinated Universal Time)
+            </div>
+        <script src="../../prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="../../sorter.js"></script>
+        <script src="../../block-navigation.js"></script>
+    </body>
+</html>

package/coverage/lcov-report/src/hooks/useMap.ts.html CHANGED Viewed

@@ -153,7 +153,8 @@
 <a name='L88'></a><a href='#L88'>88</a>
 <a name='L89'></a><a href='#L89'>89</a>
 <a name='L90'></a><a href='#L90'>90</a>
-<a name='L91'></a><a href='#L91'>91</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L91'></a><a href='#L91'>91</a>
+<a name='L92'></a><a href='#L92'>92</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>
@@ -185,6 +186,7 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">211x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">211x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">211x</span>
@@ -194,7 +196,6 @@
 <span class="cline-any cline-yes">211x</span>
 <span class="cline-any cline-yes">39x</span>
 <span class="cline-any cline-yes">29x</span>
-<span class="cline-any cline-yes">29x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">39x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -203,6 +204,7 @@
 <span class="cline-any cline-yes">57x</span>
 <span class="cline-any cline-yes">26x</span>
 <span class="cline-any cline-yes">26x</span>
+<span class="cline-any cline-yes">26x</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>
@@ -243,91 +245,92 @@
 <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 { useContext, useState, useEffect, useRef, MutableRefObject } from "react";
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { useContext, useState, useEffect, useRef } from "react";
 import { v4 as uuidv4 } from "uuid";
 import MapContext from "../contexts/MapContext";
 import useMapState from "./useMapState";
 import MapLibreGlWrapper, { LayerState } from "../components/MapLibreMap/lib/MapLibreGlWrapper";
 &nbsp;
 type useMapType = {
-  map: MapLibreGlWrapper | undefined;
-  mapIsReady: boolean;
-  componentId: string;
-  layers: (LayerState | undefined)[];
-  cleanup: Function;
+	map: MapLibreGlWrapper | undefined;
+	mapIsReady: boolean;
+	componentId: string;
+	layers: (LayerState | undefined)[];
+	cleanup: () =&gt; void;
 };
 &nbsp;
 function useMap(props: { mapId?: string; waitForLayer?: string }): useMapType {
-  // Use a useRef hook to reference the layer object to be able to access it later inside useEffect hooks
-  const mapContext: MapContextType = useContext(MapContext);
-  const [map, setMap] = useState&lt;MapLibreGlWrapper&gt;();
+	// Use a useRef hook to reference the layer object to be able to access it later inside useEffect hooks
+	const mapContext: MapContextType = useContext(MapContext);
+	const [map, setMap] = useState&lt;MapLibreGlWrapper&gt;();
 &nbsp;
-  const mapState = useMapState({
-    mapId: props.mapId,
-    watch: {
-      viewport: false,
-      layers: props.waitForLayer ? <span class="branch-0 cbranch-no" title="branch not covered" >true </span>: false,
-      sources: false,
-    },
-    filter: {
-      includeBaseLayers: true,
-    },
-  });
+	const mapState = useMapState({
+		mapId: props.mapId,
+		watch: {
+			viewport: false,
+			layers: props.waitForLayer ? <span class="branch-0 cbranch-no" title="branch not covered" >true </span>: false,
+			sources: false,
+		},
+		filter: {
+			includeBaseLayers: true,
+		},
+	});
 &nbsp;
-  const initializedRef = useRef(false);
-  const mapRef: MutableRefObject&lt;MapLibreGlWrapper | undefined&gt; = useRef(undefined);
+	const initializedRef = useRef(false);
 &nbsp;
-  const componentId = useRef(uuidv4());
+	const mapRef = useRef&lt;MapLibreGlWrapper&gt;();
 &nbsp;
-  const [mapIsReady, setMapIsReady] = useState(false);
+	const componentId = useRef(uuidv4());
 &nbsp;
-  const cleanup = () =&gt; {
-    if (mapRef.current) {
-      mapRef.current.cleanup(componentId.current);
-      mapRef.current = undefined;
-    }
-    initializedRef.current = false;
-  };
+	const [mapIsReady, setMapIsReady] = useState(false);
 &nbsp;
-  useEffect(() =&gt; {
-    return () =&gt; {
-      cleanup();
-      setMapIsReady(false);
-    }
-  }, []);
+	const cleanup = () =&gt; {
+		if (mapRef.current) {
+			mapRef.current.cleanup(componentId.current);
+		}
+		initializedRef.current = false;
+	};
 &nbsp;
-  useEffect(() =&gt; {
-    if (!mapContext.mapExists(props.mapId) || initializedRef.current) return;
+	useEffect(() =&gt; {
+		return () =&gt; {
+			cleanup();
+			setMapIsReady(false);
+			mapRef.current = undefined;
+		};
+	}, []);
 &nbsp;
-    // check if waitForLayer (string, layer id of the layer this hook is supposed to wait for)
-    // exists as layer in the MapLibre instance
-    <span class="missing-if-branch" title="if path not taken" >I</span>if (props.waitForLayer) {
-      let layerFound = <span class="cstat-no" title="statement not covered" >false;</span>
+	useEffect(() =&gt; {
+		if (!mapContext.mapExists(props.mapId) || initializedRef.current) return;
 &nbsp;
-<span class="cstat-no" title="statement not covered" >      mapState?.layers?.forEach(<span class="fstat-no" title="function not covered" >(l</span>ayer: any) =&gt; {</span>
-<span class="cstat-no" title="statement not covered" >        if (layer.id === props.waitForLayer) {</span>
-<span class="cstat-no" title="statement not covered" >          layerFound = true;</span>
-        }
-      });
-<span class="cstat-no" title="statement not covered" >      if (!layerFound) {</span>
-<span class="cstat-no" title="statement not covered" >        return;</span>
-      }
-    }
-    // the MapLibre-gl instance (mapContext.getMap(props.mapId)) is accessible here
-    // initialize the layer and add it to the MapLibre-gl instance or do something else with it
-    initializedRef.current = true;
-    mapRef.current = mapContext.getMap(props.mapId);
-    setMap(mapRef.current);
-    setMapIsReady(true);
-  }, [mapContext.mapIds, mapState.layers, mapContext, props.waitForLayer, props.mapId]);
+		// check if waitForLayer (string, layer id of the layer this hook is supposed to wait for)
+		// exists as layer in the MapLibre instance
+		<span class="missing-if-branch" title="if path not taken" >I</span>if (props.waitForLayer) {
+			let layerFound = <span class="cstat-no" title="statement not covered" >false;</span>
+&nbsp;
+<span class="cstat-no" title="statement not covered" >			mapState?.layers?.forEach(<span class="fstat-no" title="function not covered" >(l</span>ayer: any) =&gt; {</span>
+<span class="cstat-no" title="statement not covered" >				if (layer.id === props.waitForLayer) {</span>
+<span class="cstat-no" title="statement not covered" >					layerFound = true;</span>
+				}
+			});
+<span class="cstat-no" title="statement not covered" >			if (!layerFound) {</span>
+<span class="cstat-no" title="statement not covered" >				return;</span>
+			}
+		}
+		// the MapLibre-gl instance (mapContext.getMap(props.mapId)) is accessible here
+		// initialize the layer and add it to the MapLibre-gl instance or do something else with it
+		initializedRef.current = true;
+		mapRef.current = mapContext.getMap(props.mapId);
+		setMap(mapRef.current);
+		setMapIsReady(true);
+	}, [mapContext.mapIds, mapState.layers, mapContext, props.waitForLayer, props.mapId]);
 &nbsp;
-  return {
-    map: map,
-    mapIsReady,
-    componentId: componentId.current,
-    layers: mapState.layers,
-    cleanup,
-  };
+	return {
+		map: map,
+		mapIsReady,
+		componentId: componentId.current,
+		layers: mapState.layers,
+		cleanup,
+	};
 }
 &nbsp;
 export default useMap;
@@ -340,7 +343,7 @@ export type { useMapType };
             <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 Aug 11 2022 13:20:32 GMT+0000 (Coordinated Universal Time)
+                at Tue Oct 04 2022 11:59:51 GMT+0000 (Coordinated Universal Time)
             </div>
         <script src="../../prettify.js"></script>
         <script>