@develia/commons 0.3.17 → 0.3.20

package/src/utilities.ts

@@ -0,0 +1,345 @@
+// noinspection JSUnusedGlobalSymbols
+
+
+import Pair from "./pair";
+import {Optional, Provider} from "./types";
+import {Type} from "./typing";
+
+/**
+ * Checks if an object is iterable.
+ *
+ * @param {any} obj - The object to check.
+ * @return {boolean} - Returns true if the object is iterable, otherwise false.
+ */
+export function isIterable(obj: any): boolean {
+    return obj[Symbol.iterator] === 'function';
+}
+
+/**
+ * Checks if a given value is a string.
+ *
+ * @param {*} value - The value to check.
+ * @return {boolean} - Returns true if the value is a string, otherwise returns false.
+ */
+export function isString(value: any): value is string {
+    return typeof value === 'string';
+}
+
+/**
+ * Checks if a value is a number.
+ *
+ * @param {any} value - The value to check.
+ * @return {boolean} - Returns true if the value is a number, otherwise false.
+ */
+export function isNumber(value: any): value is number {
+    return typeof value === 'number';
+}
+
+/**
+ * Checks if a given value is a boolean.
+ *
+ * @param {any} value - The value to be checked.
+ *
+ * @return {boolean} - Returns true if the value is a boolean, otherwise false.
+ */
+export function isBoolean(value: any): value is boolean {
+    return typeof value === 'boolean';
+}
+
+/**
+ * Checks if a value is an object.
+ * @param {any} value - The value to be checked.
+ * @returns {boolean} - Returns true if the value is an object, otherwise returns false.
+ */
+export function isObject(value: any): value is object {
+    return value != null && typeof value === 'object' && !Array.isArray(value);
+}
+
+/**
+ * Determines if a value is an array.
+ *
+ * @param value - The value to be checked.
+ *
+ * @return Whether the value is an array.
+ */
+export function isArray(value: any): value is any[] {
+    return Array.isArray(value);
+}
+
+/**
+ * Checks if a value is a function.
+ *
+ * @param {any} value - The value to be checked.
+ * @return {boolean} - Returns true if the value is a function, otherwise returns false.
+ */
+export function isFunction(value: any): value is Function {
+    return typeof value === 'function';
+}
+
+/**
+ * Checks if a value is undefined.
+ *
+ * @param {any} value - The value to check.
+ * @returns {boolean} - True if the value is undefined, false otherwise.
+ */
+export function isUndefined(value: any): value is undefined {
+    return typeof value === 'undefined';
+}
+
+/**
+ * Checks if a value is defined or not.
+ *
+ * @param {any} value - The value to be checked.
+ *
+ * @return {boolean} - True if the value is defined, false otherwise.
+ */
+export function isDefined(value: any): value is undefined {
+    return typeof value !== 'undefined';
+}
+
+/**
+ * Checks if a given value is null.
+ *
+ * @param {any} value - The value to check for null.
+ * @return {boolean} - Returns true if the value is null, otherwise returns false.
+ */
+export function isNull(value: any): value is null {
+    return value === null;
+}
+
+/**
+ * Determines whether the given value is of type bigint.
+ * @param {any} value - The value to be checked.
+ * @return {boolean} - Returns true if the value is of type bigint, false otherwise.
+ */
+export function isBigInt(value: any): value is bigint {
+    return typeof value === 'bigint';
+}
+
+/**
+ * Checks if a given value is a symbol.
+ *
+ * @param {any} value - The value to be checked.
+ * @return {boolean} - Returns true if the value is a symbol, false otherwise.
+ */
+export function isSymbol(value: any): value is symbol {
+    return typeof value === 'symbol';
+}
+
+/**
+ * Checks if a value is null or undefined.
+ *
+ * @param {any} value - The value to check.
+ * @return {boolean} - Returns true if the value is null or undefined, false otherwise.
+ */
+export function isNullOrUndefined(value: any): boolean {
+    return value === null || typeof value === 'undefined';
+}
+
+/**
+ * Checks if a given value is empty.
+ *
+ * @param {any} value - The value to check.
+ * @return {boolean} - Returns true if the value is empty, otherwise returns false.
+ */
+export function isEmpty(value: any): boolean {
+    return (Array.isArray(value) && value.length === 0) ||
+        (typeof value === 'string' && value === '') ||
+        value === null || typeof value === 'undefined';
+}
+
+/**
+ * Check if a value is empty or contains only whitespace characters.
+ *
+ * @param {any} value - The value to check.
+ * @return {boolean} Returns true if the value is empty or contains only whitespace characters, otherwise returns false.
+ */
+export function isEmptyOrWhitespace(value: any): boolean {
+    return (Array.isArray(value) && value.length === 0) ||
+        (typeof value === 'string' && value.trim() === '') ||
+        value === null || typeof value === 'undefined';
+}
+
+
+/**
+ * Submits a form via AJAX and returns a Promise that resolves to the Response object.
+ *
+ * @param {HTMLFormElement | string} selectorOrElement - The form element or selector.
+ * @return {Promise<Response>} A Promise that resolves to the Response object.
+ * @throws {Error} If the element is invalid.
+ */
+export async function ajaxSubmit(selectorOrElement: HTMLFormElement | string): Promise<Response> {
+
+    const form = typeof selectorOrElement === 'string'
+        ? document.querySelector(selectorOrElement)
+        : selectorOrElement;
+
+    if (!(form instanceof HTMLFormElement)) {
+        throw new Error("Invalid element.");
+    }
+
+    // Crear un objeto FormData a partir del formulario
+    return await fetch(form.action, {
+        method: form.method,
+        body: new FormData(form),
+    });
+}
+
+/**
+ * Converts an object into an array of key-value pairs.
+ *
+ * @param {Record<string, any>} obj - The object to convert.
+ * @return {Pair<string, any>[]} - The array of key-value pairs.
+ */
+export function toPairs(obj: Record<string, any>): Pair<string, any>[] {
+
+    let output = [];
+    for (const key in obj) {
+        output.push(new Pair(key, obj[key]));
+    }
+    return output;
+
+}
+
+/**
+ * Converts a given thing into a Promise.
+ * @template T
+ * @param {any} thing - The thing to be converted into a Promise.
+ * @returns {Promise<T>} - A Promise representing the given thing.
+ */
+export function promisify<T>(thing: any): Promise<T> {
+
+    if (thing instanceof Promise)
+        return thing;
+
+
+    if (isFunction(thing)) {
+        return new Promise<T>((resolve, reject) => {
+            try {
+                const result = thing();
+                resolve(result);
+            } catch (error) {
+                reject(error);
+            }
+        });
+    }
+
+    return Promise.resolve(thing);
+}
+
+
+export function ajaxSubmission(selectorOrElement: HTMLFormElement | string,
+                               onSuccess: Optional<Provider<any>> = undefined,
+                               onFailure: Optional<Provider<any>> = undefined) : void {
+
+    const form = typeof selectorOrElement === 'string'
+        ? document.querySelector(selectorOrElement)
+        : selectorOrElement;
+
+    if (!(form instanceof HTMLFormElement)) {
+        return;
+    }
+
+    form.addEventListener('submit', async (event) => {
+        event.preventDefault();
+        let promise = ajaxSubmit(form);
+        if (promise) {
+            if (onSuccess)
+                promise = promise.then(onSuccess);
+            if (onFailure)
+                promise.catch(onFailure);
+        }
+
+    });
+
+
+}
+
+
+/**
+ * Creates a deep clone of the given object.
+ * @template T
+ * @param {T} obj - The object to clone.
+ * @return {T} - The deep clone of the given object.
+ */
+export function deepClone<T>(obj: T): T {
+    if (obj === null || typeof obj !== 'object') {
+        return obj;
+    }
+
+    if (Array.isArray(obj)) {
+        const copy: any[] = [];
+        for (const element of obj) {
+            copy.push(deepClone(element));
+        }
+        return copy as T;
+    }
+
+    const copy: { [key: string]: any } = {};
+    for (const key in obj) {
+        if (obj.hasOwnProperty(key)) {
+            copy[key] = deepClone((obj as { [key: string]: any })[key]);
+        }
+    }
+    return copy as T;
+}
+
+/**
+ * Returns the type of the given value.
+ *
+ * @param {any} value - The value to determine the type of.
+ * @return {Type} - The type of the given value.
+ */
+export function getType(value: any): Type {
+
+    return value === null ? Type.Null : Type[typeof value as keyof typeof Type];
+}
+
+/**
+ * Converts an object to `FormData` format recursively.
+ *
+ * @param {Record<string, any>} data - The object data to convert.
+ * @param {FormData} formData - The `FormData` instance to append data to.
+ * @param {string} parentKey - The parent key to append to child keys in the `FormData`.
+ * @returns {FormData} - The `FormData` instance with the converted data.
+ */
+function _objectToFormData(data: Record<string, any>, formData: FormData, parentKey: string = ''): FormData {
+
+    for (const key in data) {
+        if (data.hasOwnProperty(key)) {
+            const value = data[key];
+
+            if (value instanceof Date) {
+                formData.append(parentKey ? `${parentKey}[${key}]` : key, value.toISOString());
+            } else if (value instanceof File) {
+                formData.append(parentKey ? `${parentKey}[${key}]` : key, value);
+            } else if (typeof value === 'object' && !Array.isArray(value)) {
+                _objectToFormData(value, formData, parentKey ? `${parentKey}[${key}]` : key);
+            } else if (Array.isArray(value)) {
+                value.forEach((item, index) => {
+                    const arrayKey = `${parentKey ? `${parentKey}[${key}]` : key}[${index}]`;
+                    if (typeof item === 'object' && !Array.isArray(item)) {
+                        _objectToFormData(item, formData, arrayKey);
+                    } else {
+                        formData.append(arrayKey, item);
+                    }
+                });
+            } else {
+                formData.append(parentKey ? `${parentKey}[${key}]` : key, value);
+            }
+        }
+    }
+
+    return formData;
+}
+
+/**
+ * Converts an object into FormData.
+ *
+ * @param {Record<string, any>} data - The object to be converted into FormData.
+ * @return {FormData} - The FormData object representing the converted data.
+ */
+export function objectToFormData(data: Record<string, any>): FormData {
+    let formData = new FormData();
+    return _objectToFormData(data, formData);
+}

package/src/functions.ts

@@ -1,247 +0,0 @@
-// noinspection JSUnusedGlobalSymbols
-
-
-import Pair from "./pair";
-import {Nullable, Provider} from "./types";
-
-export function isIterable(obj: any): boolean {
-    return obj[Symbol.iterator] === 'function';
-}
-
-export function clamp(n: number, min: number, max: number) {
-    if (n <= min)
-        return min;
-    if (n >= max)
-        return max;
-    return n
-}
-
-/**
- * Linearly remaps a value from its source range [`inMin`, `inMax`] to the destination range [`outMin`, `outMax`]
- *
- * @category Math
- * @example
- * ```
- * const value = remap(0.5, 0, 1, 200, 400) // value will be 300
- * ```
- */
-export function lerp(n: number, inMin: number, inMax: number, outMin: number, outMax: number) {
-
-
-    return outMin + (outMax - outMin) * ((n - inMin) / (inMax - inMin))
-
-
-}
-
-
-/**
- * Ensure prefix of a string
- *
- * @category String
- */
-export function ensurePrefix(prefix: string, str: string) {
-    if (!str.startsWith(prefix))
-        return prefix + str
-    return str
-}
-
-/**
- * Ensure suffix of a string
- *
- * @category String
- */
-export function ensureSuffix(suffix: string, str: string) {
-    if (!str.endsWith(suffix))
-        return str + suffix
-    return str
-}
-
-export function isString(value: any): value is string {
-    return typeof value === 'string';
-}
-
-export function isNumber(value: any): value is number {
-    return typeof value === 'number';
-}
-
-export function isBoolean(value: any): value is boolean {
-    return typeof value === 'boolean';
-}
-
-export function isObject(value: any): value is object {
-    return value !== null && typeof value === 'object' && !Array.isArray(value);
-}
-
-export function isArray(value: any): value is any[] {
-    return Array.isArray(value);
-}
-
-export function isFunction(value: any): value is Function {
-    return typeof value === 'function';
-}
-
-export function isUndefined(value: any): value is undefined {
-    return typeof value === 'undefined';
-}
-
-export function isNull(value: any): value is null {
-    return value === null;
-}
-
-export function isBigInt(value: any): value is bigint {
-    return typeof value === 'bigint';
-}
-
-export function isSymbol(value: any): value is symbol {
-    return typeof value === 'symbol';
-}
-
-export function isNullOrUndefined(value: any) {
-    return value === null || typeof value === 'undefined';
-}
-
-export function isEmpty(value: any): boolean {
-    return (Array.isArray(value) && value.length === 0) ||
-        (typeof value === 'string' && value === '') ||
-        value === null || typeof value === 'undefined';
-}
-
-export function isEmptyOrWhitespace(value: any): boolean {
-    return (Array.isArray(value) && value.length === 0) ||
-        (typeof value === 'string' && value.trim() === '') ||
-        value === null || typeof value === 'undefined';
-}
-
-
-export async function ajaxSubmit(selectorOrElement: HTMLFormElement | string): Promise<Response> {
-
-    const form = typeof selectorOrElement === 'string'
-        ? document.querySelector(selectorOrElement)
-        : selectorOrElement;
-
-    if (!(form instanceof HTMLFormElement)) {
-        throw new Error("Invalid element.");
-    }
-
-    // Crear un objeto FormData a partir del formulario
-    return await fetch(form.action, {
-        method: form.method,
-        body: new FormData(form),
-    });
-}
-
-export function toPairs(obj: any): Pair<any, any>[] {
-
-    let output = [];
-    for (const key in obj) {
-        output.push(new Pair(key, obj[key]));
-    }
-    return output;
-
-}
-
-export function promisify<T>(thing: any): Promise<T> {
-
-    if (thing instanceof Promise)
-        return thing;
-
-
-    if (isFunction(thing)) {
-        return new Promise<T>((resolve, reject) => {
-            try {
-                const result = thing();
-                resolve(result);
-            } catch (error) {
-                reject(error);
-            }
-        });
-    }
-
-    return Promise.resolve(thing);
-}
-
-export function ajaxSubmission(selectorOrElement: HTMLFormElement | string,
-                               onSuccess: Nullable<Provider<Nullable<any>>> = null,
-                               onFailure: Nullable<Provider<Nullable<any>>> = null) {
-
-    const form = typeof selectorOrElement === 'string'
-        ? document.querySelector(selectorOrElement)
-        : selectorOrElement;
-
-    if (!(form instanceof HTMLFormElement)) {
-        return;
-    }
-
-    form.addEventListener('submit', async (event) => {
-        event.preventDefault();
-        let promise = ajaxSubmit(form);
-        if (promise) {
-            if (onSuccess)
-                promise = promise.then(onSuccess);
-            if (onFailure)
-                promise.catch(onFailure);
-        }
-
-    });
-
-
-}
-
-
-export function deepClone<T>(obj: T): T {
-    if (obj === null || typeof obj !== 'object') {
-        return obj;
-    }
-
-    if (Array.isArray(obj)) {
-        const copy: any[] = [];
-        for (const element of obj) {
-            copy.push(deepClone(element));
-        }
-        return copy as T;
-    }
-
-    const copy: { [key: string]: any } = {};
-    for (const key in obj) {
-        if (obj.hasOwnProperty(key)) {
-            copy[key] = deepClone((obj as { [key: string]: any })[key]);
-        }
-    }
-    return copy as T;
-}
-
-function _objectToFormData(data: Record<string, any>, formData: FormData, parentKey: string = ''): FormData {
-
-
-    for (const key in data) {
-        if (data.hasOwnProperty(key)) {
-            const value = data[key];
-
-            if (value instanceof Date) {
-                formData.append(parentKey ? `${parentKey}[${key}]` : key, value.toISOString());
-            } else if (value instanceof File) {
-                formData.append(parentKey ? `${parentKey}[${key}]` : key, value);
-            } else if (typeof value === 'object' && !Array.isArray(value)) {
-                _objectToFormData(value, formData, parentKey ? `${parentKey}[${key}]` : key);
-            } else if (Array.isArray(value)) {
-                value.forEach((item, index) => {
-                    const arrayKey = `${parentKey ? `${parentKey}[${key}]` : key}[${index}]`;
-                    if (typeof item === 'object' && !Array.isArray(item)) {
-                        _objectToFormData(item, formData, arrayKey);
-                    } else {
-                        formData.append(arrayKey, item);
-                    }
-                });
-            } else {
-                formData.append(parentKey ? `${parentKey}[${key}]` : key, value);
-            }
-        }
-    }
-
-    return formData;
-}
-
-export function objectToFormData(data: Record<string, any>): FormData {
-    let formData = new FormData();
-    return _objectToFormData(data, formData);
-}