Merge branch 'main' into feat/adds-tools-for-handling-brazilian-passports

Author: vicentevendramin

docs/pt-br/utilities.md

@@ -23,6 +23,16 @@ formatCpf('74650688000'); // 746.506.880-00
 formatCpf('746506880', { pad: true }); // 007.465.068-80
 ```
 
+## parseCpf
+
+Remove a formatação do CPF e retorna apenas os dígitos.
+
+```javascript
+import { parseCpf } from '@brazilian-utils/brazilian-utils';
+
+parseCpf('746.506.880-00'); // 74650688000
+```
+
 ## generateCpf
 
 Gera um CPF válido aleatório.
@@ -55,6 +65,17 @@ formatCnpj('245222000174', { pad: true }); // 00.245.222/0001-74
 formatCnpj('12OUT345000199', { version: 2 }); // 12.OUT.345/0001-99
 ```
 
+## parseCnpj
+
+Remove a formatação do CNPJ e retorna um valor normalizado.
+
+```javascript
+import { parseCnpj } from '@brazilian-utils/brazilian-utils';
+
+parseCnpj('24.522.200/0001-74'); // 24522200000174
+parseCnpj('12.OUT.345/0001-99', { version: 2 }); // 12OUT345000199
+```
+
 ## generateCnpj
 
 Gera um CNPJ válido aleatório.
@@ -96,6 +117,16 @@ formatBoleto('00190000090114971860168524522114675860000102656'); // 00190.00009
 formatBoleto('1900000901149', { pad: true }); // 00000.00000 00000.000019 00000.901149 0 00000000000000
 ```
 
+## parseBoleto
+
+Remove a formatação do boleto e retorna apenas os dígitos.
+
+```javascript
+import { parseBoleto } from '@brazilian-utils/brazilian-utils';
+
+parseBoleto('00190.00009 01149.718601 68524.522114 6 75860000102656'); // 00190000090114971860168524522114675860000102656
+```
+
 ## generateBoleto
 
 Gera um boleto válido aleatório.
@@ -149,6 +180,16 @@ formatPhone('11900000000', { mask: 'nanp' }); // (11) 90000-0000
 formatPhone('11900000000', { mask: 'auto' }); // Detecta automaticamente a máscara baseado no comprimento
 ```
 
+## parsePhone
+
+Remove a formatação do telefone e retorna apenas os dígitos.
+
+```javascript
+import { parsePhone } from '@brazilian-utils/brazilian-utils';
+
+parsePhone('(11) 90000-0000'); // 11900000000
+```
+
 ## isValidMobilePhone
 
 Valida se o número de telefone celular é válido.
@@ -215,6 +256,16 @@ formatPis('12345678901'); // 123.45678.90-1
 formatPis('123456789', { pad: true }); // 001.23456.78-9
 ```
 
+## parsePis
+
+Remove a formatação do PIS e retorna apenas os dígitos.
+
+```javascript
+import { parsePis } from '@brazilian-utils/brazilian-utils';
+
+parsePis('123.45678.90-1'); // 12345678901
+```
+
 ## formatCep
 
 Formata o CEP.
@@ -225,6 +276,16 @@ import { formatCep } from '@brazilian-utils/brazilian-utils';
 formatCep('92500000'); // 92500-000
 ```
 
+## parseCep
+
+Remove a formatação do CEP e retorna apenas os dígitos.
+
+```javascript
+import { parseCep } from '@brazilian-utils/brazilian-utils';
+
+parseCep('92500-000'); // 92500000
+```
+
 ## getAddressInfoByCep
 
 Busca informações de endereço para um CEP usando múltiplos provedores.
@@ -265,6 +326,16 @@ import { formatProcessoJuridico } from '@brazilian-utils/brazilian-utils';
 formatProcessoJuridico('00020802520125150049'); // 0002080-25.2012.515.0049
 ```
 
+## parseProcessoJuridico
+
+Remove a formatação do processo jurídico e retorna apenas os dígitos.
+
+```javascript
+import { parseProcessoJuridico } from '@brazilian-utils/brazilian-utils';
+
+parseProcessoJuridico('0002080-25.2012.515.0049'); // 00020802520125150049
+```
+
 ## isValidIe
 
 Valida se a inscrição estadual de um estado é válida.

docs/utilities.md

@@ -23,6 +23,16 @@ formatCpf('74650688000'); // 746.506.880-00
 formatCpf('746506880', { pad: true }); // 007.465.068-80
 ```
 
+## parseCpf
+
+Remove CPF formatting and return only digits.
+
+```javascript
+import { parseCpf } from '@brazilian-utils/brazilian-utils';
+
+parseCpf('746.506.880-00'); // 74650688000
+```
+
 ## generateCpf
 
 Generate a valid random CPF.
@@ -55,6 +65,17 @@ formatCnpj('245222000174', { pad: true }); // 00.245.222/0001-74
 formatCnpj('12OUT345000199', { version: 2 }); // 12.OUT.345/0001-99
 ```
 
+## parseCnpj
+
+Remove CNPJ formatting and return a normalized value.
+
+```javascript
+import { parseCnpj } from '@brazilian-utils/brazilian-utils';
+
+parseCnpj('24.522.200/0001-74'); // 24522200000174
+parseCnpj('12.OUT.345/0001-99', { version: 2 }); // 12OUT345000199
+```
+
 ## isValidCep
 
 Check if CEP ([brazilian postal code](https://en.wikipedia.org/wiki/C%C3%B3digo_de_Endere%C3%A7amento_Postal)) is valid.
@@ -96,6 +117,16 @@ formatBoleto('00190000090114971860168524522114675860000102656'); // 00190.00009
 formatBoleto('1900000901149', { pad: true }); // 00000.00000 00000.000019 00000.901149 0 00000000000000
 ```
 
+## parseBoleto
+
+Remove boleto formatting and return only digits.
+
+```javascript
+import { parseBoleto } from '@brazilian-utils/brazilian-utils';
+
+parseBoleto('00190.00009 01149.718601 68524.522114 6 75860000102656'); // 00190000090114971860168524522114675860000102656
+```
+
 ## generateBoleto
 
 Generate a valid random boleto.
@@ -149,6 +180,16 @@ formatPhone('11900000000', { mask: 'nanp' }); // (11) 90000-0000
 formatPhone('11900000000', { mask: 'auto' }); // Automatically detects mask based on length
 ```
 
+## parsePhone
+
+Remove phone formatting and return only digits.
+
+```javascript
+import { parsePhone } from '@brazilian-utils/brazilian-utils';
+
+parsePhone('(11) 90000-0000'); // 11900000000
+```
+
 ## isValidMobilePhone
 
 Check if mobile phone number is valid.
@@ -215,6 +256,16 @@ formatPis('12345678901'); // 123.45678.90-1
 formatPis('123456789', { pad: true }); // 001.23456.78-9
 ```
 
+## parsePis
+
+Remove PIS formatting and return only digits.
+
+```javascript
+import { parsePis } from '@brazilian-utils/brazilian-utils';
+
+parsePis('123.45678.90-1'); // 12345678901
+```
+
 ## formatCep
 
 Format CEP ([brazilian postal code](https://en.wikipedia.org/wiki/C%C3%B3digo_de_Endere%C3%A7amento_Postal)).
@@ -225,6 +276,16 @@ import { formatCep } from '@brazilian-utils/brazilian-utils';
 formatCep('92500000'); // 92500-000
 ```
 
+## parseCep
+
+Remove CEP formatting and return only digits.
+
+```javascript
+import { parseCep } from '@brazilian-utils/brazilian-utils';
+
+parseCep('92500-000'); // 92500000
+```
+
 ## getAddressInfoByCep
 
 Fetch address information for a given CEP using multiple providers.
@@ -265,6 +326,16 @@ import { formatProcessoJuridico } from '@brazilian-utils/brazilian-utils';
 formatProcessoJuridico('00020802520125150049'); // 0002080-25.2012.515.0049
 ```
 
+## parseProcessoJuridico
+
+Remove processo jurídico formatting and return only digits.
+
+```javascript
+import { parseProcessoJuridico } from '@brazilian-utils/brazilian-utils';
+
+parseProcessoJuridico('0002080-25.2012.515.0049'); // 00020802520125150049
+```
+
 ## isValidIe
 
 Check if inscrição estadual (state registration) is valid.

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@brazilian-utils/brazilian-utils",
-	"version": "2.0.1",
+	"version": "2.1.0",
 	"license": "MIT",
 	"description": "Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.",
 	"repository": "https://github.com/brazilian-utils/javascript",

src/_internals/constants/cities.ts

@@ -3745,7 +3745,6 @@ export const DATA = {
 	],
 	RN: [
 		"Acari",
-		"Açu",
 		"Afonso Bezerra",
 		"Água Nova",
 		"Alexandria",
@@ -3755,7 +3754,8 @@ export const DATA = {
 		"Antônio Martins",
 		"Apodi",
 		"Areia Branca",
-		"Arês",
+		"Arez",
+		"Assú",
 		"Baía Formosa",
 		"Baraúna",
 		"Barcelona",
@@ -3980,7 +3980,7 @@ export const DATA = {
 		"Pacaraima",
 		"Rorainópolis",
 		"São João da Baliza",
-		"São Luiz",
+		"São Luiz do Anauá",
 		"Uiramutã",
 	],
 	RS: [

src/index.test.ts

@@ -22,12 +22,19 @@ const PUBLIC = [
 	"formatCpf",
 	"formatCurrency",
 	"formatPhone",
+	"parseBoleto",
+	"parseCep",
+	"parseCnpj",
+	"parseCpf",
 	"parseCurrency",
 	"isValidPassport",
 	"generatePassport",
 	"parsePassport",
 	"formatPassport",
+	"parsePhone",
 	"formatPis",
+	"parsePis",
+	"parseProcessoJuridico",
 	"getStates",
 	"getCities",
 	"getHolidays",

src/index.ts

@@ -75,8 +75,15 @@ export {
 export { isValidPis } from "./is-valid-pis/is-valid-pis";
 export { isValidProcessoJuridico } from "./is-valid-processo-juridico/is-valid-processo-juridico";
 export { isValidRenavam } from "./is-valid-renavam/is-valid-renavam";
+export { parseBoleto } from "./parse-boleto/parse-boleto";
+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";
 
 // ============================================================================
 // DEPRECATED EXPORTS - Will be removed in v3.0.0

src/parse-boleto/parse-boleto.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from "vitest";
+import { parseBoleto } from "./parse-boleto";
+
+describe("parseBoleto", () => {
+	it("should remove boleto mask characters", () => {
+		expect(
+			parseBoleto("10491.44338 55119.000002 00000.000141 3 25230000093423"),
+		).toBe("10491443385511900000200000000141325230000093423");
+	});
+
+	it("should remove non numeric characters", () => {
+		expect(
+			parseBoleto(
+				"10491.44A338 55119.000002? ABC00000.000?141 3 25230000093423",
+			),
+		).toBe("10491443385511900000200000000141325230000093423");
+	});
+});

src/parse-boleto/parse-boleto.ts

@@ -0,0 +1,10 @@
+import { sanitizeToDigits } from "../_internals/sanitize-to-digits/sanitize-to-digits";
+
+/**
+ * Removes boleto formatting characters and returns only digits.
+ *
+ * @param {string|number} value - The boleto value to be parsed.
+ * @returns {string} The boleto value without formatting.
+ */
+export const parseBoleto = (value: string | number): string =>
+	sanitizeToDigits(value);

src/parse-cep/parse-cep.test.ts

@@ -0,0 +1,12 @@
+import { describe, expect, it } from "vitest";
+import { parseCep } from "./parse-cep";
+
+describe("parseCep", () => {
+	it("should remove CEP mask characters", () => {
+		expect(parseCep("01001-000")).toBe("01001000");
+	});
+
+	it("should remove non numeric characters", () => {
+		expect(parseCep("a0.10cr01?00#ab0")).toBe("01001000");
+	});
+});

src/parse-cep/parse-cep.ts

@@ -0,0 +1,10 @@
+import { sanitizeToDigits } from "../_internals/sanitize-to-digits/sanitize-to-digits";
+
+/**
+ * Removes CEP formatting characters and returns only digits.
+ *
+ * @param {string|number} value - The CEP value to be parsed.
+ * @returns {string} The CEP value without formatting.
+ */
+export const parseCep = (value: string | number): string =>
+	sanitizeToDigits(value);