@openmrs/esm-framework 4.0.0-pre.1 → 4.0.1-pre.208

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 (91) hide show
  1. package/.turbo/turbo-build.log +23 -119
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -22
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +330 -774
  6. package/docs/classes/OpenmrsFetchError.md +4 -10
  7. package/docs/enums/Type.md +20 -20
  8. package/docs/enums/VisitMode.md +8 -8
  9. package/docs/enums/VisitStatus.md +6 -6
  10. package/docs/interfaces/AssignedExtension.md +7 -9
  11. package/docs/interfaces/BreadcrumbRegistration.md +2 -2
  12. package/docs/interfaces/BreadcrumbSettings.md +4 -22
  13. package/docs/interfaces/CancelLoading.md +1 -1
  14. package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
  15. package/docs/interfaces/ComponentDefinition.md +7 -19
  16. package/docs/interfaces/Config.md +3 -17
  17. package/docs/interfaces/ConfigObject.md +14 -17
  18. package/docs/interfaces/ConfigSchema.md +3 -3
  19. package/docs/interfaces/ConfigurableLinkProps.md +2 -2
  20. package/docs/interfaces/ConnectedExtension.md +4 -6
  21. package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
  22. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  23. package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
  24. package/docs/interfaces/DynamicOfflineData.md +5 -20
  25. package/docs/interfaces/DynamicOfflineDataHandler.md +9 -26
  26. package/docs/interfaces/DynamicOfflineDataSyncState.md +5 -17
  27. package/docs/interfaces/ErrorStateProps.md +2 -2
  28. package/docs/interfaces/ExtensionData.md +3 -3
  29. package/docs/interfaces/ExtensionDefinition.md +13 -37
  30. package/docs/interfaces/ExtensionProps.md +2 -2
  31. package/docs/interfaces/ExtensionRegistration.md +18 -7
  32. package/docs/interfaces/ExtensionSlotBaseProps.md +15 -4
  33. package/docs/interfaces/ExtensionSlotConfig.md +4 -4
  34. package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
  35. package/docs/interfaces/ExtensionSlotState.md +2 -2
  36. package/docs/interfaces/ExtensionStore.md +1 -1
  37. package/docs/interfaces/FHIRCode.md +3 -3
  38. package/docs/interfaces/FHIRRequestObj.md +3 -3
  39. package/docs/interfaces/FHIRRequestOptions.md +41 -0
  40. package/docs/interfaces/FHIRResource.md +1 -1
  41. package/docs/interfaces/FetchResponse.md +1 -1
  42. package/docs/interfaces/FetchResponseJson.md +7 -0
  43. package/docs/interfaces/ImportMap.md +1 -1
  44. package/docs/interfaces/Lifecycle.md +4 -4
  45. package/docs/interfaces/Location.md +3 -3
  46. package/docs/interfaces/LoggedInUser.md +11 -11
  47. package/docs/interfaces/LoggedInUserFetchResponse.md +1 -1
  48. package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
  49. package/docs/interfaces/NavigateOptions.md +2 -2
  50. package/docs/interfaces/NewVisitPayload.md +6 -6
  51. package/docs/interfaces/NotificationDescriptor.md +6 -6
  52. package/docs/interfaces/OfflineModeResult.md +3 -3
  53. package/docs/interfaces/OfflinePatientArgs.md +2 -4
  54. package/docs/interfaces/OfflinePatientDataSyncHandler.md +2 -4
  55. package/docs/interfaces/OfflinePatientDataSyncState.md +6 -8
  56. package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -4
  57. package/docs/interfaces/OldExtensionSlotBaseProps.md +65 -0
  58. package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
  59. package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
  60. package/docs/interfaces/OnlyThePatient.md +1 -1
  61. package/docs/interfaces/OpenmrsResource.md +2 -2
  62. package/docs/interfaces/PageDefinition.md +9 -25
  63. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  64. package/docs/interfaces/Person.md +3 -3
  65. package/docs/interfaces/Privilege.md +3 -3
  66. package/docs/interfaces/QueueItemDescriptor.md +4 -9
  67. package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
  68. package/docs/interfaces/ResourceLoader.md +1 -1
  69. package/docs/interfaces/RetryOptions.md +7 -18
  70. package/docs/interfaces/Role.md +3 -3
  71. package/docs/interfaces/Session.md +7 -7
  72. package/docs/interfaces/SessionLocation.md +3 -3
  73. package/docs/interfaces/ShowNotificationEvent.md +5 -5
  74. package/docs/interfaces/ShowToastEvent.md +4 -4
  75. package/docs/interfaces/SpaConfig.md +5 -19
  76. package/docs/interfaces/SyncItem.md +7 -11
  77. package/docs/interfaces/SyncProcessOptions.md +5 -7
  78. package/docs/interfaces/ToastDescriptor.md +5 -5
  79. package/docs/interfaces/ToastNotificationMeta.md +6 -6
  80. package/docs/interfaces/UserHasAccessProps.md +4 -4
  81. package/docs/interfaces/Visit.md +9 -9
  82. package/docs/interfaces/VisitItem.md +4 -4
  83. package/docs/interfaces/VisitType.md +3 -3
  84. package/jest.config.js +3 -0
  85. package/mock.tsx +3 -7
  86. package/package.json +13 -13
  87. package/src/integration-tests/extension-config.test.tsx +215 -17
  88. package/typedoc.json +1 -1
  89. package/.turbo/turbo-lint.log +0 -2
  90. package/.turbo/turbo-test.log +0 -451
  91. package/.turbo/turbo-typescript.log +0 -2
package/docs/classes/OpenmrsFetchError.md CHANGED
@@ -53,7 +53,7 @@ Error.constructor
53
53
 
54
54
  #### Defined in
55
55
 
56
- [packages/framework/esm-api/src/openmrs-fetch.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L286)
56
+ [packages/framework/esm-api/src/openmrs-fetch.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L281)
57
57
 
58
58
  ## API Properties
59
59
 
@@ -63,17 +63,17 @@ Error.constructor
63
63
 
64
64
  #### Defined in
65
65
 
66
- [packages/framework/esm-api/src/openmrs-fetch.ts:299](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L299)
66
+ [packages/framework/esm-api/src/openmrs-fetch.ts:294](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L294)
67
67
 
68
68
  ___
69
69
 
70
70
  ### responseBody
71
71
 
72
- • **responseBody**: ``null`` \| `string` \| `FetchResponseJson`
72
+ • **responseBody**: ``null`` \| `string` \| [`FetchResponseJson`](../interfaces/FetchResponseJson.md)
73
73
 
74
74
  #### Defined in
75
75
 
76
- [packages/framework/esm-api/src/openmrs-fetch.ts:300](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L300)
76
+ [packages/framework/esm-api/src/openmrs-fetch.ts:295](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L295)
77
77
 
78
78
  ___
79
79
 
@@ -143,10 +143,6 @@ ___
143
143
 
144
144
  ▸ (`err`, `stackTraces`): `any`
145
145
 
146
- Optional override for formatting stack traces
147
-
148
- **`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
149
-
150
146
  ##### Parameters
151
147
 
152
148
  | Name | Type |
@@ -186,8 +182,6 @@ node_modules/@types/node/globals.d.ts:13
186
182
 
187
183
  ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
188
184
 
189
- Create .stack property on a target object
190
-
191
185
  #### Parameters
192
186
 
193
187
  | Name | Type |
package/docs/enums/Type.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Enumeration members
7
+ ### Enumeration Members
8
8
 
9
9
  - [Array](Type.md#array)
10
10
  - [Boolean](Type.md#boolean)
@@ -16,92 +16,92 @@
16
16
  - [String](Type.md#string)
17
17
  - [UUID](Type.md#uuid)
18
18
 
19
- ## Enumeration members
19
+ ## Enumeration Members
20
20
 
21
21
  ### Array
22
22
 
23
- • **Array** = `"Array"`
23
+ • **Array** = ``"Array"``
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L2)
27
+ [packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L2)
28
28
 
29
29
  ___
30
30
 
31
31
  ### Boolean
32
32
 
33
- • **Boolean** = `"Boolean"`
33
+ • **Boolean** = ``"Boolean"``
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L3)
37
+ [packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L3)
38
38
 
39
39
  ___
40
40
 
41
41
  ### ConceptUuid
42
42
 
43
- • **ConceptUuid** = `"ConceptUuid"`
43
+ • **ConceptUuid** = ``"ConceptUuid"``
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L4)
47
+ [packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L4)
48
48
 
49
49
  ___
50
50
 
51
51
  ### Number
52
52
 
53
- • **Number** = `"Number"`
53
+ • **Number** = ``"Number"``
54
54
 
55
55
  #### Defined in
56
56
 
57
- [packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L5)
57
+ [packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L5)
58
58
 
59
59
  ___
60
60
 
61
61
  ### Object
62
62
 
63
- • **Object** = `"Object"`
63
+ • **Object** = ``"Object"``
64
64
 
65
65
  #### Defined in
66
66
 
67
- [packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L6)
67
+ [packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L6)
68
68
 
69
69
  ___
70
70
 
71
71
  ### PatientIdentifierTypeUuid
72
72
 
73
- • **PatientIdentifierTypeUuid** = `"PatientIdentifierTypeUuid"`
73
+ • **PatientIdentifierTypeUuid** = ``"PatientIdentifierTypeUuid"``
74
74
 
75
75
  #### Defined in
76
76
 
77
- [packages/framework/esm-config/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L10)
77
+ [packages/framework/esm-config/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L10)
78
78
 
79
79
  ___
80
80
 
81
81
  ### PersonAttributeTypeUuid
82
82
 
83
- • **PersonAttributeTypeUuid** = `"PersonAttributeTypeUuid"`
83
+ • **PersonAttributeTypeUuid** = ``"PersonAttributeTypeUuid"``
84
84
 
85
85
  #### Defined in
86
86
 
87
- [packages/framework/esm-config/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L9)
87
+ [packages/framework/esm-config/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L9)
88
88
 
89
89
  ___
90
90
 
91
91
  ### String
92
92
 
93
- • **String** = `"String"`
93
+ • **String** = ``"String"``
94
94
 
95
95
  #### Defined in
96
96
 
97
- [packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L7)
97
+ [packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L7)
98
98
 
99
99
  ___
100
100
 
101
101
  ### UUID
102
102
 
103
- • **UUID** = `"UUID"`
103
+ • **UUID** = ``"UUID"``
104
104
 
105
105
  #### Defined in
106
106
 
107
- [packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L8)
107
+ [packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L8)
package/docs/enums/VisitMode.md CHANGED
@@ -4,38 +4,38 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### API Enumeration members
7
+ ### API Enumeration Members
8
8
 
9
9
  - [EDITVISIT](VisitMode.md#editvisit)
10
10
  - [LOADING](VisitMode.md#loading)
11
11
  - [NEWVISIT](VisitMode.md#newvisit)
12
12
 
13
- ## API Enumeration members
13
+ ## API Enumeration Members
14
14
 
15
15
  ### EDITVISIT
16
16
 
17
- • **EDITVISIT** = `"editVisit"`
17
+ • **EDITVISIT** = ``"editVisit"``
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L85)
21
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L85)
22
22
 
23
23
  ___
24
24
 
25
25
  ### LOADING
26
26
 
27
- • **LOADING** = `"loadingVisit"`
27
+ • **LOADING** = ``"loadingVisit"``
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L86)
31
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L86)
32
32
 
33
33
  ___
34
34
 
35
35
  ### NEWVISIT
36
36
 
37
- • **NEWVISIT** = `"startVisit"`
37
+ • **NEWVISIT** = ``"startVisit"``
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L84)
41
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L84)
package/docs/enums/VisitStatus.md CHANGED
@@ -4,27 +4,27 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### API Enumeration members
7
+ ### API Enumeration Members
8
8
 
9
9
  - [NOTSTARTED](VisitStatus.md#notstarted)
10
10
  - [ONGOING](VisitStatus.md#ongoing)
11
11
 
12
- ## API Enumeration members
12
+ ## API Enumeration Members
13
13
 
14
14
  ### NOTSTARTED
15
15
 
16
- • **NOTSTARTED** = `"notStarted"`
16
+ • **NOTSTARTED** = ``"notStarted"``
17
17
 
18
18
  #### Defined in
19
19
 
20
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L90)
20
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L90)
21
21
 
22
22
  ___
23
23
 
24
24
  ### ONGOING
25
25
 
26
- • **ONGOING** = `"ongoing"`
26
+ • **ONGOING** = ``"ongoing"``
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L91)
30
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L91)
package/docs/interfaces/AssignedExtension.md CHANGED
@@ -20,11 +20,9 @@
20
20
 
21
21
  • **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
22
22
 
23
- The extension's config. Note that this will be `null` until the slot is mounted.
24
-
25
23
  #### Defined in
26
24
 
27
- [packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L79)
25
+ [packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L80)
28
26
 
29
27
  ___
30
28
 
@@ -34,7 +32,7 @@ ___
34
32
 
35
33
  #### Defined in
36
34
 
37
- [packages/framework/esm-extensions/src/store.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L74)
35
+ [packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L75)
38
36
 
39
37
  ___
40
38
 
@@ -44,7 +42,7 @@ ___
44
42
 
45
43
  #### Defined in
46
44
 
47
- [packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L77)
45
+ [packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
48
46
 
49
47
  ___
50
48
 
@@ -54,7 +52,7 @@ ___
54
52
 
55
53
  #### Defined in
56
54
 
57
- [packages/framework/esm-extensions/src/store.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L76)
55
+ [packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L77)
58
56
 
59
57
  ___
60
58
 
@@ -64,7 +62,7 @@ ___
64
62
 
65
63
  #### Defined in
66
64
 
67
- [packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
65
+ [packages/framework/esm-extensions/src/store.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L76)
68
66
 
69
67
  ___
70
68
 
@@ -74,7 +72,7 @@ ___
74
72
 
75
73
  #### Defined in
76
74
 
77
- [packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L81)
75
+ [packages/framework/esm-extensions/src/store.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L82)
78
76
 
79
77
  ___
80
78
 
@@ -84,4 +82,4 @@ ___
84
82
 
85
83
  #### Defined in
86
84
 
87
- [packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L80)
85
+ [packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L81)
package/docs/interfaces/BreadcrumbRegistration.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [packages/framework/esm-breadcrumbs/src/types.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L36)
20
+ [packages/framework/esm-breadcrumbs/src/types.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L36)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/framework/esm-breadcrumbs/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L37)
30
+ [packages/framework/esm-breadcrumbs/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L37)
package/docs/interfaces/BreadcrumbSettings.md CHANGED
@@ -17,16 +17,9 @@
17
17
 
18
18
  • `Optional` **matcher**: `string` \| `RegExp`
19
19
 
20
- A string or RegEx that determines whether the breadcrumb should be displayed.
21
- It is tested against the current location's path.
22
-
23
- If `matcher` is a string, it can contain route parameters. e.g. `/foo/:bar`.
24
-
25
- Can be omitted; the value of `path` is used as the default value.
26
-
27
20
  #### Defined in
28
21
 
29
- [packages/framework/esm-breadcrumbs/src/types.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L16)
22
+ [packages/framework/esm-breadcrumbs/src/types.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L16)
30
23
 
31
24
  ___
32
25
 
@@ -34,16 +27,9 @@ ___
34
27
 
35
28
  • `Optional` **parent**: `string`
36
29
 
37
- The breadcrumb's parent breadcrumb. Supply the path of the breadcrumb here, e.g.,
38
- if we are currently in "/foo/bar", you could provide "/foo" to get the breadcrumb
39
- associated with the path "/foo".
40
-
41
- If a path is missing for some reason, the closest matching one will be taken as
42
- parent.
43
-
44
30
  #### Defined in
45
31
 
46
- [packages/framework/esm-breadcrumbs/src/types.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L25)
32
+ [packages/framework/esm-breadcrumbs/src/types.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L25)
47
33
 
48
34
  ___
49
35
 
@@ -51,11 +37,9 @@ ___
51
37
 
52
38
  • **path**: `string`
53
39
 
54
- Gets the path of breadcrumb for navigation purposes.
55
-
56
40
  #### Defined in
57
41
 
58
- [packages/framework/esm-breadcrumbs/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L7)
42
+ [packages/framework/esm-breadcrumbs/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L7)
59
43
 
60
44
  ___
61
45
 
@@ -63,8 +47,6 @@ ___
63
47
 
64
48
  • **title**: `string` \| (`params`: `any`) => `string` \| (`params`: `any`) => `Promise`<`string`\>
65
49
 
66
- The title of the breadcrumb.
67
-
68
50
  #### Defined in
69
51
 
70
- [packages/framework/esm-breadcrumbs/src/types.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L29)
52
+ [packages/framework/esm-breadcrumbs/src/types.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L29)
package/docs/interfaces/CancelLoading.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  #### Defined in
16
16
 
17
- [packages/framework/esm-extensions/src/render.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L9)
17
+ [packages/framework/esm-extensions/src/render.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L9)
package/docs/interfaces/ClearDynamicRoutesMessage.md CHANGED
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
29
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
package/docs/interfaces/ComponentDefinition.md CHANGED
@@ -30,11 +30,9 @@
30
30
 
31
31
  • **appName**: `string`
32
32
 
33
- The module/app that defines the component
34
-
35
33
  #### Defined in
36
34
 
37
- [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L99)
35
+ [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L99)
38
36
 
39
37
  ___
40
38
 
@@ -42,11 +40,9 @@ ___
42
40
 
43
41
  • `Optional` **offline**: `boolean` \| `object`
44
42
 
45
- Defines the offline support / properties of the component.
46
-
47
43
  #### Defined in
48
44
 
49
- [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L111)
45
+ [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L111)
50
46
 
51
47
  ___
52
48
 
@@ -54,23 +50,19 @@ ___
54
50
 
55
51
  • `Optional` **online**: `boolean` \| `object`
56
52
 
57
- Defines the online support / properties of the component.
58
-
59
53
  #### Defined in
60
54
 
61
- [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L107)
55
+ [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L107)
62
56
 
63
57
  ___
64
58
 
65
59
  ### privilege
66
60
 
67
- • `Optional` **privilege**: `string`
68
-
69
- Defines the access privilege required for this component, if any.
61
+ • `Optional` **privilege**: `string` \| `string`[]
70
62
 
71
63
  #### Defined in
72
64
 
73
- [packages/framework/esm-globals/src/types.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L115)
65
+ [packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L116)
74
66
 
75
67
  ___
76
68
 
@@ -78,11 +70,9 @@ ___
78
70
 
79
71
  • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
80
72
 
81
- Defines resources that are loaded when the component should mount.
82
-
83
73
  #### Defined in
84
74
 
85
- [packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
75
+ [packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L120)
86
76
 
87
77
  ## Methods
88
78
 
@@ -90,12 +80,10 @@ Defines resources that are loaded when the component should mount.
90
80
 
91
81
  ▸ **load**(): `Promise`<`any`\>
92
82
 
93
- Defines a function to use for actually loading the component's lifecycle.
94
-
95
83
  #### Returns
96
84
 
97
85
  `Promise`<`any`\>
98
86
 
99
87
  #### Defined in
100
88
 
101
- [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L103)
89
+ [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L103)
package/docs/interfaces/Config.md CHANGED
@@ -33,8 +33,6 @@
33
33
 
34
34
  • **constructor**: `Function`
35
35
 
36
- The initial value of Object.prototype.constructor is the standard built-in Object constructor.
37
-
38
36
  #### Inherited from
39
37
 
40
38
  Object.constructor
@@ -49,13 +47,11 @@ node_modules/typescript/lib/lib.es5.d.ts:124
49
47
 
50
48
  ▸ **hasOwnProperty**(`v`): `boolean`
51
49
 
52
- Determines whether an object has a property with the specified name.
53
-
54
50
  #### Parameters
55
51
 
56
52
  | Name | Type | Description |
57
53
  | :------ | :------ | :------ |
58
- | `v` | `PropertyKey` | A property name. |
54
+ | `v` | `PropertyKey` | |
59
55
 
60
56
  #### Returns
61
57
 
@@ -75,13 +71,11 @@ ___
75
71
 
76
72
  ▸ **isPrototypeOf**(`v`): `boolean`
77
73
 
78
- Determines whether an object exists in another object's prototype chain.
79
-
80
74
  #### Parameters
81
75
 
82
76
  | Name | Type | Description |
83
77
  | :------ | :------ | :------ |
84
- | `v` | `Object` | Another object whose prototype chain is to be checked. |
78
+ | `v` | `Object` | |
85
79
 
86
80
  #### Returns
87
81
 
@@ -101,13 +95,11 @@ ___
101
95
 
102
96
  ▸ **propertyIsEnumerable**(`v`): `boolean`
103
97
 
104
- Determines whether a specified property is enumerable.
105
-
106
98
  #### Parameters
107
99
 
108
100
  | Name | Type | Description |
109
101
  | :------ | :------ | :------ |
110
- | `v` | `PropertyKey` | A property name. |
102
+ | `v` | `PropertyKey` | |
111
103
 
112
104
  #### Returns
113
105
 
@@ -127,8 +119,6 @@ ___
127
119
 
128
120
  ▸ **toLocaleString**(): `string`
129
121
 
130
- Returns a date converted to a string using the current locale.
131
-
132
122
  #### Returns
133
123
 
134
124
  `string`
@@ -147,8 +137,6 @@ ___
147
137
 
148
138
  ▸ **toString**(): `string`
149
139
 
150
- Returns a string representation of an object.
151
-
152
140
  #### Returns
153
141
 
154
142
  `string`
@@ -167,8 +155,6 @@ ___
167
155
 
168
156
  ▸ **valueOf**(): `Object`
169
157
 
170
- Returns the primitive value of the specified object.
171
-
172
158
  #### Returns
173
159
 
174
160
  `Object`
package/docs/interfaces/ConfigObject.md CHANGED
@@ -16,6 +16,7 @@
16
16
 
17
17
  ### Properties
18
18
 
19
+ - [Display conditions](ConfigObject.md#display conditions)
19
20
  - [constructor](ConfigObject.md#constructor)
20
21
 
21
22
  ### Methods
@@ -29,12 +30,20 @@
29
30
 
30
31
  ## Properties
31
32
 
33
+ ### Display conditions
34
+
35
+ • `Optional` **Display conditions**: [`DisplayConditionsConfigObject`](DisplayConditionsConfigObject.md)
36
+
37
+ #### Defined in
38
+
39
+ [packages/framework/esm-config/src/types.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L30)
40
+
41
+ ___
42
+
32
43
  ### constructor
33
44
 
34
45
  • **constructor**: `Function`
35
46
 
36
- The initial value of Object.prototype.constructor is the standard built-in Object constructor.
37
-
38
47
  #### Inherited from
39
48
 
40
49
  Object.constructor
@@ -49,13 +58,11 @@ node_modules/typescript/lib/lib.es5.d.ts:124
49
58
 
50
59
  ▸ **hasOwnProperty**(`v`): `boolean`
51
60
 
52
- Determines whether an object has a property with the specified name.
53
-
54
61
  #### Parameters
55
62
 
56
63
  | Name | Type | Description |
57
64
  | :------ | :------ | :------ |
58
- | `v` | `PropertyKey` | A property name. |
65
+ | `v` | `PropertyKey` | |
59
66
 
60
67
  #### Returns
61
68
 
@@ -75,13 +82,11 @@ ___
75
82
 
76
83
  ▸ **isPrototypeOf**(`v`): `boolean`
77
84
 
78
- Determines whether an object exists in another object's prototype chain.
79
-
80
85
  #### Parameters
81
86
 
82
87
  | Name | Type | Description |
83
88
  | :------ | :------ | :------ |
84
- | `v` | `Object` | Another object whose prototype chain is to be checked. |
89
+ | `v` | `Object` | |
85
90
 
86
91
  #### Returns
87
92
 
@@ -101,13 +106,11 @@ ___
101
106
 
102
107
  ▸ **propertyIsEnumerable**(`v`): `boolean`
103
108
 
104
- Determines whether a specified property is enumerable.
105
-
106
109
  #### Parameters
107
110
 
108
111
  | Name | Type | Description |
109
112
  | :------ | :------ | :------ |
110
- | `v` | `PropertyKey` | A property name. |
113
+ | `v` | `PropertyKey` | |
111
114
 
112
115
  #### Returns
113
116
 
@@ -127,8 +130,6 @@ ___
127
130
 
128
131
  ▸ **toLocaleString**(): `string`
129
132
 
130
- Returns a date converted to a string using the current locale.
131
-
132
133
  #### Returns
133
134
 
134
135
  `string`
@@ -147,8 +148,6 @@ ___
147
148
 
148
149
  ▸ **toString**(): `string`
149
150
 
150
- Returns a string representation of an object.
151
-
152
151
  #### Returns
153
152
 
154
153
  `string`
@@ -167,8 +166,6 @@ ___
167
166
 
168
167
  ▸ **valueOf**(): `Object`
169
168
 
170
- Returns the primitive value of the specified object.
171
-
172
169
  #### Returns
173
170
 
174
171
  `Object`