@sankhyalabs/core 5.20.0-dev.55 → 5.20.0-dev.57

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 (40) hide show
  1. package/.docs/classes/Change.md +11 -11
  2. package/.docs/classes/DataUnit.md +135 -135
  3. package/.docs/classes/LockManager.md +191 -0
  4. package/.docs/classes/MaskFormatter.md +61 -13
  5. package/.docs/classes/SelectionInfo.md +12 -12
  6. package/.docs/classes/SilentException.md +193 -0
  7. package/.docs/enumerations/ChangeOperation.md +4 -4
  8. package/.docs/enumerations/LockManagerOperation.md +21 -0
  9. package/.docs/enumerations/SelectionMode.md +2 -2
  10. package/.docs/globals.md +3 -0
  11. package/.docs/interfaces/DUActionInterceptor.md +1 -1
  12. package/.docs/interfaces/PageRequest.md +3 -3
  13. package/.docs/interfaces/QuickFilter.md +3 -3
  14. package/.docs/interfaces/Record.md +4 -4
  15. package/.docs/interfaces/SavedRecord.md +5 -5
  16. package/.docs/interfaces/WaitingChange.md +3 -3
  17. package/.docs/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  18. package/.docs/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  19. package/.docs/type-aliases/DataUnitEventOptions.md +1 -1
  20. package/dist/dataunit/DataUnit.js +4 -2
  21. package/dist/dataunit/DataUnit.js.map +1 -1
  22. package/dist/exceptions/SilentException.d.ts +14 -0
  23. package/dist/exceptions/SilentException.js +13 -0
  24. package/dist/exceptions/SilentException.js.map +1 -0
  25. package/dist/index.d.ts +3 -1
  26. package/dist/index.js +3 -1
  27. package/dist/index.js.map +1 -1
  28. package/dist/utils/LockManager.d.ts +46 -0
  29. package/dist/utils/LockManager.js +141 -0
  30. package/dist/utils/LockManager.js.map +1 -0
  31. package/dist/utils/MaskFormatter.d.ts +14 -0
  32. package/dist/utils/MaskFormatter.js +77 -1
  33. package/dist/utils/MaskFormatter.js.map +1 -1
  34. package/package.json +1 -1
  35. package/reports/test-report.xml +107 -107
  36. package/src/dataunit/DataUnit.ts +7 -4
  37. package/src/exceptions/SilentException.ts +25 -0
  38. package/src/index.ts +6 -1
  39. package/src/utils/LockManager.ts +157 -0
  40. package/src/utils/MaskFormatter.ts +88 -1
@@ -0,0 +1,191 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LockManager
6
+
7
+ # Class: LockManager
8
+
9
+ ## Constructors
10
+
11
+ ### new LockManager()
12
+
13
+ > **new LockManager**(): [`LockManager`](LockManager.md)
14
+
15
+ #### Returns
16
+
17
+ [`LockManager`](LockManager.md)
18
+
19
+ ## Properties
20
+
21
+ ### ATTRIBUTE\_NAME
22
+
23
+ > `static` **ATTRIBUTE\_NAME**: `string` = `"data-locker-manger-context-id"`
24
+
25
+ Nome do atributo que será utilizado para controlar contexto de locks nos elementos da DOM.
26
+
27
+ #### Source
28
+
29
+ src/utils/LockManager.ts:24
30
+
31
+ ***
32
+
33
+ ### \_locks
34
+
35
+ > `static` `private` **\_locks**: `Map`\<`string`, `Lock`[]\>
36
+
37
+ #### Source
38
+
39
+ src/utils/LockManager.ts:19
40
+
41
+ ## Methods
42
+
43
+ ### addLockManagerCtxId()
44
+
45
+ > `static` **addLockManagerCtxId**(`startElement`): `string`
46
+
47
+ Cria um contexto de locker, caso nao exista, para todos elementos pais iniciados com ez- ou snk-.
48
+
49
+ #### Parameters
50
+
51
+ • **startElement**: `HTMLElement`
52
+
53
+ Elemento de de onde o lock deve começar.
54
+
55
+ #### Returns
56
+
57
+ `string`
58
+
59
+ - O id do locker, que pode ser usado para iniciar ou aguardar um lock do contexto.
60
+
61
+ #### Source
62
+
63
+ src/utils/LockManager.ts:83
64
+
65
+ ***
66
+
67
+ ### buildContextID()
68
+
69
+ > `static` `private` **buildContextID**(): `string`
70
+
71
+ #### Returns
72
+
73
+ `string`
74
+
75
+ #### Source
76
+
77
+ src/utils/LockManager.ts:26
78
+
79
+ ***
80
+
81
+ ### buildLockerID()
82
+
83
+ > `static` `private` **buildLockerID**(`ctxId`, `operation`): `undefined` \| `string`
84
+
85
+ #### Parameters
86
+
87
+ • **ctxId**: `string` \| `HTMLElement`
88
+
89
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
90
+
91
+ #### Returns
92
+
93
+ `undefined` \| `string`
94
+
95
+ #### Source
96
+
97
+ src/utils/LockManager.ts:30
98
+
99
+ ***
100
+
101
+ ### findExistingCtxId()
102
+
103
+ > `static` `private` **findExistingCtxId**(`element`): `null` \| `string`
104
+
105
+ #### Parameters
106
+
107
+ • **element**: `HTMLElement`
108
+
109
+ #### Returns
110
+
111
+ `null` \| `string`
112
+
113
+ #### Source
114
+
115
+ src/utils/LockManager.ts:43
116
+
117
+ ***
118
+
119
+ ### lock()
120
+
121
+ > `static` **lock**(`id`, `operation`): `any`
122
+
123
+ Inicia um locker baseado em um contexto e uma operação.
124
+
125
+ #### Parameters
126
+
127
+ • **id**: `string` \| `HTMLElement`
128
+
129
+ Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
130
+
131
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
132
+
133
+ Operação do contexto que o lock deve ser feito.
134
+
135
+ #### Returns
136
+
137
+ `any`
138
+
139
+ - Uma função que fara a liberação do lock.
140
+
141
+ #### Source
142
+
143
+ src/utils/LockManager.ts:114
144
+
145
+ ***
146
+
147
+ ### traverseAndAddAttr()
148
+
149
+ > `static` `private` **traverseAndAddAttr**(`element`, `ctxId`): `void`
150
+
151
+ #### Parameters
152
+
153
+ • **element**: `HTMLElement`
154
+
155
+ • **ctxId**: `string`
156
+
157
+ #### Returns
158
+
159
+ `void`
160
+
161
+ #### Source
162
+
163
+ src/utils/LockManager.ts:65
164
+
165
+ ***
166
+
167
+ ### whenResolve()
168
+
169
+ > `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
170
+
171
+ Aguarda todos os lockers de um contexto e operação serem resolvidos.
172
+
173
+ #### Parameters
174
+
175
+ • **id**: `string` \| `HTMLElement`
176
+
177
+ Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
178
+
179
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
180
+
181
+ Operação do contexto que devera aguardar.
182
+
183
+ #### Returns
184
+
185
+ `Promise`\<`void`\>
186
+
187
+ - Promise que será resolvida quando todos lockers forem finalizados.
188
+
189
+ #### Source
190
+
191
+ src/utils/LockManager.ts:142
@@ -66,7 +66,7 @@ resultaria na string '123-____'.
66
66
 
67
67
  #### Source
68
68
 
69
- src/utils/MaskFormatter.ts:91
69
+ src/utils/MaskFormatter.ts:92
70
70
 
71
71
  ## Properties
72
72
 
@@ -76,7 +76,7 @@ src/utils/MaskFormatter.ts:91
76
76
 
77
77
  #### Source
78
78
 
79
- src/utils/MaskFormatter.ts:65
79
+ src/utils/MaskFormatter.ts:66
80
80
 
81
81
  ***
82
82
 
@@ -86,7 +86,7 @@ src/utils/MaskFormatter.ts:65
86
86
 
87
87
  #### Source
88
88
 
89
- src/utils/MaskFormatter.ts:66
89
+ src/utils/MaskFormatter.ts:67
90
90
 
91
91
  ***
92
92
 
@@ -99,7 +99,7 @@ ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espa
99
99
 
100
100
  #### Source
101
101
 
102
- src/utils/MaskFormatter.ts:72
102
+ src/utils/MaskFormatter.ts:73
103
103
 
104
104
  ***
105
105
 
@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
129
129
 
130
130
  #### Source
131
131
 
132
- src/utils/MaskFormatter.ts:379
132
+ src/utils/MaskFormatter.ts:466
133
133
 
134
134
  ***
135
135
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
149
149
 
150
150
  #### Source
151
151
 
152
- src/utils/MaskFormatter.ts:393
152
+ src/utils/MaskFormatter.ts:480
153
153
 
154
154
  ***
155
155
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
179
179
 
180
180
  #### Source
181
181
 
182
- src/utils/MaskFormatter.ts:304
182
+ src/utils/MaskFormatter.ts:391
183
183
 
184
184
  ***
185
185
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
209
209
 
210
210
  #### Source
211
211
 
212
- src/utils/MaskFormatter.ts:285
212
+ src/utils/MaskFormatter.ts:372
213
213
 
214
214
  ***
215
215
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:285
219
219
 
220
220
  #### Source
221
221
 
222
- src/utils/MaskFormatter.ts:356
222
+ src/utils/MaskFormatter.ts:443
223
223
 
224
224
  ***
225
225
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
239
239
 
240
240
  #### Source
241
241
 
242
- src/utils/MaskFormatter.ts:333
242
+ src/utils/MaskFormatter.ts:420
243
243
 
244
244
  ## Accessors
245
245
 
@@ -265,10 +265,34 @@ A última máscara informada.
265
265
 
266
266
  #### Source
267
267
 
268
- src/utils/MaskFormatter.ts:87
268
+ src/utils/MaskFormatter.ts:88
269
269
 
270
270
  ## Methods
271
271
 
272
+ ### applyMask()
273
+
274
+ > **applyMask**(`value`): `string`
275
+
276
+ Aplica a máscara quando o input é alterado
277
+
278
+ #### Parameters
279
+
280
+ • **value**: `string`
281
+
282
+ Valor a ser aplicado com a máscara.
283
+
284
+ #### Returns
285
+
286
+ `string`
287
+
288
+ O valor processado de acordo com o padrão.
289
+
290
+ #### Source
291
+
292
+ src/utils/MaskFormatter.ts:103
293
+
294
+ ***
295
+
272
296
  ### format()
273
297
 
274
298
  > **format**(`value`, `trimBefore`): `string`
@@ -293,7 +317,31 @@ O valor processado de acordo com o padrão.
293
317
 
294
318
  #### Source
295
319
 
296
- src/utils/MaskFormatter.ts:102
320
+ src/utils/MaskFormatter.ts:189
321
+
322
+ ***
323
+
324
+ ### removeMask()
325
+
326
+ > **removeMask**(`value`): `string`
327
+
328
+ Remove a máscara formatando a string retornando sem máscara
329
+
330
+ #### Parameters
331
+
332
+ • **value**: `string`
333
+
334
+ Valor a ser formatado com máscara.
335
+
336
+ #### Returns
337
+
338
+ `string`
339
+
340
+ O valor processado de acordo com o padrão.
341
+
342
+ #### Source
343
+
344
+ src/utils/MaskFormatter.ts:169
297
345
 
298
346
  ***
299
347
 
@@ -309,4 +357,4 @@ Prepara a formatação internamente de acordo com o padrão.
309
357
 
310
358
  #### Source
311
359
 
312
- src/utils/MaskFormatter.ts:122
360
+ src/utils/MaskFormatter.ts:209
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2027
33
+ src/dataunit/DataUnit.ts:2030
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2027
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2024
43
+ src/dataunit/DataUnit.ts:2027
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2024
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2025
53
+ src/dataunit/DataUnit.ts:2028
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2025
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2021
63
+ src/dataunit/DataUnit.ts:2024
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2021
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2023
77
+ src/dataunit/DataUnit.ts:2026
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2023
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2020
87
+ src/dataunit/DataUnit.ts:2023
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2020
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2022
97
+ src/dataunit/DataUnit.ts:2025
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2022
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2055
111
+ src/dataunit/DataUnit.ts:2058
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2055
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2045
125
+ src/dataunit/DataUnit.ts:2048
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2045
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2035
139
+ src/dataunit/DataUnit.ts:2038
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2035
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2062
153
+ src/dataunit/DataUnit.ts:2065
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2062
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2066
167
+ src/dataunit/DataUnit.ts:2069
@@ -0,0 +1,193 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / SilentException
6
+
7
+ # Class: SilentException
8
+
9
+ `SilentException`: Exceção lançada quando uma exception silenciosa é.
10
+
11
+ ## Extends
12
+
13
+ - `Error`
14
+
15
+ ## Constructors
16
+
17
+ ### new SilentException()
18
+
19
+ > **new SilentException**(`title`, `message`, `errorCode`): [`SilentException`](SilentException.md)
20
+
21
+ #### Parameters
22
+
23
+ • **title**: `string`= `""`
24
+
25
+ • **message**: `string`= `""`
26
+
27
+ • **errorCode**: `string`= `""`
28
+
29
+ #### Returns
30
+
31
+ [`SilentException`](SilentException.md)
32
+
33
+ #### Overrides
34
+
35
+ `Error.constructor`
36
+
37
+ #### Source
38
+
39
+ src/exceptions/SilentException.ts:18
40
+
41
+ ## Properties
42
+
43
+ ### cause?
44
+
45
+ > `optional` **cause**: `unknown`
46
+
47
+ #### Inherited from
48
+
49
+ `Error.cause`
50
+
51
+ #### Source
52
+
53
+ node\_modules/typescript/lib/lib.es2022.error.d.ts:26
54
+
55
+ ***
56
+
57
+ ### errorCode
58
+
59
+ > **errorCode**: `string`
60
+
61
+ Código do erro, indica o erro disparado pelo backend.
62
+
63
+ #### Source
64
+
65
+ src/exceptions/SilentException.ts:16
66
+
67
+ ***
68
+
69
+ ### message
70
+
71
+ > **message**: `string`
72
+
73
+ Descrição do erro.
74
+
75
+ #### Overrides
76
+
77
+ `Error.message`
78
+
79
+ #### Source
80
+
81
+ src/exceptions/SilentException.ts:13
82
+
83
+ ***
84
+
85
+ ### name
86
+
87
+ > **name**: `string`
88
+
89
+ Nome da exceção.
90
+
91
+ #### Overrides
92
+
93
+ `Error.name`
94
+
95
+ #### Source
96
+
97
+ src/exceptions/SilentException.ts:7
98
+
99
+ ***
100
+
101
+ ### stack?
102
+
103
+ > `optional` **stack**: `string`
104
+
105
+ #### Inherited from
106
+
107
+ `Error.stack`
108
+
109
+ #### Source
110
+
111
+ node\_modules/typescript/lib/lib.es5.d.ts:1055
112
+
113
+ ***
114
+
115
+ ### title
116
+
117
+ > **title**: `string`
118
+
119
+ Titulo do erro.
120
+
121
+ #### Source
122
+
123
+ src/exceptions/SilentException.ts:10
124
+
125
+ ***
126
+
127
+ ### prepareStackTrace()?
128
+
129
+ > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
130
+
131
+ Optional override for formatting stack traces
132
+
133
+ #### See
134
+
135
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
136
+
137
+ #### Parameters
138
+
139
+ • **err**: `Error`
140
+
141
+ • **stackTraces**: `CallSite`[]
142
+
143
+ #### Returns
144
+
145
+ `any`
146
+
147
+ #### Inherited from
148
+
149
+ `Error.prepareStackTrace`
150
+
151
+ #### Source
152
+
153
+ node\_modules/@types/node/globals.d.ts:27
154
+
155
+ ***
156
+
157
+ ### stackTraceLimit
158
+
159
+ > `static` **stackTraceLimit**: `number`
160
+
161
+ #### Inherited from
162
+
163
+ `Error.stackTraceLimit`
164
+
165
+ #### Source
166
+
167
+ node\_modules/@types/node/globals.d.ts:29
168
+
169
+ ## Methods
170
+
171
+ ### captureStackTrace()
172
+
173
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
174
+
175
+ Create .stack property on a target object
176
+
177
+ #### Parameters
178
+
179
+ • **targetObject**: `object`
180
+
181
+ • **constructorOpt?**: `Function`
182
+
183
+ #### Returns
184
+
185
+ `void`
186
+
187
+ #### Inherited from
188
+
189
+ `Error.captureStackTrace`
190
+
191
+ #### Source
192
+
193
+ node\_modules/@types/node/globals.d.ts:20
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1906
17
+ src/dataunit/DataUnit.ts:1909
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1906
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1908
27
+ src/dataunit/DataUnit.ts:1911
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1908
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1905
37
+ src/dataunit/DataUnit.ts:1908
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1905
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1907
47
+ src/dataunit/DataUnit.ts:1910
@@ -0,0 +1,21 @@
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
+ ### TASKBAR\_CLICK
14
+
15
+ > **TASKBAR\_CLICK**: `"taskbar_click"`
16
+
17
+ Operação de lock utilizada para controlar cliques nos botoes da taskbar.
18
+
19
+ #### Source
20
+
21
+ src/utils/LockManager.ts:9
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2014
17
+ src/dataunit/DataUnit.ts:2017
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2014
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2015
27
+ src/dataunit/DataUnit.ts:2018