@opengeoweb/shared 9.10.1 → 9.11.0

package/index.esm.js

@@ -259,57 +259,6 @@ function _nonIterableSpread() {
 function _nonIterableRest() {
   throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-function _createForOfIteratorHelper(o, allowArrayLike) {
-  var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
-  if (!it) {
-    if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {
-      if (it) o = it;
-      var i = 0;
-      var F = function () {};
-      return {
-        s: F,
-        n: function () {
-          if (i >= o.length) return {
-            done: true
-          };
-          return {
-            done: false,
-            value: o[i++]
-          };
-        },
-        e: function (e) {
-          throw e;
-        },
-        f: F
-      };
-    }
-    throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-  }
-  var normalCompletion = true,
-    didErr = false,
-    err;
-  return {
-    s: function () {
-      it = it.call(o);
-    },
-    n: function () {
-      var step = it.next();
-      normalCompletion = step.done;
-      return step;
-    },
-    e: function (e) {
-      didErr = true;
-      err = e;
-    },
-    f: function () {
-      try {
-        if (!normalCompletion && it.return != null) it.return();
-      } finally {
-        if (didErr) throw err;
-      }
-    }
-  };
-}
 
 var defaultDelay = 1000;
 var useControlledTooltip = function useControlledTooltip() {
@@ -3806,6 +3755,7 @@ var getWarningMessage = function getWarningMessage(error) {
  * Copyright 2023 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
  * Copyright 2023 - Finnish Meteorological Institute (FMI)
  * */
+var DATE_FORMAT_UTC = "yyyy-MM-dd'T'HH:mm:ss'Z'";
 /**
  * Parsing date strings with geoweb dateUtils:
  *
@@ -3945,7 +3895,7 @@ var setUTCDate = function setUTCDate(inDate) {
  * ``` dateToString(new Date(2022, 10, 12, 15, 30), 'dd MMM yyyy') ```
  */
 var dateToString = function dateToString(inDate) {
-  var strFormat = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "yyyy-MM-dd'T'HH:mm:ss'Z'";
+  var strFormat = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DATE_FORMAT_UTC;
   var utc = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
   if (!inDate || !isValid(inDate)) {
     return undefined;
@@ -4131,7 +4081,7 @@ var utc = function utc(dateStr) {
  * @returns {Date} - Date in UTC, undefined when not valid
  */
 var getUtcFromString = function getUtcFromString(dateStr) {
-  if (!dateStr) {
+  if (!dateStr || typeof dateStr !== 'string') {
     return undefined;
   }
   if (hasOffset(dateStr)) {
@@ -4207,7 +4157,7 @@ var getNowUtc = function getNowUtc() {
  * @returns {string} - formatted date string
  */
 var getCurrentTimeAsString = function getCurrentTimeAsString() {
-  var strFormat = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "yyyy-MM-dd'T'HH:mm:ss'Z'";
+  var strFormat = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DATE_FORMAT_UTC;
   var utc = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
   return dateToString(getNowUtc(), strFormat, utc);
 };
@@ -4398,253 +4348,4 @@ var RenderCounter = /*#__PURE__*/function () {
 }();
 var renderCounter = new RenderCounter();
 
-/* *
- * 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)
- * */
-/**
- * This class should NEVER be initialized with new Metronome(). Use the
- * exported variable. To reset the metronome use unregisterAllTimers()
- * to remove all existing timers followed by init() to initialize the
- * ticks.
- */
-var Metronome = /*#__PURE__*/function () {
-  function Metronome() {
-    _classCallCheck(this, Metronome);
-    this.tickId = 0;
-    this.step = this.step.bind(this);
-    this.isPaused = this.isPaused.bind(this);
-    this.continueTimer = this.continueTimer.bind(this);
-    this.pauseTimer = this.pauseTimer.bind(this);
-    this.toggleTimer = this.toggleTimer.bind(this);
-    this.init = this.init.bind(this);
-    this.unregisterAllTimers = this.unregisterAllTimers.bind(this);
-    this.setSpeed = this.setSpeed.bind(this);
-    this.interval = null;
-    this.init();
-    this.handleTimerTicks = null;
-    this.timers = [];
-  }
-  _createClass(Metronome, [{
-    key: "init",
-    value: function init() {
-      if (this.interval != null) {
-        clearInterval(this.interval);
-      }
-      this.interval = setInterval(this.step, 10);
-    }
-  }, {
-    key: "unregisterAllTimers",
-    value: function unregisterAllTimers() {
-      this.timers.length = 0;
-    }
-  }, {
-    key: "step",
-    value: function step() {
-      var _this = this;
-      this.tickId += 1;
-      var triggeredTimerIds = [];
-      this.timers.forEach(function (timer) {
-        // Delay in x10 ms
-        var delay = 100 / timer.hertz;
-        // Get nearest multiple of delay
-        var nearestDelay = delay * Math.floor((_this.tickId + delay / 2) / delay);
-        var distanceToDelay = _this.tickId - nearestDelay;
-        if (Math.abs(distanceToDelay) < 0.5 || distanceToDelay === -0.5) {
-          if (!timer.isPaused) {
-            timer.timerFunc && timer.timerFunc(timer.timerId, _this.tickId);
-            triggeredTimerIds.push(timer.timerId);
-          }
-        }
-      });
-      // Trigger the handleTimerTicks function with all collected timerIds
-      if (triggeredTimerIds.length > 0) {
-        this.handleTimerTicks && this.handleTimerTicks(triggeredTimerIds);
-      }
-    }
-    /**
-     * Multiple timers with varying frequencies can be made at the same
-     * time however each timerId must be unique. If you attempt to create
-     * two timers with the same timerId, the second will silently be ignored.
-     *
-     * @param timerFunc The function to be executed at the given hertz frequency
-     * @param hertz Frequency of the timer given in hertz
-     * @param timerId Id of the timer
-     * @returns Timer or nothing if no timer was created
-     */
-  }, {
-    key: "register",
-    value: function register(timerFunc, hertz, timerId) {
-      var existingTimer = this.timers.find(function (timer) {
-        return timer.timerId === timerId;
-      });
-      if (existingTimer) {
-        existingTimer.hertz = hertz;
-        existingTimer.timerFunc = timerFunc;
-        return existingTimer;
-      }
-      this.timers.push({
-        timerFunc: timerFunc,
-        hertz: hertz,
-        timerId: timerId,
-        isPaused: false
-      });
-      return this.timers.at(-1);
-    }
-    /**
-     * Unregistering a timer completely removes it, if you want to pause a
-     * timer, then use pauseTimer()
-     *
-     * @param timerId Id of the timer
-     */
-  }, {
-    key: "unregister",
-    value: function unregister(timerId) {
-      var indexToRemove = this.timers.findIndex(function (timer) {
-        return timer.timerId === timerId;
-      });
-      if (indexToRemove > -1) {
-        this.timers.splice(indexToRemove, 1);
-      }
-    }
-    /**
-     * Checks if a timer is paused
-     *
-     * @param timerId Id of the timer
-     * @returns true if the timer is paused, false if it is running
-     */
-  }, {
-    key: "isPaused",
-    value: function isPaused(timerId) {
-      var _iterator = _createForOfIteratorHelper(this.timers),
-        _step;
-      try {
-        for (_iterator.s(); !(_step = _iterator.n()).done;) {
-          var timer = _step.value;
-          if (timer.timerId === timerId && timer.isPaused) {
-            return true;
-          }
-        }
-      } catch (err) {
-        _iterator.e(err);
-      } finally {
-        _iterator.f();
-      }
-      return false;
-    }
-    /**
-     * Continues running a timer
-     *
-     * @param timerId Id of the timer
-     */
-  }, {
-    key: "continueTimer",
-    value: function continueTimer(timerId) {
-      var _iterator2 = _createForOfIteratorHelper(this.timers),
-        _step2;
-      try {
-        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-          var timer = _step2.value;
-          if (timer.timerId === timerId) {
-            timer.isPaused = false;
-            break;
-          }
-        }
-      } catch (err) {
-        _iterator2.e(err);
-      } finally {
-        _iterator2.f();
-      }
-    }
-    /**
-     * Pauses a timer
-     *
-     * @param timerId Id of the timer
-     */
-  }, {
-    key: "pauseTimer",
-    value: function pauseTimer(timerId) {
-      var _iterator3 = _createForOfIteratorHelper(this.timers),
-        _step3;
-      try {
-        for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
-          var timer = _step3.value;
-          if (timer.timerId === timerId) {
-            timer.isPaused = true;
-            break;
-          }
-        }
-      } catch (err) {
-        _iterator3.e(err);
-      } finally {
-        _iterator3.f();
-      }
-    }
-    /**
-     * Toggles a timer to be paused or running. Be careful when asking redux
-     * to toggle a timer, it might toggle twice and therefore do nothing
-     *
-     * @param timerId Id of the timer
-     */
-  }, {
-    key: "toggleTimer",
-    value: function toggleTimer(timerId) {
-      var _iterator4 = _createForOfIteratorHelper(this.timers),
-        _step4;
-      try {
-        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
-          var timer = _step4.value;
-          if (timer.timerId === timerId) {
-            timer.isPaused = !timer.isPaused;
-            break;
-          }
-        }
-      } catch (err) {
-        _iterator4.e(err);
-      } finally {
-        _iterator4.f();
-      }
-    }
-    /**
-     * Sets the speed of a timer to a new frequency given in hertz
-     *
-     * @param timerId Id of the timer
-     * @param hertz Frequency of the timer given in hertz
-     */
-  }, {
-    key: "setSpeed",
-    value: function setSpeed(timerId, hertz) {
-      var _iterator5 = _createForOfIteratorHelper(this.timers),
-        _step5;
-      try {
-        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-          var timer = _step5.value;
-          if (timer.timerId === timerId) {
-            timer.hertz = hertz;
-            break;
-          }
-        }
-      } catch (err) {
-        _iterator5.e(err);
-      } finally {
-        _iterator5.f();
-      }
-    }
-  }]);
-  return Metronome;
-}();
-var metronome = new Metronome();
-
-export { AlertBanner, AlertIcon, AppHeader, AppLayout, Avatar, BUTTON_TITLE, CanvasComponent, ConfirmationDialog, ConfirmationServiceProvider, CustomAccordion, CustomDialog, CustomIconButton, CustomSlider, CustomToggleButton, CustomTooltip, DEFAULT_ERROR_MESSAGE, DraggableComponent$1 as Draggable, ErrorBoundary, LastUpdateTime, 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, getInitials, getLastUpdateTitle, getPosition, getWarningMessage, isAxiosError, metronome, pollingIntervalTimeout, renderCounter, showPrompt, sliderHeaderStyle, tooltipContainerStyles, useConfirmationDialog, useControlledTooltip, useDialogActions, useIsMounted, useMakeSureContainerStaysInsideWindow, usePoller, usePreventBrowserClose, usePrevious, useUserMenu, withEggs };
+export { AlertBanner, AlertIcon, AppHeader, AppLayout, Avatar, BUTTON_TITLE, CanvasComponent, ConfirmationDialog, ConfirmationServiceProvider, CustomAccordion, CustomDialog, CustomIconButton, CustomSlider, CustomToggleButton, CustomTooltip, DEFAULT_ERROR_MESSAGE, DraggableComponent$1 as Draggable, ErrorBoundary, LastUpdateTime, 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, getInitials, getLastUpdateTitle, getPosition, getWarningMessage, isAxiosError, pollingIntervalTimeout, 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.10.1",
+  "version": "9.11.0",
   "description": "GeoWeb shared library with shared components and utils for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

package/src/lib/components/ToggleMenu/ToggleMenu.d.ts

@@ -6,7 +6,7 @@ export declare const getPosition: (menuPosition: MenuPosition) => {
     anchorOrigin: PopoverOrigin;
     transformOrigin: PopoverOrigin;
 };
-interface MenuItemType {
+export interface MenuItemType {
     text: string;
     action: (event: React.MouseEvent) => void;
     icon?: React.ReactNode;

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

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

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

@@ -1,77 +0,0 @@
-/// <reference types="node" />
-type TimerFunction = (timerId: string, tickId: number) => void;
-interface Timer {
-    timerFunc: TimerFunction | null;
-    hertz: number;
-    timerId: string;
-    isPaused: boolean;
-}
-/**
- * This class should NEVER be initialized with new Metronome(). Use the
- * exported variable. To reset the metronome use unregisterAllTimers()
- * to remove all existing timers followed by init() to initialize the
- * ticks.
- */
-declare class Metronome {
-    tickId: number;
-    timers: Timer[];
-    interval: NodeJS.Timeout | null;
-    handleTimerTicks: ((timerIds: string[]) => void) | null;
-    constructor();
-    init(): void;
-    unregisterAllTimers(): void;
-    step(): void;
-    /**
-     * Multiple timers with varying frequencies can be made at the same
-     * time however each timerId must be unique. If you attempt to create
-     * two timers with the same timerId, the second will silently be ignored.
-     *
-     * @param timerFunc The function to be executed at the given hertz frequency
-     * @param hertz Frequency of the timer given in hertz
-     * @param timerId Id of the timer
-     * @returns Timer or nothing if no timer was created
-     */
-    register(timerFunc: TimerFunction | null, hertz: number, timerId: string): Timer | undefined;
-    /**
-     * Unregistering a timer completely removes it, if you want to pause a
-     * timer, then use pauseTimer()
-     *
-     * @param timerId Id of the timer
-     */
-    unregister(timerId: string): void;
-    /**
-     * Checks if a timer is paused
-     *
-     * @param timerId Id of the timer
-     * @returns true if the timer is paused, false if it is running
-     */
-    isPaused(timerId: string): boolean;
-    /**
-     * Continues running a timer
-     *
-     * @param timerId Id of the timer
-     */
-    continueTimer(timerId: string): void;
-    /**
-     * Pauses a timer
-     *
-     * @param timerId Id of the timer
-     */
-    pauseTimer(timerId: string): void;
-    /**
-     * Toggles a timer to be paused or running. Be careful when asking redux
-     * to toggle a timer, it might toggle twice and therefore do nothing
-     *
-     * @param timerId Id of the timer
-     */
-    toggleTimer(timerId: string): void;
-    /**
-     * Sets the speed of a timer to a new frequency given in hertz
-     *
-     * @param timerId Id of the timer
-     * @param hertz Frequency of the timer given in hertz
-     */
-    setSpeed(timerId: string, hertz: number): void;
-}
-declare const metronome: Metronome;
-export { metronome };

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

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

package/src/lib/utils/metronome.stories.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-declare const _default: {
-    title: string;
-};
-export default _default;
-export declare const MetronomeCanvasPlaygroundDemo: React.FC;
-export declare const MetronomeCanvasDemo: React.FC;