tiny-essentials 1.0.0

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

@@ -0,0 +1,27 @@
+/**
+ * Checks the type of a given object or returns its type as a string.
+ *
+ * @param {*} obj - The object to check or identify.
+ * @param {string} [type] - Optional. If provided, checks whether the object matches this type (e.g., "object", "array", "string").
+ * @returns {boolean|string|null} - Returns `true` if the type matches, `false` if not,
+ *                                   the type string if no type is provided, or `null` if the object is `undefined`.
+ *
+ * @example
+ * objType([], 'array'); // true
+ * objType({}, 'object'); // true
+ * objType('hello'); // "string"
+ * objType(undefined); // null
+ */
+export function objType(obj: any, type?: string): boolean | string | null;
+/**
+ * Counts the number of elements in an array or the number of properties in an object.
+ *
+ * @param {*} obj - The array or object to count.
+ * @returns {number} - The count of items (array elements or object keys), or `0` if the input is neither an array nor an object.
+ *
+ * @example
+ * countObj([1, 2, 3]); // 3
+ * countObj({ a: 1, b: 2 }); // 2
+ * countObj('not an object'); // 0
+ */
+export function countObj(obj: any): number;

package/dist/v1/basics/objFilter.mjs

@@ -0,0 +1,52 @@
+/**
+ * Checks the type of a given object or returns its type as a string.
+ *
+ * @param {*} obj - The object to check or identify.
+ * @param {string} [type] - Optional. If provided, checks whether the object matches this type (e.g., "object", "array", "string").
+ * @returns {boolean|string|null} - Returns `true` if the type matches, `false` if not,
+ *                                   the type string if no type is provided, or `null` if the object is `undefined`.
+ *
+ * @example
+ * objType([], 'array'); // true
+ * objType({}, 'object'); // true
+ * objType('hello'); // "string"
+ * objType(undefined); // null
+ */
+export function objType(obj, type) {
+    // Is Defined
+    if (typeof obj !== 'undefined') {
+        // Get Obj Type
+        const result = Object.prototype.toString.call(obj).toLowerCase();
+        // Check Obj Type
+        if (typeof type === 'string') {
+            if (result === `[object ${type}]`)
+                return true;
+            return false;
+        }
+        // Send Result
+        return result.substring(8, result.length - 1);
+    }
+    // Nope
+    return null;
+}
+/**
+ * Counts the number of elements in an array or the number of properties in an object.
+ *
+ * @param {*} obj - The array or object to count.
+ * @returns {number} - The count of items (array elements or object keys), or `0` if the input is neither an array nor an object.
+ *
+ * @example
+ * countObj([1, 2, 3]); // 3
+ * countObj({ a: 1, b: 2 }); // 2
+ * countObj('not an object'); // 0
+ */
+export function countObj(obj) {
+    // Is Array
+    if (Array.isArray(obj))
+        return obj.length;
+    // Object
+    if (objType(obj, 'object'))
+        return Object.keys(obj).length;
+    // Nothing
+    return 0;
+}

package/dist/v1/basics/simpleMath.cjs

@@ -0,0 +1,88 @@
+'use strict';
+
+/**
+ * Executes a Rule of Three calculation.
+ *
+ * @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).
+ * @returns {number} The result of the Rule of Three operation.
+ *
+ * Rule of Three Formula (Direct Proportion):
+ *      val1 / val2 = val3 / result
+ *
+ * For Inverse Proportion:
+ *      val1 / val3 = val2 / result
+ *
+ * Visual Representation:
+ *
+ * For Direct Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * For Inverse Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * @example
+ * // Direct proportion:
+ * ruleOfThree.execute(2, 6, 3, false); // → 9
+ *
+ * @example
+ * // Inverse proportion:
+ * ruleOfThree.execute(2, 6, 3, true); // → 4
+ */
+function ruleOfThree(val1, val2, val3, inverse) {
+  return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
+}
+
+/**
+ * Calculates a percentage of a given base value.
+ * @param {number} price - The base value.
+ * @param {number} percentage - The percentage to apply.
+ * @returns {number} The result of the percentage calculation.
+ *
+ * @example
+ * getSimplePerc(200, 15); // 30
+ */
+function getSimplePerc(price, percentage) {
+  return price * (percentage / 100);
+}
+
+/**
+ * Calculates the age based on the given date.
+ *
+ * @param {number|string|Date} timeData - The birth date (can be a timestamp, ISO string, or Date object).
+ * @param {Date|null} [now=null] - The Date object representing the current date. Defaults to the current date and time if not provided.
+ * @returns {number|null} The age in years, or null if `timeData` is not provided or invalid.
+ */
+function getAge(timeData = 0, now = null) {
+  if (typeof timeData !== 'undefined' && timeData !== null && timeData !== 0) {
+    const birthDate = new Date(timeData);
+    if (isNaN(birthDate)) return null;
+
+    const currentDate = now instanceof Date ? now : new Date();
+
+    let age = currentDate.getFullYear() - birthDate.getFullYear();
+
+    const currentMonth = currentDate.getMonth();
+    const birthMonth = birthDate.getMonth();
+
+    const currentDay = currentDate.getDate();
+    const birthDay = birthDate.getDate();
+
+    // Adjust if birthday hasn't occurred yet this year
+    if (currentMonth < birthMonth || (currentMonth === birthMonth && currentDay < birthDay)) age--;
+
+    return Math.abs(age);
+  }
+
+  return null;
+}
+
+exports.getAge = getAge;
+exports.getSimplePerc = getSimplePerc;
+exports.ruleOfThree = ruleOfThree;

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

@@ -0,0 +1,54 @@
+/**
+ * Executes a Rule of Three calculation.
+ *
+ * @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).
+ * @returns {number} The result of the Rule of Three operation.
+ *
+ * Rule of Three Formula (Direct Proportion):
+ *      val1 / val2 = val3 / result
+ *
+ * For Inverse Proportion:
+ *      val1 / val3 = val2 / result
+ *
+ * Visual Representation:
+ *
+ * For Direct Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * For Inverse Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * @example
+ * // Direct proportion:
+ * ruleOfThree.execute(2, 6, 3, false); // → 9
+ *
+ * @example
+ * // Inverse proportion:
+ * ruleOfThree.execute(2, 6, 3, true); // → 4
+ */
+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.
+ * @param {number} percentage - The percentage to apply.
+ * @returns {number} The result of the percentage calculation.
+ *
+ * @example
+ * getSimplePerc(200, 15); // 30
+ */
+export function getSimplePerc(price: number, percentage: number): number;
+/**
+ * Calculates the age based on the given date.
+ *
+ * @param {number|string|Date} timeData - The birth date (can be a timestamp, ISO string, or Date object).
+ * @param {Date|null} [now=null] - The Date object representing the current date. Defaults to the current date and time if not provided.
+ * @returns {number|null} The age in years, or null if `timeData` is not provided or invalid.
+ */
+export function getAge(timeData?: number | string | Date, now?: Date | null): number | null;

package/dist/v1/basics/simpleMath.mjs

@@ -0,0 +1,75 @@
+/**
+ * Executes a Rule of Three calculation.
+ *
+ * @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).
+ * @returns {number} The result of the Rule of Three operation.
+ *
+ * Rule of Three Formula (Direct Proportion):
+ *      val1 / val2 = val3 / result
+ *
+ * For Inverse Proportion:
+ *      val1 / val3 = val2 / result
+ *
+ * Visual Representation:
+ *
+ * For Direct Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * For Inverse Proportion:
+ *      val1      val2
+ *      -----  =  ------
+ *      val3      result
+ *
+ * @example
+ * // Direct proportion:
+ * ruleOfThree.execute(2, 6, 3, false); // → 9
+ *
+ * @example
+ * // Inverse proportion:
+ * ruleOfThree.execute(2, 6, 3, true); // → 4
+ */
+export function ruleOfThree(val1, val2, val3, inverse) {
+    return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
+}
+/**
+ * Calculates a percentage of a given base value.
+ * @param {number} price - The base value.
+ * @param {number} percentage - The percentage to apply.
+ * @returns {number} The result of the percentage calculation.
+ *
+ * @example
+ * getSimplePerc(200, 15); // 30
+ */
+export function getSimplePerc(price, percentage) {
+    return price * (percentage / 100);
+}
+/**
+ * Calculates the age based on the given date.
+ *
+ * @param {number|string|Date} timeData - The birth date (can be a timestamp, ISO string, or Date object).
+ * @param {Date|null} [now=null] - The Date object representing the current date. Defaults to the current date and time if not provided.
+ * @returns {number|null} The age in years, or null if `timeData` is not provided or invalid.
+ */
+export function getAge(timeData = 0, now = null) {
+    if (typeof timeData !== 'undefined' && timeData !== null && timeData !== 0) {
+        const birthDate = new Date(timeData);
+        if (isNaN(birthDate))
+            return null;
+        const currentDate = now instanceof Date ? now : new Date();
+        let age = currentDate.getFullYear() - birthDate.getFullYear();
+        const currentMonth = currentDate.getMonth();
+        const birthMonth = birthDate.getMonth();
+        const currentDay = currentDate.getDate();
+        const birthDay = birthDate.getDate();
+        // Adjust if birthday hasn't occurred yet this year
+        if (currentMonth < birthMonth || (currentMonth === birthMonth && currentDay < birthDay))
+            age--;
+        return Math.abs(age);
+    }
+    return null;
+}

package/dist/v1/basics/text.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+/**
+ * Converts a string to title case where the first letter of each word is capitalized.
+ * All other letters are converted to lowercase.
+ *
+ * Example: "hello world" -> "Hello World"
+ *
+ * @param {string} str - The string to be converted to title case.
+ * @returns {string} The string converted to title case.
+ */
+function toTitleCase(str) {
+  return str.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
+}
+
+/**
+ * Converts a string to title case where the first letter of each word is capitalized,
+ * but the first letter of the entire string is left lowercase.
+ *
+ * Example: "hello world" -> "hello World"
+ *
+ * @param {string} str - The string to be converted to title case with the first letter in lowercase.
+ * @returns {string} The string converted to title case with the first letter in lowercase.
+ */
+function toTitleCaseLowerFirst(str) {
+  const titleCased = str.replace(
+    /\w\S*/g,
+    (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase(),
+  );
+  return titleCased.charAt(0).toLowerCase() + titleCased.slice(1);
+}
+
+exports.toTitleCase = toTitleCase;
+exports.toTitleCaseLowerFirst = toTitleCaseLowerFirst;

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

@@ -0,0 +1,20 @@
+/**
+ * Converts a string to title case where the first letter of each word is capitalized.
+ * All other letters are converted to lowercase.
+ *
+ * Example: "hello world" -> "Hello World"
+ *
+ * @param {string} str - The string to be converted to title case.
+ * @returns {string} The string converted to title case.
+ */
+export function toTitleCase(str: string): string;
+/**
+ * Converts a string to title case where the first letter of each word is capitalized,
+ * but the first letter of the entire string is left lowercase.
+ *
+ * Example: "hello world" -> "hello World"
+ *
+ * @param {string} str - The string to be converted to title case with the first letter in lowercase.
+ * @returns {string} The string converted to title case with the first letter in lowercase.
+ */
+export function toTitleCaseLowerFirst(str: string): string;

package/dist/v1/basics/text.mjs

@@ -0,0 +1,25 @@
+/**
+ * Converts a string to title case where the first letter of each word is capitalized.
+ * All other letters are converted to lowercase.
+ *
+ * Example: "hello world" -> "Hello World"
+ *
+ * @param {string} str - The string to be converted to title case.
+ * @returns {string} The string converted to title case.
+ */
+export function toTitleCase(str) {
+    return str.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
+}
+/**
+ * Converts a string to title case where the first letter of each word is capitalized,
+ * but the first letter of the entire string is left lowercase.
+ *
+ * Example: "hello world" -> "hello World"
+ *
+ * @param {string} str - The string to be converted to title case with the first letter in lowercase.
+ * @returns {string} The string converted to title case with the first letter in lowercase.
+ */
+export function toTitleCaseLowerFirst(str) {
+    const titleCased = str.replace(/\w\S*/g, (txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
+    return titleCased.charAt(0).toLowerCase() + titleCased.slice(1);
+}

package/dist/v1/index.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+var replaceAsync = require('../legacy/libs/replaceAsync.cjs');
+var userLevel = require('../legacy/libs/userLevel.cjs');
+var array = require('./basics/array.cjs');
+var clock = require('./basics/clock.cjs');
+var objFilter = require('./basics/objFilter.cjs');
+var simpleMath = require('./basics/simpleMath.cjs');
+var text = require('./basics/text.cjs');
+
+
+
+exports.asyncReplace = replaceAsync;
+exports.TinyLevelUp = userLevel;
+exports.shuffleArray = array.shuffleArray;
+exports.formatCustomTimer = clock.formatCustomTimer;
+exports.formatDayTimer = clock.formatDayTimer;
+exports.formatTimer = clock.formatTimer;
+exports.getTimeDuration = clock.getTimeDuration;
+exports.countObj = objFilter.countObj;
+exports.objType = objFilter.objType;
+exports.getAge = simpleMath.getAge;
+exports.getSimplePerc = simpleMath.getSimplePerc;
+exports.ruleOfThree = simpleMath.ruleOfThree;
+exports.toTitleCase = text.toTitleCase;
+exports.toTitleCaseLowerFirst = text.toTitleCaseLowerFirst;

package/dist/v1/index.d.mts

@@ -0,0 +1,15 @@
+import TinyLevelUp from '../legacy/libs/userLevel.mjs';
+import { countObj } from './basics/objFilter.mjs';
+import { objType } from './basics/objFilter.mjs';
+import { ruleOfThree } from './basics/simpleMath.mjs';
+import { getSimplePerc } from './basics/simpleMath.mjs';
+import asyncReplace from '../legacy/libs/replaceAsync.mjs';
+import { getAge } from './basics/simpleMath.mjs';
+import { formatCustomTimer } from './basics/clock.mjs';
+import { formatDayTimer } from './basics/clock.mjs';
+import { formatTimer } from './basics/clock.mjs';
+import { getTimeDuration } from './basics/clock.mjs';
+import { shuffleArray } from './basics/array.mjs';
+import { toTitleCase } from './basics/text.mjs';
+import { toTitleCaseLowerFirst } from './basics/text.mjs';
+export { TinyLevelUp, countObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst };

package/dist/v1/index.mjs

@@ -0,0 +1,8 @@
+import asyncReplace from '../legacy/libs/replaceAsync.mjs';
+import TinyLevelUp from '../legacy/libs/userLevel.mjs';
+import { shuffleArray } from './basics/array.mjs';
+import { formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, } from './basics/clock.mjs';
+import { countObj, objType } from './basics/objFilter.mjs';
+import { getAge, getSimplePerc, ruleOfThree } from './basics/simpleMath.mjs';
+import { toTitleCase, toTitleCaseLowerFirst } from './basics/text.mjs';
+export { TinyLevelUp, countObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst, };

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "tiny-essentials",
+  "version": "1.0.0",
+  "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",
+    "test:js": "npx babel-node test/index.js",
+    "test:mjs": "node test/index.mjs",
+    "test:cjs": "node test/index.cjs",
+    "fix:prettier": "prettier --write ./src/* && prettier --write ./test/*",
+    "auto-build": "npm run build",
+    "build": "tsc -p tsconfig.json && rollup -c",
+    "build-clean": "npm run clean && npm run build",
+    "build-dist": "npm run build",
+    "build-browserify": "npx browserify build/browserify.js -p esmify > dist/TinyAiApi.web.js",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "main": "./dist/v1/index.cjs",
+  "module": "./dist/v1/index.mjs",
+  "types": "./dist/v1/index.d.mts",
+  "ethereum": "jasmindreasond.x",
+  "exports": {
+    ".": {
+      "require": "./dist/v1/index.cjs",
+      "import": "./dist/v1/index.mjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JasminDreasond/Tiny-Essentials.git"
+  },
+  "keywords": [],
+  "author": "Yasmin Seidel (Jasmin Dreasond)",
+  "license": "GPL-3.0-only",
+  "bugs": {
+    "url": "https://github.com/JasminDreasond/Tiny-Essentials/issues"
+  },
+  "homepage": "https://github.com/JasminDreasond/Tiny-Essentials#readme",
+  "devDependencies": {
+    "@babel/cli": "^7.27.0",
+    "@babel/core": "^7.26.10",
+    "@babel/node": "^7.26.0",
+    "@babel/preset-env": "^7.26.9",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "babel-preset-es2015": "^6.24.1",
+    "byte-length": "^1.0.2",
+    "clone": "^2.1.2",
+    "compare-versions": "^6.1.1",
+    "firebase-functions": "^6.3.2",
+    "latest-version": "^9.0.0",
+    "lodash": "^4.17.21",
+    "md5": "^2.3.0",
+    "moment": "^2.30.1",
+    "moment-timezone": "^0.5.48",
+    "mysql": "^2.18.1",
+    "node-fetch": "2.7.0",
+    "object-hash": "^3.0.0",
+    "prettier": "3.5.3",
+    "rollup": "^4.40.0",
+    "rollup-preserve-directives": "^1.1.3",
+    "tinycolor2": "^1.6.0",
+    "tslib": "^2.8.1",
+    "type-fest": "^4.40.0",
+    "typescript": "^5.8.3",
+    "util": "^0.12.5"
+  }
+}