@sankhyalabs/core-docs 5.20.0-dev.6 → 5.20.0-dev.60

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 (35) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +317 -137
  3. package/classes/DateUtils.md +8 -8
  4. package/classes/IDBRepository.md +22 -0
  5. package/classes/LockManager.md +191 -0
  6. package/classes/MaskFormatter.md +66 -14
  7. package/classes/ObjectUtils.md +141 -0
  8. package/classes/OverflowWatcher.md +533 -0
  9. package/classes/SelectionInfo.md +25 -11
  10. package/classes/ServiceCanceledException.md +193 -0
  11. package/classes/ServiceUtils.md +67 -0
  12. package/classes/SilentException.md +193 -0
  13. package/enumerations/Action.md +41 -21
  14. package/enumerations/ChangeOperation.md +4 -4
  15. package/enumerations/LockManagerOperation.md +21 -0
  16. package/enumerations/OverflowDirection.md +29 -0
  17. package/enumerations/SelectionMode.md +2 -2
  18. package/enumerations/StorageType.md +37 -0
  19. package/globals.md +18 -0
  20. package/interfaces/DUActionInterceptor.md +1 -1
  21. package/interfaces/IRepository.md +18 -0
  22. package/interfaces/LoadDataRequest.md +1 -1
  23. package/interfaces/OverFlowWatcherParams.md +67 -0
  24. package/interfaces/PageRequest.md +3 -3
  25. package/interfaces/PaginationInfo.md +13 -0
  26. package/interfaces/QuickFilter.md +3 -3
  27. package/interfaces/Record.md +4 -4
  28. package/interfaces/SavedRecord.md +5 -5
  29. package/interfaces/WaitingChange.md +3 -3
  30. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  31. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  32. package/package.json +1 -1
  33. package/type-aliases/DataUnitEventOptions.md +17 -0
  34. package/type-aliases/OnOverflowCallBack.md +25 -0
  35. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
package/enumerations/OverflowDirection.md ADDED
@@ -0,0 +1,29 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverflowDirection
6
+
7
+ # Enumeration: OverflowDirection
8
+
9
+ Define em qual direção o overflow será observado
10
+
11
+ ## Enumeration Members
12
+
13
+ ### HORIZONTAL
14
+
15
+ > **HORIZONTAL**: `1`
16
+
17
+ #### Source
18
+
19
+ src/utils/OverflowWatcher/types/overflow-direction.ts:6
20
+
21
+ ***
22
+
23
+ ### VERTICAL
24
+
25
+ > **VERTICAL**: `0`
26
+
27
+ #### Source
28
+
29
+ src/utils/OverflowWatcher/types/overflow-direction.ts:5
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1902
17
+ src/dataunit/DataUnit.ts:2022
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1902
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1903
27
+ src/dataunit/DataUnit.ts:2023
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,8 +14,11 @@
14
14
  - [ChangeOperation](enumerations/ChangeOperation.md)
15
15
  - [DataType](enumerations/DataType.md)
16
16
  - [DependencyType](enumerations/DependencyType.md)
17
+ - [LockManagerOperation](enumerations/LockManagerOperation.md)
18
+ - [OverflowDirection](enumerations/OverflowDirection.md)
17
19
  - [SelectionMode](enumerations/SelectionMode.md)
18
20
  - [SortMode](enumerations/SortMode.md)
21
+ - [StorageType](enumerations/StorageType.md)
19
22
  - [UserInterface](enumerations/UserInterface.md)
20
23
 
21
24
  ## Classes
@@ -38,15 +41,20 @@
38
41
  - [IDBRepository](classes/IDBRepository.md)
39
42
  - [JSUtils](classes/JSUtils.md)
40
43
  - [KeyboardManager](classes/KeyboardManager.md)
44
+ - [LockManager](classes/LockManager.md)
41
45
  - [MaskFormatter](classes/MaskFormatter.md)
42
46
  - [NumberUtils](classes/NumberUtils.md)
43
47
  - [ObjectUtils](classes/ObjectUtils.md)
44
48
  - [OnboardingUtils](classes/OnboardingUtils.md)
49
+ - [OverflowWatcher](classes/OverflowWatcher.md)
45
50
  - [PromiseSync](classes/PromiseSync.md)
46
51
  - [ReadyUtil](classes/ReadyUtil.md)
47
52
  - [RequestMetadata](classes/RequestMetadata.md)
48
53
  - [SearchUtils](classes/SearchUtils.md)
49
54
  - [SelectionInfo](classes/SelectionInfo.md)
55
+ - [ServiceCanceledException](classes/ServiceCanceledException.md)
56
+ - [ServiceUtils](classes/ServiceUtils.md)
57
+ - [SilentException](classes/SilentException.md)
50
58
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
51
59
  - [StringUtils](classes/StringUtils.md)
52
60
  - [TimeFormatter](classes/TimeFormatter.md)
@@ -69,6 +77,7 @@
69
77
  - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
70
78
  - [LoadDataRequest](interfaces/LoadDataRequest.md)
71
79
  - [LoadDataResponse](interfaces/LoadDataResponse.md)
80
+ - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
72
81
  - [PageRequest](interfaces/PageRequest.md)
73
82
  - [PaginationInfo](interfaces/PaginationInfo.md)
74
83
  - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -80,6 +89,15 @@
80
89
  - [UnitMetadata](interfaces/UnitMetadata.md)
81
90
  - [WaitingChange](interfaces/WaitingChange.md)
82
91
 
92
+ ## Type Aliases
93
+
94
+ - [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
95
+ - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
96
+
97
+ ## Variables
98
+
99
+ - [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
100
+
83
101
  ## Functions
84
102
 
85
103
  - [defaultDataLoader](functions/defaultDataLoader.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1777
25
+ src/dataunit/DataUnit.ts:1897
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/OverFlowWatcherParams.md ADDED
@@ -0,0 +1,67 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
6
+
7
+ # Interface: OverFlowWatcherParams
8
+
9
+ ## Properties
10
+
11
+ ### callback
12
+
13
+ > **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
14
+
15
+ #### Source
16
+
17
+ src/utils/OverflowWatcher/index.ts:233
18
+
19
+ ***
20
+
21
+ ### debounce?
22
+
23
+ > `optional` **debounce**: `number`
24
+
25
+ #### Source
26
+
27
+ src/utils/OverflowWatcher/index.ts:236
28
+
29
+ ***
30
+
31
+ ### deltaSize?
32
+
33
+ > `optional` **deltaSize**: `number`
34
+
35
+ #### Source
36
+
37
+ src/utils/OverflowWatcher/index.ts:235
38
+
39
+ ***
40
+
41
+ ### element
42
+
43
+ > **element**: `HTMLElement`
44
+
45
+ #### Source
46
+
47
+ src/utils/OverflowWatcher/index.ts:232
48
+
49
+ ***
50
+
51
+ ### notOverFlow?
52
+
53
+ > `optional` **notOverFlow**: `string`[]
54
+
55
+ #### Source
56
+
57
+ src/utils/OverflowWatcher/index.ts:237
58
+
59
+ ***
60
+
61
+ ### overFlowDirection?
62
+
63
+ > `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
64
+
65
+ #### Source
66
+
67
+ src/utils/OverflowWatcher/index.ts:234
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1882
17
+ src/dataunit/DataUnit.ts:2002
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1882
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1883
27
+ src/dataunit/DataUnit.ts:2003
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1883
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1884
37
+ src/dataunit/DataUnit.ts:2004
package/interfaces/PaginationInfo.md CHANGED
@@ -70,6 +70,19 @@ src/dataunit/loading/PaginationInfo.ts:11
70
70
 
71
71
  ***
72
72
 
73
+ ### loadingInProgress?
74
+
75
+ > `optional` **loadingInProgress**: `boolean`
76
+
77
+ Informa se o carregamento de dados em background está sendo executado
78
+ Caso o dataunit não tenha carga paralela o valor será indefinido
79
+
80
+ #### Source
81
+
82
+ src/dataunit/loading/PaginationInfo.ts:25
83
+
84
+ ***
85
+
73
86
  ### total?
74
87
 
75
88
  > `optional` **total**: `number`
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1889
17
+ src/dataunit/DataUnit.ts:2009
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1889
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1890
27
+ src/dataunit/DataUnit.ts:2010
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1890
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1888
37
+ src/dataunit/DataUnit.ts:2008
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1784
25
+ src/dataunit/DataUnit.ts:1904
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1784
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1783
35
+ src/dataunit/DataUnit.ts:1903
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1783
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1781
45
+ src/dataunit/DataUnit.ts:1901
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1781
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1782
55
+ src/dataunit/DataUnit.ts:1902
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1789
21
+ src/dataunit/DataUnit.ts:1909
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1789
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1784
35
+ src/dataunit/DataUnit.ts:1904
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1784
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1783
49
+ src/dataunit/DataUnit.ts:1903
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1783
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1781
63
+ src/dataunit/DataUnit.ts:1901
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1781
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1782
77
+ src/dataunit/DataUnit.ts:1902
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1877
17
+ src/dataunit/DataUnit.ts:1997
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1877
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1878
27
+ src/dataunit/DataUnit.ts:1998
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1878
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1876
37
+ src/dataunit/DataUnit.ts:1996
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.20.0-dev.6",
3
+ "version": "5.20.0-dev.60",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md ADDED
@@ -0,0 +1,17 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnitEventOptions
6
+
7
+ # Type alias: DataUnitEventOptions
8
+
9
+ > **DataUnitEventOptions**: `object`
10
+
11
+ ## Index signature
12
+
13
+ \[`key`: `string`\]: `any`
14
+
15
+ ## Source
16
+
17
+ src/dataunit/DataUnit.ts:2079
package/type-aliases/OnOverflowCallBack.md ADDED
@@ -0,0 +1,25 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OnOverflowCallBack
6
+
7
+ # Type alias: OnOverflowCallBack()
8
+
9
+ > **OnOverflowCallBack**: (`elementsOverFlow`) => `void`
10
+
11
+ Callback que será chamado quando o overflow de um elemento for alterado.
12
+
13
+ ## Parameters
14
+
15
+ • **elementsOverFlow**: `Element`[]
16
+
17
+ Conjunto de elementos filhos que estão causando overflow no elemento pai.
18
+
19
+ ## Returns
20
+
21
+ `void`
22
+
23
+ ## Source
24
+
25
+ src/utils/OverflowWatcher/types/overflow-callback.ts:6
package/variables/OVERFLOWED_CLASS_NAME.md ADDED
@@ -0,0 +1,13 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
6
+
7
+ # Variable: OVERFLOWED\_CLASS\_NAME
8
+
9
+ > `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
10
+
11
+ ## Source
12
+
13
+ src/utils/OverflowWatcher/index.ts:9