@sankhyalabs/core-docs 5.20.0-rc.30 → 5.20.0-rc.32

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:379
+src/utils/MaskFormatter.ts:466
 
 ***
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
 
 #### Source
 
-src/utils/MaskFormatter.ts:393
+src/utils/MaskFormatter.ts:480
 
 ***
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
 
 #### Source
 
-src/utils/MaskFormatter.ts:304
+src/utils/MaskFormatter.ts:391
 
 ***
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
 
 #### Source
 
-src/utils/MaskFormatter.ts:285
+src/utils/MaskFormatter.ts:372
 
 ***
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:285
 
 #### Source
 
-src/utils/MaskFormatter.ts:356
+src/utils/MaskFormatter.ts:443
 
 ***
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
 
 #### Source
 
-src/utils/MaskFormatter.ts:333
+src/utils/MaskFormatter.ts:420
 
 ## Accessors
 
@@ -265,10 +265,34 @@ 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`, `trimBefore`): `string`
@@ -293,7 +317,31 @@ O valor processado de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:102
+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`
+
+O valor processado de acordo com o padrão.
+
+#### Source
+
+src/utils/MaskFormatter.ts:169
 
 ***
 
@@ -309,4 +357,4 @@ Prepara a formatação internamente de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:122
+src/utils/MaskFormatter.ts:209

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2030
+src/dataunit/DataUnit.ts:2035
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2030
 
 #### Source
 
-src/dataunit/DataUnit.ts:2027
+src/dataunit/DataUnit.ts:2032
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2027
 
 #### Source
 
-src/dataunit/DataUnit.ts:2028
+src/dataunit/DataUnit.ts:2033
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2028
 
 #### Source
 
-src/dataunit/DataUnit.ts:2024
+src/dataunit/DataUnit.ts:2029
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2024
 
 #### Source
 
-src/dataunit/DataUnit.ts:2026
+src/dataunit/DataUnit.ts:2031
 
 ***
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2026
 
 #### Source
 
-src/dataunit/DataUnit.ts:2023
+src/dataunit/DataUnit.ts:2028
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2023
 
 #### Source
 
-src/dataunit/DataUnit.ts:2025
+src/dataunit/DataUnit.ts:2030
 
 ## Accessors
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2025
 
 #### Source
 
-src/dataunit/DataUnit.ts:2058
+src/dataunit/DataUnit.ts:2063
 
 ***
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2058
 
 #### Source
 
-src/dataunit/DataUnit.ts:2048
+src/dataunit/DataUnit.ts:2053
 
 ***
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2048
 
 #### Source
 
-src/dataunit/DataUnit.ts:2038
+src/dataunit/DataUnit.ts:2043
 
 ## Methods
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2038
 
 #### Source
 
-src/dataunit/DataUnit.ts:2065
+src/dataunit/DataUnit.ts:2070
 
 ***
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2065
 
 #### Source
 
-src/dataunit/DataUnit.ts:2069
+src/dataunit/DataUnit.ts:2074

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

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1909
+src/dataunit/DataUnit.ts:1914
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1909
 
 #### Source
 
-src/dataunit/DataUnit.ts:1911
+src/dataunit/DataUnit.ts:1916
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1911
 
 #### Source
 
-src/dataunit/DataUnit.ts:1908
+src/dataunit/DataUnit.ts:1913
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1908
 
 #### Source
 
-src/dataunit/DataUnit.ts:1910
+src/dataunit/DataUnit.ts:1915

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2017
+src/dataunit/DataUnit.ts:2022
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2017
 
 #### Source
 
-src/dataunit/DataUnit.ts:2018
+src/dataunit/DataUnit.ts:2023

package/enumerations/StorageType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / StorageType
+
+# Enumeration: StorageType
+
+## Enumeration Members
+
+### IN\_MEMORY\_CACHE
+
+> **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:2
+
+***
+
+### LOCAL\_STORAGE
+
+> **LOCAL\_STORAGE**: `"localStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:4
+
+***
+
+### SESSION\_STORAGE
+
+> **SESSION\_STORAGE**: `"sessionStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:3

package/globals.md

@@ -18,6 +18,7 @@
 - [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -52,6 +53,7 @@
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
 - [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
 - [SilentException](classes/SilentException.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1892
+src/dataunit/DataUnit.ts:1897

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1997
+src/dataunit/DataUnit.ts:2002
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1997
 
 #### Source
 
-src/dataunit/DataUnit.ts:1998
+src/dataunit/DataUnit.ts:2003
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1998
 
 #### Source
 
-src/dataunit/DataUnit.ts:1999
+src/dataunit/DataUnit.ts:2004

package/interfaces/PaginationInfo.md

@@ -70,6 +70,19 @@ src/dataunit/loading/PaginationInfo.ts:11
 
 ***
 
+### loadingInProgress?
+
+> `optional` **loadingInProgress**: `boolean`
+
+Informa se o carregamento de dados em background está sendo executado
+ Caso o dataunit não tenha carga paralela o valor será indefinido
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:25
+
+***
+
 ### total?
 
 > `optional` **total**: `number`

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2004
+src/dataunit/DataUnit.ts:2009
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2004
 
 #### Source
 
-src/dataunit/DataUnit.ts:2005
+src/dataunit/DataUnit.ts:2010
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2005
 
 #### Source
 
-src/dataunit/DataUnit.ts:2003
+src/dataunit/DataUnit.ts:2008

package/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1899
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1899
 
 #### Source
 
-src/dataunit/DataUnit.ts:1898
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1898
 
 #### Source
 
-src/dataunit/DataUnit.ts:1896
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1896
 
 #### Source
 
-src/dataunit/DataUnit.ts:1897
+src/dataunit/DataUnit.ts:1902

package/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1904
+src/dataunit/DataUnit.ts:1909
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1904
 
 #### Source
 
-src/dataunit/DataUnit.ts:1899
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1899
 
 #### Source
 
-src/dataunit/DataUnit.ts:1898
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1898
 
 #### Source
 
-src/dataunit/DataUnit.ts:1896
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1896
 
 #### Source
 
-src/dataunit/DataUnit.ts:1897
+src/dataunit/DataUnit.ts:1902

package/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1992
+src/dataunit/DataUnit.ts:1997
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1992
 
 #### Source
 
-src/dataunit/DataUnit.ts:1993
+src/dataunit/DataUnit.ts:1998
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1993
 
 #### Source
 
-src/dataunit/DataUnit.ts:1991
+src/dataunit/DataUnit.ts:1996

package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:170
+src/utils/MaskFormatter.ts:257

package/namespaces/MaskFormatter/variables/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:170
+src/utils/MaskFormatter.ts:257

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "5.20.0-rc.30",
+    "version": "5.20.0-rc.32",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [

package/type-aliases/DataUnitEventOptions.md

@@ -14,4 +14,4 @@
 
 ## Source
 
-src/dataunit/DataUnit.ts:2074
+src/dataunit/DataUnit.ts:2079