@openmrs/esm-framework 9.0.3-pre.4151 → 9.0.3-pre.4166

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 (123) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/API.md +7 -0
  3. package/docs/functions/age.md +6 -6
  4. package/docs/functions/calculateInterpretation.md +2 -2
  5. package/docs/functions/canAccessStorage.md +4 -4
  6. package/docs/functions/convertToLocaleCalendar.md +1 -1
  7. package/docs/functions/createAttachment.md +2 -2
  8. package/docs/functions/createErrorHandler.md +1 -1
  9. package/docs/functions/deleteAttachmentPermanently.md +2 -2
  10. package/docs/functions/dispatchNotificationShown.md +1 -1
  11. package/docs/functions/dispatchPrecacheStaticDependencies.md +4 -4
  12. package/docs/functions/displayName.md +1 -1
  13. package/docs/functions/fetchCurrentPatient.md +1 -1
  14. package/docs/functions/formatDate.md +1 -1
  15. package/docs/functions/formatDatetime.md +1 -1
  16. package/docs/functions/formatDuration.md +1 -1
  17. package/docs/functions/formatPartialDate.md +4 -4
  18. package/docs/functions/formatPatientName.md +1 -1
  19. package/docs/functions/formatTime.md +1 -1
  20. package/docs/functions/formattedName.md +1 -1
  21. package/docs/functions/getAttachmentByUuid.md +2 -2
  22. package/docs/functions/getAttachments.md +2 -2
  23. package/docs/functions/getCoreTranslation.md +1 -1
  24. package/docs/functions/getDefaultCalendar.md +1 -1
  25. package/docs/functions/getDefaultsFromConfigSchema.md +1 -1
  26. package/docs/functions/getLocale.md +1 -1
  27. package/docs/functions/getPatientName.md +1 -1
  28. package/docs/functions/getVisitsForPatient.md +2 -2
  29. package/docs/functions/isOmrsDateStrict.md +1 -1
  30. package/docs/functions/isOmrsDateToday.md +1 -1
  31. package/docs/functions/isOnline.md +1 -1
  32. package/docs/functions/isVersionSatisfied.md +1 -1
  33. package/docs/functions/normalizeInterpretation.md +3 -3
  34. package/docs/functions/parseDate.md +1 -1
  35. package/docs/functions/registerDefaultCalendar.md +1 -1
  36. package/docs/functions/reportError.md +1 -1
  37. package/docs/functions/retry.md +4 -4
  38. package/docs/functions/saveVisit.md +2 -2
  39. package/docs/functions/selectPreferredName.md +1 -1
  40. package/docs/functions/shallowEqual.md +1 -1
  41. package/docs/functions/subscribeActionableNotificationShown.md +1 -1
  42. package/docs/functions/subscribeConnectivity.md +1 -1
  43. package/docs/functions/subscribeConnectivityChanged.md +1 -1
  44. package/docs/functions/subscribeNotificationShown.md +1 -1
  45. package/docs/functions/subscribePrecacheStaticDependencies.md +1 -1
  46. package/docs/functions/subscribeSnackbarShown.md +1 -1
  47. package/docs/functions/subscribeToastShown.md +1 -1
  48. package/docs/functions/toDateObjectStrict.md +1 -1
  49. package/docs/functions/toOmrsIsoString.md +4 -4
  50. package/docs/functions/updateVisit.md +2 -2
  51. package/docs/functions/useAssignedExtensions.md +2 -2
  52. package/docs/functions/useAttachments.md +2 -2
  53. package/docs/functions/useEmrConfiguration.md +1 -1
  54. package/docs/functions/useExtensionSlotMeta.md +1 -1
  55. package/docs/functions/useExtensionSlotStore.md +2 -2
  56. package/docs/functions/useFhirPagination.md +1 -1
  57. package/docs/functions/useLeftNav.md +1 -1
  58. package/docs/functions/useLeftNavStore.md +2 -2
  59. package/docs/functions/useLocations.md +2 -2
  60. package/docs/functions/useOpenmrsPagination.md +1 -1
  61. package/docs/functions/useOpenmrsSWR.md +2 -2
  62. package/docs/functions/useSession.md +2 -2
  63. package/docs/functions/useVisitContextStore.md +2 -2
  64. package/docs/functions/useVisitTypes.md +2 -2
  65. package/docs/interfaces/AssignedExtension.md +1 -1
  66. package/docs/interfaces/ConfigurableLinkProps.md +1 -1
  67. package/docs/interfaces/ConnectedExtension.md +1 -1
  68. package/docs/interfaces/ConnectivityChangedEvent.md +2 -2
  69. package/docs/interfaces/Diagnosis.md +20 -16
  70. package/docs/interfaces/Drug.md +17 -13
  71. package/docs/interfaces/EmrApiConfigurationResponse.md +51 -51
  72. package/docs/interfaces/Encounter.md +18 -14
  73. package/docs/interfaces/EncounterProvider.md +18 -14
  74. package/docs/interfaces/EncounterRole.md +17 -13
  75. package/docs/interfaces/EncounterType.md +17 -13
  76. package/docs/interfaces/ExtensionSlotBaseProps.md +3 -3
  77. package/docs/interfaces/ExtensionSlotProps.md +11 -11
  78. package/docs/interfaces/FeatureFlagDefinition.md +4 -4
  79. package/docs/interfaces/ImportMap.md +2 -2
  80. package/docs/interfaces/Location.md +19 -15
  81. package/docs/interfaces/NumericObservationProps.md +1 -1
  82. package/docs/interfaces/Obs.md +22 -18
  83. package/docs/interfaces/OpenWorkspace.md +24 -24
  84. package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
  85. package/docs/interfaces/OpenmrsResource.md +9 -0
  86. package/docs/interfaces/Order.md +26 -22
  87. package/docs/interfaces/Patient.md +8 -8
  88. package/docs/interfaces/PatientIdentifier.md +7 -7
  89. package/docs/interfaces/PatientIdentifierType.md +7 -7
  90. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -1
  91. package/docs/interfaces/ResourceLoader.md +2 -2
  92. package/docs/interfaces/RetryOptions.md +4 -4
  93. package/docs/interfaces/ShowActionableNotificationEvent.md +7 -7
  94. package/docs/interfaces/ShowNotificationEvent.md +6 -6
  95. package/docs/interfaces/ShowSnackbarEvent.md +9 -9
  96. package/docs/interfaces/ShowToastEvent.md +6 -6
  97. package/docs/interfaces/SpaConfig.md +6 -6
  98. package/docs/interfaces/UseServerFetchAllOptions.md +2 -2
  99. package/docs/interfaces/UseServerInfiniteOptions.md +2 -2
  100. package/docs/interfaces/UseServerPaginationOptions.md +2 -2
  101. package/docs/interfaces/Visit.md +1 -1
  102. package/docs/interfaces/VisitReturnType.md +2 -2
  103. package/docs/interfaces/WorkspaceDefinition2.md +4 -4
  104. package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
  105. package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
  106. package/docs/interfaces/WorkspaceRegistration.md +4 -0
  107. package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
  108. package/docs/type-aliases/CurrentPatient.md +1 -1
  109. package/docs/type-aliases/DateInput.md +1 -1
  110. package/docs/type-aliases/ExtensionDefinition.md +12 -12
  111. package/docs/type-aliases/FormatDateMode.md +1 -1
  112. package/docs/type-aliases/FormatDateOptions.md +10 -10
  113. package/docs/type-aliases/ModalDefinition.md +3 -3
  114. package/docs/type-aliases/NameUse.md +1 -1
  115. package/docs/type-aliases/OpenmrsRoutes.md +1 -1
  116. package/docs/type-aliases/PageDefinition.md +1 -1
  117. package/docs/type-aliases/SpaEnvironment.md +1 -1
  118. package/docs/type-aliases/UseOpenmrsSWROptions.md +1 -1
  119. package/docs/type-aliases/WorkspaceDefinition.md +14 -14
  120. package/docs/type-aliases/WorkspaceWindowState.md +1 -1
  121. package/docs/variables/useConnectedExtensions.md +2 -2
  122. package/docs/variables/useExtensionStore.md +9 -9
  123. package/package.json +20 -20
package/docs/interfaces/OpenWorkspace.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L113)
6
6
 
7
- The default parameters received by all workspaces
7
+ See [[WorkspaceDefinition]] for more information about these properties
8
8
 
9
9
  ## Extends
10
10
 
11
- - `WorkspaceRegistration`.[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
11
+ - [`WorkspaceRegistration`](WorkspaceRegistration.md).[`DefaultWorkspaceProps`](DefaultWorkspaceProps.md)
12
12
 
13
13
  ## Properties
14
14
 
@@ -24,11 +24,11 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:114]
24
24
 
25
25
  > **canHide**: `boolean`
26
26
 
27
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:10
27
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L14)
28
28
 
29
29
  #### Inherited from
30
30
 
31
- `WorkspaceRegistration.canHide`
31
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`canHide`](WorkspaceRegistration.md#canhide)
32
32
 
33
33
  ***
34
34
 
@@ -36,11 +36,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:10
36
36
 
37
37
  > **canMaximize**: `boolean`
38
38
 
39
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:11
39
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L15)
40
40
 
41
41
  #### Inherited from
42
42
 
43
- `WorkspaceRegistration.canMaximize`
43
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`canMaximize`](WorkspaceRegistration.md#canmaximize)
44
44
 
45
45
  ***
46
46
 
@@ -56,11 +56,11 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:115]
56
56
 
57
57
  > **groups**: `string`[]
58
58
 
59
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:16
59
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
60
60
 
61
61
  #### Inherited from
62
62
 
63
- `WorkspaceRegistration.groups`
63
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`groups`](WorkspaceRegistration.md#groups)
64
64
 
65
65
  ***
66
66
 
@@ -68,11 +68,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:16
68
68
 
69
69
  > **moduleName**: `string`
70
70
 
71
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:15
71
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
72
72
 
73
73
  #### Inherited from
74
74
 
75
- `WorkspaceRegistration.moduleName`
75
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`moduleName`](WorkspaceRegistration.md#modulename)
76
76
 
77
77
  ***
78
78
 
@@ -80,11 +80,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:15
80
80
 
81
81
  > **name**: `string`
82
82
 
83
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:6
83
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L10)
84
84
 
85
85
  #### Inherited from
86
86
 
87
- `WorkspaceRegistration.name`
87
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`name`](WorkspaceRegistration.md#name)
88
88
 
89
89
  ***
90
90
 
@@ -92,11 +92,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:6
92
92
 
93
93
  > **preferredWindowSize**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
94
94
 
95
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:13
95
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
96
96
 
97
97
  #### Inherited from
98
98
 
99
- `WorkspaceRegistration.preferredWindowSize`
99
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`preferredWindowSize`](WorkspaceRegistration.md#preferredwindowsize)
100
100
 
101
101
  ***
102
102
 
@@ -104,11 +104,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:13
104
104
 
105
105
  > **title**: `string`
106
106
 
107
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:7
107
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L11)
108
108
 
109
109
  #### Inherited from
110
110
 
111
- `WorkspaceRegistration.title`
111
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`title`](WorkspaceRegistration.md#title)
112
112
 
113
113
  ***
114
114
 
@@ -116,11 +116,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:7
116
116
 
117
117
  > `optional` **titleNode**: `ReactNode`
118
118
 
119
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:8
119
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L12)
120
120
 
121
121
  #### Inherited from
122
122
 
123
- `WorkspaceRegistration.titleNode`
123
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`titleNode`](WorkspaceRegistration.md#titlenode)
124
124
 
125
125
  ***
126
126
 
@@ -128,11 +128,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:8
128
128
 
129
129
  > **type**: `string`
130
130
 
131
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:9
131
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L13)
132
132
 
133
133
  #### Inherited from
134
134
 
135
- `WorkspaceRegistration.type`
135
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`type`](WorkspaceRegistration.md#type)
136
136
 
137
137
  ***
138
138
 
@@ -140,11 +140,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:9
140
140
 
141
141
  > **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
142
142
 
143
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:12
143
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L16)
144
144
 
145
145
  #### Inherited from
146
146
 
147
- `WorkspaceRegistration.width`
147
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`width`](WorkspaceRegistration.md#width)
148
148
 
149
149
  ## Methods
150
150
 
@@ -205,7 +205,7 @@ will directly close the workspace without any prompt
205
205
 
206
206
  > **load**(): `Promise`\<`LifeCycles`\>
207
207
 
208
- Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
208
+ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
209
209
 
210
210
  #### Returns
211
211
 
@@ -213,7 +213,7 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
213
213
 
214
214
  #### Inherited from
215
215
 
216
- `WorkspaceRegistration.load`
216
+ [`WorkspaceRegistration`](WorkspaceRegistration.md).[`load`](WorkspaceRegistration.md#load)
217
217
 
218
218
  ***
219
219
 
package/docs/interfaces/OpenmrsAppRoutes.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: OpenmrsAppRoutes
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:347
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:373](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L373)
6
6
 
7
7
  This interface describes the format of the routes provided by an app
8
8
 
@@ -12,7 +12,7 @@ This interface describes the format of the routes provided by an app
12
12
 
13
13
  > `optional` **backendDependencies**: `Record`\<`string`, `string`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:351
15
+ Defined in: [packages/framework/esm-globals/src/types.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L377)
16
16
 
17
17
  A list of backend modules necessary for this frontend module and the corresponding required versions.
18
18
 
@@ -22,7 +22,7 @@ A list of backend modules necessary for this frontend module and the correspondi
22
22
 
23
23
  > `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
24
24
 
25
- Defined in: packages/framework/esm-globals/dist/types.d.ts:365
25
+ Defined in: [packages/framework/esm-globals/src/types.ts:393](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L393)
26
26
 
27
27
  An array of all extensions supported by this frontend module. Extensions can be mounted in extension slots, either via declarations in this file or configuration.
28
28
 
@@ -32,7 +32,7 @@ An array of all extensions supported by this frontend module. Extensions can be
32
32
 
33
33
  > `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
34
34
 
35
- Defined in: packages/framework/esm-globals/dist/types.d.ts:367
35
+ Defined in: [packages/framework/esm-globals/src/types.ts:395](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L395)
36
36
 
37
37
  An array of all feature flags for any beta-stage features this module provides.
38
38
 
@@ -42,7 +42,7 @@ An array of all feature flags for any beta-stage features this module provides.
42
42
 
43
43
  > `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
44
44
 
45
- Defined in: packages/framework/esm-globals/dist/types.d.ts:369
45
+ Defined in: [packages/framework/esm-globals/src/types.ts:397](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L397)
46
46
 
47
47
  An array of all modals supported by this frontend module. Modals can be launched by name.
48
48
 
@@ -52,7 +52,7 @@ An array of all modals supported by this frontend module. Modals can be launched
52
52
 
53
53
  > `optional` **optionalBackendDependencies**: `object`
54
54
 
55
- Defined in: packages/framework/esm-globals/dist/types.d.ts:353
55
+ Defined in: [packages/framework/esm-globals/src/types.ts:379](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L379)
56
56
 
57
57
  A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
58
58
 
@@ -68,7 +68,7 @@ The name of the backend dependency and either the required version or an object
68
68
 
69
69
  > `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
70
70
 
71
- Defined in: packages/framework/esm-globals/dist/types.d.ts:363
71
+ Defined in: [packages/framework/esm-globals/src/types.ts:391](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L391)
72
72
 
73
73
  An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
74
74
 
@@ -78,7 +78,7 @@ An array of all pages supported by this frontend module. Pages are automatically
78
78
 
79
79
  > `optional` **version**: `string`
80
80
 
81
- Defined in: packages/framework/esm-globals/dist/types.d.ts:349
81
+ Defined in: [packages/framework/esm-globals/src/types.ts:375](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L375)
82
82
 
83
83
  The version of this frontend module.
84
84
 
@@ -88,7 +88,7 @@ The version of this frontend module.
88
88
 
89
89
  > `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
90
90
 
91
- Defined in: packages/framework/esm-globals/dist/types.d.ts:373
91
+ Defined in: [packages/framework/esm-globals/src/types.ts:401](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L401)
92
92
 
93
93
  An array of all workspace groups supported by this frontend module.
94
94
 
@@ -98,7 +98,7 @@ An array of all workspace groups supported by this frontend module.
98
98
 
99
99
  > `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
100
100
 
101
- Defined in: packages/framework/esm-globals/dist/types.d.ts:375
101
+ Defined in: [packages/framework/esm-globals/src/types.ts:404](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L404)
102
102
 
103
103
  An array of all workspace groups (v2) supported by this frontend module.
104
104
 
@@ -108,7 +108,7 @@ An array of all workspace groups (v2) supported by this frontend module.
108
108
 
109
109
  > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
110
110
 
111
- Defined in: packages/framework/esm-globals/dist/types.d.ts:371
111
+ Defined in: [packages/framework/esm-globals/src/types.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L399)
112
112
 
113
113
  An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
114
114
 
@@ -118,7 +118,7 @@ An array of all workspaces supported by this frontend module. Workspaces can be
118
118
 
119
119
  > `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
120
120
 
121
- Defined in: packages/framework/esm-globals/dist/types.d.ts:379
121
+ Defined in: [packages/framework/esm-globals/src/types.ts:410](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L410)
122
122
 
123
123
  An array of all workspaces (v2) supported by this frontend module.
124
124
 
@@ -128,6 +128,6 @@ An array of all workspaces (v2) supported by this frontend module.
128
128
 
129
129
  > `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
130
130
 
131
- Defined in: packages/framework/esm-globals/dist/types.d.ts:377
131
+ Defined in: [packages/framework/esm-globals/src/types.ts:407](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L407)
132
132
 
133
133
  An array of all workspace windows (v2) supported by this frontend module.
package/docs/interfaces/OpenmrsResource.md CHANGED
@@ -19,6 +19,15 @@ accounted for, use OpenmrsResource instead.
19
19
  - [`ConceptName`](ConceptName.md)
20
20
  - [`ConceptClass`](ConceptClass.md)
21
21
  - [`User`](User.md)
22
+ - [`Diagnosis`](Diagnosis.md)
23
+ - [`Drug`](Drug.md)
24
+ - [`Encounter`](Encounter.md)
25
+ - [`EncounterType`](EncounterType.md)
26
+ - [`EncounterProvider`](EncounterProvider.md)
27
+ - [`EncounterRole`](EncounterRole.md)
28
+ - [`Location`](Location.md)
29
+ - [`Obs`](Obs.md)
30
+ - [`Order`](Order.md)
22
31
 
23
32
  ## Indexable
24
33
 
package/docs/interfaces/Order.md CHANGED
@@ -4,9 +4,13 @@
4
4
 
5
5
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L18)
6
6
 
7
+ Superclass for all Openmrs Resources, with strict typings.
8
+ If the subclass does not have all attributes (including optional ones)
9
+ accounted for, use OpenmrsResource instead.
10
+
7
11
  ## Extends
8
12
 
9
- - `OpenmrsResource`
13
+ - [`OpenmrsResource`](OpenmrsResource.md)
10
14
 
11
15
  ## Indexable
12
16
 
@@ -48,13 +52,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:22](http
48
52
 
49
53
  ### auditInfo?
50
54
 
51
- > `optional` **auditInfo**: `AuditInfo`
55
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
52
56
 
53
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
57
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
54
58
 
55
59
  #### Inherited from
56
60
 
57
- `OpenmrsResource.auditInfo`
61
+ [`OpenmrsResource`](OpenmrsResource.md).[`auditInfo`](OpenmrsResource.md#auditinfo)
58
62
 
59
63
  ***
60
64
 
@@ -76,7 +80,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:24](http
76
80
 
77
81
  ### careSetting
78
82
 
79
- > **careSetting**: `OpenmrsResource`
83
+ > **careSetting**: [`OpenmrsResource`](OpenmrsResource.md)
80
84
 
81
85
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L25)
82
86
 
@@ -100,7 +104,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:26](http
100
104
 
101
105
  ### concept
102
106
 
103
- > **concept**: `Concept`
107
+ > **concept**: [`Concept`](Concept.md)
104
108
 
105
109
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L27)
106
110
 
@@ -138,7 +142,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:71](http
138
142
 
139
143
  #### Overrides
140
144
 
141
- `OpenmrsResource.display`
145
+ [`OpenmrsResource`](OpenmrsResource.md).[`display`](OpenmrsResource.md#display)
142
146
 
143
147
  ***
144
148
 
@@ -152,7 +156,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:31](http
152
156
 
153
157
  ### doseUnits
154
158
 
155
- > **doseUnits**: `OpenmrsResource`
159
+ > **doseUnits**: [`OpenmrsResource`](OpenmrsResource.md)
156
160
 
157
161
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L32)
158
162
 
@@ -192,7 +196,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:36](http
192
196
 
193
197
  ### durationUnits
194
198
 
195
- > **durationUnits**: `OpenmrsResource`
199
+ > **durationUnits**: [`OpenmrsResource`](OpenmrsResource.md)
196
200
 
197
201
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L37)
198
202
 
@@ -200,7 +204,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:37](http
200
204
 
201
205
  ### encounter
202
206
 
203
- > **encounter**: `OpenmrsResource`
207
+ > **encounter**: [`OpenmrsResource`](OpenmrsResource.md)
204
208
 
205
209
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L38)
206
210
 
@@ -208,7 +212,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:38](http
208
212
 
209
213
  ### frequency
210
214
 
211
- > **frequency**: `OpenmrsResource`
215
+ > **frequency**: [`OpenmrsResource`](OpenmrsResource.md)
212
216
 
213
217
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L39)
214
218
 
@@ -248,13 +252,13 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:75](http
248
252
 
249
253
  ### links?
250
254
 
251
- > `optional` **links**: `Link`[]
255
+ > `optional` **links**: [`Link`](Link.md)[]
252
256
 
253
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
257
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
254
258
 
255
259
  #### Inherited from
256
260
 
257
- `OpenmrsResource.links`
261
+ [`OpenmrsResource`](OpenmrsResource.md).[`links`](OpenmrsResource.md#links)
258
262
 
259
263
  ***
260
264
 
@@ -308,7 +312,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:42](http
308
312
 
309
313
  ### orderReason
310
314
 
311
- > **orderReason**: `null` \| `Concept`
315
+ > **orderReason**: `null` \| [`Concept`](Concept.md)
312
316
 
313
317
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L43)
314
318
 
@@ -360,7 +364,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:45](http
360
364
 
361
365
  ### patient
362
366
 
363
- > **patient**: `OpenmrsResource`
367
+ > **patient**: [`OpenmrsResource`](OpenmrsResource.md)
364
368
 
365
369
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L61)
366
370
 
@@ -384,7 +388,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:63](http
384
388
 
385
389
  ### quantityUnits
386
390
 
387
- > **quantityUnits**: `OpenmrsResource`
391
+ > **quantityUnits**: [`OpenmrsResource`](OpenmrsResource.md)
388
392
 
389
393
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L64)
390
394
 
@@ -394,17 +398,17 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:64](http
394
398
 
395
399
  > `optional` **resourceVersion**: `string`
396
400
 
397
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
401
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
398
402
 
399
403
  #### Inherited from
400
404
 
401
- `OpenmrsResource.resourceVersion`
405
+ [`OpenmrsResource`](OpenmrsResource.md).[`resourceVersion`](OpenmrsResource.md#resourceversion)
402
406
 
403
407
  ***
404
408
 
405
409
  ### route
406
410
 
407
- > **route**: `OpenmrsResource`
411
+ > **route**: [`OpenmrsResource`](OpenmrsResource.md)
408
412
 
409
413
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L65)
410
414
 
@@ -420,7 +424,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:70](http
420
424
 
421
425
  ### specimenSource
422
426
 
423
- > **specimenSource**: `null` \| `Concept`
427
+ > **specimenSource**: `null` \| [`Concept`](Concept.md)
424
428
 
425
429
  Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/order-resource.ts#L74)
426
430
 
@@ -450,4 +454,4 @@ Defined in: [packages/framework/esm-emr-api/src/types/order-resource.ts:19](http
450
454
 
451
455
  #### Overrides
452
456
 
453
- `OpenmrsResource.uuid`
457
+ [`OpenmrsResource`](OpenmrsResource.md).[`uuid`](OpenmrsResource.md#uuid)
package/docs/interfaces/Patient.md CHANGED
@@ -16,9 +16,9 @@ accounted for, use OpenmrsResource instead.
16
16
 
17
17
  ### auditInfo?
18
18
 
19
- > `optional` **auditInfo**: `AuditInfo`
19
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
20
20
 
21
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
21
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
22
22
 
23
23
  #### Inherited from
24
24
 
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
30
30
 
31
31
  > `optional` **display**: `string`
32
32
 
33
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
33
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
34
34
 
35
35
  #### Inherited from
36
36
 
@@ -48,9 +48,9 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:16](ht
48
48
 
49
49
  ### links?
50
50
 
51
- > `optional` **links**: `Link`[]
51
+ > `optional` **links**: [`Link`](Link.md)[]
52
52
 
53
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
53
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
54
54
 
55
55
  #### Inherited from
56
56
 
@@ -60,7 +60,7 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
60
60
 
61
61
  ### person?
62
62
 
63
- > `optional` **person**: `Person`
63
+ > `optional` **person**: [`Person`](Person.md)
64
64
 
65
65
  Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/patient-resource.ts#L17)
66
66
 
@@ -70,7 +70,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:17](ht
70
70
 
71
71
  > `optional` **resourceVersion**: `string`
72
72
 
73
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
73
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
74
74
 
75
75
  #### Inherited from
76
76
 
@@ -82,7 +82,7 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
82
82
 
83
83
  > **uuid**: `string`
84
84
 
85
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
85
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
86
86
 
87
87
  #### Inherited from
88
88
 
package/docs/interfaces/PatientIdentifier.md CHANGED
@@ -16,9 +16,9 @@ accounted for, use OpenmrsResource instead.
16
16
 
17
17
  ### auditInfo?
18
18
 
19
- > `optional` **auditInfo**: `AuditInfo`
19
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
20
20
 
21
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
21
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
22
22
 
23
23
  #### Inherited from
24
24
 
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
30
30
 
31
31
  > `optional` **display**: `string`
32
32
 
33
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
33
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
34
34
 
35
35
  #### Inherited from
36
36
 
@@ -56,9 +56,9 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:23](ht
56
56
 
57
57
  ### links?
58
58
 
59
- > `optional` **links**: `Link`[]
59
+ > `optional` **links**: [`Link`](Link.md)[]
60
60
 
61
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
61
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
62
62
 
63
63
  #### Inherited from
64
64
 
@@ -86,7 +86,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:25](ht
86
86
 
87
87
  > `optional` **resourceVersion**: `string`
88
88
 
89
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
89
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
90
90
 
91
91
  #### Inherited from
92
92
 
@@ -98,7 +98,7 @@ Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
98
98
 
99
99
  > **uuid**: `string`
100
100
 
101
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
101
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
102
102
 
103
103
  #### Inherited from
104
104
 
package/docs/interfaces/PatientIdentifierType.md CHANGED
@@ -16,9 +16,9 @@ accounted for, use OpenmrsResource instead.
16
16
 
17
17
  ### auditInfo?
18
18
 
19
- > `optional` **auditInfo**: `AuditInfo`
19
+ > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
20
20
 
21
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:14
21
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
22
22
 
23
23
  #### Inherited from
24
24
 
@@ -38,7 +38,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:5](htt
38
38
 
39
39
  > `optional` **display**: `string`
40
40
 
41
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:12
41
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
42
42
 
43
43
  #### Inherited from
44
44
 
@@ -64,9 +64,9 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:7](htt
64
64
 
65
65
  ### links?
66
66
 
67
- > `optional` **links**: `Link`[]
67
+ > `optional` **links**: [`Link`](Link.md)[]
68
68
 
69
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:13
69
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
70
70
 
71
71
  #### Inherited from
72
72
 
@@ -102,7 +102,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:8](htt
102
102
 
103
103
  > `optional` **resourceVersion**: `string`
104
104
 
105
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:15
105
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
106
106
 
107
107
  #### Inherited from
108
108
 
@@ -130,7 +130,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/patient-resource.ts:11](ht
130
130
 
131
131
  > **uuid**: `string`
132
132
 
133
- Defined in: packages/framework/esm-api/dist/types/openmrs-resource.d.ts:11
133
+ Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
134
134
 
135
135
  #### Inherited from
136
136
 
package/docs/interfaces/PrecacheStaticDependenciesEvent.md CHANGED
@@ -2,4 +2,4 @@
2
2
 
3
3
  # Interface: PrecacheStaticDependenciesEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:10
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L30)