@arkyn/shared 1.4.52 → 1.4.55

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/regex/index.d.ts

@@ -0,0 +1,6 @@
+declare const regex: {
+    RG: RegExp;
+    PASSWORD: RegExp;
+};
+export { regex };
+//# 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":"AAKA,QAAA,MAAM,KAAK;;;CAAmB,CAAC;AAE/B,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/regex/index.js

@@ -0,0 +1,4 @@
+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/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

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

@@ -0,0 +1 @@
+{"version":3,"file":"removeCurrencySymbols.d.ts","sourceRoot":"","sources":["../../src/services/removeCurrencySymbols.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,QAAA,MAAM,qBAAqB,GAAI,gBAAgB,MAAM,KAAG,MAIvD,CAAC;AAEF,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/services/removeCurrencySymbols.js

@@ -0,0 +1,23 @@
+/**
+ * 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)
+ */
+const removeCurrencySymbols = (formattedValue) => {
+    return formattedValue
+        .replace(/(?:R\$|\p{Sc}|[$€¥£])/gu, "") // Inclui "R$" e outros símbolos comuns
+        .trim();
+};
+export { removeCurrencySymbols };

package/dist/services/removeNonNumeric.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Removes all non-numeric characters from a given string.
+ *
+ * @param prop - The input string from which non-numeric characters will be removed.
+ * @returns A new string containing only numeric characters from the input.
+ *
+ * @example
+ * ```typescript
+ * const result = removeNonNumeric("abc123def456");
+ * console.log(result); // Output: "123456"
+ * ```
+ */
+declare function removeNonNumeric(prop: string): string;
+export { removeNonNumeric };
+//# sourceMappingURL=removeNonNumeric.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"removeNonNumeric.d.ts","sourceRoot":"","sources":["../../src/services/removeNonNumeric.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/services/removeNonNumeric.js

@@ -0,0 +1,16 @@
+/**
+ * Removes all non-numeric characters from a given string.
+ *
+ * @param prop - The input string from which non-numeric characters will be removed.
+ * @returns A new string containing only numeric characters from the input.
+ *
+ * @example
+ * ```typescript
+ * const result = removeNonNumeric("abc123def456");
+ * console.log(result); // Output: "123456"
+ * ```
+ */
+function removeNonNumeric(prop) {
+    return prop.replace(/[^0-9]/g, "");
+}
+export { removeNonNumeric };

package/dist/services/truncateLargeFields.d.ts

@@ -1,3 +1,32 @@
-declare function truncateLargeFields(jsonString: string, maxLength?: number): string;
+import type { TruncateLargeFieldsFunction } from "@arkyn/types";
+/**
+ * Truncates large string fields in a JSON string to a specified maximum length.
+ *
+ * This function parses a JSON string, traverses its structure recursively, and truncates
+ * any string fields that exceed the specified maximum length. If a string field is truncated,
+ * it is replaced with a message indicating the original length of the field.
+ *
+ * @param jsonString - The JSON string to process.
+ * @param maxLength - The maximum allowed length for string fields. Defaults to 1000.
+ * @returns A JSON string with large string fields truncated.
+ *
+ * @throws {Error} Throws an error if the input is not a valid JSON string.
+ *
+ * @example
+ * ```typescript
+ * const json = JSON.stringify({
+ *   name: "John",
+ *   description: "A very long description that exceeds the maximum length...",
+ *   nested: {
+ *     details: "Another long string that needs truncation."
+ *   }
+ * });
+ *
+ * const result = truncateLargeFields(json, 50);
+ * console.log(result);
+ * // Output: '{"name":"John","description":"To large information: field as 57 characters","nested":{"details":"To large information: field as 43 characters"}}'
+ * ```
+ */
+declare const truncateLargeFields: TruncateLargeFieldsFunction;
 export { truncateLargeFields };
 //# sourceMappingURL=truncateLargeFields.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"truncateLargeFields.d.ts","sourceRoot":"","sources":["../../src/services/truncateLargeFields.ts"],"names":[],"mappings":"AAAA,iBAAS,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,MAAM,CA6BzE;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"truncateLargeFields.d.ts","sourceRoot":"","sources":["../../src/services/truncateLargeFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,QAAA,MAAM,mBAAmB,EAAE,2BAgC1B,CAAC;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/dist/services/truncateLargeFields.js

@@ -1,5 +1,33 @@
-function truncateLargeFields(jsonString, maxLength = 1000) {
-    function truncateValue(key, value) {
+/**
+ * Truncates large string fields in a JSON string to a specified maximum length.
+ *
+ * This function parses a JSON string, traverses its structure recursively, and truncates
+ * any string fields that exceed the specified maximum length. If a string field is truncated,
+ * it is replaced with a message indicating the original length of the field.
+ *
+ * @param jsonString - The JSON string to process.
+ * @param maxLength - The maximum allowed length for string fields. Defaults to 1000.
+ * @returns A JSON string with large string fields truncated.
+ *
+ * @throws {Error} Throws an error if the input is not a valid JSON string.
+ *
+ * @example
+ * ```typescript
+ * const json = JSON.stringify({
+ *   name: "John",
+ *   description: "A very long description that exceeds the maximum length...",
+ *   nested: {
+ *     details: "Another long string that needs truncation."
+ *   }
+ * });
+ *
+ * const result = truncateLargeFields(json, 50);
+ * console.log(result);
+ * // Output: '{"name":"John","description":"To large information: field as 57 characters","nested":{"details":"To large information: field as 43 characters"}}'
+ * ```
+ */
+const truncateLargeFields = (jsonString, maxLength = 1000) => {
+    function truncateValue(value) {
         if (typeof value === "string" && value.length > maxLength) {
             return `To large information: field as ${value.length} characters`;
         }
@@ -7,15 +35,15 @@ function truncateLargeFields(jsonString, maxLength = 1000) {
     }
     function recursiveTruncate(obj) {
         if (Array.isArray(obj)) {
-            return obj.map(recursiveTruncate);
+            return obj.map((item) => recursiveTruncate(item)); // Corrigido para processar elementos do array
         }
         else if (obj !== null && typeof obj === "object") {
             return Object.fromEntries(Object.entries(obj).map(([key, value]) => [
                 key,
-                truncateValue(key, recursiveTruncate(value)),
+                recursiveTruncate(value), // Corrigido para aplicar recursão corretamente
             ]));
         }
-        return obj;
+        return truncateValue(obj); // Corrigido para truncar valores diretamente
     }
     try {
         const parsedJson = JSON.parse(jsonString);
@@ -25,5 +53,5 @@ function truncateLargeFields(jsonString, maxLength = 1000) {
     catch (error) {
         throw new Error("Invalid JSON string");
     }
-}
+};
 export { truncateLargeFields };

package/dist/validations/validateCpf.d.ts

@@ -0,0 +1,24 @@
+import type { ValidateCpfFunction } from "@arkyn/types";
+/**
+ * Validates a Brazilian CPF (Cadastro de Pessoas Físicas) number.
+ *
+ * The CPF is a unique identifier assigned to Brazilian citizens and residents.
+ * This function checks if the provided CPF is valid by performing the following steps:
+ * - Removes any non-digit characters from the input.
+ * - Verifies if the CPF has the correct length (11 digits).
+ * - Ensures that all digits are not the same (e.g., "111.111.111-11" is invalid).
+ * - Calculates the first and second verification digits using the CPF algorithm.
+ * - Compares the calculated verification digits with the ones provided in the CPF.
+ *
+ * @param rawCpf - The raw CPF string, which may include formatting characters (e.g., dots or dashes).
+ * @returns `true` if the CPF is valid, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * validateCpf("123.456.789-09"); // false
+ * validateCpf("111.444.777-35"); // true
+ * ```
+ */
+declare const validateCpf: ValidateCpfFunction;
+export { validateCpf };
+//# sourceMappingURL=validateCpf.d.ts.map

package/dist/validations/validateCpf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateCpf.d.ts","sourceRoot":"","sources":["../../src/validations/validateCpf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AA6BxD;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,QAAA,MAAM,WAAW,EAAE,mBAWlB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/validations/validateCpf.js

@@ -0,0 +1,56 @@
+function removeNonDigits(cpf) {
+    return cpf.replace(/\D/g, "");
+}
+function isInvalidLength(cpf) {
+    const CPF_LENGTH = 11;
+    return cpf.length !== CPF_LENGTH;
+}
+function hasAllDigitsEqual(cpf) {
+    const [firstCpfDigit] = cpf;
+    return [...cpf].every((digit) => digit === firstCpfDigit);
+}
+function calculateDigit(cpf, factor) {
+    let total = 0;
+    for (const digit of cpf) {
+        if (factor > 1)
+            total += parseInt(digit) * factor--;
+    }
+    const rest = total % 11;
+    return rest < 2 ? 0 : 11 - rest;
+}
+function extractDigit(cpf) {
+    return cpf.slice(9);
+}
+/**
+ * Validates a Brazilian CPF (Cadastro de Pessoas Físicas) number.
+ *
+ * The CPF is a unique identifier assigned to Brazilian citizens and residents.
+ * This function checks if the provided CPF is valid by performing the following steps:
+ * - Removes any non-digit characters from the input.
+ * - Verifies if the CPF has the correct length (11 digits).
+ * - Ensures that all digits are not the same (e.g., "111.111.111-11" is invalid).
+ * - Calculates the first and second verification digits using the CPF algorithm.
+ * - Compares the calculated verification digits with the ones provided in the CPF.
+ *
+ * @param rawCpf - The raw CPF string, which may include formatting characters (e.g., dots or dashes).
+ * @returns `true` if the CPF is valid, otherwise `false`.
+ *
+ * @example
+ * ```typescript
+ * validateCpf("123.456.789-09"); // false
+ * validateCpf("111.444.777-35"); // true
+ * ```
+ */
+const validateCpf = (rawCpf) => {
+    if (!rawCpf)
+        return false;
+    const cpf = removeNonDigits(rawCpf);
+    if (isInvalidLength(cpf))
+        return false;
+    if (hasAllDigitsEqual(cpf))
+        return false;
+    const digit1 = calculateDigit(cpf, 10);
+    const digit2 = calculateDigit(cpf, 11);
+    return extractDigit(cpf) === `${digit1}${digit2}`;
+};
+export { validateCpf };

package/dist/validations/validateDate.d.ts

@@ -1,8 +1,29 @@
-type Format = "DD/MM/YYYY" | "MM-DD-YYYY" | "YYYY-MM-DD";
-type Config = {
-    minYear?: number;
-    maxYear?: number;
-};
-declare function validateDate(date: string, format: Format, config?: Config): boolean;
+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 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".
+ *                            Defaults to "DD/MM/YYYY".
+ * @param config.minYear - The minimum allowed year for the date. Defaults to 1900.
+ * @param config.maxYear - The maximum allowed year for the date. Defaults to 3000.
+ *
+ * @returns `true` if the date is valid according to the specified format and configuration, otherwise `false`.
+ *
+ * @throws {Error} If an invalid date format is provided in the configuration.
+ *
+ * @example
+ * ```typescript
+ * validateDate("31/12/2023"); // true
+ * validateDate("12-31-2023", { inputFormat: "MM-DD-YYYY" }); // true
+ * validateDate("2023-12-31", { inputFormat: "YYYY-MM-DD", minYear: 2000, maxYear: 2100 }); // true
+ * validateDate("29/02/2024", { inputFormat: "DD/MM/YYYY" }); // true (leap year)
+ * validateDate("29/02/2023", { inputFormat: "DD/MM/YYYY" }); // false (not a leap year)
+ * validateDate("31/04/2023", { inputFormat: "DD/MM/YYYY" }); // false (April has 30 days)
+ * ```
+ */
+declare const validateDate: ValidateDateFunction;
 export { validateDate };
 //# sourceMappingURL=validateDate.d.ts.map

package/dist/validations/validateDate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateDate.d.ts","sourceRoot":"","sources":["../../src/validations/validateDate.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAC;AAEzD,KAAK,MAAM,GAAG;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,iBAAS,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CA6C5E;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"validateDate.d.ts","sourceRoot":"","sources":["../../src/validations/validateDate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,QAAA,MAAM,YAAY,EAAE,oBA8CnB,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/validations/validateDate.js

@@ -1,20 +1,46 @@
-function validateDate(date, format, config) {
+/**
+ * Validates a date string based on the provided format and configuration.
+ *
+ * @param date - 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".
+ *                            Defaults to "DD/MM/YYYY".
+ * @param config.minYear - The minimum allowed year for the date. Defaults to 1900.
+ * @param config.maxYear - The maximum allowed year for the date. Defaults to 3000.
+ *
+ * @returns `true` if the date is valid according to the specified format and configuration, otherwise `false`.
+ *
+ * @throws {Error} If an invalid date format is provided in the configuration.
+ *
+ * @example
+ * ```typescript
+ * validateDate("31/12/2023"); // true
+ * validateDate("12-31-2023", { inputFormat: "MM-DD-YYYY" }); // true
+ * validateDate("2023-12-31", { inputFormat: "YYYY-MM-DD", minYear: 2000, maxYear: 2100 }); // true
+ * validateDate("29/02/2024", { inputFormat: "DD/MM/YYYY" }); // true (leap year)
+ * validateDate("29/02/2023", { inputFormat: "DD/MM/YYYY" }); // false (not a leap year)
+ * validateDate("31/04/2023", { inputFormat: "DD/MM/YYYY" }); // false (April has 30 days)
+ * ```
+ */
+const validateDate = (date, config) => {
     let day, month, year;
-    const minYear = config?.minYear || 0;
+    const inputFormat = config?.inputFormat || "DD/MM/YYYY";
+    const minYear = config?.minYear || 1900;
     const maxYear = config?.maxYear || 3000;
-    if (format === "DD/MM/YYYY") {
+    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) || [];
     }
-    else if (format === "MM-DD-YYYY") {
+    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) || [];
     }
-    else if (format === "YYYY-MM-DD") {
+    else if (inputFormat === "YYYY-MM-DD") {
         const dateRegex = /^(\d{4})-(\d{2})-(\d{2})$/;
         if (!dateRegex.test(date))
             return false;
@@ -43,5 +69,5 @@ function validateDate(date, format, config) {
         return false;
     const isValidDate = new Date(yearNum, monthNum - 1, dayNum).getDate() === dayNum;
     return isValidDate;
-}
+};
 export { validateDate };