eai-frontend-components 2.0.20 → 2.0.21

package/dist/index.js

@@ -792,6 +792,20 @@ const removeMaskNumber = (value) => {
 };
 
 // PHONE
+/**
+ * Formats a phone number string with proper mask.
+ * Automatically detects landline vs mobile format.
+ *
+ * @param telefone - Raw phone number string
+ * @param removerCountryCode - Whether to remove country code (55) if present
+ * @returns Formatted phone number string
+ *
+ * @example
+ * ```tsx
+ * formatPhone('11987654321') // '(11) 9 8765-4321'
+ * formatPhone('1134567890')  // '(11) 3456-7890'
+ * ```
+ */
 function formatPhone(telefone, removerCountryCode = true) {
     if (!telefone)
         return '';
@@ -803,6 +817,19 @@ function formatPhone(telefone, removerCountryCode = true) {
     return mask.format(numberPhone, maskPhone(numberPhone));
 }
 // CPF/CNPJ
+/**
+ * Formats a CPF or CNPJ string with proper mask.
+ * Automatically detects CPF vs CNPJ format based on length.
+ *
+ * @param cpfCnpj - Raw CPF/CNPJ string
+ * @returns Formatted CPF/CNPJ string
+ *
+ * @example
+ * ```tsx
+ * formatCpfCnpj('12345678901')    // '123.456.789-01'
+ * formatCpfCnpj('12345678000195') // '12.345.678/0001-95'
+ * ```
+ */
 function formatCpfCnpj(cpfCnpj) {
     if (!cpfCnpj)
         return '';
@@ -819,6 +846,19 @@ function getMonth(date) {
 function getYear(date) {
     return date.getFullYear().toString();
 }
+/**
+ * Formats a date to Brazilian format (DD/MM/YYYY).
+ *
+ * @param date - Date string, Date object, or undefined
+ * @param separator - Date separator (default: '/')
+ * @returns Formatted date string in Brazilian format
+ *
+ * @example
+ * ```tsx
+ * formatDate('2023-12-25')      // '25/12/2023'
+ * formatDate(new Date())        // '13/10/2025'
+ * ```
+ */
 const formatDate = (date, separator = '/') => {
     if (!date)
         return '';
@@ -890,6 +930,19 @@ const formatNumber = (value) => {
     });
 };
 // DECIMAL
+/**
+ * Formats a number with Brazilian decimal format.
+ *
+ * @param value - Numeric value to format
+ * @param decimalPlaces - Number of decimal places (default: 2)
+ * @returns Formatted decimal string
+ *
+ * @example
+ * ```tsx
+ * formatDecimal(1234.56)   // '1.234,56'
+ * formatDecimal(1000.1, 1) // '1.000,1'
+ * ```
+ */
 const formatDecimal = (value, decimalPlaces = 2) => {
     return value.toLocaleString('pt-BR', {
         style: 'decimal',
@@ -897,6 +950,87 @@ const formatDecimal = (value, decimalPlaces = 2) => {
         maximumFractionDigits: decimalPlaces,
     });
 };
+// PERCENT
+/**
+ * Formats a number as percentage with Brazilian decimal format.
+ *
+ * @param value - Numeric value to format
+ * @param decimalPlaces - Number of decimal places (default: 2)
+ * @returns Formatted percentage string
+ *
+ * @example
+ * ```tsx
+ * formatPercent(15.5)    // '% 15,50'
+ * formatPercent(100, 0)  // '% 100'
+ * ```
+ */
+const formatPercent = (value, decimalPlaces = 2) => {
+    return `% ${formatDecimal(value, decimalPlaces)}`;
+};
+// CURRENCY
+/**
+ * Formats a number as Brazilian currency (BRL).
+ *
+ * @param value - Numeric value to format
+ * @param decimalPlaces - Number of decimal places (default: 2)
+ * @returns Formatted currency string
+ *
+ * @example
+ * ```tsx
+ * formatCurrency(1234.56)  // 'R$ 1.234,56'
+ * formatCurrency(1000, 0)  // 'R$ 1.000'
+ * ```
+ */
+const formatCurrency = (value, decimalPlaces = 2) => {
+    return value.toLocaleString('pt-BR', {
+        style: 'currency',
+        currency: 'BRL',
+        minimumFractionDigits: decimalPlaces,
+        maximumFractionDigits: decimalPlaces,
+    });
+};
+const isInvalidCurrencyValue = (rawValue) => {
+    if (!rawValue || rawValue.trim() === '')
+        return true;
+    const numericValue = stringToNumber(rawValue);
+    return Number.isNaN(numericValue) || numericValue <= 0;
+};
+// OTHERS
+/**
+ * Formats an MSISDN (mobile phone number) to display format.
+ *
+ * @param value - Raw MSISDN string
+ * @returns Formatted MSISDN string
+ *
+ * @example
+ * ```tsx
+ * formatMsisdn('5511987654321') // '(11) 98765-4321'
+ * ```
+ */
+function formatMsisdn(value = '') {
+    const msisdn = value.replace(/\D/g, '');
+    return `(${msisdn.slice(2, 4)}) ${msisdn.slice(4, 9)}-${msisdn.slice(9)}`;
+}
+/**
+ * Formats a CEP (Brazilian postal code) with proper mask.
+ *
+ * @param cep - Raw CEP string
+ * @returns Formatted CEP string (XXXXX-XXX)
+ *
+ * @example
+ * ```tsx
+ * formatCEP('01234567') // '01234-567'
+ * formatCEP('12345')    // '12345'
+ * ```
+ */
+function formatCEP(cep) {
+    if (!cep)
+        return '';
+    return cep
+        .replace(/\D/g, '')
+        .replace(/(\d{5})(\d)/, '$1-$2')
+        .replace(/(-\d{3})\d+?$/, '$1');
+}
 
 function buildFormatLongFn(args) {
   return (options = {}) => {
@@ -3723,17 +3857,22 @@ exports.formHelpText = formHelpText;
 exports.formLabel = formLabel;
 exports.formLabelAndSubLabel = formLabelAndSubLabel;
 exports.formMessage = formMessage;
+exports.formatCEP = formatCEP;
 exports.formatCpfCnpj = formatCpfCnpj;
+exports.formatCurrency = formatCurrency;
 exports.formatDate = formatDate;
 exports.formatDateCalendar = formatDateCalendar;
 exports.formatDateTime = formatDateTime;
 exports.formatDecimal = formatDecimal;
+exports.formatMsisdn = formatMsisdn;
 exports.formatNumber = formatNumber;
+exports.formatPercent = formatPercent;
 exports.formatPhone = formatPhone;
 exports.getFirstDayOf90DaysAgo = getFirstDayOf90DaysAgo;
 exports.getFirstDayOfCurrentMonth = getFirstDayOfCurrentMonth;
 exports.getTailwindColorShades = getTailwindColorShades;
 exports.invertDate = invertDate;
+exports.isInvalidCurrencyValue = isInvalidCurrencyValue;
 exports.isUUIDv4 = isUUIDv4;
 exports.maskCpfCnpj = maskCpfCnpj;
 exports.maskPhone = maskPhone;