@arkyn/shared 1.4.52 → 2.0.1-beta.1

package/dist/generators/generateSlug.js

@@ -1,5 +1,19 @@
-function generateSlug(string) {
-    let slug = string.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
+/**
+ * Generates a URL-friendly slug from a given string.
+ *
+ * The function performs the following transformations:
+ * - Normalizes the string to remove diacritical marks (e.g., accents).
+ * - Removes non-alphanumeric characters except for spaces and hyphens.
+ * - Replaces spaces with hyphens.
+ * - Converts the string to lowercase.
+ * - Collapses multiple consecutive hyphens into a single hyphen.
+ * - Trims leading and trailing hyphens.
+ *
+ * @param string - The input string to be converted into a slug.
+ * @returns A URL-friendly slug derived from the input string.
+ */
+function generateSlug(prop) {
+    let slug = prop.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
     slug = slug
         .replace(/[^\w\s-]/g, "")
         .replace(/\s+/g, "-")

package/dist/index.d.ts

@@ -1,26 +1,23 @@
-export { formatBrazilianDateHour } from "./formats/formatBrazilianDateHour";
-export { formatBrazilianDateToDate } from "./formats/formatBrazilianDateToDate";
-export { formatDateHour } from "./formats/formatDateHour";
+export { formatDate } from "./formats/formatDate";
 export { formatJsonObject } from "./formats/formatJsonObject";
 export { formatJsonString } from "./formats/formatJsonString";
-export { formatToBRL } from "./formats/formatToBRL";
 export { formatToCep } from "./formats/formatToCep";
-export { formatToCNPJ } from "./formats/formatToCNPJ";
-export { formatToCPF } from "./formats/formatToCPF";
+export { formatToCnpj } from "./formats/formatToCnpj";
+export { formatToCpf } from "./formats/formatToCpf";
 export { formatToCpfCnpj } from "./formats/formatToCpfCnpj";
+export { formatToCurrency } from "./formats/formatToCurrency";
 export { formatToEllipsis } from "./formats/formatToEllipsis";
 export { formatToHiddenDigits } from "./formats/formatToHiddenDigits";
 export { formatToPhone } from "./formats/formatToPhone";
 export { generateColorByString } from "./generators/generateColorByString";
 export { generateId } from "./generators/generateId";
 export { generateSlug } from "./generators/generateSlug";
-export { parseToCharacters } from "./parsers/parseToCharacters";
+export { regex } from "./regex";
 export { calculateCardInstallment } from "./services/calculateCardInstallment";
 export { maskSensitiveData } from "./services/maskSensitiveData";
-export { normalizeRange, within } from "./services/range";
+export { removeNonNumeric } from "./services/removeNonNumeric";
 export { truncateLargeFields } from "./services/truncateLargeFields";
-export { regex } from "./validations/regex";
-export { validateCPF } from "./validations/validateCPF";
+export { validateCpf } from "./validations/validateCpf";
 export { validateDate } from "./validations/validateDate";
 export { validatePhone } from "./validations/validatePhone";
 //# 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":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,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,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,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,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAGrE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,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":"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"}

package/dist/index.js

@@ -1,30 +1,22 @@
-// formats
-export { formatBrazilianDateHour } from "./formats/formatBrazilianDateHour";
-export { formatBrazilianDateToDate } from "./formats/formatBrazilianDateToDate";
-export { formatDateHour } from "./formats/formatDateHour";
+export { formatDate } from "./formats/formatDate";
 export { formatJsonObject } from "./formats/formatJsonObject";
 export { formatJsonString } from "./formats/formatJsonString";
-export { formatToBRL } from "./formats/formatToBRL";
 export { formatToCep } from "./formats/formatToCep";
-export { formatToCNPJ } from "./formats/formatToCNPJ";
-export { formatToCPF } from "./formats/formatToCPF";
+export { formatToCnpj } from "./formats/formatToCnpj";
+export { formatToCpf } from "./formats/formatToCpf";
 export { formatToCpfCnpj } from "./formats/formatToCpfCnpj";
+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";
-// parsers
-export { parseToCharacters } from "./parsers/parseToCharacters";
-// services
+export { regex } from "./regex";
 export { calculateCardInstallment } from "./services/calculateCardInstallment";
 export { maskSensitiveData } from "./services/maskSensitiveData";
-export { normalizeRange, within } from "./services/range";
+export { removeNonNumeric } from "./services/removeNonNumeric";
 export { truncateLargeFields } from "./services/truncateLargeFields";
-// validations
-export { regex } from "./validations/regex";
-export { validateCPF } from "./validations/validateCPF";
+export { validateCpf } from "./validations/validateCpf";
 export { validateDate } from "./validations/validateDate";
 export { validatePhone } from "./validations/validatePhone";

package/dist/{validations/regex.d.ts → regex/index.d.ts}

@@ -12,4 +12,4 @@ declare const regex: {
     DATE: RegExp;
 };
 export { regex };
-//# sourceMappingURL=regex.d.ts.map
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/services/__test__/calculateCardInstallment.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=calculateCardInstallment.spec.d.ts.map

package/dist/services/__test__/calculateCardInstallment.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateCardInstallment.spec.d.ts","sourceRoot":"","sources":["../../../src/services/__test__/calculateCardInstallment.spec.ts"],"names":[],"mappings":""}

package/dist/services/__test__/calculateCardInstallment.spec.js

@@ -0,0 +1,71 @@
+import { describe, it, expect } from "vitest";
+import { calculateCardInstallment } from "../calculateCardInstallment";
+describe("calculateCardInstallment", () => {
+    it("should calculate the total and installment price with default fees", () => {
+        const result = calculateCardInstallment({
+            cashPrice: 1000,
+            numberInstallments: 12,
+        });
+        expect(result).toEqual({
+            totalPrice: 1241.08,
+            installmentPrice: 103.42,
+        });
+    });
+    it("should calculate the total and installment price with custom fees", () => {
+        const result = calculateCardInstallment({
+            cashPrice: 1000,
+            numberInstallments: 12,
+            fees: 0.02,
+        });
+        expect(result).toEqual({
+            totalPrice: 1134.72,
+            installmentPrice: 94.56,
+        });
+    });
+    it("should calculate correctly for a single installment (no interest)", () => {
+        const result = calculateCardInstallment({
+            cashPrice: 1000,
+            numberInstallments: 1,
+            fees: 0,
+        });
+        expect(result).toEqual({
+            totalPrice: 1000,
+            installmentPrice: 1000,
+        });
+    });
+    it("should calculate correctly for zero fees", () => {
+        const result = calculateCardInstallment({
+            cashPrice: 500,
+            numberInstallments: 5,
+            fees: 0,
+        });
+        expect(result).toEqual({
+            totalPrice: 500,
+            installmentPrice: 100,
+        });
+    });
+    it("should handle edge case with zero installments", () => {
+        expect(() => calculateCardInstallment({
+            cashPrice: 1000,
+            numberInstallments: 0,
+        })).toThrow("Number of installments must be greater than 0");
+    });
+    it("should handle edge case with negative fees", () => {
+        expect(() => calculateCardInstallment({
+            cashPrice: 1000,
+            numberInstallments: 12,
+            fees: -0.01,
+        })).toThrow("Fees must be greater than or equal to 0");
+    });
+    it("should handle large numbers for cash price and installments", () => {
+        const result = calculateCardInstallment({
+            cashPrice: 1000000,
+            numberInstallments: 24,
+            fees: 0.01,
+        });
+        expect(result).toEqual({
+            totalPrice: 1129763.33,
+            installmentPrice: 47073.47,
+        });
+    });
+});

package/dist/services/__test__/maskSensitiveData.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=maskSensitiveData.spec.d.ts.map

package/dist/services/__test__/maskSensitiveData.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maskSensitiveData.spec.d.ts","sourceRoot":"","sources":["../../../src/services/__test__/maskSensitiveData.spec.ts"],"names":[],"mappings":""}

package/dist/services/__test__/maskSensitiveData.spec.js

@@ -0,0 +1,79 @@
+import { describe, it, expect } from "vitest";
+import { maskSensitiveData } from "../maskSensitiveData";
+describe("maskSensitiveData", () => {
+    it("should mask sensitive keys in a flat JSON object", () => {
+        const jsonString = JSON.stringify({
+            username: "user123",
+            password: "secret",
+            email: "user@example.com",
+        });
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe('{"username":"user123","password":"****","email":"user@example.com"}');
+    });
+    it("should mask sensitive keys in nested objects", () => {
+        const jsonString = JSON.stringify({
+            profile: {
+                username: "user123",
+                creditCard: "1234-5678-9012-3456",
+            },
+        });
+        const result = maskSensitiveData(jsonString, ["creditCard"]);
+        expect(result).toBe('{"profile":{"username":"user123","creditCard":"****"}}');
+    });
+    it("should mask sensitive keys in arrays", () => {
+        const jsonString = JSON.stringify({
+            users: [
+                { username: "user1", password: "pass1" },
+                { username: "user2", password: "pass2" },
+            ],
+        });
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe('{"users":[{"username":"user1","password":"****"},{"username":"user2","password":"****"}]}');
+    });
+    it("should handle non-JSON strings gracefully", () => {
+        const invalidJson = "not a json string";
+        const result = maskSensitiveData(invalidJson, ["password"]);
+        expect(result).toBe("not a json string");
+    });
+    it("should handle empty JSON objects", () => {
+        const jsonString = JSON.stringify({});
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe("{}");
+    });
+    it("should handle empty arrays", () => {
+        const jsonString = JSON.stringify([]);
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe("[]");
+    });
+    it("should use default sensitive keys if none are provided", () => {
+        const jsonString = JSON.stringify({
+            username: "user123",
+            password: "secret",
+            confirmPassword: "secret",
+            creditCard: "1234-5678-9012-3456",
+        });
+        const result = maskSensitiveData(jsonString);
+        expect(result).toBe('{"username":"user123","password":"****","confirmPassword":"****","creditCard":"****"}');
+    });
+    it("should not mask keys that are not in the sensitive keys list", () => {
+        const jsonString = JSON.stringify({
+            username: "user123",
+            email: "user@example.com",
+        });
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe('{"username":"user123","email":"user@example.com"}');
+    });
+    it("should handle deeply nested objects", () => {
+        const jsonString = JSON.stringify({
+            level1: {
+                level2: {
+                    level3: {
+                        password: "secret",
+                    },
+                },
+            },
+        });
+        const result = maskSensitiveData(jsonString, ["password"]);
+        expect(result).toBe('{"level1":{"level2":{"level3":{"password":"****"}}}}');
+    });
+});

package/dist/services/__test__/removeCurrencySymbols.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=removeCurrencySymbols.spec.d.ts.map

package/dist/services/__test__/removeCurrencySymbols.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeCurrencySymbols.spec.d.ts","sourceRoot":"","sources":["../../../src/services/__test__/removeCurrencySymbols.spec.ts"],"names":[],"mappings":""}

package/dist/services/__test__/removeCurrencySymbols.spec.js

@@ -0,0 +1,34 @@
+import { describe, it, expect } from "vitest";
+import { removeCurrencySymbols } from "../removeCurrencySymbols";
+describe("removeCurrencySymbols", () => {
+    it("should remove common currency symbols from the string", () => {
+        expect(removeCurrencySymbols("R$13,45")).toBe("13,45");
+        expect(removeCurrencySymbols("$123.45")).toBe("123.45");
+        expect(removeCurrencySymbols("€99.99")).toBe("99.99");
+        expect(removeCurrencySymbols("¥1,000")).toBe("1,000");
+    });
+    it("should handle strings without currency symbols", () => {
+        expect(removeCurrencySymbols("123.45")).toBe("123.45");
+        expect(removeCurrencySymbols("1,000")).toBe("1,000");
+    });
+    it("should handle strings with multiple currency symbols", () => {
+        expect(removeCurrencySymbols("R$ $123.45")).toBe("123.45");
+        expect(removeCurrencySymbols("€¥99,99")).toBe("99,99");
+    });
+    it("should handle strings with leading and trailing whitespace", () => {
+        expect(removeCurrencySymbols("  $123.45  ")).toBe("123.45");
+        expect(removeCurrencySymbols("\t€99.99\n")).toBe("99.99");
+    });
+    it("should return an empty string if the input is only currency symbols", () => {
+        expect(removeCurrencySymbols("R$")).toBe("");
+        expect(removeCurrencySymbols("$")).toBe("");
+        expect(removeCurrencySymbols("€")).toBe("");
+    });
+    it("should handle an empty string input", () => {
+        expect(removeCurrencySymbols("")).toBe("");
+    });
+    it("should handle strings with special characters but no currency symbols", () => {
+        expect(removeCurrencySymbols("123-45")).toBe("123-45");
+        expect(removeCurrencySymbols("1,000.00")).toBe("1,000.00");
+    });
+});

package/dist/services/__test__/removeNonNumeric.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=removeNonNumeric.spec.d.ts.map

package/dist/services/__test__/removeNonNumeric.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeNonNumeric.spec.d.ts","sourceRoot":"","sources":["../../../src/services/__test__/removeNonNumeric.spec.ts"],"names":[],"mappings":""}

package/dist/services/__test__/removeNonNumeric.spec.js

@@ -0,0 +1,27 @@
+import { describe, it, expect } from "vitest";
+import { removeNonNumeric } from "../removeNonNumeric";
+describe("removeNonNumeric", () => {
+    it("should remove all non-numeric characters from a string", () => {
+        expect(removeNonNumeric("abc123def456")).toBe("123456");
+        expect(removeNonNumeric("!@#123$%^456&*()")).toBe("123456");
+        expect(removeNonNumeric("a1b2c3")).toBe("123");
+    });
+    it("should return an empty string if there are no numeric characters", () => {
+        expect(removeNonNumeric("abcdef")).toBe("");
+        expect(removeNonNumeric("!@#$%^&*()")).toBe("");
+    });
+    it("should return the same string if it contains only numeric characters", () => {
+        expect(removeNonNumeric("123456")).toBe("123456");
+        expect(removeNonNumeric("000123")).toBe("000123");
+    });
+    it("should handle an empty string input", () => {
+        expect(removeNonNumeric("")).toBe("");
+    });
+    it("should handle strings with spaces and remove them", () => {
+        expect(removeNonNumeric("123 456 789")).toBe("123456789");
+        expect(removeNonNumeric(" 1 2 3 ")).toBe("123");
+    });
+    it("should handle strings with special characters and preserve only numbers", () => {
+        expect(removeNonNumeric("12-34.56/78")).toBe("12345678");
+    });
+});

package/dist/services/__test__/truncateLargeFields.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=truncateLargeFields.spec.d.ts.map

package/dist/services/__test__/truncateLargeFields.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncateLargeFields.spec.d.ts","sourceRoot":"","sources":["../../../src/services/__test__/truncateLargeFields.spec.ts"],"names":[],"mappings":""}

package/dist/services/__test__/truncateLargeFields.spec.js

@@ -0,0 +1,65 @@
+import { describe, it, expect } from "vitest";
+import { truncateLargeFields } from "../truncateLargeFields";
+describe("truncateLargeFields", () => {
+    it("should truncate string fields exceeding the maxLength", () => {
+        const json = JSON.stringify({
+            name: "John",
+            description: "A very long description that exceeds the maximum length...",
+        });
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe('{"name":"John","description":"To large information: field as 58 characters"}');
+    });
+    it("should handle nested objects and truncate large string fields", () => {
+        const json = JSON.stringify({
+            nested: {
+                details: "Another long string that needs truncation.",
+            },
+        });
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe('{"nested":{"details":"To large information: field as 42 characters"}}');
+    });
+    it("should handle arrays and truncate large string fields within them", () => {
+        const json = JSON.stringify({
+            items: ["short", "A very long string in an array that exceeds the limit"],
+        });
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe('{"items":["short","To large information: field as 53 characters"]}');
+    });
+    it("should not modify fields that are within the maxLength", () => {
+        const json = JSON.stringify({
+            name: "John",
+            description: "Short description",
+        });
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe('{"name":"John","description":"Short description"}');
+    });
+    it("should throw an error for invalid JSON strings", () => {
+        const invalidJson = "{ name: 'John' }"; // Invalid JSON
+        expect(() => truncateLargeFields(invalidJson, 20)).toThrow("Invalid JSON string");
+    });
+    it("should handle empty JSON objects", () => {
+        const json = JSON.stringify({});
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe("{}");
+    });
+    it("should handle empty arrays", () => {
+        const json = JSON.stringify([]);
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe("[]");
+    });
+    it("should handle non-string fields without modification", () => {
+        const json = JSON.stringify({
+            number: 123,
+            boolean: true,
+            nullValue: null,
+        });
+        const result = truncateLargeFields(json, 20);
+        expect(result).toBe('{"number":123,"boolean":true,"nullValue":null}');
+    });
+    it("should use the default maxLength of 1000 if not provided", () => {
+        const longString = "a".repeat(1500);
+        const json = JSON.stringify({ longField: longString });
+        const result = truncateLargeFields(json);
+        expect(result).toBe(`{"longField":"To large information: field as 1500 characters"}`);
+    });
+});

package/dist/services/calculateCardInstallment.d.ts

@@ -1,7 +1,33 @@
-import type { CalculateCardInstallmentProps } from "@arkyn/types";
-declare function calculateCardInstallment(args: CalculateCardInstallmentProps): {
-    total_price: number;
-    installment_price: number;
-};
+import type { CalculateCardInstallmentFunction } from "@arkyn/types";
+/**
+ * Calculates the installment price and total price for a card payment plan.
+ *
+ * @remarks
+ * **Important:** When the interest amount (`fees`) is equal to 0 or the number of installments (`numberInstallments`) is equal to 1, no interest will be charged.
+ *
+ * @throws Will throw an error if the number of installments is less than or equal to 0.
+ * @throws Will throw an error if the fees are less than 0.
+ *
+ * @param props - The input parameters for the calculation.
+ * @param props.cashPrice - The total cash price of the product or service.
+ * @param props.numberInstallments - The number of installments for the payment plan.
+ * @param props.fees - The interest rate per installment (default is 0.0349).
+ *
+ * @returns An object containing:
+ * - `totalPrice`: The total price to be paid, rounded to two decimal places.
+ * - `installmentPrice`: The price of each installment, rounded to two decimal places.
+ *
+ * @example
+ * ```typescript
+ * const result = calculateCardInstallment({
+ *   cashPrice: 1000,
+ *   numberInstallments: 12,
+ *   fees: 0.02,
+ * });
+ * console.log(result);
+ * // Output: { totalPrice: 1124.62, installmentPrice: 93.72 }
+ * ```
+ */
+declare const calculateCardInstallment: CalculateCardInstallmentFunction;
 export { calculateCardInstallment };
 //# sourceMappingURL=calculateCardInstallment.d.ts.map

package/dist/services/calculateCardInstallment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calculateCardInstallment.d.ts","sourceRoot":"","sources":["../../src/services/calculateCardInstallment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,cAAc,CAAC;AAElE,iBAAS,wBAAwB,CAAC,IAAI,EAAE,6BAA6B;;;EAgBpE;AAED,OAAO,EAAE,wBAAwB,EAAE,CAAC"}
+{"version":3,"file":"calculateCardInstallment.d.ts","sourceRoot":"","sources":["../../src/services/calculateCardInstallment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,cAAc,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,QAAA,MAAM,wBAAwB,EAAE,gCA+B/B,CAAC;AAEF,OAAO,EAAE,wBAAwB,EAAE,CAAC"}

package/dist/services/calculateCardInstallment.js

@@ -1,14 +1,55 @@
-function calculateCardInstallment(args) {
-    const { cash_price, number_installments, fees = 0.0349 } = args;
-    let installment_price = 0;
-    let total_price = 0;
-    let numerator = Math.pow(1 + fees, number_installments) * fees;
-    let denominator = Math.pow(1 + fees, number_installments) - 1;
-    installment_price = cash_price * (numerator / denominator);
-    total_price = number_installments * installment_price;
+/**
+ * Calculates the installment price and total price for a card payment plan.
+ *
+ * @remarks
+ * **Important:** When the interest amount (`fees`) is equal to 0 or the number of installments (`numberInstallments`) is equal to 1, no interest will be charged.
+ *
+ * @throws Will throw an error if the number of installments is less than or equal to 0.
+ * @throws Will throw an error if the fees are less than 0.
+ *
+ * @param props - The input parameters for the calculation.
+ * @param props.cashPrice - The total cash price of the product or service.
+ * @param props.numberInstallments - The number of installments for the payment plan.
+ * @param props.fees - The interest rate per installment (default is 0.0349).
+ *
+ * @returns An object containing:
+ * - `totalPrice`: The total price to be paid, rounded to two decimal places.
+ * - `installmentPrice`: The price of each installment, rounded to two decimal places.
+ *
+ * @example
+ * ```typescript
+ * const result = calculateCardInstallment({
+ *   cashPrice: 1000,
+ *   numberInstallments: 12,
+ *   fees: 0.02,
+ * });
+ * console.log(result);
+ * // Output: { totalPrice: 1124.62, installmentPrice: 93.72 }
+ * ```
+ */
+const calculateCardInstallment = (props) => {
+    const { cashPrice, numberInstallments, fees = 0.0349 } = props;
+    if (fees === 0 || numberInstallments === 1) {
+        return {
+            totalPrice: cashPrice,
+            installmentPrice: cashPrice / numberInstallments,
+        };
+    }
+    if (numberInstallments <= 0) {
+        throw new Error("Number of installments must be greater than 0");
+    }
+    if (fees < 0) {
+        throw new Error("Fees must be greater than or equal to 0");
+    }
+    let installmentPrice = 0;
+    let totalPrice = 0;
+    let numerator = Math.pow(1 + fees, numberInstallments) * fees;
+    let denominator = Math.pow(1 + fees, numberInstallments) - 1;
+    installmentPrice = cashPrice * (numerator / denominator);
+    totalPrice = numberInstallments * installmentPrice;
     return {
-        total_price: +total_price.toFixed(2),
-        installment_price: +installment_price.toFixed(2),
+        totalPrice: +totalPrice.toFixed(2),
+        installmentPrice: +installmentPrice.toFixed(2),
     };
-}
+};
 export { calculateCardInstallment };

package/dist/services/maskSensitiveData.d.ts

@@ -1,3 +1,26 @@
-declare function maskSensitiveData(jsonString: string, sensitiveKeys?: string[]): string;
+import type { MaskSensitiveDataFunction } from "@arkyn/types";
+/**
+ * Masks sensitive data in a JSON string by replacing the values of specified keys with "****".
+ *
+ * @param jsonString - The JSON string to be processed.
+ * @param sensitiveKeys - An array of keys whose values should be masked. Defaults to `["password", "confirmPassword", "creditCard"]`.
+ * @returns A JSON string with sensitive data masked. If the input is not a valid JSON string, it returns the original string.
+ *
+ * @example
+ * ```typescript
+ * const jsonString = JSON.stringify({
+ *   username: "user123",
+ *   password: "secret",
+ *   profile: {
+ *     creditCard: "1234-5678-9012-3456",
+ *   },
+ * });
+ *
+ * const result = maskSensitiveData(jsonString, ["password", "creditCard"]);
+ * console.log(result);
+ * // Output: '{"username":"user123","password":"****","profile":{"creditCard":"****"}}'
+ * ```
+ */
+declare const maskSensitiveData: MaskSensitiveDataFunction;
 export { maskSensitiveData };
 //# sourceMappingURL=maskSensitiveData.d.ts.map

package/dist/services/maskSensitiveData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maskSensitiveData.d.ts","sourceRoot":"","sources":["../../src/services/maskSensitiveData.ts"],"names":[],"mappings":"AAAA,iBAAS,iBAAiB,CACxB,UAAU,EAAE,MAAM,EAClB,aAAa,WAAgD,GAC5D,MAAM,CAkCR;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"maskSensitiveData.d.ts","sourceRoot":"","sources":["../../src/services/maskSensitiveData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,QAAA,MAAM,iBAAiB,EAAE,yBAqCxB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/services/maskSensitiveData.js

@@ -1,4 +1,26 @@
-function maskSensitiveData(jsonString, sensitiveKeys = ["password", "confirmPassword", "creditCard"]) {
+/**
+ * Masks sensitive data in a JSON string by replacing the values of specified keys with "****".
+ *
+ * @param jsonString - The JSON string to be processed.
+ * @param sensitiveKeys - An array of keys whose values should be masked. Defaults to `["password", "confirmPassword", "creditCard"]`.
+ * @returns A JSON string with sensitive data masked. If the input is not a valid JSON string, it returns the original string.
+ *
+ * @example
+ * ```typescript
+ * const jsonString = JSON.stringify({
+ *   username: "user123",
+ *   password: "secret",
+ *   profile: {
+ *     creditCard: "1234-5678-9012-3456",
+ *   },
+ * });
+ *
+ * const result = maskSensitiveData(jsonString, ["password", "creditCard"]);
+ * console.log(result);
+ * // Output: '{"username":"user123","password":"****","profile":{"creditCard":"****"}}'
+ * ```
+ */
+const maskSensitiveData = (jsonString, sensitiveKeys = ["password", "confirmPassword", "creditCard"]) => {
     function maskValue(key, value) {
         if (sensitiveKeys.includes(key))
             return "****";
@@ -34,5 +56,5 @@ function maskSensitiveData(jsonString, sensitiveKeys = ["password", "confirmPass
     catch (error) {
         return jsonString;
     }
-}
+};
 export { maskSensitiveData };

package/dist/services/removeCurrencySymbols.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Removes currency symbols from a given formatted string.
+ *
+ * This function takes a string that may contain currency symbols
+ * and removes them using a regular expression. The resulting string
+ * is also trimmed of any leading or trailing whitespace.
+ *
+ * @param formattedValue - The input string containing currency symbols.
+ * @returns A string with all currency symbols removed and trimmed of whitespace.
+ *
+ * @example
+ * removeCurrencySymbols("R$13,45"); // "13,45"
+ * removeCurrencySymbols("$123.45"); // "123.45"
+ * removeCurrencySymbols("€99.99"); // "99.99"
+ * removeCurrencySymbols("¥1,000"); // "1,000"
+ * removeCurrencySymbols("123.45"); // "123.45" (no symbols to remove)
+ */
+declare const removeCurrencySymbols: (formattedValue: string) => string;
+export { removeCurrencySymbols };
+//# sourceMappingURL=removeCurrencySymbols.d.ts.map