@opengeoweb/metronome 17.0.1 → 17.1.0

package/README.md

@@ -0,0 +1,15 @@
+# metronome
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test metronome` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running storybook
+
+Run `nx storybook metronome` to build and view the storybook at http://localhost:5700/.
+
+### TypeScript Documentation
+
+- [TypeScript Docs](https://opengeoweb.gitlab.io/opengeoweb/typescript-docs/metronome/)

package/package.json

@@ -1,18 +1,30 @@
 {
   "name": "@opengeoweb/metronome",
-  "version": "17.0.1",
+  "version": "17.1.0",
   "description": "GeoWeb metronome library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
+  "main": "./dist/index.esm.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@opengeoweb/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "default": "./dist/index.esm.js"
+    }
+  },
   "devDependencies": {
     "eslint-plugin-storybook": "10.3.3"
   },
-  "dependencies": {},
-  "module": "./index.esm.js",
-  "type": "module",
-  "main": "./index.esm.js",
-  "types": "./index.d.ts"
-}
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ]
+}

package/readme.mdx

@@ -0,0 +1,7 @@
+import { Meta, Markdown } from "@storybook/addon-docs/blocks";
+ 
+import Readme from "./README.md?raw";
+ 
+<Meta title="Readme" />
+ 
+<Markdown>{Readme}</Markdown>

package/index.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";

package/index.esm.js

@@ -1,232 +0,0 @@
-function _arrayLikeToArray(r, a) {
-  (null == a || a > r.length) && (a = r.length);
-  for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e];
-  return n;
-}
-function _createForOfIteratorHelperLoose(r, e) {
-  var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
-  if (t) return (t = t.call(r)).next.bind(t);
-  if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e) {
-    t && (r = t);
-    var o = 0;
-    return function () {
-      return o >= r.length ? {
-        done: true
-      } : {
-        done: false,
-        value: r[o++]
-      };
-    };
-  }
-  throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-function _unsupportedIterableToArray(r, a) {
-  if (r) {
-    if ("string" == typeof r) return _arrayLikeToArray(r, a);
-    var t = {}.toString.call(r).slice(8, -1);
-    return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0;
-  }
-}
-
-/* *
- * 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)
- * Copyright 2024 - The Norwegian Meteorological Institute (MET Norway)
- * */
-/**
- * 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() {
-    this.tickId = void 0;
-    this.timers = void 0;
-    this.interval = void 0;
-    this.handleTimerTicks = void 0;
-    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 = [];
-  }
-  var _proto = Metronome.prototype;
-  _proto.init = function init() {
-    if (this.interval != null) {
-      clearInterval(this.interval);
-    }
-    this.interval = setInterval(this.step, 10);
-  };
-  _proto.unregisterAllTimers = function unregisterAllTimers() {
-    this.timers.length = 0;
-  };
-  _proto.step = 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 == null || timer.timerFunc(timer.timerId, _this.tickId);
-          triggeredTimerIds.push(timer.timerId);
-        }
-      }
-    });
-    // Trigger the handleTimerTicks function with all collected timerIds
-    if (triggeredTimerIds.length > 0) {
-      var _this$handleTimerTick;
-      (_this$handleTimerTick = this.handleTimerTicks) == null || _this$handleTimerTick.call(this, 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
-   */;
-  _proto.register = 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
-   */;
-  _proto.unregister = 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
-   */;
-  _proto.isPaused = function isPaused(timerId) {
-    for (var _iterator = _createForOfIteratorHelperLoose(this.timers), _step; !(_step = _iterator()).done;) {
-      var timer = _step.value;
-      if (timer.timerId === timerId && timer.isPaused) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  /**
-   * Continues running a timer
-   *
-   * @param timerId Id of the timer
-   */;
-  _proto.continueTimer = function continueTimer(timerId) {
-    for (var _iterator2 = _createForOfIteratorHelperLoose(this.timers), _step2; !(_step2 = _iterator2()).done;) {
-      var timer = _step2.value;
-      if (timer.timerId === timerId) {
-        timer.isPaused = false;
-        break;
-      }
-    }
-  }
-
-  /**
-   * Pauses a timer
-   *
-   * @param timerId Id of the timer
-   */;
-  _proto.pauseTimer = function pauseTimer(timerId) {
-    for (var _iterator3 = _createForOfIteratorHelperLoose(this.timers), _step3; !(_step3 = _iterator3()).done;) {
-      var timer = _step3.value;
-      if (timer.timerId === timerId) {
-        timer.isPaused = true;
-        break;
-      }
-    }
-  }
-
-  /**
-   * 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
-   */;
-  _proto.toggleTimer = function toggleTimer(timerId) {
-    for (var _iterator4 = _createForOfIteratorHelperLoose(this.timers), _step4; !(_step4 = _iterator4()).done;) {
-      var timer = _step4.value;
-      if (timer.timerId === timerId) {
-        timer.isPaused = !timer.isPaused;
-        break;
-      }
-    }
-  }
-
-  /**
-   * 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
-   */;
-  _proto.setSpeed = function setSpeed(timerId, hertz) {
-    for (var _iterator5 = _createForOfIteratorHelperLoose(this.timers), _step5; !(_step5 = _iterator5()).done;) {
-      var timer = _step5.value;
-      if (timer.timerId === timerId) {
-        timer.hertz = hertz;
-        break;
-      }
-    }
-  };
-  return Metronome;
-}();
-var metronome = new Metronome();
-
-export { metronome };