@arkyn/shared 3.0.1-beta.21 → 3.0.1-beta.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +452 -67
  2. package/package.json +21 -2
  3. package/src/formats/formatDate.ts +0 -92
  4. package/src/formats/formatJsonObject.ts +0 -90
  5. package/src/formats/formatJsonString.ts +0 -50
  6. package/src/formats/formatToCapitalizeFirstWordLetter.ts +0 -46
  7. package/src/formats/formatToCep.ts +0 -39
  8. package/src/formats/formatToCnpj.ts +0 -40
  9. package/src/formats/formatToCpf.ts +0 -40
  10. package/src/formats/formatToCpfCnpj.ts +0 -38
  11. package/src/formats/formatToCurrency.ts +0 -63
  12. package/src/formats/formatToDate.ts +0 -70
  13. package/src/formats/formatToEllipsis.ts +0 -25
  14. package/src/formats/formatToHiddenDigits.ts +0 -92
  15. package/src/formats/formatToPhone.ts +0 -170
  16. package/src/generators/generateColorByString.ts +0 -33
  17. package/src/generators/generateId.ts +0 -61
  18. package/src/generators/generateSlug.ts +0 -31
  19. package/src/index.ts +0 -37
  20. package/src/services/calculateCardInstallment.ts +0 -73
  21. package/src/services/ensureQuotes.ts +0 -25
  22. package/src/services/maskSensitiveData.ts +0 -68
  23. package/src/services/removeCurrencySymbols.ts +0 -29
  24. package/src/services/removeNonNumeric.ts +0 -20
  25. package/src/services/stripHtmlTags.ts +0 -20
  26. package/src/services/truncateLargeFields.ts +0 -69
  27. package/src/validations/validateCep.ts +0 -41
  28. package/src/validations/validateCnpj.ts +0 -65
  29. package/src/validations/validateCpf.ts +0 -62
  30. package/src/validations/validateDate.ts +0 -86
  31. package/src/validations/validatePassword.ts +0 -41
  32. package/src/validations/validatePhone.ts +0 -50
  33. package/src/validations/validateRg.ts +0 -37
  34. package/tsconfig.json +0 -20
  35. package/vitest.config.ts +0 -5
@@ -1,65 +0,0 @@
1
- import { removeNonNumeric } from "../services/removeNonNumeric";
2
-
3
- type ValidateCnpjFunction = (rawCnpj: string) => boolean;
4
-
5
- function isInvalidLength(cnpj: string) {
6
- const CNPJ_LENGTH = 14;
7
- return cnpj.length !== CNPJ_LENGTH;
8
- }
9
-
10
- function hasAllDigitsEqual(cnpj: string) {
11
- const [firstDigit] = cnpj;
12
- return [...cnpj].every((digit) => digit === firstDigit);
13
- }
14
-
15
- function calculateDigit(cnpj: string, multipliers: number[]) {
16
- let total = 0;
17
- for (let i = 0; i < multipliers.length; i++) {
18
- total += parseInt(cnpj[i]) * multipliers[i];
19
- }
20
- const rest = total % 11;
21
- return rest < 2 ? 0 : 11 - rest;
22
- }
23
-
24
- function extractDigit(cnpj: string) {
25
- return cnpj.slice(12);
26
- }
27
-
28
- /**
29
- * Validates a Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica) number.
30
- *
31
- * This function performs:
32
- * - Sanitization (removes non-digit characters).
33
- * - Length check (must be 14 digits).
34
- * - Repeating digits check (invalid if all digits are the same).
35
- * - Verifies the two check digits with the proper weights.
36
- *
37
- * @param rawCnpj - CNPJ string, possibly formatted.
38
- * @returns `true` if valid, otherwise `false`.
39
- *
40
- * @example
41
- * ```ts
42
- * validateCnpj("12.345.678/0001-95"); // false
43
- * validateCnpj("11.444.777/0001-61"); // true
44
- * ```
45
- */
46
-
47
- const validateCnpj: ValidateCnpjFunction = (rawCnpj) => {
48
- if (!rawCnpj) return false;
49
-
50
- const cnpj = removeNonNumeric(rawCnpj);
51
-
52
- if (isInvalidLength(cnpj)) return false;
53
- if (hasAllDigitsEqual(cnpj)) return false;
54
-
55
- const base = cnpj.slice(0, 12);
56
- const digit1 = calculateDigit(base, [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]);
57
- const digit2 = calculateDigit(
58
- base + digit1,
59
- [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
60
- );
61
-
62
- return extractDigit(cnpj) === `${digit1}${digit2}`;
63
- };
64
-
65
- export { validateCnpj };
@@ -1,62 +0,0 @@
1
- import { removeNonNumeric } from "../services/removeNonNumeric";
2
-
3
- type ValidateCpfFunction = (rawCpf: string) => boolean;
4
-
5
- function isInvalidLength(cpf: string) {
6
- const CPF_LENGTH = 11;
7
- return cpf.length !== CPF_LENGTH;
8
- }
9
-
10
- function hasAllDigitsEqual(cpf: string) {
11
- const [firstCpfDigit] = cpf;
12
- return [...cpf].every((digit) => digit === firstCpfDigit);
13
- }
14
-
15
- function calculateDigit(cpf: string, factor: number) {
16
- let total = 0;
17
- for (const digit of cpf) {
18
- if (factor > 1) total += parseInt(digit) * factor--;
19
- }
20
- const rest = total % 11;
21
- return rest < 2 ? 0 : 11 - rest;
22
- }
23
-
24
- function extractDigit(cpf: string) {
25
- return cpf.slice(9);
26
- }
27
-
28
- /**
29
- * Validates a Brazilian CPF (Cadastro de Pessoas Físicas) number.
30
- *
31
- * The CPF is a unique identifier assigned to Brazilian citizens and residents.
32
- * This function checks if the provided CPF is valid by performing the following steps:
33
- * - Removes any non-digit characters from the input.
34
- * - Verifies if the CPF has the correct length (11 digits).
35
- * - Ensures that all digits are not the same (e.g., "111.111.111-11" is invalid).
36
- * - Calculates the first and second verification digits using the CPF algorithm.
37
- * - Compares the calculated verification digits with the ones provided in the CPF.
38
- *
39
- * @param rawCpf - The raw CPF string, which may include formatting characters (e.g., dots or dashes).
40
- * @returns `true` if the CPF is valid, otherwise `false`.
41
- *
42
- * @example
43
- * ```typescript
44
- * validateCpf("123.456.789-09"); // false
45
- * validateCpf("111.444.777-35"); // true
46
- * ```
47
- */
48
-
49
- const validateCpf: ValidateCpfFunction = (rawCpf) => {
50
- if (!rawCpf) return false;
51
- const cpf = removeNonNumeric(rawCpf);
52
-
53
- if (isInvalidLength(cpf)) return false;
54
- if (hasAllDigitsEqual(cpf)) return false;
55
-
56
- const digit1 = calculateDigit(cpf, 10);
57
- const digit2 = calculateDigit(cpf, 11);
58
-
59
- return extractDigit(cpf) === `${digit1}${digit2}`;
60
- };
61
-
62
- export { validateCpf };
@@ -1,86 +0,0 @@
1
- type ValidateDateConfig = {
2
- inputFormat?: "DD/MM/YYYY" | "MM-DD-YYYY" | "YYYY-MM-DD";
3
- minYear?: number;
4
- maxYear?: number;
5
- };
6
-
7
- type ValidateDateFunction = (
8
- rawDate: string,
9
- config?: ValidateDateConfig
10
- ) => boolean;
11
-
12
- /**
13
- * Validates a date string based on the provided format and configuration.
14
- *
15
- * @param rawDate - The date string to validate.
16
- * @param config - Optional configuration object to customize validation.
17
- * @param config.inputFormat - The expected format of the input date.
18
- * Supported formats are "DD/MM/YYYY", "MM-DD-YYYY", and "YYYY-MM-DD".
19
- * Defaults to "DD/MM/YYYY".
20
- * @param config.minYear - The minimum allowed year for the date. Defaults to 1900.
21
- * @param config.maxYear - The maximum allowed year for the date. Defaults to 3000.
22
- *
23
- * @returns `true` if the date is valid according to the specified format and configuration, otherwise `false`.
24
- *
25
- * @throws {Error} If an invalid date format is provided in the configuration.
26
- *
27
- * @example
28
- * ```typescript
29
- * validateDate("31/12/2023"); // true
30
- * validateDate("12-31-2023", { inputFormat: "MM-DD-YYYY" }); // true
31
- * validateDate("2023-12-31", { inputFormat: "YYYY-MM-DD", minYear: 2000, maxYear: 2100 }); // true
32
- * validateDate("29/02/2024", { inputFormat: "DD/MM/YYYY" }); // true (leap year)
33
- * validateDate("29/02/2023", { inputFormat: "DD/MM/YYYY" }); // false (not a leap year)
34
- * validateDate("31/04/2023", { inputFormat: "DD/MM/YYYY" }); // false (April has 30 days)
35
- * ```
36
- */
37
-
38
- const validateDate: ValidateDateFunction = (rawDate, config) => {
39
- let day: string, month: string, year: string;
40
-
41
- const inputFormat = config?.inputFormat || "DD/MM/YYYY";
42
- const minYear = config?.minYear || 1900;
43
- const maxYear = config?.maxYear || 3000;
44
-
45
- if (inputFormat === "DD/MM/YYYY") {
46
- const dateRegex = /^(\d{2})\/(\d{2})\/(\d{4})$/;
47
- if (!dateRegex.test(rawDate)) return false;
48
- [, day, month, year] = rawDate.match(dateRegex) || [];
49
- } else if (inputFormat === "MM-DD-YYYY") {
50
- const dateRegex = /^(\d{2})-(\d{2})-(\d{4})$/;
51
- if (!dateRegex.test(rawDate)) return false;
52
- [, month, day, year] = rawDate.match(dateRegex) || [];
53
- } else if (inputFormat === "YYYY-MM-DD") {
54
- const dateRegex = /^(\d{4})-(\d{2})-(\d{2})$/;
55
- if (!dateRegex.test(rawDate)) return false;
56
- [, year, month, day] = rawDate.match(dateRegex) || [];
57
- } else {
58
- throw new Error("Invalid date format");
59
- }
60
-
61
- const dayNum = parseInt(day, 10);
62
- const monthNum = parseInt(month, 10);
63
- const yearNum = parseInt(year, 10);
64
-
65
- if (dayNum < 1 || dayNum > 31) return false;
66
- if (monthNum < 1 || monthNum > 12) return false;
67
-
68
- const daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
69
-
70
- if (monthNum === 2) {
71
- const isLeapYear =
72
- (yearNum % 4 === 0 && yearNum % 100 !== 0) || yearNum % 400 === 0;
73
- if (dayNum > (isLeapYear ? 29 : 28)) return false;
74
- } else if (dayNum > daysInMonth[monthNum - 1]) {
75
- return false;
76
- }
77
-
78
- if (yearNum < minYear || yearNum > maxYear) return false;
79
-
80
- const isValidDate =
81
- new Date(yearNum, monthNum - 1, dayNum).getDate() === dayNum;
82
-
83
- return isValidDate;
84
- };
85
-
86
- export { validateDate };
@@ -1,41 +0,0 @@
1
- type ValidatePasswordFunction = (rawPassword: string) => boolean;
2
-
3
- /**
4
- * Validates a password based on the following rules:
5
- * - At least 8 characters
6
- * - At least 1 uppercase letter
7
- * - At least 1 letter (any case)
8
- * - At least 1 number
9
- * - At least 1 special character
10
- *
11
- * @param rawPassword - The raw password string.
12
- * @returns `true` if password is valid, otherwise `false`.
13
- *
14
- * @example
15
- * ```ts
16
- * validatePassword("Senha@123"); // true
17
- * validatePassword("senha123"); // false (no uppercase, no special char)
18
- * ```
19
- */
20
-
21
- const validatePassword: ValidatePasswordFunction = (rawPassword) => {
22
- if (!rawPassword) return false;
23
-
24
- const hasMinLength = rawPassword.length >= 8;
25
- const hasUppercase = /[A-Z]/.test(rawPassword);
26
- const hasLetter = /[a-z]/.test(rawPassword);
27
- const hasNumber = /\d/.test(rawPassword);
28
- const hasSpecialChar = /[!@#$%^&*(),.?":{}|<>_\-+=~`[\]\\\/]/.test(
29
- rawPassword
30
- );
31
-
32
- return [
33
- hasMinLength,
34
- hasUppercase,
35
- hasLetter,
36
- hasNumber,
37
- hasSpecialChar,
38
- ].every((condition) => condition);
39
- };
40
-
41
- export { validatePassword };
@@ -1,50 +0,0 @@
1
- import { countries } from "@arkyn/templates";
2
-
3
- type ValidatePhoneFunction = (rawPhone: string) => boolean;
4
-
5
- /**
6
- * Validates a phone number against a list of country-specific formats.
7
- *
8
- * The function iterates through a predefined list of countries and checks if the
9
- * provided phone number matches the format for any of the countries. It uses
10
- * regular expressions to validate the phone number based on the country's code,
11
- * prefix, and mask.
12
- *
13
- * Special handling is applied for Brazilian phone numbers (ISO code "BR"), which
14
- * allows for an optional ninth digit.
15
- *
16
- * @param rawPhone - The phone number to validate as a string.
17
- * @returns `true` if the phone number matches any country's format, otherwise `false`.
18
- *
19
- * @example
20
- * ```typescript
21
- * import { validatePhone } from "./validatePhone";
22
- *
23
- * validatePhone("+55 32912345678"); // true for a valid Brazilian phone number
24
- * validatePhone("+55 3212345678"); // true for a valid Brazilian phone number
25
- * validatePhone("+1-684 1234567"); // true for a valid American Samoa phone number
26
- * validatePhone("+5532912345678"); // false for an invalid Brazilian phone number
27
- * validatePhone("+55 1234567890"); // false for an invalid Brazilian phone number
28
- * ```
29
- */
30
-
31
- const validatePhone: ValidatePhoneFunction = (rawPhone) => {
32
- for (const country of countries) {
33
- const countryCode = country.code;
34
- const prefix = country.prefix ? `-${country.prefix}` : "";
35
- const digitCount = country.mask.replace(/[^_]/g, "").length;
36
-
37
- if (country.iso === "BR") {
38
- const brazilRegex = new RegExp(`^\\${countryCode} \\d{2}9?\\d{8}$`);
39
- if (brazilRegex.test(rawPhone)) return true;
40
- continue;
41
- }
42
-
43
- const regex = new RegExp(`^\\${countryCode}${prefix} \\d{${digitCount}}$`);
44
- if (regex.test(rawPhone)) return true;
45
- }
46
-
47
- return false;
48
- };
49
-
50
- export { validatePhone };
@@ -1,37 +0,0 @@
1
- type ValidateRgFunction = (rawRg: string) => boolean;
2
-
3
- /**
4
- * Validates a Brazilian RG (Registro Geral) in a generic way.
5
- *
6
- * This function does a basic structure validation:
7
- * - Removes non-alphanumeric characters.
8
- * - Ensures length is reasonable (7–9 digits).
9
- * - Optionally allows for a final letter (verifier).
10
- *
11
- * @param rawRg - RG string, possibly formatted.
12
- * @returns `true` if format seems valid, otherwise `false`.
13
- *
14
- * @example
15
- * ```ts
16
- * validateRg("12.345.678-9"); // true
17
- * validateRg("MG-12.345.678"); // false (not supported)
18
- * validateRg("12345678X"); // true
19
- * ```
20
- */
21
-
22
- const validateRg: ValidateRgFunction = (rawRg) => {
23
- if (!rawRg) return false;
24
-
25
- const validFormat = /^[0-9a-zA-Z.-]+$/.test(rawRg);
26
- if (!validFormat) return false;
27
-
28
- const rg = rawRg.replace(/[^a-zA-Z0-9]/g, "");
29
-
30
- if (rg.length < 7 || rg.length > 9) return false;
31
-
32
- const isValidFormat = /^[0-9]{7,8}[0-9Xx]?$/.test(rg);
33
-
34
- return isValidFormat;
35
- };
36
-
37
- export { validateRg };
package/tsconfig.json DELETED
@@ -1,20 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "declaration": true,
4
- "declarationDir": "./dist",
5
- "declarationMap": true,
6
- "isolatedModules": true,
7
- "lib": ["DOM", "DOM.Iterable", "ES2022"],
8
- "module": "ESNext",
9
- "moduleResolution": "node",
10
- "outDir": "./dist",
11
- "preserveWatchOutput": true,
12
- "skipLibCheck": true,
13
- "strict": true,
14
- "target": "ESNext",
15
- "types": ["bun-types"],
16
- "verbatimModuleSyntax": true
17
- },
18
- "exclude": ["dist", "node_modules", "**/__test__"],
19
- "include": ["src/**/*.ts", "src/**/*.ts"]
20
- }
package/vitest.config.ts DELETED
@@ -1,5 +0,0 @@
1
- import { defineConfig } from "vite";
2
-
3
- export default defineConfig({
4
- resolve: { mainFields: ["module"] },
5
- });