tiny-essentials 1.8.5 → 1.9.1

package/dist/TinyEssentials.js

@@ -2145,6 +2145,7 @@ __webpack_require__.d(__webpack_exports__, {
   ColorSafeStringify: () => (/* reexport */ libs_ColorSafeStringify),
   TinyLevelUp: () => (/* reexport */ userLevel),
   TinyPromiseQueue: () => (/* reexport */ libs_TinyPromiseQueue),
+  TinyRateLimiter: () => (/* reexport */ libs_TinyRateLimiter),
   addAiMarkerShortcut: () => (/* reexport */ addAiMarkerShortcut),
   arraySortPositions: () => (/* reexport */ arraySortPositions),
   asyncReplace: () => (/* reexport */ asyncReplace),
@@ -2201,6 +2202,15 @@ async function asyncReplace(str, regex, asyncFn) {
 }
 
 ;// ./src/legacy/libs/userLevel.mjs
+/**
+ * Represents a user object used.
+ *
+ * @typedef {Object} UserEditor
+ * @property {number} exp - Current experience points of the user.
+ * @property {number} level - Current level of the user.
+ * @property {number} totalExp - Total accumulated experience.
+ */
+
 /**
  * Class to manage user level-up logic based on experience points.
  */
@@ -2211,26 +2221,95 @@ class TinyLevelUp {
    * @param {number} expLevel - Base experience needed to level up (per level).
    */
   constructor(giveExp, expLevel) {
+    if (typeof giveExp !== 'number' || Number.isNaN(giveExp))
+      throw new Error('giveExp must be a valid number');
+    if (typeof expLevel !== 'number' || Number.isNaN(expLevel))
+      throw new Error('expLevel must be a valid number');
     this.giveExp = giveExp;
     this.expLevel = expLevel;
   }
 
   /**
-   * @typedef {{ exp: number, level: number, totalExp: number }} UserResult
+   * Creates a new user object starting at level 0 with 0 experience.
+   * @returns {UserEditor} A fresh user object.
+   */
+  createUser() {
+    return {
+      exp: 0,
+      level: 1,
+      totalExp: 0,
+    };
+  }
+
+  /**
+   * Validates if the given user object has valid numeric properties.
+   * Throws an error if any property is invalid.
+   *
+   * @param {UserEditor} user - The user object to validate.
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
+   */
+  validateUser(user) {
+    if (typeof user.exp !== 'number' || Number.isNaN(user.exp))
+      throw new Error('exp must be a valid number');
+    if (typeof user.level !== 'number' || Number.isNaN(user.level))
+      throw new Error('level must be a valid number');
+    if (user.level < 1) throw new Error('level must be at least 1');
+    if (typeof user.totalExp !== 'number' || Number.isNaN(user.totalExp))
+      throw new Error('totalExp must be a valid number');
+  }
+
+  /**
+   * Checks if the given user object is valid by verifying its numeric properties.
+   *
+   * @param {UserEditor} user - The user object to check.
+   * @returns {boolean} `true` if all properties (exp, level, totalExp) are valid numbers; otherwise `false`.
    */
+  isValidUser(user) {
+    if (typeof user.exp !== 'number' || Number.isNaN(user.exp)) return false;
+    if (typeof user.level !== 'number' || Number.isNaN(user.level)) return false;
+    if (user.level < 1) return false;
+    if (typeof user.totalExp !== 'number' || Number.isNaN(user.totalExp)) return false;
+    return true;
+  }
+
+  /**
+   * Returns the base experience value used for random experience generation.
+   * Throws an error if the internal giveExp value is not a valid number.
+   *
+   * @returns {number} The base experience value.
+   * @throws {Error} If giveExp is not a valid number.
+   */
+  getGiveExpBase() {
+    if (typeof this.giveExp !== 'number' || Number.isNaN(this.giveExp))
+      throw new Error('giveExp must be a valid number');
+    return this.giveExp;
+  }
 
   /**
-   * @typedef {{ exp: number, level: number, totalExp: any }} UserEditor
+   * Returns the base experience required to level up.
+   * Throws an error if the internal expLevel value is not a valid number.
+   *
+   * @returns {number} The base experience needed per level.
+   * @throws {Error} If expLevel is not a valid number.
    */
+  getExpLevelBase() {
+    if (typeof this.expLevel !== 'number' || Number.isNaN(this.expLevel))
+      throw new Error('expLevel must be a valid number');
+    return this.expLevel;
+  }
 
   /**
    * Validates and adjusts the user's level based on their current experience.
    * @param {UserEditor} user - The user object containing experience and level properties.
-   * @returns {UserResult} The updated user object.
+   * @returns {UserEditor} The updated user object.
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
    */
   expValidator(user) {
+    const expLevel = this.getExpLevelBase();
+    this.validateUser(user);
+
     let extraValue = 0;
-    const nextLevelExp = this.expLevel * user.level;
+    const nextLevelExp = expLevel * user.level;
 
     // Level Up
     if (user.exp >= nextLevelExp) {
@@ -2245,7 +2324,7 @@ class TinyLevelUp {
     if (user.exp < 1 && user.level > 1) {
       user.level--;
       extraValue = Math.abs(user.exp);
-      user.exp = this.expLevel * user.level;
+      user.exp = expLevel * user.level;
 
       if (extraValue > 0) return this.remove(user, extraValue, 'extra');
     }
@@ -2255,12 +2334,14 @@ class TinyLevelUp {
 
   /**
    * Calculates the total experience based on the user's level.
-   * @param {{ exp: number, level: number }} user - The user object containing experience and level properties.
+   * @param {UserEditor} user - The user object containing experience and level properties.
    * @returns {number} The total experience of the user.
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
    */
   getTotalExp(user) {
+    this.validateUser(user);
     let totalExp = 0;
-    for (let p = 1; p <= user.level; p++) totalExp += this.expLevel * p;
+    for (let p = 1; p <= user.level; p++) totalExp += this.getExpLevelBase() * p;
     totalExp += user.exp;
     return totalExp;
   }
@@ -2271,34 +2352,52 @@ class TinyLevelUp {
    * @returns {number} The generated experience points.
    */
   expGenerator(multi = 1) {
-    return Math.floor(Math.random() * this.giveExp) + 1 * multi;
+    if (typeof multi !== 'number' || Number.isNaN(multi))
+      throw new Error('multi must be a valid number');
+    return Math.floor(Math.random() * this.getGiveExpBase()) * multi;
+  }
+
+  /**
+   * Calculates how much experience is missing to next level.
+   * @param {UserEditor} user
+   * @returns {number}
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
+   */
+  getMissingExp(user) {
+    return this.getProgress(user) - user.exp;
   }
 
   /**
    * Gets the experience points required to reach the next level.
-   * @param {{ level: number }} user - The user object containing the level.
+   * @param {UserEditor} user - The user object containing the level.
    * @returns {number} The experience required for the next level.
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
    */
   progress(user) {
-    return this.expLevel * user.level;
+    return this.getProgress(user);
   }
 
   /**
    * Gets the experience points required to reach the next level.
-   * @param {{ level: number }} user - The user object containing the level.
+   * @param {UserEditor} user - The user object containing the level.
    * @returns {number} The experience required for the next level.
+   * @throws {Error} If any property (exp, level, totalExp) is not a valid number.
    */
   getProgress(user) {
-    return this.expLevel * user.level;
+    this.validateUser(user);
+    return this.getExpLevelBase() * user.level;
   }
 
   /**
    * Sets the experience value for the user, adjusting their level if necessary.
    * @param {UserEditor} user - The user object.
    * @param {number} value - The new experience value to set.
-   * @returns {UserResult} The updated user object.
+   * @returns {UserEditor} The updated user object.
    */
   set(user, value) {
+    if (typeof value !== 'number' || Number.isNaN(value))
+      throw new Error('value must be a valid number');
+
     user.exp = value;
     this.expValidator(user);
     user.totalExp = this.getTotalExp(user);
@@ -2311,9 +2410,15 @@ class TinyLevelUp {
    * @param {number} [extraExp] - Additional experience to be added.
    * @param {'add' | 'extra'} [type] - Type of addition ('add' or 'extra').
    * @param {number} [multi] - Multiplier for experience generation.
-   * @returns {UserResult} The updated user object.
+   * @returns {UserEditor} The updated user object.
    */
   give(user, extraExp = 0, type = 'add', multi = 1) {
+    if (typeof multi !== 'number' || Number.isNaN(multi))
+      throw new Error('multi must be a valid number');
+    if (typeof extraExp !== 'number' || Number.isNaN(extraExp))
+      throw new Error('extraExp must be a valid number');
+    if (typeof type !== 'string') throw new Error('type must be a valid string');
+
     if (type === 'add') user.exp += this.expGenerator(multi) + extraExp;
     else if (type === 'extra') user.exp += extraExp;
 
@@ -2328,9 +2433,15 @@ class TinyLevelUp {
    * @param {number} [extraExp] - Additional experience to remove.
    * @param {'add' | 'extra'} [type] - Type of removal ('add' or 'extra').
    * @param {number} [multi] - Multiplier for experience generation.
-   * @returns {UserResult} The updated user object.
+   * @returns {UserEditor} The updated user object.
    */
   remove(user, extraExp = 0, type = 'add', multi = 1) {
+    if (typeof multi !== 'number' || Number.isNaN(multi))
+      throw new Error('multi must be a valid number');
+    if (typeof extraExp !== 'number' || Number.isNaN(extraExp))
+      throw new Error('extraExp must be a valid number');
+    if (typeof type !== 'string') throw new Error('type must be a valid string');
+
     if (type === 'add') user.exp -= this.expGenerator(multi) + extraExp;
     else if (type === 'extra') user.exp -= extraExp;
 
@@ -3310,6 +3421,16 @@ class ColorSafeStringify {
 /* harmony default export */ const libs_ColorSafeStringify = (ColorSafeStringify);
 
 ;// ./src/v1/libs/TinyPromiseQueue.mjs
+/**
+ * @typedef {Object} QueuedTask
+ * @property {(...args: any[]) => Promise<any>|Promise<any>} task - The async task to execute.
+ * @property {(value: any) => any} resolve - The resolve function from the Promise.
+ * @property {(reason?: any) => any} reject - The reject function from the Promise.
+ * @property {string|undefined} [id] - Optional identifier for the task.
+ * @property {string|null|undefined} [marker] - Optional marker for the task.
+ * @property {number|null|undefined} [delay] - Optional delay (in ms) before the task is executed.
+ */
+
 /**
  * A queue system for managing and executing asynchronous tasks sequentially, one at a time.
  *
@@ -3319,20 +3440,10 @@ class ColorSafeStringify {
  * @class
  */
 class TinyPromiseQueue {
-  /**
-   * @typedef {Object} QueuedTask
-   * @property {(...args: any[]) => Promise<any>|Promise<any>} task - The async task to execute.
-   * @property {(value: any) => any} resolve - The resolve function from the Promise.
-   * @property {(reason?: any) => any} reject - The reject function from the Promise.
-   * @property {string|undefined} [id] - Optional identifier for the task.
-   * @property {string|null|undefined} [marker] - Optional marker for the task.
-   * @property {number|null|undefined} [delay] - Optional delay (in ms) before the task is executed.
-   */
-
-  /** @type {Array<QueuedTask>} */
+  /** @type {QueuedTask[]} */
   #queue = [];
   #running = false;
-  /** @type {Record<string, *>} */
+  /** @type {Record<string, ReturnType<typeof setTimeout>>} */
   #timeouts = {};
   /** @type {Set<string>} */
   #blacklist = new Set();
@@ -3495,8 +3606,13 @@ class TinyPromiseQueue {
    * @param {(...args: any[]) => Promise<any>|Promise<any>} task A function that returns a Promise.
    * @param {string} [id] Optional ID to identify the task in the queue.
    * @returns {Promise<any>} A Promise that resolves or rejects with the result of the task once it's processed.
+   * @throws {Error} Throws if param is invalid.
    */
   async enqueuePoint(task, id) {
+    if (typeof task !== 'function')
+      return Promise.reject(new Error('Task must be a function returning a Promise.'));
+    if (typeof id !== 'undefined' && typeof id !== 'string')
+      throw new Error('The "id" parameter must be a string.');
     if (!this.#running) return task();
     return new Promise((resolve, reject) => {
       this.#queue.push({ marker: 'POINT_MARKER', task, resolve, reject, id });
@@ -3515,8 +3631,16 @@ class TinyPromiseQueue {
    * @param {number|null} [delay] Optional delay (in ms) before the task is executed.
    * @param {string} [id] Optional ID to identify the task in the queue.
    * @returns {Promise<any>} A Promise that resolves or rejects with the result of the task once it's processed.
+   * @throws {Error} Throws if param is invalid.
    */
   enqueue(task, delay, id) {
+    if (typeof task !== 'function')
+      return Promise.reject(new Error('Task must be a function returning a Promise.'));
+    if (typeof delay !== 'undefined' && (typeof delay !== 'number' || delay < 0))
+      return Promise.reject(new Error('Delay must be a positive number or undefined.'));
+    if (typeof id !== 'undefined' && typeof id !== 'string')
+      throw new Error('The "id" parameter must be a string.');
+
     return new Promise((resolve, reject) => {
       this.#queue.push({ task, resolve, reject, id, delay });
       this.#processQueue();
@@ -3529,9 +3653,10 @@ class TinyPromiseQueue {
    *
    * @param {string} id The ID of the task to cancel.
    * @returns {boolean} True if a delay was cancelled and the task was removed.
+   * @throws {Error} Throws if `id` is not a string.
    */
   cancelTask(id) {
-    if (!id) return false;
+    if (typeof id !== 'string') throw new Error('The "id" parameter must be a string.');
     let cancelled = false;
 
     if (id in this.#timeouts) {
@@ -3555,6 +3680,203 @@ class TinyPromiseQueue {
 
 /* harmony default export */ const libs_TinyPromiseQueue = (TinyPromiseQueue);
 
+;// ./src/v1/libs/TinyRateLimiter.mjs
+/**
+ * Class representing a flexible rate limiter per user.
+ *
+ * This rate limiter can be configured by maximum number of hits,
+ * time interval, or a combination of both. It supports automatic
+ * cleanup of inactive users to optimize memory usage.
+ *
+ * @class
+ */
+class TinyRateLimiter {
+  /**
+   * @param {Object} options
+   * @param {number} [options.maxHits] - Max interactions allowed
+   * @param {number} [options.interval] - Time window in milliseconds
+   * @param {number} [options.cleanupInterval] - Interval for automatic cleanup (ms)
+   * @param {number} [options.maxIdle=300000] - Max idle time for a user before being cleaned (ms)
+   */
+  constructor({ maxHits, interval, cleanupInterval, maxIdle = 300000 }) {
+    /** @param {number|undefined} val */
+    const isPositiveInteger = (val) =>
+      typeof val === 'number' && Number.isFinite(val) && val >= 1 && Number.isInteger(val);
+
+    const isMaxHitsValid = isPositiveInteger(maxHits);
+    const isIntervalValid = isPositiveInteger(interval);
+    const isCleanupValid = isPositiveInteger(cleanupInterval);
+    const isMaxIdleValid = isPositiveInteger(maxIdle);
+
+    if (!isMaxHitsValid && !isIntervalValid)
+      throw new Error("RateLimiter requires at least one valid option: 'maxHits' or 'interval'.");
+    if (maxHits !== undefined && !isMaxHitsValid)
+      throw new Error("'maxHits' must be a positive integer if defined.");
+    if (interval !== undefined && !isIntervalValid)
+      throw new Error("'interval' must be a positive integer in milliseconds if defined.");
+    if (cleanupInterval !== undefined && !isCleanupValid)
+      throw new Error("'cleanupInterval' must be a positive integer in milliseconds if defined.");
+    if (!isMaxIdleValid) throw new Error("'maxIdle' must be a positive integer in milliseconds.");
+
+    this.maxHits = isMaxHitsValid ? maxHits : null;
+    this.interval = isIntervalValid ? interval : null;
+    this.cleanupInterval = isCleanupValid ? cleanupInterval : null;
+    this.maxIdle = maxIdle;
+
+    /** @type {Map<string, number[]>} */
+    this.userData = new Map();
+
+    /** @type {Map<string, number>} */
+    this.lastSeen = new Map();
+
+    // Start automatic cleanup only if cleanupInterval is valid
+    if (this.cleanupInterval !== null)
+      this._cleanupTimer = setInterval(() => this._cleanup(), this.cleanupInterval);
+  }
+
+  /**
+   * Get the interval window in milliseconds.
+   *
+   * @returns {number} The interval value.
+   * @throws {Error} If interval is not a valid finite number.
+   */
+  getInterval() {
+    if (typeof this.interval !== 'number' || !Number.isFinite(this.interval))
+      throw new Error("'interval' is not a valid finite number.");
+    return this.interval;
+  }
+
+  /**
+   * Get the maximum number of allowed hits.
+   *
+   * @returns {number} The maxHits value.
+   * @throws {Error} If maxHits is not a valid finite number.
+   */
+  getMaxHits() {
+    if (typeof this.maxHits !== 'number' || !Number.isFinite(this.maxHits)) {
+      throw new Error("'maxHits' is not a valid finite number.");
+    }
+    return this.maxHits;
+  }
+
+  /**
+   * Register a hit for a specific user
+   * @param {string} userId
+   */
+  hit(userId) {
+    const now = Date.now();
+
+    if (!this.userData.has(userId)) {
+      this.userData.set(userId, []);
+    }
+
+    const history = this.userData.get(userId);
+    if (!history) throw new Error(`No data found for userId: ${userId}`);
+
+    history.push(now);
+    this.lastSeen.set(userId, now);
+
+    // Clean up old entries
+    if (this.interval !== null) {
+      const interval = this.getInterval();
+      const cutoff = now - interval;
+      while (history.length && history[0] < cutoff) {
+        history.shift();
+      }
+    }
+
+    // Optional: keep only the last N entries for memory optimization
+    if (this.maxHits !== null) {
+      const maxHits = this.getMaxHits();
+      if (history.length > maxHits) {
+        history.splice(0, history.length - maxHits);
+      }
+    }
+  }
+
+  /**
+   * Check if the user is currently rate limited
+   * @param {string} userId
+   * @returns {boolean}
+   */
+  isRateLimited(userId) {
+    const now = Date.now();
+
+    if (!this.userData.has(userId)) return false;
+
+    const history = this.userData.get(userId);
+    if (!history) throw new Error(`No data found for userId: ${userId}`);
+
+    if (this.interval !== null) {
+      const interval = this.getInterval();
+      const recent = history.filter((t) => t > now - interval);
+      if (this.maxHits !== null) {
+        return recent.length >= this.getMaxHits();
+      }
+      return recent.length > 0;
+    }
+
+    if (this.maxHits !== null) {
+      return history.length >= this.getMaxHits();
+    }
+
+    return false;
+  }
+
+  /**
+   * Manually reset user data
+   * @param {string} userId
+   */
+  reset(userId) {
+    this.userData.delete(userId);
+    this.lastSeen.delete(userId);
+  }
+
+  /**
+   * Set hit timestamps for a user
+   * @param {string} userId
+   * @param {number[]} timestamps
+   */
+  setData(userId, timestamps) {
+    this.userData.set(userId, timestamps);
+    this.lastSeen.set(userId, Date.now());
+  }
+
+  /**
+   * Get timestamps from user
+   * @param {string} userId
+   * @returns {number[]}
+   */
+  getData(userId) {
+    return this.userData.get(userId) || [];
+  }
+
+  /**
+   * Cleanup old/inactive users
+   * @private
+   */
+  _cleanup() {
+    const now = Date.now();
+    for (const [userId, last] of this.lastSeen.entries()) {
+      if (now - last > this.maxIdle) {
+        this.userData.delete(userId);
+        this.lastSeen.delete(userId);
+      }
+    }
+  }
+
+  /**
+   * Destroy the rate limiter, stopping all intervals
+   */
+  destroy() {
+    if (this._cleanupTimer) clearInterval(this._cleanupTimer);
+    this.userData.clear();
+    this.lastSeen.clear();
+  }
+}
+
+/* harmony default export */ const libs_TinyRateLimiter = (TinyRateLimiter);
+
 ;// ./src/v1/index.mjs
 
 
@@ -3569,6 +3891,7 @@ class TinyPromiseQueue {
 
 
 
+
 })();
 
 window.TinyEssentials = __webpack_exports__;