@openmrs/esm-framework 10.0.1-pre.5539 → 10.0.1-pre.5545
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.
- package/.turbo/turbo-build.log +1 -1
- package/dist/deprecated.d.ts +63 -0
- package/dist/deprecated.d.ts.map +1 -0
- package/dist/deprecated.js +65 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/internal.d.ts +1 -1
- package/dist/internal.d.ts.map +1 -1
- package/dist/internal.js +1 -1
- package/docs/API.md +0 -47
- package/docs/classes/OpenmrsFetchError.md +4 -4
- package/docs/enumerations/VisitMode.md +4 -4
- package/docs/enumerations/VisitStatus.md +3 -3
- package/docs/functions/attach.md +1 -1
- package/docs/functions/clearCurrentUser.md +1 -1
- package/docs/functions/createErrorHandler.md +1 -1
- package/docs/functions/detach.md +1 -1
- package/docs/functions/detachAll.md +1 -1
- package/docs/functions/fetchCurrentPatient.md +5 -15
- package/docs/functions/getAssignedExtensions.md +1 -1
- package/docs/functions/getCoreTranslation.md +1 -1
- package/docs/functions/getCurrentUser.md +31 -41
- package/docs/functions/getDynamicOfflineDataEntries.md +11 -10
- package/docs/functions/getExtensionNameFromId.md +1 -1
- package/docs/functions/getExtensionStore.md +1 -1
- package/docs/functions/getLocations.md +3 -3
- package/docs/functions/getLoggedInUser.md +1 -1
- package/docs/functions/getSessionLocation.md +1 -1
- package/docs/functions/getSessionStore.md +1 -1
- package/docs/functions/getSynchronizationItems.md +11 -9
- package/docs/functions/getVisitStore.md +1 -1
- package/docs/functions/getVisitTypes.md +15 -8
- package/docs/functions/getVisitsForPatient.md +1 -1
- package/docs/functions/isVersionSatisfied.md +1 -1
- package/docs/functions/makeUrl.md +1 -1
- package/docs/functions/messageOmrsServiceWorker.md +13 -11
- package/docs/functions/openmrsFetch.md +1 -1
- package/docs/functions/refetchCurrentUser.md +4 -4
- package/docs/functions/renderExtension.md +1 -1
- package/docs/functions/reportError.md +1 -1
- package/docs/functions/saveVisit.md +1 -1
- package/docs/functions/setCurrentVisit.md +1 -1
- package/docs/functions/setSessionLocation.md +1 -1
- package/docs/functions/setUserLanguage.md +1 -1
- package/docs/functions/setUserProperties.md +1 -1
- package/docs/functions/setupDynamicOfflineDataHandler.md +17 -9
- package/docs/functions/setupOfflineSync.md +17 -24
- package/docs/functions/subscribeActionableNotificationShown.md +1 -1
- package/docs/functions/subscribeNotificationShown.md +1 -1
- package/docs/functions/subscribePrecacheStaticDependencies.md +11 -4
- package/docs/functions/subscribeSnackbarShown.md +1 -1
- package/docs/functions/subscribeToastShown.md +1 -1
- package/docs/functions/toLocationObject.md +1 -1
- package/docs/functions/toVisitTypeObject.md +1 -1
- package/docs/functions/updateVisit.md +1 -1
- package/docs/functions/useConnectivity.md +6 -16
- package/docs/functions/useLocations.md +1 -1
- package/docs/functions/useVisitTypes.md +1 -1
- package/docs/functions/userHasAccess.md +1 -1
- package/docs/interfaces/AssignedExtension.md +8 -24
- package/docs/interfaces/CancelLoading.md +2 -2
- package/docs/interfaces/ConnectedExtension.md +6 -6
- package/docs/interfaces/CurrentPatientOptions.md +2 -2
- package/docs/interfaces/DisplayConditionsConfigObject.md +0 -20
- package/docs/interfaces/ExtensionRegistration.md +3 -19
- package/docs/interfaces/ExtensionSlotConfig.md +5 -5
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +1 -1
- package/docs/interfaces/ExtensionSlotProps.md +2 -2
- package/docs/interfaces/ExtensionSlotState.md +3 -3
- package/docs/interfaces/ExtensionStore.md +2 -2
- package/docs/interfaces/FeatureFlagDefinition.md +4 -4
- package/docs/interfaces/FetchConfig.md +3 -3
- package/docs/interfaces/FetchError.md +3 -3
- package/docs/interfaces/FetchHeaders.md +1 -1
- package/docs/interfaces/FetchResponseJson.md +1 -1
- package/docs/interfaces/ImportMap.md +2 -2
- package/docs/interfaces/OnlyThePatient.md +2 -2
- package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
- package/docs/interfaces/OpenmrsRoutes.md +3 -3
- package/docs/interfaces/PatientWithFullResponse.md +2 -2
- package/docs/interfaces/ResourceLoader.md +2 -2
- package/docs/interfaces/ShowActionableNotificationEvent.md +7 -7
- package/docs/interfaces/ShowNotificationEvent.md +6 -6
- package/docs/interfaces/ShowSnackbarEvent.md +9 -9
- package/docs/interfaces/ShowToastEvent.md +6 -6
- package/docs/interfaces/SpaConfig.md +5 -21
- package/docs/interfaces/VisitItem.md +5 -5
- package/docs/interfaces/VisitStoreState.md +3 -3
- package/docs/interfaces/WorkspaceDefinition2.md +5 -5
- package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
- package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
- package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
- package/docs/type-aliases/ConfigValue.md +1 -1
- package/docs/type-aliases/CurrentPatient.md +1 -1
- package/docs/type-aliases/ExtensionDefinition.md +10 -30
- package/docs/type-aliases/ExtensionSlotCustomState.md +1 -1
- package/docs/type-aliases/LoadedSessionStore.md +3 -3
- package/docs/type-aliases/ModalDefinition.md +3 -3
- package/docs/type-aliases/NameUse.md +1 -1
- package/docs/type-aliases/PageDefinition.md +1 -13
- package/docs/type-aliases/PatientUuid.md +1 -1
- package/docs/type-aliases/ProvidedConfig.md +3 -3
- package/docs/type-aliases/SessionStore.md +1 -1
- package/docs/type-aliases/SpaEnvironment.md +1 -1
- package/docs/type-aliases/UnloadedSessionStore.md +3 -3
- package/docs/type-aliases/Validator.md +1 -1
- package/docs/type-aliases/ValidatorFunction.md +1 -1
- package/docs/type-aliases/WorkspaceDefinition.md +10 -10
- package/docs/type-aliases/WorkspaceWindowState.md +1 -1
- package/docs/variables/defaultVisitCustomRepresentation.md +1 -1
- package/docs/variables/fhirBaseUrl.md +1 -1
- package/docs/variables/restBaseUrl.md +1 -1
- package/docs/variables/sessionEndpoint.md +1 -1
- package/docs/variables/visitTypesUrl.md +9 -0
- package/mock-jest.tsx +12 -4
- package/mock.tsx +12 -4
- package/package.json +19 -21
- package/src/deprecated.ts +87 -0
- package/src/index.ts +1 -1
- package/src/internal.ts +1 -1
- package/tsconfig.typedoc.json +0 -2
- package/docs/functions/beginEditSynchronizationItem.md +0 -22
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +0 -22
- package/docs/functions/deleteSynchronizationItem.md +0 -21
- package/docs/functions/generateOfflineUuid.md +0 -13
- package/docs/functions/getCurrentOfflineMode.md +0 -11
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +0 -34
- package/docs/functions/getDynamicOfflineDataHandlers.md +0 -13
- package/docs/functions/getFullSynchronizationItems.md +0 -27
- package/docs/functions/getFullSynchronizationItemsFor.md +0 -33
- package/docs/functions/getOfflinePatientDataStore.md +0 -15
- package/docs/functions/getSynchronizationItem.md +0 -27
- package/docs/functions/isOfflineUuid.md +0 -19
- package/docs/functions/isOnline.md +0 -27
- package/docs/functions/openmrsObservableFetch.md +0 -55
- package/docs/functions/putDynamicOfflineData.md +0 -28
- package/docs/functions/putDynamicOfflineDataFor.md +0 -34
- package/docs/functions/queueSynchronizationItem.md +0 -39
- package/docs/functions/registerOfflinePatientHandler.md +0 -25
- package/docs/functions/removeDynamicOfflineData.md +0 -28
- package/docs/functions/removeDynamicOfflineDataFor.md +0 -34
- package/docs/functions/subscribeConnectivity.md +0 -21
- package/docs/functions/subscribeConnectivityChanged.md +0 -21
- package/docs/functions/syncAllDynamicOfflineData.md +0 -27
- package/docs/functions/syncDynamicOfflineData.md +0 -33
- package/docs/functions/syncOfflinePatientData.md +0 -21
- package/docs/interfaces/ClearDynamicRoutesMessage.md +0 -21
- package/docs/interfaces/ConnectivityChangedEvent.md +0 -13
- package/docs/interfaces/DynamicOfflineData.md +0 -60
- package/docs/interfaces/DynamicOfflineDataHandler.md +0 -98
- package/docs/interfaces/DynamicOfflineDataSyncState.md +0 -65
- package/docs/interfaces/MessageServiceWorkerResult.md +0 -35
- package/docs/interfaces/OfflineModeResult.md +0 -29
- package/docs/interfaces/OfflinePatientArgs.md +0 -25
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +0 -35
- package/docs/interfaces/OfflinePatientDataSyncState.md +0 -61
- package/docs/interfaces/OfflinePatientDataSyncStore.md +0 -25
- package/docs/interfaces/OmrsServiceWorkerMessage.md +0 -25
- package/docs/interfaces/OnImportMapChangedMessage.md +0 -29
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +0 -5
- package/docs/interfaces/QueueItemDescriptor.md +0 -50
- package/docs/interfaces/RegisterDynamicRouteMessage.md +0 -45
- package/docs/interfaces/SyncItem.md +0 -79
- package/docs/interfaces/SyncProcessOptions.md +0 -53
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +0 -7
- package/docs/type-aliases/OfflineMode.md +0 -7
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +0 -12
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +0 -7
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +0 -44
- package/docs/variables/getStartedVisit.md +0 -9
- package/docs/variables/offlineUuidPrefix.md +0 -7
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +0 -7
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +0 -7
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: OpenmrsAppRoutes
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:345](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L345)
|
|
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/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:349](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L349)
|
|
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/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:365](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L365)
|
|
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/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:367](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L367)
|
|
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/src/types.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:369](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L369)
|
|
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/src/types.ts:
|
|
55
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:351](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L351)
|
|
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/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:363](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L363)
|
|
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/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L347)
|
|
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/src/types.ts:
|
|
91
|
+
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)
|
|
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/src/types.ts:
|
|
101
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:376](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L376)
|
|
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/src/types.ts:
|
|
111
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:371](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L371)
|
|
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/src/types.ts:
|
|
121
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:382](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L382)
|
|
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/src/types.ts:
|
|
131
|
+
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)
|
|
132
132
|
|
|
133
133
|
An array of all workspace windows (v2) supported by this frontend module.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: OpenmrsRoutes
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L389)
|
|
6
6
|
|
|
7
7
|
This interfaces describes the format of the overall routes.json loaded by the app shell.
|
|
8
8
|
Basically, this is the same as the app routes, with each routes definition keyed by the app's name
|
|
@@ -13,7 +13,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
|
|
|
13
13
|
|
|
14
14
|
> **routes**: `Record`\<`Exclude`\<`string`, `"version"`\>, [`OpenmrsAppRoutes`](OpenmrsAppRoutes.md)\>
|
|
15
15
|
|
|
16
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
16
|
+
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)
|
|
17
17
|
|
|
18
18
|
The routes associated with this application keyed by module id
|
|
19
19
|
|
|
@@ -23,6 +23,6 @@ The routes associated with this application keyed by module id
|
|
|
23
23
|
|
|
24
24
|
> `optional` **version**: `string`
|
|
25
25
|
|
|
26
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
26
|
+
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)
|
|
27
27
|
|
|
28
28
|
The overall version for this application
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: PatientWithFullResponse
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L10)
|
|
6
6
|
|
|
7
7
|
## Extends
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:11](https://g
|
|
|
14
14
|
|
|
15
15
|
> **includeConfig**: `true`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L11)
|
|
18
18
|
|
|
19
19
|
#### Overrides
|
|
20
20
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ResourceLoader()\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L396)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:422](https://github.com
|
|
|
12
12
|
|
|
13
13
|
> **ResourceLoader**(): `Promise`\<`T`\>
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
15
|
+
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)
|
|
16
16
|
|
|
17
17
|
## Returns
|
|
18
18
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ShowActionableNotificationEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L10)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:53](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> **actionButtonLabel**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L14)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:57](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L12)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:55](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> **onActionButtonClick**: () => `void`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L15)
|
|
30
30
|
|
|
31
31
|
#### Returns
|
|
32
32
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:58](https://github.com
|
|
|
38
38
|
|
|
39
39
|
> `optional` **progressActionLabel**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
41
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L16)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:59](https://github.com
|
|
|
46
46
|
|
|
47
47
|
> **subtitle**: `any`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L11)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,4 +54,4 @@ Defined in: [packages/framework/esm-globals/src/events.ts:54](https://github.com
|
|
|
54
54
|
|
|
55
55
|
> `optional` **title**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
57
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L13)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ShowNotificationEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L2)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:45](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **action**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L6)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:49](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **description**: `any`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L3)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:46](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L4)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:47](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **millis**: `number`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L7)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,4 +42,4 @@ Defined in: [packages/framework/esm-globals/src/events.ts:50](https://github.com
|
|
|
42
42
|
|
|
43
43
|
> `optional` **title**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L5)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ShowSnackbarEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L29)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:72](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **actionButtonLabel**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L33)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:76](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> `optional` **isLowContrast**: `boolean`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L36)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:79](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L31)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:74](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **onActionButtonClick**: () => `void`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L34)
|
|
38
38
|
|
|
39
39
|
#### Returns
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:77](https://github.com
|
|
|
46
46
|
|
|
47
47
|
> `optional` **progressActionLabel**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L35)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:78](https://github.com
|
|
|
54
54
|
|
|
55
55
|
> `optional` **subtitle**: `any`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
57
|
+
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)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:73](https://github.com
|
|
|
62
62
|
|
|
63
63
|
> `optional` **timeoutInMs**: `number`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
65
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L37)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,4 +70,4 @@ Defined in: [packages/framework/esm-globals/src/events.ts:80](https://github.com
|
|
|
70
70
|
|
|
71
71
|
> **title**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
73
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L32)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ShowToastEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L20)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:63](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **actionButtonLabel**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L24)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:67](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **description**: `any`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L21)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:64](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L22)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/events.ts:65](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **onActionButtonClick**: () => `void`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L25)
|
|
38
38
|
|
|
39
39
|
#### Returns
|
|
40
40
|
|
|
@@ -46,4 +46,4 @@ Defined in: [packages/framework/esm-globals/src/events.ts:68](https://github.com
|
|
|
46
46
|
|
|
47
47
|
> `optional` **title**: `string`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/framework/esm-globals/src/events.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-globals/src/events.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L23)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: SpaConfig
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L66)
|
|
6
6
|
|
|
7
7
|
The configuration passed to the app shell initialization function
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ The configuration passed to the app shell initialization function
|
|
|
12
12
|
|
|
13
13
|
> **apiUrl**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L70)
|
|
16
16
|
|
|
17
17
|
The base path or URL for the OpenMRS API / endpoints.
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ The base path or URL for the OpenMRS API / endpoints.
|
|
|
22
22
|
|
|
23
23
|
> `optional` **configUrls**: `string`[]
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L83)
|
|
26
26
|
|
|
27
27
|
URLs of configurations to load in the system.
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ URLs of configurations to load in the system.
|
|
|
32
32
|
|
|
33
33
|
> `optional` **env**: [`SpaEnvironment`](../type-aliases/SpaEnvironment.md)
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L79)
|
|
36
36
|
|
|
37
37
|
The environment to use.
|
|
38
38
|
|
|
@@ -44,26 +44,10 @@ production
|
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
47
|
-
### offline?
|
|
48
|
-
|
|
49
|
-
> `optional` **offline**: `boolean`
|
|
50
|
-
|
|
51
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L93)
|
|
52
|
-
|
|
53
|
-
Defines if offline should be supported by installing a service worker.
|
|
54
|
-
|
|
55
|
-
#### Default
|
|
56
|
-
|
|
57
|
-
```ts
|
|
58
|
-
true
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
***
|
|
62
|
-
|
|
63
47
|
### spaPath
|
|
64
48
|
|
|
65
49
|
> **spaPath**: `string`
|
|
66
50
|
|
|
67
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
51
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L74)
|
|
68
52
|
|
|
69
53
|
The base path for the SPA root path.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: VisitItem
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L6)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:7](https://github
|
|
|
10
10
|
|
|
11
11
|
> `optional` **anythingElse**: `any`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L10)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:11](https://githu
|
|
|
18
18
|
|
|
19
19
|
> **mode**: [`VisitMode`](../enumerations/VisitMode.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L7)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:8](https://github
|
|
|
26
26
|
|
|
27
27
|
> **status**: [`VisitStatus`](../enumerations/VisitStatus.md)
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L9)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,4 +34,4 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:10](https://githu
|
|
|
34
34
|
|
|
35
35
|
> `optional` **visitData**: [`Visit`](Visit.md)
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L8)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: VisitStoreState
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L24)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:25](https://githu
|
|
|
10
10
|
|
|
11
11
|
> **manuallySetVisitUuid**: `null` \| `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L26)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,4 +18,4 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:27](https://githu
|
|
|
18
18
|
|
|
19
19
|
> **patientUuid**: `null` \| `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L25)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:319](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L319)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:345](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> **component**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:321](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L321)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:347](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> `optional` **meta**: `object`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:327](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L327)
|
|
22
22
|
|
|
23
23
|
Meta describes any properties that are passed down to the workspace when it is loaded. It is
|
|
24
24
|
available to the workspace component via `useWorkspace2Context().workspaceMeta`.
|
|
@@ -33,7 +33,7 @@ available to the workspace component via `useWorkspace2Context().workspaceMeta`.
|
|
|
33
33
|
|
|
34
34
|
> **name**: `string`
|
|
35
35
|
|
|
36
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
36
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L320)
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
@@ -41,4 +41,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:346](https://github.com
|
|
|
41
41
|
|
|
42
42
|
> **window**: `string`
|
|
43
43
|
|
|
44
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
44
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:322](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L322)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceGroupDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:267](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L267)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:293](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **members**: `string`[]
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:275](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L275)
|
|
14
14
|
|
|
15
15
|
List of workspace names which are part of the workspace group.
|
|
16
16
|
|
|
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
|
|
|
20
20
|
|
|
21
21
|
> **name**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:271](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L271)
|
|
24
24
|
|
|
25
25
|
Name of the workspace group. This is used to launch the workspace group
|