tiny-essentials 1.28.1 → 1.28.2

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

@@ -1,14 +1,4 @@
-export default 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:
- * - a string containing the selected weather configuration name, or
- * - `null` if no selection has been made.
- */
 export type SelectedWeather = Record<string, string | null>;
-/**
- * Callback used to dynamically calculate weather probabilities.
- */
 export type WeatherCallback = (configs: {
     hour: number;
     minute: number;
@@ -17,9 +7,6 @@ export type WeatherCallback = (configs: {
     season: string;
     weather: SelectedWeather;
 }) => number;
-/**
- * Represents the complete set of weather configurations.
- */
 export type WeatherCfgs = {
     /**
      * - Default weather configuration applied when no specific condition matches.
@@ -42,18 +29,8 @@ export type WeatherCfgs = {
      */
     seasons: Record<string, WeatherCfg>;
 };
-/**
- * A weather configuration object mapping weather types to probability weights
- * or dynamic WeatherCallback functions.
- */
 export type WeatherCfg = Record<string, number | WeatherCallback>;
-/**
- * Weather data with resolved numeric probability values.
- */
 export type WeatherData = Record<string, number>;
-/**
- * Represents the data for a moon's current phase.
- */
 export type MoonData = {
     /**
      * - The name of the moon.
@@ -72,9 +49,6 @@ export type MoonData = {
      */
     cycleLength: number;
 };
-/**
- * Represents the raw data structure for a moon's cycle.
- */
 export type MoonRaw = {
     /**
      * - The name of the moon.
@@ -91,7 +65,7 @@ export type MoonRaw = {
     /**
      * - Optional list of names for each phase in the cycle.
      */
-    phaseNames?: string[] | undefined;
+    phaseNames?: string[];
 };
 /**
  * Represents a mapping of weather type names to their selected values.
@@ -175,23 +149,17 @@ export type MoonRaw = {
  * Time and date calculations are independent from the real world and can run at any speed.
  */
 declare class TinyDayNightCycle {
-    /**
-     * @param {number} dayStart - Hour of the day start (0-23)
-     * @param {number} nightStart - Hour of the night start (0-23)
-     */
-    constructor(dayStart?: number, nightStart?: number);
-    /**
-     * Sets the number of in-game seconds representing a full day.
-     * Keeps the proportion based on the current `hourSize` and `minuteSize` if `autoSizeAdjuste` is enabled.
-     * @param {number} value - Positive finite number representing seconds in a full day.
-     * @throws {Error} If `value` is not a positive finite number.
-     */
-    set daySize(value: number);
+    #private;
     /**
      * Gets the number of in-game seconds representing a full day.
      * @returns {number}
      */
     get daySize(): number;
+    /**
+     * Gets whether automatic size adjustment is enabled.
+     * @returns {boolean}
+     */
+    get autoSizeAdjuste(): boolean;
     /**
      * Sets whether automatic size adjustment is enabled.
      * @param {boolean} value - `true` to keep the proportional relation between day, hour, and minute sizes; `false` to disable auto-adjustment.
@@ -199,10 +167,17 @@ declare class TinyDayNightCycle {
      */
     set autoSizeAdjuste(value: boolean);
     /**
-     * Gets whether automatic size adjustment is enabled.
-     * @returns {boolean}
+     * Sets the number of in-game seconds representing a full day.
+     * Keeps the proportion based on the current `hourSize` and `minuteSize` if `autoSizeAdjuste` is enabled.
+     * @param {number} value - Positive finite number representing seconds in a full day.
+     * @throws {Error} If `value` is not a positive finite number.
      */
-    get autoSizeAdjuste(): boolean;
+    set daySize(value: number);
+    /**
+     * Gets the number of in-game seconds representing a full hour.
+     * @returns {number}
+     */
+    get hourSize(): number;
     /**
      * Sets the number of in-game seconds representing a full hour.
      * Keeps the proportion based on the current `daySize` and `minuteSize` if `autoSizeAdjuste` is enabled.
@@ -211,10 +186,10 @@ declare class TinyDayNightCycle {
      */
     set hourSize(value: number);
     /**
-     * Gets the number of in-game seconds representing a full hour.
+     * Gets the number of in-game seconds representing a full minute.
      * @returns {number}
      */
-    get hourSize(): number;
+    get minuteSize(): number;
     /**
      * Sets the number of in-game seconds representing a full minute.
      * Keeps the proportion based on the current `daySize` and `hourSize` if `autoSizeAdjuste` is enabled.
@@ -222,16 +197,16 @@ declare class TinyDayNightCycle {
      * @throws {Error} If `value` is not a positive finite number.
      */
     set minuteSize(value: number);
-    /**
-     * Gets the number of in-game seconds representing a full minute.
-     * @returns {number}
-     */
-    get minuteSize(): number;
     /**
      * Indicates whether this instance has been destroyed.
      * @type {boolean}
      */
     get isDestroyed(): boolean;
+    /**
+     * Gets the current time in seconds since midnight.
+     * @returns {number} Current seconds (0 to 86399).
+     */
+    get currentSeconds(): number;
     /**
      * Sets the current time in seconds since midnight.
      * Also updates the currentMinutes property accordingly.
@@ -241,10 +216,10 @@ declare class TinyDayNightCycle {
      */
     set currentSeconds(value: number);
     /**
-     * Gets the current time in seconds since midnight.
-     * @returns {number} Current seconds (0 to 86399).
+     * Gets the current time in minutes since midnight.
+     * @returns {number} Current minutes (0 to 1439).
      */
-    get currentSeconds(): number;
+    get currentMinutes(): number;
     /**
      * Sets the current time in minutes since midnight.
      * Also updates the currentSeconds property accordingly (seconds set to zero).
@@ -254,10 +229,11 @@ declare class TinyDayNightCycle {
      */
     set currentMinutes(value: number);
     /**
-     * Gets the current time in minutes since midnight.
-     * @returns {number} Current minutes (0 to 1439).
+     * Gets the current time in hours since midnight.
+     * May be a decimal value (e.g., 14.5 = 14:30).
+     * @returns {number} Current hours (0 to less than 24).
      */
-    get currentMinutes(): number;
+    get currentHours(): number;
     /**
      * Sets the current time in hours since midnight.
      * Accepts decimal numbers to specify partial hours.
@@ -267,12 +243,6 @@ declare class TinyDayNightCycle {
      * @throws {RangeError} If the value is outside the valid range.
      */
     set currentHours(value: number);
-    /**
-     * Gets the current time in hours since midnight.
-     * May be a decimal value (e.g., 14.5 = 14:30).
-     * @returns {number} Current hours (0 to less than 24).
-     */
-    get currentHours(): number;
     /**
      * Returns all moons with their current phase details.
      * @returns {MoonData[]} Array of moons including their name, current phase index, phase name, and cycle length.
@@ -283,30 +253,54 @@ declare class TinyDayNightCycle {
      * @returns {string[]} Array of season names.
      */
     get seasons(): string[];
+    /** @returns {number} Hour at which day starts (0-23). */
+    get dayStart(): number;
+    /** @returns {number} Hour at which night starts (0-23). */
+    get nightStart(): number;
+    /** @returns {SelectedWeather} Currently active weather types or nulls if none. */
+    get weather(): SelectedWeather;
+    /** @returns {string} Currently active season name. */
+    get currentSeason(): string;
+    /** @returns {number} Current day of the month. */
+    get currentDay(): number;
+    /** @returns {number} Current month number. */
+    get currentMonth(): number;
+    /** @returns {number} Current year count. */
+    get currentYear(): number;
+    /**
+     * Returns a shallow copy of the mapping of month numbers to days.
+     * Can be customized for non-standard calendar systems.
+     * @returns {number[]} Object mapping month number to days.
+     */
+    get monthDays(): number[];
+    /**
+     * Returns the configured range of weather durations in minutes.
+     * @returns {{min: number, max: number}} Object with min and max weather duration.
+     */
+    get weatherDuration(): {
+        min: number;
+        max: number;
+    };
+    /** @returns {number} Minutes left until current weather expires. */
+    get weatherTimeLeft(): number;
     /**
      * Sets the hour at which day starts.
      * @param {number} value Hour (0-23).
      * @throws {TypeError} If value is not a number.
      */
     set dayStart(value: number);
-    /** @returns {number} Hour at which day starts (0-23). */
-    get dayStart(): number;
     /**
      * Sets the hour at which night starts.
      * @param {number} value Hour (0-23).
      * @throws {TypeError} If value is not a number.
      */
     set nightStart(value: number);
-    /** @returns {number} Hour at which night starts (0-23). */
-    get nightStart(): number;
     /**
      * Sets the current weather type.
      * @param {SelectedWeather} value Weather type strings or nulls for no weather.
      * @throws {TypeError} If value is not a string or null.
      */
     set weather(value: SelectedWeather);
-    /** @returns {SelectedWeather} Currently active weather types or nulls if none. */
-    get weather(): SelectedWeather;
     /**
      * Sets the current season.
      * Must be one of the configured seasons.
@@ -314,44 +308,30 @@ declare class TinyDayNightCycle {
      * @throws {TypeError} If value is not a string or not a configured season.
      */
     set currentSeason(value: string);
-    /** @returns {string} Currently active season name. */
-    get currentSeason(): string;
     /**
      * Sets the current day of the month.
      * @param {number} value Day number.
      * @throws {TypeError} If value is not a number.
      */
     set currentDay(value: number);
-    /** @returns {number} Current day of the month. */
-    get currentDay(): number;
     /**
      * Sets the current month.
      * @param {number} value Month number.
      * @throws {TypeError} If value is not a number.
      */
     set currentMonth(value: number);
-    /** @returns {number} Current month number. */
-    get currentMonth(): number;
     /**
      * Sets the current year.
      * @param {number} value Year count.
      * @throws {TypeError} If value is not a number.
      */
     set currentYear(value: number);
-    /** @returns {number} Current year count. */
-    get currentYear(): number;
     /**
      * Sets a custom configuration for the number of days in each month.
      * This allows for non-standard calendar systems.
      * @param {number[]} value - An object where keys are month numbers and values are the number of days.
      */
     set monthDays(value: number[]);
-    /**
-     * Returns a shallow copy of the mapping of month numbers to days.
-     * Can be customized for non-standard calendar systems.
-     * @returns {number[]} Object mapping month number to days.
-     */
-    get monthDays(): number[];
     /**
      * Sets the weather duration range in minutes.
      * @param {{min: number, max: number}} value Object with min and max durations.
@@ -361,22 +341,18 @@ declare class TinyDayNightCycle {
         min: number;
         max: number;
     });
-    /**
-     * Returns the configured range of weather durations in minutes.
-     * @returns {{min: number, max: number}} Object with min and max weather duration.
-     */
-    get weatherDuration(): {
-        min: number;
-        max: number;
-    };
     /**
      * Sets the remaining time for current weather in minutes.
      * @param {number} value Minutes remaining.
      * @throws {TypeError} If value is not a number.
      */
     set weatherTimeLeft(value: number);
-    /** @returns {number} Minutes left until current weather expires. */
-    get weatherTimeLeft(): number;
+    /**
+     * Returns the entire weather configuration object.
+     * Includes default, day, night, hours, and seasons settings.
+     * @returns {WeatherCfgs} Deep copy of the weather configuration.
+     */
+    get weatherConfig(): WeatherCfgs;
     /**
      * Sets the entire weather configuration object.
      * Accepts default, day, night, hours, and seasons settings.
@@ -385,11 +361,10 @@ declare class TinyDayNightCycle {
      */
     set weatherConfig(config: WeatherCfgs);
     /**
-     * Returns the entire weather configuration object.
-     * Includes default, day, night, hours, and seasons settings.
-     * @returns {WeatherCfgs} Deep copy of the weather configuration.
+     * @param {number} dayStart - Hour of the day start (0-23)
+     * @param {number} nightStart - Hour of the night start (0-23)
      */
-    get weatherConfig(): WeatherCfgs;
+    constructor(dayStart?: number, nightStart?: number);
     /** --------------------- SEASON SYSTEM --------------------- */
     /**
      * Adds or updates a season with the provided numeric values.
@@ -432,9 +407,9 @@ declare class TinyDayNightCycle {
      * @param {number} [settings.second=0] - 0 to 59
      */
     setTime({ hour, minute, second }: {
-        hour?: number | undefined;
-        minute?: number | undefined;
-        second?: number | undefined;
+        hour?: number;
+        minute?: number;
+        second?: number;
     }): void;
     /**
      * Adds time to the current clock.
@@ -444,9 +419,9 @@ declare class TinyDayNightCycle {
      * @param {number} [settings.seconds=0]
      */
     addTime({ hours, minutes, seconds }: {
-        hours?: number | undefined;
-        minutes?: number | undefined;
-        seconds?: number | undefined;
+        hours?: number;
+        minutes?: number;
+        seconds?: number;
     }): void;
     /**
      * Returns the current time as both an object and a formatted string,
@@ -464,9 +439,9 @@ declare class TinyDayNightCycle {
      * }} An object containing the hour, minute, second, and the formatted time string.
      */
     getTime({ withSeconds, hourSize, minuteSize }?: {
-        hourSize?: number | undefined;
-        minuteSize?: number | undefined;
-        withSeconds?: boolean | undefined;
+        hourSize?: number;
+        minuteSize?: number;
+        withSeconds?: boolean;
     }): {
         hour: number;
         minute: number;
@@ -519,7 +494,7 @@ declare class TinyDayNightCycle {
      * @param {'minutes'|'seconds'|'hours'} unit - The unit to return.
      * @returns {number} Time until target hour, in the specified unit.
      */
-    timeUntil(targetHour: number, unit: "minutes" | "seconds" | "hours"): number;
+    timeUntil(targetHour: number, unit: 'minutes' | 'seconds' | 'hours'): number;
     /**
      * Instantly sets the current time to the start of the specified phase.
      * @param {"day"|"night"} phase - The phase to set the time to.
@@ -571,9 +546,9 @@ declare class TinyDayNightCycle {
      * @param {number|null} [settings.duration=null] - Duration in minutes. If null, a random duration is used.
      */
     forceWeather({ where, type, duration }: {
-        where?: string | undefined;
+        where?: string;
         type: string | null;
-        duration?: number | null | undefined;
+        duration?: number | null;
     }): void;
     /**
      * Chooses a new weather type based on configured probabilities.
@@ -590,8 +565,8 @@ declare class TinyDayNightCycle {
      * @returns {string|null} - The selected weather type, or null if none selected.
      */
     chooseNewWeather({ customWeather, where }?: {
-        where?: string | undefined;
-        customWeather?: WeatherCfg | undefined;
+        where?: string;
+        customWeather?: WeatherCfg;
     }): string | null;
     /**
      * Returns a random integer between min and max, inclusive.
@@ -663,6 +638,6 @@ declare class TinyDayNightCycle {
      * Once destroyed, any further method calls should throw an error or be ignored.
      */
     destroy(): void;
-    #private;
 }
+export default TinyDayNightCycle;
 //# sourceMappingURL=TinyDayNightCycle.d.mts.map

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

@@ -1,13 +1,10 @@
-export default TinyDomReadyManager;
 /**
  * A basic function that performs a task when the system is ready.
  * Used for handlers in the readiness queue.
+ *
+ * @typedef {() => void} Fn
  */
 export type Fn = () => void;
-/**
- * A function that determines whether a specific handler should be executed.
- * Should return `true` to allow execution, or `false` to skip the handler.
- */
 export type FnFilter = () => boolean;
 export type Handler = {
     /**
@@ -31,12 +28,6 @@ export type Handler = {
      */
     domOnly: boolean;
 };
-/**
- * A basic function that performs a task when the system is ready.
- * Used for handlers in the readiness queue.
- *
- * @typedef {() => void} Fn
- */
 /**
  * A function that determines whether a specific handler should be executed.
  * Should return `true` to allow execution, or `false` to skip the handler.
@@ -52,6 +43,7 @@ export type Handler = {
  * @property {boolean} domOnly - Whether to run as soon as DOM is ready (before full readiness).
  */
 declare class TinyDomReadyManager {
+    #private;
     /**
      * Marks the system as DOM-ready and runs DOM-only handlers.
      * @private
@@ -79,10 +71,10 @@ declare class TinyDomReadyManager {
      * @throws {TypeError} If fn is not a function.
      */
     onReady(fn: Fn, { once, priority, filter, domOnly }?: {
-        once?: boolean | undefined;
-        priority?: number | undefined;
-        filter?: FnFilter | null | undefined;
-        domOnly?: boolean | undefined;
+        once?: boolean;
+        priority?: number;
+        filter?: FnFilter | null;
+        domOnly?: boolean;
     }): void;
     /**
      * Returns whether the system is fully ready (DOM + Promises).
@@ -95,6 +87,6 @@ declare class TinyDomReadyManager {
      * @returns {boolean}
      */
     isDomReady(): boolean;
-    #private;
 }
+export default TinyDomReadyManager;
 //# sourceMappingURL=TinyDomReadyManager.d.mts.map

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

@@ -1,21 +1,20 @@
-export default TinyDragDropDetector;
 export type DragAndDropOptions = {
     /**
      * - CSS class applied to the target element while files are being dragged over it.
      */
-    hoverClass?: string | undefined;
+    hoverClass?: string;
     /**
      * - Callback function executed when files are dropped onto the target.
      */
-    onDrop?: ((files: FileList, event: DragEvent) => void) | undefined;
+    onDrop?: (files: FileList, event: DragEvent) => void;
     /**
      * - Optional callback triggered when dragging enters the target area.
      */
-    onEnter?: ((event: DragEvent) => void) | undefined;
+    onEnter?: (event: DragEvent) => void;
     /**
      * - Optional callback triggered when dragging leaves the target area.
      */
-    onLeave?: ((event: DragEvent) => void) | undefined;
+    onLeave?: (event: DragEvent) => void;
 };
 /**
  * @typedef {Object} DragAndDropOptions
@@ -34,6 +33,13 @@ export type DragAndDropOptions = {
  * @template {HTMLElement} HTMLTarget
  */
 declare class TinyDragDropDetector<HTMLTarget extends HTMLElement> {
+    #private;
+    /**
+     * Gets the current destruction status of the instance.
+     *
+     * @returns {boolean} True if the instance is destroyed, false otherwise.
+     */
+    get destroyed(): boolean;
     /**
      * Creates a new instance of TinyDragDropDetector to handle drag-and-drop file detection.
      *
@@ -47,11 +53,25 @@ declare class TinyDragDropDetector<HTMLTarget extends HTMLElement> {
      */
     constructor(target: HTMLTarget, options: DragAndDropOptions);
     /**
-     * Gets the current destruction status of the instance.
-     *
-     * @returns {boolean} True if the instance is destroyed, false otherwise.
+     * Returns the current target DOM element where the listeners are attached.
+     * @returns {HTMLTarget}
      */
-    get destroyed(): boolean;
+    getTarget(): HTMLTarget;
+    /**
+     * Returns the CSS class applied during drag hover.
+     * @returns {string}
+     */
+    getHoverClass(): string;
+    /**
+     * Returns whether a drag operation is currently active over the target.
+     * @returns {boolean}
+     */
+    isDragging(): boolean;
+    /**
+     * Returns whether the event listeners are currently bound to the target.
+     * @returns {boolean}
+     */
+    bound(): boolean;
     /**
      * Handles the `dragenter` event.
      * Adds the hover CSS class and triggers the `onEnter` callback if provided.
@@ -84,32 +104,12 @@ declare class TinyDragDropDetector<HTMLTarget extends HTMLElement> {
      * @returns {void}
      */
     private _handleDrop;
-    /**
-     * Returns the current target DOM element where the listeners are attached.
-     * @returns {HTMLTarget}
-     */
-    getTarget(): HTMLTarget;
-    /**
-     * Returns the CSS class applied during drag hover.
-     * @returns {string}
-     */
-    getHoverClass(): string;
-    /**
-     * Returns whether a drag operation is currently active over the target.
-     * @returns {boolean}
-     */
-    isDragging(): boolean;
-    /**
-     * Returns whether the event listeners are currently bound to the target.
-     * @returns {boolean}
-     */
-    bound(): boolean;
     /**
      * Destroys the detector instance, unbinding all event listeners and cleaning up.
      * Should be called when the detector is no longer needed to avoid memory leaks.
      * @returns {void}
      */
     destroy(): void;
-    #private;
 }
+export default TinyDragDropDetector;
 //# sourceMappingURL=TinyDragDropDetector.d.mts.map