@arkyn/shared 1.9.1 → 1.9.5

package/src/validations/__test__/validatePassword.spec.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it } from "vitest";
+import { validatePassword } from "../validatePassword";
+
+describe("validatePassword", () => {
+  it("should return true for a valid password", () => {
+    const validPassword = "StrongP@ssw0rd!";
+    expect(validatePassword(validPassword)).toBe(true);
+  });
+
+  it("should return false for a password shorter than the minimum length", () => {
+    const shortPassword = "Short1!";
+    expect(validatePassword(shortPassword)).toBe(false);
+  });
+
+  it("should return false for a password without an uppercase letter", () => {
+    const noUppercase = "weakp@ssw0rd!";
+    expect(validatePassword(noUppercase)).toBe(false);
+  });
+
+  it("should return false for a password without a lowercase letter", () => {
+    const noLowercase = "WEAKP@SSW0RD!";
+    expect(validatePassword(noLowercase)).toBe(false);
+  });
+
+  it("should return false for a password without a number", () => {
+    const noNumber = "NoNumber@!";
+    expect(validatePassword(noNumber)).toBe(false);
+  });
+
+  it("should return false for a password without a special character", () => {
+    const noSpecialChar = "NoSpecialChar1";
+    expect(validatePassword(noSpecialChar)).toBe(false);
+  });
+
+  it("should return false for an empty password", () => {
+    expect(validatePassword("")).toBe(false);
+  });
+
+  it("should return false for a null or undefined password", () => {
+    expect(validatePassword(null as unknown as string)).toBe(false);
+    expect(validatePassword(undefined as unknown as string)).toBe(false);
+  });
+});

package/src/validations/__test__/validatePhone.spec.ts

@@ -0,0 +1,39 @@
+import { describe, it, expect } from "vitest";
+import { validatePhone } from "../validatePhone";
+
+describe("validatePhone", () => {
+  it("should return true for valid Brazilian phone numbers", () => {
+    expect(validatePhone("+55 32912345678")).toBe(true); // Valid with 9th digit
+    expect(validatePhone("+55 3212345678")).toBe(true); // Valid without 9th digit
+  });
+
+  it("should return false for invalid Brazilian phone numbers", () => {
+    expect(validatePhone("+5532912345678")).toBe(false); // Missing space
+    expect(validatePhone("+55 123456789")).toBe(false); // Invalid format
+  });
+
+  it("should return true for valid American Samoa phone numbers", () => {
+    expect(validatePhone("+1-684 1234567")).toBe(true); // Valid format
+  });
+
+  it("should return false for invalid phone numbers", () => {
+    expect(validatePhone("+1-684 12345")).toBe(false); // Too few digits
+    expect(validatePhone("+99 1234567890")).toBe(false); // Non-existent country code
+  });
+
+  it("should return true for valid phone numbers from other countries", () => {
+    expect(validatePhone("+44 1234567890")).toBe(true); // Example for UK
+    expect(validatePhone("+91 9876543210")).toBe(true); // Example for India
+  });
+
+  it("should return false for phone numbers with incorrect prefixes", () => {
+    expect(validatePhone("+44-20 12345678")).toBe(false); // Invalid prefix for UK
+    expect(validatePhone("+91-80 12345678")).toBe(false); // Invalid prefix for India
+  });
+
+  it("should handle edge cases gracefully", () => {
+    expect(validatePhone("")).toBe(false); // Empty string
+    expect(validatePhone("+55")).toBe(false); // Only country code
+    expect(validatePhone("+55 329123456789")).toBe(false); // Too many digits
+  });
+});

package/src/validations/__test__/validateRg.spec.ts

@@ -0,0 +1,48 @@
+import { describe, expect, it } from "vitest";
+import { validateRg } from "../validateRg";
+
+describe("validateRg", () => {
+  it("should return true for a valid RG with formatting", () => {
+    const validRg = "12.345.678-9";
+    expect(validateRg(validRg)).toBe(true);
+  });
+
+  it("should return true for a valid RG without formatting", () => {
+    const validRg = "123456789";
+    expect(validateRg(validRg)).toBe(true);
+  });
+
+  it("should return true for a valid RG with a verifier letter", () => {
+    const validRg = "12345678X";
+    expect(validateRg(validRg)).toBe(true);
+  });
+
+  it("should return false for an RG with invalid length (too short)", () => {
+    const invalidRg = "123456";
+    expect(validateRg(invalidRg)).toBe(false);
+  });
+
+  it("should return false for an RG with invalid length (too long)", () => {
+    const invalidRg = "1234567890";
+    expect(validateRg(invalidRg)).toBe(false);
+  });
+
+  it("should return false for an RG with special characters", () => {
+    const invalidRg = "12.345.678@9";
+    expect(validateRg(invalidRg)).toBe(false);
+  });
+
+  it("should return false for an RG with letters in the middle", () => {
+    const invalidRg = "12345A678";
+    expect(validateRg(invalidRg)).toBe(false);
+  });
+
+  it("should return false for an empty RG", () => {
+    expect(validateRg("")).toBe(false);
+  });
+
+  it("should return false for a null or undefined RG", () => {
+    expect(validateRg(null as unknown as string)).toBe(false);
+    expect(validateRg(undefined as unknown as string)).toBe(false);
+  });
+});

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/tsconfig.json

@@ -16,5 +16,5 @@
     "verbatimModuleSyntax": true
   },
   "exclude": ["dist", "node_modules", "**/__test__"],
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts", "src/**/*.ts"]
 }

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 };