@sankhyalabs/core-docs 2.3.6 → 2.4.0

package/classes/DateUtils.md

@@ -2,6 +2,8 @@
 
 # Class: DateUtils
 
+`DateUtils`: Utilizado para formatação, padronização e cálculos de datas.
+
 ## Table of contents
 
 ### Constructors
@@ -31,19 +33,23 @@
 
 ▸ `Static` `Private` **adjustDLST**(`date`): `Date`
 
+Realiza correção do horário de verão.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `date` | `Date` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date` | `Date` | Data a ser ajustada. |
 
 #### Returns
 
 `Date`
 
+- Data informada ajustada para horário de verão.
+
 #### Defined in
 
-src/utils/DateUtils.ts:60
+src/utils/DateUtils.ts:101
 
 ___
 
@@ -51,20 +57,30 @@ ___
 
 ▸ `Static` **clearTime**(`date`, `adjustDayLightSavingTime?`): `Date`
 
+Zerar o horário de uma data.
+
+**`Example`**
+
+```ts
+Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
+```
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `date` | `Date` | `undefined` |
-| `adjustDayLightSavingTime` | `boolean` | `true` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `date` | `Date` | `undefined` | Data a ser manipulada. |
+| `adjustDayLightSavingTime` | `boolean` | `true` | Ajusta horário de verão na data recebida. |
 
 #### Returns
 
 `Date`
 
+- Data sem as informações de horário.
+
 #### Defined in
 
-src/utils/DateUtils.ts:3
+src/utils/DateUtils.ts:17
 
 ___
 
@@ -72,19 +88,30 @@ ___
 
 ▸ `Static` **formatRfc3339**(`date`): `string`
 
+Converte a data para o formato RFC3339.
+
+**`Example`**
+
+```ts
+Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
+```
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `date` | `Date` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `date` | `Date` | Data a ser convertida |
 
 #### Returns
 
 `string`
 
+- Data informada no formato RFC3339.
+*
+
 #### Defined in
 
-src/utils/DateUtils.ts:87
+src/utils/DateUtils.ts:151
 
 ___
 
@@ -92,19 +119,23 @@ ___
 
 ▸ `Static` **getToday**(`withTime?`): `Date`
 
+Obtém a data atual.
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `withTime` | `boolean` | `false` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `withTime` | `boolean` | `false` | Caso true retorna a data com informações de horário. |
 
 #### Returns
 
 `Date`
 
+- Data atual sem informação de horário.
+
 #### Defined in
 
-src/utils/DateUtils.ts:44
+src/utils/DateUtils.ts:72
 
 ___
 
@@ -112,19 +143,35 @@ ___
 
 ▸ `Static` `Private` **pad**(`n`): `string` \| `Number`
 
+Adiciona uma casa decimal a esquerda de uma unidade.
+
+**`Example`**
+
+```ts
+Informo: 15     | Obtenho: 15
+```
+
+**`Example`**
+
+```ts
+Informo:  2     | Obtenho: "02"
+```
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `n` | `Number` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `n` | `Number` | Número a ser ajustado |
 
 #### Returns
 
 `string` \| `Number`
 
+- O número informado, com uma casa decimal a esquerda.
+
 #### Defined in
 
-src/utils/DateUtils.ts:70
+src/utils/DateUtils.ts:120
 
 ___
 
@@ -132,21 +179,25 @@ ___
 
 ▸ `Static` **strToDate**(`strValue`, `adjustDayLightSavingTime?`, `monthYearMode?`): `undefined` \| `Date`
 
+Converte String para Date.
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `strValue` | `string` | `undefined` |
-| `adjustDayLightSavingTime` | `boolean` | `true` |
-| `monthYearMode` | `boolean` | `false` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `strValue` | `string` | `undefined` | Texto a ser convertido para data. |
+| `adjustDayLightSavingTime` | `boolean` | `true` | Se verdadeiro, ativa regra de horário de verão. |
+| `monthYearMode` | `boolean` | `false` | Quando ativado, retorna o primeiro dia do mês apenas para construir a data. |
 
 #### Returns
 
 `undefined` \| `Date`
 
+- Data sem as informações de horário.
+
 #### Defined in
 
-src/utils/DateUtils.ts:8
+src/utils/DateUtils.ts:30
 
 ___
 
@@ -154,19 +205,23 @@ ___
 
 ▸ `Static` `Private` **timezoneOffset**(`offset`): `string`
 
+Retorna timezone da data.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `offset` | `number` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `offset` | `number` | Valor do timezone desejado. |
 
 #### Returns
 
 `string`
 
+Timezone da data.
+
 #### Defined in
 
-src/utils/DateUtils.ts:74
+src/utils/DateUtils.ts:130
 
 ___
 
@@ -174,17 +229,21 @@ ___
 
 ▸ `Static` **validateDate**(`value`, `hasTime?`): `undefined` \| `Date`
 
+Retorna se a data é válida.
+
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `value` | `Date` | `undefined` |
-| `hasTime` | `boolean` | `false` |
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `Date` | `undefined` | Data a ser validada. |
+| `hasTime` | `boolean` | `false` | Determina se a data retornada deve conter informação de horário ou não. Por padrão não retorna a hora. |
 
 #### Returns
 
 `undefined` \| `Date`
 
+- Caso válida, retorna a própria data.
+
 #### Defined in
 
-src/utils/DateUtils.ts:54
+src/utils/DateUtils.ts:89

package/classes/ElementIDUtils.md

@@ -2,6 +2,8 @@
 
 # Class: ElementIDUtils
 
+`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.
+
 ## Table of contents
 
 ### Constructors
@@ -39,7 +41,7 @@
 
 #### Defined in
 
-src/utils/ElementIDUtils.ts:12
+src/utils/ElementIDUtils.ts:13
 
 ___
 
@@ -49,7 +51,7 @@ ___
 
 #### Defined in
 
-src/utils/ElementIDUtils.ts:13
+src/utils/ElementIDUtils.ts:14
 
 ## Methods
 
@@ -57,21 +59,25 @@ src/utils/ElementIDUtils.ts:13
 
 ▸ `Static` **addIDInfo**(`element`, `suffix?`, `iDInfo?`): `string`
 
+Cria e adiciona a propriedade `data-element-id` em um elemento.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
+| `suffix?` | `string` | Sufixo/Texto para ser adicionado. |
+| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
 
 #### Returns
 
 `string`
 
+- O data-element-id gerado.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:15
+src/utils/ElementIDUtils.ts:24
 
 ___
 
@@ -93,7 +99,7 @@ ___
 
 #### Defined in
 
-src/utils/ElementIDUtils.ts:24
+src/utils/ElementIDUtils.ts:33
 
 ___
 
@@ -101,20 +107,24 @@ ___
 
 ▸ `Static` `Private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
 
+Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `iDInfo` | `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-| `dataElementID` | `string` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `iDInfo` | `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado ao `data-element-id`. |
+| `dataElementID` | `string` | Sufixo/Texto para ser adicionado ao `data-element-id`. |
 
 #### Returns
 
 `string`
 
+- String contendo informação para ser usada no `data-element-id` do elemento.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:94
+src/utils/ElementIDUtils.ts:136
 
 ___
 
@@ -122,21 +132,32 @@ ___
 
 ▸ `Static` `Private` **addSuffix**(`dataElementID`, `suffix`, `element`): `string`
 
+Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para montar a hierarquia dos ids dos componentes em tela.
+
+**`Example`**
+
+```ts
+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.
+```
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `dataElementID` | ``null`` \| `string` |
-| `suffix` | `undefined` \| `string` |
-| `element` | `HTMLElement` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dataElementID` | ``null`` \| `string` | ID para ser adicionado ao `data-element-id`. |
+| `suffix` | `undefined` \| `string` | Sufixo/Texto para ser adicionado ao `data-element-id`. |
+| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
 
 #### Returns
 
 `string`
 
+- `data-element-id` com sufixo.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:84
+src/utils/ElementIDUtils.ts:119
 
 ___
 
@@ -144,19 +165,23 @@ ___
 
 ▸ `Static` `Private` **formatDescription**(`value`): `string`
 
+Remove caracteres especiais.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `value` | ``null`` \| `string` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | ``null`` \| `string` | Texto que terá os caracteres especiais removidos. |
 
 #### Returns
 
 `string`
 
+- Retorna a string sem caracteres especiais e em camelCase.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:102
+src/utils/ElementIDUtils.ts:150
 
 ___
 
@@ -164,20 +189,24 @@ ___
 
 ▸ `Static` `Private` **getAttributeValid**(`element`, `iDInfo?`): ``null`` \| `string`
 
+Obtém ID válido para o elemento.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
+| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
 
 #### Returns
 
 ``null`` \| `string`
 
+- ID para ser adicionado ao elemento conforme ordem de prioridade.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:56
+src/utils/ElementIDUtils.ts:79
 
 ___
 
@@ -185,21 +214,25 @@ ___
 
 ▸ `Static` `Private` **getDataElementID**(`element`, `suffix?`, `iDInfo?`): `string`
 
+Obtém o `data-element-id` do elemento com adição do sufixo e ID.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `HTMLElement` | Elemento HTML a ser modificado (HTMLElement). |
+| `suffix?` | `string` | Sufixo/Texto para ser adicionado. |
+| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) | ID para ser adicionado. |
 
 #### Returns
 
 `string`
 
+- Atributo `data-element-id` do elemento modificado com sufixo e/ou ID.
+
 #### Defined in
 
-src/utils/ElementIDUtils.ts:39
+src/utils/ElementIDUtils.ts:55
 
 ___
 
@@ -219,7 +252,7 @@ ___
 
 #### Defined in
 
-src/utils/ElementIDUtils.ts:107
+src/utils/ElementIDUtils.ts:155
 
 ___
 
@@ -240,4 +273,4 @@ ___
 
 #### Defined in
 
-src/utils/ElementIDUtils.ts:35
+src/utils/ElementIDUtils.ts:43

package/classes/ErrorException.md

@@ -2,6 +2,8 @@
 
 # Class: ErrorException
 
+`ErrorException`: Exceção lançada quando ocorre um erro.
+
 ## Hierarchy
 
 - `Error`
@@ -49,7 +51,7 @@ Error.constructor
 
 #### Defined in
 
-src/exceptions/ErrorException.ts:7
+src/exceptions/ErrorException.ts:15
 
 ## Properties
 
@@ -71,9 +73,11 @@ ___
 
 • **errorCode**: `string`
 
+Código do erro, indica o erro disparado pelo backend.
+
 #### Defined in
 
-src/exceptions/ErrorException.ts:5
+src/exceptions/ErrorException.ts:13
 
 ___
 
@@ -81,13 +85,15 @@ ___
 
 • **message**: `string`
 
+Descrição do erro.
+
 #### Overrides
 
 Error.message
 
 #### Defined in
 
-src/exceptions/ErrorException.ts:4
+src/exceptions/ErrorException.ts:10
 
 ___
 
@@ -123,9 +129,11 @@ ___
 
 • **title**: `string`
 
+Titulo do erro.
+
 #### Defined in
 
-src/exceptions/ErrorException.ts:3
+src/exceptions/ErrorException.ts:7
 
 ___
 

package/classes/ErrorTracking.md

@@ -2,6 +2,8 @@
 
 # Class: ErrorTracking
 
+`ErrorTracking`: Handler para processar exceptions lançadas.
+
 ## Table of contents
 
 ### Constructors
@@ -25,13 +27,15 @@
 
 ▸ `Static` **init**(): `void`
 
+Inicializa o Rollbar, utilizado para rastreio de erros e análise de logs.
+
 #### Returns
 
 `void`
 
 #### Defined in
 
-src/traking/ErrorTraking.ts:6
+src/traking/ErrorTraking.ts:16
 
 ___
 
@@ -39,16 +43,20 @@ ___
 
 ▸ `Static` `Private` **isInternalException**(`error`): `boolean`
 
+Retorna se o erro é uma exceção interna na aplicação.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `error` | `any` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `any` | Erro que será identificado como exceção interna ou não. |
 
 #### Returns
 
 `boolean`
 
+- Verdadeiro caso seja uma exceção interna.
+
 #### Defined in
 
-src/traking/ErrorTraking.ts:17
+src/traking/ErrorTraking.ts:34