tiny-essentials 1.0.0

package/dist/legacy/index.mjs

@@ -0,0 +1,92 @@
+import countObj from './get/countObj.mjs';
+import objType from './get/objType.mjs';
+import super_string_filter from './get/super_string_filter.mjs';
+import auth from './http/auth.mjs';
+import check_domain from './http/check_domain.mjs';
+import domainValidator from './http/domainValidator.mjs';
+import errorsCallback from './http/errorsCallback.mjs';
+import http_base from './http/HTTP-1.0.mjs';
+import userIp from './http/userIP.mjs';
+import convertBytes from './libs/convertBytes.mjs';
+import custom_module_manager from './libs/custom_module_loader.mjs';
+import replaceAsync from './libs/replaceAsync.mjs';
+import * as momentjs from './momentjs/index.mjs';
+import * as crypto from './crypto/index.mjs';
+import pagination from './get/pagination.mjs';
+import getDomainURL from './http/getDomainURL.mjs';
+import tinyDice from './libs/dice.mjs';
+import LevelUp from './libs/userLevel.mjs';
+import queryUrlByName from './get/queryUrlByName.mjs';
+import queryUrlJSON from './get/queryUrlJSON.mjs';
+import decimalColor from './get/decimalColor.mjs';
+import percentageBase from './libs/percentage.mjs';
+import rule3 from './libs/rule3.mjs';
+import versionCheck from './get/versionCheck.mjs';
+import socketIo from './socket.io/index.mjs';
+import arraySortPositions from './libs/arraySortPositions.mjs';
+import capitalize from './libs/capitalize.mjs';
+import getJsonFetch from './http/fetch/json.mjs';
+import getTextFetch from './http/fetch/text.mjs';
+import csrfTokenAnalyze from './http/csrfTokenAnalyze.mjs';
+const legacyModules = {
+    // Convert Bytes
+    convertBytes,
+    // HTTP/1.0 Render
+    'HTTP/1.0': http_base,
+    // Moment JS
+    momentjs,
+    // Check Domain
+    checkDomain: check_domain,
+    // Get Obj Type
+    getObjType: objType,
+    // Count Obj
+    countObj: countObj,
+    // HTTP Auth Generator
+    httpAuth: auth,
+    // Replace Async
+    replaceAsync,
+    // User IP
+    getUserIP: userIp,
+    // Super string Filter
+    superStringFilter: super_string_filter,
+    // Custom Module Loader
+    customModuleManager: custom_module_manager,
+    // Errors Callback
+    errorsCallback,
+    // Domain Validator
+    domainValidator,
+    // Crypto
+    crypto,
+    // Pagination
+    pagination,
+    // Get Domain URL
+    getDomainURL,
+    // Dice
+    dice: tinyDice,
+    // User Level
+    LevelUp: LevelUp,
+    // Get URL Parameter
+    getQueryUrlByName: queryUrlByName,
+    getQueryUrlJSON: queryUrlJSON,
+    // Get Decimal Color
+    getDecimalColor: decimalColor,
+    // Percentage
+    percentage: percentageBase,
+    // Rule 3
+    rule3,
+    // Version Check
+    versionCheck,
+    // Socket IO
+    socketIO: socketIo,
+    // Array Sort Positions
+    arraySortPositions,
+    // Capitalize
+    capitalize,
+    // Fetch
+    fetchJSON: getJsonFetch,
+    fetchText: getTextFetch,
+    // csrfToken Analyze
+    csrfTokenAnalyze,
+};
+// Modules
+export default legacyModules;

package/dist/legacy/libs/arraySortPositions.cjs

@@ -0,0 +1,30 @@
+'use strict';
+
+/**
+ * Generates a comparator function to sort an array of objects by a given key.
+ *
+ * @param {string} item - The object key to sort by.
+ * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
+ * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos')); // Ascending: [{pos: 1}, {pos: 2}, {pos: 3}]
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos', true)); // Descending: [{pos: 3}, {pos: 2}, {pos: 1}]
+ */
+function arraySortPositions(item, isReverse = false) {
+  if (!isReverse) {
+    return function (a, b) {
+      return a[item] < b[item] ? -1 : a[item] > b[item] ? 1 : 0;
+    };
+  } else {
+    return function (a, b) {
+      return a[item] > b[item] ? -1 : a[item] < b[item] ? 1 : 0;
+    };
+  }
+}
+
+module.exports = arraySortPositions;

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

@@ -0,0 +1,16 @@
+/**
+ * Generates a comparator function to sort an array of objects by a given key.
+ *
+ * @param {string} item - The object key to sort by.
+ * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
+ * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos')); // Ascending: [{pos: 1}, {pos: 2}, {pos: 3}]
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos', true)); // Descending: [{pos: 3}, {pos: 2}, {pos: 1}]
+ */
+export default function arraySortPositions(item: string, isReverse?: boolean): (a: Object, b: Object) => number;

package/dist/legacy/libs/arraySortPositions.mjs

@@ -0,0 +1,27 @@
+/**
+ * Generates a comparator function to sort an array of objects by a given key.
+ *
+ * @param {string} item - The object key to sort by.
+ * @param {boolean} [isReverse=false] - If `true`, the sorting will be in descending order.
+ * @returns {(a: Object, b: Object) => number} Comparator function compatible with Array.prototype.sort().
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos')); // Ascending: [{pos: 1}, {pos: 2}, {pos: 3}]
+ *
+ * @example
+ * const arr = [{ pos: 2 }, { pos: 1 }, { pos: 3 }];
+ * arr.sort(arraySortPositions('pos', true)); // Descending: [{pos: 3}, {pos: 2}, {pos: 1}]
+ */
+export default function arraySortPositions(item, isReverse = false) {
+    if (!isReverse) {
+        return function (a, b) {
+            return a[item] < b[item] ? -1 : a[item] > b[item] ? 1 : 0;
+        };
+    }
+    else {
+        return function (a, b) {
+            return a[item] > b[item] ? -1 : a[item] < b[item] ? 1 : 0;
+        };
+    }
+}

package/dist/legacy/libs/capitalize.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+/**
+ * Capitalizes the first letter of each word in a given string.
+ *
+ * @param {string} text - The input string to be transformed.
+ * @returns {string} The transformed string with each word's first letter capitalized.
+ *
+ * @example
+ * capitalize("hello world"); // "Hello World"
+ *
+ * @example
+ * capitalize("my little pony"); // "My Little Pony"
+ */
+function capitalize(text) {
+  return text.replace(/\b\w/g, function (l) {
+    return l.toUpperCase();
+  });
+}
+
+module.exports = capitalize;

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

@@ -0,0 +1,13 @@
+/**
+ * Capitalizes the first letter of each word in a given string.
+ *
+ * @param {string} text - The input string to be transformed.
+ * @returns {string} The transformed string with each word's first letter capitalized.
+ *
+ * @example
+ * capitalize("hello world"); // "Hello World"
+ *
+ * @example
+ * capitalize("my little pony"); // "My Little Pony"
+ */
+export default function capitalize(text: string): string;

package/dist/legacy/libs/capitalize.mjs

@@ -0,0 +1,17 @@
+/**
+ * Capitalizes the first letter of each word in a given string.
+ *
+ * @param {string} text - The input string to be transformed.
+ * @returns {string} The transformed string with each word's first letter capitalized.
+ *
+ * @example
+ * capitalize("hello world"); // "Hello World"
+ *
+ * @example
+ * capitalize("my little pony"); // "My Little Pony"
+ */
+export default function capitalize(text) {
+    return text.replace(/\b\w/g, function (l) {
+        return l.toUpperCase();
+    });
+}

package/dist/legacy/libs/convertBytes.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+/**
+ * A utility module to convert between bytes and higher order units (KB, MB, GB, etc).
+ */
+
+/**
+ * @typedef {'kb'|'mb'|'gb'|'tb'|'pb'|'eb'} SizeUnit
+ */
+const convertList = {
+  kb: 1024,
+  mb: 1048576,
+  gb: 1073741824,
+  tb: 1099511627776,
+  pb: 1125899906842624,
+  eb: 1152921504606847000,
+};
+
+const sequence = ['kb', 'mb', 'gb', 'tb', 'pb', 'eb'];
+
+/**
+ * @namespace convertBytes
+ */
+const convertBytes = {
+  /**
+   * Conversion factors for each unit.
+   * @type {Object.<SizeUnit, number>}
+   */
+  list: convertList,
+
+  /**
+   * Ordered list of size units.
+   * @type {SizeUnit[]}
+   */
+  sequence: sequence,
+
+  /**
+   * Converts a size in the specified unit to bytes.
+   * @param {number} bytes - The number of units to convert.
+   * @param {SizeUnit} selected - The unit of the input value.
+   * @returns {number} The equivalent size in bytes.
+   *
+   * @example
+   * convertBytes.get(5, 'mb'); // 5242880
+   */
+  get: function (bytes, selected) {
+    return convertList[selected] * bytes;
+  },
+
+  /**
+   * Converts a size in bytes to the specified unit.
+   * @param {number} bytes - The size in bytes.
+   * @param {SizeUnit} selected - The target unit.
+   * @returns {number} The equivalent size in the selected unit.
+   *
+   * @example
+   * convertBytes.convert(1048576, 'mb'); // 1
+   */
+  convert: function (bytes, selected) {
+    return bytes / convertList[selected];
+  },
+};
+
+module.exports = convertBytes;

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

@@ -0,0 +1,17 @@
+export default convertBytes;
+export type SizeUnit = "kb" | "mb" | "gb" | "tb" | "pb" | "eb";
+declare namespace convertBytes {
+    export { convertList as list };
+    export { sequence };
+    export function get(bytes: number, selected: SizeUnit): number;
+    export function convert(bytes: number, selected: SizeUnit): number;
+}
+declare namespace convertList {
+    let kb: number;
+    let mb: number;
+    let gb: number;
+    let tb: number;
+    let pb: number;
+    let eb: number;
+}
+declare const sequence: string[];

package/dist/legacy/libs/convertBytes.mjs

@@ -0,0 +1,55 @@
+/**
+ * A utility module to convert between bytes and higher order units (KB, MB, GB, etc).
+ */
+/**
+ * @typedef {'kb'|'mb'|'gb'|'tb'|'pb'|'eb'} SizeUnit
+ */
+const convertList = {
+    kb: 1024,
+    mb: 1048576,
+    gb: 1073741824,
+    tb: 1099511627776,
+    pb: 1125899906842624,
+    eb: 1152921504606847000,
+};
+const sequence = ['kb', 'mb', 'gb', 'tb', 'pb', 'eb'];
+/**
+ * @namespace convertBytes
+ */
+const convertBytes = {
+    /**
+     * Conversion factors for each unit.
+     * @type {Object.<SizeUnit, number>}
+     */
+    list: convertList,
+    /**
+     * Ordered list of size units.
+     * @type {SizeUnit[]}
+     */
+    sequence: sequence,
+    /**
+     * Converts a size in the specified unit to bytes.
+     * @param {number} bytes - The number of units to convert.
+     * @param {SizeUnit} selected - The unit of the input value.
+     * @returns {number} The equivalent size in bytes.
+     *
+     * @example
+     * convertBytes.get(5, 'mb'); // 5242880
+     */
+    get: function (bytes, selected) {
+        return convertList[selected] * bytes;
+    },
+    /**
+     * Converts a size in bytes to the specified unit.
+     * @param {number} bytes - The size in bytes.
+     * @param {SizeUnit} selected - The target unit.
+     * @returns {number} The equivalent size in the selected unit.
+     *
+     * @example
+     * convertBytes.convert(1048576, 'mb'); // 1
+     */
+    convert: function (bytes, selected) {
+        return bytes / convertList[selected];
+    },
+};
+export default convertBytes;

package/dist/legacy/libs/custom_module_loader.cjs

@@ -0,0 +1,82 @@
+'use strict';
+
+var objType = require('../get/objType.cjs');
+
+/**
+ * A custom module manager to validate and run hooks on external modules dynamically.
+ * Especially useful for plugin-like systems or hooks in systems like payment handlers.
+ * @namespace custom_module_manager
+ */
+const custom_module_manager = {
+  /**
+   * Validates if the given object has valid custom or default module arrays.
+   * @param {Object} custom_modules - The object containing module definitions.
+   * @param {string} type - The specific type of module to validate.
+   * @returns {boolean} Whether the module is valid.
+   *
+   * @example
+   * custom_module_manager.validator(myModules, 'paypal'); // true or false
+   */
+  validator: function (custom_modules, type) {
+    if (
+      custom_modules &&
+      custom_modules[type] &&
+      (Array.isArray(custom_modules[type].custom) || Array.isArray(custom_modules[type].default))
+    )
+      return true;
+    else return false;
+  },
+
+  /**
+   * Executes all functions inside the given modules.
+   * Accepts either an array of functions or an object with typed module arrays.
+   *
+   * @param {Object|Function[]} custom_modules - The modules or functions to run.
+   * @param {*} db_prepare - A value to pass to each module when called.
+   * @param {string} hookType - A string representing the hook (e.g., 'before', 'after').
+   * @param {Object} [options] - Optional. Object with keys matching types in `custom_modules`.
+   *
+   * @returns {Promise<void>}
+   *
+   * @example
+   * await custom_module_manager.run(customModules, db, 'after', { paypal: true });
+   */
+  run: async function (custom_modules, db_prepare, hookType, options) {
+    const run_custom_module = async function (type) {
+      let module_list = null;
+
+      if (type) {
+        if (custom_modules && custom_modules[type]) module_list = custom_modules[type];
+      } else module_list = custom_modules;
+
+      if (Array.isArray(module_list)) {
+        for (const item in module_list) {
+          if (typeof module_list[item] === 'function') {
+            try {
+              await module_list[item](db_prepare, hookType);
+            } catch (err) {
+              console.error(err);
+              console.error(err.message);
+            }
+          } else {
+            const err = new Error(
+              `The Custom Paypal Module value needs to be a Function!\nArray: ${type}\nIndex: ${item}`,
+            );
+            console.error(err);
+            console.error(err.message);
+          }
+        }
+      }
+    };
+
+    if (objType(options, 'object')) {
+      for (const item in options) {
+        if (options[item] && Array.isArray(custom_modules[item])) await run_custom_module(item);
+      }
+    } else {
+      if (Array.isArray(custom_modules)) await run_custom_module();
+    }
+  },
+};
+
+module.exports = custom_module_manager;

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

@@ -0,0 +1,5 @@
+export default custom_module_manager;
+declare namespace custom_module_manager {
+    function validator(custom_modules: Object, type: string): boolean;
+    function run(custom_modules: Object | Function[], db_prepare: any, hookType: string, options?: Object): Promise<void>;
+}

package/dist/legacy/libs/custom_module_loader.mjs

@@ -0,0 +1,79 @@
+import objType from '../get/objType.mjs';
+/**
+ * A custom module manager to validate and run hooks on external modules dynamically.
+ * Especially useful for plugin-like systems or hooks in systems like payment handlers.
+ * @namespace custom_module_manager
+ */
+const custom_module_manager = {
+    /**
+     * Validates if the given object has valid custom or default module arrays.
+     * @param {Object} custom_modules - The object containing module definitions.
+     * @param {string} type - The specific type of module to validate.
+     * @returns {boolean} Whether the module is valid.
+     *
+     * @example
+     * custom_module_manager.validator(myModules, 'paypal'); // true or false
+     */
+    validator: function (custom_modules, type) {
+        if (custom_modules &&
+            custom_modules[type] &&
+            (Array.isArray(custom_modules[type].custom) || Array.isArray(custom_modules[type].default)))
+            return true;
+        else
+            return false;
+    },
+    /**
+     * Executes all functions inside the given modules.
+     * Accepts either an array of functions or an object with typed module arrays.
+     *
+     * @param {Object|Function[]} custom_modules - The modules or functions to run.
+     * @param {*} db_prepare - A value to pass to each module when called.
+     * @param {string} hookType - A string representing the hook (e.g., 'before', 'after').
+     * @param {Object} [options] - Optional. Object with keys matching types in `custom_modules`.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * await custom_module_manager.run(customModules, db, 'after', { paypal: true });
+     */
+    run: async function (custom_modules, db_prepare, hookType, options) {
+        const run_custom_module = async function (type) {
+            let module_list = null;
+            if (type) {
+                if (custom_modules && custom_modules[type])
+                    module_list = custom_modules[type];
+            }
+            else
+                module_list = custom_modules;
+            if (Array.isArray(module_list)) {
+                for (const item in module_list) {
+                    if (typeof module_list[item] === 'function') {
+                        try {
+                            await module_list[item](db_prepare, hookType);
+                        }
+                        catch (err) {
+                            console.error(err);
+                            console.error(err.message);
+                        }
+                    }
+                    else {
+                        const err = new Error(`The Custom Paypal Module value needs to be a Function!\nArray: ${type}\nIndex: ${item}`);
+                        console.error(err);
+                        console.error(err.message);
+                    }
+                }
+            }
+        };
+        if (objType(options, 'object')) {
+            for (const item in options) {
+                if (options[item] && Array.isArray(custom_modules[item]))
+                    await run_custom_module(item);
+            }
+        }
+        else {
+            if (Array.isArray(custom_modules))
+                await run_custom_module();
+        }
+    },
+};
+export default custom_module_manager;

package/dist/legacy/libs/dice.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+/**
+ * A simple random number generator (dice roller) utility.
+ * Supports a vanilla dice roll from 1 to N.
+ * @namespace tinyDice
+ */
+const tinyDice = {
+  /**
+   * Generates a random integer between 1 and `obj`, inclusive.
+   * @param {number} obj - The maximum value of the dice.
+   * @returns {number} The result of the dice roll.
+   *
+   * @example
+   * const result = tinyDice.vanilla(6); // 1 to 6
+   */
+  vanilla: function (obj) {
+    return Number(Math.floor(Math.random() * (obj - 1 + 1) + 1));
+  },
+
+  /**
+   * Returns the stringified version of the `vanilla()` method.
+   * Useful for injecting the dice logic in client environments.
+   * @param {number} obj - Unused in the function body.
+   * @returns {string} The function source code of `vanilla`.
+   *
+   * @example
+   * const clientScript = tinyDice.getClientVanilla();
+   */
+  getClientVanilla: function (obj) {
+    return tinyDice.vanilla.toString();
+  },
+};
+
+module.exports = tinyDice;

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

@@ -0,0 +1,5 @@
+export default tinyDice;
+declare namespace tinyDice {
+    function vanilla(obj: number): number;
+    function getClientVanilla(obj: number): string;
+}

package/dist/legacy/libs/dice.mjs

@@ -0,0 +1,31 @@
+/**
+ * A simple random number generator (dice roller) utility.
+ * Supports a vanilla dice roll from 1 to N.
+ * @namespace tinyDice
+ */
+const tinyDice = {
+    /**
+     * Generates a random integer between 1 and `obj`, inclusive.
+     * @param {number} obj - The maximum value of the dice.
+     * @returns {number} The result of the dice roll.
+     *
+     * @example
+     * const result = tinyDice.vanilla(6); // 1 to 6
+     */
+    vanilla: function (obj) {
+        return Number(Math.floor(Math.random() * (obj - 1 + 1) + 1));
+    },
+    /**
+     * Returns the stringified version of the `vanilla()` method.
+     * Useful for injecting the dice logic in client environments.
+     * @param {number} obj - Unused in the function body.
+     * @returns {string} The function source code of `vanilla`.
+     *
+     * @example
+     * const clientScript = tinyDice.getClientVanilla();
+     */
+    getClientVanilla: function (obj) {
+        return tinyDice.vanilla.toString();
+    },
+};
+export default tinyDice;