@openmrs/esm-framework 10.0.1-pre.5542 → 10.0.1-pre.5561
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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useLocations**(`tagUuidOrName`, `query`): [`Location`](../interfaces/Location.md)[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useLocations.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useLocations.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLocations.tsx#L32)
|
|
8
8
|
|
|
9
9
|
A React hook that fetches and returns locations from the OpenMRS server.
|
|
10
10
|
Locations can be filtered by a tag UUID/name and/or a search query string.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useVisitTypes**(): [`VisitType`](../interfaces/VisitType.md)[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useVisitTypes.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useVisitTypes.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitTypes.ts#L29)
|
|
8
8
|
|
|
9
9
|
A React hook that fetches and returns all available visit types from the
|
|
10
10
|
OpenMRS server. The data is fetched once when the component mounts.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L286)
|
|
8
8
|
|
|
9
9
|
Checks whether the given user has access based on the required privilege(s).
|
|
10
10
|
A user has access if they have the required privilege(s) or if they are a
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: AssignedExtension
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L110)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:112](https://github.
|
|
|
10
10
|
|
|
11
11
|
> `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L116)
|
|
14
14
|
|
|
15
15
|
The extension's config. Note that this will be `null` until the slot is mounted.
|
|
16
16
|
|
|
@@ -20,7 +20,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
|
|
|
20
20
|
|
|
21
21
|
> `readonly` `optional` **displayConditionExpression**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L119)
|
|
24
24
|
|
|
25
25
|
The condition under which this extension should be displayed.
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ The condition under which this extension should be displayed.
|
|
|
30
30
|
|
|
31
31
|
> `readonly` `optional` **featureFlag**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
33
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:117](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L117)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:121](https://github.
|
|
|
38
38
|
|
|
39
39
|
> `readonly` **id**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
41
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L111)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:113](https://github.
|
|
|
46
46
|
|
|
47
47
|
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L114)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:116](https://github.
|
|
|
54
54
|
|
|
55
55
|
> `readonly` **moduleName**: `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
57
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L113)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,20 +62,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:115](https://github.
|
|
|
62
62
|
|
|
63
63
|
> `readonly` **name**: `string`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
66
|
-
|
|
67
|
-
***
|
|
68
|
-
|
|
69
|
-
### offline?
|
|
70
|
-
|
|
71
|
-
> `readonly` `optional` **offline**: `boolean` \| `object`
|
|
72
|
-
|
|
73
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L120)
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### online?
|
|
78
|
-
|
|
79
|
-
> `readonly` `optional` **online**: `boolean` \| `object`
|
|
80
|
-
|
|
81
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L119)
|
|
65
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L112)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: CancelLoading()
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L14)
|
|
6
6
|
|
|
7
7
|
> **CancelLoading**(): `void`
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:
|
|
9
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L15)
|
|
10
10
|
|
|
11
11
|
## Returns
|
|
12
12
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ~~ConnectedExtension~~
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:123](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L123)
|
|
6
6
|
|
|
7
7
|
## Deprecated
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@ replaced with AssignedExtension
|
|
|
14
14
|
|
|
15
15
|
> `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L129)
|
|
18
18
|
|
|
19
19
|
The extension's config. Note that this will be `null` until the slot is mounted.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **id**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:124](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L124)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:128](https://github.
|
|
|
32
32
|
|
|
33
33
|
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L127)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:131](https://github.
|
|
|
40
40
|
|
|
41
41
|
> `readonly` **moduleName**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
43
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L126)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
@@ -48,4 +48,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:130](https://github.
|
|
|
48
48
|
|
|
49
49
|
> `readonly` **name**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
51
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L125)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: CurrentPatientOptions
|
|
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:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L6)
|
|
6
6
|
|
|
7
7
|
## Extended by
|
|
8
8
|
|
|
@@ -15,4 +15,4 @@ Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:7](https://gi
|
|
|
15
15
|
|
|
16
16
|
> `optional` **includeConfig**: `boolean`
|
|
17
17
|
|
|
18
|
-
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:
|
|
18
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L7)
|
|
@@ -16,26 +16,6 @@ An expression to evaluate whether or not the user should see this extension
|
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
19
|
-
### offline?
|
|
20
|
-
|
|
21
|
-
> `optional` **offline**: `boolean`
|
|
22
|
-
|
|
23
|
-
Defined in: [packages/framework/esm-config/src/types.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L43)
|
|
24
|
-
|
|
25
|
-
Whether to display this extension when not connected to the server
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### online?
|
|
30
|
-
|
|
31
|
-
> `optional` **online**: `boolean`
|
|
32
|
-
|
|
33
|
-
Defined in: [packages/framework/esm-config/src/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L41)
|
|
34
|
-
|
|
35
|
-
Whether to display this extension when connected to the server
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
19
|
### privileges?
|
|
40
20
|
|
|
41
21
|
> `optional` **privileges**: `string`[]
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:11](https://github.c
|
|
|
10
10
|
|
|
11
11
|
> `readonly` `optional` **displayExpression**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L19)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:21](https://github.c
|
|
|
18
18
|
|
|
19
19
|
> `readonly` `optional` **featureFlag**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L18)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -46,22 +46,6 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:12](https://github.c
|
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
49
|
-
### offline?
|
|
50
|
-
|
|
51
|
-
> `readonly` `optional` **offline**: `boolean`
|
|
52
|
-
|
|
53
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L18)
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### online?
|
|
58
|
-
|
|
59
|
-
> `readonly` `optional` **online**: `boolean`
|
|
60
|
-
|
|
61
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L17)
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
49
|
### order?
|
|
66
50
|
|
|
67
51
|
> `readonly` `optional` **order**: `number`
|
|
@@ -74,7 +58,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:16](https://github.c
|
|
|
74
58
|
|
|
75
59
|
> `readonly` `optional` **privileges**: `string` \| `string`[]
|
|
76
60
|
|
|
77
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
61
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L17)
|
|
78
62
|
|
|
79
63
|
## Methods
|
|
80
64
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionSlotConfig
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-config/src/types.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L44)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-config/src/types.ts:48](https://github.com/o
|
|
|
10
10
|
|
|
11
11
|
> `optional` **add**: `string`[]
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-config/src/types.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L46)
|
|
14
14
|
|
|
15
15
|
Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
|
|
16
16
|
|
|
@@ -20,7 +20,7 @@ Additional extension IDs to assign to this slot, in addition to those `attach`ed
|
|
|
20
20
|
|
|
21
21
|
> `optional` **configure**: [`ExtensionSlotConfigureValueObject`](ExtensionSlotConfigureValueObject.md)
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L51)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/framework/esm-config/src/types.ts:55](https://github.com/o
|
|
|
28
28
|
|
|
29
29
|
> `optional` **order**: `string`[]
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
31
|
+
Defined in: [packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
|
|
32
32
|
|
|
33
33
|
Overrides the default ordering of extensions.
|
|
34
34
|
|
|
@@ -38,6 +38,6 @@ Overrides the default ordering of extensions.
|
|
|
38
38
|
|
|
39
39
|
> `optional` **remove**: `string`[]
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
41
|
+
Defined in: [packages/framework/esm-config/src/types.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L48)
|
|
42
42
|
|
|
43
43
|
Extension IDs which were `attach`ed to the slot but which should not be assigned.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionSlotConfigureValueObject
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-config/src/types.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L54)
|
|
6
6
|
|
|
7
7
|
## Indexable
|
|
8
8
|
|
|
@@ -913,7 +913,7 @@ Defines the human readable text alternative of aria-valuenow for a range widget.
|
|
|
913
913
|
|
|
914
914
|
### autoCapitalize?
|
|
915
915
|
|
|
916
|
-
> `optional` **autoCapitalize**: `"none"` \| `
|
|
916
|
+
> `optional` **autoCapitalize**: `"none"` \| `string` & `object` \| `"off"` \| `"on"` \| `"sentences"` \| `"words"` \| `"characters"`
|
|
917
917
|
|
|
918
918
|
Defined in: node\_modules/@types/react/index.d.ts:2913
|
|
919
919
|
|
|
@@ -3499,7 +3499,7 @@ Defined in: node\_modules/@types/react/index.d.ts:2948
|
|
|
3499
3499
|
|
|
3500
3500
|
### unselectable?
|
|
3501
3501
|
|
|
3502
|
-
> `optional` **unselectable**: `"
|
|
3502
|
+
> `optional` **unselectable**: `"off"` \| `"on"`
|
|
3503
3503
|
|
|
3504
3504
|
Defined in: node\_modules/@types/react/index.d.ts:2962
|
|
3505
3505
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionSlotState
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L101)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:103](https://github.
|
|
|
10
10
|
|
|
11
11
|
> **candidateExtensions**: [`AssignedExtension`](AssignedExtension.md)[]
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L107)
|
|
14
14
|
|
|
15
15
|
Candidates only. Call `getAssignedExtensions()` for the extensions a given rendering of
|
|
16
16
|
this slot should actually display.
|
|
@@ -21,4 +21,4 @@ this slot should actually display.
|
|
|
21
21
|
|
|
22
22
|
> `optional` **moduleName**: `string`
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
24
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L102)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionStore
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:97](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L97)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,4 +10,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:99](https://github.c
|
|
|
10
10
|
|
|
11
11
|
> **slots**: `Record`\<`string`, [`ExtensionSlotState`](ExtensionSlotState.md)\>
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L98)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FeatureFlagDefinition
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:335](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L335)
|
|
6
6
|
|
|
7
7
|
A definition of a feature flag extracted from the routes.json
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ A definition of a feature flag extracted from the routes.json
|
|
|
12
12
|
|
|
13
13
|
> **description**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:341](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L341)
|
|
16
16
|
|
|
17
17
|
An explanation of what the flag does, which will be displayed in the Implementer Tools
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
|
|
|
22
22
|
|
|
23
23
|
> **flagName**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L337)
|
|
26
26
|
|
|
27
27
|
A code-friendly name for the flag, which will be used to reference it in code
|
|
28
28
|
|
|
@@ -32,6 +32,6 @@ A code-friendly name for the flag, which will be used to reference it in code
|
|
|
32
32
|
|
|
33
33
|
> **label**: `string`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:339](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L339)
|
|
36
36
|
|
|
37
37
|
A human-friendly name which will be displayed in the Implementer Tools
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FetchConfig
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:271](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L271)
|
|
6
6
|
|
|
7
7
|
## Extends
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:333](https://github
|
|
|
14
14
|
|
|
15
15
|
> `optional` **body**: `string` \| `FetchBody`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:273](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L273)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -50,7 +50,7 @@ A string indicating whether credentials will be sent with the request always, ne
|
|
|
50
50
|
|
|
51
51
|
> `optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:272](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L272)
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FetchError
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:290](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L290)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:352](https://github
|
|
|
10
10
|
|
|
11
11
|
> **response**: `Response`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:291](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L291)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,4 +18,4 @@ Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:353](https://github
|
|
|
18
18
|
|
|
19
19
|
> **responseBody**: `null` \| `ResponseBody`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:292](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L292)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FetchHeaders
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:278](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L278)
|
|
6
6
|
|
|
7
7
|
## Indexable
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: FetchResponseJson
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L286)
|
|
6
6
|
|
|
7
7
|
## Indexable
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ImportMap
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L59)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,4 +10,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:64](https://github.com/
|
|
|
10
10
|
|
|
11
11
|
> **imports**: `Record`\<`string`, `string`\>
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L60)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: OnlyThePatient
|
|
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:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L14)
|
|
6
6
|
|
|
7
7
|
## Extends
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:15](https://g
|
|
|
14
14
|
|
|
15
15
|
> **includeConfig**: `false`
|
|
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:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L15)
|
|
18
18
|
|
|
19
19
|
#### Overrides
|
|
20
20
|
|