tiny-essentials 1.3.0 → 1.3.2

package/dist/legacy/libs/userLevel.d.mts

@@ -11,16 +11,26 @@ declare class TinyLevelUp {
     constructor(giveExp: number, expLevel: number);
     giveExp: number;
     expLevel: number;
+    /**
+     * @typedef {{ exp: number, level: number, totalExp: number }} UserResult
+     */
+    /**
+     * @typedef {{ exp: number, level: number, totalExp: any }} UserEditor
+     */
     /**
      * Validates and adjusts the user's level based on their current experience.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object containing experience and level properties.
-     * @returns {Object} The updated user object.
+     * @param {UserEditor} user - The user object containing experience and level properties.
+     * @returns {UserResult} The updated user object.
      */
     expValidator(user: {
         exp: number;
         level: number;
         totalExp: any;
-    }): Object;
+    }): {
+        exp: number;
+        level: number;
+        totalExp: number;
+    };
     /**
      * Calculates the total experience based on the user's level.
      * @param {{ exp: number, level: number }} user - The user object containing experience and level properties.
@@ -32,7 +42,7 @@ declare class TinyLevelUp {
     }): number;
     /**
      * Generates random experience points based on the configured multiplier.
-     * @param {number} multi - A multiplier for the generated experience.
+     * @param {number} [multi] - A multiplier for the generated experience.
      * @returns {number} The generated experience points.
      */
     expGenerator(multi?: number): number;
@@ -54,39 +64,51 @@ declare class TinyLevelUp {
     }): number;
     /**
      * Sets the experience value for the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
+     * @param {UserEditor} user - The user object.
      * @param {number} value - The new experience value to set.
-     * @returns {Object} The updated user object.
+     * @returns {UserResult} The updated user object.
      */
     set(user: {
         exp: number;
         level: number;
         totalExp: any;
-    }, value: number): Object;
+    }, value: number): {
+        exp: number;
+        level: number;
+        totalExp: number;
+    };
     /**
      * Adds experience to the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
-     * @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 {Object} The updated user object.
+     * @param {UserEditor} user - The user object.
+     * @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.
      */
     give(user: {
         exp: number;
         level: number;
         totalExp: any;
-    }, extraExp?: number, type?: "add" | "extra", multi?: number): Object;
+    }, extraExp?: number, type?: "add" | "extra", multi?: number): {
+        exp: number;
+        level: number;
+        totalExp: number;
+    };
     /**
      * Removes experience from the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
-     * @param {number} extraExp - Experience to remove.
-     * @param {'add' | 'extra'} type - Type of removal ('add' or 'extra').
-     * @param {number} multi - Multiplier for experience generation.
-     * @returns {Object} The updated user object.
+     * @param {UserEditor} user - The user object.
+     * @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.
      */
     remove(user: {
         exp: number;
         level: number;
         totalExp: any;
-    }, extraExp?: number, type?: "add" | "extra", multi?: number): Object;
+    }, extraExp?: number, type?: "add" | "extra", multi?: number): {
+        exp: number;
+        level: number;
+        totalExp: number;
+    };
 }

package/dist/legacy/libs/userLevel.mjs

@@ -11,10 +11,16 @@ class TinyLevelUp {
         this.giveExp = giveExp;
         this.expLevel = expLevel;
     }
+    /**
+     * @typedef {{ exp: number, level: number, totalExp: number }} UserResult
+     */
+    /**
+     * @typedef {{ exp: number, level: number, totalExp: any }} UserEditor
+     */
     /**
      * Validates and adjusts the user's level based on their current experience.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object containing experience and level properties.
-     * @returns {Object} The updated user object.
+     * @param {UserEditor} user - The user object containing experience and level properties.
+     * @returns {UserResult} The updated user object.
      */
     expValidator(user) {
         let extraValue = 0;
@@ -51,7 +57,7 @@ class TinyLevelUp {
     }
     /**
      * Generates random experience points based on the configured multiplier.
-     * @param {number} multi - A multiplier for the generated experience.
+     * @param {number} [multi] - A multiplier for the generated experience.
      * @returns {number} The generated experience points.
      */
     expGenerator(multi = 1) {
@@ -75,9 +81,9 @@ class TinyLevelUp {
     }
     /**
      * Sets the experience value for the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
+     * @param {UserEditor} user - The user object.
      * @param {number} value - The new experience value to set.
-     * @returns {Object} The updated user object.
+     * @returns {UserResult} The updated user object.
      */
     set(user, value) {
         user.exp = value;
@@ -87,11 +93,11 @@ class TinyLevelUp {
     }
     /**
      * Adds experience to the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
-     * @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 {Object} The updated user object.
+     * @param {UserEditor} user - The user object.
+     * @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.
      */
     give(user, extraExp = 0, type = 'add', multi = 1) {
         if (type === 'add')
@@ -104,11 +110,11 @@ class TinyLevelUp {
     }
     /**
      * Removes experience from the user, adjusting their level if necessary.
-     * @param {{ exp: number, level: number, totalExp: any }} user - The user object.
-     * @param {number} extraExp - Experience to remove.
-     * @param {'add' | 'extra'} type - Type of removal ('add' or 'extra').
-     * @param {number} multi - Multiplier for experience generation.
-     * @returns {Object} The updated user object.
+     * @param {UserEditor} user - The user object.
+     * @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.
      */
     remove(user, extraExp = 0, type = 'add', multi = 1) {
         if (type === 'add')

package/dist/legacy/socket.io/antiFlood/install.cjs

@@ -11,9 +11,9 @@ var userIP = require('../../http/userIP.cjs');
  * This middleware checks the user's IP address and allows or denies the socket connection based on whether
  * the IP is in the block list or not.
  *
- * @param {Object} io - The Socket.IO server instance.
- * @param {Object} ioCache - The cache object containing blocked IPs.
- * @param {Array} ioCache.blocklick - The list of blocked IP addresses.
+ * @param {Record<string, any>} io - The Socket.IO server instance.
+ * @param {Record<string, any>} ioCache - The cache object containing blocked IPs.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IP addresses.
  * @returns {void} This function does not return a value, it just sets the authorization logic for socket connections.
  */
 function install(io, ioCache) {

package/dist/legacy/socket.io/antiFlood/install.d.mts

@@ -4,11 +4,9 @@
  * This middleware checks the user's IP address and allows or denies the socket connection based on whether
  * the IP is in the block list or not.
  *
- * @param {Object} io - The Socket.IO server instance.
- * @param {Object} ioCache - The cache object containing blocked IPs.
- * @param {Array} ioCache.blocklick - The list of blocked IP addresses.
+ * @param {Record<string, any>} io - The Socket.IO server instance.
+ * @param {Record<string, any>} ioCache - The cache object containing blocked IPs.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IP addresses.
  * @returns {void} This function does not return a value, it just sets the authorization logic for socket connections.
  */
-export default function install(io: Object, ioCache: {
-    blocklick: any[];
-}): void;
+export default function install(io: Record<string, any>, ioCache: Record<string, any>): void;

package/dist/legacy/socket.io/antiFlood/install.mjs

@@ -6,9 +6,9 @@ import userIp from '../../http/userIP.mjs';
  * This middleware checks the user's IP address and allows or denies the socket connection based on whether
  * the IP is in the block list or not.
  *
- * @param {Object} io - The Socket.IO server instance.
- * @param {Object} ioCache - The cache object containing blocked IPs.
- * @param {Array} ioCache.blocklick - The list of blocked IP addresses.
+ * @param {Record<string, any>} io - The Socket.IO server instance.
+ * @param {Record<string, any>} ioCache - The cache object containing blocked IPs.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IP addresses.
  * @returns {void} This function does not return a value, it just sets the authorization logic for socket connections.
  */
 export default function install(io, ioCache) {

package/dist/legacy/socket.io/antiFlood/verify.cjs

@@ -26,10 +26,10 @@ setInterval(function () {
  * This function checks how many times an IP has attempted to interact with the socket.
  * If the attempts exceed a threshold, the IP is temporarily banned and disconnected.
  *
- * @param {Object} socket - The socket object representing the connection.
- * @param {Object} ioCache - The cache object that holds the blocklist and flood panel data.
- * @param {Array} ioCache.blocklick - The list of blocked IPs.
- * @param {Object} floodPanel - The object tracking flooding attempts and timeouts for each IP.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
+ * @param {Record<string, any>} ioCache - The cache object that holds the blocklist and flood panel data.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IPs.
+ * @param {Record<string, any>} floodPanel - The object tracking flooding attempts and timeouts for each IP.
  * @returns {void} This function does not return anything, it modifies the floodPanel and blocklist.
  */
 function verify(socket, ioCache) {

package/dist/legacy/socket.io/antiFlood/verify.d.mts

@@ -4,12 +4,10 @@
  * This function checks how many times an IP has attempted to interact with the socket.
  * If the attempts exceed a threshold, the IP is temporarily banned and disconnected.
  *
- * @param {Object} socket - The socket object representing the connection.
- * @param {Object} ioCache - The cache object that holds the blocklist and flood panel data.
- * @param {Array} ioCache.blocklick - The list of blocked IPs.
- * @param {Object} floodPanel - The object tracking flooding attempts and timeouts for each IP.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
+ * @param {Record<string, any>} ioCache - The cache object that holds the blocklist and flood panel data.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IPs.
+ * @param {Record<string, any>} floodPanel - The object tracking flooding attempts and timeouts for each IP.
  * @returns {void} This function does not return anything, it modifies the floodPanel and blocklist.
  */
-export default function verify(socket: Object, ioCache: {
-    blocklick: any[];
-}): void;
+export default function verify(socket: Record<string, any>, ioCache: Record<string, any>): void;

package/dist/legacy/socket.io/antiFlood/verify.mjs

@@ -20,10 +20,10 @@ setInterval(function () {
  * This function checks how many times an IP has attempted to interact with the socket.
  * If the attempts exceed a threshold, the IP is temporarily banned and disconnected.
  *
- * @param {Object} socket - The socket object representing the connection.
- * @param {Object} ioCache - The cache object that holds the blocklist and flood panel data.
- * @param {Array} ioCache.blocklick - The list of blocked IPs.
- * @param {Object} floodPanel - The object tracking flooding attempts and timeouts for each IP.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
+ * @param {Record<string, any>} ioCache - The cache object that holds the blocklist and flood panel data.
+ * @param {Array<*>} ioCache.blocklick - The list of blocked IPs.
+ * @param {Record<string, any>} floodPanel - The object tracking flooding attempts and timeouts for each IP.
  * @returns {void} This function does not return anything, it modifies the floodPanel and blocklist.
  */
 export default function verify(socket, ioCache) {

package/dist/legacy/socket.io/cookie-session.cjs

@@ -6,9 +6,9 @@
  * Handles the cookie session for a socket connection by simulating an Express request and response.
  * This function uses the provided session module to manage session data for the socket connection.
  *
- * @param {Object} socket - The socket object representing the connection.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
  * @param {Function} sessionModule - The session module function, typically used with Express, that handles session logic.
- * @returns {Promise<Object>} A promise that resolves with the session object once the session is processed.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the session object once the session is processed.
  */
 function cookieSession(socket, sessionModule) {
   return new Promise((resolve) => {

package/dist/legacy/socket.io/cookie-session.d.mts

@@ -2,8 +2,8 @@
  * Handles the cookie session for a socket connection by simulating an Express request and response.
  * This function uses the provided session module to manage session data for the socket connection.
  *
- * @param {Object} socket - The socket object representing the connection.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
  * @param {Function} sessionModule - The session module function, typically used with Express, that handles session logic.
- * @returns {Promise<Object>} A promise that resolves with the session object once the session is processed.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the session object once the session is processed.
  */
-export default function cookieSession(socket: Object, sessionModule: Function): Promise<Object>;
+export default function cookieSession(socket: Record<string, any>, sessionModule: Function): Promise<Record<string, any>>;

package/dist/legacy/socket.io/cookie-session.mjs

@@ -3,9 +3,9 @@
  * Handles the cookie session for a socket connection by simulating an Express request and response.
  * This function uses the provided session module to manage session data for the socket connection.
  *
- * @param {Object} socket - The socket object representing the connection.
+ * @param {Record<string, any>} socket - The socket object representing the connection.
  * @param {Function} sessionModule - The session module function, typically used with Express, that handles session logic.
- * @returns {Promise<Object>} A promise that resolves with the session object once the session is processed.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the session object once the session is processed.
  */
 export default function cookieSession(socket, sessionModule) {
     return new Promise((resolve) => {

package/dist/legacy/socket.io/discord.cjs

@@ -9,10 +9,10 @@ var getUser = require('../firebase/discord/api/getUser.cjs');
  * Handles the Discord OAuth2 authentication for a user, stores user data in an in-memory cache,
  * and manages the user's socket connection and disconnection events.
  *
- * @param {Object} socket - The socket object representing the user's connection.
- * @param {Object} ioCache - The shared cache that stores user data and connections.
+ * @param {Record<string, any>} socket - The socket object representing the user's connection.
+ * @param {Record<string, any>} ioCache - The shared cache that stores user data and connections.
  * @param {string} token - The OAuth2 token used to fetch user data from Discord.
- * @returns {Promise<Object>} A promise that resolves with the user data and updates the cache.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the user data and updates the cache.
  */
 function discord(socket, ioCache, token) {
   return new Promise((resolve, reject) => {

package/dist/legacy/socket.io/discord.d.mts

@@ -2,9 +2,9 @@
  * Handles the Discord OAuth2 authentication for a user, stores user data in an in-memory cache,
  * and manages the user's socket connection and disconnection events.
  *
- * @param {Object} socket - The socket object representing the user's connection.
- * @param {Object} ioCache - The shared cache that stores user data and connections.
+ * @param {Record<string, any>} socket - The socket object representing the user's connection.
+ * @param {Record<string, any>} ioCache - The shared cache that stores user data and connections.
  * @param {string} token - The OAuth2 token used to fetch user data from Discord.
- * @returns {Promise<Object>} A promise that resolves with the user data and updates the cache.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the user data and updates the cache.
  */
-export default function discord(socket: Object, ioCache: Object, token: string): Promise<Object>;
+export default function discord(socket: Record<string, any>, ioCache: Record<string, any>, token: string): Promise<Record<string, any>>;

package/dist/legacy/socket.io/discord.mjs

@@ -4,10 +4,10 @@ import getUser from '../firebase/discord/api/getUser.mjs';
  * Handles the Discord OAuth2 authentication for a user, stores user data in an in-memory cache,
  * and manages the user's socket connection and disconnection events.
  *
- * @param {Object} socket - The socket object representing the user's connection.
- * @param {Object} ioCache - The shared cache that stores user data and connections.
+ * @param {Record<string, any>} socket - The socket object representing the user's connection.
+ * @param {Record<string, any>} ioCache - The shared cache that stores user data and connections.
  * @param {string} token - The OAuth2 token used to fetch user data from Discord.
- * @returns {Promise<Object>} A promise that resolves with the user data and updates the cache.
+ * @returns {Promise<Record<string, any>>} A promise that resolves with the user data and updates the cache.
  */
 export default function discord(socket, ioCache, token) {
     return new Promise((resolve, reject) => {

package/dist/v1/basics/clock.cjs

@@ -38,7 +38,7 @@ function getTimeDuration(timeData = new Date(), durationType = 'asSeconds', now
  * Includes proper reallocation of lower units into higher ones, ensuring consistent hierarchy.
  *
  * @param {number} totalSeconds - The total amount of seconds to convert.
- * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} level - The highest level to calculate and display.
+ * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} [level] - The highest level to calculate and display.
  * @param {string} [format='{time}'] - Output template with placeholders like {years}, {months}, {days}, {hours}, {minutes}, {seconds}, {time}, {total}.
  * @returns {string} The formatted timer string.
  */

package/dist/v1/basics/clock.d.mts

@@ -12,7 +12,7 @@ export function getTimeDuration(timeData?: Date, durationType?: string, now?: Da
  * Includes proper reallocation of lower units into higher ones, ensuring consistent hierarchy.
  *
  * @param {number} totalSeconds - The total amount of seconds to convert.
- * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} level - The highest level to calculate and display.
+ * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} [level] - The highest level to calculate and display.
  * @param {string} [format='{time}'] - Output template with placeholders like {years}, {months}, {days}, {hours}, {minutes}, {seconds}, {time}, {total}.
  * @returns {string} The formatted timer string.
  */

package/dist/v1/basics/clock.mjs

@@ -33,7 +33,7 @@ export function getTimeDuration(timeData = new Date(), durationType = 'asSeconds
  * Includes proper reallocation of lower units into higher ones, ensuring consistent hierarchy.
  *
  * @param {number} totalSeconds - The total amount of seconds to convert.
- * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} level - The highest level to calculate and display.
+ * @param {'seconds'|'minutes'|'hours'|'days'|'months'|'years'} [level] - The highest level to calculate and display.
  * @param {string} [format='{time}'] - Output template with placeholders like {years}, {months}, {days}, {hours}, {minutes}, {seconds}, {time}, {total}.
  * @returns {string} The formatted timer string.
  */

package/dist/v1/basics/simpleMath.cjs

@@ -6,7 +6,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -35,7 +35,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-function ruleOfThree(val1, val2, val3, inverse) {
+function ruleOfThree(val1, val2, val3, inverse = false) {
   return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
 }
 

package/dist/v1/basics/simpleMath.d.mts

@@ -4,7 +4,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -33,7 +33,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-export function ruleOfThree(val1: number, val2: number, val3: number, inverse: boolean): number;
+export function ruleOfThree(val1: number, val2: number, val3: number, inverse?: boolean): number;
 /**
  * Calculates a percentage of a given base value.
  * @param {number} price - The base value.

package/dist/v1/basics/simpleMath.mjs

@@ -4,7 +4,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -33,7 +33,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-export function ruleOfThree(val1, val2, val3, inverse) {
+export function ruleOfThree(val1, val2, val3, inverse = false) {
     return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",