@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.41

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 (84) 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 +1110 -1086
  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 +201 -196
  18. package/classes/JSUtils.md +65 -66
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +93 -128
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +206 -70
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/OverflowWatcher.md +533 -0
  25. package/classes/PromiseSync.md +25 -42
  26. package/classes/ReadyUtil.md +31 -41
  27. package/classes/RequestMetadata.md +29 -30
  28. package/classes/SearchUtils.md +18 -20
  29. package/classes/SelectionInfo.md +73 -74
  30. package/classes/SkwHttpProvider.md +33 -45
  31. package/classes/StringUtils.md +297 -322
  32. package/classes/TimeFormatter.md +43 -44
  33. package/classes/UserAgentUtils.md +17 -20
  34. package/classes/VersionUtils.md +15 -18
  35. package/classes/WaitingChangeException.md +63 -84
  36. package/classes/WarningException.md +67 -88
  37. package/enumerations/Action.md +307 -0
  38. package/enumerations/ChangeOperation.md +47 -0
  39. package/enumerations/DataType.md +57 -0
  40. package/enumerations/DependencyType.md +37 -0
  41. package/enumerations/OverflowDirection.md +29 -0
  42. package/enumerations/SelectionMode.md +27 -0
  43. package/enumerations/SortMode.md +27 -0
  44. package/enumerations/UserInterface.md +177 -0
  45. package/functions/defaultDataLoader.md +25 -0
  46. package/{modules.md → globals.md} +26 -36
  47. package/interfaces/ChildDescriptor.md +12 -16
  48. package/interfaces/ChildLink.md +9 -12
  49. package/interfaces/DUActionInterceptor.md +10 -14
  50. package/interfaces/ExecutionContext.md +17 -32
  51. package/interfaces/FieldDescriptor.md +52 -66
  52. package/interfaces/Filter.md +13 -17
  53. package/interfaces/IElementIDInfo.md +11 -14
  54. package/interfaces/ILoadResult.md +11 -16
  55. package/interfaces/IRepository.md +106 -93
  56. package/interfaces/IRepositoryIndex.md +23 -30
  57. package/interfaces/LoadDataRequest.md +36 -45
  58. package/interfaces/LoadDataResponse.md +11 -14
  59. package/interfaces/OverFlowWatcherParams.md +67 -0
  60. package/interfaces/PageRequest.md +16 -20
  61. package/interfaces/PaginationInfo.md +24 -31
  62. package/interfaces/PromiseSyncCallback.md +13 -17
  63. package/interfaces/QuickFilter.md +17 -21
  64. package/interfaces/Record.md +26 -33
  65. package/interfaces/SavedRecord.md +33 -41
  66. package/interfaces/Sort.md +12 -16
  67. package/interfaces/SortingProvider.md +10 -13
  68. package/interfaces/UnitMetadata.md +16 -21
  69. package/interfaces/WaitingChange.md +16 -20
  70. package/namespaces/MaskFormatter/README.md +17 -0
  71. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  72. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  73. package/package.json +1 -1
  74. package/type-aliases/DataUnitEventOptions.md +17 -0
  75. package/type-aliases/OnOverflowCallBack.md +25 -0
  76. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
  77. package/enums/Action.md +0 -305
  78. package/enums/ChangeOperation.md +0 -52
  79. package/enums/DataType.md +0 -63
  80. package/enums/DependencyType.md +0 -41
  81. package/enums/SelectionMode.md +0 -30
  82. package/enums/SortMode.md +0 -30
  83. package/enums/UserInterface.md +0 -195
  84. package/modules/MaskFormatter.md +0 -37
@@ -1,62 +1,55 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: Record
4
-
5
- ## Hierarchy
6
-
7
- - **`Record`**
3
+ ***
8
4
 
9
- [`SavedRecord`](SavedRecord.md)
5
+ [@sankhyalabs/core](../globals.md) / Record
10
6
 
11
- ## Indexable
7
+ # Interface: Record
12
8
 
13
- [key: `string`]: `any`
9
+ ## Extended by
14
10
 
15
- ## Table of contents
11
+ - [`SavedRecord`](SavedRecord.md)
16
12
 
17
- ### Properties
13
+ ## Indexable
18
14
 
19
- - [\_\_owner\_\_dataunit\_\_name\_\_](Record.md#__owner__dataunit__name__)
20
- - [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
21
- - [\_\_record\_\_id\_\_](Record.md#__record__id__)
22
- - [\_\_record\_\_label\_\_](Record.md#__record__label__)
15
+ \[`key`: `string`\]: `any`
23
16
 
24
17
  ## Properties
25
18
 
26
- ### \_\_owner\_\_dataunit\_\_name\_\_
19
+ ### \_\_owner\_\_dataunit\_\_name\_\_?
27
20
 
28
- `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
21
+ > `optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
29
22
 
30
- #### Defined in
23
+ #### Source
31
24
 
32
- src/dataunit/DataUnit.ts:1750
25
+ src/dataunit/DataUnit.ts:1844
33
26
 
34
- ___
27
+ ***
35
28
 
36
- ### \_\_parent\_\_record\_\_id\_\_
29
+ ### \_\_parent\_\_record\_\_id\_\_?
37
30
 
38
- `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
31
+ > `optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
39
32
 
40
- #### Defined in
33
+ #### Source
41
34
 
42
- src/dataunit/DataUnit.ts:1749
35
+ src/dataunit/DataUnit.ts:1843
43
36
 
44
- ___
37
+ ***
45
38
 
46
39
  ### \_\_record\_\_id\_\_
47
40
 
48
- **\_\_record\_\_id\_\_**: `string`
41
+ > **\_\_record\_\_id\_\_**: `string`
49
42
 
50
- #### Defined in
43
+ #### Source
51
44
 
52
- src/dataunit/DataUnit.ts:1747
45
+ src/dataunit/DataUnit.ts:1841
53
46
 
54
- ___
47
+ ***
55
48
 
56
- ### \_\_record\_\_label\_\_
49
+ ### \_\_record\_\_label\_\_?
57
50
 
58
- `Optional` **\_\_record\_\_label\_\_**: `string`
51
+ > `optional` **\_\_record\_\_label\_\_**: `string`
59
52
 
60
- #### Defined in
53
+ #### Source
61
54
 
62
- src/dataunit/DataUnit.ts:1748
55
+ src/dataunit/DataUnit.ts:1842
@@ -1,85 +1,77 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SavedRecord
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: SavedRecord
4
-
5
- ## Hierarchy
6
-
7
- - [`Record`](Record.md)
3
+ ***
8
4
 
9
- **`SavedRecord`**
5
+ [@sankhyalabs/core](../globals.md) / SavedRecord
10
6
 
11
- ## Table of contents
7
+ # Interface: SavedRecord
12
8
 
13
- ### Properties
9
+ ## Extends
14
10
 
15
- - [\_\_old\_\_id\_\_](SavedRecord.md#__old__id__)
16
- - [\_\_owner\_\_dataunit\_\_name\_\_](SavedRecord.md#__owner__dataunit__name__)
17
- - [\_\_parent\_\_record\_\_id\_\_](SavedRecord.md#__parent__record__id__)
18
- - [\_\_record\_\_id\_\_](SavedRecord.md#__record__id__)
19
- - [\_\_record\_\_label\_\_](SavedRecord.md#__record__label__)
11
+ - [`Record`](Record.md)
20
12
 
21
13
  ## Properties
22
14
 
23
- ### \_\_old\_\_id\_\_
15
+ ### \_\_old\_\_id\_\_?
24
16
 
25
- `Optional` **\_\_old\_\_id\_\_**: `string`
17
+ > `optional` **\_\_old\_\_id\_\_**: `string`
26
18
 
27
- #### Defined in
19
+ #### Source
28
20
 
29
- src/dataunit/DataUnit.ts:1755
21
+ src/dataunit/DataUnit.ts:1849
30
22
 
31
- ___
23
+ ***
32
24
 
33
- ### \_\_owner\_\_dataunit\_\_name\_\_
25
+ ### \_\_owner\_\_dataunit\_\_name\_\_?
34
26
 
35
- `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
27
+ > `optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
36
28
 
37
29
  #### Inherited from
38
30
 
39
- [Record](Record.md).[__owner__dataunit__name__](Record.md#__owner__dataunit__name__)
31
+ [`Record`](Record.md).[`__owner__dataunit__name__`](Record.md#__owner__dataunit__name__)
40
32
 
41
- #### Defined in
33
+ #### Source
42
34
 
43
- src/dataunit/DataUnit.ts:1750
35
+ src/dataunit/DataUnit.ts:1844
44
36
 
45
- ___
37
+ ***
46
38
 
47
- ### \_\_parent\_\_record\_\_id\_\_
39
+ ### \_\_parent\_\_record\_\_id\_\_?
48
40
 
49
- `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
41
+ > `optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
50
42
 
51
43
  #### Inherited from
52
44
 
53
- [Record](Record.md).[__parent__record__id__](Record.md#__parent__record__id__)
45
+ [`Record`](Record.md).[`__parent__record__id__`](Record.md#__parent__record__id__)
54
46
 
55
- #### Defined in
47
+ #### Source
56
48
 
57
- src/dataunit/DataUnit.ts:1749
49
+ src/dataunit/DataUnit.ts:1843
58
50
 
59
- ___
51
+ ***
60
52
 
61
53
  ### \_\_record\_\_id\_\_
62
54
 
63
- **\_\_record\_\_id\_\_**: `string`
55
+ > **\_\_record\_\_id\_\_**: `string`
64
56
 
65
57
  #### Inherited from
66
58
 
67
- [Record](Record.md).[__record__id__](Record.md#__record__id__)
59
+ [`Record`](Record.md).[`__record__id__`](Record.md#__record__id__)
68
60
 
69
- #### Defined in
61
+ #### Source
70
62
 
71
- src/dataunit/DataUnit.ts:1747
63
+ src/dataunit/DataUnit.ts:1841
72
64
 
73
- ___
65
+ ***
74
66
 
75
- ### \_\_record\_\_label\_\_
67
+ ### \_\_record\_\_label\_\_?
76
68
 
77
- `Optional` **\_\_record\_\_label\_\_**: `string`
69
+ > `optional` **\_\_record\_\_label\_\_**: `string`
78
70
 
79
71
  #### Inherited from
80
72
 
81
- [Record](Record.md).[__record__label__](Record.md#__record__label__)
73
+ [`Record`](Record.md).[`__record__label__`](Record.md#__record__label__)
82
74
 
83
- #### Defined in
75
+ #### Source
84
76
 
85
- src/dataunit/DataUnit.ts:1748
77
+ src/dataunit/DataUnit.ts:1842
@@ -1,41 +1,37 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Sort
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: Sort
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / Sort
8
6
 
9
- - [dataType](Sort.md#datatype)
10
- - [field](Sort.md#field)
11
- - [mode](Sort.md#mode)
7
+ # Interface: Sort
12
8
 
13
9
  ## Properties
14
10
 
15
11
  ### dataType
16
12
 
17
- **dataType**: [`DataType`](../enums/DataType.md)
13
+ > **dataType**: [`DataType`](../enumerations/DataType.md)
18
14
 
19
- #### Defined in
15
+ #### Source
20
16
 
21
17
  src/dataunit/metadata/UnitMetadata.ts:58
22
18
 
23
- ___
19
+ ***
24
20
 
25
21
  ### field
26
22
 
27
- **field**: `string`
23
+ > **field**: `string`
28
24
 
29
- #### Defined in
25
+ #### Source
30
26
 
31
27
  src/dataunit/metadata/UnitMetadata.ts:56
32
28
 
33
- ___
29
+ ***
34
30
 
35
31
  ### mode
36
32
 
37
- **mode**: [`SortMode`](../enums/SortMode.md)
33
+ > **mode**: [`SortMode`](../enumerations/SortMode.md)
38
34
 
39
- #### Defined in
35
+ #### Source
40
36
 
41
37
  src/dataunit/metadata/UnitMetadata.ts:57
@@ -1,30 +1,27 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortingProvider
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: SortingProvider
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Methods
5
+ [@sankhyalabs/core](../globals.md) / SortingProvider
8
6
 
9
- - [getSort](SortingProvider.md#getsort)
7
+ # Interface: SortingProvider
10
8
 
11
9
  ## Methods
12
10
 
13
- ### getSort
11
+ ### getSort()
14
12
 
15
- **getSort**(`dataUnit`, `defaultSorting`): `undefined` \| [`Sort`](Sort.md)[]
13
+ > **getSort**(`dataUnit`, `defaultSorting`): `undefined` \| [`Sort`](Sort.md)[]
16
14
 
17
15
  #### Parameters
18
16
 
19
- | Name | Type |
20
- | :------ | :------ |
21
- | `dataUnit` | `string` |
22
- | `defaultSorting` | [`Sort`](Sort.md)[] |
17
+ **dataUnit**: `string`
18
+
19
+ **defaultSorting**: [`Sort`](Sort.md)[]
23
20
 
24
21
  #### Returns
25
22
 
26
23
  `undefined` \| [`Sort`](Sort.md)[]
27
24
 
28
- #### Defined in
25
+ #### Source
29
26
 
30
27
  src/dataunit/metadata/UnitMetadata.ts:67
@@ -1,52 +1,47 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UnitMetadata
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: UnitMetadata
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / UnitMetadata
8
6
 
9
- - [children](UnitMetadata.md#children)
10
- - [fields](UnitMetadata.md#fields)
11
- - [label](UnitMetadata.md#label)
12
- - [name](UnitMetadata.md#name)
7
+ # Interface: UnitMetadata
13
8
 
14
9
  ## Properties
15
10
 
16
- ### children
11
+ ### children?
17
12
 
18
- `Optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
13
+ > `optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
19
14
 
20
- #### Defined in
15
+ #### Source
21
16
 
22
17
  src/dataunit/metadata/UnitMetadata.ts:7
23
18
 
24
- ___
19
+ ***
25
20
 
26
21
  ### fields
27
22
 
28
- **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
23
+ > **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
29
24
 
30
- #### Defined in
25
+ #### Source
31
26
 
32
27
  src/dataunit/metadata/UnitMetadata.ts:6
33
28
 
34
- ___
29
+ ***
35
30
 
36
31
  ### label
37
32
 
38
- **label**: `string`
33
+ > **label**: `string`
39
34
 
40
- #### Defined in
35
+ #### Source
41
36
 
42
37
  src/dataunit/metadata/UnitMetadata.ts:5
43
38
 
44
- ___
39
+ ***
45
40
 
46
41
  ### name
47
42
 
48
- **name**: `string`
43
+ > **name**: `string`
49
44
 
50
- #### Defined in
45
+ #### Source
51
46
 
52
47
  src/dataunit/metadata/UnitMetadata.ts:4
@@ -1,41 +1,37 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChange
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
2
 
3
- # Interface: WaitingChange
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@sankhyalabs/core](../globals.md) / WaitingChange
8
6
 
9
- - [blocking](WaitingChange.md#blocking)
10
- - [promise](WaitingChange.md#promise)
11
- - [waitmessage](WaitingChange.md#waitmessage)
7
+ # Interface: WaitingChange
12
8
 
13
9
  ## Properties
14
10
 
15
11
  ### blocking
16
12
 
17
- **blocking**: `boolean`
13
+ > **blocking**: `boolean`
18
14
 
19
- #### Defined in
15
+ #### Source
20
16
 
21
- src/dataunit/DataUnit.ts:1843
17
+ src/dataunit/DataUnit.ts:1937
22
18
 
23
- ___
19
+ ***
24
20
 
25
- ### promise
21
+ ### promise?
26
22
 
27
- `Optional` **promise**: `Promise`<`any`\>
23
+ > `optional` **promise**: `Promise`\<`any`\>
28
24
 
29
- #### Defined in
25
+ #### Source
30
26
 
31
- src/dataunit/DataUnit.ts:1844
27
+ src/dataunit/DataUnit.ts:1938
32
28
 
33
- ___
29
+ ***
34
30
 
35
31
  ### waitmessage
36
32
 
37
- **waitmessage**: `string`
33
+ > **waitmessage**: `string`
38
34
 
39
- #### Defined in
35
+ #### Source
40
36
 
41
- src/dataunit/DataUnit.ts:1842
37
+ src/dataunit/DataUnit.ts:1936
@@ -0,0 +1,17 @@
1
+ [**@sankhyalabs/core**](../../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../../globals.md) / MaskFormatter
6
+
7
+ # Namespace: MaskFormatter
8
+
9
+ ## Index
10
+
11
+ ### Type Aliases
12
+
13
+ - [MaskCharacter](type-aliases/MaskCharacter.md)
14
+
15
+ ### Variables
16
+
17
+ - [MaskCharacter](variables/MaskCharacter.md)
@@ -0,0 +1,13 @@
1
+ [**@sankhyalabs/core**](../../../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../../../globals.md) / [MaskFormatter](../README.md) / MaskCharacter
6
+
7
+ # Type alias: MaskCharacter
8
+
9
+ > **MaskCharacter**: `InstanceType`\<*typeof* [`MaskCharacter`](../variables/MaskCharacter.md)\>
10
+
11
+ ## Source
12
+
13
+ src/utils/MaskFormatter.ts:170
@@ -0,0 +1,13 @@
1
+ [**@sankhyalabs/core**](../../../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../../../globals.md) / [MaskFormatter](../README.md) / MaskCharacter
6
+
7
+ # Variable: MaskCharacter
8
+
9
+ > **MaskCharacter**: *typeof* `__class`
10
+
11
+ ## Source
12
+
13
+ src/utils/MaskFormatter.ts:170
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.20.0-dev.4",
3
+ "version": "5.20.0-dev.41",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
@@ -0,0 +1,17 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnitEventOptions
6
+
7
+ # Type alias: DataUnitEventOptions
8
+
9
+ > **DataUnitEventOptions**: `object`
10
+
11
+ ## Index signature
12
+
13
+ \[`key`: `string`\]: `any`
14
+
15
+ ## Source
16
+
17
+ src/dataunit/DataUnit.ts:2019
@@ -0,0 +1,25 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OnOverflowCallBack
6
+
7
+ # Type alias: OnOverflowCallBack()
8
+
9
+ > **OnOverflowCallBack**: (`elementsOverFlow`) => `void`
10
+
11
+ Callback que será chamado quando o overflow de um elemento for alterado.
12
+
13
+ ## Parameters
14
+
15
+ • **elementsOverFlow**: `Element`[]
16
+
17
+ Conjunto de elementos filhos que estão causando overflow no elemento pai.
18
+
19
+ ## Returns
20
+
21
+ `void`
22
+
23
+ ## Source
24
+
25
+ src/utils/OverflowWatcher/types/overflow-callback.ts:6
@@ -0,0 +1,13 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
6
+
7
+ # Variable: OVERFLOWED\_CLASS\_NAME
8
+
9
+ > `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
10
+
11
+ ## Source
12
+
13
+ src/utils/OverflowWatcher/index.ts:9