@openmrs/esm-framework 9.0.3-pre.4128 → 9.0.3-pre.4166
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/docs/API.md +7 -0
- package/docs/functions/age.md +6 -6
- package/docs/functions/calculateInterpretation.md +2 -2
- package/docs/functions/canAccessStorage.md +4 -4
- package/docs/functions/convertToLocaleCalendar.md +1 -1
- package/docs/functions/createAttachment.md +2 -2
- package/docs/functions/createErrorHandler.md +1 -1
- package/docs/functions/deleteAttachmentPermanently.md +2 -2
- package/docs/functions/dispatchNotificationShown.md +1 -1
- package/docs/functions/dispatchPrecacheStaticDependencies.md +4 -4
- package/docs/functions/displayName.md +1 -1
- package/docs/functions/fetchCurrentPatient.md +1 -1
- package/docs/functions/formatDate.md +1 -1
- package/docs/functions/formatDatetime.md +1 -1
- package/docs/functions/formatDuration.md +1 -1
- package/docs/functions/formatPartialDate.md +4 -4
- package/docs/functions/formatPatientName.md +1 -1
- package/docs/functions/formatTime.md +1 -1
- package/docs/functions/formattedName.md +1 -1
- package/docs/functions/getAttachmentByUuid.md +2 -2
- package/docs/functions/getAttachments.md +2 -2
- package/docs/functions/getCoreTranslation.md +1 -1
- package/docs/functions/getDefaultCalendar.md +1 -1
- package/docs/functions/getDefaultsFromConfigSchema.md +1 -1
- package/docs/functions/getLocale.md +1 -1
- package/docs/functions/getPatientName.md +1 -1
- package/docs/functions/getVisitsForPatient.md +2 -2
- package/docs/functions/isOmrsDateStrict.md +1 -1
- package/docs/functions/isOmrsDateToday.md +1 -1
- package/docs/functions/isOnline.md +1 -1
- package/docs/functions/isVersionSatisfied.md +1 -1
- package/docs/functions/normalizeInterpretation.md +3 -3
- package/docs/functions/parseDate.md +1 -1
- package/docs/functions/registerDefaultCalendar.md +1 -1
- package/docs/functions/reportError.md +1 -1
- package/docs/functions/retry.md +4 -4
- package/docs/functions/saveVisit.md +2 -2
- package/docs/functions/selectPreferredName.md +1 -1
- package/docs/functions/shallowEqual.md +1 -1
- package/docs/functions/subscribeActionableNotificationShown.md +1 -1
- package/docs/functions/subscribeConnectivity.md +1 -1
- package/docs/functions/subscribeConnectivityChanged.md +1 -1
- package/docs/functions/subscribeNotificationShown.md +1 -1
- package/docs/functions/subscribePrecacheStaticDependencies.md +1 -1
- package/docs/functions/subscribeSnackbarShown.md +1 -1
- package/docs/functions/subscribeToastShown.md +1 -1
- package/docs/functions/toDateObjectStrict.md +1 -1
- package/docs/functions/toOmrsIsoString.md +4 -4
- package/docs/functions/updateVisit.md +2 -2
- package/docs/functions/useAssignedExtensions.md +2 -2
- package/docs/functions/useAttachments.md +2 -2
- package/docs/functions/useEmrConfiguration.md +1 -1
- package/docs/functions/useExtensionSlotMeta.md +1 -1
- package/docs/functions/useExtensionSlotStore.md +2 -2
- package/docs/functions/useFhirPagination.md +1 -1
- package/docs/functions/useLeftNav.md +1 -1
- package/docs/functions/useLeftNavStore.md +2 -2
- package/docs/functions/useLocations.md +2 -2
- package/docs/functions/useOpenmrsPagination.md +1 -1
- package/docs/functions/useOpenmrsSWR.md +2 -2
- package/docs/functions/useSession.md +2 -2
- package/docs/functions/useVisitContextStore.md +2 -2
- package/docs/functions/useVisitTypes.md +2 -2
- package/docs/interfaces/AssignedExtension.md +1 -1
- package/docs/interfaces/ConfigurableLinkProps.md +1 -1
- package/docs/interfaces/ConnectedExtension.md +1 -1
- package/docs/interfaces/ConnectivityChangedEvent.md +2 -2
- package/docs/interfaces/Diagnosis.md +20 -16
- package/docs/interfaces/Drug.md +17 -13
- package/docs/interfaces/EmrApiConfigurationResponse.md +51 -51
- package/docs/interfaces/Encounter.md +18 -14
- package/docs/interfaces/EncounterProvider.md +18 -14
- package/docs/interfaces/EncounterRole.md +17 -13
- package/docs/interfaces/EncounterType.md +17 -13
- package/docs/interfaces/ExtensionSlotBaseProps.md +3 -3
- package/docs/interfaces/ExtensionSlotProps.md +11 -11
- package/docs/interfaces/FeatureFlagDefinition.md +4 -4
- package/docs/interfaces/ImportMap.md +2 -2
- package/docs/interfaces/Location.md +19 -15
- package/docs/interfaces/NumericObservationProps.md +1 -1
- package/docs/interfaces/Obs.md +22 -18
- package/docs/interfaces/OpenWorkspace.md +24 -24
- package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
- package/docs/interfaces/OpenmrsResource.md +9 -0
- package/docs/interfaces/Order.md +26 -22
- package/docs/interfaces/Patient.md +8 -8
- package/docs/interfaces/PatientIdentifier.md +7 -7
- package/docs/interfaces/PatientIdentifierType.md +7 -7
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -1
- package/docs/interfaces/ResourceLoader.md +2 -2
- package/docs/interfaces/RetryOptions.md +4 -4
- 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 +6 -6
- package/docs/interfaces/UseServerFetchAllOptions.md +2 -2
- package/docs/interfaces/UseServerInfiniteOptions.md +2 -2
- package/docs/interfaces/UseServerPaginationOptions.md +2 -2
- package/docs/interfaces/Visit.md +1 -1
- package/docs/interfaces/VisitReturnType.md +2 -2
- package/docs/interfaces/WorkspaceDefinition2.md +4 -4
- package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
- package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
- package/docs/interfaces/WorkspaceRegistration.md +4 -0
- package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
- package/docs/type-aliases/CurrentPatient.md +1 -1
- package/docs/type-aliases/DateInput.md +1 -1
- package/docs/type-aliases/ExtensionDefinition.md +12 -12
- package/docs/type-aliases/FormatDateMode.md +1 -1
- package/docs/type-aliases/FormatDateOptions.md +10 -10
- package/docs/type-aliases/ModalDefinition.md +3 -3
- package/docs/type-aliases/NameUse.md +1 -1
- package/docs/type-aliases/OpenmrsRoutes.md +1 -1
- package/docs/type-aliases/PageDefinition.md +1 -1
- package/docs/type-aliases/SpaEnvironment.md +1 -1
- package/docs/type-aliases/UseOpenmrsSWROptions.md +1 -1
- package/docs/type-aliases/WorkspaceDefinition.md +14 -14
- package/docs/type-aliases/WorkspaceWindowState.md +1 -1
- package/docs/variables/useConnectedExtensions.md +2 -2
- package/docs/variables/useExtensionStore.md +9 -9
- package/package.json +20 -20
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ExtensionDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L181)
|
|
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/
|
|
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
|
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/
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L213)
|
|
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/
|
|
37
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:217](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L217)
|
|
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/
|
|
47
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:221](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L221)
|
|
48
48
|
|
|
49
49
|
Meta describes any properties that are passed down to the extension when it is loaded
|
|
50
50
|
|
|
@@ -58,7 +58,7 @@ 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/
|
|
61
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:185](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L185)
|
|
62
62
|
|
|
63
63
|
The name of this extension. This is used to refer to the extension in configuration.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ The name of this extension. This is used to refer to the extension in configurat
|
|
|
68
68
|
|
|
69
69
|
> `optional` **offline**: `boolean`
|
|
70
70
|
|
|
71
|
-
Defined in: packages/framework/esm-globals/
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L201)
|
|
72
72
|
|
|
73
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
74
|
|
|
@@ -78,7 +78,7 @@ Determines whether the component renders while the browser is not connected to t
|
|
|
78
78
|
|
|
79
79
|
> `optional` **online**: `boolean`
|
|
80
80
|
|
|
81
|
-
Defined in: packages/framework/esm-globals/
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:197](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L197)
|
|
82
82
|
|
|
83
83
|
Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ Determines whether the component renders while the browser is connected to the i
|
|
|
88
88
|
|
|
89
89
|
> `optional` **order**: `number`
|
|
90
90
|
|
|
91
|
-
Defined in: packages/framework/esm-globals/
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L205)
|
|
92
92
|
|
|
93
93
|
Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
|
|
94
94
|
|
|
@@ -98,7 +98,7 @@ Determines the order in which this component renders in its default extension sl
|
|
|
98
98
|
|
|
99
99
|
> `optional` **privileges**: `string` \| `string`[]
|
|
100
100
|
|
|
101
|
-
Defined in: packages/framework/esm-globals/
|
|
101
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:209](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L209)
|
|
102
102
|
|
|
103
103
|
The user must have ANY of these privileges to see this extension.
|
|
104
104
|
|
|
@@ -108,7 +108,7 @@ The user must have ANY of these privileges to see this extension.
|
|
|
108
108
|
|
|
109
109
|
> `optional` **slot**: `string`
|
|
110
110
|
|
|
111
|
-
Defined in: packages/framework/esm-globals/
|
|
111
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:189](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L189)
|
|
112
112
|
|
|
113
113
|
If supplied, the slot that this extension is rendered into by default.
|
|
114
114
|
|
|
@@ -118,6 +118,6 @@ If supplied, the slot that this extension is rendered into by default.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **slots**: `string`[]
|
|
120
120
|
|
|
121
|
-
Defined in: packages/framework/esm-globals/
|
|
121
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:193](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L193)
|
|
122
122
|
|
|
123
123
|
If supplied, the slots that this extension is rendered into by default.
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **FormatDateMode** = `"standard"` \| `"wide"`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-utils/
|
|
7
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L172)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **FormatDateOptions** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-utils/
|
|
7
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L174)
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:53
|
|
|
12
12
|
|
|
13
13
|
> `optional` **calendar**: `string`
|
|
14
14
|
|
|
15
|
-
Defined in: packages/framework/esm-utils/
|
|
15
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L178)
|
|
16
16
|
|
|
17
17
|
The calendar to use when formatting this date.
|
|
18
18
|
|
|
@@ -22,7 +22,7 @@ The calendar to use when formatting this date.
|
|
|
22
22
|
|
|
23
23
|
> **day**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: packages/framework/esm-utils/
|
|
25
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:194](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L194)
|
|
26
26
|
|
|
27
27
|
Whether to include the day number
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Whether to include the day number
|
|
|
32
32
|
|
|
33
33
|
> `optional` **locale**: `string`
|
|
34
34
|
|
|
35
|
-
Defined in: packages/framework/esm-utils/
|
|
35
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L182)
|
|
36
36
|
|
|
37
37
|
The locale to use when formatting this date
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ The locale to use when formatting this date
|
|
|
42
42
|
|
|
43
43
|
> **mode**: [`FormatDateMode`](FormatDateMode.md)
|
|
44
44
|
|
|
45
|
-
Defined in: packages/framework/esm-utils/
|
|
45
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:187](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L187)
|
|
46
46
|
|
|
47
47
|
- `standard`: "03 Feb 2022"
|
|
48
48
|
- `wide`: "03 — Feb — 2022"
|
|
@@ -53,7 +53,7 @@ Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:66
|
|
|
53
53
|
|
|
54
54
|
> **month**: `boolean`
|
|
55
55
|
|
|
56
|
-
Defined in: packages/framework/esm-utils/
|
|
56
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:196](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L196)
|
|
57
57
|
|
|
58
58
|
Whether to include the month number
|
|
59
59
|
|
|
@@ -63,7 +63,7 @@ Whether to include the month number
|
|
|
63
63
|
|
|
64
64
|
> **noToday**: `boolean`
|
|
65
65
|
|
|
66
|
-
Defined in: packages/framework/esm-utils/
|
|
66
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:207](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L207)
|
|
67
67
|
|
|
68
68
|
Disables the special handling of dates that are today. If false
|
|
69
69
|
(the default), then dates that are today will be formatted as "Today"
|
|
@@ -76,7 +76,7 @@ formatted the same as all other dates.
|
|
|
76
76
|
|
|
77
77
|
> `optional` **numberingSystem**: `string`
|
|
78
78
|
|
|
79
|
-
Defined in: packages/framework/esm-utils/
|
|
79
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L200)
|
|
80
80
|
|
|
81
81
|
The unicode numbering system to use
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ The unicode numbering system to use
|
|
|
86
86
|
|
|
87
87
|
> **time**: `true` \| `false` \| `"for today"`
|
|
88
88
|
|
|
89
|
-
Defined in: packages/framework/esm-utils/
|
|
89
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L192)
|
|
90
90
|
|
|
91
91
|
Whether the time should be included in the output always (`true`),
|
|
92
92
|
never (`false`), or only when the input date is today (`for today`).
|
|
@@ -97,6 +97,6 @@ never (`false`), or only when the input date is today (`for today`).
|
|
|
97
97
|
|
|
98
98
|
> **year**: `boolean`
|
|
99
99
|
|
|
100
|
-
Defined in: packages/framework/esm-utils/
|
|
100
|
+
Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L198)
|
|
101
101
|
|
|
102
102
|
Whether to include the year
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **ModalDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:233](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L233)
|
|
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/
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L241)
|
|
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/
|
|
27
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L237)
|
|
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/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:426](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L426)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:417](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L417)
|
|
8
8
|
|
|
9
9
|
This interfaces describes the format of the overall routes.json loaded by the app shell.
|
|
10
10
|
Basically, this is the same as the app routes, with each routes definition keyed by the app's name
|
|
@@ -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/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L120)
|
|
8
8
|
|
|
9
9
|
A definition of a page extracted from an app's routes.json
|
|
10
10
|
|
|
@@ -4,4 +4,4 @@
|
|
|
4
4
|
|
|
5
5
|
> **SpaEnvironment** = `"production"` \| `"development"` \| `"test"`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L75)
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:11](https:/
|
|
|
18
18
|
|
|
19
19
|
### fetchInit?
|
|
20
20
|
|
|
21
|
-
> `optional` **fetchInit**: `FetchConfig`
|
|
21
|
+
> `optional` **fetchInit**: [`FetchConfig`](../interfaces/FetchConfig.md)
|
|
22
22
|
|
|
23
23
|
Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L12)
|
|
24
24
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **WorkspaceDefinition** = `object`
|
|
6
6
|
|
|
7
|
-
Defined in: packages/framework/esm-globals/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:250](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L250)
|
|
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/
|
|
17
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:266](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L266)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:249
|
|
|
22
22
|
|
|
23
23
|
> `optional` **canMaximize**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: packages/framework/esm-globals/
|
|
25
|
+
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)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:250
|
|
|
30
30
|
|
|
31
31
|
> **component**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: packages/framework/esm-globals/
|
|
33
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:303](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L303)
|
|
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/
|
|
43
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:299](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L299)
|
|
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
|
|
@@ -50,10 +50,10 @@ at a time. For example,
|
|
|
50
50
|
|
|
51
51
|
```ts
|
|
52
52
|
{
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
53
|
+
* name: 'order-basket',
|
|
54
|
+
* type: 'order',
|
|
55
|
+
* groups: ['ward-patient']
|
|
56
|
+
* }
|
|
57
57
|
|
|
58
58
|
This means that the 'order-basket' workspace can be opened independently, or only
|
|
59
59
|
in the 'ward-patient'.
|
|
@@ -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/
|
|
71
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L254)
|
|
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/
|
|
81
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:277](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L277)
|
|
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/
|
|
91
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:259](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L259)
|
|
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/
|
|
102
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:265](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L265)
|
|
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/
|
|
114
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:273](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L273)
|
|
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/
|
|
7
|
+
Defined in: [packages/framework/esm-globals/src/types.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L245)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Variable: ~~useConnectedExtensions()~~
|
|
4
4
|
|
|
5
|
-
> `const` **useConnectedExtensions**: (`slotName`) => `ConnectedExtension`[]
|
|
5
|
+
> `const` **useConnectedExtensions**: (`slotName`) => [`ConnectedExtension`](../interfaces/ConnectedExtension.md)[]
|
|
6
6
|
|
|
7
7
|
Defined in: [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L10)
|
|
8
8
|
|
|
@@ -18,7 +18,7 @@ The name of the slot to get the assigned extensions for.
|
|
|
18
18
|
|
|
19
19
|
## Returns
|
|
20
20
|
|
|
21
|
-
`ConnectedExtension`[]
|
|
21
|
+
[`ConnectedExtension`](../interfaces/ConnectedExtension.md)[]
|
|
22
22
|
|
|
23
23
|
## Deprecated
|
|
24
24
|
|
|
@@ -2,27 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
# Variable: useExtensionStore()
|
|
4
4
|
|
|
5
|
-
> `const` **useExtensionStore**: \{(): `ExtensionStore
|
|
5
|
+
> `const` **useExtensionStore**: \{(): [`ExtensionStore`](../interfaces/ExtensionStore.md); \<`A`\>(`actions`): [`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>; \<`A`\>(`actions?`): [`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>; \}
|
|
6
6
|
|
|
7
7
|
Defined in: [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
|
|
8
8
|
|
|
9
9
|
## Call Signature
|
|
10
10
|
|
|
11
|
-
> (): `ExtensionStore`
|
|
11
|
+
> (): [`ExtensionStore`](../interfaces/ExtensionStore.md)
|
|
12
12
|
|
|
13
13
|
### Returns
|
|
14
14
|
|
|
15
|
-
`ExtensionStore`
|
|
15
|
+
[`ExtensionStore`](../interfaces/ExtensionStore.md)
|
|
16
16
|
|
|
17
17
|
## Call Signature
|
|
18
18
|
|
|
19
|
-
> \<`A`\>(`actions`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)
|
|
19
|
+
> \<`A`\>(`actions`): [`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>
|
|
20
20
|
|
|
21
21
|
### Type Parameters
|
|
22
22
|
|
|
23
23
|
#### A
|
|
24
24
|
|
|
25
|
-
`A` *extends* [`Actions`](../type-aliases/Actions.md)
|
|
25
|
+
`A` *extends* [`Actions`](../type-aliases/Actions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>
|
|
26
26
|
|
|
27
27
|
### Parameters
|
|
28
28
|
|
|
@@ -32,17 +32,17 @@ Defined in: [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](http
|
|
|
32
32
|
|
|
33
33
|
### Returns
|
|
34
34
|
|
|
35
|
-
`ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)
|
|
35
|
+
[`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>
|
|
36
36
|
|
|
37
37
|
## Call Signature
|
|
38
38
|
|
|
39
|
-
> \<`A`\>(`actions?`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)
|
|
39
|
+
> \<`A`\>(`actions?`): [`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>
|
|
40
40
|
|
|
41
41
|
### Type Parameters
|
|
42
42
|
|
|
43
43
|
#### A
|
|
44
44
|
|
|
45
|
-
`A` *extends* [`Actions`](../type-aliases/Actions.md)
|
|
45
|
+
`A` *extends* [`Actions`](../type-aliases/Actions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>
|
|
46
46
|
|
|
47
47
|
### Parameters
|
|
48
48
|
|
|
@@ -52,4 +52,4 @@ Defined in: [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](http
|
|
|
52
52
|
|
|
53
53
|
### Returns
|
|
54
54
|
|
|
55
|
-
`ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)
|
|
55
|
+
[`ExtensionStore`](../interfaces/ExtensionStore.md) & [`BoundActions`](../type-aliases/BoundActions.md)\<[`ExtensionStore`](../interfaces/ExtensionStore.md), `A`\>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "9.0.3-pre.
|
|
3
|
+
"version": "9.0.3-pre.4166",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -59,24 +59,24 @@
|
|
|
59
59
|
"access": "public"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@openmrs/esm-api": "9.0.3-pre.
|
|
63
|
-
"@openmrs/esm-config": "9.0.3-pre.
|
|
64
|
-
"@openmrs/esm-context": "9.0.3-pre.
|
|
65
|
-
"@openmrs/esm-dynamic-loading": "9.0.3-pre.
|
|
66
|
-
"@openmrs/esm-emr-api": "9.0.3-pre.
|
|
67
|
-
"@openmrs/esm-error-handling": "9.0.3-pre.
|
|
68
|
-
"@openmrs/esm-expression-evaluator": "9.0.3-pre.
|
|
69
|
-
"@openmrs/esm-extensions": "9.0.3-pre.
|
|
70
|
-
"@openmrs/esm-feature-flags": "9.0.3-pre.
|
|
71
|
-
"@openmrs/esm-globals": "9.0.3-pre.
|
|
72
|
-
"@openmrs/esm-navigation": "9.0.3-pre.
|
|
73
|
-
"@openmrs/esm-offline": "9.0.3-pre.
|
|
74
|
-
"@openmrs/esm-react-utils": "9.0.3-pre.
|
|
75
|
-
"@openmrs/esm-routes": "9.0.3-pre.
|
|
76
|
-
"@openmrs/esm-state": "9.0.3-pre.
|
|
77
|
-
"@openmrs/esm-styleguide": "9.0.3-pre.
|
|
78
|
-
"@openmrs/esm-translations": "9.0.3-pre.
|
|
79
|
-
"@openmrs/esm-utils": "9.0.3-pre.
|
|
62
|
+
"@openmrs/esm-api": "9.0.3-pre.4166",
|
|
63
|
+
"@openmrs/esm-config": "9.0.3-pre.4166",
|
|
64
|
+
"@openmrs/esm-context": "9.0.3-pre.4166",
|
|
65
|
+
"@openmrs/esm-dynamic-loading": "9.0.3-pre.4166",
|
|
66
|
+
"@openmrs/esm-emr-api": "9.0.3-pre.4166",
|
|
67
|
+
"@openmrs/esm-error-handling": "9.0.3-pre.4166",
|
|
68
|
+
"@openmrs/esm-expression-evaluator": "9.0.3-pre.4166",
|
|
69
|
+
"@openmrs/esm-extensions": "9.0.3-pre.4166",
|
|
70
|
+
"@openmrs/esm-feature-flags": "9.0.3-pre.4166",
|
|
71
|
+
"@openmrs/esm-globals": "9.0.3-pre.4166",
|
|
72
|
+
"@openmrs/esm-navigation": "9.0.3-pre.4166",
|
|
73
|
+
"@openmrs/esm-offline": "9.0.3-pre.4166",
|
|
74
|
+
"@openmrs/esm-react-utils": "9.0.3-pre.4166",
|
|
75
|
+
"@openmrs/esm-routes": "9.0.3-pre.4166",
|
|
76
|
+
"@openmrs/esm-state": "9.0.3-pre.4166",
|
|
77
|
+
"@openmrs/esm-styleguide": "9.0.3-pre.4166",
|
|
78
|
+
"@openmrs/esm-translations": "9.0.3-pre.4166",
|
|
79
|
+
"@openmrs/esm-utils": "9.0.3-pre.4166"
|
|
80
80
|
},
|
|
81
81
|
"peerDependencies": {
|
|
82
82
|
"dayjs": "1.x",
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"swr": "2.x"
|
|
90
90
|
},
|
|
91
91
|
"devDependencies": {
|
|
92
|
-
"@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.
|
|
92
|
+
"@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4166",
|
|
93
93
|
"@swc/cli": "0.8.0",
|
|
94
94
|
"@swc/core": "1.15.18",
|
|
95
95
|
"@vitest/coverage-v8": "^4.0.18",
|