tiny-essentials 1.0.0

package/dist/legacy/firebase/mysqlConnector/pagination.mjs

@@ -0,0 +1,87 @@
+/**
+ * Executes a paginated query on the database, returning the result set along with pagination metadata.
+ *
+ * @async
+ * @param {Object} db - Database instance with a `.query(sql, params)` method.
+ * @param {Object} data - Query configuration options.
+ * @param {string} data.from - The table or view name to query from.
+ * @param {string} [data.where] - Optional WHERE clause without the keyword (e.g., `"status = 'active'"`).
+ * @param {Array} [data.params] - Optional parameters for the SQL query placeholders.
+ * @param {string} [data.select="*"] - Fields to select in the query.
+ * @param {string} data.order - SQL ORDER BY clause (e.g., `"created_at DESC"`).
+ * @param {number} [data.limit] - Number of rows per page.
+ * @param {number|string} [data.page] - Current page number or `'last'` to get the last page.
+ * @param {number} [data.count] - Optional total count override (skip count query if provided).
+ * @param {boolean} [data.count_rows=false] - Whether to include a row number for each result.
+ * @returns {Promise<Object>} Resolves with pagination metadata and result set.
+ * @returns {number} return.count - Total number of matched rows.
+ * @returns {Array} return.data - The paginated data from the query.
+ * @returns {number} return.pages - Total number of pages.
+ * @returns {number} return.page - Current page number after validation.
+ * @returns {number} return.start - Row offset used in the query.
+ */
+export default async function pagination(db, data) {
+    // Create Where
+    if (data.where)
+        data.where = ' WHERE ' + data.where;
+    else
+        data.where = '';
+    // Values
+    let start = 0;
+    let page;
+    let pages;
+    let edit_count;
+    if (typeof data.page === 'number') {
+        // Get Count
+        if (!data.count) {
+            edit_count = await db.query(`SELECT COUNT(*) FROM ${data.from}${data.where}`, data.params);
+            edit_count = edit_count[0]['COUNT(*)'];
+        }
+        else
+            edit_count = data.count;
+        // Prepare Numbers
+        pages = Math.ceil(edit_count / data.limit);
+        // Default
+        page = data.page;
+        // Is Last
+        if (page === 'last')
+            page = pages;
+        // is NaN
+        else if (isNaN(page))
+            page = 1;
+        // Bigger
+        else if (page > pages)
+            page = pages;
+        // Smaller
+        else if (page < 1)
+            page = 1;
+        // Offset
+        if (page)
+            start = Number(page - 1) * data.limit;
+        else {
+            start = 0;
+            page = 1;
+        }
+    }
+    if (!data.select)
+        data.select = '*';
+    // Count Rows
+    let count_rows = {
+        select: '',
+        from: '',
+    };
+    if (data.count_rows)
+        count_rows = {
+            select: `(@row_number:=@row_number + 1) AS row_num, `,
+            from: `(SELECT @row_number:=${start}) AS row_number, `,
+        };
+    // Edits
+    let tiny_query = `SELECT ${count_rows.select}${data.select} FROM ${count_rows.from}${data.from}${data.where} ORDER BY ${data.order}`;
+    if (typeof data.limit === 'number')
+        tiny_query += ` LIMIT ${data.limit}`;
+    if (typeof data.page === 'number')
+        tiny_query += ` OFFSET ${start}`;
+    let edits = await db.query(tiny_query, data.params);
+    // Complete
+    return { count: edit_count, data: edits, pages: pages, page: page, start: start };
+}

package/dist/legacy/firebase/mysqlConnector/sameUser.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+var clone = require('clone');
+var objType = require('../../get/objType.cjs');
+
+/**
+ * Creates a deep clone of a login object and attaches the given database name to it,
+ * if the input types are valid.
+ *
+ * @param {string} database - The name of the database to associate with the user.
+ * @param {Object} login - The login object that contains user data.
+ * @param {Object} login.data - The nested data object inside the login object.
+ * @returns {Object|null} A cloned and modified login object with the database name attached, or null if invalid input.
+ */
+function sameUser(database, login) {
+  // Validator
+  if (typeof database === 'string' && objType(login, 'object') && objType(login.data, 'object')) {
+    // Result
+    const result = clone(login);
+    result.data.database = database;
+    return result;
+  }
+
+  // Nope
+  else return null;
+}
+
+module.exports = sameUser;

package/dist/legacy/firebase/mysqlConnector/sameUser.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Creates a deep clone of a login object and attaches the given database name to it,
+ * if the input types are valid.
+ *
+ * @param {string} database - The name of the database to associate with the user.
+ * @param {Object} login - The login object that contains user data.
+ * @param {Object} login.data - The nested data object inside the login object.
+ * @returns {Object|null} A cloned and modified login object with the database name attached, or null if invalid input.
+ */
+export default function sameUser(database: string, login: {
+    data: Object;
+}): Object | null;

package/dist/legacy/firebase/mysqlConnector/sameUser.mjs

@@ -0,0 +1,23 @@
+import clone from 'clone';
+import objType from '../../get/objType.mjs';
+/**
+ * Creates a deep clone of a login object and attaches the given database name to it,
+ * if the input types are valid.
+ *
+ * @param {string} database - The name of the database to associate with the user.
+ * @param {Object} login - The login object that contains user data.
+ * @param {Object} login.data - The nested data object inside the login object.
+ * @returns {Object|null} A cloned and modified login object with the database name attached, or null if invalid input.
+ */
+export default function sameUser(database, login) {
+    // Validator
+    if (typeof database === 'string' && objType(login, 'object') && objType(login.data, 'object')) {
+        // Result
+        const result = clone(login);
+        result.data.database = database;
+        return result;
+    }
+    // Nope
+    else
+        return null;
+}

package/dist/legacy/firebase/transactionDBAsync.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+/**
+ * Executes a Firebase Realtime Database transaction asynchronously.
+ * This function uses the `transaction` method of Firebase to apply changes to the database.
+ * The provided callback is executed with the current value in the database, and the transaction
+ * is committed based on the result returned from the callback.
+ *
+ * @param {Object} data - The Firebase database reference object on which the transaction will be performed.
+ * @param {Function} callback - A function that accepts the current value of the data and returns the updated value.
+ * @returns {Promise} Resolves with the result of the transaction or rejects with an error if the transaction fails.
+ */
+async function transactionDBAsync(data, callback) {
+  return new Promise(async function (resolve, reject) {
+    // Try
+    try {
+      // The Transaction
+      const result = await data.transaction(
+        function (current_value) {
+          return callback(current_value);
+        },
+        function (errorObject) {
+          reject(errorObject);
+        },
+      );
+      resolve(result);
+    } catch (err) {
+      reject(err);
+    }
+  });
+}
+
+module.exports = transactionDBAsync;

package/dist/legacy/firebase/transactionDBAsync.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Executes a Firebase Realtime Database transaction asynchronously.
+ * This function uses the `transaction` method of Firebase to apply changes to the database.
+ * The provided callback is executed with the current value in the database, and the transaction
+ * is committed based on the result returned from the callback.
+ *
+ * @param {Object} data - The Firebase database reference object on which the transaction will be performed.
+ * @param {Function} callback - A function that accepts the current value of the data and returns the updated value.
+ * @returns {Promise} Resolves with the result of the transaction or rejects with an error if the transaction fails.
+ */
+export default function transactionDBAsync(data: Object, callback: Function): Promise<any>;

package/dist/legacy/firebase/transactionDBAsync.mjs

@@ -0,0 +1,27 @@
+/**
+ * Executes a Firebase Realtime Database transaction asynchronously.
+ * This function uses the `transaction` method of Firebase to apply changes to the database.
+ * The provided callback is executed with the current value in the database, and the transaction
+ * is committed based on the result returned from the callback.
+ *
+ * @param {Object} data - The Firebase database reference object on which the transaction will be performed.
+ * @param {Function} callback - A function that accepts the current value of the data and returns the updated value.
+ * @returns {Promise} Resolves with the result of the transaction or rejects with an error if the transaction fails.
+ */
+export default async function transactionDBAsync(data, callback) {
+    return new Promise(async function (resolve, reject) {
+        // Try
+        try {
+            // The Transaction
+            const result = await data.transaction(function (current_value) {
+                return callback(current_value);
+            }, function (errorObject) {
+                reject(errorObject);
+            });
+            resolve(result);
+        }
+        catch (err) {
+            reject(err);
+        }
+    });
+}

package/dist/legacy/get/countObj.cjs

@@ -0,0 +1,24 @@
+'use strict';
+
+var objType = require('./objType.cjs');
+
+/**
+ * Counts the number of elements or properties in an object or array.
+ *
+ * - If the input is an array, returns its length.
+ * - If it's a plain object, returns the number of its own enumerable properties.
+ * - Otherwise, returns 0.
+ *
+ * @param {*} obj - The input to count elements or properties from.
+ * @returns {number} The count of elements (array) or properties (object), or 0 if not applicable.
+ */
+function countObj(obj) {
+  // Is Array
+  if (Array.isArray(obj)) return obj.length;
+  // Object
+  else if (objType(obj, 'object')) return Object.keys(obj).length;
+  // Nothing
+  return 0;
+}
+
+module.exports = countObj;

package/dist/legacy/get/countObj.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Counts the number of elements or properties in an object or array.
+ *
+ * - If the input is an array, returns its length.
+ * - If it's a plain object, returns the number of its own enumerable properties.
+ * - Otherwise, returns 0.
+ *
+ * @param {*} obj - The input to count elements or properties from.
+ * @returns {number} The count of elements (array) or properties (object), or 0 if not applicable.
+ */
+export default function countObj(obj: any): number;

package/dist/legacy/get/countObj.mjs

@@ -0,0 +1,21 @@
+import objType from './objType.mjs';
+/**
+ * Counts the number of elements or properties in an object or array.
+ *
+ * - If the input is an array, returns its length.
+ * - If it's a plain object, returns the number of its own enumerable properties.
+ * - Otherwise, returns 0.
+ *
+ * @param {*} obj - The input to count elements or properties from.
+ * @returns {number} The count of elements (array) or properties (object), or 0 if not applicable.
+ */
+export default function countObj(obj) {
+    // Is Array
+    if (Array.isArray(obj))
+        return obj.length;
+    // Object
+    else if (objType(obj, 'object'))
+        return Object.keys(obj).length;
+    // Nothing
+    return 0;
+}

package/dist/legacy/get/decimalColor.cjs

@@ -0,0 +1,60 @@
+'use strict';
+
+var tinycolor = require('tinycolor2');
+
+/**
+ * Combines RGB values into a single decimal color.
+ *
+ * @private
+ * @param {number} r - Red component (0–255).
+ * @param {number} g - Green component (0–255).
+ * @param {number} b - Blue component (0–255).
+ * @returns {number} The combined decimal color value.
+ */
+function combineRGB(r, g, b) {
+  return (r << 16) | (g << 8) | b;
+}
+
+/**
+ * Converts a CSS color string (hex, rgb, hsl, etc.) to a decimal color value.
+ *
+ * - If the input is a valid color string, it returns the decimal RGB representation (e.g. 16729344 for `#ff6600`).
+ * - If invalid, returns `0`.
+ * - If the input is already a number and valid, returns it unchanged.
+ *
+ * @param {string|number} color - The color input (e.g. "#ff6600", "rgb(255, 102, 0)", or a decimal number).
+ * @param {function} [errCallback] - Optional callback to handle parsing errors.
+ * @returns {number} The decimal representation of the color, or 0 if invalid.
+ */
+function decimalColor(color, errCallback) {
+  // Is String
+  if (typeof color === 'string') {
+    // Prepare Color
+    try {
+      // Get Color Manager
+      color = tinycolor(color);
+
+      // Validate
+      if (color.isValid()) {
+        // Convert
+        color = color.toRgb();
+        color = combineRGB(color.r, color.g, color.b);
+      }
+
+      // Nope
+      else color = 0;
+    } catch (err) {
+      // Error
+      if (typeof errCallback === 'function') errCallback(err);
+      color = 0;
+    }
+  }
+
+  // Fix Color Number
+  if (typeof color !== 'number' || isNaN(color) || !isFinite(color) || color < 0) color = 0;
+
+  // Return the Color Value
+  return color;
+}
+
+module.exports = decimalColor;

package/dist/legacy/get/decimalColor.d.mts

@@ -0,0 +1,12 @@
+/**
+ * Converts a CSS color string (hex, rgb, hsl, etc.) to a decimal color value.
+ *
+ * - If the input is a valid color string, it returns the decimal RGB representation (e.g. 16729344 for `#ff6600`).
+ * - If invalid, returns `0`.
+ * - If the input is already a number and valid, returns it unchanged.
+ *
+ * @param {string|number} color - The color input (e.g. "#ff6600", "rgb(255, 102, 0)", or a decimal number).
+ * @param {function} [errCallback] - Optional callback to handle parsing errors.
+ * @returns {number} The decimal representation of the color, or 0 if invalid.
+ */
+export default function decimalColor(color: string | number, errCallback?: Function): number;

package/dist/legacy/get/decimalColor.mjs

@@ -0,0 +1,54 @@
+import tinycolor from 'tinycolor2';
+/**
+ * Combines RGB values into a single decimal color.
+ *
+ * @private
+ * @param {number} r - Red component (0–255).
+ * @param {number} g - Green component (0–255).
+ * @param {number} b - Blue component (0–255).
+ * @returns {number} The combined decimal color value.
+ */
+function combineRGB(r, g, b) {
+    return (r << 16) | (g << 8) | b;
+}
+/**
+ * Converts a CSS color string (hex, rgb, hsl, etc.) to a decimal color value.
+ *
+ * - If the input is a valid color string, it returns the decimal RGB representation (e.g. 16729344 for `#ff6600`).
+ * - If invalid, returns `0`.
+ * - If the input is already a number and valid, returns it unchanged.
+ *
+ * @param {string|number} color - The color input (e.g. "#ff6600", "rgb(255, 102, 0)", or a decimal number).
+ * @param {function} [errCallback] - Optional callback to handle parsing errors.
+ * @returns {number} The decimal representation of the color, or 0 if invalid.
+ */
+export default function decimalColor(color, errCallback) {
+    // Is String
+    if (typeof color === 'string') {
+        // Prepare Color
+        try {
+            // Get Color Manager
+            color = tinycolor(color);
+            // Validate
+            if (color.isValid()) {
+                // Convert
+                color = color.toRgb();
+                color = combineRGB(color.r, color.g, color.b);
+            }
+            // Nope
+            else
+                color = 0;
+        }
+        catch (err) {
+            // Error
+            if (typeof errCallback === 'function')
+                errCallback(err);
+            color = 0;
+        }
+    }
+    // Fix Color Number
+    if (typeof color !== 'number' || isNaN(color) || !isFinite(color) || color < 0)
+        color = 0;
+    // Return the Color Value
+    return color;
+}

package/dist/legacy/get/objType.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+/**
+ * Checks the internal type of an object using `Object.prototype.toString`.
+ *
+ * - If `type` is provided, returns `true` if it matches the object's internal type (case-insensitive).
+ * - If `type` is omitted, returns the object's internal type as a lowercase string.
+ *
+ * Examples:
+ * ```js
+ * objType([], 'array'); // true
+ * objType({}, 'object'); // true
+ * objType('hello'); // "string"
+ * objType(undefined); // null
+ * ```
+ *
+ * @param {*} obj - The value to check the type of.
+ * @param {string} [type] - Optional string to compare the object's type against.
+ * @returns {boolean|string|null} Returns true/false if checking, or type string/null if querying.
+ */
+function objType(obj, type) {
+  // Is Defined
+  if (typeof obj !== 'undefined') {
+    // Check Obj Type
+    if (typeof type === 'string') {
+      if (Object.prototype.toString.call(obj).toLowerCase() === `[object ${type}]`) return true;
+      else return false;
+    }
+
+    // Get Obj Type
+    else {
+      // Result
+      const result = Object.prototype.toString.call(obj).toLowerCase();
+      // Send Result
+      return result.substring(8, result.length - 1);
+    }
+  }
+
+  // Nope
+  else return null;
+}
+
+module.exports = objType;

package/dist/legacy/get/objType.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Checks the internal type of an object using `Object.prototype.toString`.
+ *
+ * - If `type` is provided, returns `true` if it matches the object's internal type (case-insensitive).
+ * - If `type` is omitted, returns the object's internal type as a lowercase string.
+ *
+ * Examples:
+ * ```js
+ * objType([], 'array'); // true
+ * objType({}, 'object'); // true
+ * objType('hello'); // "string"
+ * objType(undefined); // null
+ * ```
+ *
+ * @param {*} obj - The value to check the type of.
+ * @param {string} [type] - Optional string to compare the object's type against.
+ * @returns {boolean|string|null} Returns true/false if checking, or type string/null if querying.
+ */
+export default function objType(obj: any, type?: string): boolean | string | null;

package/dist/legacy/get/objType.mjs

@@ -0,0 +1,40 @@
+/**
+ * Checks the internal type of an object using `Object.prototype.toString`.
+ *
+ * - If `type` is provided, returns `true` if it matches the object's internal type (case-insensitive).
+ * - If `type` is omitted, returns the object's internal type as a lowercase string.
+ *
+ * Examples:
+ * ```js
+ * objType([], 'array'); // true
+ * objType({}, 'object'); // true
+ * objType('hello'); // "string"
+ * objType(undefined); // null
+ * ```
+ *
+ * @param {*} obj - The value to check the type of.
+ * @param {string} [type] - Optional string to compare the object's type against.
+ * @returns {boolean|string|null} Returns true/false if checking, or type string/null if querying.
+ */
+export default function objType(obj, type) {
+    // Is Defined
+    if (typeof obj !== 'undefined') {
+        // Check Obj Type
+        if (typeof type === 'string') {
+            if (Object.prototype.toString.call(obj).toLowerCase() === `[object ${type}]`)
+                return true;
+            else
+                return false;
+        }
+        // Get Obj Type
+        else {
+            // Result
+            const result = Object.prototype.toString.call(obj).toLowerCase();
+            // Send Result
+            return result.substring(8, result.length - 1);
+        }
+    }
+    // Nope
+    else
+        return null;
+}

package/dist/legacy/get/pagination.cjs

@@ -0,0 +1,100 @@
+'use strict';
+
+var queryUrlJSON = require('./queryUrlJSON.cjs');
+
+/**
+ * Generates pagination metadata for a given query and current page.
+ * It builds a list of pages to display and determines whether "next" and "previous" buttons should be shown.
+ * The resulting object can be used to render a pagination UI.
+ *
+ * @param {string} query - The base query string to be appended to URLs (without `?` or `&`).
+ * @param {number} page - The current page number.
+ * @param {number} total - The total number of pages.
+ * @param {string} [url=''] - The base URL to which pagination parameters will be added.
+ * @param {string} [extraClass=''] - Additional class name for styling the pagination container.
+ * @param {string} [extraClass2=''] - Additional class name for individual page links.
+ *
+ * @returns {Object} Pagination metadata including:
+ *   - `url` {string} - The updated URL prefix to use for each page link.
+ *   - `extraClass` {string} - Additional class name passed through.
+ *   - `extraClass2` {string} - Additional class name passed through.
+ *   - `page` {number} - The current page.
+ *   - `pagination` {number[]} - An array of page numbers to be displayed.
+ *   - `previous` {boolean} - Whether there are previous pages.
+ *   - `next` {boolean} - Whether there are next pages.
+ *   - `firstPagination` {boolean} - `true` if page 1 is not in the visible pagination and should be shown separately.
+ *   - `lastPagination` {boolean} - `true` if the last page is not in the visible pagination and should be shown separately.
+ *   - `pages` {number} - Total number of pages.
+ */
+function pagination(
+  query,
+  page,
+  total,
+  url = '',
+  extraClass = '',
+  extraClass2 = '',
+) {
+  // Fix URL
+  if (url) {
+    // Final URL Result
+    const finalURLResult = function (sqT = '') {
+      if (query) return sqT + query + '&page=';
+      else return 'page=';
+    };
+
+    // Param Fixed
+    const params = queryUrlJSON(url);
+    if (Object.keys(params).length > 0) {
+      if (params.page) {
+        url = url
+          .replace(finalURLResult('&') + params.page, '')
+          .replace('?' + query + '=' + params.page, '?')
+          .replace('?&', '?');
+
+        if (Object.keys(params).length === 1) url += finalURLResult();
+        else url += finalURLResult('&');
+      } else url += finalURLResult('&');
+    } else url += finalURLResult('?');
+  }
+
+  // Pagination
+
+  const pagination = [];
+  const data = {
+    url: url,
+    extraClass: extraClass,
+    extraClass2: extraClass2,
+  };
+
+  data.next = false;
+  data.previous = false;
+  for (let i = page - 1; i > page - 5; i--) {
+    if (i > 0) {
+      pagination.push(i);
+      data.previous = true;
+    }
+  }
+  pagination.reverse();
+  pagination.push(page);
+  for (let i = page + 1; i < page + 5; i++) {
+    if (i <= total) {
+      pagination.push(i);
+      data.next = true;
+    }
+  }
+
+  // Build Data and send it
+  data.page = page;
+  data.pagination = pagination;
+
+  if (pagination.indexOf(1) < 0) data.firstPagination = true;
+  else data.firstPagination = false;
+  if (pagination.indexOf(total) < 0) data.lastPagination = true;
+  else data.lastPagination = false;
+
+  data.pages = total;
+
+  return data;
+}
+
+module.exports = pagination;

package/dist/legacy/get/pagination.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Generates pagination metadata for a given query and current page.
+ * It builds a list of pages to display and determines whether "next" and "previous" buttons should be shown.
+ * The resulting object can be used to render a pagination UI.
+ *
+ * @param {string} query - The base query string to be appended to URLs (without `?` or `&`).
+ * @param {number} page - The current page number.
+ * @param {number} total - The total number of pages.
+ * @param {string} [url=''] - The base URL to which pagination parameters will be added.
+ * @param {string} [extraClass=''] - Additional class name for styling the pagination container.
+ * @param {string} [extraClass2=''] - Additional class name for individual page links.
+ *
+ * @returns {Object} Pagination metadata including:
+ *   - `url` {string} - The updated URL prefix to use for each page link.
+ *   - `extraClass` {string} - Additional class name passed through.
+ *   - `extraClass2` {string} - Additional class name passed through.
+ *   - `page` {number} - The current page.
+ *   - `pagination` {number[]} - An array of page numbers to be displayed.
+ *   - `previous` {boolean} - Whether there are previous pages.
+ *   - `next` {boolean} - Whether there are next pages.
+ *   - `firstPagination` {boolean} - `true` if page 1 is not in the visible pagination and should be shown separately.
+ *   - `lastPagination` {boolean} - `true` if the last page is not in the visible pagination and should be shown separately.
+ *   - `pages` {number} - Total number of pages.
+ */
+export default function pagination(query: string, page: number, total: number, url?: string, extraClass?: string, extraClass2?: string): Object;