@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/enumerations/SelectionMode.md ADDED
@@ -0,0 +1,27 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / SelectionMode
6
+
7
+ # Enumeration: SelectionMode
8
+
9
+ ## Enumeration Members
10
+
11
+ ### ALL\_RECORDS
12
+
13
+ > **ALL\_RECORDS**: `"ALL_RECORDS"`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/DataUnit.ts:1902
18
+
19
+ ***
20
+
21
+ ### SOME\_RECORDS
22
+
23
+ > **SOME\_RECORDS**: `"SOME_RECORDS"`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/DataUnit.ts:1903
package/enumerations/SortMode.md ADDED
@@ -0,0 +1,27 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / SortMode
6
+
7
+ # Enumeration: SortMode
8
+
9
+ ## Enumeration Members
10
+
11
+ ### ASC
12
+
13
+ > **ASC**: `"ASC"`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/metadata/UnitMetadata.ts:71
18
+
19
+ ***
20
+
21
+ ### DESC
22
+
23
+ > **DESC**: `"DESC"`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/metadata/UnitMetadata.ts:72
package/enumerations/UserInterface.md ADDED
@@ -0,0 +1,177 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / UserInterface
6
+
7
+ # Enumeration: UserInterface
8
+
9
+ ## Enumeration Members
10
+
11
+ ### CHECKBOX
12
+
13
+ > **CHECKBOX**: `"CHECKBOX"`
14
+
15
+ #### Source
16
+
17
+ src/dataunit/metadata/UnitMetadata.ts:88
18
+
19
+ ***
20
+
21
+ ### DATE
22
+
23
+ > **DATE**: `"DATE"`
24
+
25
+ #### Source
26
+
27
+ src/dataunit/metadata/UnitMetadata.ts:84
28
+
29
+ ***
30
+
31
+ ### DATETIME
32
+
33
+ > **DATETIME**: `"DATETIME"`
34
+
35
+ #### Source
36
+
37
+ src/dataunit/metadata/UnitMetadata.ts:85
38
+
39
+ ***
40
+
41
+ ### DECIMALNUMBER
42
+
43
+ > **DECIMALNUMBER**: `"DECIMALNUMBER"`
44
+
45
+ #### Source
46
+
47
+ src/dataunit/metadata/UnitMetadata.ts:91
48
+
49
+ ***
50
+
51
+ ### ELAPSEDTIME
52
+
53
+ > **ELAPSEDTIME**: `"ELAPSEDTIME"`
54
+
55
+ #### Source
56
+
57
+ src/dataunit/metadata/UnitMetadata.ts:87
58
+
59
+ ***
60
+
61
+ ### FILE
62
+
63
+ > **FILE**: `"FILE"`
64
+
65
+ #### Source
66
+
67
+ src/dataunit/metadata/UnitMetadata.ts:82
68
+
69
+ ***
70
+
71
+ ### HTML
72
+
73
+ > **HTML**: `"HTML"`
74
+
75
+ #### Source
76
+
77
+ src/dataunit/metadata/UnitMetadata.ts:98
78
+
79
+ ***
80
+
81
+ ### IMAGE
82
+
83
+ > **IMAGE**: `"IMAGE"`
84
+
85
+ #### Source
86
+
87
+ src/dataunit/metadata/UnitMetadata.ts:83
88
+
89
+ ***
90
+
91
+ ### INTEGERNUMBER
92
+
93
+ > **INTEGERNUMBER**: `"INTEGERNUMBER"`
94
+
95
+ #### Source
96
+
97
+ src/dataunit/metadata/UnitMetadata.ts:92
98
+
99
+ ***
100
+
101
+ ### LONGTEXT
102
+
103
+ > **LONGTEXT**: `"LONGTEXT"`
104
+
105
+ #### Source
106
+
107
+ src/dataunit/metadata/UnitMetadata.ts:97
108
+
109
+ ***
110
+
111
+ ### MASKEDTEXT
112
+
113
+ > **MASKEDTEXT**: `"MASKEDTEXT"`
114
+
115
+ #### Source
116
+
117
+ src/dataunit/metadata/UnitMetadata.ts:96
118
+
119
+ ***
120
+
121
+ ### OPTIONSELECTOR
122
+
123
+ > **OPTIONSELECTOR**: `"OPTIONSELECTOR"`
124
+
125
+ #### Source
126
+
127
+ src/dataunit/metadata/UnitMetadata.ts:90
128
+
129
+ ***
130
+
131
+ ### PASSWORD
132
+
133
+ > **PASSWORD**: `"PASSWORD"`
134
+
135
+ #### Source
136
+
137
+ src/dataunit/metadata/UnitMetadata.ts:95
138
+
139
+ ***
140
+
141
+ ### SEARCH
142
+
143
+ > **SEARCH**: `"SEARCH"`
144
+
145
+ #### Source
146
+
147
+ src/dataunit/metadata/UnitMetadata.ts:93
148
+
149
+ ***
150
+
151
+ ### SHORTTEXT
152
+
153
+ > **SHORTTEXT**: `"SHORTTEXT"`
154
+
155
+ #### Source
156
+
157
+ src/dataunit/metadata/UnitMetadata.ts:94
158
+
159
+ ***
160
+
161
+ ### SWITCH
162
+
163
+ > **SWITCH**: `"SWITCH"`
164
+
165
+ #### Source
166
+
167
+ src/dataunit/metadata/UnitMetadata.ts:89
168
+
169
+ ***
170
+
171
+ ### TIME
172
+
173
+ > **TIME**: `"TIME"`
174
+
175
+ #### Source
176
+
177
+ src/dataunit/metadata/UnitMetadata.ts:86
package/functions/defaultDataLoader.md ADDED
@@ -0,0 +1,25 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / defaultDataLoader
6
+
7
+ # Function: defaultDataLoader()
8
+
9
+ > **defaultDataLoader**(`dataUnit`, `request`, `recordsIn`): `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
10
+
11
+ ## Parameters
12
+
13
+ • **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
14
+
15
+ • **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
16
+
17
+ • **recordsIn**: [`Record`](../interfaces/Record.md)[]
18
+
19
+ ## Returns
20
+
21
+ `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
22
+
23
+ ## Source
24
+
25
+ src/dataunit/DataUnitHelper.ts:26
package/{modules.md → globals.md} RENAMED
@@ -1,24 +1,24 @@
1
- [@sankhyalabs/core](README.md) / Exports
1
+ [**@sankhyalabs/core**](README.md) • **Docs**
2
2
 
3
- # @sankhyalabs/core
3
+ ***
4
4
 
5
- ## Table of contents
5
+ # @sankhyalabs/core
6
6
 
7
- ### Namespaces
7
+ ## Namespaces
8
8
 
9
- - [MaskFormatter](modules/MaskFormatter.md)
9
+ - [MaskFormatter](namespaces/MaskFormatter/README.md)
10
10
 
11
- ### Enumerations
11
+ ## Enumerations
12
12
 
13
- - [Action](enums/Action.md)
14
- - [ChangeOperation](enums/ChangeOperation.md)
15
- - [DataType](enums/DataType.md)
16
- - [DependencyType](enums/DependencyType.md)
17
- - [SelectionMode](enums/SelectionMode.md)
18
- - [SortMode](enums/SortMode.md)
19
- - [UserInterface](enums/UserInterface.md)
13
+ - [Action](enumerations/Action.md)
14
+ - [ChangeOperation](enumerations/ChangeOperation.md)
15
+ - [DataType](enumerations/DataType.md)
16
+ - [DependencyType](enumerations/DependencyType.md)
17
+ - [SelectionMode](enumerations/SelectionMode.md)
18
+ - [SortMode](enumerations/SortMode.md)
19
+ - [UserInterface](enumerations/UserInterface.md)
20
20
 
21
- ### Classes
21
+ ## Classes
22
22
 
23
23
  - [ApplicationContext](classes/ApplicationContext.md)
24
24
  - [ArrayUtils](classes/ArrayUtils.md)
@@ -38,7 +38,7 @@
38
38
  - [IDBRepository](classes/IDBRepository.md)
39
39
  - [JSUtils](classes/JSUtils.md)
40
40
  - [KeyboardManager](classes/KeyboardManager.md)
41
- - [MaskFormatter](classes/MaskFormatter-1.md)
41
+ - [MaskFormatter](classes/MaskFormatter.md)
42
42
  - [NumberUtils](classes/NumberUtils.md)
43
43
  - [ObjectUtils](classes/ObjectUtils.md)
44
44
  - [OnboardingUtils](classes/OnboardingUtils.md)
@@ -55,7 +55,7 @@
55
55
  - [WaitingChangeException](classes/WaitingChangeException.md)
56
56
  - [WarningException](classes/WarningException.md)
57
57
 
58
- ### Interfaces
58
+ ## Interfaces
59
59
 
60
60
  - [ChildDescriptor](interfaces/ChildDescriptor.md)
61
61
  - [ChildLink](interfaces/ChildLink.md)
@@ -80,28 +80,6 @@
80
80
  - [UnitMetadata](interfaces/UnitMetadata.md)
81
81
  - [WaitingChange](interfaces/WaitingChange.md)
82
82
 
83
- ### Functions
84
-
85
- - [defaultDataLoader](modules.md#defaultdataloader)
86
-
87
83
  ## Functions
88
84
 
89
- ### defaultDataLoader
90
-
91
- ▸ **defaultDataLoader**(`dataUnit`, `request`, `recordsIn`): `Promise`<[`LoadDataResponse`](interfaces/LoadDataResponse.md)\>
92
-
93
- #### Parameters
94
-
95
- | Name | Type |
96
- | :------ | :------ |
97
- | `dataUnit` | [`DataUnit`](classes/DataUnit.md) |
98
- | `request` | [`LoadDataRequest`](interfaces/LoadDataRequest.md) |
99
- | `recordsIn` | [`Record`](interfaces/Record.md)[] |
100
-
101
- #### Returns
102
-
103
- `Promise`<[`LoadDataResponse`](interfaces/LoadDataResponse.md)\>
104
-
105
- #### Defined in
106
-
107
- src/dataunit/DataUnitHelper.ts:26
85
+ - [defaultDataLoader](functions/defaultDataLoader.md)
package/interfaces/ChildDescriptor.md CHANGED
@@ -1,41 +1,37 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildDescriptor
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Interface: ChildDescriptor
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / ChildDescriptor
8
6
 
9
- - [label](ChildDescriptor.md#label)
10
- - [links](ChildDescriptor.md#links)
11
- - [name](ChildDescriptor.md#name)
7
+ # Interface: ChildDescriptor
12
8
 
13
9
  ## Properties
14
10
 
15
11
  ### label
16
12
 
17
- • **label**: `string`
13
+ > **label**: `string`
18
14
 
19
- #### Defined in
15
+ #### Source
20
16
 
21
17
  src/dataunit/metadata/UnitMetadata.ts:11
22
18
 
23
- ___
19
+ ***
24
20
 
25
21
  ### links
26
22
 
27
- • **links**: [`ChildLink`](ChildLink.md)[]
23
+ > **links**: [`ChildLink`](ChildLink.md)[]
28
24
 
29
- #### Defined in
25
+ #### Source
30
26
 
31
27
  src/dataunit/metadata/UnitMetadata.ts:13
32
28
 
33
- ___
29
+ ***
34
30
 
35
31
  ### name
36
32
 
37
- • **name**: `string`
33
+ > **name**: `string`
38
34
 
39
- #### Defined in
35
+ #### Source
40
36
 
41
37
  src/dataunit/metadata/UnitMetadata.ts:12
package/interfaces/ChildLink.md CHANGED
@@ -1,30 +1,27 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildLink
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Interface: ChildLink
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / ChildLink
8
6
 
9
- - [source](ChildLink.md#source)
10
- - [target](ChildLink.md#target)
7
+ # Interface: ChildLink
11
8
 
12
9
  ## Properties
13
10
 
14
11
  ### source
15
12
 
16
- • **source**: `string`
13
+ > **source**: `string`
17
14
 
18
- #### Defined in
15
+ #### Source
19
16
 
20
17
  src/dataunit/metadata/UnitMetadata.ts:17
21
18
 
22
- ___
19
+ ***
23
20
 
24
21
  ### target
25
22
 
26
- • **target**: `string`
23
+ > **target**: `string`
27
24
 
28
- #### Defined in
25
+ #### Source
29
26
 
30
27
  src/dataunit/metadata/UnitMetadata.ts:18
package/interfaces/DUActionInterceptor.md CHANGED
@@ -1,29 +1,25 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DUActionInterceptor
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Interface: DUActionInterceptor
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Methods
5
+ [@sankhyalabs/core](../globals.md) / DUActionInterceptor
8
6
 
9
- - [interceptAction](DUActionInterceptor.md#interceptaction)
7
+ # Interface: DUActionInterceptor
10
8
 
11
9
  ## Methods
12
10
 
13
- ### interceptAction
11
+ ### interceptAction()
14
12
 
15
- ▸ **interceptAction**(`action`): [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
13
+ > **interceptAction**(`action`): [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`\<[`DataUnitAction`](../classes/DataUnitAction.md)\>
16
14
 
17
15
  #### Parameters
18
16
 
19
- | Name | Type |
20
- | :------ | :------ |
21
- | `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
17
+ • **action**: [`DataUnitAction`](../classes/DataUnitAction.md)
22
18
 
23
19
  #### Returns
24
20
 
25
- [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
21
+ [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`\<[`DataUnitAction`](../classes/DataUnitAction.md)\>
26
22
 
27
- #### Defined in
23
+ #### Source
28
24
 
29
- src/dataunit/DataUnit.ts:1743
25
+ src/dataunit/DataUnit.ts:1777
package/interfaces/ExecutionContext.md CHANGED
@@ -1,58 +1,43 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ExecutionContext
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Interface: ExecutionContext
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / ExecutionContext
8
6
 
9
- - [after](ExecutionContext.md#after)
10
- - [before](ExecutionContext.md#before)
7
+ # Interface: ExecutionContext
11
8
 
12
9
  ## Properties
13
10
 
14
- ### after
15
-
16
- • `Optional` **after**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => `void`
11
+ ### after()?
17
12
 
18
- #### Type declaration
13
+ > `optional` **after**: (`action`) => `void`
19
14
 
20
- ▸ (`action`): `void`
15
+ #### Parameters
21
16
 
22
- ##### Parameters
17
+ • **action**: [`DataUnitAction`](../classes/DataUnitAction.md)
23
18
 
24
- | Name | Type |
25
- | :------ | :------ |
26
- | `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
27
-
28
- ##### Returns
19
+ #### Returns
29
20
 
30
21
  `void`
31
22
 
32
- #### Defined in
23
+ #### Source
33
24
 
34
25
  src/dataunit/state/action/DataUnitAction.ts:24
35
26
 
36
- ___
37
-
38
- ### before
39
-
40
- • `Optional` **before**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => [`DataUnitAction`](../classes/DataUnitAction.md)
27
+ ***
41
28
 
42
- #### Type declaration
29
+ ### before()?
43
30
 
44
- ▸ (`action`): [`DataUnitAction`](../classes/DataUnitAction.md)
31
+ > `optional` **before**: (`action`) => [`DataUnitAction`](../classes/DataUnitAction.md)
45
32
 
46
- ##### Parameters
33
+ #### Parameters
47
34
 
48
- | Name | Type |
49
- | :------ | :------ |
50
- | `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
35
+ • **action**: [`DataUnitAction`](../classes/DataUnitAction.md)
51
36
 
52
- ##### Returns
37
+ #### Returns
53
38
 
54
39
  [`DataUnitAction`](../classes/DataUnitAction.md)
55
40
 
56
- #### Defined in
41
+ #### Source
57
42
 
58
43
  src/dataunit/state/action/DataUnitAction.ts:23