@rzl-zone/utils-js 3.0.2-beta.2 → 3.1.0

package/dist/conversions/index.js

@@ -1 +1 @@
-export{f as convertType,g as removeObjectPaths,b as toBooleanContent,c as toBooleanContentDeep,d as toBooleanExplicit,e as toBooleanLoose,a as toNumberArrayUnRecursive,h as toNumberDeep,i as toStringDeep}from'../chunk-VYCGZ2S6.js';export{b as cleanParsedData,a as extractDigits,c as parseCustomDate,d as safeJsonParse}from'../chunk-PVJF2JHM.js';import'../chunk-DGH75GJD.js';export{d as dedupeArray,b as filterNilArray,c as filterNullArray,e as toStringArrayUnRecursive,a as toStringDeepForce}from'../chunk-WHAVUFEU.js';import'../chunk-ZYAML74V.js';import'../chunk-W5EDKJK3.js';import'../chunk-QFCGBBSY.js';export{a as parseCurrencyString}from'../chunk-XH6MCRLP.js';import'../chunk-4JOQ45HL.js';import'../chunk-SYJC7UAW.js';import'../chunk-NIMNTEGV.js';import'../chunk-XVB3ZZEB.js';export{c as safeStableStringify}from'../chunk-MNGGDB2G.js';import'../chunk-5SZUSNGZ.js';import'../chunk-XCFIOTCV.js';
+export{convertType,removeObjectPaths,toBooleanContent,toBooleanContentDeep,toBooleanExplicit,toBooleanLoose,toNumberArrayUnRecursive,toNumberDeep,toStringDeep}from"../chunk-EGNZCW4K.js";export{cleanParsedData,extractDigits,parseCustomDate,safeJsonParse}from"../chunk-LBMEEJWA.js";import"../chunk-HQ5GQTEE.js";export{dedupeArray,filterNilArray,toStringArrayUnRecursive,toStringDeepForce}from"../chunk-CTBRLEOG.js";import"../chunk-FEKDB32T.js";import"../chunk-BSVZRN7C.js";import"../chunk-ZXIWDFEQ.js";export{parseCurrencyString}from"../chunk-VEYMQ3UA.js";import"../chunk-DUK2K4FB.js";import"../chunk-FIAAX3UE.js";import"../chunk-TSLYDPBJ.js";import"../chunk-W2W3L2M5.js";export{safeStableStringify}from"../chunk-AJ65QFV2.js";import"../chunk-QNKGP5DY.js";import"../chunk-2UIRWYE3.js";

package/dist/env/index.cjs

@@ -1 +1 @@
-'use strict';require('../chunk-MMSYCIJ2.cjs');var chunkSW6HYEW7_cjs=require('../chunk-SW6HYEW7.cjs');Object.defineProperty(exports,"isServer",{enumerable:true,get:function(){return chunkSW6HYEW7_cjs.a}});
+"use strict";require("../chunk-MMSYCIJ2.cjs");var e=require("../chunk-J2RGTPGK.cjs");Object.defineProperty(exports,"isServer",{enumerable:!0,get:function(){return e.isServer}});

package/dist/env/index.d.ts

@@ -1,19 +1,16 @@
 /** ----------------------------------------
-* * ***Detects if the current environment is server-side (Node.js) or client-side (browser).***
-* ----------------------------------------
-*
-* Determines whether the code is running in a Node.js environment (server)
-* or in a browser environment (client).
-*
-* @returns {boolean}
-* - `true` → running on the **server-side** (Node.js).
-* - `false` → running on the **client-side** (browser).
-*
-* @example
-* if (isServer()) {
-*   console.log("Running on Node.js");
-* } else {
-*   console.log("Running in the browser");
-* }
-*/
+ * * ***Utility: `isServer`.***
+ * ----------------------------------------
+ * **Checks if the current execution environment is at **server-side** (Node.js)
+ * or **client-side** (browser).**
+ * @returns {boolean}
+ * - `true` ➔ running on the **server-side** (Node.js).
+ * - `false` ➔ running on the **client-side** (browser).
+ * @example
+ * if (isServer()) {
+ *   console.log("Running on Node.js");
+ * } else {
+ *   console.log("Running in the browser");
+ * }
+ */
 declare const isServer:()=>boolean;export{isServer};

package/dist/env/index.js

@@ -1 +1 @@
-import'../chunk-G5LXIEFO.js';export{a as isServer}from'../chunk-56QBKKRE.js';
+import"../chunk-G5LXIEFO.js";export{isServer}from"../chunk-MC3LXMCQ.js";

package/dist/events/index.cjs

@@ -1 +1 @@
-'use strict';var chunkGQE4OVHC_cjs=require('../chunk-GQE4OVHC.cjs');require('../chunk-SW6HYEW7.cjs'),require('../chunk-BVPMMWDL.cjs'),require('../chunk-CN53M4QZ.cjs');Object.defineProperty(exports,"disableUserInteraction",{enumerable:true,get:function(){return chunkGQE4OVHC_cjs.a}});Object.defineProperty(exports,"enableUserInteraction",{enumerable:true,get:function(){return chunkGQE4OVHC_cjs.b}});Object.defineProperty(exports,"removeElementFocus",{enumerable:true,get:function(){return chunkGQE4OVHC_cjs.c}});Object.defineProperty(exports,"scrollToTop",{enumerable:true,get:function(){return chunkGQE4OVHC_cjs.d}});
+"use strict";var e=require("../chunk-KXIXXSWX.cjs");require("../chunk-J2RGTPGK.cjs"),require("../chunk-Y4O5KZF6.cjs"),require("../chunk-INUFZJLX.cjs"),Object.defineProperty(exports,"disableUserInteraction",{enumerable:!0,get:function(){return e.disableUserInteraction}}),Object.defineProperty(exports,"enableUserInteraction",{enumerable:!0,get:function(){return e.enableUserInteraction}}),Object.defineProperty(exports,"removeElementFocus",{enumerable:!0,get:function(){return e.removeElementFocus}}),Object.defineProperty(exports,"scrollToTop",{enumerable:!0,get:function(){return e.scrollToTop}});

package/dist/events/index.d.ts

@@ -1,119 +1,122 @@
 type ScrollToTopOptions={
-/** `"auto" | "instant" | "smooth"` defaults value `"smooth"` */
+/** Scroll animation type.
+ *
+ * - Valid values: `"auto"`, `"instant"`, `"smooth"`.
+ * - Default force to `"smooth"` if missing or invalid.
+ *
+ * @default "smooth"
+ */
 behavior?:ScrollBehavior|undefined;
-/** `number | undefined` defaults value `1` as `ms` */
+/** Delay before scrolling (in milliseconds).
+ *
+ * - Default value is `1`.
+ * - Valid values: any number `≥` `1`.
+ * - Non-integer number are truncated to an integer.
+ * - Force to `2147483647` if number is larger than `2147483647`.
+ * - Default force to `1` if `missing`, `NaN`, `invalid-type`, or `less-than` `1`.
+ *
+ * @default 1
+ */
 timeout?:number|undefined;};
 /** ----------------------------------------------------------
-* * ***Disables user interaction by adding a CSS class to the `<html>` element.***
-* ----------------------------------------------------------
-*
-* Key points:
-* - Works **only in browser environments**.
-* - Safely adds the specified CSS class to `<html>`.
-* - Prevents multiple additions of the same class.
-* - Useful to indicate that a process is ongoing
-*   (e.g., loading or processing state).
-*
-* **Using custom CSS classes:**
-* - You can pass any class name that exists in your CSS.
-* - Example: if you have `.loading` in your styles, passing `"loading"`
-*   will add it and disable interactions accordingly.
-*
-* **Validation:**
-* - Throws `TypeError` if the `className` parameter is not a string.
-*
-* @param {string} [className="on_processing"] - The CSS class to add. Defaults to `"on_processing"`.
-*
-* @returns {void} Does not return anything.
-*
-* @throws {TypeError} If `className` is not a string.
-*
-* @example
-* disableUserInteraction();           // Adds "on_processing" class
-* disableUserInteraction("loading");  // Adds "loading" class
-* // ❌ Invalid value:
-* disableUserInteraction(123);        // Throws TypeError
-*/
+ * * ***Utility: `disableUserInteraction`.***
+ * ----------------------------------------------------------
+ * **Disables user interaction by adding a CSS class to the `<html>` element.**
+ * - **Key points**:
+ *    - Works **only in browser environments**.
+ *    - Safely adds the specified CSS class to `<html>`.
+ *    - Prevents multiple additions of the same class.
+ *    - Useful to indicate that a process is ongoing
+ *   (e.g., loading or processing state).
+ * - **Using custom CSS classes:**
+ *    - You can pass any class name that exists in your CSS.
+ *    - Example: if you have `.loading` in your styles, passing `"loading"`
+ *   will add it and disable interactions accordingly.
+ * - **Validation:**
+ *    - Throws `TypeError` if the `className` parameter is not a string.
+ * @param {string} [className="on_processing"] - The CSS class to add, defaults to `"on_processing"`.
+ * @returns {void} Does not return anything.
+ * @throws {TypeError} If `className` is not a string.
+ * @example
+ * disableUserInteraction();          // ➔ Adds "on_processing" class
+ * disableUserInteraction("loading"); // ➔ Adds "loading" class
+ * // ❌ Invalid value:
+ * disableUserInteraction(123);       // ➔ Throws TypeError
+ */
 declare const disableUserInteraction:(className?:string)=>void;
 /** ----------------------------------------------------------
-* * ***Enables user interaction by removing a CSS class from the `<html>` element.***
-* ----------------------------------------------------------
-*
-* Key points:
-* - Works **only in browser environments**.
-* - Safely removes the specified CSS class from `<html>`.
-* - Does nothing if the class is not present.
-* - Useful to re-enable user interactions after a process
-*   (e.g., loading or processing) completes.
-*
-* **Using custom CSS classes:**
-* - You can pass any class name that exists in your CSS.
-* - Example: if you have `.loading` in your styles, passing `"loading"`
-*   will remove it and re-enable interactions.
-*
-* **Validation:**
-* - Throws `TypeError` if the `className` parameter is not a string.
-*
-* @param {string} [className="on_processing"] - The CSS class to remove. Defaults to `"on_processing"`.
-*
-* @returns {void} Does not return anything.
-*
-* @throws {TypeError} If `className` is not a string.
-*
-* @example
-* enableUserInteraction();           // ➔ Removes "on_processing" class
-* enableUserInteraction("loading");  // ➔ Removes "loading" class
-* // ➔ ❌ Invalid value:
-* enableUserInteraction(123);        // ➔ Throws TypeError
-*/
+ * * ***Utility: `enableUserInteraction`.***
+ * ----------------------------------------------------------
+ * **Enables user interaction by removing a CSS class from the `<html>` element.**
+ * - **Key points**:
+ *    - Works **only in browser environments**.
+ *    - Safely removes the specified CSS class from `<html>`.
+ *    - Does nothing if the class is not present.
+ *    - Useful to re-enable user interactions after a process
+ *   (e.g., loading or processing) completes.
+ * - **Using custom CSS classes:**
+ *    - You can pass any class name that exists in your CSS.
+ *    - Example: if you have `.loading` in your styles, passing `"loading"`
+ *   will remove it and re-enable interactions.
+ * - **Validation:**
+ *    - Throws `TypeError` if the `className` parameter is not a string.
+ * @param {string} [className="on_processing"] - The CSS class to remove, defaults to `"on_processing"`.
+ * @returns {void} Does not return anything.
+ * @throws {TypeError} If `className` is not a string.
+ * @example
+ * enableUserInteraction();          // ➔ Removes "on_processing" class
+ * enableUserInteraction("loading"); // ➔ Removes "loading" class
+ * // ❌ Invalid value:
+ * enableUserInteraction(123);       // ➔ Throws TypeError
+ */
 declare const enableUserInteraction:(className?:string)=>void;
 /** ----------------------------------------------------------
-* * ***Removes focus from the currently active element in the document.***
-* ----------------------------------------------------------
-*
-* - This function works **only in browser environments**.
-* - If an element is focused, it will lose focus by calling `blur()`.
-* - If no element is focused or the active element is not an `HTMLElement`, nothing happens.
-*
-* @returns {void} Does not return anything.
-*
-* @example
-* removeElementFocus(); // Removes focus from the currently active element
-*/
+ * * ***Utility: `removeElementFocus`.***
+ * ----------------------------------------------------------
+ * **Removes focus from the currently active element in the document.**
+ * - **Features**:
+ *    - This function works **only in browser environments**.
+ *    - If an element is focused, it will lose focus by calling `blur()`.
+ *    - If no element is focused or the active element is not an `HTMLElement`, nothing happens.
+ * @returns {void} Does not return anything.
+ * @example
+ * removeElementFocus(); // ➔ Removes focus from the currently active element
+ */
 declare const removeElementFocus:()=>void;
 /** ----------------------------------------------------------
-* * ***Scrolls the page to the top with optional smooth animation and delay.***
-* ----------------------------------------------------------
-*
-* - This function works **only in browser environments** (no effect on server-side).
-* - It leverages the native `window.scrollTo()` API with support for smooth scrolling
-* and an optional timeout delay before executing the scroll.
-*
-* Each option has strict valid values. If an invalid value is provided, the function
-* **automatically falls back to its default**.
-*
-* @param {ScrollToTopOptions} [options] - Optional settings for scroll behavior.
-* @param {ScrollBehavior} [options.behavior="smooth"] - Scroll animation type.
-*   - Valid values: `"auto"`, `"instant"`, `"smooth"`.
-*   - Default: `"smooth"` if missing or invalid.
-* @param {number} [options.timeout=1] - Delay before scrolling (in milliseconds).
-*   - Valid values: any number >= 1.
-*   - Default: `1` if missing, invalid, or less than 1.
-*
-* @returns {void} Does not return anything.
-*
-* @example
-* // Scroll smoothly to the top after 1ms delay
-* scrollToTop();
-*
-* // Jump instantly to the top
-* scrollToTop({ behavior: "instant" });
-*
-* // Scroll smoothly to the top after 500ms
-* scrollToTop({ timeout: 500 });
-*
-* // ❌ Invalid options value:
-* scrollToTop({ behavior: "fly", timeout: -100 });
-* // Fallback: behavior="smooth", timeout=1
-*/
+ * * ***Utility: `scrollToTop`.***
+ * ----------------------------------------------------------
+ * **Scrolls the page to the top with optional smooth animation and delay.**
+ * - **Features**:
+ *    - This function works **only in browser environments** (no effect on server-side).
+ *    - It leverages the native `window.scrollTo()` API with support for smooth scrolling
+ * and an optional timeout delay before executing the scroll.
+ * - Each option has strict valid values.
+ *    - If an invalid value is provided, the function **automatically falls back to its default**.
+ * @param {ScrollToTopOptions} [options] - Optional settings for scroll behavior.
+ * @param {ScrollToTopOptions["behavior"]} [options.behavior="smooth"] - Scroll animation type.
+ *   - Valid values: `"auto"`, `"instant"`, `"smooth"`.
+ *   - Default force to `"smooth"` if missing or invalid.
+ * @param {ScrollToTopOptions["timeout"]} [options.timeout=1] - Delay before scrolling (in milliseconds).
+ *   - Default value is `1`.
+ *   - Valid values: any number `≥` `1`.
+ *   - Non-integer number are truncated to an integer.
+ *   - Force to `2147483647` if number is larger than `2147483647`.
+ *   - Default force to `1` if `missing`, `NaN`, `invalid`, or `less-than` `1`.
+ * @returns {void} Does not return anything, only scrolling to top.
+ * @example
+ * // ✅ Valid options value:
+ * scrollToTop();
+ * // ➔ Scroll smoothly to the top after 1ms delay
+ * scrollToTop({ behavior: "instant" });
+ * // ➔ Jump instantly to the top
+ * scrollToTop({ timeout: 500 });
+ * // ➔ Scroll smoothly to the top after 500ms
+ *
+ * // ❌ Invalid options value:
+ * scrollToTop({ behavior: "fly", timeout: -100 });
+ * // ➔ Fallback: behavior="smooth", timeout=1
+ * scrollToTop({ behavior: "fly", timeout: 123.55 });
+ * // ➔ Fallback: behavior="smooth", timeout=123
+ */
 declare const scrollToTop:(options?:ScrollToTopOptions)=>void;export{disableUserInteraction,enableUserInteraction,removeElementFocus,scrollToTop};

package/dist/events/index.js

@@ -1 +1 @@
-export{a as disableUserInteraction,b as enableUserInteraction,c as removeElementFocus,d as scrollToTop}from'../chunk-RN3TP3S3.js';import'../chunk-56QBKKRE.js';import'../chunk-XVB3ZZEB.js';import'../chunk-XCFIOTCV.js';
+export{disableUserInteraction,enableUserInteraction,removeElementFocus,scrollToTop}from"../chunk-5I2B5DOG.js";import"../chunk-MC3LXMCQ.js";import"../chunk-W2W3L2M5.js";import"../chunk-2UIRWYE3.js";