@arkyn/shared 3.0.1-beta.14 → 3.0.1-beta.141

package/dist/formats/formatToEllipsis.d.ts

@@ -1,16 +1,19 @@
-type FormatToEllipsisFunction = (value: string, maxLength: number) => string;
 /**
  * Truncates a given text to a specified maximum length and appends an ellipsis ("...")
  * if the text exceeds the maximum length.
  *
- * @param text - The input string to be truncated.
- * @param maxLength - The maximum allowed length of the string before truncation.
- * @returns The truncated string with an ellipsis if the input exceeds the maximum length,
+ * @param {string} text - The input string to be truncated.
+ *
+ * @param {number} maxLength - The maximum allowed length of the string before truncation.
+ *
+ * @returns {string} The truncated string with an ellipsis if the input exceeds the maximum length,
  *          or the original string if it does not.
  * @example
+ * ```typescript
  * const result = formatToEllipsis("Hello, world!", 5);
  * console.log(result); // Output: "Hello..."
+ * ```
  */
-declare const formatToEllipsis: FormatToEllipsisFunction;
+declare function formatToEllipsis(text: string, maxLength: number): string;
 export { formatToEllipsis };
 //# sourceMappingURL=formatToEllipsis.d.ts.map

package/dist/formats/formatToEllipsis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToEllipsis.d.ts","sourceRoot":"","sources":["../../src/formats/formatToEllipsis.ts"],"names":[],"mappings":"AAAA,KAAK,wBAAwB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAE7E;;;;;;;;;;;GAWG;AAEH,QAAA,MAAM,gBAAgB,EAAE,wBAOvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"formatToEllipsis.d.ts","sourceRoot":"","sources":["../../src/formats/formatToEllipsis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAsBjE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/formats/formatToEllipsis.js

@@ -2,20 +2,34 @@
  * Truncates a given text to a specified maximum length and appends an ellipsis ("...")
  * if the text exceeds the maximum length.
  *
- * @param text - The input string to be truncated.
- * @param maxLength - The maximum allowed length of the string before truncation.
- * @returns The truncated string with an ellipsis if the input exceeds the maximum length,
+ * @param {string} text - The input string to be truncated.
+ *
+ * @param {number} maxLength - The maximum allowed length of the string before truncation.
+ *
+ * @returns {string} The truncated string with an ellipsis if the input exceeds the maximum length,
  *          or the original string if it does not.
  * @example
+ * ```typescript
  * const result = formatToEllipsis("Hello, world!", 5);
  * console.log(result); // Output: "Hello..."
+ * ```
  */
-const formatToEllipsis = (text, maxLength) => {
+function formatToEllipsis(text, maxLength) {
     if (text.length > maxLength) {
-        let trimmedText = text.substring(0, maxLength).trimEnd();
-        trimmedText = trimmedText.replace(/[.,!?;:]$/, "");
+        let trimmedText = text.substring(0, maxLength);
+        // Find the last space to avoid breaking words
+        const lastSpaceIndex = trimmedText.lastIndexOf(" ");
+        if (lastSpaceIndex > 0) {
+            trimmedText = trimmedText.substring(0, lastSpaceIndex);
+        }
+        // Remove trailing punctuation
+        trimmedText = trimmedText.replace(/[\s.,!?;:]+$/, "");
+        // If after removing punctuation the text is empty or only contains punctuation/spaces, return only "..."
+        if (trimmedText.trim().length === 0 || /^[.,!?;:\s]+$/.test(trimmedText)) {
+            return "...";
+        }
         return `${trimmedText}...`;
     }
     return text;
-};
+}
 export { formatToEllipsis };

package/dist/formats/formatToHiddenDigits.d.ts

@@ -1,35 +1,35 @@
-type FormatToHiddenDigitsFunction = (value: string, options: {
-    range?: number | [number, number];
-    hider?: string;
-}) => string;
 /**
  * Formats a string by hiding specific digits within a given range.
  *
  * This function takes a string input and replaces digits within a specified range
  * with a hiding character (e.g., "*"). Non-digit characters remain unchanged.
  *
- * @param value - The input string to be formatted.
- * @param options - Configuration options for formatting.
- * @param options.range - The range of digits to hide. It can be:
+ * @param {string} value - The input string to be formatted.
+ * @param {FormatToHiddenDigitsOptions} options - Configuration options for formatting.
+ * @param {number | [number, number]} options.range - The range of digits to hide. It can be:
  *   - A single number (e.g., `3`), which hides the first `n` digits if positive,
  *     or the last `n` digits if negative.
  *   - A tuple `[start, end]` specifying the range of digits to hide (inclusive).
  *   - Defaults to `3`, hiding the first three digits.
- * @param options.hider - The character used to hide digits. Defaults to `"*"`.
+ * @param {string} options.hider - The character used to hide digits. Defaults to `"*"`.
  *
- * @returns The formatted string with specified digits hidden.
+ * @returns {string} The formatted string with specified digits hidden.
  *
  * @example
  * ```typescript
- * import { formatToHiddenDigits } from "./formatToHiddenDigits";
- *
- * formatToHiddenDigits("123-456-7890", { range: 3 });
- * // Output: "***-456-7890"
+ * const formatted = formatToHiddenDigits("123-456-7890", { range: 3 });
+ * console.log(formatted); // Output: "***-456-7890"
+ * ```
  *
- * formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
- * // Output: "123-###-7890"
+ * @example
+ * ```typescript
+ * const formatted = formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
+ * console.log(formatted); // Output: "123-###-7890"
  * ```
  */
-declare const formatToHiddenDigits: FormatToHiddenDigitsFunction;
+declare function formatToHiddenDigits(value: string, options?: {
+    range?: number | [number, number];
+    hider?: string;
+}): string;
 export { formatToHiddenDigits };
 //# sourceMappingURL=formatToHiddenDigits.d.ts.map

package/dist/formats/formatToHiddenDigits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToHiddenDigits.d.ts","sourceRoot":"","sources":["../../src/formats/formatToHiddenDigits.ts"],"names":[],"mappings":"AAmBA,KAAK,4BAA4B,GAAG,CAClC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,KAC3D,MAAM,CAAC;AA4BZ;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,QAAA,MAAM,oBAAoB,EAAE,4BAU3B,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"formatToHiddenDigits.d.ts","sourceRoot":"","sources":["../../src/formats/formatToHiddenDigits.ts"],"names":[],"mappings":"AA6CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,iBAAS,oBAAoB,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9D,MAAM,CAWR;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/formats/formatToHiddenDigits.js

@@ -24,37 +24,37 @@ const within = (range, value) => value >= range[0] && value <= range[1];
  * This function takes a string input and replaces digits within a specified range
  * with a hiding character (e.g., "*"). Non-digit characters remain unchanged.
  *
- * @param value - The input string to be formatted.
- * @param options - Configuration options for formatting.
- * @param options.range - The range of digits to hide. It can be:
+ * @param {string} value - The input string to be formatted.
+ * @param {FormatToHiddenDigitsOptions} options - Configuration options for formatting.
+ * @param {number | [number, number]} options.range - The range of digits to hide. It can be:
  *   - A single number (e.g., `3`), which hides the first `n` digits if positive,
  *     or the last `n` digits if negative.
  *   - A tuple `[start, end]` specifying the range of digits to hide (inclusive).
  *   - Defaults to `3`, hiding the first three digits.
- * @param options.hider - The character used to hide digits. Defaults to `"*"`.
+ * @param {string} options.hider - The character used to hide digits. Defaults to `"*"`.
  *
- * @returns The formatted string with specified digits hidden.
+ * @returns {string} The formatted string with specified digits hidden.
  *
  * @example
  * ```typescript
- * import { formatToHiddenDigits } from "./formatToHiddenDigits";
- *
- * formatToHiddenDigits("123-456-7890", { range: 3 });
- * // Output: "***-456-7890"
+ * const formatted = formatToHiddenDigits("123-456-7890", { range: 3 });
+ * console.log(formatted); // Output: "***-456-7890"
+ * ```
  *
- * formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
- * // Output: "123-###-7890"
+ * @example
+ * ```typescript
+ * const formatted = formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
+ * console.log(formatted); // Output: "123-###-7890"
  * ```
  */
-const formatToHiddenDigits = (value, options) => {
+function formatToHiddenDigits(value, options) {
     const characters = parseToCharacters(value);
-    const range = normalizeRange(options.range ?? 3, characters.digits);
-    return characters.children
-        .map((node) => {
+    const range = normalizeRange(options?.range ?? 3, characters.digits);
+    const mappedCharacters = characters.children.map((node) => {
         if (node.kind === "digit" && within(range, node.digit))
-            return options.hider ?? "*";
+            return options?.hider ?? "*";
         return node.character;
-    })
-        .join("");
-};
+    });
+    return mappedCharacters.join("");
+}
 export { formatToHiddenDigits };

package/dist/formats/formatToPhone.d.ts

@@ -1,34 +1,23 @@
-type FormatToPhoneFunction = (prop: string) => string;
 /**
- * Formats a phone number string based on the provided country code and optional prefix.
+ * Formats a phone number string according to the country mask defined in `@arkyn/templates`.
  *
- * The input string should follow the format: `"<countryCode>-<prefix> <phoneNumber>"` or `"<countryCode> <phoneNumber>"`.
- * The function determines the appropriate formatting mask based on the country and applies it to the phone number.
+ * The function parses the input using libphonenumber-js to determine the country and
+ * national number, then applies the corresponding country's mask (underscore `_` used
+ * as digit placeholder) replacing placeholders with actual digits.
  *
- * @param prop - The phone number string to be formatted. It must include the country code and optionally a prefix.
- *               Example formats:
- *               - "+55 32912345678"
- *               - "+1 1234567890"
+ * @param {string} phoneNumber - The input phone number (can include country code or be in national format).
  *
- * @returns The formatted phone number string based on the country's formatting rules.
+ * @returns {string} The phone number formatted following the country's mask.
  *
- * @throws {Error} If the input phone number does not match the expected format.
- * @throws {Error} If the country code or phone number is missing from the input string.
- * @throws {Error} If the provided country code and prefix combination is invalid.
- * @throws {Error} If the provided country code is invalid.
- * @throws {Error} If the provided country code has a prefix but none is supplied in the input.
+ * @throws {Error} If the phone number is invalid or if no country mask is found for the parsed country.
  *
  * @example
  * ```typescript
- * import { formatToPhone } from "./formatToPhone";
- *
- * const formattedPhone1 = formatToPhone("+55 11912345678");
- * console.log(formattedPhone1); // Output: "(11) 91234-5678" (brazilian phone number format)
- *
- * const formattedPhone2 = formatToPhone("+1-123 4567890");
- * console.log(formattedPhone2); // Output: "(123) 456-7890" (us phone number format)
+ * console.log(formatToPhone("+5534920524282")); // Output: "(34) 92052-4282" (Brazilian format)
+ * console.log(formatToPhone("+553420524282")); // Output: "(34) 2052-4282" (Brazilian format with optional ninth digit)
+ * console.log(formatToPhone("+12125550199")); // Output: "(212) 555-0199" (American Samoa format)
  * ```
  */
-declare const formatToPhone: FormatToPhoneFunction;
+declare function formatToPhone(phoneNumber: string): string;
 export { formatToPhone };
 //# sourceMappingURL=formatToPhone.d.ts.map

package/dist/formats/formatToPhone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToPhone.d.ts","sourceRoot":"","sources":["../../src/formats/formatToPhone.ts"],"names":[],"mappings":"AAaA,KAAK,qBAAqB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAmGtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,QAAA,MAAM,aAAa,EAAE,qBAwBpB,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"formatToPhone.d.ts","sourceRoot":"","sources":["../../src/formats/formatToPhone.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,iBAAS,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA0BlD;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/formats/formatToPhone.js

@@ -1,131 +1,44 @@
-import { countries } from "@arkyn/templates";
-import { removeNonNumeric } from "../services/removeNonNumeric";
-function getMask(value) {
-    const mask = value.length > 10 ? "NINE" : "EIGTH";
-    return mask;
-}
-const TYPES = {
-    EIGTH: "(99) 9999-9999",
-    NINE: "(99) 99999-9999",
-};
-const MAX_LENGTH = removeNonNumeric(TYPES.NINE).length;
-function applyMask(value, maskPattern) {
-    let result = "";
-    let digitIndex = 0;
-    for (let i = 0; i < maskPattern.length; i++) {
-        if (maskPattern[i] === "9") {
-            if (digitIndex < value.length) {
-                result += value[digitIndex];
-                digitIndex++;
-            }
-            else {
-                break;
-            }
-        }
-        else {
-            if (digitIndex < value.length) {
-                result += maskPattern[i];
-            }
-            else {
-                break;
-            }
-        }
-    }
-    return result;
-}
-function formatPhoneNumber(phoneNumber, country) {
-    if (country.code === "+55") {
-        let value = removeNonNumeric(phoneNumber);
-        const mask = getMask(value);
-        let nextLength = value.length;
-        if (nextLength > MAX_LENGTH)
-            return value;
-        value = applyMask(value, TYPES[mask]);
-        return value;
-    }
-    const mask = country.mask;
-    let formattedNumber = mask;
-    if (country.prefix) {
-        const prefixRegex = /\$+/g;
-        formattedNumber = formattedNumber.replace(prefixRegex, country.prefix);
-    }
-    for (let i = 0, j = 0; i < formattedNumber.length && j < phoneNumber.length; i++) {
-        if (formattedNumber[i] === "_") {
-            formattedNumber =
-                formattedNumber.substring(0, i) +
-                    phoneNumber[j] +
-                    formattedNumber.substring(i + 1);
-            j++;
-        }
-    }
-    return formattedNumber;
-}
-function getCountryWithPrefixCode(countryCode, prefix) {
-    const country = countries.find((country) => country.code === countryCode && country.prefix === prefix);
-    if (!country)
-        throw new Error("Invalid country code or prefix");
-    if (country.prefix !== prefix) {
-        throw new Error("Invalid country code or prefix");
-    }
-    if (!country.prefix) {
-        throw new Error("Invalid country code or prefix");
-    }
-    return country;
-}
-function getCountryWithoutPrefixCode(countryCode) {
-    const country = countries.find((country) => country.code === countryCode);
-    if (!country)
-        throw new Error("Invalid country code");
-    if (country.prefix)
-        throw new Error("Invalid country code");
-    return country;
-}
+import { parsePhoneNumberWithError } from "libphonenumber-js";
+import { findCountryMask } from "../utilities/findCountryMask";
 /**
- * Formats a phone number string based on the provided country code and optional prefix.
+ * Formats a phone number string according to the country mask defined in `@arkyn/templates`.
  *
- * The input string should follow the format: `"<countryCode>-<prefix> <phoneNumber>"` or `"<countryCode> <phoneNumber>"`.
- * The function determines the appropriate formatting mask based on the country and applies it to the phone number.
+ * The function parses the input using libphonenumber-js to determine the country and
+ * national number, then applies the corresponding country's mask (underscore `_` used
+ * as digit placeholder) replacing placeholders with actual digits.
  *
- * @param prop - The phone number string to be formatted. It must include the country code and optionally a prefix.
- *               Example formats:
- *               - "+55 32912345678"
- *               - "+1 1234567890"
+ * @param {string} phoneNumber - The input phone number (can include country code or be in national format).
  *
- * @returns The formatted phone number string based on the country's formatting rules.
+ * @returns {string} The phone number formatted following the country's mask.
  *
- * @throws {Error} If the input phone number does not match the expected format.
- * @throws {Error} If the country code or phone number is missing from the input string.
- * @throws {Error} If the provided country code and prefix combination is invalid.
- * @throws {Error} If the provided country code is invalid.
- * @throws {Error} If the provided country code has a prefix but none is supplied in the input.
+ * @throws {Error} If the phone number is invalid or if no country mask is found for the parsed country.
  *
  * @example
  * ```typescript
- * import { formatToPhone } from "./formatToPhone";
- *
- * const formattedPhone1 = formatToPhone("+55 11912345678");
- * console.log(formattedPhone1); // Output: "(11) 91234-5678" (brazilian phone number format)
- *
- * const formattedPhone2 = formatToPhone("+1-123 4567890");
- * console.log(formattedPhone2); // Output: "(123) 456-7890" (us phone number format)
+ * console.log(formatToPhone("+5534920524282")); // Output: "(34) 92052-4282" (Brazilian format)
+ * console.log(formatToPhone("+553420524282")); // Output: "(34) 2052-4282" (Brazilian format with optional ninth digit)
+ * console.log(formatToPhone("+12125550199")); // Output: "(212) 555-0199" (American Samoa format)
  * ```
  */
-const formatToPhone = (prop) => {
-    const phoneRegex = /^\+\d{1,4}(-\d{1,4})? \d+$/;
-    if (!phoneRegex.test(prop)) {
-        throw new Error("Invalid phone number format. Expected format: +<countryCode>-<optionalPrefix> <phoneNumber>");
-    }
-    const countryCode = prop.split(" ")[0].split("-")[0];
-    const prefixCode = prop.split(" ")[0].split("-")[1];
-    const phoneNumber = prop.split(" ")[1];
-    if (!countryCode || !phoneNumber) {
-        throw new Error("Invalid phone number format");
+function formatToPhone(phoneNumber) {
+    try {
+        const parsedPhone = parsePhoneNumberWithError(phoneNumber);
+        const phoneNumberDigits = parsedPhone.nationalNumber.toString();
+        let formattedNumber = findCountryMask(phoneNumber)[0];
+        for (let i = 0, j = 0; i < formattedNumber.length && j < phoneNumberDigits.length; i++) {
+            if (formattedNumber[i] === "_") {
+                formattedNumber =
+                    formattedNumber.substring(0, i) +
+                        phoneNumberDigits[j] +
+                        formattedNumber.substring(i + 1);
+                j++;
+            }
+        }
+        return formattedNumber;
     }
-    if (prefixCode) {
-        const country = getCountryWithPrefixCode(countryCode, prefixCode);
-        return formatPhoneNumber(phoneNumber, country);
+    catch (rawError) {
+        const error = rawError;
+        throw new Error(error.message);
     }
-    const country = getCountryWithoutPrefixCode(countryCode);
-    return formatPhoneNumber(phoneNumber, country);
-};
+}
 export { formatToPhone };

package/dist/generators/generateColorByString.d.ts

@@ -1,15 +1,18 @@
-type GenerateColorByStringFunction = (prop: string) => string;
 /**
  * Generates a hexadecimal color code based on the input string.
  * The function creates a hash from the string and uses it to calculate
  * RGB values, which are then converted to a hexadecimal color code.
  *
- * @param prop - The input string used to generate the color.
- * @returns A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ * @param {string} rawString - The input string used to generate the color.
+ *
+ * @returns {string} A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ *
  * @example
+ * ```typescript
  * const color = generateColorByString("example");
  * console.log(color); // Outputs a consistent hex color like "#5e8f9a"
+ * ```
  */
-declare const generateColorByString: GenerateColorByStringFunction;
+declare function generateColorByString(rawString: string): string;
 export { generateColorByString };
 //# sourceMappingURL=generateColorByString.d.ts.map

package/dist/generators/generateColorByString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateColorByString.d.ts","sourceRoot":"","sources":["../../src/generators/generateColorByString.ts"],"names":[],"mappings":"AAAA,KAAK,6BAA6B,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAE9D;;;;;;;;;;GAUG;AAEH,QAAA,MAAM,qBAAqB,EAAE,6BAgB5B,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"generateColorByString.d.ts","sourceRoot":"","sources":["../../src/generators/generateColorByString.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,iBAAS,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAgBxD;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/generators/generateColorByString.js

@@ -3,16 +3,20 @@
  * The function creates a hash from the string and uses it to calculate
  * RGB values, which are then converted to a hexadecimal color code.
  *
- * @param prop - The input string used to generate the color.
- * @returns A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ * @param {string} rawString - The input string used to generate the color.
+ *
+ * @returns {string} A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ *
  * @example
+ * ```typescript
  * const color = generateColorByString("example");
  * console.log(color); // Outputs a consistent hex color like "#5e8f9a"
+ * ```
  */
-const generateColorByString = (prop) => {
+function generateColorByString(rawString) {
     var hash = 0;
-    for (var i = 0; i < prop.length; i++) {
-        hash = prop.charCodeAt(i) + ((hash << 5) - hash);
+    for (var i = 0; i < rawString.length; i++) {
+        hash = rawString.charCodeAt(i) + ((hash << 5) - hash);
     }
     var red = (hash & 0xff0000) >> 16;
     var green = (hash & 0x00ff00) >> 8;
@@ -21,5 +25,5 @@ const generateColorByString = (prop) => {
     var greenHex = green.toString(16).padStart(2, "0");
     var blueHex = blue.toString(16).padStart(2, "0");
     return "#" + redHex + greenHex + blueHex;
-};
+}
 export { generateColorByString };

package/dist/generators/generateId.d.ts

@@ -1,13 +1,13 @@
 /**
  * Generates a unique identifier (UUID) in the specified format and type.
  *
- * @param type - The desired output type of the UUID. Can be:
+ * @param {"text" | "binary"} type - The desired output type of the UUID. Can be:
  *   - `"text"`: Returns the UUID as a string.
  *   - `"binary"`: Returns the UUID as a `Uint8Array` in binary format.
- * @param format - The version of the UUID to generate. Can be:
+ * @param {"v4" | "v7"} format - The version of the UUID to generate. Can be:
  *   - `"v4"`: Generates a random UUID (version 4).
  *   - `"v7"`: Generates a time-ordered UUID (version 7).
- * @returns The generated UUID in the specified type and format.
+ * @returns {string | Uint8Array} The generated UUID in the specified type and format.
  *   - If `type` is `"text"`, a string representation of the UUID is returned.
  *   - If `type` is `"binary"`, a `Uint8Array` representation of the UUID is returned.
  * @throws {Error} If an invalid `type` or `format` is provided.

package/dist/generators/generateSlug.d.ts

@@ -9,9 +9,16 @@
  * - Collapses multiple consecutive hyphens into a single hyphen.
  * - Trims leading and trailing hyphens.
  *
- * @param string - The input string to be converted into a slug.
- * @returns A URL-friendly slug derived from the input string.
+ * @param {string} rawString - The input string to be converted into a slug.
+ *
+ * @returns {string} A URL-friendly slug derived from the input string.
+ *
+ * @example
+ * ```typescript
+ * const slug = generateSlug("Hello, World! This is a Test.");
+ * console.log(slug); // Outputs: "hello-world-this-is-a-test"
+ * ```
  */
-declare function generateSlug(prop: string): string;
+declare function generateSlug(rawString: string): string;
 export { generateSlug };
 //# sourceMappingURL=generateSlug.d.ts.map

package/dist/generators/generateSlug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateSlug.d.ts","sourceRoot":"","sources":["../../src/generators/generateSlug.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,iBAAS,YAAY,CAAC,IAAI,EAAE,MAAM,UAajC;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"generateSlug.d.ts","sourceRoot":"","sources":["../../src/generators/generateSlug.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,iBAAS,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAa/C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/generators/generateSlug.js

@@ -9,11 +9,18 @@
  * - Collapses multiple consecutive hyphens into a single hyphen.
  * - Trims leading and trailing hyphens.
  *
- * @param string - The input string to be converted into a slug.
- * @returns A URL-friendly slug derived from the input string.
+ * @param {string} rawString - The input string to be converted into a slug.
+ *
+ * @returns {string} A URL-friendly slug derived from the input string.
+ *
+ * @example
+ * ```typescript
+ * const slug = generateSlug("Hello, World! This is a Test.");
+ * console.log(slug); // Outputs: "hello-world-this-is-a-test"
+ * ```
  */
-function generateSlug(prop) {
-    let slug = prop.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+function generateSlug(rawString) {
+    let slug = rawString.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
     slug = slug
         .replace(/[^\w\s-]/g, "")
         .replace(/\s+/g, "-")

package/dist/index.d.ts

@@ -5,27 +5,22 @@ export { formatToCapitalizeFirstWordLetter } from "./formats/formatToCapitalizeF
 export { formatToCep } from "./formats/formatToCep";
 export { formatToCnpj } from "./formats/formatToCnpj";
 export { formatToCpf } from "./formats/formatToCpf";
-export { formatToCpfCnpj } from "./formats/formatToCpfCnpj";
 export { formatToCurrency } from "./formats/formatToCurrency";
-export { formatToDate } from "./formats/formatToDate";
 export { formatToEllipsis } from "./formats/formatToEllipsis";
 export { formatToHiddenDigits } from "./formats/formatToHiddenDigits";
 export { formatToPhone } from "./formats/formatToPhone";
 export { generateColorByString } from "./generators/generateColorByString";
 export { generateId } from "./generators/generateId";
 export { generateSlug } from "./generators/generateSlug";
-export { calculateCardInstallment } from "./services/calculateCardInstallment";
-export { ensureQuotes } from "./services/ensureQuotes";
-export { maskSensitiveData } from "./services/maskSensitiveData";
-export { removeCurrencySymbols } from "./services/removeCurrencySymbols";
-export { removeNonNumeric } from "./services/removeNonNumeric";
-export { stripHtmlTags } from "./services/stripHtmlTags";
-export { truncateLargeFields } from "./services/truncateLargeFields";
-export { validateCep } from "./validations/validateCep";
-export { validateCnpj } from "./validations/validateCnpj";
-export { validateCpf } from "./validations/validateCpf";
-export { validateDate } from "./validations/validateDate";
-export { validatePassword } from "./validations/validatePassword";
-export { validatePhone } from "./validations/validatePhone";
-export { validateRg } from "./validations/validateRg";
+export { parseLargeFields } from "./parsers/parseLargeFields";
+export { parseSensitiveData } from "./parsers/parseSensitiveData";
+export { parseToDate } from "./parsers/parseToDate";
+export { ValidateDateService } from "./services/validateDateService";
+export { calculateCardInstallment } from "./utilities/calculateCardInstallment";
+export { ensureQuotes } from "./utilities/ensureQuotes";
+export { findCountryMask } from "./utilities/findCountryMask";
+export { isHtml } from "./utilities/isHtml";
+export { removeCurrencySymbols } from "./utilities/removeCurrencySymbols";
+export { removeNonNumeric } from "./utilities/removeNonNumeric";
+export { stripHtmlTags } from "./utilities/stripHtmlTags";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,iCAAiC,EAAE,MAAM,6CAA6C,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAGrE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,iCAAiC,EAAE,MAAM,6CAA6C,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAGrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC"}