@sankhyalabs/core-docs 5.17.4 → 5.18.0-ms.1

package/classes/LockManager.md

@@ -0,0 +1,249 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManager
+
+# Class: LockManager
+
+## Constructors
+
+### new LockManager()
+
+> **new LockManager**(): [`LockManager`](LockManager.md)
+
+#### Returns
+
+[`LockManager`](LockManager.md)
+
+## Properties
+
+### ATTRIBUTE\_NAME
+
+> `static` **ATTRIBUTE\_NAME**: `string` = `"data-locker-manger-context-id"`
+
+Nome do atributo que será utilizado para controlar contexto de locks nos elementos da DOM.
+
+#### Source
+
+src/utils/LockManager.ts:28
+
+***
+
+### \_locks
+
+> `static` `private` **\_locks**: `Map`\<`string`, `Lock`[]\>
+
+#### Source
+
+src/utils/LockManager.ts:23
+
+## Methods
+
+### addLockManagerCtxId()
+
+> `static` **addLockManagerCtxId**(`startElement`): `string`
+
+Cria um contexto de locker, caso nao exista, para todos elementos pais iniciados com ez- ou snk-.
+
+#### Parameters
+
+• **startElement**: `HTMLElement`
+
+Elemento de de onde o lock deve começar.
+
+#### Returns
+
+`string`
+
+- O id do locker, que pode ser usado para iniciar ou aguardar um lock do contexto.
+
+#### Source
+
+src/utils/LockManager.ts:87
+
+***
+
+### buildContextID()
+
+> `static` `private` **buildContextID**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/LockManager.ts:30
+
+***
+
+### buildLockerID()
+
+> `static` `private` **buildLockerID**(`ctxId`, `operation`): `undefined` \| `string`
+
+#### Parameters
+
+• **ctxId**: `string` \| `HTMLElement`
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:34
+
+***
+
+### findExistingCtxId()
+
+> `static` `private` **findExistingCtxId**(`element`): `null` \| `string`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+#### Returns
+
+`null` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:47
+
+***
+
+### lock()
+
+> `static` **lock**(`id`, `operation`): () => `void`
+
+Inicia um locker baseado em um contexto e uma operação.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+Operação do contexto que o lock deve ser feito.
+
+#### Returns
+
+`Function`
+
+- Uma função que fara a liberação do lock.
+
+##### Returns
+
+`void`
+
+#### Source
+
+src/utils/LockManager.ts:142
+
+***
+
+### resetLocks()
+
+> `static` **resetLocks**(`id`, `operation`): `Promise`\<`void`\>
+
+Reseta todos os locks existentes para um determinado contexto e operação de forma assíncrona
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+ID do contexto ou elemento HTML contendo contexto
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+Operação específica para resetar os locks
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise que será resolvida quando todos os locks forem resetados
+
+#### Source
+
+src/utils/LockManager.ts:116
+
+***
+
+### traverseAndAddAttr()
+
+> `static` `private` **traverseAndAddAttr**(`element`, `ctxId`): `void`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+• **ctxId**: `string`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/LockManager.ts:69
+
+***
+
+### whenHasLock()
+
+> `static` **whenHasLock**(`id`, `operation`, `timeOut`?): `Promise`\<`void`\>
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+• **timeOut?**: `number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Source
+
+src/utils/LockManager.ts:196
+
+***
+
+### whenResolve()
+
+> `static` **whenResolve**(`id`, `operation`, `debounce`?, `timeOut`?): `Promise`\<`void`\>
+
+Aguarda todos os lockers de um contexto e operação serem resolvidos.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+Operação do contexto que devera aguardar.
+
+• **debounce?**: `number`
+
+• **timeOut?**: `number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+- Promise que será resolvida quando todos lockers forem finalizados.
+
+#### Source
+
+src/utils/LockManager.ts:169

package/classes/MaskFormatter.md

@@ -66,7 +66,7 @@ resultaria na string '123-____'.
 
 #### Source
 
-src/utils/MaskFormatter.ts:91
+src/utils/MaskFormatter.ts:92
 
 ## Properties
 
@@ -76,7 +76,7 @@ src/utils/MaskFormatter.ts:91
 
 #### Source
 
-src/utils/MaskFormatter.ts:65
+src/utils/MaskFormatter.ts:66
 
 ***
 
@@ -86,7 +86,7 @@ src/utils/MaskFormatter.ts:65
 
 #### Source
 
-src/utils/MaskFormatter.ts:66
+src/utils/MaskFormatter.ts:67
 
 ***
 
@@ -99,7 +99,7 @@ ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espa
 
 #### Source
 
-src/utils/MaskFormatter.ts:72
+src/utils/MaskFormatter.ts:73
 
 ***
 
@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
 
 #### Source
 
-src/utils/MaskFormatter.ts:375
+src/utils/MaskFormatter.ts:466
 
 ***
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
 
 #### Source
 
-src/utils/MaskFormatter.ts:389
+src/utils/MaskFormatter.ts:480
 
 ***
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
 
 #### Source
 
-src/utils/MaskFormatter.ts:300
+src/utils/MaskFormatter.ts:391
 
 ***
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
 
 #### Source
 
-src/utils/MaskFormatter.ts:281
+src/utils/MaskFormatter.ts:372
 
 ***
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:281
 
 #### Source
 
-src/utils/MaskFormatter.ts:352
+src/utils/MaskFormatter.ts:443
 
 ***
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
 
 #### Source
 
-src/utils/MaskFormatter.ts:329
+src/utils/MaskFormatter.ts:420
 
 ## Accessors
 
@@ -265,13 +265,37 @@ A última máscara informada.
 
 #### Source
 
-src/utils/MaskFormatter.ts:87
+src/utils/MaskFormatter.ts:88
 
 ## Methods
 
+### applyMask()
+
+> **applyMask**(`value`): `string`
+
+Aplica a máscara quando o input é alterado
+
+#### Parameters
+
+• **value**: `string`
+
+Valor a ser aplicado com a máscara.
+
+#### Returns
+
+`string`
+
+O valor processado de acordo com o padrão.
+
+#### Source
+
+src/utils/MaskFormatter.ts:103
+
+***
+
 ### format()
 
-> **format**(`value`): `string`
+> **format**(`value`, `trimBefore`): `string`
 
 Formata a string passada baseada na máscara definda pelo atributo mask.
 
@@ -281,6 +305,34 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
 
 Valor a ser formatado.
 
+• **trimBefore**: `boolean`= `false`
+
+Executa um trim para remover espaços em branco.
+
+#### Returns
+
+`string`
+
+O valor processado de acordo com o padrão.
+
+#### Source
+
+src/utils/MaskFormatter.ts:189
+
+***
+
+### removeMask()
+
+> **removeMask**(`value`): `string`
+
+Remove a máscara formatando a string retornando sem máscara
+
+#### Parameters
+
+• **value**: `string`
+
+Valor a ser formatado com máscara.
+
 #### Returns
 
 `string`
@@ -289,7 +341,7 @@ O valor processado de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:101
+src/utils/MaskFormatter.ts:169
 
 ***
 
@@ -305,4 +357,4 @@ Prepara a formatação internamente de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:118
+src/utils/MaskFormatter.ts:209

package/classes/ObjectUtils.md

@@ -76,6 +76,99 @@ src/utils/ObjectUtils.ts:84
 
 ***
 
+### getComparableProp()
+
+> `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
+
+#### Parameters
+
+• **value**: `any`
+
+• **propToCompare**: `string`= `"value"`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/ObjectUtils.ts:106
+
+***
+
+### getProp()
+
+> `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
+
+Busca a propriedade de um objeto baseado em seu caminho.
+
+#### Parameters
+
+• **obj**: `Record`\<`string`, `any`\>
+
+Objeto a ser verificado.
+
+• **keyPath**: `string`
+
+Caminho da propriedade a ser buscada.
+
+#### Returns
+
+`undefined` \| `Record`\<`string`, `any`\>
+
+- O valor da propriedade caso ela exista.
+
+#### Source
+
+src/utils/ObjectUtils.ts:140
+
+***
+
+### hasEquivalentProps()
+
+> `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
+
+Compara se o valor de dois items são equivalentes.
+Comparando tanto o valor do item em si, quanto sua propriedade "value"
+
+#### Parameters
+
+• **obj1**: `any`
+
+Objeto a ser comparado.
+
+• **obj2**: `any`
+
+Objeto a ser comparado.
+
+• **propToCompare**: `string`= `"value"`
+
+propriedade que deve ser comparada.
+
+#### Returns
+
+`boolean`
+
+- Se o objeto 1 é equivalente ao objeto 2.
+
+*
+
+#### Examples
+
+```ts
+hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
+```
+
+```ts
+hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
+```
+
+#### Source
+
+src/utils/ObjectUtils.ts:102
+
+***
+
 ### isEmpty()
 
 > `static` **isEmpty**(`obj`): `boolean`
@@ -96,7 +189,7 @@ Objeto a ser verificado.
 
 #### Source
 
-src/utils/ObjectUtils.ts:94
+src/utils/ObjectUtils.ts:119
 
 ***
 
@@ -120,7 +213,7 @@ Objeto a ser verificado.
 
 #### Source
 
-src/utils/ObjectUtils.ts:104
+src/utils/ObjectUtils.ts:129
 
 ***
 

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1958
+src/dataunit/DataUnit.ts:2074
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1958
 
 #### Source
 
-src/dataunit/DataUnit.ts:1952
+src/dataunit/DataUnit.ts:2071
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1952
 
 #### Source
 
-src/dataunit/DataUnit.ts:1954
+src/dataunit/DataUnit.ts:2072
 
 ***
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1954
 
 #### Source
 
-src/dataunit/DataUnit.ts:1955
+src/dataunit/DataUnit.ts:2068
+
+***
+
+### getAllRecords()?
+
+> `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/DataUnit.ts:2070
 
 ***
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1955
 
 #### Source
 
-src/dataunit/DataUnit.ts:1953
+src/dataunit/DataUnit.ts:2067
 
 ***
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1953
 
 #### Source
 
-src/dataunit/DataUnit.ts:1956
+src/dataunit/DataUnit.ts:2069
 
 ## Accessors
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1956
 
 #### Source
 
-src/dataunit/DataUnit.ts:1983
+src/dataunit/DataUnit.ts:2102
 
 ***
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1983
 
 #### Source
 
-src/dataunit/DataUnit.ts:1973
+src/dataunit/DataUnit.ts:2092
 
 ***
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1973
 
 #### Source
 
-src/dataunit/DataUnit.ts:1966
+src/dataunit/DataUnit.ts:2082
 
 ## Methods
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1966
 
 #### Source
 
-src/dataunit/DataUnit.ts:1990
+src/dataunit/DataUnit.ts:2109
 
 ***
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1990
 
 #### Source
 
-src/dataunit/DataUnit.ts:1994
+src/dataunit/DataUnit.ts:2113

package/classes/ServiceUtils.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ServiceUtils
+
+# Class: ServiceUtils
+
+## Constructors
+
+### new ServiceUtils()
+
+> **new ServiceUtils**(): [`ServiceUtils`](ServiceUtils.md)
+
+#### Returns
+
+[`ServiceUtils`](ServiceUtils.md)
+
+## Methods
+
+### useCacheWithService()
+
+> `static` **useCacheWithService**\<`T`\>(`identifier`, `fetchFunction`, `storageType`): `Promise`\<`T`\>
+
+Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
+
+#### Type parameters
+
+• **T**
+
+Tipo do dado a ser retornado.
+
+#### Parameters
+
+• **identifier**: `string`
+
+Identificadores únicos usados para compor a chave de cache.
+
+• **fetchFunction**
+
+Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
+
+• **storageType**: [`StorageType`](../enumerations/StorageType.md)= `StorageType.IN_MEMORY_CACHE`
+
+Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
+
+#### Example
+
+```typescript
+const actions = await useCacheWithService(
+ `${this.entityName} - ${this.resourceID}`,
+  async () => {
+    return await fetchActionsFromAPI();
+  }
+);
+console.log(actions);
+```
+
+#### Source
+
+src/utils/ServiceUtils.ts:28