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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/ColumnFilterManager.md +145 -0
  3. package/classes/DataUnit.md +334 -136
  4. package/classes/DataUnitInMemoryLoader.md +303 -0
  5. package/classes/DataUnitLoaderUtils.md +151 -0
  6. package/classes/FieldComparator.md +2 -2
  7. package/classes/IDBRepository.md +22 -0
  8. package/classes/LockManager.md +249 -0
  9. package/classes/MaskFormatter.md +66 -14
  10. package/classes/ObjectUtils.md +95 -2
  11. package/classes/SelectionInfo.md +25 -11
  12. package/classes/ServiceCanceledException.md +193 -0
  13. package/classes/ServiceUtils.md +67 -0
  14. package/classes/SilentException.md +193 -0
  15. package/classes/UserAgentUtils.md +15 -1
  16. package/enumerations/Action.md +32 -22
  17. package/enumerations/ChangeOperation.md +4 -4
  18. package/enumerations/LockManagerOperation.md +33 -0
  19. package/enumerations/RECORD_DATE_FORMAT.md +27 -0
  20. package/enumerations/SelectionMode.md +2 -2
  21. package/enumerations/StorageType.md +37 -0
  22. package/globals.md +12 -0
  23. package/interfaces/DUActionInterceptor.md +1 -1
  24. package/interfaces/DataUnitInMemoryLoaderConfig.md +37 -0
  25. package/interfaces/IRepository.md +18 -0
  26. package/interfaces/LoadDataRequest.md +1 -1
  27. package/interfaces/PageRequest.md +3 -3
  28. package/interfaces/PaginationInfo.md +25 -0
  29. package/interfaces/PaginationInfoBuilderParams.md +37 -0
  30. package/interfaces/QuickFilter.md +3 -3
  31. package/interfaces/Record.md +4 -4
  32. package/interfaces/SavedRecord.md +5 -5
  33. package/interfaces/WaitingChange.md +3 -3
  34. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  35. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  36. package/package.json +1 -1
  37. package/type-aliases/DataUnitEventOptions.md +1 -1
package/enumerations/LockManagerOperation.md ADDED
@@ -0,0 +1,33 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LockManagerOperation
6
+
7
+ # Enumeration: LockManagerOperation
8
+
9
+ Define os tipos de operação que o locker pode controlar
10
+
11
+ ## Enumeration Members
12
+
13
+ ### APP\_LOADING
14
+
15
+ > **APP\_LOADING**: `"app_loading"`
16
+
17
+ Operação de lock utilizada para controlar carregamento da aplicação.
18
+
19
+ #### Source
20
+
21
+ src/utils/LockManager.ts:13
22
+
23
+ ***
24
+
25
+ ### TASKBAR\_CLICK
26
+
27
+ > **TASKBAR\_CLICK**: `"taskbar_click"`
28
+
29
+ Operação de lock utilizada para controlar cliques nos botoes da taskbar.
30
+
31
+ #### Source
32
+
33
+ src/utils/LockManager.ts:9
package/enumerations/RECORD_DATE_FORMAT.md ADDED
@@ -0,0 +1,27 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / RECORD\_DATE\_FORMAT
6
+
7
+ # Enumeration: RECORD\_DATE\_FORMAT
8
+
9
+ ## Enumeration Members
10
+
11
+ ### DD\_MM\_YYYY
12
+
13
+ > **DD\_MM\_YYYY**: `"DD/MM/YYYY"`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:8
18
+
19
+ ***
20
+
21
+ ### ISO
22
+
23
+ > **ISO**: `"ISO"`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:9
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1940
17
+ src/dataunit/DataUnit.ts:2061
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1940
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1941
27
+ src/dataunit/DataUnit.ts:2062
package/enumerations/StorageType.md ADDED
@@ -0,0 +1,37 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / StorageType
6
+
7
+ # Enumeration: StorageType
8
+
9
+ ## Enumeration Members
10
+
11
+ ### IN\_MEMORY\_CACHE
12
+
13
+ > **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
14
+
15
+ #### Source
16
+
17
+ src/utils/CacheManager/interfaces/index.ts:2
18
+
19
+ ***
20
+
21
+ ### LOCAL\_STORAGE
22
+
23
+ > **LOCAL\_STORAGE**: `"localStorage"`
24
+
25
+ #### Source
26
+
27
+ src/utils/CacheManager/interfaces/index.ts:4
28
+
29
+ ***
30
+
31
+ ### SESSION\_STORAGE
32
+
33
+ > **SESSION\_STORAGE**: `"sessionStorage"`
34
+
35
+ #### Source
36
+
37
+ src/utils/CacheManager/interfaces/index.ts:3
package/globals.md CHANGED
@@ -14,9 +14,12 @@
14
14
  - [ChangeOperation](enumerations/ChangeOperation.md)
15
15
  - [DataType](enumerations/DataType.md)
16
16
  - [DependencyType](enumerations/DependencyType.md)
17
+ - [LockManagerOperation](enumerations/LockManagerOperation.md)
17
18
  - [OverflowDirection](enumerations/OverflowDirection.md)
19
+ - [RECORD\_DATE\_FORMAT](enumerations/RECORD_DATE_FORMAT.md)
18
20
  - [SelectionMode](enumerations/SelectionMode.md)
19
21
  - [SortMode](enumerations/SortMode.md)
22
+ - [StorageType](enumerations/StorageType.md)
20
23
  - [UserInterface](enumerations/UserInterface.md)
21
24
 
22
25
  ## Classes
@@ -25,8 +28,11 @@
25
28
  - [ArrayUtils](classes/ArrayUtils.md)
26
29
  - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
27
30
  - [Change](classes/Change.md)
31
+ - [ColumnFilterManager](classes/ColumnFilterManager.md)
28
32
  - [DataUnit](classes/DataUnit.md)
29
33
  - [DataUnitAction](classes/DataUnitAction.md)
34
+ - [DataUnitInMemoryLoader](classes/DataUnitInMemoryLoader.md)
35
+ - [DataUnitLoaderUtils](classes/DataUnitLoaderUtils.md)
30
36
  - [DataUnitStorage](classes/DataUnitStorage.md)
31
37
  - [DateUtils](classes/DateUtils.md)
32
38
  - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -39,6 +45,7 @@
39
45
  - [IDBRepository](classes/IDBRepository.md)
40
46
  - [JSUtils](classes/JSUtils.md)
41
47
  - [KeyboardManager](classes/KeyboardManager.md)
48
+ - [LockManager](classes/LockManager.md)
42
49
  - [MaskFormatter](classes/MaskFormatter.md)
43
50
  - [NumberUtils](classes/NumberUtils.md)
44
51
  - [ObjectUtils](classes/ObjectUtils.md)
@@ -49,6 +56,9 @@
49
56
  - [RequestMetadata](classes/RequestMetadata.md)
50
57
  - [SearchUtils](classes/SearchUtils.md)
51
58
  - [SelectionInfo](classes/SelectionInfo.md)
59
+ - [ServiceCanceledException](classes/ServiceCanceledException.md)
60
+ - [ServiceUtils](classes/ServiceUtils.md)
61
+ - [SilentException](classes/SilentException.md)
52
62
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
53
63
  - [StringUtils](classes/StringUtils.md)
54
64
  - [TimeFormatter](classes/TimeFormatter.md)
@@ -62,6 +72,7 @@
62
72
  - [ChildDescriptor](interfaces/ChildDescriptor.md)
63
73
  - [ChildLink](interfaces/ChildLink.md)
64
74
  - [DUActionInterceptor](interfaces/DUActionInterceptor.md)
75
+ - [DataUnitInMemoryLoaderConfig](interfaces/DataUnitInMemoryLoaderConfig.md)
65
76
  - [ExecutionContext](interfaces/ExecutionContext.md)
66
77
  - [FieldDescriptor](interfaces/FieldDescriptor.md)
67
78
  - [Filter](interfaces/Filter.md)
@@ -74,6 +85,7 @@
74
85
  - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
75
86
  - [PageRequest](interfaces/PageRequest.md)
76
87
  - [PaginationInfo](interfaces/PaginationInfo.md)
88
+ - [PaginationInfoBuilderParams](interfaces/PaginationInfoBuilderParams.md)
77
89
  - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
78
90
  - [QuickFilter](interfaces/QuickFilter.md)
79
91
  - [Record](interfaces/Record.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1815
25
+ src/dataunit/DataUnit.ts:1936
package/interfaces/DataUnitInMemoryLoaderConfig.md ADDED
@@ -0,0 +1,37 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoaderConfig
6
+
7
+ # Interface: DataUnitInMemoryLoaderConfig
8
+
9
+ ## Properties
10
+
11
+ ### autoLoad?
12
+
13
+ > `optional` **autoLoad**: `boolean`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:2
18
+
19
+ ***
20
+
21
+ ### pageSize?
22
+
23
+ > `optional` **pageSize**: `number`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:3
28
+
29
+ ***
30
+
31
+ ### recordDateFormat?
32
+
33
+ > `optional` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
34
+
35
+ #### Source
36
+
37
+ src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:4
package/interfaces/IRepository.md CHANGED
@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
96
96
 
97
97
  ***
98
98
 
99
+ ### getFromCache()
100
+
101
+ > **getFromCache**(): `undefined` \| `T`[]
102
+
103
+ Retorna todos os registros que estão em cache no momento
104
+
105
+ #### Returns
106
+
107
+ `undefined` \| `T`[]
108
+
109
+ Todos registros que estão em cache no momento
110
+
111
+ #### Source
112
+
113
+ src/repository/IRepository.ts:88
114
+
115
+ ***
116
+
99
117
  ### insert()
100
118
 
101
119
  > **insert**(`itemReference`, `items`): `Promise`\<`void`\>
package/interfaces/LoadDataRequest.md CHANGED
@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
96
96
 
97
97
  ### source?
98
98
 
99
- > `optional` **source**: `String`
99
+ > `optional` **source**: `string`
100
100
 
101
101
  De onde partiu o refresh. Por padrão a fonte não é identificada
102
102
 
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1920
17
+ src/dataunit/DataUnit.ts:2041
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1920
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1921
27
+ src/dataunit/DataUnit.ts:2042
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1921
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1922
37
+ src/dataunit/DataUnit.ts:2043
package/interfaces/PaginationInfo.md CHANGED
@@ -10,6 +10,18 @@ Informações da paginação retornada na requisição de carregamento de regist
10
10
 
11
11
  ## Properties
12
12
 
13
+ ### askRowsLimit?
14
+
15
+ > `optional` **askRowsLimit**: `number`
16
+
17
+ Informa se deve exibir diálogo para cancelar carregamento de registros
18
+
19
+ #### Source
20
+
21
+ src/dataunit/loading/PaginationInfo.ts:30
22
+
23
+ ***
24
+
13
25
  ### count?
14
26
 
15
27
  > `optional` **count**: `number`
@@ -70,6 +82,19 @@ src/dataunit/loading/PaginationInfo.ts:11
70
82
 
71
83
  ***
72
84
 
85
+ ### loadingInProgress?
86
+
87
+ > `optional` **loadingInProgress**: `boolean`
88
+
89
+ Informa se o carregamento de dados em background está sendo executado
90
+ Caso o dataunit não tenha carga paralela o valor será indefinido
91
+
92
+ #### Source
93
+
94
+ src/dataunit/loading/PaginationInfo.ts:25
95
+
96
+ ***
97
+
73
98
  ### total?
74
99
 
75
100
  > `optional` **total**: `number`
package/interfaces/PaginationInfoBuilderParams.md ADDED
@@ -0,0 +1,37 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / PaginationInfoBuilderParams
6
+
7
+ # Interface: PaginationInfoBuilderParams
8
+
9
+ ## Properties
10
+
11
+ ### offset
12
+
13
+ > **offset**: `number`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
18
+
19
+ ***
20
+
21
+ ### recordsLength
22
+
23
+ > **recordsLength**: `number`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
28
+
29
+ ***
30
+
31
+ ### recordsPerPage
32
+
33
+ > **recordsPerPage**: `number`
34
+
35
+ #### Source
36
+
37
+ src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1927
17
+ src/dataunit/DataUnit.ts:2048
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1927
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1928
27
+ src/dataunit/DataUnit.ts:2049
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1928
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1926
37
+ src/dataunit/DataUnit.ts:2047
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1822
25
+ src/dataunit/DataUnit.ts:1943
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1822
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1821
35
+ src/dataunit/DataUnit.ts:1942
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1821
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1819
45
+ src/dataunit/DataUnit.ts:1940
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1819
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1820
55
+ src/dataunit/DataUnit.ts:1941
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1827
21
+ src/dataunit/DataUnit.ts:1948
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1827
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1822
35
+ src/dataunit/DataUnit.ts:1943
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1822
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1821
49
+ src/dataunit/DataUnit.ts:1942
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1821
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1819
63
+ src/dataunit/DataUnit.ts:1940
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1819
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1820
77
+ src/dataunit/DataUnit.ts:1941
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1915
17
+ src/dataunit/DataUnit.ts:2036
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1915
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1916
27
+ src/dataunit/DataUnit.ts:2037
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1916
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1914
37
+ src/dataunit/DataUnit.ts:2035
package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:257
package/namespaces/MaskFormatter/variables/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:257
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.17.3",
3
+ "version": "5.18.0-ms.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:1993
17
+ src/dataunit/DataUnit.ts:2118