@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.41

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 (84) hide show
  1. package/README.md +3 -1
  2. package/classes/ApplicationContext.md +31 -32
  3. package/classes/ArrayUtils.md +95 -83
  4. package/classes/AuthorizedServiceCaller.md +25 -34
  5. package/classes/Change.md +59 -74
  6. package/classes/DataUnit.md +1110 -1086
  7. package/classes/DataUnitAction.md +25 -42
  8. package/classes/DataUnitStorage.md +40 -43
  9. package/classes/DateUtils.md +133 -126
  10. package/classes/ElementIDUtils.md +123 -122
  11. package/classes/ErrorException.md +67 -88
  12. package/classes/ErrorTracking.md +20 -23
  13. package/classes/FieldComparator.md +35 -39
  14. package/classes/FloatingManager.md +195 -198
  15. package/classes/HTMLBuilder.md +14 -20
  16. package/classes/HttpProvider.md +45 -41
  17. package/classes/IDBRepository.md +201 -196
  18. package/classes/JSUtils.md +65 -66
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +93 -128
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +206 -70
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/OverflowWatcher.md +533 -0
  25. package/classes/PromiseSync.md +25 -42
  26. package/classes/ReadyUtil.md +31 -41
  27. package/classes/RequestMetadata.md +29 -30
  28. package/classes/SearchUtils.md +18 -20
  29. package/classes/SelectionInfo.md +73 -74
  30. package/classes/SkwHttpProvider.md +33 -45
  31. package/classes/StringUtils.md +297 -322
  32. package/classes/TimeFormatter.md +43 -44
  33. package/classes/UserAgentUtils.md +17 -20
  34. package/classes/VersionUtils.md +15 -18
  35. package/classes/WaitingChangeException.md +63 -84
  36. package/classes/WarningException.md +67 -88
  37. package/enumerations/Action.md +307 -0
  38. package/enumerations/ChangeOperation.md +47 -0
  39. package/enumerations/DataType.md +57 -0
  40. package/enumerations/DependencyType.md +37 -0
  41. package/enumerations/OverflowDirection.md +29 -0
  42. package/enumerations/SelectionMode.md +27 -0
  43. package/enumerations/SortMode.md +27 -0
  44. package/enumerations/UserInterface.md +177 -0
  45. package/functions/defaultDataLoader.md +25 -0
  46. package/{modules.md → globals.md} +26 -36
  47. package/interfaces/ChildDescriptor.md +12 -16
  48. package/interfaces/ChildLink.md +9 -12
  49. package/interfaces/DUActionInterceptor.md +10 -14
  50. package/interfaces/ExecutionContext.md +17 -32
  51. package/interfaces/FieldDescriptor.md +52 -66
  52. package/interfaces/Filter.md +13 -17
  53. package/interfaces/IElementIDInfo.md +11 -14
  54. package/interfaces/ILoadResult.md +11 -16
  55. package/interfaces/IRepository.md +106 -93
  56. package/interfaces/IRepositoryIndex.md +23 -30
  57. package/interfaces/LoadDataRequest.md +36 -45
  58. package/interfaces/LoadDataResponse.md +11 -14
  59. package/interfaces/OverFlowWatcherParams.md +67 -0
  60. package/interfaces/PageRequest.md +16 -20
  61. package/interfaces/PaginationInfo.md +24 -31
  62. package/interfaces/PromiseSyncCallback.md +13 -17
  63. package/interfaces/QuickFilter.md +17 -21
  64. package/interfaces/Record.md +26 -33
  65. package/interfaces/SavedRecord.md +33 -41
  66. package/interfaces/Sort.md +12 -16
  67. package/interfaces/SortingProvider.md +10 -13
  68. package/interfaces/UnitMetadata.md +16 -21
  69. package/interfaces/WaitingChange.md +16 -20
  70. package/namespaces/MaskFormatter/README.md +17 -0
  71. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  72. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  73. package/package.json +1 -1
  74. package/type-aliases/DataUnitEventOptions.md +17 -0
  75. package/type-aliases/OnOverflowCallBack.md +25 -0
  76. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
  77. package/enums/Action.md +0 -305
  78. package/enums/ChangeOperation.md +0 -52
  79. package/enums/DataType.md +0 -63
  80. package/enums/DependencyType.md +0 -41
  81. package/enums/SelectionMode.md +0 -30
  82. package/enums/SortMode.md +0 -30
  83. package/enums/UserInterface.md +0 -195
  84. package/modules/MaskFormatter.md +0 -37
package/classes/ReadyUtil.md CHANGED
@@ -1,58 +1,48 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ReadyUtil
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: ReadyUtil
4
-
5
- `ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
6
-
7
- ## Table of contents
8
-
9
- ### Constructors
3
+ ***
10
4
 
11
- - [constructor](ReadyUtil.md#constructor)
5
+ [@sankhyalabs/core](../globals.md) / ReadyUtil
12
6
 
13
- ### Properties
7
+ # Class: ReadyUtil
14
8
 
15
- - [promise](ReadyUtil.md#promise)
16
- - [resolve](ReadyUtil.md#resolve)
9
+ `ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
17
10
 
18
- ### Methods
11
+ ## Constructors
19
12
 
20
- - [clean](ReadyUtil.md#clean)
21
- - [end](ReadyUtil.md#end)
22
- - [start](ReadyUtil.md#start)
23
- - [whenReady](ReadyUtil.md#whenready)
13
+ ### new ReadyUtil()
24
14
 
25
- ## Constructors
15
+ > **new ReadyUtil**(): [`ReadyUtil`](ReadyUtil.md)
26
16
 
27
- ### constructor
17
+ #### Returns
28
18
 
29
- • **new ReadyUtil**()
19
+ [`ReadyUtil`](ReadyUtil.md)
30
20
 
31
21
  ## Properties
32
22
 
33
23
  ### promise
34
24
 
35
- • `Private` **promise**: `any`
25
+ > `private` **promise**: `any`
36
26
 
37
- #### Defined in
27
+ #### Source
38
28
 
39
29
  src/utils/ReadyUtil.ts:6
40
30
 
41
- ___
31
+ ***
42
32
 
43
33
  ### resolve
44
34
 
45
- • `Private` **resolve**: `any`
35
+ > `private` **resolve**: `any`
46
36
 
47
- #### Defined in
37
+ #### Source
48
38
 
49
39
  src/utils/ReadyUtil.ts:5
50
40
 
51
41
  ## Methods
52
42
 
53
- ### clean
43
+ ### clean()
54
44
 
55
- ▸ `Private` **clean**(): `void`
45
+ > `private` **clean**(): `void`
56
46
 
57
47
  Limpa o estado da instancia ao finalizar a execução do processo registrado.
58
48
 
@@ -60,15 +50,15 @@ Limpa o estado da instancia ao finalizar a execução do processo registrado.
60
50
 
61
51
  `void`
62
52
 
63
- #### Defined in
53
+ #### Source
64
54
 
65
55
  src/utils/ReadyUtil.ts:11
66
56
 
67
- ___
57
+ ***
68
58
 
69
- ### end
59
+ ### end()
70
60
 
71
- ▸ **end**(): `void`
61
+ > **end**(): `void`
72
62
 
73
63
  Executa processo atribuído.
74
64
 
@@ -76,15 +66,15 @@ Executa processo atribuído.
76
66
 
77
67
  `void`
78
68
 
79
- #### Defined in
69
+ #### Source
80
70
 
81
71
  src/utils/ReadyUtil.ts:28
82
72
 
83
- ___
73
+ ***
84
74
 
85
- ### start
75
+ ### start()
86
76
 
87
- ▸ `Private` **start**(): `void`
77
+ > `private` **start**(): `void`
88
78
 
89
79
  Inicializa o estado da instancia ao registrar processo.
90
80
 
@@ -92,24 +82,24 @@ Inicializa o estado da instancia ao registrar processo.
92
82
 
93
83
  `void`
94
84
 
95
- #### Defined in
85
+ #### Source
96
86
 
97
87
  src/utils/ReadyUtil.ts:19
98
88
 
99
- ___
89
+ ***
100
90
 
101
- ### whenReady
91
+ ### whenReady()
102
92
 
103
- ▸ **whenReady**(): `Promise`<`unknown`\>
93
+ > **whenReady**(): `Promise`\<`unknown`\>
104
94
 
105
95
  Atribui processo que será executado por operações que o invocarem no método 'end'.
106
96
 
107
97
  #### Returns
108
98
 
109
- `Promise`<`unknown`\>
99
+ `Promise`\<`unknown`\>
110
100
 
111
101
  Promise que deve conter o código do processo.
112
102
 
113
- #### Defined in
103
+ #### Source
114
104
 
115
105
  src/utils/ReadyUtil.ts:36
package/classes/RequestMetadata.md CHANGED
@@ -1,37 +1,36 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / RequestMetadata
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / RequestMetadata
2
6
 
3
7
  # Class: RequestMetadata
4
8
 
5
9
  Representa as propriedades necessárias para se executar uma requisição.
6
10
 
7
- ## Table of contents
11
+ ## Constructors
8
12
 
9
- ### Constructors
13
+ ### new RequestMetadata()
10
14
 
11
- - [constructor](RequestMetadata.md#constructor)
15
+ > **new RequestMetadata**(`url`, `method`, `headers`?): [`RequestMetadata`](RequestMetadata.md)
12
16
 
13
- ### Properties
17
+ #### Parameters
14
18
 
15
- - [headers](RequestMetadata.md#headers)
16
- - [method](RequestMetadata.md#method)
17
- - [timeout](RequestMetadata.md#timeout)
18
- - [url](RequestMetadata.md#url)
19
+ • **url**: `string`
19
20
 
20
- ## Constructors
21
+ A URL que deve ser chamada.
21
22
 
22
- ### constructor
23
+ • **method**: `Method`
23
24
 
24
- • **new RequestMetadata**(`url`, `method`, `headers?`)
25
+ O Método da requisição (GET, PUT, POST ou DELETE).
25
26
 
26
- #### Parameters
27
+ • **headers?**: `Header`[]
28
+
29
+ #### Returns
27
30
 
28
- | Name | Type | Description |
29
- | :------ | :------ | :------ |
30
- | `url` | `string` | A URL que deve ser chamada. |
31
- | `method` | `Method` | O Método da requisição (GET, PUT, POST ou DELETE). |
32
- | `headers?` | `Header`[] | - |
31
+ [`RequestMetadata`](RequestMetadata.md)
33
32
 
34
- #### Defined in
33
+ #### Source
35
34
 
36
35
  src/http/RequestMetadata.ts:22
37
36
 
@@ -39,46 +38,46 @@ src/http/RequestMetadata.ts:22
39
38
 
40
39
  ### headers
41
40
 
42
- • **headers**: `Header`[]
41
+ > **headers**: `Header`[]
43
42
 
44
43
  Headers para serem enviados na requisição
45
44
 
46
- #### Defined in
45
+ #### Source
47
46
 
48
47
  src/http/RequestMetadata.ts:16
49
48
 
50
- ___
49
+ ***
51
50
 
52
51
  ### method
53
52
 
54
- • **method**: `Method`
53
+ > **method**: `Method`
55
54
 
56
55
  O verbo HTTP
57
56
 
58
- #### Defined in
57
+ #### Source
59
58
 
60
59
  src/http/RequestMetadata.ts:10
61
60
 
62
- ___
61
+ ***
63
62
 
64
63
  ### timeout
65
64
 
66
- • **timeout**: `number` = `30000`
65
+ > **timeout**: `number` = `30000`
67
66
 
68
67
  Tempo limite de espera pela resposta
69
68
 
70
- #### Defined in
69
+ #### Source
71
70
 
72
71
  src/http/RequestMetadata.ts:13
73
72
 
74
- ___
73
+ ***
75
74
 
76
75
  ### url
77
76
 
78
- • **url**: `string`
77
+ > **url**: `string`
79
78
 
80
79
  A URL a ser chamada
81
80
 
82
- #### Defined in
81
+ #### Source
83
82
 
84
83
  src/http/RequestMetadata.ts:7
package/classes/SearchUtils.md CHANGED
@@ -1,43 +1,41 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SearchUtils
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: SearchUtils
4
-
5
- `Search`: Utilizado para manipulação de do objeto de pesquisa.
3
+ ***
6
4
 
7
- ## Table of contents
5
+ [@sankhyalabs/core](../globals.md) / SearchUtils
8
6
 
9
- ### Constructors
7
+ # Class: SearchUtils
10
8
 
11
- - [constructor](SearchUtils.md#constructor)
9
+ `Search`: Utilizado para manipulação de do objeto de pesquisa.
12
10
 
13
- ### Methods
11
+ ## Constructors
14
12
 
15
- - [buildDetails](SearchUtils.md#builddetails)
13
+ ### new SearchUtils()
16
14
 
17
- ## Constructors
15
+ > **new SearchUtils**(): [`SearchUtils`](SearchUtils.md)
18
16
 
19
- ### constructor
17
+ #### Returns
20
18
 
21
- • **new SearchUtils**()
19
+ [`SearchUtils`](SearchUtils.md)
22
20
 
23
21
  ## Methods
24
22
 
25
- ### buildDetails
23
+ ### buildDetails()
26
24
 
27
- ▸ `Static` **buildDetails**(`argument`, `fields`, `item`): `any`
25
+ > `static` **buildDetails**(`argument`, `fields`, `item`): `any`
28
26
 
29
27
  #### Parameters
30
28
 
31
- | Name | Type |
32
- | :------ | :------ |
33
- | `argument` | `String` |
34
- | `fields` | `any` |
35
- | `item` | `any` |
29
+ • **argument**: `String`
30
+
31
+ • **fields**: `any`
32
+
33
+ • **item**: `any`
36
34
 
37
35
  #### Returns
38
36
 
39
37
  `any`
40
38
 
41
- #### Defined in
39
+ #### Source
42
40
 
43
41
  src/utils/SearchUtils.ts:8
package/classes/SelectionInfo.md CHANGED
@@ -1,168 +1,167 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: SelectionInfo
3
+ ***
4
4
 
5
- ## Table of contents
5
+ [@sankhyalabs/core](../globals.md) / SelectionInfo
6
6
 
7
- ### Constructors
7
+ # Class: SelectionInfo
8
8
 
9
- - [constructor](SelectionInfo.md#constructor)
9
+ ## Constructors
10
10
 
11
- ### Properties
11
+ ### new SelectionInfo()
12
12
 
13
- - [\_records](SelectionInfo.md#_records)
14
- - [\_total](SelectionInfo.md#_total)
15
- - [filters](SelectionInfo.md#filters)
16
- - [mode](SelectionInfo.md#mode)
17
- - [sort](SelectionInfo.md#sort)
13
+ > **new SelectionInfo**(`records`, `mode`, `total`?, `filters`?, `sort`?): [`SelectionInfo`](SelectionInfo.md)
18
14
 
19
- ### Accessors
15
+ #### Parameters
20
16
 
21
- - [length](SelectionInfo.md#length)
22
- - [recordIds](SelectionInfo.md#recordids)
23
- - [records](SelectionInfo.md#records)
17
+ • **records**: [`Record`](../interfaces/Record.md)[]
24
18
 
25
- ### Methods
19
+ • **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)= `SelectionMode.SOME_RECORDS`
26
20
 
27
- - [isAllRecords](SelectionInfo.md#isallrecords)
28
- - [isEmpty](SelectionInfo.md#isempty)
21
+ • **total?**: `number`
29
22
 
30
- ## Constructors
23
+ • **filters?**: [`Filter`](../interfaces/Filter.md)[]
31
24
 
32
- ### constructor
25
+ • **sort?**: [`Sort`](../interfaces/Sort.md)[]
33
26
 
34
- • **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
35
-
36
- #### Parameters
27
+ #### Returns
37
28
 
38
- | Name | Type | Default value |
39
- | :------ | :------ | :------ |
40
- | `records` | [`Record`](../interfaces/Record.md)[] | `undefined` |
41
- | `mode` | [`SelectionMode`](../enums/SelectionMode.md) | `SelectionMode.SOME_RECORDS` |
42
- | `total?` | `number` | `undefined` |
43
- | `filters?` | [`Filter`](../interfaces/Filter.md)[] | `undefined` |
44
- | `sort?` | [`Sort`](../interfaces/Sort.md)[] | `undefined` |
29
+ [`SelectionInfo`](SelectionInfo.md)
45
30
 
46
- #### Defined in
31
+ #### Source
47
32
 
48
- src/dataunit/DataUnit.ts:1880
33
+ src/dataunit/DataUnit.ts:1975
49
34
 
50
35
  ## Properties
51
36
 
52
37
  ### \_records
53
38
 
54
- • `Private` **\_records**: [`Record`](../interfaces/Record.md)[]
39
+ > `private` **\_records**: [`Record`](../interfaces/Record.md)[]
40
+
41
+ #### Source
55
42
 
56
- #### Defined in
43
+ src/dataunit/DataUnit.ts:1972
57
44
 
58
- src/dataunit/DataUnit.ts:1874
45
+ ***
59
46
 
60
- ___
47
+ ### \_total?
61
48
 
62
- ### \_total
49
+ > `private` `optional` **\_total**: `number`
63
50
 
64
- • `Private` `Optional` **\_total**: `number`
51
+ #### Source
65
52
 
66
- #### Defined in
53
+ src/dataunit/DataUnit.ts:1973
67
54
 
68
- src/dataunit/DataUnit.ts:1876
55
+ ***
69
56
 
70
- ___
57
+ ### filters?
71
58
 
72
- ### filters
59
+ > `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
73
60
 
74
- • `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
61
+ #### Source
62
+
63
+ src/dataunit/DataUnit.ts:1969
64
+
65
+ ***
66
+
67
+ ### getAllRecords()?
68
+
69
+ > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
70
+
71
+ #### Returns
72
+
73
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
75
74
 
76
- #### Defined in
75
+ #### Source
77
76
 
78
- src/dataunit/DataUnit.ts:1877
77
+ src/dataunit/DataUnit.ts:1971
79
78
 
80
- ___
79
+ ***
81
80
 
82
81
  ### mode
83
82
 
84
- • **mode**: [`SelectionMode`](../enums/SelectionMode.md)
83
+ > **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
85
84
 
86
- #### Defined in
85
+ #### Source
87
86
 
88
- src/dataunit/DataUnit.ts:1875
87
+ src/dataunit/DataUnit.ts:1968
89
88
 
90
- ___
89
+ ***
91
90
 
92
- ### sort
91
+ ### sort?
93
92
 
94
- • `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
93
+ > `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
95
94
 
96
- #### Defined in
95
+ #### Source
97
96
 
98
- src/dataunit/DataUnit.ts:1878
97
+ src/dataunit/DataUnit.ts:1970
99
98
 
100
99
  ## Accessors
101
100
 
102
101
  ### length
103
102
 
104
- • `get` **length**(): `number`
103
+ > `get` **length**(): `number`
105
104
 
106
105
  #### Returns
107
106
 
108
107
  `number`
109
108
 
110
- #### Defined in
109
+ #### Source
111
110
 
112
- src/dataunit/DataUnit.ts:1905
111
+ src/dataunit/DataUnit.ts:2003
113
112
 
114
- ___
113
+ ***
115
114
 
116
115
  ### recordIds
117
116
 
118
- • `get` **recordIds**(): `undefined` \| `string`[]
117
+ > `get` **recordIds**(): `undefined` \| `string`[]
119
118
 
120
119
  #### Returns
121
120
 
122
121
  `undefined` \| `string`[]
123
122
 
124
- #### Defined in
123
+ #### Source
125
124
 
126
- src/dataunit/DataUnit.ts:1895
125
+ src/dataunit/DataUnit.ts:1993
127
126
 
128
- ___
127
+ ***
129
128
 
130
129
  ### records
131
130
 
132
- • `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
131
+ > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
133
132
 
134
133
  #### Returns
135
134
 
136
135
  `undefined` \| [`Record`](../interfaces/Record.md)[]
137
136
 
138
- #### Defined in
137
+ #### Source
139
138
 
140
- src/dataunit/DataUnit.ts:1888
139
+ src/dataunit/DataUnit.ts:1983
141
140
 
142
141
  ## Methods
143
142
 
144
- ### isAllRecords
143
+ ### isAllRecords()
145
144
 
146
- ▸ **isAllRecords**(): `boolean`
145
+ > **isAllRecords**(): `boolean`
147
146
 
148
147
  #### Returns
149
148
 
150
149
  `boolean`
151
150
 
152
- #### Defined in
151
+ #### Source
153
152
 
154
- src/dataunit/DataUnit.ts:1912
153
+ src/dataunit/DataUnit.ts:2010
155
154
 
156
- ___
155
+ ***
157
156
 
158
- ### isEmpty
157
+ ### isEmpty()
159
158
 
160
- ▸ **isEmpty**(): `boolean`
159
+ > **isEmpty**(): `boolean`
161
160
 
162
161
  #### Returns
163
162
 
164
163
  `boolean`
165
164
 
166
- #### Defined in
165
+ #### Source
167
166
 
168
- src/dataunit/DataUnit.ts:1916
167
+ src/dataunit/DataUnit.ts:2014