@rzl-zone/utils-js 3.5.5 → 3.5.7

package/dist/chunk-VCVND6CH.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-VJDDGRIK.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-VNADVWSJ.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-WVSPXFTY.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-XFTUHS4Y.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-YC7AK3KX.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-YGB2BQPB.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-YWHHVDT4.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/chunk-ZN53RM3R.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/conversions/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/conversions/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/conversions/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/events/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/events/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================
@@ -23,14 +23,32 @@
  *   will add it and disable interactions accordingly.
  * - **Validation:**
  *    - Throws `TypeError` if the `className` parameter is not a string.
+ * @defaultValue `"on_processing"`
  * @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
+ * * ***Example in your code:***
+ * ```ts
  * disableUserInteraction();          // ➔ Adds "on_processing" class
  * disableUserInteraction("loading"); // ➔ Adds "loading" class
  * // ❌ Invalid value:
  * disableUserInteraction(123);       // ➔ Throws TypeError
+ * ```
+ * * ***Example in your css file (with defaultValue `className` props [on_processing]):***
+ * ```css
+ * .on_processing {
+ *   cursor: wait;
+ *   touch-action: none;
+ *   user-select: none;
+ * }
+ *
+ * .on_processing > * {
+ *   pointer-events: none;
+ *   touch-action: none;
+ *   user-select: none;
+ * }
+ * ```
  */
 declare const disableUserInteraction:(className?:string)=>void;
 /** ----------------------------------------------------------
@@ -49,14 +67,32 @@ declare const disableUserInteraction:(className?:string)=>void;
  *   will remove it and re-enable interactions.
  * - **Validation:**
  *    - Throws `TypeError` if the `className` parameter is not a string.
+ * @defaultValue `"on_processing"`
  * @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
+ * * ***Example in your code:***
+ * ```ts
  * enableUserInteraction();          // ➔ Removes "on_processing" class
  * enableUserInteraction("loading"); // ➔ Removes "loading" class
  * // ❌ Invalid value:
  * enableUserInteraction(123);       // ➔ Throws TypeError
+ * ```
+ * * ***Example in your css file (with defaultValue `className` props [on_processing]):***
+ * ```css
+ * .on_processing {
+ *   cursor: wait;
+ *   touch-action: none;
+ *   user-select: none;
+ * }
+ *
+ * .on_processing > * {
+ *   pointer-events: none;
+ *   touch-action: none;
+ *   user-select: none;
+ * }
+ * ```
  */
 declare const enableUserInteraction:(className?:string)=>void;
 /** ----------------------------------------------------------

package/dist/events/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/formatters/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/formatters/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/formatters/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/generators/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/generators/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/generators/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/isPlainObject-FWmcJF6k.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/server/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/server/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/next/server/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/operations/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/operations/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/operations/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/parsers/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/parsers/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/parsers/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/predicates/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/predicates/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/predicates/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/promises/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/promises/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/promises/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/rzl-utils.global.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/strings/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/strings/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/strings/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/tailwind/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/tailwind/index.d.ts

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================
@@ -365,32 +365,54 @@ declare const customCnV4:(customTwMergeV4:TwMergeDefaultFnV4,...classes:ClassesV
  * * ***Utility: `shouldForwardProp`.***
  * ----------------------------------------------------------
  * **Creates a helper for styled-components `shouldForwardProp`.**
+ *
  * @description
- * This utility returns a predicate function that determines whether a given prop
- * should be forwarded to the DOM, useful for filtering out internal props (e.g.,
- * `$size`, `$active`) so they don't end up as invalid HTML attributes.
+ * 1. Returns a **predicate function** that determines whether a given prop
+ * should be forwarded to the DOM.
+ * 2. Useful for filtering out internal props (e.g., `$size`, `$active`)
+ * so they don't become invalid HTML attributes.
+ *
  * - **Behavior:**
- *    - Accepts a tuple (strict) of prop keys to exclude from forwarding.
- *    - Automatically coerces prop names to string for consistent checking.
- *    - Supports string, number, or symbol keys (via PropertyKey).
- *    - Will throw an error if the provided `props` argument is not an array.
- * @template CustomProps - The type of the component's props.
- * @param {UnionToTupleStrict<keyof CustomProps>} props
+ *    - Accepts a strict tuple of **string keys** to exclude from forwarding.
+ *    - Every key is validated as a **non-empty string** at runtime.
+ *    - Throws a `TypeError` if:
+ *      - `props` is not an array, or
+ *      - any item is not a non-empty string.
+ *    - Automatically coerces the tested prop name to string for matching.
+ *
+ * @template CustomProps
+ *   The component props type to validate against.
+ *
+ * @param {readonly Stringify<keyof CustomProps>[]}
+ *   props
  *   The list of prop names (keys of `CustomProps`) to exclude from forwarding.
- * @returns {(propName: PropertyKey) => boolean}
- *   A function that takes a prop name and returns `true` if it should be forwarded, `false` if it should be blocked.
- * @throws {TypeError} If `props` is not an array.
+ *
+ * @returns {(propName: keyof CustomProps | ({} & string)) => boolean}
+ *   A function that receives a prop name and returns:
+ *   - `true`  ➔ the prop **will** be forwarded to the DOM.
+ *   - `false` ➔ the prop **will not** be forwarded.
+ *
+ * @throws {TypeError}
+ *   Thrown when:
+ *   - `props` is not an array, or
+ *   - any item is not a non-empty string.
+ *
  * @example
+ * // Basic usage
  * type Props = { $size: string; color: string; visible: boolean };
  * const filter = shouldForwardProp<Props>(["$size"]);
- * filter("$size");   // ➔ false (blocked)
- * filter("color");   // ➔ true (forwarded)
- * filter("visible"); // ➔ true (forwarded)
+ *
+ * filter("$size");   // ➔ false (blocked).
+ * filter("color");   // ➔ true  (forwarded).
+ * filter("visible"); // ➔ true  (forwarded).
+ *
  * @example
- * // Using with styled-components:
+ * // With styled-components
+ * type CustomProps = { $internal: boolean; public: string; another: boolean };
+ *
  * styled.div.withConfig({
  *   shouldForwardProp: shouldForwardProp<CustomProps>(["$internal"])
- * })
+ * });
  */
 declare const shouldForwardProp:<CustomProps extends Record<string,unknown>>(props:readonly Stringify<keyof CustomProps>[])=>((propName:keyof CustomProps|({}& string))=>boolean);
 /** -------------------------------------------------------------

package/dist/tailwind/index.js

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================

package/dist/urls/index.cjs

@@ -2,7 +2,7 @@
  * ====================================================
  * Rzl Utils-JS.
  * ----------------------------------------------------
- * Version: 3.5.5.
+ * Version: 3.5.7.
  * Author: Rizalvin Dwiky.
  * Repository: https://github.com/rzl-zone/utils-js.
  * ====================================================