@sankhyalabs/core-docs 5.20.0-rc.9 → 6.0.0

package/enumerations/Action.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:52
+src/dataunit/state/action/DataUnitAction.ts:54
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/state/action/DataUnitAction.ts:52
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:51
+src/dataunit/state/action/DataUnitAction.ts:53
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/state/action/DataUnitAction.ts:51
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:45
+src/dataunit/state/action/DataUnitAction.ts:47
 
 ***
 
@@ -44,7 +44,7 @@ src/dataunit/state/action/DataUnitAction.ts:45
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:63
+src/dataunit/state/action/DataUnitAction.ts:65
 
 ***
 
@@ -54,7 +54,7 @@ src/dataunit/state/action/DataUnitAction.ts:63
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:47
+src/dataunit/state/action/DataUnitAction.ts:49
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/state/action/DataUnitAction.ts:33
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:48
+src/dataunit/state/action/DataUnitAction.ts:50
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/state/action/DataUnitAction.ts:37
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:50
+src/dataunit/state/action/DataUnitAction.ts:52
 
 ***
 
@@ -104,7 +104,7 @@ src/dataunit/state/action/DataUnitAction.ts:50
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:65
+src/dataunit/state/action/DataUnitAction.ts:67
 
 ***
 
@@ -114,7 +114,7 @@ src/dataunit/state/action/DataUnitAction.ts:65
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:66
+src/dataunit/state/action/DataUnitAction.ts:68
 
 ***
 
@@ -144,7 +144,7 @@ src/dataunit/state/action/DataUnitAction.ts:29
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:69
+src/dataunit/state/action/DataUnitAction.ts:71
 
 ***
 
@@ -154,7 +154,7 @@ src/dataunit/state/action/DataUnitAction.ts:69
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:68
+src/dataunit/state/action/DataUnitAction.ts:70
 
 ***
 
@@ -164,7 +164,7 @@ src/dataunit/state/action/DataUnitAction.ts:68
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:60
+src/dataunit/state/action/DataUnitAction.ts:62
 
 ***
 
@@ -184,7 +184,7 @@ src/dataunit/state/action/DataUnitAction.ts:30
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:55
+src/dataunit/state/action/DataUnitAction.ts:57
 
 ***
 
@@ -204,7 +204,7 @@ src/dataunit/state/action/DataUnitAction.ts:34
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:56
+src/dataunit/state/action/DataUnitAction.ts:58
 
 ***
 
@@ -214,7 +214,7 @@ src/dataunit/state/action/DataUnitAction.ts:56
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:42
+src/dataunit/state/action/DataUnitAction.ts:44
 
 ***
 
@@ -224,7 +224,7 @@ src/dataunit/state/action/DataUnitAction.ts:42
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:43
+src/dataunit/state/action/DataUnitAction.ts:45
 
 ***
 
@@ -234,7 +234,7 @@ src/dataunit/state/action/DataUnitAction.ts:43
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:40
+src/dataunit/state/action/DataUnitAction.ts:42
 
 ***
 
@@ -244,7 +244,7 @@ src/dataunit/state/action/DataUnitAction.ts:40
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:61
+src/dataunit/state/action/DataUnitAction.ts:63
 
 ***
 
@@ -254,6 +254,16 @@ src/dataunit/state/action/DataUnitAction.ts:61
 
 #### Source
 
+src/dataunit/state/action/DataUnitAction.ts:41
+
+***
+
+### SAVING\_CANCELED
+
+> **SAVING\_CANCELED**: `"savingCanceled"`
+
+#### Source
+
 src/dataunit/state/action/DataUnitAction.ts:39
 
 ***
@@ -268,13 +278,23 @@ src/dataunit/state/action/DataUnitAction.ts:36
 
 ***
 
+### SAVING\_ERROR
+
+> **SAVING\_ERROR**: `"savingError"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:38
+
+***
+
 ### SELECTION\_CHANGED
 
 > **SELECTION\_CHANGED**: `"selectionChanged"`
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:54
+src/dataunit/state/action/DataUnitAction.ts:56
 
 ***
 
@@ -284,7 +304,7 @@ src/dataunit/state/action/DataUnitAction.ts:54
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:58
+src/dataunit/state/action/DataUnitAction.ts:60
 
 ***
 
@@ -294,4 +314,4 @@ src/dataunit/state/action/DataUnitAction.ts:58
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:46
+src/dataunit/state/action/DataUnitAction.ts:48

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1805
+src/dataunit/DataUnit.ts:1967
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1805
 
 #### Source
 
-src/dataunit/DataUnit.ts:1807
+src/dataunit/DataUnit.ts:1969
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1807
 
 #### Source
 
-src/dataunit/DataUnit.ts:1804
+src/dataunit/DataUnit.ts:1966
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1804
 
 #### Source
 
-src/dataunit/DataUnit.ts:1806
+src/dataunit/DataUnit.ts:1968

package/enumerations/LockManagerOperation.md

@@ -0,0 +1,33 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManagerOperation
+
+# Enumeration: LockManagerOperation
+
+Define os tipos de operação que o locker pode controlar
+
+## Enumeration Members
+
+### APP\_LOADING
+
+> **APP\_LOADING**: `"app_loading"`
+
+Operação de lock utilizada para controlar carregamento da aplicação.
+
+#### Source
+
+src/utils/LockManager.ts:13
+
+***
+
+### TASKBAR\_CLICK
+
+> **TASKBAR\_CLICK**: `"taskbar_click"`
+
+Operação de lock utilizada para controlar cliques nos botoes da taskbar.
+
+#### Source
+
+src/utils/LockManager.ts:9

package/enumerations/RECORD_DATE_FORMAT.md

@@ -0,0 +1,27 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / RECORD\_DATE\_FORMAT
+
+# Enumeration: RECORD\_DATE\_FORMAT
+
+## Enumeration Members
+
+### DD\_MM\_YYYY
+
+> **DD\_MM\_YYYY**: `"DD/MM/YYYY"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:8
+
+***
+
+### ISO
+
+> **ISO**: `"ISO"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:9

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1913
+src/dataunit/DataUnit.ts:2075
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1913
 
 #### Source
 
-src/dataunit/DataUnit.ts:1914
+src/dataunit/DataUnit.ts:2076

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

@@ -14,9 +14,12 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
+- [RECORD\_DATE\_FORMAT](enumerations/RECORD_DATE_FORMAT.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -24,9 +27,13 @@
 - [ApplicationContext](classes/ApplicationContext.md)
 - [ArrayUtils](classes/ArrayUtils.md)
 - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
+- [Base64Utils](classes/Base64Utils.md)
 - [Change](classes/Change.md)
+- [ColumnFilterManager](classes/ColumnFilterManager.md)
 - [DataUnit](classes/DataUnit.md)
 - [DataUnitAction](classes/DataUnitAction.md)
+- [DataUnitInMemoryLoader](classes/DataUnitInMemoryLoader.md)
+- [DataUnitLoaderUtils](classes/DataUnitLoaderUtils.md)
 - [DataUnitStorage](classes/DataUnitStorage.md)
 - [DateUtils](classes/DateUtils.md)
 - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -39,6 +46,7 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
@@ -49,6 +57,9 @@
 - [RequestMetadata](classes/RequestMetadata.md)
 - [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)
 - [TimeFormatter](classes/TimeFormatter.md)
@@ -62,6 +73,7 @@
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)
+- [DataUnitInMemoryLoaderConfig](interfaces/DataUnitInMemoryLoaderConfig.md)
 - [ExecutionContext](interfaces/ExecutionContext.md)
 - [FieldDescriptor](interfaces/FieldDescriptor.md)
 - [Filter](interfaces/Filter.md)
@@ -74,6 +86,7 @@
 - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
+- [PaginationInfoBuilderParams](interfaces/PaginationInfoBuilderParams.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
 - [QuickFilter](interfaces/QuickFilter.md)
 - [Record](interfaces/Record.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1788
+src/dataunit/DataUnit.ts:1950

package/interfaces/DataUnitInMemoryLoaderConfig.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoaderConfig
+
+# Interface: DataUnitInMemoryLoaderConfig
+
+## Properties
+
+### autoLoad?
+
+> `optional` **autoLoad**: `boolean`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:2
+
+***
+
+### pageSize?
+
+> `optional` **pageSize**: `number`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:3
+
+***
+
+### recordDateFormat?
+
+> `optional` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:4

package/interfaces/IRepository.md

@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
 
 ***
 
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Source
+
+src/repository/IRepository.ts:88
+
+***
+
 ### insert()
 
 > **insert**(`itemReference`, `items`): `Promise`\<`void`\>

package/interfaces/LoadDataRequest.md

@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
 
 ### source?
 
-> `optional` **source**: `String`
+> `optional` **source**: `string`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 

package/interfaces/OverFlowWatcherParams.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:233
+src/utils/OverflowWatcher/index.ts:234
 
 ***
 
@@ -24,7 +24,7 @@ src/utils/OverflowWatcher/index.ts:233
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:236
+src/utils/OverflowWatcher/index.ts:237
 
 ***
 
@@ -34,7 +34,7 @@ src/utils/OverflowWatcher/index.ts:236
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:235
+src/utils/OverflowWatcher/index.ts:236
 
 ***
 
@@ -44,7 +44,7 @@ src/utils/OverflowWatcher/index.ts:235
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:232
+src/utils/OverflowWatcher/index.ts:233
 
 ***
 
@@ -54,7 +54,7 @@ src/utils/OverflowWatcher/index.ts:232
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:237
+src/utils/OverflowWatcher/index.ts:238
 
 ***
 
@@ -64,4 +64,4 @@ src/utils/OverflowWatcher/index.ts:237
 
 #### Source
 
-src/utils/OverflowWatcher/index.ts:234
+src/utils/OverflowWatcher/index.ts:235

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1893
+src/dataunit/DataUnit.ts:2055
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1893
 
 #### Source
 
-src/dataunit/DataUnit.ts:1894
+src/dataunit/DataUnit.ts:2056
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1894
 
 #### Source
 
-src/dataunit/DataUnit.ts:1895
+src/dataunit/DataUnit.ts:2057

package/interfaces/PaginationInfo.md

@@ -10,6 +10,18 @@ Informações da paginação retornada na requisição de carregamento de regist
 
 ## Properties
 
+### askRowsLimit?
+
+> `optional` **askRowsLimit**: `number`
+
+Informa se deve exibir diálogo para cancelar carregamento de registros
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:30
+
+***
+
 ### count?
 
 > `optional` **count**: `number`
@@ -70,6 +82,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/PaginationInfoBuilderParams.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / PaginationInfoBuilderParams
+
+# Interface: PaginationInfoBuilderParams
+
+## Properties
+
+### offset
+
+> **offset**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
+
+***
+
+### recordsLength
+
+> **recordsLength**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
+
+***
+
+### recordsPerPage
+
+> **recordsPerPage**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1900
+src/dataunit/DataUnit.ts:2062
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1900
 
 #### Source
 
-src/dataunit/DataUnit.ts:1901
+src/dataunit/DataUnit.ts:2063
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1901
 
 #### Source
 
-src/dataunit/DataUnit.ts:1899
+src/dataunit/DataUnit.ts:2061