@opengeoweb/shared 9.4.0 → 9.5.0

package/index.esm.js

@@ -4752,4 +4752,62 @@ var getHeight = function getHeight(element) {
   return element.offsetHeight + marginTop + marginBottom;
 };
 
-export { AlertBanner, AlertIcon, AppHeader, AppLayout, Avatar, ConfirmationDialog, ConfirmationServiceProvider, CustomAccordion, CustomDialog, CustomIconButton, CustomSlider, CustomToggleButton, CustomTooltip, DEFAULT_ERROR_MESSAGE, DraggableComponent$1 as Draggable, ErrorBoundary, ResizeComponent as Resizable, SearchField, SearchFieldButton, SearchHighlight, StatusTag, SwitchButton, ToggleMenu, ToolContainer, DraggableComponent as ToolContainerDraggable, ToolFooter, ToolHeader, TooltipSelect, UserMenu, UserMenuItemCheatSheet, MenuItemTheme as UserMenuItemTheme, adjustPosition, calculateDialogSizeAndPosition, calculateStartSize, createMockStoreWithEggs, createMockStoreWithEggsAndMiddleware, createToolkitMockStoreWithEggs, index as dateUtils, defaultDelay, getAxiosErrorMessage, getAxiosWarningMessage, getErrorMessage, getHeight, getInitials, getPosition, getWarningMessage, isAxiosError, showPrompt, sliderHeaderStyle, tooltipContainerStyles, useConfirmationDialog, useControlledTooltip, useDialogActions, useIsMounted, useMakeSureContainerStaysInsideWindow, usePoller, usePreventBrowserClose, usePrevious, useUserMenu, withEggs };
+/* *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2024 - Finnish Meteorological Institute (FMI)
+ * */
+/**
+ * Utility function to keep track of number of renders by a react component
+ *
+ * Usage:
+ * 1) reset all counters to zero by:
+ *      renderCounter.reset()
+ * 2) in the render function of the functional component do:
+ *      renderCounter.count(<your react functional component>.name);
+ * 3) in the test do:
+ *      expect(renderCounter.get(<your react functional component>.name)).toBe(1);
+ *
+ */
+var RenderCounter = /*#__PURE__*/function () {
+  function RenderCounter() {
+    _classCallCheck(this, RenderCounter);
+    this.numRenders = new Map();
+  }
+  _createClass(RenderCounter, [{
+    key: "reset",
+    value: function reset() {
+      var _this = this;
+      this.numRenders.forEach(function (_value, key) {
+        _this.numRenders.set(key, 0);
+      });
+    }
+  }, {
+    key: "count",
+    value: function count(id) {
+      this.numRenders.set(id, this.get(id) + 1);
+      // Enable next line (for debugging) to track the number of renders per component in the developer console
+      // console.log('numRenders', id, this.get(id));
+    }
+  }, {
+    key: "get",
+    value: function get(id) {
+      return this.numRenders.get(id) || 0;
+    }
+  }]);
+  return RenderCounter;
+}();
+var renderCounter = new RenderCounter();
+
+export { AlertBanner, AlertIcon, AppHeader, AppLayout, Avatar, ConfirmationDialog, ConfirmationServiceProvider, CustomAccordion, CustomDialog, CustomIconButton, CustomSlider, CustomToggleButton, CustomTooltip, DEFAULT_ERROR_MESSAGE, DraggableComponent$1 as Draggable, ErrorBoundary, ResizeComponent as Resizable, SearchField, SearchFieldButton, SearchHighlight, StatusTag, SwitchButton, ToggleMenu, ToolContainer, DraggableComponent as ToolContainerDraggable, ToolFooter, ToolHeader, TooltipSelect, UserMenu, UserMenuItemCheatSheet, MenuItemTheme as UserMenuItemTheme, adjustPosition, calculateDialogSizeAndPosition, calculateStartSize, createMockStoreWithEggs, createMockStoreWithEggsAndMiddleware, createToolkitMockStoreWithEggs, index as dateUtils, defaultDelay, getAxiosErrorMessage, getAxiosWarningMessage, getErrorMessage, getHeight, getInitials, getPosition, getWarningMessage, isAxiosError, renderCounter, showPrompt, sliderHeaderStyle, tooltipContainerStyles, useConfirmationDialog, useControlledTooltip, useDialogActions, useIsMounted, useMakeSureContainerStaysInsideWindow, usePoller, usePreventBrowserClose, usePrevious, useUserMenu, withEggs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/shared",
-  "version": "9.4.0",
+  "version": "9.5.0",
   "description": "GeoWeb shared library with shared components and utils for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

package/src/lib/utils/index.d.ts

@@ -2,3 +2,4 @@ export * from './axiosErrorUtils';
 export * as dateUtils from './dateUtils';
 export * from './reduxTestUtils';
 export * from './layoutUtils';
+export { renderCounter } from './renderCounter';

package/src/lib/utils/renderCounter.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Utility function to keep track of number of renders by a react component
+ *
+ * Usage:
+ * 1) reset all counters to zero by:
+ *      renderCounter.reset()
+ * 2) in the render function of the functional component do:
+ *      renderCounter.count(<your react functional component>.name);
+ * 3) in the test do:
+ *      expect(renderCounter.get(<your react functional component>.name)).toBe(1);
+ *
+ */
+declare class RenderCounter {
+    private numRenders;
+    constructor();
+    reset(): void;
+    count(id: string): void;
+    get(id: string): number;
+}
+export declare const renderCounter: RenderCounter;
+export {};

package/src/lib/utils/renderCounter.spec.d.ts

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