@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/classes/ElementIDUtils.md

@@ -0,0 +1,308 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ElementIDUtils
+
+# 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
+
+- [constructor](ElementIDUtils.md#constructor)
+
+### Properties
+
+- [DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME](ElementIDUtils.md#data_element_id_attribute_name)
+- [INTERNAL\_INPUT\_NAME](ElementIDUtils.md#internal_input_name)
+- [REGEX\_DATAUNIT\_NAME](ElementIDUtils.md#regex_dataunit_name)
+
+### Methods
+
+- [addIDInfo](ElementIDUtils.md#addidinfo)
+- [addIDInfoIfNotExists](ElementIDUtils.md#addidinfoifnotexists)
+- [addPrefix](ElementIDUtils.md#addprefix)
+- [addSuffix](ElementIDUtils.md#addsuffix)
+- [formatDescription](ElementIDUtils.md#formatdescription)
+- [getAttributeValid](ElementIDUtils.md#getattributevalid)
+- [getDataElementID](ElementIDUtils.md#getdataelementid)
+- [getDataElementIDAttribute](ElementIDUtils.md#getdataelementidattribute)
+- [getInternalIDInfo](ElementIDUtils.md#getinternalidinfo)
+- [parseDataUnitName](ElementIDUtils.md#parsedataunitname)
+
+## Constructors
+
+### constructor
+
+• **new ElementIDUtils**()
+
+## Properties
+
+### DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME
+
+▪ `Static` **DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME**: `string` = `"data-element-id"`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:14
+
+___
+
+### INTERNAL\_INPUT\_NAME
+
+▪ `Static` **INTERNAL\_INPUT\_NAME**: `string` = `"embedded"`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:15
+
+___
+
+### REGEX\_DATAUNIT\_NAME
+
+▪ `Static` `Private` **REGEX\_DATAUNIT\_NAME**: `RegExp`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:16
+
+## Methods
+
+### addIDInfo
+
+▸ `Static` **addIDInfo**(`element`, `suffix?`, `iDInfo?`): `string`
+
+Cria e adiciona a propriedade `data-element-id` em um elemento.
+
+#### Parameters
+
+| 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:26
+
+___
+
+### addIDInfoIfNotExists
+
+▸ `Static` **addIDInfoIfNotExists**(`element`, `suffix?`, `iDInfo?`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+| `suffix?` | `string` |
+| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:39
+
+___
+
+### addPrefix
+
+▸ `Static` `Private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
+
+Adiciona a propriedade name do DataUnit como prefixo do data-element-id do elemento.
+
+#### Parameters
+
+| 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:147
+
+___
+
+### addSuffix
+
+▸ `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_embedded_combo.
+Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
+```
+
+#### Parameters
+
+| 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:130
+
+___
+
+### formatDescription
+
+▸ `Static` `Private` **formatDescription**(`value`): `string`
+
+Remove caracteres especiais.
+
+#### Parameters
+
+| 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:162
+
+___
+
+### getAttributeValid
+
+▸ `Static` `Private` **getAttributeValid**(`element`, `iDInfo?`): ``null`` \| `string`
+
+Obtém ID válido para o elemento.
+
+#### Parameters
+
+| 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:90
+
+___
+
+### getDataElementID
+
+▸ `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 | 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:66
+
+___
+
+### getDataElementIDAttribute
+
+▸ `Static` `Private` **getDataElementIDAttribute**(`element`): ``null`` \| `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+
+#### Returns
+
+``null`` \| `string`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:168
+
+___
+
+### getInternalIDInfo
+
+▸ `Static` **getInternalIDInfo**(`sufix`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `sufix` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:54
+
+___
+
+### parseDataUnitName
+
+▸ `Static` `Private` **parseDataUnitName**(`uri`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `uri` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:175

package/classes/ErrorException.md

@@ -0,0 +1,214 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorException
+
+# Class: ErrorException
+
+`ErrorException`: Exceção lançada quando ocorre um erro.
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`ErrorException`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ErrorException.md#constructor)
+
+### Properties
+
+- [cause](ErrorException.md#cause)
+- [errorCode](ErrorException.md#errorcode)
+- [message](ErrorException.md#message)
+- [name](ErrorException.md#name)
+- [stack](ErrorException.md#stack)
+- [title](ErrorException.md#title)
+- [prepareStackTrace](ErrorException.md#preparestacktrace)
+- [stackTraceLimit](ErrorException.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](ErrorException.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new ErrorException**(`title`, `message`, `errorCode?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `title` | `string` | `undefined` |
+| `message` | `string` | `undefined` |
+| `errorCode` | `string` | `""` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+src/exceptions/ErrorException.ts:18
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### errorCode
+
+• **errorCode**: `string`
+
+Código do erro, indica o erro disparado pelo backend.
+
+#### Defined in
+
+src/exceptions/ErrorException.ts:16
+
+___
+
+### message
+
+• **message**: `string`
+
+Descrição do erro.
+
+#### Overrides
+
+Error.message
+
+#### Defined in
+
+src/exceptions/ErrorException.ts:13
+
+___
+
+### name
+
+• **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+Error.name
+
+#### Defined in
+
+src/exceptions/ErrorException.ts:7
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1055
+
+___
+
+### title
+
+• **title**: `string`
+
+Titulo do erro.
+
+#### Defined in
+
+src/exceptions/ErrorException.ts:10
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/classes/ErrorTracking.md

@@ -0,0 +1,62 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorTracking
+
+# Class: ErrorTracking
+
+`ErrorTracking`: Handler para processar exceptions lançadas.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ErrorTracking.md#constructor)
+
+### Methods
+
+- [init](ErrorTracking.md#init)
+- [isInternalException](ErrorTracking.md#isinternalexception)
+
+## Constructors
+
+### constructor
+
+• **new ErrorTracking**()
+
+## Methods
+
+### init
+
+▸ `Static` **init**(): `void`
+
+Inicializa o Rollbar, utilizado para rastreio de erros e análise de logs.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/traking/ErrorTraking.ts:16
+
+___
+
+### isInternalException
+
+▸ `Static` `Private` **isInternalException**(`error`): `boolean`
+
+Retorna se o erro é uma exceção interna na aplicação.
+
+#### Parameters
+
+| 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:34