@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

package/classes/NumberUtils.md

@@ -0,0 +1,335 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / NumberUtils
+
+# Class: NumberUtils
+
+`NumberUtils`: Utilizado para manipulação de numerais.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](NumberUtils.md#constructor)
+
+### Methods
+
+- [changeFormat](NumberUtils.md#changeformat)
+- [compare](NumberUtils.md#compare)
+- [format](NumberUtils.md#format)
+- [getValueOrDefault](NumberUtils.md#getvalueordefault)
+- [getValueOrZero](NumberUtils.md#getvalueorzero)
+- [keepOnlyDecimalSeparator](NumberUtils.md#keeponlydecimalseparator)
+- [round](NumberUtils.md#round)
+- [safeFormat](NumberUtils.md#safeformat)
+- [stringToNumber](NumberUtils.md#stringtonumber)
+
+## Constructors
+
+### constructor
+
+• **new NumberUtils**()
+
+## Methods
+
+### changeFormat
+
+▸ `Static` **changeFormat**(`value`): `string`
+
+Troca o formato do numeral(string) de "PT-BR" para "EN-US" e vice-versa.
+
+**`Example`**
+
+```ts
+Informo: "15,55"     | Obtenho: "15.55"
+```
+
+**`Example`**
+
+```ts
+Informo: "27.99"     | Obtenho: "27,99"
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | Numeral em formato de string a ser convertido. |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de string formatado de "PT-BR" para "EN-US" e vice-versa.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:186
+
+___
+
+### compare
+
+▸ `Static` **compare**(`a`, `b`): `number`
+
+Determina a ordem de umeros.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `a` | `number` | Primeio número para comparação. |
+| `b` | `number` | Segundo número para comparação. |
+
+#### Returns
+
+`number`
+
+- Um numeral negativo se o primeiro argumento é menor que o segundo, zero se os dois são iguais e um numeral positivo quando o primeiro é maior que o segundo.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:267
+
+___
+
+### format
+
+▸ `Static` **format**(`value`, `precision`, `prettyPrecision?`, `defaultValue?`): `string`
+
+Formata o numeral com a precisão informada.
+
+**`Example`**
+
+```ts
+Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
+Informado: (undefined, 3, 3) | Retorna: NaN
+Informado: (undefined, 3, 3, '0,00') | Retorna: 0,00
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##). |
+| `precision` | `number` | `undefined` | Quantidade de casas decimais. |
+| `prettyPrecision` | `number` | `NaN` | Quantidade de zeros nos decimais. |
+| `defaultValue` | `string` | `undefined` | Valor padrão caso o value não seja um valor numérico válido. |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de String formatado em PT-BR.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:77
+
+___
+
+### getValueOrDefault
+
+▸ `Static` **getValueOrDefault**(`value`, `defaultValue`): `number`
+
+Obtém o valor ou o valor padrão, caso o valor seja inválido(NaN/undefined).
+
+**`Example`**
+
+```ts
+Informo: value: 30, defaultValue: 0     | Obtenho: 30
+```
+
+**`Example`**
+
+```ts
+Informo: value: "30", defaultValue: 0   | Obtenho: 30
+```
+
+**`Example`**
+
+```ts
+Informo: value: "30abc", defaultValue: 0   | Obtenho: 0
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `any` | Valor a ser validado. |
+| `defaultValue` | `number` | Valor padrão a ser retornado caso o value seja inválido. |
+
+#### Returns
+
+`number`
+
+- O próprio numeral passado ou zero.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:208
+
+___
+
+### getValueOrZero
+
+▸ `Static` **getValueOrZero**(`value`): `number`
+
+Obtém o valor ou zero, caso o valor seja inválido(NaN/undefined).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `any` | Numeral a ser validado. |
+
+#### Returns
+
+`number`
+
+- O próprio numeral passado. Caso esse seja inválido retorna zero.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:227
+
+___
+
+### keepOnlyDecimalSeparator
+
+▸ `Static` **keepOnlyDecimalSeparator**(`value`, `formatnumber?`): `string`
+
+Retira os separadores de milhar de um numeral em formato de string.
+
+**`Example`**
+
+```ts
+Informado: '95.12' | Retorna: '9512'
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido. |
+| `formatnumber` | `string` | `'pt-BR'` | Formatação de ENTRADA e SAÍDA do utilitário: pt-BR="###.###,##" en-US="###,###.##"; Default: "pt-BR". |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de string formatado apenas com separador decimal.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:158
+
+___
+
+### round
+
+▸ `Static` **round**(`value`, `decimals?`): `number`
+
+Realiza o arredondamento de casas decimais de um numero.
+
+**`Example`**
+
+```ts
+Informo: (100.12)       |   100.12
+Informo: (100,12)       |   NaN
+
+Informo: ("100.12", 1)  |   100.1
+Informo: ("100.12", 2)  |   100.12
+Informo: ("100.12", 3)  |   100.12
+
+Informo: ("100.15", 1)  |   100.2
+Informo: ("100.15", 2)  |   100.15
+Informo: ("100.15", 3)  |   100.15
+
+Informo: ("100.16", 1)  |   100.2
+Informo: ("100.16", 2)  |   100.16
+Informo: ("100.16", 3)  |   100.16
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `number` | `undefined` | Numeral a ser arredondado. |
+| `decimals` | `number` | `2` | Quantidade de casas decimais ussada no arredondamento. |
+
+#### Returns
+
+`number`
+
+- O próprio numeral arredondado com a quantidade de casas decimais do argumento decimals.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:255
+
+___
+
+### safeFormat
+
+▸ `Static` **safeFormat**(`value`, `precision`, `prettyPrecision?`): `string`
+
+Formata o numeral com a precisão informada e o valor default 0,00 caso o value não seja um numero valido.
+
+**`Example`**
+
+```ts
+Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
+Informado: (undefined, 3, 3) | Retorna: 0,00
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##). |
+| `precision` | `number` | `undefined` | Quantidade de casas decimais. |
+| `prettyPrecision` | `number` | `NaN` | Quantidade de zeros nos decimais. |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de String formatado em PT-BR.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:143
+
+___
+
+### stringToNumber
+
+▸ `Static` **stringToNumber**(`value`): `number`
+
+Converte o dado numérico de string para number.
+
+**`Example`**
+
+```ts
+@"100,12"     |       100.12
+@"100.12"     |       100.12
+@"-100,12"    |       -100.12
+@"R$100,12"   |       100.12
+@"-R$100,12"  |       -100.12
+@"string"     |       NaN
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico: ######.##). |
+
+#### Returns
+
+`number`
+
+- Numeral passado.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:22

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