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

package/classes/ObjectUtils.md

@@ -0,0 +1,160 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ObjectUtils
+
+# Class: ObjectUtils
+
+`ObjectUtils`: Utilizado para manipulação de objetos.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ObjectUtils.md#constructor)
+
+### Methods
+
+- [copy](ObjectUtils.md#copy)
+- [objectToString](ObjectUtils.md#objecttostring)
+- [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
+- [sortByProperty](ObjectUtils.md#sortbyproperty)
+- [stringToObject](ObjectUtils.md#stringtoobject)
+
+## Constructors
+
+### constructor
+
+• **new ObjectUtils**()
+
+## Methods
+
+### copy
+
+▸ `Static` **copy**<`T`\>(`data`): `T`
+
+Faz a cópia do objeto.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `Object` \| `Object`[] | Objeto a ser copiado. |
+
+#### Returns
+
+`T`
+
+- A cópia do objeto válido.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:13
+
+___
+
+### objectToString
+
+▸ `Static` **objectToString**(`data`): `string`
+
+Converte um objeto em string/JSON.
+
+**`Example`**
+
+@Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `Object` \| `Object`[] | Objeto a ser convertido. |
+
+#### Returns
+
+`string`
+
+- Uma string JSON.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:26
+
+___
+
+### removeEmptyValues
+
+▸ `Static` **removeEmptyValues**(`obj`): `object`
+
+Remove atributos nulos e indefinidos de um objeto.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `obj` | `object` |
+
+#### Returns
+
+`object`
+
+- O objeto com as propriedades válidas.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:68
+
+___
+
+### sortByProperty
+
+▸ `Static` **sortByProperty**(`data`, `property`): `any`
+
+Faz a ordenação de um objeto por uma propriedade.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `any` | Objeto a ser ordenado. |
+| `property` | `string` | Nome da propriedade a ser ordenada. |
+
+#### Returns
+
+`any`
+
+- O objeto ordenado pela propriedade.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:50
+
+___
+
+### stringToObject
+
+▸ `Static` **stringToObject**(`data`): `Object` \| `Object`[]
+
+Converte uma string/JSON em objeto.
+
+**`Example`**
+
+Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | `string` | String a ser convertida. |
+
+#### Returns
+
+`Object` \| `Object`[]
+
+- Um objeto válido.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:39

package/classes/OnboardingUtils.md

@@ -0,0 +1,126 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
+
+# Class: OnboardingUtils
+
+## Table of contents
+
+### Constructors
+
+- [constructor](OnboardingUtils.md#constructor)
+
+### Properties
+
+- [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
+- [instance](OnboardingUtils.md#instance)
+
+### Methods
+
+- [init](OnboardingUtils.md#init)
+- [injectScript](OnboardingUtils.md#injectscript)
+- [register](OnboardingUtils.md#register)
+- [getInstance](OnboardingUtils.md#getinstance)
+
+## Constructors
+
+### constructor
+
+• `Private` **new OnboardingUtils**()
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:5
+
+## Properties
+
+### USER\_GUIDE\_TAG\_ID
+
+▪ `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:2
+
+___
+
+### instance
+
+▪ `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:3
+
+## Methods
+
+### init
+
+▸ **init**(`apiKey`, `ctx`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `apiKey` | `string` |
+| `ctx` | `EnvironmentContext` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:14
+
+___
+
+### injectScript
+
+▸ `Private` **injectScript**(`apiKey`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `apiKey` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:23
+
+___
+
+### register
+
+▸ `Private` **register**(`ctx`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ctx` | `EnvironmentContext` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:34
+
+___
+
+### getInstance
+
+▸ `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
+
+#### Returns
+
+[`OnboardingUtils`](OnboardingUtils.md)
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:7

package/classes/PromiseSync.md

@@ -0,0 +1,91 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSync
+
+# Class: PromiseSync<T\>
+
+O intuito desta classe é organizar a finalização de várias
+promessas executando determinada ação (callback) com o resultado.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](PromiseSync.md#constructor)
+
+### Properties
+
+- [\_callBack](PromiseSync.md#_callback)
+- [\_promises](PromiseSync.md#_promises)
+
+### Methods
+
+- [add](PromiseSync.md#add)
+
+## Constructors
+
+### constructor
+
+• **new PromiseSync**<`T`\>(`callBack`)
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callBack` | [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\> |
+
+#### Defined in
+
+src/async/PromiseSync.ts:13
+
+## Properties
+
+### \_callBack
+
+• **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\>
+
+#### Defined in
+
+src/async/PromiseSync.ts:8
+
+___
+
+### \_promises
+
+• **\_promises**: `Promise`<`T`\>[]
+
+#### Defined in
+
+src/async/PromiseSync.ts:7
+
+## Methods
+
+### add
+
+▸ **add**(`promise`): `void`
+
+Adiciona na lista de promises pendentes. Isso faz com que criemos uma nova espera.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `promise` | `Promise`<`T`\> | Entrará na lista aguardada. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/async/PromiseSync.ts:23

package/classes/ReadyUtil.md

@@ -0,0 +1,115 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ReadyUtil
+
+# Class: ReadyUtil
+
+`ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ReadyUtil.md#constructor)
+
+### Properties
+
+- [promise](ReadyUtil.md#promise)
+- [resolve](ReadyUtil.md#resolve)
+
+### Methods
+
+- [clean](ReadyUtil.md#clean)
+- [end](ReadyUtil.md#end)
+- [start](ReadyUtil.md#start)
+- [whenReady](ReadyUtil.md#whenready)
+
+## Constructors
+
+### constructor
+
+• **new ReadyUtil**()
+
+## Properties
+
+### promise
+
+• `Private` **promise**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:6
+
+___
+
+### resolve
+
+• `Private` **resolve**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:5
+
+## Methods
+
+### clean
+
+▸ `Private` **clean**(): `void`
+
+Limpa o estado da instancia ao finalizar a execução do processo registrado.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:11
+
+___
+
+### end
+
+▸ **end**(): `void`
+
+Executa processo atribuído.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:28
+
+___
+
+### start
+
+▸ `Private` **start**(): `void`
+
+Inicializa o estado da instancia ao registrar processo.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:19
+
+___
+
+### whenReady
+
+▸ **whenReady**(): `Promise`<`unknown`\>
+
+Atribui processo que será executado por operações que o invocarem no método 'end'.
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+Promise que deve conter o código do processo.
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:36

package/classes/RequestMetadata.md

@@ -0,0 +1,84 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / RequestMetadata
+
+# Class: RequestMetadata
+
+Representa as propriedades necessárias para se executar uma requisição.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RequestMetadata.md#constructor)
+
+### Properties
+
+- [headers](RequestMetadata.md#headers)
+- [method](RequestMetadata.md#method)
+- [timeout](RequestMetadata.md#timeout)
+- [url](RequestMetadata.md#url)
+
+## Constructors
+
+### constructor
+
+• **new RequestMetadata**(`url`, `method`, `headers?`)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `method` | `Method` | O Método da requisição (GET, PUT, POST ou DELETE). |
+| `headers?` | `Header`[] | - |
+
+#### Defined in
+
+src/http/RequestMetadata.ts:22
+
+## Properties
+
+### headers
+
+• **headers**: `Header`[]
+
+Headers para serem enviados na requisição
+
+#### Defined in
+
+src/http/RequestMetadata.ts:16
+
+___
+
+### method
+
+• **method**: `Method`
+
+O verbo HTTP
+
+#### Defined in
+
+src/http/RequestMetadata.ts:10
+
+___
+
+### timeout
+
+• **timeout**: `number` = `30000`
+
+Tempo limite de espera pela resposta
+
+#### Defined in
+
+src/http/RequestMetadata.ts:13
+
+___
+
+### url
+
+• **url**: `string`
+
+A URL a ser chamada
+
+#### Defined in
+
+src/http/RequestMetadata.ts:7