tiny-essentials 1.27.1 → 1.28.1

package/dist/v1/libs/TinyDayNightCycle.cjs

@@ -1,5 +1,9 @@
 'use strict';
 
+var utils = require('./utils.cjs');
+
+const checkDestroy = utils.createCheckDestroyed('TinyDayNightCycle');
+
 /**
  * Represents a mapping of weather type names to their selected values.
  * Each key is the name of a weather type, and the value is either:
@@ -244,6 +248,7 @@ class TinyDayNightCycle {
    * @returns {number}
    */
   get daySize() {
+    checkDestroy(this.#isDestroyed);
     return this.#daySize;
   }
 
@@ -252,6 +257,7 @@ class TinyDayNightCycle {
    * @returns {boolean}
    */
   get autoSizeAdjuste() {
+    checkDestroy(this.#isDestroyed);
     return this.#autoSizeAdjuste;
   }
 
@@ -261,6 +267,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If `value` is not a boolean.
    */
   set autoSizeAdjuste(value) {
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'boolean') throw new TypeError('autoSizeAdjuste must be a boolean.');
     this.#autoSizeAdjuste = value;
   }
@@ -272,6 +279,7 @@ class TinyDayNightCycle {
    * @throws {Error} If `value` is not a positive finite number.
    */
   set daySize(value) {
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value) || value <= 0)
       throw new Error('daySize must be a positive finite number.');
 
@@ -290,6 +298,7 @@ class TinyDayNightCycle {
    * @returns {number}
    */
   get hourSize() {
+    checkDestroy(this.#isDestroyed);
     return this.#hourSize;
   }
 
@@ -300,6 +309,7 @@ class TinyDayNightCycle {
    * @throws {Error} If `value` is not a positive finite number.
    */
   set hourSize(value) {
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value) || value <= 0)
       throw new Error('hourSize must be a positive finite number.');
 
@@ -318,6 +328,7 @@ class TinyDayNightCycle {
    * @returns {number}
    */
   get minuteSize() {
+    checkDestroy(this.#isDestroyed);
     return this.#minuteSize;
   }
 
@@ -328,6 +339,7 @@ class TinyDayNightCycle {
    * @throws {Error} If `value` is not a positive finite number.
    */
   set minuteSize(value) {
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value) || value <= 0)
       throw new Error('minuteSize must be a positive finite number.');
 
@@ -354,6 +366,7 @@ class TinyDayNightCycle {
    * @returns {number} Current seconds (0 to 86399).
    */
   get currentSeconds() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentSeconds;
   }
 
@@ -365,7 +378,7 @@ class TinyDayNightCycle {
    * @throws {RangeError} If the value is outside the valid range.
    */
   set currentSeconds(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value))
       throw new TypeError(`currentSeconds must be a finite number, received ${typeof value}`);
     if (value < 0 || value >= this.#daySize)
@@ -380,6 +393,7 @@ class TinyDayNightCycle {
    * @returns {number} Current minutes (0 to 1439).
    */
   get currentMinutes() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentMinutes;
   }
 
@@ -391,7 +405,7 @@ class TinyDayNightCycle {
    * @throws {RangeError} If the value is outside the valid range.
    */
   set currentMinutes(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value))
       throw new TypeError(`currentMinutes must be a finite number, received ${typeof value}`);
     if (value < 0 || value >= 1440)
@@ -407,6 +421,7 @@ class TinyDayNightCycle {
    * @returns {number} Current hours (0 to less than 24).
    */
   get currentHours() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentHours;
   }
 
@@ -419,7 +434,7 @@ class TinyDayNightCycle {
    * @throws {RangeError} If the value is outside the valid range.
    */
   set currentHours(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || !Number.isFinite(value))
       throw new TypeError(`currentHours must be a finite number, received ${typeof value}`);
     if (value < 0 || value >= 24)
@@ -434,6 +449,7 @@ class TinyDayNightCycle {
    * @returns {MoonData[]} Array of moons including their name, current phase index, phase name, and cycle length.
    */
   get moons() {
+    checkDestroy(this.#isDestroyed);
     return this.#moons.map((moon) => this.getMoon(moon));
   }
 
@@ -442,41 +458,49 @@ class TinyDayNightCycle {
    * @returns {string[]} Array of season names.
    */
   get seasons() {
+    checkDestroy(this.#isDestroyed);
     return Array.from(this.#seasons.keys());
   }
 
   /** @returns {number} Hour at which day starts (0-23). */
   get dayStart() {
+    checkDestroy(this.#isDestroyed);
     return this.#dayStart;
   }
 
   /** @returns {number} Hour at which night starts (0-23). */
   get nightStart() {
+    checkDestroy(this.#isDestroyed);
     return this.#nightStart;
   }
 
   /** @returns {SelectedWeather} Currently active weather types or nulls if none. */
   get weather() {
+    checkDestroy(this.#isDestroyed);
     return { ...this.#weather };
   }
 
   /** @returns {string} Currently active season name. */
   get currentSeason() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentSeason;
   }
 
   /** @returns {number} Current day of the month. */
   get currentDay() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentDay;
   }
 
   /** @returns {number} Current month number. */
   get currentMonth() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentMonth;
   }
 
   /** @returns {number} Current year count. */
   get currentYear() {
+    checkDestroy(this.#isDestroyed);
     return this.#currentYear;
   }
 
@@ -486,6 +510,7 @@ class TinyDayNightCycle {
    * @returns {number[]} Object mapping month number to days.
    */
   get monthDays() {
+    checkDestroy(this.#isDestroyed);
     return [...this.#monthDays];
   }
 
@@ -494,11 +519,13 @@ class TinyDayNightCycle {
    * @returns {{min: number, max: number}} Object with min and max weather duration.
    */
   get weatherDuration() {
+    checkDestroy(this.#isDestroyed);
     return { ...this.#weatherDuration };
   }
 
   /** @returns {number} Minutes left until current weather expires. */
   get weatherTimeLeft() {
+    checkDestroy(this.#isDestroyed);
     return this.#weatherTimeLeft;
   }
 
@@ -508,7 +535,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set dayStart(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || value < 1)
       throw new TypeError(`dayStart must be a positive non-zero number, received ${typeof value}`);
     this.#dayStart = value;
@@ -520,7 +547,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set nightStart(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || value < 1)
       throw new TypeError(
         `nightStart must be a positive non-zero number, received ${typeof value}`,
@@ -534,7 +561,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a string or null.
    */
   set weather(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (
       typeof value !== 'object' ||
       value === null ||
@@ -552,7 +579,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a string or not a configured season.
    */
   set currentSeason(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'string' || !this.#seasons.has(value)) {
       throw new TypeError(
         `currentSeason must be one of ${Array.from(this.#seasons)
@@ -569,7 +596,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set currentDay(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || value < 1 || value > this.#monthDays[this.#currentMonth - 1])
       throw new TypeError(`currentDay must be a valid day number, received ${typeof value}`);
     this.#currentDay = value;
@@ -581,7 +608,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set currentMonth(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || typeof this.#monthDays[value - 1] !== 'number')
       throw new TypeError(`currentMonth must be a valid month number, received ${typeof value}`);
     this.#currentMonth = value;
@@ -593,7 +620,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set currentYear(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number' || value < 1)
       throw new TypeError(
         `currentYear must be a positive number non-zero, received ${typeof value}`,
@@ -607,7 +634,7 @@ class TinyDayNightCycle {
    * @param {number[]} value - An object where keys are month numbers and values are the number of days.
    */
   set monthDays(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (!Array.isArray(value)) throw new TypeError(`monthDays must be a array`);
     if (!value.every((n) => typeof n === 'number'))
       throw new TypeError(`monthDays must have number values`);
@@ -620,7 +647,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value or its min/max are invalid.
    */
   set weatherDuration(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'object' || value === null)
       throw new TypeError(`weatherDuration must be a non-null object`);
     if (typeof value.min !== 'number' || typeof value.max !== 'number')
@@ -634,7 +661,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If value is not a number.
    */
   set weatherTimeLeft(value) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof value !== 'number')
       throw new TypeError(`weatherTimeLeft must be a number, received ${typeof value}`);
     this.#weatherTimeLeft = value;
@@ -646,6 +673,7 @@ class TinyDayNightCycle {
    * @returns {WeatherCfgs} Deep copy of the weather configuration.
    */
   get weatherConfig() {
+    checkDestroy(this.#isDestroyed);
     /** @type {Record<string, WeatherCfg>} */
     const hours = {};
     /** @type {Record<string, WeatherCfg>} */
@@ -672,7 +700,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If the provided value is not a valid object or contains invalid data types.
    */
   set weatherConfig(config) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof config !== 'object' || config === null)
       throw new TypeError(`weatherConfig must be a non-null object, received ${config}`);
 
@@ -750,7 +778,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If `name` is not a string or `values` is not an array of numbers.
    */
   addSeason(name, values) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError(`Season name must be a string, received ${typeof name}`);
     if (!Array.isArray(values) || !values.every((v) => typeof v === 'number'))
@@ -765,7 +793,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If `name` is not a string.
    */
   removeSeason(name) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError(`Season name must be a string, received ${typeof name}`);
     this.#seasons.delete(name);
@@ -780,6 +808,7 @@ class TinyDayNightCycle {
    * @throws {TypeError} If `name` is not a string.
    */
   hasSeason(name) {
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError(`Season name must be a string, received ${typeof name}`);
     return this.#seasons.has(name);
@@ -794,6 +823,7 @@ class TinyDayNightCycle {
    * @throws {Error} If the season does not exist.
    */
   getSeason(name) {
+    checkDestroy(this.#isDestroyed);
     if (typeof name !== 'string')
       throw new TypeError(`Season name must be a string, received ${typeof name}`);
     const result = this.#seasons.get(name);
@@ -811,7 +841,7 @@ class TinyDayNightCycle {
    * @param {number} [settings.second=0] - 0 to 59
    */
   setTime({ hour = 0, minute = 0, second = 0 }) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.currentSeconds =
       (hour * this.#hourSize + minute * this.#minuteSize + second) % this.#daySize;
   }
@@ -824,7 +854,7 @@ class TinyDayNightCycle {
    * @param {number} [settings.seconds=0]
    */
   addTime({ hours = 0, minutes = 0, seconds = 0 }) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     let total = this.currentSeconds + hours * this.#hourSize + minutes * this.#minuteSize + seconds;
 
     while (total >= this.#daySize) {
@@ -858,6 +888,7 @@ class TinyDayNightCycle {
    * }} An object containing the hour, minute, second, and the formatted time string.
    */
   getTime({ withSeconds = false, hourSize = this.#hourSize, minuteSize = this.#minuteSize } = {}) {
+    checkDestroy(this.#isDestroyed);
     const hour = Math.floor(this.currentSeconds / hourSize);
     const minute = Math.floor((this.currentSeconds % hourSize) / minuteSize);
     const second = this.currentSeconds % minuteSize;
@@ -879,6 +910,7 @@ class TinyDayNightCycle {
    * @returns {boolean} True if current time is day, false otherwise.
    */
   isDay() {
+    checkDestroy(this.#isDestroyed);
     if (this.#dayStart < this.#nightStart) {
       return (
         this.#currentMinutes >= this.#dayStart * this.#minuteSize &&
@@ -951,7 +983,7 @@ class TinyDayNightCycle {
    * @returns {number} Time until target hour, in the specified unit.
    */
   timeUntil(targetHour, unit) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     const targetSeconds = targetHour * this.#hourSize; // 1 hour = 3600 seconds
     let diffSeconds = targetSeconds - this.#currentSeconds;
     if (diffSeconds <= 0) diffSeconds += this.#daySize; // 24h = 86400 seconds (wrap to next day)
@@ -972,7 +1004,7 @@ class TinyDayNightCycle {
    * @param {"day"|"night"} phase - The phase to set the time to.
    */
   setTo(phase) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     if (phase === 'day') this.setTime({ hour: this.#dayStart });
     else if (phase === 'night') this.setTime({ hour: this.#nightStart });
   }
@@ -986,7 +1018,7 @@ class TinyDayNightCycle {
    * @param {number} [amount=1] - Number of days to move forward.
    */
   nextDay(amount = 1) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     for (let i = 0; i < amount; i++) {
       this.#currentDay++;
       const monthDays = this.#monthDays[this.#currentMonth - 1];
@@ -1012,7 +1044,7 @@ class TinyDayNightCycle {
    * @param {number} [amount=1] - Number of days to move backward.
    */
   prevDay(amount = 1) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     for (let i = 0; i < amount; i++) {
       this.#currentDay--;
       if (this.#currentDay < 1) {
@@ -1032,7 +1064,7 @@ class TinyDayNightCycle {
    * Updates the current season based on the month.
    */
   updateSeason() {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.#seasons.forEach((seasonMonths, name) => {
       if (seasonMonths.includes(this.#currentMonth)) this.#currentSeason = name;
     });
@@ -1046,7 +1078,7 @@ class TinyDayNightCycle {
    * An object defining default probabilities, time-based probabilities, day/night differences, and seasonal probabilities.
    */
   setWeatherConfig(config) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.#weatherConfig = { ...this.#weatherConfig, ...config };
   }
 
@@ -1056,7 +1088,7 @@ class TinyDayNightCycle {
    * @param {number} maxMinutes - Maximum duration in minutes.
    */
   setWeatherDuration(minMinutes, maxMinutes) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.#weatherDuration.min = minMinutes;
     this.#weatherDuration.max = maxMinutes;
   }
@@ -1067,7 +1099,7 @@ class TinyDayNightCycle {
    * @param {number} minutesPassed - Number of in-game minutes passed since last update.
    */
   updateWeatherTimer(minutesPassed) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.#weatherTimeLeft -= minutesPassed;
     if (this.#weatherTimeLeft <= 0) {
       this.chooseNewWeather();
@@ -1082,7 +1114,7 @@ class TinyDayNightCycle {
    * @param {number|null} [settings.duration=null] - Duration in minutes. If null, a random duration is used.
    */
   forceWeather({ where = 'main', type, duration = null }) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     const weather = this.#weather;
     weather[where] = type;
     this.weather = weather;
@@ -1105,7 +1137,7 @@ class TinyDayNightCycle {
    * @returns {string|null} - The selected weather type, or null if none selected.
    */
   chooseNewWeather({ customWeather, where = 'main' } = {}) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     /** @type {WeatherData} */
     let probabilities = {};
 
@@ -1202,6 +1234,7 @@ class TinyDayNightCycle {
    * @param {number} min - Minimum value.
    * @param {number} max - Maximum value.
    * @returns {number} - A random integer between min and max.
+   * @private
    */
   _randomInRange(min, max) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
@@ -1218,7 +1251,7 @@ class TinyDayNightCycle {
    * @returns {number} - The moon index.
    */
   addMoon(name, cycleLength, phaseNames, startingPhase = 0) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     const length = Math.max(1, cycleLength);
     this.#moons.push({
       name,
@@ -1234,7 +1267,7 @@ class TinyDayNightCycle {
    * @param {string} name
    */
   removeMoon(name) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     this.#moons = this.#moons.filter((m) => m.name !== name);
   }
 
@@ -1261,7 +1294,7 @@ class TinyDayNightCycle {
    * @throws {RangeError} If the moonIndex is invalid.
    */
   advanceMoon(moonIndex, days = 1) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     const moon = this.#moons[moonIndex];
     if (!moon) throw new RangeError(`No moon found at index ${moonIndex}`);
     moon.currentPhase = (moon.currentPhase + days) % moon.cycleLength;
@@ -1274,7 +1307,7 @@ class TinyDayNightCycle {
    * @throws {RangeError} If the moonIndex is invalid.
    */
   rewindMoon(moonIndex, days = 1) {
-    this._checkDestroyed();
+    checkDestroy(this.#isDestroyed);
     const moon = this.#moons[moonIndex];
     if (!moon) throw new RangeError(`No moon found at index ${moonIndex}`);
     moon.currentPhase = (moon.currentPhase - days + moon.cycleLength) % moon.cycleLength;
@@ -1287,6 +1320,7 @@ class TinyDayNightCycle {
    * @returns {boolean} `true` if a moon exists at the given index, otherwise `false`.
    */
   moonExists(index) {
+    checkDestroy(this.#isDestroyed);
     if (!this.#moons[index]) return false;
     return true;
   }
@@ -1301,6 +1335,7 @@ class TinyDayNightCycle {
    * @throws {Error} If `index` is a `MoonRaw` object but required properties are missing or invalid.
    */
   getMoon(index) {
+    checkDestroy(this.#isDestroyed);
     let moon;
 
     if (typeof index === 'number') {
@@ -1329,16 +1364,6 @@ class TinyDayNightCycle {
     };
   }
 
-  /**
-   * Checks if the instance has been destroyed and throws an error if so.
-   * @private
-   * @throws {Error} If the instance has already been destroyed.
-   */
-  _checkDestroyed() {
-    if (this.#isDestroyed)
-      throw new Error('This instance has been destroyed and can no longer be used.');
-  }
-
   /**
    * Destroys all stored data and marks the instance as unusable.
    * Clears all internal maps, arrays, and resets primitive values to defaults.

package/dist/v1/libs/TinyDayNightCycle.d.mts

@@ -598,8 +598,9 @@ declare class TinyDayNightCycle {
      * @param {number} min - Minimum value.
      * @param {number} max - Maximum value.
      * @returns {number} - A random integer between min and max.
+     * @private
      */
-    _randomInRange(min: number, max: number): number;
+    private _randomInRange;
     /** --------------------- MOON SYSTEM --------------------- */
     /**
      * Add a new moon to the system.
@@ -656,12 +657,6 @@ declare class TinyDayNightCycle {
      * @throws {Error} If `index` is a `MoonRaw` object but required properties are missing or invalid.
      */
     getMoon(index: number | MoonRaw): MoonData;
-    /**
-     * Checks if the instance has been destroyed and throws an error if so.
-     * @private
-     * @throws {Error} If the instance has already been destroyed.
-     */
-    private _checkDestroyed;
     /**
      * Destroys all stored data and marks the instance as unusable.
      * Clears all internal maps, arrays, and resets primitive values to defaults.