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

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 (78) 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 +1017 -1091
  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 +179 -196
  18. package/classes/JSUtils.md +65 -66
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +81 -120
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +66 -71
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/PromiseSync.md +25 -42
  25. package/classes/ReadyUtil.md +31 -41
  26. package/classes/RequestMetadata.md +29 -30
  27. package/classes/SearchUtils.md +18 -20
  28. package/classes/SelectionInfo.md +59 -74
  29. package/classes/SkwHttpProvider.md +33 -45
  30. package/classes/StringUtils.md +297 -322
  31. package/classes/TimeFormatter.md +43 -44
  32. package/classes/UserAgentUtils.md +17 -20
  33. package/classes/VersionUtils.md +15 -18
  34. package/classes/WaitingChangeException.md +63 -84
  35. package/classes/WarningException.md +67 -88
  36. package/enumerations/Action.md +297 -0
  37. package/enumerations/ChangeOperation.md +47 -0
  38. package/enumerations/DataType.md +57 -0
  39. package/enumerations/DependencyType.md +37 -0
  40. package/enumerations/SelectionMode.md +27 -0
  41. package/enumerations/SortMode.md +27 -0
  42. package/enumerations/UserInterface.md +177 -0
  43. package/functions/defaultDataLoader.md +25 -0
  44. package/{modules.md → globals.md} +17 -39
  45. package/interfaces/ChildDescriptor.md +12 -16
  46. package/interfaces/ChildLink.md +9 -12
  47. package/interfaces/DUActionInterceptor.md +10 -14
  48. package/interfaces/ExecutionContext.md +17 -32
  49. package/interfaces/FieldDescriptor.md +52 -66
  50. package/interfaces/Filter.md +13 -17
  51. package/interfaces/IElementIDInfo.md +11 -14
  52. package/interfaces/ILoadResult.md +11 -16
  53. package/interfaces/IRepository.md +88 -93
  54. package/interfaces/IRepositoryIndex.md +23 -30
  55. package/interfaces/LoadDataRequest.md +36 -45
  56. package/interfaces/LoadDataResponse.md +11 -14
  57. package/interfaces/PageRequest.md +16 -20
  58. package/interfaces/PaginationInfo.md +24 -31
  59. package/interfaces/PromiseSyncCallback.md +13 -17
  60. package/interfaces/QuickFilter.md +17 -21
  61. package/interfaces/Record.md +26 -33
  62. package/interfaces/SavedRecord.md +33 -41
  63. package/interfaces/Sort.md +12 -16
  64. package/interfaces/SortingProvider.md +10 -13
  65. package/interfaces/UnitMetadata.md +16 -21
  66. package/interfaces/WaitingChange.md +16 -20
  67. package/namespaces/MaskFormatter/README.md +17 -0
  68. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  69. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  70. package/package.json +1 -1
  71. package/enums/Action.md +0 -305
  72. package/enums/ChangeOperation.md +0 -52
  73. package/enums/DataType.md +0 -63
  74. package/enums/DependencyType.md +0 -41
  75. package/enums/SelectionMode.md +0 -30
  76. package/enums/SortMode.md +0 -30
  77. package/enums/UserInterface.md +0 -195
  78. package/modules/MaskFormatter.md +0 -37
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,153 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: SelectionInfo
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Constructors
5
+ [@sankhyalabs/core](../globals.md) / SelectionInfo
8
6
 
9
- - [constructor](SelectionInfo.md#constructor)
7
+ # Class: SelectionInfo
10
8
 
11
- ### Properties
9
+ ## Constructors
12
10
 
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)
11
+ ### new SelectionInfo()
18
12
 
19
- ### Accessors
13
+ > **new SelectionInfo**(`records`, `mode`, `total`?, `filters`?, `sort`?): [`SelectionInfo`](SelectionInfo.md)
20
14
 
21
- - [length](SelectionInfo.md#length)
22
- - [recordIds](SelectionInfo.md#recordids)
23
- - [records](SelectionInfo.md#records)
15
+ #### Parameters
24
16
 
25
- ### Methods
17
+ • **records**: [`Record`](../interfaces/Record.md)[]
26
18
 
27
- - [isAllRecords](SelectionInfo.md#isallrecords)
28
- - [isEmpty](SelectionInfo.md#isempty)
19
+ • **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)= `SelectionMode.SOME_RECORDS`
29
20
 
30
- ## Constructors
21
+ • **total?**: `number`
31
22
 
32
- ### constructor
23
+ • **filters?**: [`Filter`](../interfaces/Filter.md)[]
33
24
 
34
- • **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
25
+ • **sort?**: [`Sort`](../interfaces/Sort.md)[]
35
26
 
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:1914
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)[]
55
40
 
56
- #### Defined in
41
+ #### Source
57
42
 
58
- src/dataunit/DataUnit.ts:1874
43
+ src/dataunit/DataUnit.ts:1908
59
44
 
60
- ___
45
+ ***
61
46
 
62
- ### \_total
47
+ ### \_total?
63
48
 
64
- • `Private` `Optional` **\_total**: `number`
49
+ > `private` `optional` **\_total**: `number`
65
50
 
66
- #### Defined in
51
+ #### Source
67
52
 
68
- src/dataunit/DataUnit.ts:1876
53
+ src/dataunit/DataUnit.ts:1910
69
54
 
70
- ___
55
+ ***
71
56
 
72
- ### filters
57
+ ### filters?
73
58
 
74
- • `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
59
+ > `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
75
60
 
76
- #### Defined in
61
+ #### Source
77
62
 
78
- src/dataunit/DataUnit.ts:1877
63
+ src/dataunit/DataUnit.ts:1911
79
64
 
80
- ___
65
+ ***
81
66
 
82
67
  ### mode
83
68
 
84
- • **mode**: [`SelectionMode`](../enums/SelectionMode.md)
69
+ > **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
85
70
 
86
- #### Defined in
71
+ #### Source
87
72
 
88
- src/dataunit/DataUnit.ts:1875
73
+ src/dataunit/DataUnit.ts:1909
89
74
 
90
- ___
75
+ ***
91
76
 
92
- ### sort
77
+ ### sort?
93
78
 
94
- • `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
79
+ > `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
95
80
 
96
- #### Defined in
81
+ #### Source
97
82
 
98
- src/dataunit/DataUnit.ts:1878
83
+ src/dataunit/DataUnit.ts:1912
99
84
 
100
85
  ## Accessors
101
86
 
102
87
  ### length
103
88
 
104
- • `get` **length**(): `number`
89
+ > `get` **length**(): `number`
105
90
 
106
91
  #### Returns
107
92
 
108
93
  `number`
109
94
 
110
- #### Defined in
95
+ #### Source
111
96
 
112
- src/dataunit/DataUnit.ts:1905
97
+ src/dataunit/DataUnit.ts:1939
113
98
 
114
- ___
99
+ ***
115
100
 
116
101
  ### recordIds
117
102
 
118
- • `get` **recordIds**(): `undefined` \| `string`[]
103
+ > `get` **recordIds**(): `undefined` \| `string`[]
119
104
 
120
105
  #### Returns
121
106
 
122
107
  `undefined` \| `string`[]
123
108
 
124
- #### Defined in
109
+ #### Source
125
110
 
126
- src/dataunit/DataUnit.ts:1895
111
+ src/dataunit/DataUnit.ts:1929
127
112
 
128
- ___
113
+ ***
129
114
 
130
115
  ### records
131
116
 
132
- • `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
117
+ > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
133
118
 
134
119
  #### Returns
135
120
 
136
121
  `undefined` \| [`Record`](../interfaces/Record.md)[]
137
122
 
138
- #### Defined in
123
+ #### Source
139
124
 
140
- src/dataunit/DataUnit.ts:1888
125
+ src/dataunit/DataUnit.ts:1922
141
126
 
142
127
  ## Methods
143
128
 
144
- ### isAllRecords
129
+ ### isAllRecords()
145
130
 
146
- ▸ **isAllRecords**(): `boolean`
131
+ > **isAllRecords**(): `boolean`
147
132
 
148
133
  #### Returns
149
134
 
150
135
  `boolean`
151
136
 
152
- #### Defined in
137
+ #### Source
153
138
 
154
- src/dataunit/DataUnit.ts:1912
139
+ src/dataunit/DataUnit.ts:1946
155
140
 
156
- ___
141
+ ***
157
142
 
158
- ### isEmpty
143
+ ### isEmpty()
159
144
 
160
- ▸ **isEmpty**(): `boolean`
145
+ > **isEmpty**(): `boolean`
161
146
 
162
147
  #### Returns
163
148
 
164
149
  `boolean`
165
150
 
166
- #### Defined in
151
+ #### Source
167
152
 
168
- src/dataunit/DataUnit.ts:1916
153
+ src/dataunit/DataUnit.ts:1950
package/classes/SkwHttpProvider.md CHANGED
@@ -1,109 +1,97 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SkwHttpProvider
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: SkwHttpProvider
4
-
5
- ## Table of contents
6
-
7
- ### Constructors
3
+ ***
8
4
 
9
- - [constructor](SkwHttpProvider.md#constructor)
5
+ [@sankhyalabs/core](../globals.md) / SkwHttpProvider
10
6
 
11
- ### Properties
12
-
13
- - [STATUS\_CANCELED](SkwHttpProvider.md#status_canceled)
14
- - [STATUS\_ERROR](SkwHttpProvider.md#status_error)
15
- - [STATUS\_INFO](SkwHttpProvider.md#status_info)
16
- - [STATUS\_OK](SkwHttpProvider.md#status_ok)
17
- - [STATUS\_TIMEOUT](SkwHttpProvider.md#status_timeout)
18
- - [\_counter](SkwHttpProvider.md#_counter)
7
+ # Class: SkwHttpProvider
19
8
 
20
- ### Methods
9
+ ## Constructors
21
10
 
22
- - [callService](SkwHttpProvider.md#callservice)
11
+ ### new SkwHttpProvider()
23
12
 
24
- ## Constructors
13
+ > **new SkwHttpProvider**(): [`SkwHttpProvider`](SkwHttpProvider.md)
25
14
 
26
- ### constructor
15
+ #### Returns
27
16
 
28
- • **new SkwHttpProvider**()
17
+ [`SkwHttpProvider`](SkwHttpProvider.md)
29
18
 
30
19
  ## Properties
31
20
 
32
21
  ### STATUS\_CANCELED
33
22
 
34
- ▪ `Static` **STATUS\_CANCELED**: `number` = `4`
23
+ > `static` **STATUS\_CANCELED**: `number` = `4`
35
24
 
36
- #### Defined in
25
+ #### Source
37
26
 
38
27
  src/http/SkwHttpProvider.ts:8
39
28
 
40
- ___
29
+ ***
41
30
 
42
31
  ### STATUS\_ERROR
43
32
 
44
- ▪ `Static` **STATUS\_ERROR**: `number` = `0`
33
+ > `static` **STATUS\_ERROR**: `number` = `0`
45
34
 
46
- #### Defined in
35
+ #### Source
47
36
 
48
37
  src/http/SkwHttpProvider.ts:4
49
38
 
50
- ___
39
+ ***
51
40
 
52
41
  ### STATUS\_INFO
53
42
 
54
- ▪ `Static` **STATUS\_INFO**: `number` = `2`
43
+ > `static` **STATUS\_INFO**: `number` = `2`
55
44
 
56
- #### Defined in
45
+ #### Source
57
46
 
58
47
  src/http/SkwHttpProvider.ts:6
59
48
 
60
- ___
49
+ ***
61
50
 
62
51
  ### STATUS\_OK
63
52
 
64
- ▪ `Static` **STATUS\_OK**: `number` = `1`
53
+ > `static` **STATUS\_OK**: `number` = `1`
65
54
 
66
- #### Defined in
55
+ #### Source
67
56
 
68
57
  src/http/SkwHttpProvider.ts:5
69
58
 
70
- ___
59
+ ***
71
60
 
72
61
  ### STATUS\_TIMEOUT
73
62
 
74
- ▪ `Static` **STATUS\_TIMEOUT**: `number` = `3`
63
+ > `static` **STATUS\_TIMEOUT**: `number` = `3`
75
64
 
76
- #### Defined in
65
+ #### Source
77
66
 
78
67
  src/http/SkwHttpProvider.ts:7
79
68
 
80
- ___
69
+ ***
81
70
 
82
71
  ### \_counter
83
72
 
84
- ▪ `Static` **\_counter**: `number` = `0`
73
+ > `static` **\_counter**: `number` = `0`
85
74
 
86
- #### Defined in
75
+ #### Source
87
76
 
88
77
  src/http/SkwHttpProvider.ts:2
89
78
 
90
79
  ## Methods
91
80
 
92
- ### callService
81
+ ### callService()
93
82
 
94
- ▸ `Static` **callService**(`serviceName`, `content`): `Promise`<`Object`\>
83
+ > `static` **callService**(`serviceName`, `content`): `Promise`\<`Object`\>
95
84
 
96
85
  #### Parameters
97
86
 
98
- | Name | Type |
99
- | :------ | :------ |
100
- | `serviceName` | `string` |
101
- | `content` | `Object` |
87
+ • **serviceName**: `string`
88
+
89
+ • **content**: `Object`
102
90
 
103
91
  #### Returns
104
92
 
105
- `Promise`<`Object`\>
93
+ `Promise`\<`Object`\>
106
94
 
107
- #### Defined in
95
+ #### Source
108
96
 
109
97
  src/http/SkwHttpProvider.ts:10