Merge pull request #469 from vicentevendramin/feat/adds-tools-for-handling-brazilian-passports

feat: adds tools for handling brazilian passports

Author: hyanmandian

docs/pt-br/utilities.md

@@ -503,3 +503,47 @@ getHolidays(2024);
 getHolidays({ year: 2024, stateCode: 'SP' });
 // Inclui feriados nacionais mais feriados estaduais (ex: "Revolução Constitucionalista")
 ```
+
+## isValidPassport
+
+Verifica se um número de passaporte brasileiro é válido (2 letras maiúsculas seguidas de 6 dígitos).
+
+```javascript
+import { isValidPassport } from '@brazilian-utils/brazilian-utils';
+
+isValidPassport('AB123456'); // true
+isValidPassport('Ab123456'); // false
+isValidPassport('12345678'); // false
+```
+
+## formatPassport
+
+Formata um número de passaporte brasileiro (maiúsculas, sem símbolos).
+
+```javascript
+import { formatPassport } from '@brazilian-utils/brazilian-utils';
+
+formatPassport('ab123456'); // 'AB123456'
+formatPassport('AB-123.456'); // 'AB123456'
+```
+
+## generatePassport
+
+Gera um número de passaporte brasileiro válido aleatoriamente.
+
+```javascript
+import { generatePassport } from '@brazilian-utils/brazilian-utils';
+
+generatePassport(); // 'RY393097'
+```
+
+## parsePassport
+
+Remove símbolos ('-', '.' e espaços) de um número de passaporte.
+
+```javascript
+import { parsePassport } from '@brazilian-utils/brazilian-utils';
+
+parsePassport('AB-123.456'); // 'AB123456'
+parsePassport(' AB 123 456 '); // 'AB123456'
+```

docs/utilities.md

@@ -503,3 +503,47 @@ getHolidays(2024);
 getHolidays({ year: 2024, stateCode: 'SP' });
 // Includes national holidays plus state-specific holidays (e.g., "Revolução Constitucionalista")
 ```
+
+## isValidPassport
+
+Check if a Brazilian passport number is valid (2 uppercase letters followed by 6 digits).
+
+```javascript
+import { isValidPassport } from '@brazilian-utils/brazilian-utils';
+
+isValidPassport('AB123456'); // true
+isValidPassport('Ab123456'); // false
+isValidPassport('12345678'); // false
+```
+
+## formatPassport
+
+Format a Brazilian passport number (uppercase, without symbols).
+
+```javascript
+import { formatPassport } from '@brazilian-utils/brazilian-utils';
+
+formatPassport('ab123456'); // 'AB123456'
+formatPassport('AB-123.456'); // 'AB123456'
+```
+
+## generatePassport
+
+Generate a random valid Brazilian passport number.
+
+```javascript
+import { generatePassport } from '@brazilian-utils/brazilian-utils';
+
+generatePassport(); // 'RY393097'
+```
+
+## parsePassport
+
+Remove symbols ('-', '.', and whitespaces) from a passport number.
+
+```javascript
+import { parsePassport } from '@brazilian-utils/brazilian-utils';
+
+parsePassport('AB-123.456'); // 'AB123456'
+parsePassport(' AB 123 456 '); // 'AB123456'
+```

src/format-passport/format-passport.test.ts

@@ -0,0 +1,14 @@
+import { describe, expect, test } from "../_internals/test/runtime";
+import { formatPassport } from "./format-passport";
+
+describe("formatPassport", () => {
+	describe("should return the formatted passport", () => {
+		test("when passport is valid", () => {
+			expect(formatPassport("AB123456")).toBe("AB123456");
+		});
+
+		test("when passport has lowercase letters", () => {
+			expect(formatPassport("acd12736")).toBe("ACD12736");
+		});
+	});
+});

src/format-passport/format-passport.ts

@@ -0,0 +1,16 @@
+/**
+ * Formats a Brazilian passport number for display.
+ * Converts to uppercase and removes all non-alphanumeric characters.
+ *
+ * @param passport - A Brazilian passport number (any case, possibly with symbols).
+ * @returns The formatted passport number (uppercase, no symbols), or an empty string if invalid.
+ *
+ * @example
+ * formatPassport("ab123456") // "AB123456"
+ * formatPassport("AB-123.456") // "AB123456"
+ * formatPassport("") // ""
+ */
+export const formatPassport = (passport: string): string => {
+	if (!passport || typeof passport !== "string") return "";
+	return passport.toUpperCase().replace(/[^A-Z0-9]/g, "");
+};

src/generate-passport/constants.ts

@@ -0,0 +1,4 @@
+export const LETTERS_LENGTH = 2;
+export const DIGITS_LENGTH = 6;
+export const ALPHABET_LENGTH = 26;
+export const CHAR_CODE_A = 65;

src/generate-passport/generate-passport.test.ts

@@ -0,0 +1,11 @@
+import { describe, expect, test } from "../_internals/test/runtime";
+import { isValidPassport } from "../is-valid-passport/is-valid-passport";
+import { generatePassport } from "./generate-passport";
+
+describe("generatePassport", () => {
+	test("should always generate a valid passport", () => {
+		for (let i = 0; i < 100; i++) {
+			expect(isValidPassport(generatePassport())).toBe(true);
+		}
+	});
+});

src/generate-passport/generate-passport.ts

@@ -0,0 +1,21 @@
+import { generateRandomNumber } from "../_internals/generate-random-number/generate-random-number";
+import { ALPHABET_LENGTH, CHAR_CODE_A, DIGITS_LENGTH, LETTERS_LENGTH } from "./constants";
+
+/**
+ * Generates a random valid Brazilian passport number.
+ *
+ * @returns A random valid passport number string (e.g. "RY393097").
+ *
+ * @example
+ * generatePassport() // "RY393097"
+ * generatePassport() // "ZS840088"
+ */
+export const generatePassport = (): string => {
+	const letters = Array.from({ length: LETTERS_LENGTH }, () =>
+		String.fromCharCode(CHAR_CODE_A + Math.floor(Math.random() * ALPHABET_LENGTH)),
+	).join("");
+
+	const digits = generateRandomNumber(DIGITS_LENGTH);
+
+	return `${letters}${digits}`;
+};

src/index.test.ts

@@ -27,6 +27,10 @@ const PUBLIC = [
 	"parseCpf",
 	"parseCurrency",
 	"parsePhone",
+	"isValidPassport",
+	"generatePassport",
+	"parsePassport",
+	"formatPassport",
 	"formatPis",
 	"parsePis",
 	"parseProcessoJuridico",

src/index.ts

@@ -4,6 +4,7 @@ export { type FormatCepOptions, formatCep } from "./format-cep/format-cep";
 export { type FormatCnpjOptions, formatCnpj } from "./format-cnpj/format-cnpj";
 export { type FormatCpfOptions, formatCpf } from "./format-cpf/format-cpf";
 export { type FormatCurrencyOptions, formatCurrency } from "./format-currency/format-currency";
+export { formatPassport } from "./format-passport/format-passport";
 export { type FormatPhoneOptions, formatPhone } from "./format-phone/format-phone";
 export { type FormatPisOptions, formatPis } from "./format-pis/format-pis";
 export {
@@ -13,6 +14,7 @@ export {
 export { generateBoleto } from "./generate-boleto/generate-boleto";
 export { generateCnpj } from "./generate-cnpj/generate-cnpj";
 export { generateCpf } from "./generate-cpf/generate-cpf";
+export { generatePassport } from "./generate-passport/generate-passport";
 export {
 	GetAddressInfoByCepError,
 	GetAddressInfoByCepNotFoundError,
@@ -41,6 +43,7 @@ export {
 	type IsValidMobilePhoneOptions,
 	isValidMobilePhone,
 } from "./is-valid-mobile-phone/is-valid-mobile-phone";
+export { isValidPassport } from "./is-valid-passport/is-valid-passport";
 export { type IsValidPhoneOptions, isValidPhone } from "./is-valid-phone/is-valid-phone";
 export { isValidPis } from "./is-valid-pis/is-valid-pis";
 export { isValidProcessoJuridico } from "./is-valid-processo-juridico/is-valid-processo-juridico";
@@ -50,6 +53,7 @@ export { parseCep } from "./parse-cep/parse-cep";
 export { parseCnpj } from "./parse-cnpj/parse-cnpj";
 export { parseCpf } from "./parse-cpf/parse-cpf";
 export { parseCurrency } from "./parse-currency/parse-currency";
+export { parsePassport } from "./parse-passport/parse-passport";
 export { parsePhone } from "./parse-phone/parse-phone";
 export { parsePis } from "./parse-pis/parse-pis";
 export { parseProcessoJuridico } from "./parse-processo-juridico/parse-processo-juridico";

src/is-valid-passport/constants.ts

@@ -0,0 +1 @@
+export const PASSPORT_REGEX = /^[A-Z]{2}[0-9]{6}$/;