@sankhyalabs/core 2.3.6 → 2.4.0

package/dist/utils/DateUtils.js

@@ -1,8 +1,28 @@
+/**
+ * `DateUtils`: Utilizado para formatação, padronização e cálculos de datas.
+ */
 export default class DateUtils {
+    /**
+    * Zerar o horário de uma data.
+    *
+    * @param date - Data a ser manipulada.
+    * @param adjustDayLightSavingTime - Ajusta horário de verão na data recebida.
+    * @returns - Data sem as informações de horário.
+    * @example
+    * Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
+    */
     static clearTime(date, adjustDayLightSavingTime = true) {
         const newDate = new Date(date.getFullYear(), date.getMonth(), date.getDate(), 0, 0, 0, 0);
         return adjustDayLightSavingTime ? DateUtils.adjustDLST(newDate) : newDate;
     }
+    /**
+     * Converte String para Date.
+     *
+     * @param strValue - Texto a ser convertido para data.
+     * @param adjustDayLightSavingTime - Se verdadeiro, ativa regra de horário de verão.
+     * @param monthYearMode - Quando ativado, retorna o primeiro dia do mês apenas para construir a data.
+     * @returns - Data sem as informações de horário.
+     */
     static strToDate(strValue, adjustDayLightSavingTime = true, monthYearMode = false) {
         /** monthYearMode é um booleano para usar o formato MM/YYYY.
          * Quando ativado, é retornado o primeiro dia do mês apenas para construir a data.
@@ -32,6 +52,12 @@ export default class DateUtils {
         }
         return date;
     }
+    /**
+     * Obtém a data atual.
+     *
+     * @param withTime - Caso true retorna a data com informações de horário.
+     * @returns - Data atual sem informação de horário.
+     */
     static getToday(withTime = false) {
         const today = new Date();
         if (withTime) {
@@ -41,21 +67,49 @@ export default class DateUtils {
             return DateUtils.clearTime(today);
         }
     }
+    /**
+     * Retorna se a data é válida.
+     *
+     * @param value - Data a ser validada.
+     * @param hasTime - Determina se a data retornada deve conter informação de horário ou não. Por padrão não retorna a hora.
+     * @returns - Caso válida, retorna a própria data.
+     */
     static validateDate(value, hasTime = false) {
         return value instanceof Date && !isNaN(value.valueOf())
             ? hasTime ? value : DateUtils.clearTime(value)
             : undefined;
     }
+    /**
+     * Realiza correção do horário de verão.
+     *
+     * @param date - Data a ser ajustada.
+     * @returns - Data informada ajustada para horário de verão.
+     */
     static adjustDLST(date) {
-        //Work around para corrigir o Bug do horário de verão.
         if (date.getHours() == 23) {
             return new Date(date.getFullYear(), date.getMonth(), date.getDate() + 1, 1, 0, 0, 0);
         }
         return date;
     }
+    /**
+     * Adiciona uma casa decimal a esquerda de uma unidade.
+     *
+     * @param n - Número a ser ajustado
+     * @returns - O número informado, com uma casa decimal a esquerda.
+     * @example
+     * Informo: 15     | Obtenho: 15
+     * @example
+     * Informo:  2     | Obtenho: "02"
+     */
     static pad(n) {
         return n < 10 ? "0" + n : n;
     }
+    /**
+     * Retorna timezone da data.
+     *
+     * @param offset - Valor do timezone desejado.
+     * @returns Timezone da data.
+     */
     static timezoneOffset(offset) {
         let sign;
         if (offset === 0) {
@@ -65,6 +119,14 @@ export default class DateUtils {
         offset = Math.abs(offset);
         return sign + this.pad(Math.floor(offset / 60)) + ":" + this.pad(offset % 60);
     }
+    /**
+     * Converte a data para o formato RFC3339.
+     *
+     * @param date - Data a ser convertida
+     * @returns - Data informada no formato RFC3339.
+     * * @example
+     * Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
+     */
     static formatRfc3339(date) {
         return date.getFullYear() + "-" +
             this.pad(date.getMonth() + 1) + "-" +

package/dist/utils/DateUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"DateUtils.js","sourceRoot":"","sources":["../../src/utils/DateUtils.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,SAAS;IAEnB,MAAM,CAAC,SAAS,CAAC,IAAS,EAAE,2BAAmC,IAAI;QACtE,MAAM,OAAO,GAAS,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChG,OAAO,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,QAAe,EAAE,2BAAmC,IAAI,EAAE,gBAAwB,KAAK;QAC3G;;4FAEoF;QAEpF,IAAI,KAAK,CAAC;QAEV,IAAI,aAAa,EAAE;YACf,KAAK,GAAG,iFAAiF,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC5G;aAAK;YACF,KAAK,GAAG,mHAAmH,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC9I;QACD,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,GAAG,GAAY,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAU,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,IAAI,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,MAAM,GAAG,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,MAAM,GAAG,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAElE,IAAI,IAAI,GAAG,GAAG,EAAE;YACZ,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;SACnC;QAED,IAAI,IAAI,GAAS,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAEnE,IAAI,wBAAwB,KAAK,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,CAAC,EAAE;YAClE,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACrC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,WAAoB,KAAK;QAC5C,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;QAEzB,IAAI,QAAQ,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;aAAM;YACH,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SACrC;IACL,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAW,EAAE,UAAmB,KAAK;QAC9D,OAAO,KAAK,YAAY,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACrD,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;YAC9C,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,IAAS;QAE/B,sDAAsD;QACtD,IAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAC;YACrB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACxF;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,GAAG,CAAC,CAAS;QACxB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAc;QACxC,IAAI,IAAI,CAAC;QAET,IAAI,MAAM,KAAK,CAAC,EAAE;YACd,OAAO,GAAG,CAAC;SACd;QAED,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAChC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAE1B,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAClF,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,IAAU;QAElC,OAAO,IAAI,CAAC,WAAW,EAAE,GAAG,GAAG;YAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG;YACnC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,GAAG;YAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,GAAG;YAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG;YACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF"}
+{"version":3,"file":"DateUtils.js","sourceRoot":"","sources":["../../src/utils/DateUtils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAEzB;;;;;;;;MAQE;IACI,MAAM,CAAC,SAAS,CAAC,IAAS,EAAE,2BAAmC,IAAI;QACtE,MAAM,OAAO,GAAS,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChG,OAAO,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAC,QAAe,EAAE,2BAAmC,IAAI,EAAE,gBAAwB,KAAK;QAC3G;;4FAEoF;QAEpF,IAAI,KAAK,CAAC;QAEV,IAAI,aAAa,EAAE;YACf,KAAK,GAAG,iFAAiF,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC5G;aAAK;YACF,KAAK,GAAG,mHAAmH,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC9I;QACD,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,GAAG,GAAY,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAU,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,IAAI,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,MAAM,GAAG,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAClE,MAAM,GAAG,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAElE,IAAI,IAAI,GAAG,GAAG,EAAE;YACZ,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;SACnC;QAED,IAAI,IAAI,GAAS,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAEnE,IAAI,wBAAwB,KAAK,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,CAAC,EAAE;YAClE,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACrC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,WAAoB,KAAK;QAC5C,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC;QAEzB,IAAI,QAAQ,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;aAAM;YACH,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SACrC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CAAC,KAAW,EAAE,UAAmB,KAAK;QAC9D,OAAO,KAAK,YAAY,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACrD,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;YAC9C,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,UAAU,CAAC,IAAS;QAE/B,IAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAC;YACrB,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACxF;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACK,MAAM,CAAC,GAAG,CAAC,CAAS;QACxB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,cAAc,CAAC,MAAc;QACxC,IAAI,IAAI,CAAC;QAET,IAAI,MAAM,KAAK,CAAC,EAAE;YACd,OAAO,GAAG,CAAC;SACd;QAED,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAChC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAE1B,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,IAAU;QAElC,OAAO,IAAI,CAAC,WAAW,EAAE,GAAG,GAAG;YAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG;YACnC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,GAAG;YAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,GAAG;YAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG;YACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF"}

package/dist/utils/ElementIDUtils.d.ts

@@ -3,16 +3,67 @@ export interface IElementIDInfo {
     id?: string;
     dataUnit?: DataUnit;
 }
+/**
+ * `ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id. A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
+ */
 export declare class ElementIDUtils {
     static DATA_ELEMENT_ID_ATTRIBUTE_NAME: string;
     static INTERNAL_INPUT_NAME: string;
+    /**
+    * Cria e adiciona a propriedade `data-element-id` em um elemento.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param suffix - Sufixo/Texto para ser adicionado.
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - O data-element-id gerado.
+    */
     static addIDInfo(element: HTMLElement, suffix?: string, iDInfo?: IElementIDInfo): string;
     static addIDInfoIfNotExists(element: HTMLElement, suffix?: string, iDInfo?: IElementIDInfo): string;
     static getInternalIDInfo(originalID: string, sufix: string): string;
+    /**
+    * Obtém o `data-element-id` do elemento com adição do sufixo e ID.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param suffix - Sufixo/Texto para ser adicionado.
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - Atributo `data-element-id` do elemento modificado com sufixo e/ou ID.
+    */
     private static getDataElementID;
+    /**
+    * Obtém ID válido para o elemento.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - ID para ser adicionado ao elemento conforme ordem de prioridade.
+    */
     private static getAttributeValid;
+    /**
+    * Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para montar a hierarquia dos ids dos componentes em tela.
+    *
+    * @param dataElementID - ID para ser adicionado ao `data-element-id`.
+    * @param suffix - Sufixo/Texto para ser adicionado ao `data-element-id`.
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @returns - `data-element-id` com sufixo.
+    *
+    * @example
+    * Um ez-combo-box tem data-element-id = codparc_input_internal_combo.
+    * Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_internal_combo' referente ao seu pai.
+    */
     private static addSuffix;
+    /**
+    * Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
+    *
+    * @param iDInfo - ID para ser adicionado ao `data-element-id`.
+    * @param dataElementID - Sufixo/Texto para ser adicionado ao `data-element-id`.
+    * @returns - String contendo informação para ser usada no `data-element-id` do elemento.
+    */
     private static addPrefix;
+    /**
+    * Remove caracteres especiais.
+    *
+    * @param value - Texto que terá os caracteres especiais removidos.
+    * @returns - Retorna a string sem caracteres especiais e em camelCase.
+    */
     private static formatDescription;
     private static getDataElementIDAttribute;
 }

package/dist/utils/ElementIDUtils.js

@@ -1,5 +1,16 @@
 import { StringUtils } from "./StringUtils.js";
+/**
+ * `ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id. A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
+ */
 export class ElementIDUtils {
+    /**
+    * Cria e adiciona a propriedade `data-element-id` em um elemento.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param suffix - Sufixo/Texto para ser adicionado.
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - O data-element-id gerado.
+    */
     static addIDInfo(element, suffix, iDInfo) {
         let dataElementID = this.getDataElementID(element, suffix, iDInfo);
         dataElementID = StringUtils.replaceAccentuatedChars(dataElementID, false);
@@ -17,6 +28,14 @@ export class ElementIDUtils {
     static getInternalIDInfo(originalID, sufix) {
         return `${originalID}_${ElementIDUtils.INTERNAL_INPUT_NAME}_${sufix}`;
     }
+    /**
+    * Obtém o `data-element-id` do elemento com adição do sufixo e ID.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param suffix - Sufixo/Texto para ser adicionado.
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - Atributo `data-element-id` do elemento modificado com sufixo e/ou ID.
+    */
     static getDataElementID(element, suffix, iDInfo) {
         let dataElementID = ElementIDUtils.getDataElementIDAttribute(element);
         if (dataElementID != null) {
@@ -31,6 +50,13 @@ export class ElementIDUtils {
         element.setAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME, tagName);
         return tagName;
     }
+    /**
+    * Obtém ID válido para o elemento.
+    *
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @param iDInfo - ID para ser adicionado.
+    * @returns - ID para ser adicionado ao elemento conforme ordem de prioridade.
+    */
     static getAttributeValid(element, iDInfo) {
         if (iDInfo === null || iDInfo === void 0 ? void 0 : iDInfo.id) {
             return StringUtils.toCamelCase(iDInfo === null || iDInfo === void 0 ? void 0 : iDInfo.id);
@@ -52,6 +78,18 @@ export class ElementIDUtils {
         }
         return null;
     }
+    /**
+    * Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para montar a hierarquia dos ids dos componentes em tela.
+    *
+    * @param dataElementID - ID para ser adicionado ao `data-element-id`.
+    * @param suffix - Sufixo/Texto para ser adicionado ao `data-element-id`.
+    * @param element - Elemento HTML a ser modificado (HTMLElement).
+    * @returns - `data-element-id` com sufixo.
+    *
+    * @example
+    * Um ez-combo-box tem data-element-id = codparc_input_internal_combo.
+    * Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_internal_combo' referente ao seu pai.
+    */
     static addSuffix(dataElementID, suffix, element) {
         if (suffix) {
             return `${dataElementID}_${StringUtils.toCamelCase(suffix)}`;
@@ -61,6 +99,13 @@ export class ElementIDUtils {
         }
         return `${dataElementID}_${StringUtils.toCamelCase(element.tagName)}`;
     }
+    /**
+    * Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
+    *
+    * @param iDInfo - ID para ser adicionado ao `data-element-id`.
+    * @param dataElementID - Sufixo/Texto para ser adicionado ao `data-element-id`.
+    * @returns - String contendo informação para ser usada no `data-element-id` do elemento.
+    */
     static addPrefix(iDInfo, dataElementID) {
         var _a;
         const dataUnitName = ((_a = iDInfo === null || iDInfo === void 0 ? void 0 : iDInfo.dataUnit) === null || _a === void 0 ? void 0 : _a.name) || "";
@@ -69,6 +114,12 @@ export class ElementIDUtils {
         }
         return dataElementID;
     }
+    /**
+    * Remove caracteres especiais.
+    *
+    * @param value - Texto que terá os caracteres especiais removidos.
+    * @returns - Retorna a string sem caracteres especiais e em camelCase.
+    */
     static formatDescription(value) {
         if (!value)
             return "";

package/dist/utils/ElementIDUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElementIDUtils.js","sourceRoot":"","sources":["../../src/utils/ElementIDUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAQ/C,MAAM,OAAO,cAAc;IAKlB,MAAM,CAAC,SAAS,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QACpF,IAAI,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACnE,aAAa,GAAG,WAAW,CAAC,uBAAuB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAC1E,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACtD,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,EAAE,aAAa,CAAC,CAAC;QAEnF,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QAE/F,IAAI,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;QAExF,IAAG,aAAa,IAAI,SAAS,EAAC;YAC5B,aAAa,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;SAClE;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,UAAkB,EAAE,KAAa;QAC/D,OAAO,GAAG,UAAU,IAAI,cAAc,CAAC,mBAAmB,IAAI,KAAK,EAAE,CAAC;IACxE,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QAC5F,IAAI,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACtE,IAAG,aAAa,IAAI,IAAI,EAAC;YACvB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAE,aAAwB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SAC5F;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE/D,IAAG,cAAc;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAG,MAAM;YAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,OAAO,GAAG,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;QAE7E,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,OAAoB,EAAE,MAAuB;QAC5E,IAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,EAAC;YACZ,OAAO,WAAW,CAAC,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAC,CAAC;SAC5C;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAC;YACzC,OAAO,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAW,CAAC,CAAC;SACnF;QAED,IAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,EAAC;YACb,OAAO,WAAW,CAAC,WAAW,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,CAAC,CAAC;SAC7C;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAC;YAC9B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;SAC7D;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAC;YAC/B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9D;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAC;YAC/B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,aAA4B,EAAE,MAA0B,EAAE,OAAoB;QACrG,IAAG,MAAM,EAAC;YACR,OAAO,GAAG,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;SAC9D;QACD,IAAG,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,EAAC;YACpC,OAAO,GAAG,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;SACtD;QACD,OAAO,GAAG,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACxE,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,MAAkC,EAAE,aAAqB;;QAChF,MAAM,YAAY,GAAW,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,0CAAE,IAAI,KAAI,EAAE,CAAC;QAC1D,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,KAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,CAAC,YAAY,CAAC,CAAA,EAAE;YAChE,aAAa,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,aAAa,EAAE,CAAA;SAC5E;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,KAAoB;QACnD,IAAG,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QACrB,OAAO,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACzG,CAAC;IAEO,MAAM,CAAC,yBAAyB,CAAC,OAAoB;QAC3D,IAAI,OAAe,CAAC,cAAc,CAAC,8BAA8B,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,EAAE;YACzI,OAAQ,OAAe,CAAC,cAAc,CAAC,8BAA8B,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;SAC/I;QACD,OAAO,IAAI,CAAC;IACd,CAAC;;AApGa,6CAA8B,GAAW,iBAAiB,CAAC;AAC3D,kCAAmB,GAAW,UAAU,CAAC"}
+{"version":3,"file":"ElementIDUtils.js","sourceRoot":"","sources":["../../src/utils/ElementIDUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAO/C;;GAEG;AACH,MAAM,OAAO,cAAc;IAIzB;;;;;;;MAOE;IACK,MAAM,CAAC,SAAS,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QACpF,IAAI,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACnE,aAAa,GAAG,WAAW,CAAC,uBAAuB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAC1E,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACtD,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,EAAE,aAAa,CAAC,CAAC;QAEnF,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QAC/F,IAAI,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;QAExF,IAAG,aAAa,IAAI,SAAS,EAAC;YAC5B,aAAa,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;SAClE;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,UAAkB,EAAE,KAAa;QAC/D,OAAO,GAAG,UAAU,IAAI,cAAc,CAAC,mBAAmB,IAAI,KAAK,EAAE,CAAC;IACxE,CAAC;IAED;;;;;;;MAOE;IACM,MAAM,CAAC,gBAAgB,CAAC,OAAoB,EAAE,MAAe,EAAE,MAAuB;QAC5F,IAAI,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QACtE,IAAG,aAAa,IAAI,IAAI,EAAC;YACvB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAE,aAAwB,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SAC5F;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE/D,IAAG,cAAc;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAG,MAAM;YAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,OAAO,GAAG,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;QAE7E,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;MAME;IACM,MAAM,CAAC,iBAAiB,CAAC,OAAoB,EAAE,MAAuB;QAC5E,IAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,EAAC;YACZ,OAAO,WAAW,CAAC,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAC,CAAC;SAC5C;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAC;YACzC,OAAO,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAW,CAAC,CAAC;SACnF;QAED,IAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,EAAC;YACb,OAAO,WAAW,CAAC,WAAW,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,CAAC,CAAC;SAC7C;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAC;YAC9B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;SAC7D;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAC;YAC/B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9D;QAED,IAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAC;YAC/B,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;MAWE;IACM,MAAM,CAAC,SAAS,CAAC,aAA4B,EAAE,MAA0B,EAAE,OAAoB;QACrG,IAAG,MAAM,EAAC;YACR,OAAO,GAAG,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;SAC9D;QACD,IAAG,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,EAAC;YACpC,OAAO,GAAG,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;SACtD;QACD,OAAO,GAAG,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;IACxE,CAAC;IAED;;;;;;MAME;IACM,MAAM,CAAC,SAAS,CAAC,MAAkC,EAAE,aAAqB;;QAChF,MAAM,YAAY,GAAW,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,0CAAE,IAAI,KAAI,EAAE,CAAC;QAC1D,IAAI,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,KAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,CAAC,YAAY,CAAC,CAAA,EAAE;YAChE,aAAa,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,aAAa,EAAE,CAAA;SAC5E;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;MAKE;IACM,MAAM,CAAC,iBAAiB,CAAC,KAAoB;QACnD,IAAG,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QACrB,OAAO,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACzG,CAAC;IAEO,MAAM,CAAC,yBAAyB,CAAC,OAAoB;QAC3D,IAAI,OAAe,CAAC,cAAc,CAAC,8BAA8B,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,EAAE;YACzI,OAAQ,OAAe,CAAC,cAAc,CAAC,8BAA8B,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;SAC/I;QACD,OAAO,IAAI,CAAC;IACd,CAAC;;AAnJa,6CAA8B,GAAW,iBAAiB,CAAC;AAC3D,kCAAmB,GAAW,UAAU,CAAC"}

package/dist/utils/MaskFormatter.d.ts

@@ -1,6 +1,6 @@
 /**
  * `MaskFormatter` é usado para formatar strings. Seu comportamento
- * é controlado pela formato do atributo `mask` que especifica quais
+ * é controlado pelo formato do atributo `mask` que especifica quais
  * caracteres são válidos e onde devem estar posicionados, intercalando-os
  * com eventuais caracteres literais expressados no padrão informado.
  * Sua implementação é inspirada pela implementação em Java do [MaskFormatter](https://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html).
@@ -11,7 +11,7 @@
  * |:---------:|-------------------------------------------------------------------------------------------------------------|
  * | #         | Qualquer número                                                                                             |
  * | '         | "Escapa" o caractere que vem na sequência. Útil quando desejamos converter um caractere especial em literal.|
- * | U         | Qualquer letra. Transforma letras maiúsculas em maiúsculas.                                                 |
+ * | U         | Qualquer letra. Transforma letras minúsculas em maiúsculas.                                                 |
  * | L         | Qualquer letra. Transforma letras maiúsculas em minúsculas.                                                 |
  * | A         | Qualquer letra ou número.                                                                                   |
  * | ?         | Qualquer letra. Preserva maiúsculas e minúsculas.                                                           |
@@ -20,12 +20,12 @@
  * Os demais caracteres presentes no padrão serão tratados como literais, isto é,
  * serão apenas inseridos naquela posição.
  *
- * Quando o o valor a ser formatado é menor que a máscara um 'placeHolder'
+ * Quando o valor a ser formatado é menor que a máscara, um 'placeHolder'
  * será inserido em cada posição ausente, completando a formatação.
- * Por padrão será usado um espaço em branco como 'placeHolder' mas
+ * Por padrão será usado um espaço em branco como 'placeHolder', mas
  * esse valor pode ser alterado.
  *
- * For por exemplo:
+ * Por exemplo:
  * '''
  *    const formatter: MaskFormatter = new MaskFormatter("###-####");
  *    formatter.placeholder = '_';
@@ -55,8 +55,8 @@ export declare class MaskFormatter {
     private _mask;
     private _maskChars;
     /**
-     * Determina qual caractere será usado dos caracteres não presentes no valor
-     * ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço
+     * Determina qual caractere será usado dos caracteres não presentes no valor,
+     * ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço.
      */
     placeholder: string;
     /**
@@ -64,7 +64,7 @@ export declare class MaskFormatter {
      */
     set mask(mask: string);
     /**
-     * Getter para mask
+     * Getter para mask.
      *
      * @return A última máscara informada.
      */
@@ -73,12 +73,12 @@ export declare class MaskFormatter {
     /**
      * Formata a string passada baseada na máscara definda pelo atributo mask.
      *
-     * @param value Valor a ser formatado
-     * @return O valor processado de acordo com o padrão
+     * @param value Valor a ser formatado.
+     * @return O valor processado de acordo com o padrão.
      */
     format(value: string): string;
     /**
-     * Preparamos a formatação internamente de acordo com o padrão.
+     * Prepara a formatação internamente de acordo com o padrão.
      */
     private updateInternalMask;
     static MaskCharacter: {
@@ -86,31 +86,52 @@ export declare class MaskFormatter {
             maskFormatter: MaskFormatter;
             type: string;
             /**
-             * Cada subclasse deve sobrescrever o retornando true, caso represente
+             * Cada subclasse deve sobrescrever retornando true caso represente.
              * um caractere literal. Por padrão o retorno é false.
              */
             isLiteral(): boolean;
             /**
-             * Returns true if <code>aChar</code> is a valid reprensentation of
-             * the receiver. The default implementation returns true if the
-             * receiver represents a literal character and <code>getChar</code>
-             * == aChar. Otherwise, this will return true is <code>aChar</code>
-             * is contained in the valid characters and not contained
-             * in the invalid characters.
+             * Retorna se é um texto válido.
+             *
+             * @param aChar - Valor a ser validado.
+             * @returns - Retorna se é um texto válido.
              */
             isValidCharacter(aChar: string): boolean;
             /**
-             * Returns the character to insert for <code>aChar</code>. The
-             * default implementation returns <code>aChar</code>. Subclasses
-             * that wish to do some sort of mapping, perhaps lower case to upper
-             * case should override this and do the necessary mapping.
+             * Retorna o texto informado.
+             *
+             * @param aChar - Texto a ser retornado.
+             * @returns - Texto informado.
              */
             getChar(aChar: string): string;
             /**
-             * Appends the necessary character in <code>formatting</code> at
-             * <code>index</code> to <code>buff</code>.
+             * Adiciona valor encontrado.
+             *
+             * @param result - String a ser manipulada.
+             * @param formatting - String de formatação a ser adicionada na result.
+             * @param index - Índice que será utilizado para buscar no parâmetro formatting.
+             *
+             * @returns - Valor passado na result incrementado com o valor encontrado na formatting.
+             *
+             * @example
+             * ```  const result = "";
+             *       const formatting = "123456";
+             *       const index = [0];
+             *       const returnedResult = append(result, formatting, index);
+             *   ```
+             *   Retorna:
+             *   ```returnedResult = "1";
+             *      index = [1];
+             *   ```
              */
             append(result: string, formatting: string, index: Array<number>): string;
+            /**
+             * Obtém tipo por extenso.
+             *
+             * @returns O tipo por extenso.
+             * @example
+             * Se o tipo for **ALPHA_NUMERIC_KEY** recebo **uma letra ou um número**
+             */
             getFormatMessage(): string;
         };
     };