@arkyn/shared 3.0.1-beta.9 → 3.0.1-beta.90

package/src/formats/formatToCpfCnpj.ts

@@ -1,38 +0,0 @@
-import { formatToCnpj } from "./formatToCnpj";
-import { formatToCpf } from "./formatToCpf";
-
-type FormatToCpfCnpjFunction = (value: string) => string;
-
-/**
- * Formats a given string value into either a CPF or CNPJ format based on its length.
- *
- * - If the input contains 11 numeric characters, it is formatted as a CPF.
- * - If the input contains 14 numeric characters, it is formatted as a CNPJ.
- * - Throws an error if the input length is neither 11 nor 14 after removing non-numeric characters.
- *
- * @param value - The string value to be formatted. It may contain non-numeric characters, which will be removed.
- * @returns The formatted CPF or CNPJ string.
- * @throws {Error} If the input does not have a valid CPF or CNPJ length.
- *
- * @example
- * ```typescript
- * formatToCpfCnpj("123.456.789-09"); // Returns "123.456.789-09" (CPF format)
- * formatToCpfCnpj("12.345.678/0001-95"); // Returns "12.345.678/0001-95" (CNPJ format)
- * formatToCpfCnpj("12345678909"); // Returns "123.456.789-09" (CPF format)
- * formatToCpfCnpj("12345678000195"); // Returns "12.345.678/0001-95" (CNPJ format)
- * formatToCpfCnpj("123"); // Throws an error: "Invalid CPF or CNPJ length"
- * ```
- */
-
-const formatToCpfCnpj: FormatToCpfCnpjFunction = (value) => {
-  const cleaned = value.replace(/\D/g, "");
-  if (cleaned.length === 11) {
-    return formatToCpf(cleaned);
-  } else if (cleaned.length === 14) {
-    return formatToCnpj(cleaned);
-  }
-
-  throw new Error("Invalid CPF or CNPJ length");
-};
-
-export { formatToCpfCnpj };

package/src/formats/formatToCurrency.ts

@@ -1,63 +0,0 @@
-import { countryCurrencies } from "@arkyn/templates";
-import { removeCurrencySymbols } from "../services/removeCurrencySymbols";
-
-type Currencies = keyof typeof countryCurrencies;
-
-type Config = {
-  showPrefix?: boolean;
-};
-
-type FormatToCurrency = (
-  value: number,
-  currency: Currencies,
-  config?: Config
-) => string;
-
-/**
- * Formats a numeric value into a currency string based on the specified currency and configuration.
- *
- * @param value - The numeric value to be formatted.
- * @param currency - The currency code used to determine the formatting style.
- * @param config - Optional configuration object.
- * @param config.showPrefix - Determines whether the currency symbol/prefix should be included in the formatted string. Defaults to `true`.
- *
- * @returns A formatted currency string. If `config.showPrefix` is `false`, the currency symbol is removed.
- *
- * @example
- * ```typescript
- * const formatted = formatToCurrency(1234.56, "USD", { showPrefix: true });
- * console.log(formatted); // "$1,234.56"
- *
- * const withoutPrefix = formatToCurrency(1234.56, "USD", { showPrefix: false });
- * console.log(withoutPrefix); // "1,234.56"
- *
- * const formattedBRL = formatToCurrency(1234.56, "BRL", { showPrefix: true });
- * console.log(formattedBRL); // "R$ 1.234,56"
- *
- * const withoutPrefixBRL = formatToCurrency(1234.56, "BRL", { showPrefix: false });
- * console.log(withoutPrefixBRL); // "1.234,56"
- * ```
- */
-
-const formatToCurrency: FormatToCurrency = (
-  value,
-  currency,
-  config = { showPrefix: true }
-) => {
-  if (!countryCurrencies[currency]) {
-    throw new Error("Unsupported currency code");
-  }
-
-  const { countryCurrency, countryLanguage } = countryCurrencies[currency];
-
-  const format = new Intl.NumberFormat(countryLanguage, {
-    style: "currency",
-    currency: countryCurrency,
-  }).format(value);
-
-  return config.showPrefix
-    ? format.replace(/\s/g, " ")
-    : removeCurrencySymbols(format).replace(/\s/g, " ");
-};
-
-export { formatToCurrency };

package/src/formats/formatToDate.ts

@@ -1,70 +0,0 @@
-type InputFormatTypes = "brazilianDate" | "timestamp" | "isoDate";
-
-type FormatToDateFunction = (
-  date: string[], // [date: string, time?: string]
-  inputFormat: InputFormatTypes,
-  timezone?: number
-) => Date;
-
-/**
- * Converts a date and time input into a JavaScript `Date` object, formatted according to the specified input format and timezone.
- *
- * @param param0 - A tuple containing the date string and an optional time string.
- *                 The date string format depends on the `inputFormat` parameter.
- *                 The time string defaults to "00:00:00" if not provided.
- * @param inputFormat - The format of the input date string.
- *                      Supported formats are:
- *                      - `"brazilianDate"`: Expects the date in `DD/MM/YYYY` format.
- *                      - `"isoDate"`: Expects the date in `YYYY-MM-DD` format.
- *                      - `"timestamp"`: Expects the date in `YYYY-MM-DD` format (similar to `isoDate`).
- * @param timezone - An optional timezone offset in hours. Defaults to `0` (UTC).
- *
- * @returns 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
- * ```typescript
- * import { formatToDate } from "./formatToIsoDate";
- *
- * const date = formatToDate(["25/12/2023", "15:30:00"], "brazilianDate", -3);
- * console.log(date); // Outputs a Date object for "2023-12-25T18:30:00.000Z" (UTC)
- * ```
- */
-
-const formatToDate: FormatToDateFunction = (
-  [date, time = "00:00:00"],
-  inputFormat,
-  timezone = 0
-) => {
-  const dateParts = date.split(/[-/]/).map(Number);
-  const timeParts = time.split(".")[0].split(":").map(Number);
-
-  let day, month, year;
-  const [hours = 0, minutes = 0, seconds = 0] = timeParts;
-
-  switch (inputFormat) {
-    case "brazilianDate":
-      [day, month, year] = dateParts;
-      break;
-    case "isoDate":
-      [year, month, day] = dateParts;
-      break;
-    case "timestamp":
-      [year, month, day] = dateParts.map(Number);
-      break;
-    default:
-      throw new Error("Invalid input format");
-  }
-
-  const utcDate = new Date(
-    Date.UTC(year, month - 1, day, hours - timezone, minutes, seconds)
-  );
-
-  if (isNaN(utcDate.getTime())) throw new Error("Invalid date");
-
-  return utcDate;
-};
-
-export { formatToDate };

package/src/formats/formatToEllipsis.ts

@@ -1,25 +0,0 @@
-type FormatToEllipsisFunction = (value: string, maxLength: number) => string;
-
-/**
- * Truncates a given text to a specified maximum length and appends an ellipsis ("...")
- * if the text exceeds the maximum length.
- *
- * @param text - The input string to be truncated.
- * @param maxLength - The maximum allowed length of the string before truncation.
- * @returns The truncated string with an ellipsis if the input exceeds the maximum length,
- *          or the original string if it does not.
- * @example
- * const result = formatToEllipsis("Hello, world!", 5);
- * console.log(result); // Output: "Hello..."
- */
-
-const formatToEllipsis: FormatToEllipsisFunction = (text, maxLength) => {
-  if (text.length > maxLength) {
-    let trimmedText = text.substring(0, maxLength).trimEnd();
-    trimmedText = trimmedText.replace(/[.,!?;:]$/, "");
-    return `${trimmedText}...`;
-  }
-  return text;
-};
-
-export { formatToEllipsis };

package/src/formats/formatToHiddenDigits.ts

@@ -1,92 +0,0 @@
-const DIGIT = /^\d$/;
-
-type DigitCharacterNode = {
-  kind: "digit";
-  digit: number;
-  character: string;
-};
-
-type OtherCharacterNode = {
-  kind: "other";
-  character: string;
-};
-
-type RootCharacterNode = {
-  kind: "root";
-  digits: number;
-  children: (DigitCharacterNode | OtherCharacterNode)[];
-};
-
-type FormatToHiddenDigitsFunction = (
-  value: string,
-  options: { range?: number | [number, number]; hider?: string }
-) => string;
-
-const parseToCharacters = (value: string): RootCharacterNode => {
-  let digits = 0;
-
-  const children = value
-    .split("")
-    .map((character: string): DigitCharacterNode | OtherCharacterNode => {
-      if (DIGIT.test(character))
-        return { character, kind: "digit", digit: ++digits };
-      return { character, kind: "other" };
-    });
-
-  return { digits, children, kind: "root" };
-};
-
-const normalizeRange = (
-  range: number | [number, number],
-  limit: number
-): [number, number] => {
-  if (Array.isArray(range)) return range;
-  if (range >= 0) return [0, range];
-  return [limit + 1 - Math.abs(range), limit];
-};
-
-const within = (range: [number, number], value: number): boolean =>
-  value >= range[0] && value <= range[1];
-
-/**
- * Formats a string by hiding specific digits within a given range.
- *
- * 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 value - The input string to be formatted.
- * @param options - Configuration options for formatting.
- * @param 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 options.hider - The character used to hide digits. Defaults to `"*"`.
- *
- * @returns The formatted string with specified digits hidden.
- *
- * @example
- * ```typescript
- * import { formatToHiddenDigits } from "./formatToHiddenDigits";
- *
- * formatToHiddenDigits("123-456-7890", { range: 3 });
- * // Output: "***-456-7890"
- *
- * formatToHiddenDigits("123-456-7890", { range: [4, 6], hider: "#" });
- * // Output: "123-###-7890"
- * ```
- */
-
-const formatToHiddenDigits: FormatToHiddenDigitsFunction = (value, options) => {
-  const characters = parseToCharacters(value);
-  const range = normalizeRange(options.range ?? 3, characters.digits);
-  return characters.children
-    .map((node) => {
-      if (node.kind === "digit" && within(range, node.digit))
-        return options.hider ?? "*";
-      return node.character;
-    })
-    .join("");
-};
-
-export { formatToHiddenDigits };

package/src/formats/formatToPhone.ts

@@ -1,170 +0,0 @@
-import { countries } from "@arkyn/templates";
-
-import { removeNonNumeric } from "../services/removeNonNumeric";
-
-type CountryType = {
-  name: string;
-  code: string;
-  iso: string;
-  prefix: null | string;
-  flag: string;
-  mask: string;
-};
-
-type FormatToPhoneFunction = (prop: string) => string;
-
-function getMask(value: string): "NINE" | "EIGTH" {
-  const mask = value.length > 10 ? "NINE" : "EIGTH";
-  return mask;
-}
-
-const TYPES = {
-  EIGTH: "(99) 9999-9999",
-  NINE: "(99) 99999-9999",
-};
-
-const MAX_LENGTH = removeNonNumeric(TYPES.NINE).length;
-
-function applyMask(value: string, maskPattern: string) {
-  let result = "";
-  let digitIndex = 0;
-
-  for (let i = 0; i < maskPattern.length; i++) {
-    if (maskPattern[i] === "9") {
-      if (digitIndex < value.length) {
-        result += value[digitIndex];
-        digitIndex++;
-      } else {
-        break;
-      }
-    } else {
-      if (digitIndex < value.length) {
-        result += maskPattern[i];
-      } else {
-        break;
-      }
-    }
-  }
-
-  return result;
-}
-
-function formatPhoneNumber(phoneNumber: string, country: CountryType): string {
-  if (country.code === "+55") {
-    let value = removeNonNumeric(phoneNumber);
-    const mask = getMask(value);
-
-    let nextLength = value.length;
-    if (nextLength > MAX_LENGTH) return value;
-
-    value = applyMask(value, TYPES[mask] as "EIGTH" | "NINE");
-    return value;
-  }
-
-  const mask = country.mask;
-  let formattedNumber = mask;
-
-  if (country.prefix) {
-    const prefixRegex = /\$+/g;
-    formattedNumber = formattedNumber.replace(prefixRegex, country.prefix);
-  }
-
-  for (
-    let i = 0, j = 0;
-    i < formattedNumber.length && j < phoneNumber.length;
-    i++
-  ) {
-    if (formattedNumber[i] === "_") {
-      formattedNumber =
-        formattedNumber.substring(0, i) +
-        phoneNumber[j] +
-        formattedNumber.substring(i + 1);
-      j++;
-    }
-  }
-
-  return formattedNumber;
-}
-
-function getCountryWithPrefixCode(countryCode: string, prefix: string) {
-  const country = countries.find(
-    (country) => country.code === countryCode && country.prefix === prefix
-  );
-
-  if (!country) throw new Error("Invalid country code or prefix");
-
-  if (country.prefix !== prefix) {
-    throw new Error("Invalid country code or prefix");
-  }
-
-  if (!country.prefix) {
-    throw new Error("Invalid country code or prefix");
-  }
-  return country;
-}
-
-function getCountryWithoutPrefixCode(countryCode: string) {
-  const country = countries.find((country) => country.code === countryCode);
-  if (!country) throw new Error("Invalid country code");
-  if (country.prefix) throw new Error("Invalid country code");
-  return country;
-}
-
-/**
- * Formats a phone number string based on the provided country code and optional prefix.
- *
- * The input string should follow the format: `"<countryCode>-<prefix> <phoneNumber>"` or `"<countryCode> <phoneNumber>"`.
- * The function determines the appropriate formatting mask based on the country and applies it to the phone number.
- *
- * @param prop - The phone number string to be formatted. It must include the country code and optionally a prefix.
- *               Example formats:
- *               - "+55 32912345678"
- *               - "+1 1234567890"
- *
- * @returns The formatted phone number string based on the country's formatting rules.
- *
- * @throws {Error} If the input phone number does not match the expected format.
- * @throws {Error} If the country code or phone number is missing from the input string.
- * @throws {Error} If the provided country code and prefix combination is invalid.
- * @throws {Error} If the provided country code is invalid.
- * @throws {Error} If the provided country code has a prefix but none is supplied in the input.
- *
- * @example
- * ```typescript
- * import { formatToPhone } from "./formatToPhone";
- *
- * const formattedPhone1 = formatToPhone("+55 11912345678");
- * console.log(formattedPhone1); // Output: "(11) 91234-5678" (brazilian phone number format)
- *
- * const formattedPhone2 = formatToPhone("+1-123 4567890");
- * console.log(formattedPhone2); // Output: "(123) 456-7890" (us phone number format)
- * ```
- */
-
-const formatToPhone: FormatToPhoneFunction = (prop) => {
-  const phoneRegex = /^\+\d{1,4}(-\d{1,4})? \d+$/;
-
-  if (!phoneRegex.test(prop)) {
-    throw new Error(
-      "Invalid phone number format. Expected format: +<countryCode>-<optionalPrefix> <phoneNumber>"
-    );
-  }
-
-  const countryCode = prop.split(" ")[0].split("-")[0];
-  const prefixCode = prop.split(" ")[0].split("-")[1];
-  const phoneNumber = prop.split(" ")[1];
-
-  if (!countryCode || !phoneNumber) {
-    throw new Error("Invalid phone number format");
-  }
-
-  if (prefixCode) {
-    const country = getCountryWithPrefixCode(countryCode, prefixCode);
-    return formatPhoneNumber(phoneNumber, country);
-  }
-
-  const country = getCountryWithoutPrefixCode(countryCode);
-  return formatPhoneNumber(phoneNumber, country);
-};
-
-export { formatToPhone };

package/src/generators/generateColorByString.ts

@@ -1,33 +0,0 @@
-type GenerateColorByStringFunction = (prop: string) => string;
-
-/**
- * Generates a hexadecimal color code based on the input string.
- * 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 prop - The input string used to generate the color.
- * @returns A hexadecimal color code (e.g., "#a1b2c3") derived from the input string.
- * @example
- * const color = generateColorByString("example");
- * console.log(color); // Outputs a consistent hex color like "#5e8f9a"
- */
-
-const generateColorByString: GenerateColorByStringFunction = (prop) => {
-  var hash = 0;
-
-  for (var i = 0; i < prop.length; i++) {
-    hash = prop.charCodeAt(i) + ((hash << 5) - hash);
-  }
-
-  var red = (hash & 0xff0000) >> 16;
-  var green = (hash & 0x00ff00) >> 8;
-  var blue = hash & 0x0000ff;
-
-  var redHex = red.toString(16).padStart(2, "0");
-  var greenHex = green.toString(16).padStart(2, "0");
-  var blueHex = blue.toString(16).padStart(2, "0");
-
-  return "#" + redHex + greenHex + blueHex;
-};
-
-export { generateColorByString };

package/src/generators/generateId.ts

@@ -1,61 +0,0 @@
-import { v4, v7 } from "uuid";
-
-function hexToBin(hex: string) {
-  hex = hex.replace(/-/g, "");
-  const buffer = new Uint8Array(hex.length / 2);
-
-  for (let i = 0; i < hex.length; i += 2) {
-    buffer[i / 2] = parseInt(hex.substring(i, i + 2), 16);
-  }
-
-  return buffer;
-}
-
-function uuidV4() {
-  const uuid = v4();
-  return { text: uuid, binary: hexToBin(uuid) };
-}
-
-function uuidV7() {
-  const uuid = v7();
-  return { text: uuid, binary: hexToBin(uuid) };
-}
-
-/**
- * Generates a unique identifier (UUID) in the specified format and type.
- *
- * @param 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 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 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.
- *
- * @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([...])
- */
-function generateId(type: "text", format: "v4" | "v7"): string;
-function generateId(type: "binary", format: "v4" | "v7"): Uint8Array;
-function generateId(
-  type: "text" | "binary",
-  format: "v4" | "v7"
-): string | Uint8Array {
-  if (type === "text" && format === "v4") return uuidV4().text;
-  if (type === "binary" && format === "v4") return uuidV4().binary;
-  if (type === "text" && format === "v7") return uuidV7().text;
-  if (type === "binary" && format === "v7") return uuidV7().binary;
-  throw new Error("Invalid type or format");
-}
-
-export { generateId };

package/src/generators/generateSlug.ts

@@ -1,31 +0,0 @@
-/**
- * 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: string) {
-  let slug = prop.normalize("NFD").replace(/[\u0300-\u036f]/g, "");
-
-  slug = slug
-    .replace(/[^\w\s-]/g, "")
-    .replace(/\s+/g, "-")
-    .toLowerCase();
-
-  slug = slug.replace(/-{2,}/g, "-");
-
-  slug = slug.replace(/^-+|-+$/g, "");
-
-  return slug;
-}
-
-export { generateSlug };

package/src/index.ts

@@ -1,36 +0,0 @@
-// formats
-export { formatDate } from "./formats/formatDate";
-export { formatJsonObject } from "./formats/formatJsonObject";
-export { formatJsonString } from "./formats/formatJsonString";
-export { formatToCep } from "./formats/formatToCep";
-export { formatToCnpj } from "./formats/formatToCnpj";
-export { formatToCpf } from "./formats/formatToCpf";
-export { formatToCpfCnpj } from "./formats/formatToCpfCnpj";
-export { formatToCurrency } from "./formats/formatToCurrency";
-export { formatToDate } from "./formats/formatToDate";
-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";
-
-// services
-export { calculateCardInstallment } from "./services/calculateCardInstallment";
-export { ensureQuotes } from "./services/ensureQuotes";
-export { maskSensitiveData } from "./services/maskSensitiveData";
-export { removeCurrencySymbols } from "./services/removeCurrencySymbols";
-export { removeNonNumeric } from "./services/removeNonNumeric";
-export { stripHtmlTags } from "./services/stripHtmlTags";
-export { truncateLargeFields } from "./services/truncateLargeFields";
-
-// utils
-export { validateCep } from "./validations/validateCep";
-export { validateCnpj } from "./validations/validateCnpj";
-export { validateCpf } from "./validations/validateCpf";
-export { validateDate } from "./validations/validateDate";
-export { validatePassword } from "./validations/validatePassword";
-export { validatePhone } from "./validations/validatePhone";
-export { validateRg } from "./validations/validateRg";