@sankhyalabs/core-docs 2.4.0 → 2.4.2

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 (5) hide show
  1. package/classes/Change.md +9 -9
  2. package/classes/DataUnit.md +15 -15
  3. package/classes/ElementIDUtils.md +49 -17
  4. package/classes/StringUtils.md +25 -0
  5. package/package.json +1 -1
package/classes/Change.md CHANGED
@@ -12,8 +12,8 @@
12
12
 
13
13
  ### Properties
14
14
 
15
- - [DataUnit](Change.md#dataunit)
16
15
  - [\_operation](Change.md#_operation)
16
+ - [dataUnit](Change.md#dataunit)
17
17
  - [record](Change.md#record)
18
18
  - [sourceId](Change.md#sourceid)
19
19
  - [updatingFields](Change.md#updatingfields)
@@ -33,13 +33,13 @@
33
33
 
34
34
  ### constructor
35
35
 
36
- • **new Change**(`DataUnit`, `record`, `updates`, `operation`, `sourceId?`)
36
+ • **new Change**(`dataUnit`, `record`, `updates`, `operation`, `sourceId?`)
37
37
 
38
38
  #### Parameters
39
39
 
40
40
  | Name | Type |
41
41
  | :------ | :------ |
42
- | `DataUnit` | `string` |
42
+ | `dataUnit` | `string` |
43
43
  | `record` | [`Record`](../interfaces/Record.md) |
44
44
  | `updates` | `any` |
45
45
  | `operation` | [`ChangeOperation`](../enums/ChangeOperation.md) |
@@ -51,23 +51,23 @@ src/dataunit/DataUnit.ts:1059
51
51
 
52
52
  ## Properties
53
53
 
54
- ### DataUnit
54
+ ### \_operation
55
55
 
56
- • **DataUnit**: `string`
56
+ • `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
57
57
 
58
58
  #### Defined in
59
59
 
60
- src/dataunit/DataUnit.ts:1052
60
+ src/dataunit/DataUnit.ts:1057
61
61
 
62
62
  ___
63
63
 
64
- ### \_operation
64
+ ### dataUnit
65
65
 
66
- • `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
66
+ • **dataUnit**: `string`
67
67
 
68
68
  #### Defined in
69
69
 
70
- src/dataunit/DataUnit.ts:1057
70
+ src/dataunit/DataUnit.ts:1052
71
71
 
72
72
  ___
73
73
 
package/classes/DataUnit.md CHANGED
@@ -178,17 +178,17 @@ ___
178
178
 
179
179
  ### dataLoader
180
180
 
181
- • `Optional` **dataLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
181
+ • `Optional` **dataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
182
182
 
183
183
  #### Type declaration
184
184
 
185
- ▸ (`DataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
185
+ ▸ (`dataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
186
186
 
187
187
  ##### Parameters
188
188
 
189
189
  | Name | Type |
190
190
  | :------ | :------ |
191
- | `DataUnit` | [`DataUnit`](DataUnit.md) |
191
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
192
192
  | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
193
193
 
194
194
  ##### Returns
@@ -203,17 +203,17 @@ ___
203
203
 
204
204
  ### metadataLoader
205
205
 
206
- • `Optional` **metadataLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
206
+ • `Optional` **metadataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
207
207
 
208
208
  #### Type declaration
209
209
 
210
- ▸ (`DataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
210
+ ▸ (`dataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
211
211
 
212
212
  ##### Parameters
213
213
 
214
214
  | Name | Type |
215
215
  | :------ | :------ |
216
- | `DataUnit` | [`DataUnit`](DataUnit.md) |
216
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
217
217
 
218
218
  ##### Returns
219
219
 
@@ -227,17 +227,17 @@ ___
227
227
 
228
228
  ### recordLoader
229
229
 
230
- • `Optional` **recordLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
230
+ • `Optional` **recordLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
231
231
 
232
232
  #### Type declaration
233
233
 
234
- ▸ (`DataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
234
+ ▸ (`dataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
235
235
 
236
236
  ##### Parameters
237
237
 
238
238
  | Name | Type |
239
239
  | :------ | :------ |
240
- | `DataUnit` | [`DataUnit`](DataUnit.md) |
240
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
241
241
  | `recordIds` | `string`[] |
242
242
 
243
243
  ##### Returns
@@ -252,17 +252,17 @@ ___
252
252
 
253
253
  ### removeLoader
254
254
 
255
- • `Optional` **removeLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
255
+ • `Optional` **removeLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
256
256
 
257
257
  #### Type declaration
258
258
 
259
- ▸ (`DataUnit`, `recordIds`): `Promise`<`string`[]\>
259
+ ▸ (`dataUnit`, `recordIds`): `Promise`<`string`[]\>
260
260
 
261
261
  ##### Parameters
262
262
 
263
263
  | Name | Type |
264
264
  | :------ | :------ |
265
- | `DataUnit` | [`DataUnit`](DataUnit.md) |
265
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
266
266
  | `recordIds` | `string`[] |
267
267
 
268
268
  ##### Returns
@@ -277,17 +277,17 @@ ___
277
277
 
278
278
  ### saveLoader
279
279
 
280
- • `Optional` **saveLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
280
+ • `Optional` **saveLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
281
281
 
282
282
  #### Type declaration
283
283
 
284
- ▸ (`DataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
284
+ ▸ (`dataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
285
285
 
286
286
  ##### Parameters
287
287
 
288
288
  | Name | Type |
289
289
  | :------ | :------ |
290
- | `DataUnit` | [`DataUnit`](DataUnit.md) |
290
+ | `dataUnit` | [`DataUnit`](DataUnit.md) |
291
291
  | `changes` | [`Change`](Change.md)[] |
292
292
 
293
293
  ##### Returns
package/classes/ElementIDUtils.md CHANGED
@@ -2,7 +2,8 @@
2
2
 
3
3
  # Class: ElementIDUtils
4
4
 
5
- `ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id. A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
5
+ `ElementIDUtils`: O ElementIDUtils é um utilitário responsável por criar e adicionar identificadores únicos aos componentes através do atributo data-element-id.
6
+ A finalidade dele é otimizar a automação dos testes e melhorar a eficiência na manipulação dos componentes do Design System, garantindo seleções precisas e seguras.
6
7
 
7
8
  ## Table of contents
8
9
 
@@ -14,6 +15,7 @@
14
15
 
15
16
  - [DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME](ElementIDUtils.md#data_element_id_attribute_name)
16
17
  - [INTERNAL\_INPUT\_NAME](ElementIDUtils.md#internal_input_name)
18
+ - [REGEX\_DATAUNIT\_NAME](ElementIDUtils.md#regex_dataunit_name)
17
19
 
18
20
  ### Methods
19
21
 
@@ -26,6 +28,7 @@
26
28
  - [getDataElementID](ElementIDUtils.md#getdataelementid)
27
29
  - [getDataElementIDAttribute](ElementIDUtils.md#getdataelementidattribute)
28
30
  - [getInternalIDInfo](ElementIDUtils.md#getinternalidinfo)
31
+ - [parseDataUnitName](ElementIDUtils.md#parsedataunitname)
29
32
 
30
33
  ## Constructors
31
34
 
@@ -41,17 +44,27 @@
41
44
 
42
45
  #### Defined in
43
46
 
44
- src/utils/ElementIDUtils.ts:13
47
+ src/utils/ElementIDUtils.ts:14
45
48
 
46
49
  ___
47
50
 
48
51
  ### INTERNAL\_INPUT\_NAME
49
52
 
50
- ▪ `Static` **INTERNAL\_INPUT\_NAME**: `string` = `"internal"`
53
+ ▪ `Static` **INTERNAL\_INPUT\_NAME**: `string` = `"embedded"`
51
54
 
52
55
  #### Defined in
53
56
 
54
- src/utils/ElementIDUtils.ts:14
57
+ src/utils/ElementIDUtils.ts:15
58
+
59
+ ___
60
+
61
+ ### REGEX\_DATAUNIT\_NAME
62
+
63
+ ▪ `Static` `Private` **REGEX\_DATAUNIT\_NAME**: `RegExp`
64
+
65
+ #### Defined in
66
+
67
+ src/utils/ElementIDUtils.ts:16
55
68
 
56
69
  ## Methods
57
70
 
@@ -77,7 +90,7 @@ Cria e adiciona a propriedade `data-element-id` em um elemento.
77
90
 
78
91
  #### Defined in
79
92
 
80
- src/utils/ElementIDUtils.ts:24
93
+ src/utils/ElementIDUtils.ts:26
81
94
 
82
95
  ___
83
96
 
@@ -99,7 +112,7 @@ ___
99
112
 
100
113
  #### Defined in
101
114
 
102
- src/utils/ElementIDUtils.ts:33
115
+ src/utils/ElementIDUtils.ts:39
103
116
 
104
117
  ___
105
118
 
@@ -124,7 +137,7 @@ Adiciona a propriedade name do DataUnit como prefixo do data-element-id do eleme
124
137
 
125
138
  #### Defined in
126
139
 
127
- src/utils/ElementIDUtils.ts:136
140
+ src/utils/ElementIDUtils.ts:147
128
141
 
129
142
  ___
130
143
 
@@ -137,8 +150,8 @@ Adiciona sufixo ao atributo `data-element-id` de um elemento, utilizado para mon
137
150
  **`Example`**
138
151
 
139
152
  ```ts
140
- Um ez-combo-box tem data-element-id = codparc_input_internal_combo.
141
- Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_internal_combo' referente ao seu pai.
153
+ Um ez-combo-box tem data-element-id = codparc_input_embedded_combo.
154
+ Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como sufixo o id 'codparc_input_embedded_combo' referente ao seu pai.
142
155
  ```
143
156
 
144
157
  #### Parameters
@@ -157,7 +170,7 @@ Dentro desse ez-combo-box existe um ez-text-input. O data-element-id teria como
157
170
 
158
171
  #### Defined in
159
172
 
160
- src/utils/ElementIDUtils.ts:119
173
+ src/utils/ElementIDUtils.ts:130
161
174
 
162
175
  ___
163
176
 
@@ -181,7 +194,7 @@ Remove caracteres especiais.
181
194
 
182
195
  #### Defined in
183
196
 
184
- src/utils/ElementIDUtils.ts:150
197
+ src/utils/ElementIDUtils.ts:162
185
198
 
186
199
  ___
187
200
 
@@ -206,7 +219,7 @@ Obtém ID válido para o elemento.
206
219
 
207
220
  #### Defined in
208
221
 
209
- src/utils/ElementIDUtils.ts:79
222
+ src/utils/ElementIDUtils.ts:90
210
223
 
211
224
  ___
212
225
 
@@ -232,7 +245,7 @@ Obtém o `data-element-id` do elemento com adição do sufixo e ID.
232
245
 
233
246
  #### Defined in
234
247
 
235
- src/utils/ElementIDUtils.ts:55
248
+ src/utils/ElementIDUtils.ts:66
236
249
 
237
250
  ___
238
251
 
@@ -252,19 +265,18 @@ ___
252
265
 
253
266
  #### Defined in
254
267
 
255
- src/utils/ElementIDUtils.ts:155
268
+ src/utils/ElementIDUtils.ts:168
256
269
 
257
270
  ___
258
271
 
259
272
  ### getInternalIDInfo
260
273
 
261
- ▸ `Static` **getInternalIDInfo**(`originalID`, `sufix`): `string`
274
+ ▸ `Static` **getInternalIDInfo**(`sufix`): `string`
262
275
 
263
276
  #### Parameters
264
277
 
265
278
  | Name | Type |
266
279
  | :------ | :------ |
267
- | `originalID` | `string` |
268
280
  | `sufix` | `string` |
269
281
 
270
282
  #### Returns
@@ -273,4 +285,24 @@ ___
273
285
 
274
286
  #### Defined in
275
287
 
276
- src/utils/ElementIDUtils.ts:43
288
+ src/utils/ElementIDUtils.ts:54
289
+
290
+ ___
291
+
292
+ ### parseDataUnitName
293
+
294
+ ▸ `Static` `Private` **parseDataUnitName**(`uri`): `string`
295
+
296
+ #### Parameters
297
+
298
+ | Name | Type |
299
+ | :------ | :------ |
300
+ | `uri` | `string` |
301
+
302
+ #### Returns
303
+
304
+ `string`
305
+
306
+ #### Defined in
307
+
308
+ src/utils/ElementIDUtils.ts:175
package/classes/StringUtils.md CHANGED
@@ -23,6 +23,7 @@
23
23
  - [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
24
24
  - [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
25
25
  - [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
26
+ - [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
26
27
  - [toCamelCase](StringUtils.md#tocamelcase)
27
28
  - [toKebabCase](StringUtils.md#tokebabcase)
28
29
  - [toPascalCase](StringUtils.md#topascalcase)
@@ -364,6 +365,30 @@ src/utils/StringUtils.ts:36
364
365
 
365
366
  ___
366
367
 
368
+ ### replaceBlankCharacters
369
+
370
+ ▸ `Static` **replaceBlankCharacters**(`value`): `string`
371
+
372
+ Utilitário para remover caracteres em branco da string.
373
+
374
+ #### Parameters
375
+
376
+ | Name | Type | Description |
377
+ | :------ | :------ | :------ |
378
+ | `value` | `string` | String a ser removido os espaços. |
379
+
380
+ #### Returns
381
+
382
+ `string`
383
+
384
+ String sem espaços em branco.
385
+
386
+ #### Defined in
387
+
388
+ src/utils/StringUtils.ts:293
389
+
390
+ ___
391
+
367
392
  ### toCamelCase
368
393
 
369
394
  ▸ `Static` **toCamelCase**(`value`): `string`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "2.4.0",
3
+ "version": "2.4.2",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [