@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.50

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 (85) 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 +1180 -1086
  7. package/classes/DataUnitAction.md +25 -42
  8. package/classes/DataUnitStorage.md +40 -43
  9. package/classes/DateUtils.md +140 -133
  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/ServiceCanceledException.md +193 -0
  31. package/classes/SkwHttpProvider.md +33 -45
  32. package/classes/StringUtils.md +297 -322
  33. package/classes/TimeFormatter.md +43 -44
  34. package/classes/UserAgentUtils.md +17 -20
  35. package/classes/VersionUtils.md +15 -18
  36. package/classes/WaitingChangeException.md +63 -84
  37. package/classes/WarningException.md +67 -88
  38. package/enumerations/Action.md +317 -0
  39. package/enumerations/ChangeOperation.md +47 -0
  40. package/enumerations/DataType.md +57 -0
  41. package/enumerations/DependencyType.md +37 -0
  42. package/enumerations/OverflowDirection.md +29 -0
  43. package/enumerations/SelectionMode.md +27 -0
  44. package/enumerations/SortMode.md +27 -0
  45. package/enumerations/UserInterface.md +177 -0
  46. package/functions/defaultDataLoader.md +25 -0
  47. package/{modules.md → globals.md} +27 -36
  48. package/interfaces/ChildDescriptor.md +12 -16
  49. package/interfaces/ChildLink.md +9 -12
  50. package/interfaces/DUActionInterceptor.md +10 -14
  51. package/interfaces/ExecutionContext.md +17 -32
  52. package/interfaces/FieldDescriptor.md +52 -66
  53. package/interfaces/Filter.md +13 -17
  54. package/interfaces/IElementIDInfo.md +11 -14
  55. package/interfaces/ILoadResult.md +11 -16
  56. package/interfaces/IRepository.md +106 -93
  57. package/interfaces/IRepositoryIndex.md +23 -30
  58. package/interfaces/LoadDataRequest.md +36 -45
  59. package/interfaces/LoadDataResponse.md +11 -14
  60. package/interfaces/OverFlowWatcherParams.md +67 -0
  61. package/interfaces/PageRequest.md +16 -20
  62. package/interfaces/PaginationInfo.md +24 -31
  63. package/interfaces/PromiseSyncCallback.md +13 -17
  64. package/interfaces/QuickFilter.md +17 -21
  65. package/interfaces/Record.md +26 -33
  66. package/interfaces/SavedRecord.md +33 -41
  67. package/interfaces/Sort.md +12 -16
  68. package/interfaces/SortingProvider.md +10 -13
  69. package/interfaces/UnitMetadata.md +16 -21
  70. package/interfaces/WaitingChange.md +16 -20
  71. package/namespaces/MaskFormatter/README.md +17 -0
  72. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  73. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  74. package/package.json +1 -1
  75. package/type-aliases/DataUnitEventOptions.md +17 -0
  76. package/type-aliases/OnOverflowCallBack.md +25 -0
  77. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
  78. package/enums/Action.md +0 -305
  79. package/enums/ChangeOperation.md +0 -52
  80. package/enums/DataType.md +0 -63
  81. package/enums/DependencyType.md +0 -41
  82. package/enums/SelectionMode.md +0 -30
  83. package/enums/SortMode.md +0 -30
  84. package/enums/UserInterface.md +0 -195
  85. package/modules/MaskFormatter.md +0 -37
@@ -1,49 +1,40 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ObjectUtils
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Class: ObjectUtils
4
-
5
- `ObjectUtils`: Utilizado para manipulação de objetos.
3
+ ***
6
4
 
7
- ## Table of contents
5
+ [@sankhyalabs/core](../globals.md) / ObjectUtils
8
6
 
9
- ### Constructors
7
+ # Class: ObjectUtils
10
8
 
11
- - [constructor](ObjectUtils.md#constructor)
9
+ `ObjectUtils`: Utilizado para manipulação de objetos.
12
10
 
13
- ### Methods
11
+ ## Constructors
14
12
 
15
- - [copy](ObjectUtils.md#copy)
16
- - [equals](ObjectUtils.md#equals)
17
- - [objectToString](ObjectUtils.md#objecttostring)
18
- - [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
19
- - [sortByProperty](ObjectUtils.md#sortbyproperty)
20
- - [stringToObject](ObjectUtils.md#stringtoobject)
13
+ ### new ObjectUtils()
21
14
 
22
- ## Constructors
15
+ > **new ObjectUtils**(): [`ObjectUtils`](ObjectUtils.md)
23
16
 
24
- ### constructor
17
+ #### Returns
25
18
 
26
- • **new ObjectUtils**()
19
+ [`ObjectUtils`](ObjectUtils.md)
27
20
 
28
21
  ## Methods
29
22
 
30
- ### copy
23
+ ### copy()
31
24
 
32
- `Static` **copy**<`T`\>(`data`): `T`
25
+ > `static` **copy**\<`T`\>(`data`): `T`
33
26
 
34
27
  Faz a cópia do objeto.
35
28
 
36
29
  #### Type parameters
37
30
 
38
- | Name |
39
- | :------ |
40
- | `T` |
31
+ **T**
41
32
 
42
33
  #### Parameters
43
34
 
44
- | Name | Type | Description |
45
- | :------ | :------ | :------ |
46
- | `data` | `Object` \| `Object`[] | Objeto a ser copiado. |
35
+ **data**: `Object` \| `Object`[]
36
+
37
+ Objeto a ser copiado.
47
38
 
48
39
  #### Returns
49
40
 
@@ -51,24 +42,27 @@ Faz a cópia do objeto.
51
42
 
52
43
  - A cópia do objeto válido.
53
44
 
54
- #### Defined in
45
+ #### Source
55
46
 
56
47
  src/utils/ObjectUtils.ts:13
57
48
 
58
- ___
49
+ ***
59
50
 
60
- ### equals
51
+ ### equals()
61
52
 
62
- `Static` **equals**(`obj1`, `obj2`): `any`
53
+ > `static` **equals**(`obj1`, `obj2`): `any`
63
54
 
64
55
  Compara se um objeto é igual a outro objeto.
65
56
 
66
57
  #### Parameters
67
58
 
68
- | Name | Type | Description |
69
- | :------ | :------ | :------ |
70
- | `obj1` | `any` | Objeto a ser comparado. |
71
- | `obj2` | `any` | Objeto a ser comparado. |
59
+ **obj1**: `any`
60
+
61
+ Objeto a ser comparado.
62
+
63
+ • **obj2**: `any`
64
+
65
+ Objeto a ser comparado.
72
66
 
73
67
  #### Returns
74
68
 
@@ -76,27 +70,164 @@ Compara se um objeto é igual a outro objeto.
76
70
 
77
71
  - Se o objeto 1 é igual ao objeto 2.
78
72
 
79
- #### Defined in
73
+ #### Source
80
74
 
81
75
  src/utils/ObjectUtils.ts:84
82
76
 
83
- ___
77
+ ***
84
78
 
85
- ### objectToString
79
+ ### getComparableProp()
86
80
 
87
- `Static` **objectToString**(`data`): `string`
81
+ > `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
88
82
 
89
- Converte um objeto em string/JSON.
83
+ #### Parameters
90
84
 
91
- **`Example`**
85
+ • **value**: `any`
92
86
 
93
- @Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
87
+ **propToCompare**: `string`= `"value"`
88
+
89
+ #### Returns
90
+
91
+ `boolean`
92
+
93
+ #### Source
94
+
95
+ src/utils/ObjectUtils.ts:106
96
+
97
+ ***
98
+
99
+ ### getProp()
100
+
101
+ > `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
102
+
103
+ Busca a propriedade de um objeto baseado em seu caminho.
94
104
 
95
105
  #### Parameters
96
106
 
97
- | Name | Type | Description |
98
- | :------ | :------ | :------ |
99
- | `data` | `Object` \| `Object`[] | Objeto a ser convertido. |
107
+ **obj**: `Record`\<`string`, `any`\>
108
+
109
+ Objeto a ser verificado.
110
+
111
+ • **keyPath**: `string`
112
+
113
+ Caminho da propriedade a ser buscada.
114
+
115
+ #### Returns
116
+
117
+ `undefined` \| `Record`\<`string`, `any`\>
118
+
119
+ - O valor da propriedade caso ela exista.
120
+
121
+ #### Source
122
+
123
+ src/utils/ObjectUtils.ts:140
124
+
125
+ ***
126
+
127
+ ### hasEquivalentProps()
128
+
129
+ > `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
130
+
131
+ Compara se o valor de dois items são equivalentes.
132
+ Comparando tanto o valor do item em si, quanto sua propriedade "value"
133
+
134
+ #### Parameters
135
+
136
+ • **obj1**: `any`
137
+
138
+ Objeto a ser comparado.
139
+
140
+ • **obj2**: `any`
141
+
142
+ Objeto a ser comparado.
143
+
144
+ • **propToCompare**: `string`= `"value"`
145
+
146
+ propriedade que deve ser comparada.
147
+
148
+ #### Returns
149
+
150
+ `boolean`
151
+
152
+ - Se o objeto 1 é equivalente ao objeto 2.
153
+
154
+ *
155
+
156
+ #### Examples
157
+
158
+ ```ts
159
+ hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
160
+ ```
161
+
162
+ ```ts
163
+ hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
164
+ ```
165
+
166
+ #### Source
167
+
168
+ src/utils/ObjectUtils.ts:102
169
+
170
+ ***
171
+
172
+ ### isEmpty()
173
+
174
+ > `static` **isEmpty**(`obj`): `boolean`
175
+
176
+ Verifica se o objeto está vazio (sem atributos).
177
+
178
+ #### Parameters
179
+
180
+ • **obj**: `object`
181
+
182
+ Objeto a ser verificado.
183
+
184
+ #### Returns
185
+
186
+ `boolean`
187
+
188
+ - True caso o objeto esteja vazio.
189
+
190
+ #### Source
191
+
192
+ src/utils/ObjectUtils.ts:119
193
+
194
+ ***
195
+
196
+ ### isNotEmpty()
197
+
198
+ > `static` **isNotEmpty**(`obj`): `boolean`
199
+
200
+ Verifica se o objeto NÃO está vazio (sem atributos).
201
+
202
+ #### Parameters
203
+
204
+ • **obj**: `object`
205
+
206
+ Objeto a ser verificado.
207
+
208
+ #### Returns
209
+
210
+ `boolean`
211
+
212
+ - True caso o objeto NÃO esteja vazio
213
+
214
+ #### Source
215
+
216
+ src/utils/ObjectUtils.ts:129
217
+
218
+ ***
219
+
220
+ ### objectToString()
221
+
222
+ > `static` **objectToString**(`data`): `string`
223
+
224
+ Converte um objeto em string/JSON.
225
+
226
+ #### Parameters
227
+
228
+ • **data**: `Object` \| `Object`[]
229
+
230
+ Objeto a ser convertido.
100
231
 
101
232
  #### Returns
102
233
 
@@ -104,23 +235,25 @@ Converte um objeto em string/JSON.
104
235
 
105
236
  - Uma string JSON.
106
237
 
107
- #### Defined in
238
+ #### Example
239
+
240
+ @Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
241
+
242
+ #### Source
108
243
 
109
244
  src/utils/ObjectUtils.ts:26
110
245
 
111
- ___
246
+ ***
112
247
 
113
- ### removeEmptyValues
248
+ ### removeEmptyValues()
114
249
 
115
- `Static` **removeEmptyValues**(`obj`): `object`
250
+ > `static` **removeEmptyValues**(`obj`): `object`
116
251
 
117
252
  Remove atributos nulos e indefinidos de um objeto.
118
253
 
119
254
  #### Parameters
120
255
 
121
- | Name | Type |
122
- | :------ | :------ |
123
- | `obj` | `object` |
256
+ **obj**: `object`
124
257
 
125
258
  #### Returns
126
259
 
@@ -128,24 +261,27 @@ Remove atributos nulos e indefinidos de um objeto.
128
261
 
129
262
  - O objeto com as propriedades válidas.
130
263
 
131
- #### Defined in
264
+ #### Source
132
265
 
133
266
  src/utils/ObjectUtils.ts:68
134
267
 
135
- ___
268
+ ***
136
269
 
137
- ### sortByProperty
270
+ ### sortByProperty()
138
271
 
139
- `Static` **sortByProperty**(`data`, `property`): `any`
272
+ > `static` **sortByProperty**(`data`, `property`): `any`
140
273
 
141
274
  Faz a ordenação de um objeto por uma propriedade.
142
275
 
143
276
  #### Parameters
144
277
 
145
- | Name | Type | Description |
146
- | :------ | :------ | :------ |
147
- | `data` | `any` | Objeto a ser ordenado. |
148
- | `property` | `string` | Nome da propriedade a ser ordenada. |
278
+ **data**: `any`
279
+
280
+ Objeto a ser ordenado.
281
+
282
+ • **property**: `string`
283
+
284
+ Nome da propriedade a ser ordenada.
149
285
 
150
286
  #### Returns
151
287
 
@@ -153,27 +289,23 @@ Faz a ordenação de um objeto por uma propriedade.
153
289
 
154
290
  - O objeto ordenado pela propriedade.
155
291
 
156
- #### Defined in
292
+ #### Source
157
293
 
158
294
  src/utils/ObjectUtils.ts:50
159
295
 
160
- ___
296
+ ***
161
297
 
162
- ### stringToObject
298
+ ### stringToObject()
163
299
 
164
- `Static` **stringToObject**(`data`): `Object` \| `Object`[]
300
+ > `static` **stringToObject**(`data`): `Object` \| `Object`[]
165
301
 
166
302
  Converte uma string/JSON em objeto.
167
303
 
168
- **`Example`**
169
-
170
- Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
171
-
172
304
  #### Parameters
173
305
 
174
- | Name | Type | Description |
175
- | :------ | :------ | :------ |
176
- | `data` | `string` | String a ser convertida. |
306
+ **data**: `string`
307
+
308
+ String a ser convertida.
177
309
 
178
310
  #### Returns
179
311
 
@@ -181,6 +313,10 @@ Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{no
181
313
 
182
314
  - Um objeto válido.
183
315
 
184
- #### Defined in
316
+ #### Example
317
+
318
+ Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
319
+
320
+ #### Source
185
321
 
186
322
  src/utils/ObjectUtils.ts:39
@@ -1,32 +1,22 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Class: OnboardingUtils
4
-
5
- ## Table of contents
6
-
7
- ### Constructors
3
+ ***
8
4
 
9
- - [constructor](OnboardingUtils.md#constructor)
5
+ [@sankhyalabs/core](../globals.md) / OnboardingUtils
10
6
 
11
- ### Properties
12
-
13
- - [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
14
- - [instance](OnboardingUtils.md#instance)
7
+ # Class: OnboardingUtils
15
8
 
16
- ### Methods
9
+ ## Constructors
17
10
 
18
- - [init](OnboardingUtils.md#init)
19
- - [injectScript](OnboardingUtils.md#injectscript)
20
- - [register](OnboardingUtils.md#register)
21
- - [getInstance](OnboardingUtils.md#getinstance)
11
+ ### new OnboardingUtils()
22
12
 
23
- ## Constructors
13
+ > `private` **new OnboardingUtils**(): [`OnboardingUtils`](OnboardingUtils.md)
24
14
 
25
- ### constructor
15
+ #### Returns
26
16
 
27
- `Private` **new OnboardingUtils**()
17
+ [`OnboardingUtils`](OnboardingUtils.md)
28
18
 
29
- #### Defined in
19
+ #### Source
30
20
 
31
21
  src/utils/OnboardingUtils.ts:5
32
22
 
@@ -34,93 +24,88 @@ src/utils/OnboardingUtils.ts:5
34
24
 
35
25
  ### USER\_GUIDE\_TAG\_ID
36
26
 
37
- `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
27
+ > `static` `private` `readonly` **USER\_GUIDE\_TAG\_ID**: `"userGuideSnippet"` = `"userGuideSnippet"`
38
28
 
39
- #### Defined in
29
+ #### Source
40
30
 
41
31
  src/utils/OnboardingUtils.ts:2
42
32
 
43
- ___
33
+ ***
44
34
 
45
35
  ### instance
46
36
 
47
- `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
37
+ > `static` `private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
48
38
 
49
- #### Defined in
39
+ #### Source
50
40
 
51
41
  src/utils/OnboardingUtils.ts:3
52
42
 
53
43
  ## Methods
54
44
 
55
- ### init
45
+ ### init()
56
46
 
57
- **init**(`apiKey`, `ctx`): `Promise`<`void`\>
47
+ > **init**(`apiKey`, `ctx`): `Promise`\<`void`\>
58
48
 
59
49
  #### Parameters
60
50
 
61
- | Name | Type |
62
- | :------ | :------ |
63
- | `apiKey` | `string` |
64
- | `ctx` | `EnvironmentContext` |
51
+ **apiKey**: `string`
52
+
53
+ **ctx**: `EnvironmentContext`
65
54
 
66
55
  #### Returns
67
56
 
68
- `Promise`<`void`\>
57
+ `Promise`\<`void`\>
69
58
 
70
- #### Defined in
59
+ #### Source
71
60
 
72
61
  src/utils/OnboardingUtils.ts:14
73
62
 
74
- ___
63
+ ***
75
64
 
76
- ### injectScript
65
+ ### injectScript()
77
66
 
78
- `Private` **injectScript**(`apiKey`): `void`
67
+ > `private` **injectScript**(`apiKey`): `void`
79
68
 
80
69
  #### Parameters
81
70
 
82
- | Name | Type |
83
- | :------ | :------ |
84
- | `apiKey` | `string` |
71
+ **apiKey**: `string`
85
72
 
86
73
  #### Returns
87
74
 
88
75
  `void`
89
76
 
90
- #### Defined in
77
+ #### Source
91
78
 
92
79
  src/utils/OnboardingUtils.ts:23
93
80
 
94
- ___
81
+ ***
95
82
 
96
- ### register
83
+ ### register()
97
84
 
98
- `Private` **register**(`ctx`): `void`
85
+ > `private` **register**(`ctx`): `void`
99
86
 
100
87
  #### Parameters
101
88
 
102
- | Name | Type |
103
- | :------ | :------ |
104
- | `ctx` | `EnvironmentContext` |
89
+ **ctx**: `EnvironmentContext`
105
90
 
106
91
  #### Returns
107
92
 
108
93
  `void`
109
94
 
110
- #### Defined in
95
+ #### Source
111
96
 
112
97
  src/utils/OnboardingUtils.ts:34
113
98
 
114
- ___
99
+ ***
115
100
 
116
- ### getInstance
101
+ ### getInstance()
117
102
 
118
- `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
103
+ > `static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
119
104
 
120
105
  #### Returns
121
106
 
122
107
  [`OnboardingUtils`](OnboardingUtils.md)
123
108
 
124
- #### Defined in
109
+ #### Source
125
110
 
126
111
  src/utils/OnboardingUtils.ts:7