@arkyn/shared 3.0.1-beta.143 → 3.0.1-beta.144

package/dist/formats/formatToEllipsis.d.ts

@@ -2,12 +2,9 @@
  * Truncates a given text to a specified maximum length and appends an ellipsis ("...")
  * if the text exceeds the maximum length.
  *
- * @param {string} text - The input string to be truncated.
- *
- * @param {number} maxLength - The maximum allowed length of the string before truncation.
- *
- * @returns {string} The truncated string with an ellipsis if the input exceeds the maximum length,
- *          or the original string if it does not.
+ * @param text - The input string to be truncated.
+ * @param maxLength - Maximum allowed length before truncation.
+ * @returns The truncated string with `"..."` appended, or the original string if it fits.
  * @example
  * ```typescript
  * const result = formatToEllipsis("Hello, world!", 5);

package/dist/formats/formatToEllipsis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToEllipsis.d.ts","sourceRoot":"","sources":["../../src/formats/formatToEllipsis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAsBjE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"formatToEllipsis.d.ts","sourceRoot":"","sources":["../../src/formats/formatToEllipsis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAsBjE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/formats/formatToEllipsis.js

@@ -2,12 +2,9 @@
  * Truncates a given text to a specified maximum length and appends an ellipsis ("...")
  * if the text exceeds the maximum length.
  *
- * @param {string} text - The input string to be truncated.
- *
- * @param {number} maxLength - The maximum allowed length of the string before truncation.
- *
- * @returns {string} The truncated string with an ellipsis if the input exceeds the maximum length,
- *          or the original string if it does not.
+ * @param text - The input string to be truncated.
+ * @param maxLength - Maximum allowed length before truncation.
+ * @returns The truncated string with `"..."` appended, or the original string if it fits.
  * @example
  * ```typescript
  * const result = formatToEllipsis("Hello, world!", 5);

package/dist/formats/formatToHiddenDigits.d.ts

@@ -1,30 +1,19 @@
 /**
- * Formats a string by hiding specific digits within a given range.
+ * Replaces specific digits in a string with a masking character, leaving non-digit characters unchanged.
  *
- * This function takes a string input and replaces digits within a specified range
- * with a hiding character (e.g., "*"). Non-digit characters remain unchanged.
- *
- * @param {string} value - The input string to be formatted.
- * @param {FormatToHiddenDigitsOptions} options - Configuration options for formatting.
- * @param {number | [number, number]} options.range - The range of digits to hide. It can be:
- *   - A single number (e.g., `3`), which hides the first `n` digits if positive,
- *     or the last `n` digits if negative.
- *   - A tuple `[start, end]` specifying the range of digits to hide (inclusive).
- *   - Defaults to `3`, hiding the first three digits.
- * @param {string} options.hider - The character used to hide digits. Defaults to `"*"`.
- *
- * @returns {string} The formatted string with specified digits hidden.
- *
- * @example
- * ```typescript
- * const formatted = formatToHiddenDigits("123-456-7890", { range: 3 });
- * console.log(formatted); // Output: "***-456-7890"
- * ```
+ * @param value - The input string to mask.
+ * @param options.range - Which digits to hide:
+ *   - Positive number `n` — hides the first `n` digits.
+ *   - Negative number `-n` — hides the last `n` digits.
+ *   - Tuple `[start, end]` — hides digits from position `start` to `end` (inclusive, 1-indexed).
+ *   - Defaults to `3`.
+ * @param options.hider - The masking character. Defaults to `"*"`.
+ * @returns The string with the specified digit positions replaced.
  *
  * @example
  * ```typescript
- * const formatted = formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
- * console.log(formatted); // Output: "123-###-7890"
+ * formatToHiddenDigits("123-456-7890", { range: 3 });         // "***-456-7890"
+ * formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" }); // "123-###-7890"
  * ```
  */
 declare function formatToHiddenDigits(value: string, options?: {

package/dist/formats/formatToHiddenDigits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToHiddenDigits.d.ts","sourceRoot":"","sources":["../../src/formats/formatToHiddenDigits.ts"],"names":[],"mappings":"AA6CA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,iBAAS,oBAAoB,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9D,MAAM,CAWR;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"formatToHiddenDigits.d.ts","sourceRoot":"","sources":["../../src/formats/formatToHiddenDigits.ts"],"names":[],"mappings":"AA6CA;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAS,oBAAoB,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9D,MAAM,CAWR;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/formats/formatToHiddenDigits.js

@@ -19,32 +19,21 @@ const normalizeRange = (range, limit) => {
 };
 const within = (range, value) => value >= range[0] && value <= range[1];
 /**
- * Formats a string by hiding specific digits within a given range.
+ * Replaces specific digits in a string with a masking character, leaving non-digit characters unchanged.
  *
- * This function takes a string input and replaces digits within a specified range
- * with a hiding character (e.g., "*"). Non-digit characters remain unchanged.
- *
- * @param {string} value - The input string to be formatted.
- * @param {FormatToHiddenDigitsOptions} options - Configuration options for formatting.
- * @param {number | [number, number]} options.range - The range of digits to hide. It can be:
- *   - A single number (e.g., `3`), which hides the first `n` digits if positive,
- *     or the last `n` digits if negative.
- *   - A tuple `[start, end]` specifying the range of digits to hide (inclusive).
- *   - Defaults to `3`, hiding the first three digits.
- * @param {string} options.hider - The character used to hide digits. Defaults to `"*"`.
- *
- * @returns {string} The formatted string with specified digits hidden.
- *
- * @example
- * ```typescript
- * const formatted = formatToHiddenDigits("123-456-7890", { range: 3 });
- * console.log(formatted); // Output: "***-456-7890"
- * ```
+ * @param value - The input string to mask.
+ * @param options.range - Which digits to hide:
+ *   - Positive number `n` — hides the first `n` digits.
+ *   - Negative number `-n` — hides the last `n` digits.
+ *   - Tuple `[start, end]` — hides digits from position `start` to `end` (inclusive, 1-indexed).
+ *   - Defaults to `3`.
+ * @param options.hider - The masking character. Defaults to `"*"`.
+ * @returns The string with the specified digit positions replaced.
  *
  * @example
  * ```typescript
- * const formatted = formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
- * console.log(formatted); // Output: "123-###-7890"
+ * formatToHiddenDigits("123-456-7890", { range: 3 });         // "***-456-7890"
+ * formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" }); // "123-###-7890"
  * ```
  */
 function formatToHiddenDigits(value, options) {

package/dist/formats/formatToPhone.d.ts

@@ -5,9 +5,8 @@
  * national number, then applies the corresponding country's mask (underscore `_` used
  * as digit placeholder) replacing placeholders with actual digits.
  *
- * @param {string} phoneNumber - The input phone number (can include country code or be in national format).
- *
- * @returns {string} The phone number formatted following the country's mask.
+ * @param phoneNumber - The input phone number in E.164 format (e.g. `"+5534920524282"`).
+ * @returns The phone number formatted according to the country's mask.
  *
  * @throws {Error} If the phone number is invalid or if no country mask is found for the parsed country.
  *

package/dist/formats/formatToPhone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatToPhone.d.ts","sourceRoot":"","sources":["../../src/formats/formatToPhone.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,iBAAS,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA0BlD;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"formatToPhone.d.ts","sourceRoot":"","sources":["../../src/formats/formatToPhone.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,iBAAS,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CA0BlD;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/formats/formatToPhone.js

@@ -7,9 +7,8 @@ import { findCountryMask } from "../utilities/findCountryMask";
  * national number, then applies the corresponding country's mask (underscore `_` used
  * as digit placeholder) replacing placeholders with actual digits.
  *
- * @param {string} phoneNumber - The input phone number (can include country code or be in national format).
- *
- * @returns {string} The phone number formatted following the country's mask.
+ * @param phoneNumber - The input phone number in E.164 format (e.g. `"+5534920524282"`).
+ * @returns The phone number formatted according to the country's mask.
  *
  * @throws {Error} If the phone number is invalid or if no country mask is found for the parsed country.
  *

package/dist/generators/generateColorByString.d.ts

@@ -3,9 +3,8 @@
  * The function creates a hash from the string and uses it to calculate
  * RGB values, which are then converted to a hexadecimal color code.
  *
- * @param {string} rawString - The input string used to generate the color.
- *
- * @returns {string} A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ * @param rawString - The input string used to generate the color.
+ * @returns A hexadecimal color code (e.g., `"#a1b2c3"`) derived from the input string.
  *
  * @example
  * ```typescript

package/dist/generators/generateColorByString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateColorByString.d.ts","sourceRoot":"","sources":["../../src/generators/generateColorByString.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,iBAAS,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAgBxD;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
+{"version":3,"file":"generateColorByString.d.ts","sourceRoot":"","sources":["../../src/generators/generateColorByString.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,iBAAS,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAgBxD;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/generators/generateColorByString.js

@@ -3,9 +3,8 @@
  * The function creates a hash from the string and uses it to calculate
  * RGB values, which are then converted to a hexadecimal color code.
  *
- * @param {string} rawString - The input string used to generate the color.
- *
- * @returns {string} A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
+ * @param rawString - The input string used to generate the color.
+ * @returns A hexadecimal color code (e.g., `"#a1b2c3"`) derived from the input string.
  *
  * @example
  * ```typescript

package/dist/generators/generateId.d.ts

@@ -1,26 +1,15 @@
 /**
- * Generates a unique identifier (UUID) in the specified format and type.
+ * Generates a UUID in the specified version and output type.
  *
- * @param {"text" | "binary"} type - The desired output type of the UUID. Can be:
- *   - `"text"`: Returns the UUID as a string.
- *   - `"binary"`: Returns the UUID as a `Uint8Array` in binary format.
- * @param {"v4" | "v7"} format - The version of the UUID to generate. Can be:
- *   - `"v4"`: Generates a random UUID (version 4).
- *   - `"v7"`: Generates a time-ordered UUID (version 7).
- * @returns {string | Uint8Array} The generated UUID in the specified type and format.
- *   - If `type` is `"text"`, a string representation of the UUID is returned.
- *   - If `type` is `"binary"`, a `Uint8Array` representation of the UUID is returned.
- * @throws {Error} If an invalid `type` or `format` is provided.
+ * @param type - Output representation: `"text"` (string) or `"binary"` (`Uint8Array`).
+ * @param format - UUID version: `"v4"` (random) or `"v7"` (time-ordered).
+ * @returns The UUID as a string or `Uint8Array` depending on `type`.
  *
  * @example
- * // Generate a version 4 UUID as a string
- * const idTextV4 = generateId("text", "v4");
- * console.log(idTextV4); // e.g., "550e8400-e29b-41d4-a716-446655440000"
- *
- * @example
- * // Generate a version 7 UUID as binary
- * const idBinaryV7 = generateId("binary", "v7");
- * console.log(idBinaryV7); // Uint8Array([...])
+ * ```typescript
+ * generateId("text", "v4");   // "550e8400-e29b-41d4-a716-446655440000"
+ * generateId("binary", "v7"); // Uint8Array([...])
+ * ```
  */
 declare function generateId(type: "text", format: "v4" | "v7"): string;
 declare function generateId(type: "binary", format: "v4" | "v7"): Uint8Array;

package/dist/generators/generateId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateId.d.ts","sourceRoot":"","sources":["../../src/generators/generateId.ts"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAC/D,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,CAAC;AAYrE,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"generateId.d.ts","sourceRoot":"","sources":["../../src/generators/generateId.ts"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;GAYG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAC/D,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,CAAC;AAYrE,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/generators/generateSlug.d.ts

@@ -9,9 +9,8 @@
  * - Collapses multiple consecutive hyphens into a single hyphen.
  * - Trims leading and trailing hyphens.
  *
- * @param {string} rawString - The input string to be converted into a slug.
- *
- * @returns {string} A URL-friendly slug derived from the input string.
+ * @param rawString - The input string to be converted into a slug.
+ * @returns A URL-friendly slug derived from the input string.
  *
  * @example
  * ```typescript

package/dist/generators/generateSlug.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateSlug.d.ts","sourceRoot":"","sources":["../../src/generators/generateSlug.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,iBAAS,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAa/C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"generateSlug.d.ts","sourceRoot":"","sources":["../../src/generators/generateSlug.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,iBAAS,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAa/C;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/generators/generateSlug.js

@@ -9,9 +9,8 @@
  * - Collapses multiple consecutive hyphens into a single hyphen.
  * - Trims leading and trailing hyphens.
  *
- * @param {string} rawString - The input string to be converted into a slug.
- *
- * @returns {string} A URL-friendly slug derived from the input string.
+ * @param rawString - The input string to be converted into a slug.
+ * @returns A URL-friendly slug derived from the input string.
  *
  * @example
  * ```typescript

package/dist/parsers/parseLargeFields.d.ts

@@ -5,10 +5,9 @@
  * 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 {string} jsonString - The JSON string to process.
- * @param {number} maxLength - The maximum allowed length for string fields. Defaults to 1000.
- *
- * @returns {string} A JSON string with large string fields truncated.
+ * @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.
  *

package/dist/parsers/parseLargeFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseLargeFields.d.ts","sourceRoot":"","sources":["../../src/parsers/parseLargeFields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,iBAAS,gBAAgB,CACvB,UAAU,EAAE,MAAM,EAClB,SAAS,GAAE,MAAa,GACvB,MAAM,CA6BR;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"parseLargeFields.d.ts","sourceRoot":"","sources":["../../src/parsers/parseLargeFields.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,iBAAS,gBAAgB,CACvB,UAAU,EAAE,MAAM,EAClB,SAAS,GAAE,MAAa,GACvB,MAAM,CA6BR;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/parsers/parseLargeFields.js

@@ -5,10 +5,9 @@
  * 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 {string} jsonString - The JSON string to process.
- * @param {number} maxLength - The maximum allowed length for string fields. Defaults to 1000.
- *
- * @returns {string} A JSON string with large string fields truncated.
+ * @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.
  *

package/dist/parsers/parseSensitiveData.d.ts

@@ -1,10 +1,9 @@
 /**
  * Masks sensitive data in a JSON string by replacing the values of specified keys with "****".
  *
- * @param {string} jsonString - The JSON string to be processed.
- * @param {string[]} sensitiveKeys - An array of keys whose values should be masked. Defaults to `["password", "confirmPassword", "creditCard"]`.
- *
- * @returns {string} A JSON string with sensitive data masked. If the input is not a valid JSON string, it returns the original string.
+ * @param jsonString - The JSON string to be processed.
+ * @param sensitiveKeys - Keys whose values will be replaced with `"****"`. Defaults to `["password", "confirmPassword", "creditCard"]`.
+ * @returns A JSON string with sensitive values masked. Returns the original string if it is not valid JSON.
  *
  * @example
  * ```typescript

package/dist/parsers/parseSensitiveData.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseSensitiveData.d.ts","sourceRoot":"","sources":["../../src/parsers/parseSensitiveData.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,iBAAS,kBAAkB,CACzB,UAAU,EAAE,MAAM,EAClB,aAAa,GAAE,MAAM,EAAkD,GACtE,MAAM,CAkCR;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"parseSensitiveData.d.ts","sourceRoot":"","sources":["../../src/parsers/parseSensitiveData.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,iBAAS,kBAAkB,CACzB,UAAU,EAAE,MAAM,EAClB,aAAa,GAAE,MAAM,EAAkD,GACtE,MAAM,CAkCR;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/parsers/parseSensitiveData.js

@@ -1,10 +1,9 @@
 /**
  * Masks sensitive data in a JSON string by replacing the values of specified keys with "****".
  *
- * @param {string} jsonString - The JSON string to be processed.
- * @param {string[]} sensitiveKeys - An array of keys whose values should be masked. Defaults to `["password", "confirmPassword", "creditCard"]`.
- *
- * @returns {string} A JSON string with sensitive data masked. If the input is not a valid JSON string, it returns the original string.
+ * @param jsonString - The JSON string to be processed.
+ * @param sensitiveKeys - Keys whose values will be replaced with `"****"`. Defaults to `["password", "confirmPassword", "creditCard"]`.
+ * @returns A JSON string with sensitive values masked. Returns the original string if it is not valid JSON.
  *
  * @example
  * ```typescript

package/dist/parsers/parseToDate.d.ts

@@ -1,39 +1,23 @@
 /**
- * Converts a date and time input into a JavaScript `Date` object, formatted according to the specified input format and timezone.
+ * Parses a date (and optional time) string into a JavaScript `Date` object.
+ * All calculations are in UTC+0; use `timezone` to shift the result.
  *
- * @remarks
- * **Note:** This function works with UTC+0 by default. The returned Date object is not automatically converted to the machine's local timezone.
- * To adjust the timezone, you must manually specify the `timezone` parameter (e.g., -3 for UTC-3).
+ * @param date - Date string in the format determined by `inputFormat`.
+ * @param time - Optional time string `"HH:mm:ss"` (defaults to `"00:00:00"`).
+ * @param inputFormat - Parsing format:
+ *   - `"brazilianDate"`: DD/MM/YYYY
+ *   - `"isoDate"`: MM-DD-YYYY
+ *   - `"timestamp"`: YYYY-MM-DD
+ * @param timezone - UTC offset in hours (e.g. `-3` for UTC-3). Defaults to `0`.
+ * @returns A `Date` object representing the parsed date and time.
  *
- * @param {string[]} dateTime - An array containing the date and optional time.
- *   - The first element is the date string.
- *   - The second element is the time string (default is "00:00:00")
- * @param {"brazilianDate" | "isoDate" | "timestamp"} inputFormat - The format of the input date.
- *   - "brazilianDate": Expects the date in "DD/MM/YYYY" or "D/M/YYYY" format.
- *   - "isoDate": Expects the date in "MM-DD-YYYY" or "M-D-YYYY" format.
- *   - "timestamp": Expects the date in "YYYY-MM-DD" or "YYYY-M-D" format.
- * @param {number} [timezone=0] - The timezone offset in hours to apply to the date.
- *   - Defaults to 0 (UTC).
- *
- * @returns {Date} A `Date` object representing the parsed date and time, adjusted for the specified timezone.
- *
- * @throws {Error} If the `inputFormat` is invalid.
- * @throws {Error} If the provided date or time is invalid.
- *
- * @example Format a Brazilian date to Date
- * ```typescript
- * const date = parseToDate(["25/12/2023", "15:30:00"], "brazilianDate", -3);
- * console.log(date); // Outputs a Date object for "2023-12-25T12:30:00.000Z" (UTC)
- * ```
- * @example Format an ISO date to Date
- * ```typescript
- * const date = parseToDate(["12-25-2023", "15:30:00"], "isoDate", 2);
- * console.log(date); // Outputs a Date object for "2023-12-25T13:30:00.000Z" (UTC)
- * ```
- * @example Format a timestamp date to Date
+ * @example
  * ```typescript
- * const date = parseToDate(["2023-12-25", "15:30:00"], "timestamp");
- * console.log(date); // Outputs a Date object for "2023-12-25T15:30:00.000Z" (UTC)
+ * parseToDate(["25/12/2023", "15:30:00"], "brazilianDate", -3);
+ * // Date: 2023-12-25T12:30:00.000Z
+ *
+ * parseToDate(["2023-12-25"], "timestamp");
+ * // Date: 2023-12-25T00:00:00.000Z
  * ```
  */
 declare function parseToDate([date, time]: string[], inputFormat: "brazilianDate" | "isoDate" | "timestamp", timezone?: number): Date;

package/dist/parsers/parseToDate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseToDate.d.ts","sourceRoot":"","sources":["../../src/parsers/parseToDate.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,iBAAS,WAAW,CAClB,CAAC,IAAI,EAAE,IAAiB,CAAC,EAAE,MAAM,EAAE,EACnC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,WAAW,EACtD,QAAQ,GAAE,MAAU,GACnB,IAAI,CAkCN;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"parseToDate.d.ts","sourceRoot":"","sources":["../../src/parsers/parseToDate.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,iBAAS,WAAW,CAClB,CAAC,IAAI,EAAE,IAAiB,CAAC,EAAE,MAAM,EAAE,EACnC,WAAW,EAAE,eAAe,GAAG,SAAS,GAAG,WAAW,EACtD,QAAQ,GAAE,MAAU,GACnB,IAAI,CAkCN;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/parsers/parseToDate.js

@@ -1,40 +1,24 @@
 import { ValidateDateService } from "../services/validateDateService";
 /**
- * Converts a date and time input into a JavaScript `Date` object, formatted according to the specified input format and timezone.
+ * Parses a date (and optional time) string into a JavaScript `Date` object.
+ * All calculations are in UTC+0; use `timezone` to shift the result.
  *
- * @remarks
- * **Note:** This function works with UTC+0 by default. The returned Date object is not automatically converted to the machine's local timezone.
- * To adjust the timezone, you must manually specify the `timezone` parameter (e.g., -3 for UTC-3).
+ * @param date - Date string in the format determined by `inputFormat`.
+ * @param time - Optional time string `"HH:mm:ss"` (defaults to `"00:00:00"`).
+ * @param inputFormat - Parsing format:
+ *   - `"brazilianDate"`: DD/MM/YYYY
+ *   - `"isoDate"`: MM-DD-YYYY
+ *   - `"timestamp"`: YYYY-MM-DD
+ * @param timezone - UTC offset in hours (e.g. `-3` for UTC-3). Defaults to `0`.
+ * @returns A `Date` object representing the parsed date and time.
  *
- * @param {string[]} dateTime - An array containing the date and optional time.
- *   - The first element is the date string.
- *   - The second element is the time string (default is "00:00:00")
- * @param {"brazilianDate" | "isoDate" | "timestamp"} inputFormat - The format of the input date.
- *   - "brazilianDate": Expects the date in "DD/MM/YYYY" or "D/M/YYYY" format.
- *   - "isoDate": Expects the date in "MM-DD-YYYY" or "M-D-YYYY" format.
- *   - "timestamp": Expects the date in "YYYY-MM-DD" or "YYYY-M-D" format.
- * @param {number} [timezone=0] - The timezone offset in hours to apply to the date.
- *   - Defaults to 0 (UTC).
- *
- * @returns {Date} A `Date` object representing the parsed date and time, adjusted for the specified timezone.
- *
- * @throws {Error} If the `inputFormat` is invalid.
- * @throws {Error} If the provided date or time is invalid.
- *
- * @example Format a Brazilian date to Date
- * ```typescript
- * const date = parseToDate(["25/12/2023", "15:30:00"], "brazilianDate", -3);
- * console.log(date); // Outputs a Date object for "2023-12-25T12:30:00.000Z" (UTC)
- * ```
- * @example Format an ISO date to Date
- * ```typescript
- * const date = parseToDate(["12-25-2023", "15:30:00"], "isoDate", 2);
- * console.log(date); // Outputs a Date object for "2023-12-25T13:30:00.000Z" (UTC)
- * ```
- * @example Format a timestamp date to Date
+ * @example
  * ```typescript
- * const date = parseToDate(["2023-12-25", "15:30:00"], "timestamp");
- * console.log(date); // Outputs a Date object for "2023-12-25T15:30:00.000Z" (UTC)
+ * parseToDate(["25/12/2023", "15:30:00"], "brazilianDate", -3);
+ * // Date: 2023-12-25T12:30:00.000Z
+ *
+ * parseToDate(["2023-12-25"], "timestamp");
+ * // Date: 2023-12-25T00:00:00.000Z
  * ```
  */
 function parseToDate([date, time = "00:00:00"], inputFormat, timezone = 0) {

package/dist/services/validateDateService.d.ts

@@ -1,35 +1,14 @@
 /**
- * Service for validating date components and input formats.
+ * Validates date components and input format strings for date-parsing utilities.
+ * Enforces 4-digit years, month/day ranges, month-specific day counts, and leap year rules.
  *
- * This service provides methods to validate date parts (year, month, day) and
- * input format strings used in date parsing operations. It includes leap year
- * validation and month-specific day validation.
- *
- * @remarks
- * The service validates:
- * - Year must be exactly 4 digits (1000-9999)
- * - Month must be between 1 and 12
- * - Day must be between 1 and 31
- * - Day must be valid for the specific month (e.g., no February 30)
- * - Leap year rules for February 29
- *
- * @example Validate a valid date
- * ```typescript
- * const service = new ValidateDateService();
- * service.validateDateParts(2024, 1, 15); // No error thrown
- * ```
- *
- * @example Validate an invalid date
+ * @example
  * ```typescript
  * const service = new ValidateDateService();
- * service.validateDateParts(2023, 2, 29); // Throws: "Day 29 is not valid for February 2023 (non-leap year)"
- * ```
- *
- * @example Validate input format
- * ```typescript
- * const service = new ValidateDateService();
- * service.validateInputFormat("brazilianDate"); // No error thrown
- * service.validateInputFormat("invalidFormat"); // Throws: "Invalid input format: invalidFormat"
+ * service.validateDateParts(2024, 2, 29); // OK — leap year
+ * service.validateDateParts(2023, 2, 29); // throws — not a leap year
+ * service.validateInputFormat("brazilianDate"); // OK
+ * service.validateInputFormat("custom"); // throws
  * ```
  */
 declare class ValidateDateService {
@@ -37,47 +16,17 @@ declare class ValidateDateService {
     private getDaysInMonth;
     private validateDayInMonth;
     /**
-     * Validates the components of a date (year, month, and day).
-     *
-     * @param {number} year - The year to validate (must be 4 digits).
-     * @param {number} month - The month to validate (must be between 1 and 12).
-     * @param {number} day - The day to validate (must be between 1 and 31, and valid for the month).
-     *
-     * @throws {Error} "Year should be four digits" - If the year doesn't have exactly 4 digits.
-     * @throws {Error} "Month should be between 1 and 12" - If the month is out of valid range.
-     * @throws {Error} "Day should be between 1 and 31" - If the day is out of valid range.
-     * @throws {Error} Month-specific error - If the day is invalid for the specific month.
+     * Throws if year, month, or day are out of valid range or inconsistent with the calendar.
      *
-     * @example
-     * ```typescript
-     * const service = new ValidateDateService();
-     * service.validateDateParts(2024, 2, 29); // Valid leap year date
-     * service.validateDateParts(2023, 2, 29); // Throws error - not a leap year
-     * service.validateDateParts(2024, 4, 31); // Throws error - April has only 30 days
-     * ```
+     * @param year - 4-digit year (1000–9999).
+     * @param month - Month number (1–12).
+     * @param day - Day number (1–31, validated against the specific month).
      */
     validateDateParts(year: number, month: number, day: number): void;
     /**
-     * Validates that a given format string is supported.
-     *
-     * @param {string} format - The format string to validate.
-     *
-     * @throws {Error} "Invalid input format: {format}" - If the format is not one of the valid formats.
-     *
-     * @remarks
-     * Valid formats are:
-     * - "brazilianDate": DD/MM/YYYY format
-     * - "isoDate": MM-DD-YYYY format
-     * - "timestamp": YYYY-MM-DD format
+     * Throws if `format` is not one of `"brazilianDate"`, `"isoDate"`, or `"timestamp"`.
      *
-     * @example
-     * ```typescript
-     * const service = new ValidateDateService();
-     * service.validateInputFormat("brazilianDate"); // Valid
-     * service.validateInputFormat("isoDate"); // Valid
-     * service.validateInputFormat("timestamp"); // Valid
-     * service.validateInputFormat("customFormat"); // Throws error
-     * ```
+     * @param format - The format string to check.
      */
     validateInputFormat(format: string): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"validateDateService.d.ts","sourceRoot":"","sources":["../../src/services/validateDateService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,cAAM,mBAAmB;IACvB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,kBAAkB;IA2B1B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAcjE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAM1C;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"validateDateService.d.ts","sourceRoot":"","sources":["../../src/services/validateDateService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,cAAM,mBAAmB;IACvB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,kBAAkB;IA2B1B;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAcjE;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAM1C;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}