@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: WorkspaceGroupDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:278](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L278)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:304](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **closeable**: `boolean`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L280)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:306](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **name**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:279](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L279)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:305](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **overlay**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L281)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:307](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> `optional` **persistence**: `"app-wide"` \| `"closable"`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:292](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L292)
|
|
38
38
|
|
|
39
39
|
In app-wide persistence mode, a workspace group renders its
|
|
40
40
|
action menu without a close button. This is for
|
|
@@ -50,7 +50,7 @@ with any opened windows / workspaces.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **scopePattern**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:307](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L307)
|
|
54
54
|
|
|
55
55
|
URL pattern that defines the scope where workspaces in this group should persist.
|
|
56
56
|
The pattern is matched against the pathname relative to the configured SPA base path.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: WorkspaceWindowDefinition2
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:310](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L310)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:336](https://github.com
|
|
|
10
10
|
|
|
11
11
|
> `optional` **canMaximize**: `boolean`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:313](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L313)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:339](https://github.com
|
|
|
18
18
|
|
|
19
19
|
> **group**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:314](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L314)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:340](https://github.com
|
|
|
26
26
|
|
|
27
27
|
> `optional` **icon**: `string`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:312](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L312)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:338](https://github.com
|
|
|
34
34
|
|
|
35
35
|
> **name**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L311)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com
|
|
|
42
42
|
|
|
43
43
|
> `optional` **order**: `number`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:315](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L315)
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
@@ -50,4 +50,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:341](https://github.com
|
|
|
50
50
|
|
|
51
51
|
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L316)
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **ConfigValue** = `string` \| `number` \| `boolean` \| `void` \| `any`[] \| `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/types.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L42)
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **CurrentPatient** = `fhir.Patient` \| [`FetchResponse`](../interfaces/FetchResponse.md)\<`fhir.Patient`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L4)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ExtensionDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:150](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L150)
|
|
8
8
|
|
|
9
9
|
A definition of an extension as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of an extension as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L188)
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> `optional` **displayExpression**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L174)
|
|
28
28
|
|
|
29
29
|
The expression that determines whether the extension is displayed.
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ The expression that determines whether the extension is displayed.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **featureFlag**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L178)
|
|
38
38
|
|
|
39
39
|
If supplied, the extension will only be rendered when this feature flag is enabled.
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
|
|
|
44
44
|
|
|
45
45
|
> `optional` **meta**: `object`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
47
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L182)
|
|
48
48
|
|
|
49
49
|
Meta describes any properties that are passed down to the extension when it is loaded
|
|
50
50
|
|
|
@@ -58,37 +58,17 @@ Meta describes any properties that are passed down to the extension when it is l
|
|
|
58
58
|
|
|
59
59
|
> **name**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
61
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:154](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L154)
|
|
62
62
|
|
|
63
63
|
The name of this extension. This is used to refer to the extension in configuration.
|
|
64
64
|
|
|
65
65
|
***
|
|
66
66
|
|
|
67
|
-
### offline?
|
|
68
|
-
|
|
69
|
-
> `optional` **offline**: `boolean`
|
|
70
|
-
|
|
71
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L188)
|
|
72
|
-
|
|
73
|
-
Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### online?
|
|
78
|
-
|
|
79
|
-
> `optional` **online**: `boolean`
|
|
80
|
-
|
|
81
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L184)
|
|
82
|
-
|
|
83
|
-
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
84
|
-
|
|
85
|
-
***
|
|
86
|
-
|
|
87
67
|
### order?
|
|
88
68
|
|
|
89
69
|
> `optional` **order**: `number`
|
|
90
70
|
|
|
91
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:166](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L166)
|
|
92
72
|
|
|
93
73
|
Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
|
|
94
74
|
|
|
@@ -98,7 +78,7 @@ Determines the order in which this component renders in its default extension sl
|
|
|
98
78
|
|
|
99
79
|
> `optional` **privileges**: `string` \| `string`[]
|
|
100
80
|
|
|
101
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L170)
|
|
102
82
|
|
|
103
83
|
The user must have ANY of these privileges to see this extension.
|
|
104
84
|
|
|
@@ -108,7 +88,7 @@ The user must have ANY of these privileges to see this extension.
|
|
|
108
88
|
|
|
109
89
|
> `optional` **slot**: `string`
|
|
110
90
|
|
|
111
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:158](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L158)
|
|
112
92
|
|
|
113
93
|
If supplied, the slot that this extension is rendered into by default.
|
|
114
94
|
|
|
@@ -118,6 +98,6 @@ If supplied, the slot that this extension is rendered into by default.
|
|
|
118
98
|
|
|
119
99
|
> `optional` **slots**: `string`[]
|
|
120
100
|
|
|
121
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
101
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L162)
|
|
122
102
|
|
|
123
103
|
If supplied, the slots that this extension is rendered into by default.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ExtensionSlotCustomState** = `Record`\<`string`, `unknown`\> \| `undefined`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
|
|
8
8
|
|
|
9
9
|
The state one rendering of a slot is displaying, which its extensions' display conditions are
|
|
10
10
|
evaluated against. Each key becomes a variable of that name in the expression, so only string
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **LoadedSessionStore** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L10)
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-api/src/current-user.ts:11](https://github.c
|
|
|
12
12
|
|
|
13
13
|
> **loaded**: `true`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L11)
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Defined in: [packages/framework/esm-api/src/current-user.ts:12](https://github.c
|
|
|
20
20
|
|
|
21
21
|
> **session**: [`Session`](../interfaces/Session.md)
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L12)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ModalDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:194](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L194)
|
|
8
8
|
|
|
9
9
|
A definition of a modal as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> **component**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L202)
|
|
18
18
|
|
|
19
19
|
The name of the component exported by this frontend module.
|
|
20
20
|
|
|
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
|
|
|
24
24
|
|
|
25
25
|
> **name**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L198)
|
|
28
28
|
|
|
29
29
|
The name of this modal. This is used to launch the modal.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:403](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L403)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **PageDefinition** = `object` & \{ `route`: `string` \| `boolean`; `routeRegex?`: `never`; \} \| \{ `route?`: `never`; `routeRegex`: `string`; \}
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:97](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L97)
|
|
8
8
|
|
|
9
9
|
A definition of a page extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -27,15 +27,3 @@ If supplied, the page will be rendered within the DOM element with the specified
|
|
|
27
27
|
> `optional` **featureFlag**: `string`
|
|
28
28
|
|
|
29
29
|
If supplied, the page will only be rendered when this feature flag is enabled.
|
|
30
|
-
|
|
31
|
-
### offline?
|
|
32
|
-
|
|
33
|
-
> `optional` **offline**: `boolean`
|
|
34
|
-
|
|
35
|
-
Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
|
|
36
|
-
|
|
37
|
-
### online?
|
|
38
|
-
|
|
39
|
-
> `optional` **online**: `boolean`
|
|
40
|
-
|
|
41
|
-
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **PatientUuid** = `string` \| `null`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L18)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ProvidedConfig** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L58)
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-config/src/types.ts:62](https://github.com/o
|
|
|
12
12
|
|
|
13
13
|
> **config**: [`Config`](../interfaces/Config.md)
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-config/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L60)
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Defined in: [packages/framework/esm-config/src/types.ts:64](https://github.com/o
|
|
|
20
20
|
|
|
21
21
|
> **source**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-config/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L59)
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **SessionStore** = [`LoadedSessionStore`](LoadedSessionStore.md) \| [`UnloadedSessionStore`](UnloadedSessionStore.md)
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L8)
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **SpaEnvironment** = `"production"` \| `"development"` \| `"test"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L57)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **UnloadedSessionStore** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L15)
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-api/src/current-user.ts:16](https://github.c
|
|
|
12
12
|
|
|
13
13
|
> **loaded**: `false`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
15
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L16)
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Defined in: [packages/framework/esm-api/src/current-user.ts:17](https://github.c
|
|
|
20
20
|
|
|
21
21
|
> **session**: `null`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
|
23
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L17)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **Validator** = (`value`) => `void` \| `string`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
|
|
8
8
|
|
|
9
9
|
## Parameters
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ValidatorFunction** = (`value`) => `boolean`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
|
|
8
8
|
|
|
9
9
|
## Parameters
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:211](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L211)
|
|
8
8
|
|
|
9
9
|
A definition of a workspace as extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
|
|
|
14
14
|
|
|
15
15
|
> `optional` **canHide**: `boolean`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L227)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:253](https://github.com
|
|
|
22
22
|
|
|
23
23
|
> `optional` **canMaximize**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
25
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L228)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:254](https://github.com
|
|
|
30
30
|
|
|
31
31
|
> **component**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
33
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L264)
|
|
34
34
|
|
|
35
35
|
The name of the component exported by this frontend module.
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
|
|
|
40
40
|
|
|
41
41
|
> **groups**: `string`[]
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
43
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:260](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L260)
|
|
44
44
|
|
|
45
45
|
Workspaces can open either independently or as part of a "workspace group". A
|
|
46
46
|
"workspace group" groups related workspaces together, so that only one is visible
|
|
@@ -68,7 +68,7 @@ name, the entire workspace group will close, and the new workspace will launch i
|
|
|
68
68
|
|
|
69
69
|
> **name**: `string`
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:215](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L215)
|
|
72
72
|
|
|
73
73
|
The name of this workspace. This is used to launch the workspace.
|
|
74
74
|
|
|
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
|
|
|
78
78
|
|
|
79
79
|
> `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:238](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L238)
|
|
82
82
|
|
|
83
83
|
Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
|
|
|
88
88
|
|
|
89
89
|
> **title**: `string`
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L220)
|
|
92
92
|
|
|
93
93
|
The title of the workspace. This will be looked up as a key in the translations of the module
|
|
94
94
|
defining the workspace.
|
|
@@ -99,7 +99,7 @@ defining the workspace.
|
|
|
99
99
|
|
|
100
100
|
> **type**: `string`
|
|
101
101
|
|
|
102
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
102
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:226](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L226)
|
|
103
103
|
|
|
104
104
|
The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
|
|
105
105
|
time. The default is "form". If the right sidebar is in use, then the type determines which
|
|
@@ -111,7 +111,7 @@ right sidebar icon corresponds to the workspace.
|
|
|
111
111
|
|
|
112
112
|
> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
|
|
113
113
|
|
|
114
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
114
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:234](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L234)
|
|
115
115
|
|
|
116
116
|
Controls the width of the workspace. The default is "narrow" and this should only be
|
|
117
117
|
changed to "wider" if the workspace itself has internal navigation, like the form editor.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-globals/src/types.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L206)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **defaultVisitCustomRepresentation**: `string`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L34)
|
|
8
8
|
|
|
9
9
|
The default custom representation string for fetching visit data from the REST API.
|
|
10
10
|
This representation includes comprehensive visit details such as encounters, patient,
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **fhirBaseUrl**: `"/ws/fhir2/R4"` = `'/ws/fhir2/R4'`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L11)
|
|
8
8
|
|
|
9
9
|
The base URL for the OpenMRS FHIR R4 API (e.g., '/ws/fhir2/R4').
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **restBaseUrl**: `"/ws/rest/v1"` = `'/ws/rest/v1'`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L9)
|
|
8
8
|
|
|
9
9
|
The base URL for the OpenMRS REST API (e.g., '/ws/rest/v1').
|
|
@@ -4,6 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
> `const` **sessionEndpoint**: `"/ws/rest/v1/session"`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L13)
|
|
8
8
|
|
|
9
9
|
The endpoint for session management operations.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
[O3 Framework](../API.md) / visitTypesUrl
|
|
2
|
+
|
|
3
|
+
# Variable: visitTypesUrl
|
|
4
|
+
|
|
5
|
+
> `const` **visitTypesUrl**: `"/ws/rest/v1/visittype"`
|
|
6
|
+
|
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-type.ts#L14)
|
|
8
|
+
|
|
9
|
+
The endpoint [getVisitTypes](../functions/getVisitTypes.md) reads from. Use it as the SWR key when caching visit types.
|
package/mock-jest.tsx
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import React, { useState } from 'react';
|
|
2
|
-
import { NEVER } from 'rxjs';
|
|
3
2
|
import type {} from '@openmrs/esm-globals';
|
|
4
3
|
import * as utils from '@openmrs/esm-utils/mock';
|
|
5
4
|
import dayjs from 'dayjs';
|
|
@@ -47,7 +46,7 @@ export function setupPaths(config: any) {
|
|
|
47
46
|
export const importDynamic = jest.fn();
|
|
48
47
|
|
|
49
48
|
/* esm-error-handling */
|
|
50
|
-
export const createErrorHandler = () => jest.fn()
|
|
49
|
+
export const createErrorHandler = () => jest.fn();
|
|
51
50
|
|
|
52
51
|
export const reportError = jest.fn().mockImplementation((error) => {
|
|
53
52
|
throw error;
|
|
@@ -65,9 +64,18 @@ export const getHistory = jest.fn(() => ['https://o3.openmrs.org/home']);
|
|
|
65
64
|
export const clearHistory = jest.fn();
|
|
66
65
|
export const goBackInHistory = jest.fn();
|
|
67
66
|
|
|
68
|
-
/*
|
|
67
|
+
/* deprecated offline shims; these mirror the no-op implementations in src/deprecated.ts */
|
|
69
68
|
export const useConnectivity = jest.fn().mockReturnValue(true);
|
|
70
|
-
export const
|
|
69
|
+
export const setupOfflineSync = jest.fn();
|
|
70
|
+
export const setupDynamicOfflineDataHandler = jest.fn();
|
|
71
|
+
export const getDynamicOfflineDataEntries = jest.fn().mockResolvedValue([]);
|
|
72
|
+
export const getSynchronizationItems = jest.fn().mockResolvedValue([]);
|
|
73
|
+
export const subscribePrecacheStaticDependencies = jest.fn(() => () => {});
|
|
74
|
+
export const messageOmrsServiceWorker = jest.fn().mockResolvedValue({
|
|
75
|
+
success: false,
|
|
76
|
+
result: undefined,
|
|
77
|
+
error: 'No service worker has been registered. Offline-related features have been removed from the framework.',
|
|
78
|
+
});
|
|
71
79
|
|
|
72
80
|
/* esm-styleguide */
|
|
73
81
|
export const showNotification = jest.fn();
|