@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

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 (60) hide show
  1. package/README.md +63 -0
  2. package/classes/ApplicationContext.md +90 -0
  3. package/classes/ArrayUtils.md +99 -0
  4. package/classes/AuthorizedServiceCaller.md +76 -0
  5. package/classes/Change.md +190 -0
  6. package/classes/DataUnit.md +2453 -0
  7. package/classes/DataUnitAction.md +96 -0
  8. package/classes/DataUnitStorage.md +116 -0
  9. package/classes/DateUtils.md +327 -0
  10. package/classes/ElementIDUtils.md +308 -0
  11. package/classes/ErrorException.md +214 -0
  12. package/classes/ErrorTracking.md +62 -0
  13. package/classes/FloatingManager.md +530 -0
  14. package/classes/HTMLBuilder.md +45 -0
  15. package/classes/HttpProvider.md +96 -0
  16. package/classes/JSUtils.md +115 -0
  17. package/classes/MaskFormatter-1.md +347 -0
  18. package/classes/NumberUtils.md +335 -0
  19. package/classes/ObjectUtils.md +160 -0
  20. package/classes/OnboardingUtils.md +126 -0
  21. package/classes/PromiseSync.md +91 -0
  22. package/classes/ReadyUtil.md +115 -0
  23. package/classes/RequestMetadata.md +84 -0
  24. package/classes/SelectionInfo.md +168 -0
  25. package/classes/SkwHttpProvider.md +109 -0
  26. package/classes/StringUtils.md +562 -0
  27. package/classes/TimeFormatter.md +98 -0
  28. package/classes/UserAgentUtils.md +58 -0
  29. package/classes/VersionUtils.md +42 -0
  30. package/classes/WaitingChangeException.md +200 -0
  31. package/classes/WarningException.md +214 -0
  32. package/enums/Action.md +294 -0
  33. package/enums/ChangeOperation.md +52 -0
  34. package/enums/DataType.md +63 -0
  35. package/enums/DependencyType.md +41 -0
  36. package/enums/SelectionMode.md +30 -0
  37. package/enums/SortMode.md +30 -0
  38. package/enums/UserInterface.md +195 -0
  39. package/interfaces/ChildDescriptor.md +41 -0
  40. package/interfaces/ChildLink.md +30 -0
  41. package/interfaces/DUActionInterceptor.md +29 -0
  42. package/interfaces/ExecutionContext.md +58 -0
  43. package/interfaces/FieldDescriptor.md +140 -0
  44. package/interfaces/Filter.md +41 -0
  45. package/interfaces/IElementIDInfo.md +30 -0
  46. package/interfaces/LoadDataRequest.md +101 -0
  47. package/interfaces/LoadDataResponse.md +36 -0
  48. package/interfaces/PageRequest.md +41 -0
  49. package/interfaces/PaginationInfo.md +75 -0
  50. package/interfaces/PromiseSyncCallback.md +39 -0
  51. package/interfaces/QuickFilter.md +41 -0
  52. package/interfaces/Record.md +62 -0
  53. package/interfaces/SavedRecord.md +85 -0
  54. package/interfaces/Sort.md +41 -0
  55. package/interfaces/SortingProvider.md +29 -0
  56. package/interfaces/UnitMetadata.md +52 -0
  57. package/interfaces/WaitingChange.md +41 -0
  58. package/modules/MaskFormatter.md +37 -0
  59. package/modules.md +74 -0
  60. package/package.json +14 -0
package/classes/VersionUtils.md ADDED
@@ -0,0 +1,42 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / VersionUtils
2
+
3
+ # Class: VersionUtils
4
+
5
+ ## Table of contents
6
+
7
+ ### Constructors
8
+
9
+ - [constructor](VersionUtils.md#constructor)
10
+
11
+ ### Methods
12
+
13
+ - [isRequiredVersion](VersionUtils.md#isrequiredversion)
14
+
15
+ ## Constructors
16
+
17
+ ### constructor
18
+
19
+ • **new VersionUtils**()
20
+
21
+ ## Methods
22
+
23
+ ### isRequiredVersion
24
+
25
+ ▸ `Static` **isRequiredVersion**(`currentVersion`, `requiredVersion`): `boolean`
26
+
27
+ Verifica se a versão do backend (SankhyaOM) é maior ou igual a uma determinada versão.
28
+
29
+ #### Parameters
30
+
31
+ | Name | Type |
32
+ | :------ | :------ |
33
+ | `currentVersion` | `string` |
34
+ | `requiredVersion` | `string` |
35
+
36
+ #### Returns
37
+
38
+ `boolean`
39
+
40
+ #### Defined in
41
+
42
+ src/utils/VersionUtils.ts:8
package/classes/WaitingChangeException.md ADDED
@@ -0,0 +1,200 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChangeException
2
+
3
+ # Class: WaitingChangeException
4
+
5
+ `WaitingChangeException`: Exceção lançada quando um campo está pendente de finalizar a alteração antes de executar uma ação.
6
+
7
+ ## Hierarchy
8
+
9
+ - `Error`
10
+
11
+ ↳ **`WaitingChangeException`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](WaitingChangeException.md#constructor)
18
+
19
+ ### Properties
20
+
21
+ - [cause](WaitingChangeException.md#cause)
22
+ - [message](WaitingChangeException.md#message)
23
+ - [name](WaitingChangeException.md#name)
24
+ - [stack](WaitingChangeException.md#stack)
25
+ - [title](WaitingChangeException.md#title)
26
+ - [prepareStackTrace](WaitingChangeException.md#preparestacktrace)
27
+ - [stackTraceLimit](WaitingChangeException.md#stacktracelimit)
28
+
29
+ ### Methods
30
+
31
+ - [captureStackTrace](WaitingChangeException.md#capturestacktrace)
32
+
33
+ ## Constructors
34
+
35
+ ### constructor
36
+
37
+ • **new WaitingChangeException**(`title`, `message`)
38
+
39
+ #### Parameters
40
+
41
+ | Name | Type |
42
+ | :------ | :------ |
43
+ | `title` | `string` |
44
+ | `message` | `string` |
45
+
46
+ #### Overrides
47
+
48
+ Error.constructor
49
+
50
+ #### Defined in
51
+
52
+ src/exceptions/WaitingChangeException.ts:15
53
+
54
+ ## Properties
55
+
56
+ ### cause
57
+
58
+ • `Optional` **cause**: `unknown`
59
+
60
+ #### Inherited from
61
+
62
+ Error.cause
63
+
64
+ #### Defined in
65
+
66
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
67
+
68
+ ___
69
+
70
+ ### message
71
+
72
+ • **message**: `string`
73
+
74
+ Descrição do erro.
75
+
76
+ #### Overrides
77
+
78
+ Error.message
79
+
80
+ #### Defined in
81
+
82
+ src/exceptions/WaitingChangeException.ts:13
83
+
84
+ ___
85
+
86
+ ### name
87
+
88
+ • **name**: `string`
89
+
90
+ Nome da exceção.
91
+
92
+ #### Overrides
93
+
94
+ Error.name
95
+
96
+ #### Defined in
97
+
98
+ src/exceptions/WaitingChangeException.ts:7
99
+
100
+ ___
101
+
102
+ ### stack
103
+
104
+ • `Optional` **stack**: `string`
105
+
106
+ #### Inherited from
107
+
108
+ Error.stack
109
+
110
+ #### Defined in
111
+
112
+ node_modules/typescript/lib/lib.es5.d.ts:1055
113
+
114
+ ___
115
+
116
+ ### title
117
+
118
+ • **title**: `string`
119
+
120
+ Titulo do erro.
121
+
122
+ #### Defined in
123
+
124
+ src/exceptions/WaitingChangeException.ts:10
125
+
126
+ ___
127
+
128
+ ### prepareStackTrace
129
+
130
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
131
+
132
+ #### Type declaration
133
+
134
+ ▸ (`err`, `stackTraces`): `any`
135
+
136
+ Optional override for formatting stack traces
137
+
138
+ **`See`**
139
+
140
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
141
+
142
+ ##### Parameters
143
+
144
+ | Name | Type |
145
+ | :------ | :------ |
146
+ | `err` | `Error` |
147
+ | `stackTraces` | `CallSite`[] |
148
+
149
+ ##### Returns
150
+
151
+ `any`
152
+
153
+ #### Inherited from
154
+
155
+ Error.prepareStackTrace
156
+
157
+ #### Defined in
158
+
159
+ node_modules/@types/node/globals.d.ts:11
160
+
161
+ ___
162
+
163
+ ### stackTraceLimit
164
+
165
+ ▪ `Static` **stackTraceLimit**: `number`
166
+
167
+ #### Inherited from
168
+
169
+ Error.stackTraceLimit
170
+
171
+ #### Defined in
172
+
173
+ node_modules/@types/node/globals.d.ts:13
174
+
175
+ ## Methods
176
+
177
+ ### captureStackTrace
178
+
179
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
180
+
181
+ Create .stack property on a target object
182
+
183
+ #### Parameters
184
+
185
+ | Name | Type |
186
+ | :------ | :------ |
187
+ | `targetObject` | `object` |
188
+ | `constructorOpt?` | `Function` |
189
+
190
+ #### Returns
191
+
192
+ `void`
193
+
194
+ #### Inherited from
195
+
196
+ Error.captureStackTrace
197
+
198
+ #### Defined in
199
+
200
+ node_modules/@types/node/globals.d.ts:4
package/classes/WarningException.md ADDED
@@ -0,0 +1,214 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WarningException
2
+
3
+ # Class: WarningException
4
+
5
+ `WarningException`: Exceção lançada quando o "erro" vindo do backend é caracterizado como warning.
6
+
7
+ ## Hierarchy
8
+
9
+ - `Error`
10
+
11
+ ↳ **`WarningException`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](WarningException.md#constructor)
18
+
19
+ ### Properties
20
+
21
+ - [cause](WarningException.md#cause)
22
+ - [errorCode](WarningException.md#errorcode)
23
+ - [message](WarningException.md#message)
24
+ - [name](WarningException.md#name)
25
+ - [stack](WarningException.md#stack)
26
+ - [title](WarningException.md#title)
27
+ - [prepareStackTrace](WarningException.md#preparestacktrace)
28
+ - [stackTraceLimit](WarningException.md#stacktracelimit)
29
+
30
+ ### Methods
31
+
32
+ - [captureStackTrace](WarningException.md#capturestacktrace)
33
+
34
+ ## Constructors
35
+
36
+ ### constructor
37
+
38
+ • **new WarningException**(`title`, `message`, `errorCode?`)
39
+
40
+ #### Parameters
41
+
42
+ | Name | Type | Default value |
43
+ | :------ | :------ | :------ |
44
+ | `title` | `string` | `undefined` |
45
+ | `message` | `string` | `undefined` |
46
+ | `errorCode` | `string` | `""` |
47
+
48
+ #### Overrides
49
+
50
+ Error.constructor
51
+
52
+ #### Defined in
53
+
54
+ src/exceptions/WarningException.ts:18
55
+
56
+ ## Properties
57
+
58
+ ### cause
59
+
60
+ • `Optional` **cause**: `unknown`
61
+
62
+ #### Inherited from
63
+
64
+ Error.cause
65
+
66
+ #### Defined in
67
+
68
+ node_modules/typescript/lib/lib.es2022.error.d.ts:26
69
+
70
+ ___
71
+
72
+ ### errorCode
73
+
74
+ • **errorCode**: `string`
75
+
76
+ Código do alerta, indica o alerta disparado pelo backend.
77
+
78
+ #### Defined in
79
+
80
+ src/exceptions/WarningException.ts:16
81
+
82
+ ___
83
+
84
+ ### message
85
+
86
+ • **message**: `string`
87
+
88
+ Descrição do alerta.
89
+
90
+ #### Overrides
91
+
92
+ Error.message
93
+
94
+ #### Defined in
95
+
96
+ src/exceptions/WarningException.ts:13
97
+
98
+ ___
99
+
100
+ ### name
101
+
102
+ • **name**: `string`
103
+
104
+ Nome da exceção.
105
+
106
+ #### Overrides
107
+
108
+ Error.name
109
+
110
+ #### Defined in
111
+
112
+ src/exceptions/WarningException.ts:7
113
+
114
+ ___
115
+
116
+ ### stack
117
+
118
+ • `Optional` **stack**: `string`
119
+
120
+ #### Inherited from
121
+
122
+ Error.stack
123
+
124
+ #### Defined in
125
+
126
+ node_modules/typescript/lib/lib.es5.d.ts:1055
127
+
128
+ ___
129
+
130
+ ### title
131
+
132
+ • **title**: `string`
133
+
134
+ Titulo do alerta.
135
+
136
+ #### Defined in
137
+
138
+ src/exceptions/WarningException.ts:10
139
+
140
+ ___
141
+
142
+ ### prepareStackTrace
143
+
144
+ ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
145
+
146
+ #### Type declaration
147
+
148
+ ▸ (`err`, `stackTraces`): `any`
149
+
150
+ Optional override for formatting stack traces
151
+
152
+ **`See`**
153
+
154
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
155
+
156
+ ##### Parameters
157
+
158
+ | Name | Type |
159
+ | :------ | :------ |
160
+ | `err` | `Error` |
161
+ | `stackTraces` | `CallSite`[] |
162
+
163
+ ##### Returns
164
+
165
+ `any`
166
+
167
+ #### Inherited from
168
+
169
+ Error.prepareStackTrace
170
+
171
+ #### Defined in
172
+
173
+ node_modules/@types/node/globals.d.ts:11
174
+
175
+ ___
176
+
177
+ ### stackTraceLimit
178
+
179
+ ▪ `Static` **stackTraceLimit**: `number`
180
+
181
+ #### Inherited from
182
+
183
+ Error.stackTraceLimit
184
+
185
+ #### Defined in
186
+
187
+ node_modules/@types/node/globals.d.ts:13
188
+
189
+ ## Methods
190
+
191
+ ### captureStackTrace
192
+
193
+ ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
194
+
195
+ Create .stack property on a target object
196
+
197
+ #### Parameters
198
+
199
+ | Name | Type |
200
+ | :------ | :------ |
201
+ | `targetObject` | `object` |
202
+ | `constructorOpt?` | `Function` |
203
+
204
+ #### Returns
205
+
206
+ `void`
207
+
208
+ #### Inherited from
209
+
210
+ Error.captureStackTrace
211
+
212
+ #### Defined in
213
+
214
+ node_modules/@types/node/globals.d.ts:4