@arkyn/shared 2.0.1-beta.12 → 2.0.1-beta.14

package/README.md

@@ -0,0 +1,100 @@
+# @arkyn/shared
+
+The `@arkyn/shared` package provides reusable items such as formatting functions, generators, services, and
+validations. It is designed to be used in different parts of a project, providing common and practical solutions.
+
+## Installation
+
+```bash
+npm install @arkyn/shared
+```
+
+### Features
+
+#### Formatting
+
+`formatDate(date: Date): string`
+Formats a date in a readable format.
+
+`formatJsonObject(obj: object): string`
+Converts a JSON object into a formatted string.
+
+`formatJsonString(json: string): object`
+Converts a JSON string into an object.
+
+`formatToCep(value: string): string`
+Formats a string into the CEP format (XXXXX-XXX).
+
+`formatToCnpj(value: string): string`
+Formats a string into the CNPJ format (XX.XXX.XXX/XXXX-XX).
+
+`formatToCpf(value: string): string`
+Formats a string into the CPF format (XXX.XXX.XXX-XX).
+
+`formatToCpfCnpj(value: string): string`
+Formats a string into the CPF or CNPJ format, depending on the size.
+
+`formatToCurrency(value: number): string`
+Converts a number to currency format.
+
+`formatToEllipsis(value: string, maxLength: number): string`
+Truncates a string and adds an ellipsis if it exceeds the maximum length.
+
+`formatToHiddenDigits(value: string): string`
+Hides part of a string, replacing it with asterisks.
+
+`formatToPhone(value: string): string`
+Formats a string to phone number format.
+
+### Generators
+
+`generateColorByString(value: string): string`
+Generates a hexadecimal color from a string.
+
+`generateId(): string`
+Generates a unique identifier.
+
+`generateSlug(value: string): string`
+Generates a URL-friendly slug from a string.
+
+### Services
+
+`calculateCardInstallment(total: number, installments: number): number[]`
+Calculates the installment value of a total.
+
+`maskSensitiveData(data: string): string`
+Hides sensitive data in a string.
+
+`removeNonNumeric(value: string): string`
+Removes non-numeric characters from a string.
+
+`truncateLargeFields(obj: object, maxLength: number): object`
+Truncates large fields in an object.
+
+### Validations
+
+`validateCep(value: string): boolean`
+Validates whether a string is a valid CEP.
+
+`validateCnpj(value: string): boolean`
+Validates whether a string is a valid CNPJ.
+
+`validateCpf(value: string): boolean`
+Validates whether a string is a valid CPF.
+
+`validateDate(value: string): boolean`
+Validates whether a string is a valid date.
+
+`validatePhone(value: string): boolean`
+Validates whether a string is a valid phone number.
+
+`validateRg(value: string): boolean`
+Validates whether a string is a valid ID.
+
+## Contribution
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -12,12 +12,14 @@ export { formatToPhone } from "./formats/formatToPhone";
 export { generateColorByString } from "./generators/generateColorByString";
 export { generateId } from "./generators/generateId";
 export { generateSlug } from "./generators/generateSlug";
-export { regex } from "./regex";
 export { calculateCardInstallment } from "./services/calculateCardInstallment";
 export { maskSensitiveData } from "./services/maskSensitiveData";
 export { removeNonNumeric } from "./services/removeNonNumeric";
 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 { validatePhone } from "./validations/validatePhone";
+export { validateRg } from "./validations/validateRg";
 //# 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":"AAAA,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,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,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAErE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,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,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,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,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,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,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
+// formats
 export { formatDate } from "./formats/formatDate";
 export { formatJsonObject } from "./formats/formatJsonObject";
 export { formatJsonString } from "./formats/formatJsonString";
@@ -9,14 +10,19 @@ export { formatToCurrency } from "./formats/formatToCurrency";
 export { formatToEllipsis } from "./formats/formatToEllipsis";
 export { formatToHiddenDigits } from "./formats/formatToHiddenDigits";
 export { formatToPhone } from "./formats/formatToPhone";
+// generators
 export { generateColorByString } from "./generators/generateColorByString";
 export { generateId } from "./generators/generateId";
 export { generateSlug } from "./generators/generateSlug";
-export { regex } from "./regex";
+// services
 export { calculateCardInstallment } from "./services/calculateCardInstallment";
 export { maskSensitiveData } from "./services/maskSensitiveData";
 export { removeNonNumeric } from "./services/removeNonNumeric";
 export { truncateLargeFields } from "./services/truncateLargeFields";
+// utils
+export { validateCep } from "./validations/validateCep";
+export { validateCnpj } from "./validations/validateCnpj";
 export { validateCpf } from "./validations/validateCpf";
 export { validateDate } from "./validations/validateDate";
 export { validatePhone } from "./validations/validatePhone";
+export { validateRg } from "./validations/validateRg";

package/dist/validations/validateCep.d.ts

@@ -0,0 +1,24 @@
+import type { ValidateCepFunction } from "@arkyn/types";
+/**
+ * Removes all non-digit characters from the CEP.
+ * @param cep - Raw CEP string.
+ * @returns Only numeric characters.
+ */
+/**
+ * Validates a Brazilian CEP (Código de Endereçamento Postal).
+ *
+ * A valid CEP has 8 numeric digits.
+ *
+ * @param rawCep - CEP string, may include formatting (e.g., "12345-678").
+ * @returns `true` if the CEP is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCep("12345-678"); // true
+ * validateCep("12345678");  // true
+ * validateCep("ABCDE-123"); // false
+ * ```
+ */
+declare const validateCep: ValidateCepFunction;
+export { validateCep };
+//# sourceMappingURL=validateCep.d.ts.map

package/dist/validations/validateCep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateCep.d.ts","sourceRoot":"","sources":["../../src/validations/validateCep.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGxD;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AAEH,QAAA,MAAM,WAAW,EAAE,mBAYlB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/validations/validateCep.js

@@ -0,0 +1,33 @@
+import { removeNonNumeric } from "../services/removeNonNumeric";
+/**
+ * Removes all non-digit characters from the CEP.
+ * @param cep - Raw CEP string.
+ * @returns Only numeric characters.
+ */
+/**
+ * Validates a Brazilian CEP (Código de Endereçamento Postal).
+ *
+ * A valid CEP has 8 numeric digits.
+ *
+ * @param rawCep - CEP string, may include formatting (e.g., "12345-678").
+ * @returns `true` if the CEP is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCep("12345-678"); // true
+ * validateCep("12345678");  // true
+ * validateCep("ABCDE-123"); // false
+ * ```
+ */
+const validateCep = (rawCep) => {
+    if (!rawCep)
+        return false;
+    const validFormat = /^[0-9-]+$/.test(rawCep);
+    if (!validFormat)
+        return false;
+    const cep = removeNonNumeric(rawCep);
+    const CEP_LENGTH = 8;
+    const isOnlyDigits = /^\d{8}$/.test(cep);
+    return cep.length === CEP_LENGTH && isOnlyDigits;
+};
+export { validateCep };

package/dist/validations/validateCnpj.d.ts

@@ -0,0 +1,22 @@
+import type { ValidateCnpjFunction } from "@arkyn/types";
+/**
+ * Validates a Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica) number.
+ *
+ * This function performs:
+ * - Sanitization (removes non-digit characters).
+ * - Length check (must be 14 digits).
+ * - Repeating digits check (invalid if all digits are the same).
+ * - Verifies the two check digits with the proper weights.
+ *
+ * @param rawCnpj - CNPJ string, possibly formatted.
+ * @returns `true` if valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCnpj("12.345.678/0001-95"); // false
+ * validateCnpj("11.444.777/0001-61"); // true
+ * ```
+ */
+declare const validateCnpj: ValidateCnpjFunction;
+export { validateCnpj };
+//# sourceMappingURL=validateCnpj.d.ts.map

package/dist/validations/validateCnpj.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateCnpj.d.ts","sourceRoot":"","sources":["../../src/validations/validateCnpj.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AA0BzD;;;;;;;;;;;;;;;;;GAiBG;AAEH,QAAA,MAAM,YAAY,EAAE,oBAgBnB,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/validations/validateCnpj.js

@@ -0,0 +1,52 @@
+import { removeNonNumeric } from "../services/removeNonNumeric";
+function isInvalidLength(cnpj) {
+    const CNPJ_LENGTH = 14;
+    return cnpj.length !== CNPJ_LENGTH;
+}
+function hasAllDigitsEqual(cnpj) {
+    const [firstDigit] = cnpj;
+    return [...cnpj].every((digit) => digit === firstDigit);
+}
+function calculateDigit(cnpj, multipliers) {
+    let total = 0;
+    for (let i = 0; i < multipliers.length; i++) {
+        total += parseInt(cnpj[i]) * multipliers[i];
+    }
+    const rest = total % 11;
+    return rest < 2 ? 0 : 11 - rest;
+}
+function extractDigit(cnpj) {
+    return cnpj.slice(12);
+}
+/**
+ * Validates a Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica) number.
+ *
+ * This function performs:
+ * - Sanitization (removes non-digit characters).
+ * - Length check (must be 14 digits).
+ * - Repeating digits check (invalid if all digits are the same).
+ * - Verifies the two check digits with the proper weights.
+ *
+ * @param rawCnpj - CNPJ string, possibly formatted.
+ * @returns `true` if valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCnpj("12.345.678/0001-95"); // false
+ * validateCnpj("11.444.777/0001-61"); // true
+ * ```
+ */
+const validateCnpj = (rawCnpj) => {
+    if (!rawCnpj)
+        return false;
+    const cnpj = removeNonNumeric(rawCnpj);
+    if (isInvalidLength(cnpj))
+        return false;
+    if (hasAllDigitsEqual(cnpj))
+        return false;
+    const base = cnpj.slice(0, 12);
+    const digit1 = calculateDigit(base, [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]);
+    const digit2 = calculateDigit(base + digit1, [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]);
+    return extractDigit(cnpj) === `${digit1}${digit2}`;
+};
+export { validateCnpj };

package/dist/validations/validateCpf.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateCpf.d.ts","sourceRoot":"","sources":["../../src/validations/validateCpf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AA6BxD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,QAAA,MAAM,WAAW,EAAE,mBAWlB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"validateCpf.d.ts","sourceRoot":"","sources":["../../src/validations/validateCpf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AA0BxD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,QAAA,MAAM,WAAW,EAAE,mBAWlB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/validations/validateCpf.js

@@ -1,6 +1,4 @@
-function removeNonDigits(cpf) {
-    return cpf.replace(/\D/g, "");
-}
+import { removeNonNumeric } from "../services/removeNonNumeric";
 function isInvalidLength(cpf) {
     const CPF_LENGTH = 11;
     return cpf.length !== CPF_LENGTH;
@@ -44,7 +42,7 @@ function extractDigit(cpf) {
 const validateCpf = (rawCpf) => {
     if (!rawCpf)
         return false;
-    const cpf = removeNonDigits(rawCpf);
+    const cpf = removeNonNumeric(rawCpf);
     if (isInvalidLength(cpf))
         return false;
     if (hasAllDigitsEqual(cpf))

package/dist/validations/validateDate.d.ts

@@ -2,7 +2,7 @@ import type { ValidateDateFunction } from "@arkyn/types";
 /**
  * Validates a date string based on the provided format and configuration.
  *
- * @param date - The date string to validate.
+ * @param rawDate - The date string to validate.
  * @param config - Optional configuration object to customize validation.
  * @param config.inputFormat - The expected format of the input date.
  *                            Supported formats are "DD/MM/YYYY", "MM-DD-YYYY", and "YYYY-MM-DD".

package/dist/validations/validateDate.js

@@ -1,7 +1,7 @@
 /**
  * Validates a date string based on the provided format and configuration.
  *
- * @param date - The date string to validate.
+ * @param rawDate - The date string to validate.
  * @param config - Optional configuration object to customize validation.
  * @param config.inputFormat - The expected format of the input date.
  *                            Supported formats are "DD/MM/YYYY", "MM-DD-YYYY", and "YYYY-MM-DD".
@@ -23,28 +23,28 @@
  * validateDate("31/04/2023", { inputFormat: "DD/MM/YYYY" }); // false (April has 30 days)
  * ```
  */
-const validateDate = (date, config) => {
+const validateDate = (rawDate, config) => {
     let day, month, year;
     const inputFormat = config?.inputFormat || "DD/MM/YYYY";
     const minYear = config?.minYear || 1900;
     const maxYear = config?.maxYear || 3000;
     if (inputFormat === "DD/MM/YYYY") {
         const dateRegex = /^(\d{2})\/(\d{2})\/(\d{4})$/;
-        if (!dateRegex.test(date))
+        if (!dateRegex.test(rawDate))
             return false;
-        [, day, month, year] = date.match(dateRegex) || [];
+        [, day, month, year] = rawDate.match(dateRegex) || [];
     }
     else if (inputFormat === "MM-DD-YYYY") {
         const dateRegex = /^(\d{2})-(\d{2})-(\d{4})$/;
-        if (!dateRegex.test(date))
+        if (!dateRegex.test(rawDate))
             return false;
-        [, month, day, year] = date.match(dateRegex) || [];
+        [, month, day, year] = rawDate.match(dateRegex) || [];
     }
     else if (inputFormat === "YYYY-MM-DD") {
         const dateRegex = /^(\d{4})-(\d{2})-(\d{2})$/;
-        if (!dateRegex.test(date))
+        if (!dateRegex.test(rawDate))
             return false;
-        [, year, month, day] = date.match(dateRegex) || [];
+        [, year, month, day] = rawDate.match(dateRegex) || [];
     }
     else {
         throw new Error("Invalid date format");

package/dist/validations/validatePassword.d.ts

@@ -0,0 +1,21 @@
+import type { ValidatePasswordFunction } from "@arkyn/types";
+/**
+ * Validates a password based on the following rules:
+ * - At least 8 characters
+ * - At least 1 uppercase letter
+ * - At least 1 letter (any case)
+ * - At least 1 number
+ * - At least 1 special character
+ *
+ * @param rawPassword - The raw password string.
+ * @returns `true` if password is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validatePassword("Senha@123"); // true
+ * validatePassword("senha123");  // false (no uppercase, no special char)
+ * ```
+ */
+declare const validatePassword: ValidatePasswordFunction;
+export { validatePassword };
+//# sourceMappingURL=validatePassword.d.ts.map

package/dist/validations/validatePassword.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatePassword.d.ts","sourceRoot":"","sources":["../../src/validations/validatePassword.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;;;;;;;;GAgBG;AAEH,QAAA,MAAM,gBAAgB,EAAE,wBAkBvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/validations/validatePassword.js

@@ -0,0 +1,34 @@
+/**
+ * Validates a password based on the following rules:
+ * - At least 8 characters
+ * - At least 1 uppercase letter
+ * - At least 1 letter (any case)
+ * - At least 1 number
+ * - At least 1 special character
+ *
+ * @param rawPassword - The raw password string.
+ * @returns `true` if password is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validatePassword("Senha@123"); // true
+ * validatePassword("senha123");  // false (no uppercase, no special char)
+ * ```
+ */
+const validatePassword = (rawPassword) => {
+    if (!rawPassword)
+        return false;
+    const hasMinLength = rawPassword.length >= 8;
+    const hasUppercase = /[A-Z]/.test(rawPassword);
+    const hasLetter = /[a-z]/.test(rawPassword);
+    const hasNumber = /\d/.test(rawPassword);
+    const hasSpecialChar = /[!@#$%^&*(),.?":{}|<>_\-+=~`[\]\\\/]/.test(rawPassword);
+    return [
+        hasMinLength,
+        hasUppercase,
+        hasLetter,
+        hasNumber,
+        hasSpecialChar,
+    ].every((condition) => condition);
+};
+export { validatePassword };

package/dist/validations/validatePhone.d.ts

@@ -10,7 +10,7 @@ import type { ValidatePhoneFunction } from "@arkyn/types";
  * Special handling is applied for Brazilian phone numbers (ISO code "BR"), which
  * allows for an optional ninth digit.
  *
- * @param phone - The phone number to validate as a string.
+ * @param rawPhone - The phone number to validate as a string.
  * @returns `true` if the phone number matches any country's format, otherwise `false`.
  *
  * @example

package/dist/validations/validatePhone.js

@@ -10,7 +10,7 @@ import { countries } from "@arkyn/templates";
  * Special handling is applied for Brazilian phone numbers (ISO code "BR"), which
  * allows for an optional ninth digit.
  *
- * @param phone - The phone number to validate as a string.
+ * @param rawPhone - The phone number to validate as a string.
  * @returns `true` if the phone number matches any country's format, otherwise `false`.
  *
  * @example
@@ -24,19 +24,19 @@ import { countries } from "@arkyn/templates";
  * validatePhone("+55 1234567890"); // false for an invalid Brazilian phone number
  * ```
  */
-const validatePhone = (phone) => {
+const validatePhone = (rawPhone) => {
     for (const country of countries) {
         const countryCode = country.code;
         const prefix = country.prefix ? `-${country.prefix}` : "";
         const digitCount = country.mask.replace(/[^_]/g, "").length;
         if (country.iso === "BR") {
             const brazilRegex = new RegExp(`^\\${countryCode} \\d{2}9?\\d{8}$`);
-            if (brazilRegex.test(phone))
+            if (brazilRegex.test(rawPhone))
                 return true;
             continue;
         }
         const regex = new RegExp(`^\\${countryCode}${prefix} \\d{${digitCount}}$`);
-        if (regex.test(phone))
+        if (regex.test(rawPhone))
             return true;
     }
     return false;

package/dist/validations/validateRg.d.ts

@@ -0,0 +1,22 @@
+import type { ValidateRgFunction } from "@arkyn/types";
+/**
+ * Validates a Brazilian RG (Registro Geral) in a generic way.
+ *
+ * This function does a basic structure validation:
+ * - Removes non-alphanumeric characters.
+ * - Ensures length is reasonable (7–9 digits).
+ * - Optionally allows for a final letter (verifier).
+ *
+ * @param rawRg - RG string, possibly formatted.
+ * @returns `true` if format seems valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateRg("12.345.678-9"); // true
+ * validateRg("MG-12.345.678"); // false (not supported)
+ * validateRg("12345678X"); // true
+ * ```
+ */
+declare const validateRg: ValidateRgFunction;
+export { validateRg };
+//# sourceMappingURL=validateRg.d.ts.map

package/dist/validations/validateRg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateRg.d.ts","sourceRoot":"","sources":["../../src/validations/validateRg.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;;;;;;;;;;;;;;GAiBG;AAEH,QAAA,MAAM,UAAU,EAAE,kBAajB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/validations/validateRg.js

@@ -0,0 +1,31 @@
+/**
+ * Validates a Brazilian RG (Registro Geral) in a generic way.
+ *
+ * This function does a basic structure validation:
+ * - Removes non-alphanumeric characters.
+ * - Ensures length is reasonable (7–9 digits).
+ * - Optionally allows for a final letter (verifier).
+ *
+ * @param rawRg - RG string, possibly formatted.
+ * @returns `true` if format seems valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateRg("12.345.678-9"); // true
+ * validateRg("MG-12.345.678"); // false (not supported)
+ * validateRg("12345678X"); // true
+ * ```
+ */
+const validateRg = (rawRg) => {
+    if (!rawRg)
+        return false;
+    const validFormat = /^[0-9a-zA-Z.-]+$/.test(rawRg);
+    if (!validFormat)
+        return false;
+    const rg = rawRg.replace(/[^a-zA-Z0-9]/g, "");
+    if (rg.length < 7 || rg.length > 9)
+        return false;
+    const isValidFormat = /^[0-9]{7,8}[0-9Xx]?$/.test(rg);
+    return isValidFormat;
+};
+export { validateRg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/shared",
-  "version": "2.0.1-beta.12",
+  "version": "2.0.1-beta.14",
   "main": "./dist/bundle.js",
   "module": "./src/index.ts",
   "type": "module",

package/src/index.ts

@@ -1,3 +1,4 @@
+// formats
 export { formatDate } from "./formats/formatDate";
 export { formatJsonObject } from "./formats/formatJsonObject";
 export { formatJsonString } from "./formats/formatJsonString";
@@ -10,17 +11,21 @@ export { formatToEllipsis } from "./formats/formatToEllipsis";
 export { formatToHiddenDigits } from "./formats/formatToHiddenDigits";
 export { formatToPhone } from "./formats/formatToPhone";
 
+// generators
 export { generateColorByString } from "./generators/generateColorByString";
 export { generateId } from "./generators/generateId";
 export { generateSlug } from "./generators/generateSlug";
 
-export { regex } from "./regex";
-
+// services
 export { calculateCardInstallment } from "./services/calculateCardInstallment";
 export { maskSensitiveData } from "./services/maskSensitiveData";
 export { removeNonNumeric } from "./services/removeNonNumeric";
 export { truncateLargeFields } from "./services/truncateLargeFields";
 
+// utils
+export { validateCep } from "./validations/validateCep";
+export { validateCnpj } from "./validations/validateCnpj";
 export { validateCpf } from "./validations/validateCpf";
 export { validateDate } from "./validations/validateDate";
 export { validatePhone } from "./validations/validatePhone";
+export { validateRg } from "./validations/validateRg";

package/src/validations/validateCep.ts

@@ -0,0 +1,40 @@
+import type { ValidateCepFunction } from "@arkyn/types";
+import { removeNonNumeric } from "../services/removeNonNumeric";
+
+/**
+ * Removes all non-digit characters from the CEP.
+ * @param cep - Raw CEP string.
+ * @returns Only numeric characters.
+ */
+
+/**
+ * Validates a Brazilian CEP (Código de Endereçamento Postal).
+ *
+ * A valid CEP has 8 numeric digits.
+ *
+ * @param rawCep - CEP string, may include formatting (e.g., "12345-678").
+ * @returns `true` if the CEP is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCep("12345-678"); // true
+ * validateCep("12345678");  // true
+ * validateCep("ABCDE-123"); // false
+ * ```
+ */
+
+const validateCep: ValidateCepFunction = (rawCep) => {
+  if (!rawCep) return false;
+
+  const validFormat = /^[0-9-]+$/.test(rawCep);
+  if (!validFormat) return false;
+
+  const cep = removeNonNumeric(rawCep);
+
+  const CEP_LENGTH = 8;
+  const isOnlyDigits = /^\d{8}$/.test(cep);
+
+  return cep.length === CEP_LENGTH && isOnlyDigits;
+};
+
+export { validateCep };

package/src/validations/validateCnpj.ts

@@ -0,0 +1,64 @@
+import type { ValidateCnpjFunction } from "@arkyn/types";
+import { removeNonNumeric } from "../services/removeNonNumeric";
+
+function isInvalidLength(cnpj: string) {
+  const CNPJ_LENGTH = 14;
+  return cnpj.length !== CNPJ_LENGTH;
+}
+
+function hasAllDigitsEqual(cnpj: string) {
+  const [firstDigit] = cnpj;
+  return [...cnpj].every((digit) => digit === firstDigit);
+}
+
+function calculateDigit(cnpj: string, multipliers: number[]) {
+  let total = 0;
+  for (let i = 0; i < multipliers.length; i++) {
+    total += parseInt(cnpj[i]) * multipliers[i];
+  }
+  const rest = total % 11;
+  return rest < 2 ? 0 : 11 - rest;
+}
+
+function extractDigit(cnpj: string) {
+  return cnpj.slice(12);
+}
+
+/**
+ * Validates a Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica) number.
+ *
+ * This function performs:
+ * - Sanitization (removes non-digit characters).
+ * - Length check (must be 14 digits).
+ * - Repeating digits check (invalid if all digits are the same).
+ * - Verifies the two check digits with the proper weights.
+ *
+ * @param rawCnpj - CNPJ string, possibly formatted.
+ * @returns `true` if valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateCnpj("12.345.678/0001-95"); // false
+ * validateCnpj("11.444.777/0001-61"); // true
+ * ```
+ */
+
+const validateCnpj: ValidateCnpjFunction = (rawCnpj) => {
+  if (!rawCnpj) return false;
+
+  const cnpj = removeNonNumeric(rawCnpj);
+
+  if (isInvalidLength(cnpj)) return false;
+  if (hasAllDigitsEqual(cnpj)) return false;
+
+  const base = cnpj.slice(0, 12);
+  const digit1 = calculateDigit(base, [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]);
+  const digit2 = calculateDigit(
+    base + digit1,
+    [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
+  );
+
+  return extractDigit(cnpj) === `${digit1}${digit2}`;
+};
+
+export { validateCnpj };

package/src/validations/validateCpf.ts

@@ -1,8 +1,5 @@
 import type { ValidateCpfFunction } from "@arkyn/types";
-
-function removeNonDigits(cpf: string) {
-  return cpf.replace(/\D/g, "");
-}
+import { removeNonNumeric } from "../services/removeNonNumeric";
 
 function isInvalidLength(cpf: string) {
   const CPF_LENGTH = 11;
@@ -50,7 +47,7 @@ function extractDigit(cpf: string) {
 
 const validateCpf: ValidateCpfFunction = (rawCpf) => {
   if (!rawCpf) return false;
-  const cpf = removeNonDigits(rawCpf);
+  const cpf = removeNonNumeric(rawCpf);
 
   if (isInvalidLength(cpf)) return false;
   if (hasAllDigitsEqual(cpf)) return false;

package/src/validations/validateDate.ts

@@ -3,7 +3,7 @@ import type { ValidateDateFunction } from "@arkyn/types";
 /**
  * Validates a date string based on the provided format and configuration.
  *
- * @param date - The date string to validate.
+ * @param rawDate - The date string to validate.
  * @param config - Optional configuration object to customize validation.
  * @param config.inputFormat - The expected format of the input date.
  *                            Supported formats are "DD/MM/YYYY", "MM-DD-YYYY", and "YYYY-MM-DD".
@@ -26,7 +26,7 @@ import type { ValidateDateFunction } from "@arkyn/types";
  * ```
  */
 
-const validateDate: ValidateDateFunction = (date, config) => {
+const validateDate: ValidateDateFunction = (rawDate, config) => {
   let day: string, month: string, year: string;
 
   const inputFormat = config?.inputFormat || "DD/MM/YYYY";
@@ -35,16 +35,16 @@ const validateDate: ValidateDateFunction = (date, config) => {
 
   if (inputFormat === "DD/MM/YYYY") {
     const dateRegex = /^(\d{2})\/(\d{2})\/(\d{4})$/;
-    if (!dateRegex.test(date)) return false;
-    [, day, month, year] = date.match(dateRegex) || [];
+    if (!dateRegex.test(rawDate)) return false;
+    [, day, month, year] = rawDate.match(dateRegex) || [];
   } else if (inputFormat === "MM-DD-YYYY") {
     const dateRegex = /^(\d{2})-(\d{2})-(\d{4})$/;
-    if (!dateRegex.test(date)) return false;
-    [, month, day, year] = date.match(dateRegex) || [];
+    if (!dateRegex.test(rawDate)) return false;
+    [, month, day, year] = rawDate.match(dateRegex) || [];
   } else if (inputFormat === "YYYY-MM-DD") {
     const dateRegex = /^(\d{4})-(\d{2})-(\d{2})$/;
-    if (!dateRegex.test(date)) return false;
-    [, year, month, day] = date.match(dateRegex) || [];
+    if (!dateRegex.test(rawDate)) return false;
+    [, year, month, day] = rawDate.match(dateRegex) || [];
   } else {
     throw new Error("Invalid date format");
   }

package/src/validations/validatePassword.ts

@@ -0,0 +1,41 @@
+import type { ValidatePasswordFunction } from "@arkyn/types";
+
+/**
+ * Validates a password based on the following rules:
+ * - At least 8 characters
+ * - At least 1 uppercase letter
+ * - At least 1 letter (any case)
+ * - At least 1 number
+ * - At least 1 special character
+ *
+ * @param rawPassword - The raw password string.
+ * @returns `true` if password is valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validatePassword("Senha@123"); // true
+ * validatePassword("senha123");  // false (no uppercase, no special char)
+ * ```
+ */
+
+const validatePassword: ValidatePasswordFunction = (rawPassword) => {
+  if (!rawPassword) return false;
+
+  const hasMinLength = rawPassword.length >= 8;
+  const hasUppercase = /[A-Z]/.test(rawPassword);
+  const hasLetter = /[a-z]/.test(rawPassword);
+  const hasNumber = /\d/.test(rawPassword);
+  const hasSpecialChar = /[!@#$%^&*(),.?":{}|<>_\-+=~`[\]\\\/]/.test(
+    rawPassword
+  );
+
+  return [
+    hasMinLength,
+    hasUppercase,
+    hasLetter,
+    hasNumber,
+    hasSpecialChar,
+  ].every((condition) => condition);
+};
+
+export { validatePassword };

package/src/validations/validatePhone.ts

@@ -12,7 +12,7 @@ import type { ValidatePhoneFunction } from "@arkyn/types";
  * Special handling is applied for Brazilian phone numbers (ISO code "BR"), which
  * allows for an optional ninth digit.
  *
- * @param phone - The phone number to validate as a string.
+ * @param rawPhone - The phone number to validate as a string.
  * @returns `true` if the phone number matches any country's format, otherwise `false`.
  *
  * @example
@@ -27,7 +27,7 @@ import type { ValidatePhoneFunction } from "@arkyn/types";
  * ```
  */
 
-const validatePhone: ValidatePhoneFunction = (phone) => {
+const validatePhone: ValidatePhoneFunction = (rawPhone) => {
   for (const country of countries) {
     const countryCode = country.code;
     const prefix = country.prefix ? `-${country.prefix}` : "";
@@ -35,12 +35,12 @@ const validatePhone: ValidatePhoneFunction = (phone) => {
 
     if (country.iso === "BR") {
       const brazilRegex = new RegExp(`^\\${countryCode} \\d{2}9?\\d{8}$`);
-      if (brazilRegex.test(phone)) return true;
+      if (brazilRegex.test(rawPhone)) return true;
       continue;
     }
 
     const regex = new RegExp(`^\\${countryCode}${prefix} \\d{${digitCount}}$`);
-    if (regex.test(phone)) return true;
+    if (regex.test(rawPhone)) return true;
   }
 
   return false;

package/src/validations/validateRg.ts

@@ -0,0 +1,37 @@
+import type { ValidateRgFunction } from "@arkyn/types";
+
+/**
+ * Validates a Brazilian RG (Registro Geral) in a generic way.
+ *
+ * This function does a basic structure validation:
+ * - Removes non-alphanumeric characters.
+ * - Ensures length is reasonable (7–9 digits).
+ * - Optionally allows for a final letter (verifier).
+ *
+ * @param rawRg - RG string, possibly formatted.
+ * @returns `true` if format seems valid, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * validateRg("12.345.678-9"); // true
+ * validateRg("MG-12.345.678"); // false (not supported)
+ * validateRg("12345678X"); // true
+ * ```
+ */
+
+const validateRg: ValidateRgFunction = (rawRg) => {
+  if (!rawRg) return false;
+
+  const validFormat = /^[0-9a-zA-Z.-]+$/.test(rawRg);
+  if (!validFormat) return false;
+
+  const rg = rawRg.replace(/[^a-zA-Z0-9]/g, "");
+
+  if (rg.length < 7 || rg.length > 9) return false;
+
+  const isValidFormat = /^[0-9]{7,8}[0-9Xx]?$/.test(rg);
+
+  return isValidFormat;
+};
+
+export { validateRg };

package/dist/regex/index.d.ts

@@ -1,6 +0,0 @@
-declare const regex: {
-    RG: RegExp;
-    PASSWORD: RegExp;
-};
-export { regex };
-//# sourceMappingURL=index.d.ts.map

package/dist/regex/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/regex/index.ts"],"names":[],"mappings":"AAKA,QAAA,MAAM,KAAK;;;CAAmB,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/regex/index.js

@@ -1,4 +0,0 @@
-const RG = /(^\d{1,2}).?(\d{3}).?(\d{3})-?(\d{1}|X|x$)/;
-const PASSWORD = /(?=^.{8,}$)((?=.*\w)(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[|!"$%&\/\(\)\?\^\'\\\+\-\*]))^.*/;
-const regex = { RG, PASSWORD };
-export { regex };

package/src/regex/index.ts

@@ -1,8 +0,0 @@
-const RG = /(^\d{1,2}).?(\d{3}).?(\d{3})-?(\d{1}|X|x$)/;
-
-const PASSWORD =
-  /(?=^.{8,}$)((?=.*\w)(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[|!"$%&\/\(\)\?\^\'\\\+\-\*]))^.*/;
-
-const regex = { RG, PASSWORD };
-
-export { regex };