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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/API.md +7 -0
  3. package/docs/functions/age.md +6 -6
  4. package/docs/functions/calculateInterpretation.md +2 -2
  5. package/docs/functions/canAccessStorage.md +4 -4
  6. package/docs/functions/convertToLocaleCalendar.md +1 -1
  7. package/docs/functions/createAttachment.md +2 -2
  8. package/docs/functions/createErrorHandler.md +1 -1
  9. package/docs/functions/deleteAttachmentPermanently.md +2 -2
  10. package/docs/functions/dispatchNotificationShown.md +1 -1
  11. package/docs/functions/dispatchPrecacheStaticDependencies.md +4 -4
  12. package/docs/functions/displayName.md +1 -1
  13. package/docs/functions/fetchCurrentPatient.md +1 -1
  14. package/docs/functions/formatDate.md +1 -1
  15. package/docs/functions/formatDatetime.md +1 -1
  16. package/docs/functions/formatDuration.md +1 -1
  17. package/docs/functions/formatPartialDate.md +4 -4
  18. package/docs/functions/formatPatientName.md +1 -1
  19. package/docs/functions/formatTime.md +1 -1
  20. package/docs/functions/formattedName.md +1 -1
  21. package/docs/functions/getAttachmentByUuid.md +2 -2
  22. package/docs/functions/getAttachments.md +2 -2
  23. package/docs/functions/getCoreTranslation.md +1 -1
  24. package/docs/functions/getDefaultCalendar.md +1 -1
  25. package/docs/functions/getDefaultsFromConfigSchema.md +1 -1
  26. package/docs/functions/getLocale.md +1 -1
  27. package/docs/functions/getPatientName.md +1 -1
  28. package/docs/functions/getVisitsForPatient.md +2 -2
  29. package/docs/functions/isOmrsDateStrict.md +1 -1
  30. package/docs/functions/isOmrsDateToday.md +1 -1
  31. package/docs/functions/isOnline.md +1 -1
  32. package/docs/functions/isVersionSatisfied.md +1 -1
  33. package/docs/functions/normalizeInterpretation.md +3 -3
  34. package/docs/functions/parseDate.md +1 -1
  35. package/docs/functions/registerDefaultCalendar.md +1 -1
  36. package/docs/functions/reportError.md +1 -1
  37. package/docs/functions/retry.md +4 -4
  38. package/docs/functions/saveVisit.md +2 -2
  39. package/docs/functions/selectPreferredName.md +1 -1
  40. package/docs/functions/shallowEqual.md +1 -1
  41. package/docs/functions/subscribeActionableNotificationShown.md +1 -1
  42. package/docs/functions/subscribeConnectivity.md +1 -1
  43. package/docs/functions/subscribeConnectivityChanged.md +1 -1
  44. package/docs/functions/subscribeNotificationShown.md +1 -1
  45. package/docs/functions/subscribePrecacheStaticDependencies.md +1 -1
  46. package/docs/functions/subscribeSnackbarShown.md +1 -1
  47. package/docs/functions/subscribeToastShown.md +1 -1
  48. package/docs/functions/toDateObjectStrict.md +1 -1
  49. package/docs/functions/toOmrsIsoString.md +4 -4
  50. package/docs/functions/updateVisit.md +2 -2
  51. package/docs/functions/useAssignedExtensions.md +2 -2
  52. package/docs/functions/useAttachments.md +2 -2
  53. package/docs/functions/useEmrConfiguration.md +1 -1
  54. package/docs/functions/useExtensionSlotMeta.md +1 -1
  55. package/docs/functions/useExtensionSlotStore.md +2 -2
  56. package/docs/functions/useFhirPagination.md +1 -1
  57. package/docs/functions/useLeftNav.md +1 -1
  58. package/docs/functions/useLeftNavStore.md +2 -2
  59. package/docs/functions/useLocations.md +2 -2
  60. package/docs/functions/useOpenmrsPagination.md +1 -1
  61. package/docs/functions/useOpenmrsSWR.md +2 -2
  62. package/docs/functions/useSession.md +2 -2
  63. package/docs/functions/useVisitContextStore.md +2 -2
  64. package/docs/functions/useVisitTypes.md +2 -2
  65. package/docs/interfaces/AssignedExtension.md +1 -1
  66. package/docs/interfaces/ConfigurableLinkProps.md +1 -1
  67. package/docs/interfaces/ConnectedExtension.md +1 -1
  68. package/docs/interfaces/ConnectivityChangedEvent.md +2 -2
  69. package/docs/interfaces/Diagnosis.md +20 -16
  70. package/docs/interfaces/Drug.md +17 -13
  71. package/docs/interfaces/EmrApiConfigurationResponse.md +51 -51
  72. package/docs/interfaces/Encounter.md +18 -14
  73. package/docs/interfaces/EncounterProvider.md +18 -14
  74. package/docs/interfaces/EncounterRole.md +17 -13
  75. package/docs/interfaces/EncounterType.md +17 -13
  76. package/docs/interfaces/ExtensionSlotBaseProps.md +3 -3
  77. package/docs/interfaces/ExtensionSlotProps.md +11 -11
  78. package/docs/interfaces/FeatureFlagDefinition.md +4 -4
  79. package/docs/interfaces/ImportMap.md +2 -2
  80. package/docs/interfaces/Location.md +19 -15
  81. package/docs/interfaces/NumericObservationProps.md +1 -1
  82. package/docs/interfaces/Obs.md +22 -18
  83. package/docs/interfaces/OpenWorkspace.md +24 -24
  84. package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
  85. package/docs/interfaces/OpenmrsResource.md +9 -0
  86. package/docs/interfaces/Order.md +26 -22
  87. package/docs/interfaces/Patient.md +8 -8
  88. package/docs/interfaces/PatientIdentifier.md +7 -7
  89. package/docs/interfaces/PatientIdentifierType.md +7 -7
  90. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -1
  91. package/docs/interfaces/ResourceLoader.md +2 -2
  92. package/docs/interfaces/RetryOptions.md +4 -4
  93. package/docs/interfaces/ShowActionableNotificationEvent.md +7 -7
  94. package/docs/interfaces/ShowNotificationEvent.md +6 -6
  95. package/docs/interfaces/ShowSnackbarEvent.md +9 -9
  96. package/docs/interfaces/ShowToastEvent.md +6 -6
  97. package/docs/interfaces/SpaConfig.md +6 -6
  98. package/docs/interfaces/UseServerFetchAllOptions.md +2 -2
  99. package/docs/interfaces/UseServerInfiniteOptions.md +2 -2
  100. package/docs/interfaces/UseServerPaginationOptions.md +2 -2
  101. package/docs/interfaces/Visit.md +1 -1
  102. package/docs/interfaces/VisitReturnType.md +2 -2
  103. package/docs/interfaces/WorkspaceDefinition2.md +4 -4
  104. package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
  105. package/docs/interfaces/WorkspaceGroupDefinition2.md +6 -6
  106. package/docs/interfaces/WorkspaceRegistration.md +4 -0
  107. package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
  108. package/docs/type-aliases/CurrentPatient.md +1 -1
  109. package/docs/type-aliases/DateInput.md +1 -1
  110. package/docs/type-aliases/ExtensionDefinition.md +12 -12
  111. package/docs/type-aliases/FormatDateMode.md +1 -1
  112. package/docs/type-aliases/FormatDateOptions.md +10 -10
  113. package/docs/type-aliases/ModalDefinition.md +3 -3
  114. package/docs/type-aliases/NameUse.md +1 -1
  115. package/docs/type-aliases/OpenmrsRoutes.md +1 -1
  116. package/docs/type-aliases/PageDefinition.md +1 -1
  117. package/docs/type-aliases/SpaEnvironment.md +1 -1
  118. package/docs/type-aliases/UseOpenmrsSWROptions.md +1 -1
  119. package/docs/type-aliases/WorkspaceDefinition.md +14 -14
  120. package/docs/type-aliases/WorkspaceWindowState.md +1 -1
  121. package/docs/variables/useConnectedExtensions.md +2 -2
  122. package/docs/variables/useExtensionStore.md +9 -9
  123. package/package.json +20 -20
package/docs/interfaces/ResourceLoader.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ResourceLoader()\<T\>
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:386
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:419](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L419)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:386
12
12
 
13
13
  > **ResourceLoader**(): `Promise`\<`T`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:387
15
+ Defined in: [packages/framework/esm-globals/src/types.ts:420](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L420)
16
16
 
17
17
  ## Returns
18
18
 
package/docs/interfaces/RetryOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RetryOptions
4
4
 
5
- Defined in: packages/framework/esm-utils/dist/retry.d.ts:5
5
+ Defined in: [packages/framework/esm-utils/src/retry.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L6)
6
6
 
7
7
  Options for configuring the behavior of the [retry](../functions/retry.md) function.
8
8
 
@@ -12,7 +12,7 @@ Options for configuring the behavior of the [retry](../functions/retry.md) funct
12
12
 
13
13
  > `optional` **getDelay**(`attempt`): `number`
14
14
 
15
- Defined in: packages/framework/esm-utils/dist/retry.d.ts:17
15
+ Defined in: [packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L18)
16
16
 
17
17
  Calculates the next delay (in milliseconds) before a retry attempt.
18
18
  Returning a value for the inital attempt (`0`) delays the initial function invocation.
@@ -35,7 +35,7 @@ The current (zero-based) retry attempt. `0` indicates the initial attempt.
35
35
 
36
36
  > `optional` **onError**(`e`, `attempt`): `void`
37
37
 
38
- Defined in: packages/framework/esm-utils/dist/retry.d.ts:24
38
+ Defined in: [packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L25)
39
39
 
40
40
  Called when invoking the function resulted in an error.
41
41
  Allows running side-effects on errors, e.g. logging.
@@ -64,7 +64,7 @@ The current (zero-based) retry attempt. `0` indicates the initial attempt.
64
64
 
65
65
  > `optional` **shouldRetry**(`attempt`): `any`
66
66
 
67
- Defined in: packages/framework/esm-utils/dist/retry.d.ts:11
67
+ Defined in: [packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L12)
68
68
 
69
69
  Determines whether the retry function should retry executing the function after it failed
70
70
  with an error on the current attempt.
package/docs/interfaces/ShowActionableNotificationEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ShowActionableNotificationEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:23
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L54)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:23
10
10
 
11
11
  > **actionButtonLabel**: `any`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/events.d.ts:27
13
+ Defined in: [packages/framework/esm-globals/src/events.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L58)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:27
18
18
 
19
19
  > `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/events.d.ts:25
21
+ Defined in: [packages/framework/esm-globals/src/events.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L56)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:25
26
26
 
27
27
  > **onActionButtonClick**: () => `void`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/events.d.ts:28
29
+ Defined in: [packages/framework/esm-globals/src/events.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L59)
30
30
 
31
31
  #### Returns
32
32
 
@@ -38,7 +38,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:28
38
38
 
39
39
  > `optional` **progressActionLabel**: `string`
40
40
 
41
- Defined in: packages/framework/esm-globals/dist/events.d.ts:29
41
+ Defined in: [packages/framework/esm-globals/src/events.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L60)
42
42
 
43
43
  ***
44
44
 
@@ -46,7 +46,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:29
46
46
 
47
47
  > **subtitle**: `any`
48
48
 
49
- Defined in: packages/framework/esm-globals/dist/events.d.ts:24
49
+ Defined in: [packages/framework/esm-globals/src/events.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L55)
50
50
 
51
51
  ***
52
52
 
@@ -54,4 +54,4 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:24
54
54
 
55
55
  > `optional` **title**: `string`
56
56
 
57
- Defined in: packages/framework/esm-globals/dist/events.d.ts:26
57
+ Defined in: [packages/framework/esm-globals/src/events.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L57)
package/docs/interfaces/ShowNotificationEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ShowNotificationEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:16
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L46)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:16
10
10
 
11
11
  > `optional` **action**: `any`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/events.d.ts:20
13
+ Defined in: [packages/framework/esm-globals/src/events.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L50)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:20
18
18
 
19
19
  > **description**: `any`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/events.d.ts:17
21
+ Defined in: [packages/framework/esm-globals/src/events.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L47)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:17
26
26
 
27
27
  > `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/events.d.ts:18
29
+ Defined in: [packages/framework/esm-globals/src/events.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L48)
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:18
34
34
 
35
35
  > `optional` **millis**: `number`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/events.d.ts:21
37
+ Defined in: [packages/framework/esm-globals/src/events.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L51)
38
38
 
39
39
  ***
40
40
 
@@ -42,4 +42,4 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:21
42
42
 
43
43
  > `optional` **title**: `string`
44
44
 
45
- Defined in: packages/framework/esm-globals/dist/events.d.ts:19
45
+ Defined in: [packages/framework/esm-globals/src/events.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L49)
package/docs/interfaces/ShowSnackbarEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ShowSnackbarEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:40
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L73)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:40
10
10
 
11
11
  > `optional` **actionButtonLabel**: `any`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/events.d.ts:44
13
+ Defined in: [packages/framework/esm-globals/src/events.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L77)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:44
18
18
 
19
19
  > `optional` **isLowContrast**: `boolean`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/events.d.ts:47
21
+ Defined in: [packages/framework/esm-globals/src/events.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L80)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:47
26
26
 
27
27
  > `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/events.d.ts:42
29
+ Defined in: [packages/framework/esm-globals/src/events.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L75)
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:42
34
34
 
35
35
  > `optional` **onActionButtonClick**: () => `void`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/events.d.ts:45
37
+ Defined in: [packages/framework/esm-globals/src/events.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L78)
38
38
 
39
39
  #### Returns
40
40
 
@@ -46,7 +46,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:45
46
46
 
47
47
  > `optional` **progressActionLabel**: `string`
48
48
 
49
- Defined in: packages/framework/esm-globals/dist/events.d.ts:46
49
+ Defined in: [packages/framework/esm-globals/src/events.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L79)
50
50
 
51
51
  ***
52
52
 
@@ -54,7 +54,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:46
54
54
 
55
55
  > `optional` **subtitle**: `any`
56
56
 
57
- Defined in: packages/framework/esm-globals/dist/events.d.ts:41
57
+ Defined in: [packages/framework/esm-globals/src/events.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L74)
58
58
 
59
59
  ***
60
60
 
@@ -62,7 +62,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:41
62
62
 
63
63
  > `optional` **timeoutInMs**: `number`
64
64
 
65
- Defined in: packages/framework/esm-globals/dist/events.d.ts:48
65
+ Defined in: [packages/framework/esm-globals/src/events.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L81)
66
66
 
67
67
  ***
68
68
 
@@ -70,4 +70,4 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:48
70
70
 
71
71
  > **title**: `string`
72
72
 
73
- Defined in: packages/framework/esm-globals/dist/events.d.ts:43
73
+ Defined in: [packages/framework/esm-globals/src/events.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L76)
package/docs/interfaces/ShowToastEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ShowToastEvent
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/events.d.ts:32
5
+ Defined in: [packages/framework/esm-globals/src/events.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L64)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:32
10
10
 
11
11
  > `optional` **actionButtonLabel**: `any`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/events.d.ts:36
13
+ Defined in: [packages/framework/esm-globals/src/events.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L68)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:36
18
18
 
19
19
  > **description**: `any`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/events.d.ts:33
21
+ Defined in: [packages/framework/esm-globals/src/events.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L65)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:33
26
26
 
27
27
  > `optional` **kind**: `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/events.d.ts:34
29
+ Defined in: [packages/framework/esm-globals/src/events.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L66)
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:34
34
34
 
35
35
  > `optional` **onActionButtonClick**: () => `void`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/events.d.ts:37
37
+ Defined in: [packages/framework/esm-globals/src/events.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L69)
38
38
 
39
39
  #### Returns
40
40
 
@@ -46,4 +46,4 @@ Defined in: packages/framework/esm-globals/dist/events.d.ts:37
46
46
 
47
47
  > `optional` **title**: `string`
48
48
 
49
- Defined in: packages/framework/esm-globals/dist/events.d.ts:35
49
+ Defined in: [packages/framework/esm-globals/src/events.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L67)
package/docs/interfaces/SpaConfig.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SpaConfig
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:79
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L84)
6
6
 
7
7
  The configuration passed to the app shell initialization function
8
8
 
@@ -12,7 +12,7 @@ The configuration passed to the app shell initialization function
12
12
 
13
13
  > **apiUrl**: `string`
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:83
15
+ Defined in: [packages/framework/esm-globals/src/types.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L88)
16
16
 
17
17
  The base path or URL for the OpenMRS API / endpoints.
18
18
 
@@ -22,7 +22,7 @@ The base path or URL for the OpenMRS API / endpoints.
22
22
 
23
23
  > `optional` **configUrls**: `string`[]
24
24
 
25
- Defined in: packages/framework/esm-globals/dist/types.d.ts:96
25
+ Defined in: [packages/framework/esm-globals/src/types.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L101)
26
26
 
27
27
  URLs of configurations to load in the system.
28
28
 
@@ -32,7 +32,7 @@ URLs of configurations to load in the system.
32
32
 
33
33
  > `optional` **env**: [`SpaEnvironment`](../type-aliases/SpaEnvironment.md)
34
34
 
35
- Defined in: packages/framework/esm-globals/dist/types.d.ts:92
35
+ 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)
36
36
 
37
37
  The environment to use.
38
38
 
@@ -48,7 +48,7 @@ production
48
48
 
49
49
  > `optional` **offline**: `boolean`
50
50
 
51
- Defined in: packages/framework/esm-globals/dist/types.d.ts:101
51
+ Defined in: [packages/framework/esm-globals/src/types.ts:106](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L106)
52
52
 
53
53
  Defines if offline should be supported by installing a service worker.
54
54
 
@@ -64,6 +64,6 @@ true
64
64
 
65
65
  > **spaPath**: `string`
66
66
 
67
- Defined in: packages/framework/esm-globals/dist/types.d.ts:87
67
+ Defined in: [packages/framework/esm-globals/src/types.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L92)
68
68
 
69
69
  The base path for the SPA root path.
package/docs/interfaces/UseServerFetchAllOptions.md CHANGED
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:14](ht
18
18
 
19
19
  ### fetcher()?
20
20
 
21
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
21
+ > `optional` **fetcher**: (`key`) => `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
22
22
 
23
23
  Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
24
24
 
@@ -32,7 +32,7 @@ The fetcher to use. Defaults to openmrsFetch
32
32
 
33
33
  #### Returns
34
34
 
35
- `Promise`\<`FetchResponse`\<`R`\>\>
35
+ `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
36
36
 
37
37
  #### Inherited from
38
38
 
package/docs/interfaces/UseServerInfiniteOptions.md CHANGED
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:14](ht
18
18
 
19
19
  ### fetcher()?
20
20
 
21
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
21
+ > `optional` **fetcher**: (`key`) => `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
22
22
 
23
23
  Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
24
24
 
@@ -32,7 +32,7 @@ The fetcher to use. Defaults to openmrsFetch
32
32
 
33
33
  #### Returns
34
34
 
35
- `Promise`\<`FetchResponse`\<`R`\>\>
35
+ `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
36
36
 
37
37
  ***
38
38
 
package/docs/interfaces/UseServerPaginationOptions.md CHANGED
@@ -14,7 +14,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:13](
14
14
 
15
15
  ### fetcher()?
16
16
 
17
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
17
+ > `optional` **fetcher**: (`key`) => `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
18
18
 
19
19
  Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L22)
20
20
 
@@ -28,7 +28,7 @@ The fetcher to use. Defaults to openmrsFetch
28
28
 
29
29
  #### Returns
30
30
 
31
- `Promise`\<`FetchResponse`\<`R`\>\>
31
+ `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
32
32
 
33
33
  ***
34
34
 
package/docs/interfaces/Visit.md CHANGED
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-emr-api/src/types/visit-resource.ts:20](http
12
12
 
13
13
  ### attributes?
14
14
 
15
- > `optional` **attributes**: `OpenmrsResource`[]
15
+ > `optional` **attributes**: [`OpenmrsResource`](OpenmrsResource.md)[]
16
16
 
17
17
  Defined in: [packages/framework/esm-emr-api/src/types/visit-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/visit-resource.ts#L29)
18
18
 
package/docs/interfaces/VisitReturnType.md CHANGED
@@ -8,7 +8,7 @@ Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:12](https://gith
8
8
 
9
9
  ### activeVisit
10
10
 
11
- > **activeVisit**: `null` \| `Visit`
11
+ > **activeVisit**: `null` \| [`Visit`](Visit.md)
12
12
 
13
13
  Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L16)
14
14
 
@@ -16,7 +16,7 @@ Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:16](https://gith
16
16
 
17
17
  ### currentVisit
18
18
 
19
- > **currentVisit**: `null` \| `Visit`
19
+ > **currentVisit**: `null` \| [`Visit`](Visit.md)
20
20
 
21
21
  Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L17)
22
22
 
package/docs/interfaces/WorkspaceDefinition2.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceDefinition2
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:330
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:354](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L354)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:330
10
10
 
11
11
  > **component**: `string`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:332
13
+ Defined in: [packages/framework/esm-globals/src/types.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L356)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:332
18
18
 
19
19
  > **name**: `string`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/types.d.ts:331
21
+ Defined in: [packages/framework/esm-globals/src/types.ts:355](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L355)
22
22
 
23
23
  ***
24
24
 
@@ -26,4 +26,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:331
26
26
 
27
27
  > **window**: `string`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/types.d.ts:333
29
+ Defined in: [packages/framework/esm-globals/src/types.ts:357](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L357)
package/docs/interfaces/WorkspaceGroupDefinition.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceGroupDefinition
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:287
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:306](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L306)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:287
10
10
 
11
11
  > `optional` **members**: `string`[]
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:295
13
+ 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)
14
14
 
15
15
  List of workspace names which are part of the workspace group.
16
16
 
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
20
20
 
21
21
  > **name**: `string`
22
22
 
23
- Defined in: packages/framework/esm-globals/dist/types.d.ts:291
23
+ 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)
24
24
 
25
25
  Name of the workspace group. This is used to launch the workspace group
package/docs/interfaces/WorkspaceGroupDefinition2.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceGroupDefinition2
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:297
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:317](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L317)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:297
10
10
 
11
11
  > `optional` **closeable**: `boolean`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:299
13
+ Defined in: [packages/framework/esm-globals/src/types.ts:319](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L319)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:299
18
18
 
19
19
  > **name**: `string`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/types.d.ts:298
21
+ Defined in: [packages/framework/esm-globals/src/types.ts:318](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L318)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:298
26
26
 
27
27
  > `optional` **overlay**: `boolean`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/types.d.ts:300
29
+ Defined in: [packages/framework/esm-globals/src/types.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L320)
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:300
34
34
 
35
35
  > `optional` **persistence**: `"app-wide"` \| `"closable"`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/types.d.ts:310
37
+ Defined in: [packages/framework/esm-globals/src/types.ts:331](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L331)
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/dist/types.d.ts:320
53
+ Defined in: [packages/framework/esm-globals/src/types.ts:342](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L342)
54
54
 
55
55
  URL pattern that defines the scope where workspaces in this group should persist.
56
56
  - If not defined: workspaces close only when navigating to a different app
package/docs/interfaces/WorkspaceRegistration.md CHANGED
@@ -6,6 +6,10 @@ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:9](https://gith
6
6
 
7
7
  See [[WorkspaceDefinition]] for more information about these properties
8
8
 
9
+ ## Extended by
10
+
11
+ - [`OpenWorkspace`](OpenWorkspace.md)
12
+
9
13
  ## Properties
10
14
 
11
15
  ### canHide
package/docs/interfaces/WorkspaceWindowDefinition2.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceWindowDefinition2
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:322
5
+ Defined in: [packages/framework/esm-globals/src/types.ts:345](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L345)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:322
10
10
 
11
11
  > `optional` **canMaximize**: `boolean`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:325
13
+ Defined in: [packages/framework/esm-globals/src/types.ts:348](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L348)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:325
18
18
 
19
19
  > **group**: `string`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/types.d.ts:326
21
+ Defined in: [packages/framework/esm-globals/src/types.ts:349](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L349)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:326
26
26
 
27
27
  > `optional` **icon**: `string`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/types.d.ts:324
29
+ Defined in: [packages/framework/esm-globals/src/types.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L347)
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:324
34
34
 
35
35
  > **name**: `string`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/types.d.ts:323
37
+ Defined in: [packages/framework/esm-globals/src/types.ts:346](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L346)
38
38
 
39
39
  ***
40
40
 
@@ -42,7 +42,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:323
42
42
 
43
43
  > `optional` **order**: `number`
44
44
 
45
- Defined in: packages/framework/esm-globals/dist/types.d.ts:327
45
+ Defined in: [packages/framework/esm-globals/src/types.ts:350](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L350)
46
46
 
47
47
  ***
48
48
 
@@ -50,4 +50,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:327
50
50
 
51
51
  > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
52
52
 
53
- Defined in: packages/framework/esm-globals/dist/types.d.ts:328
53
+ Defined in: [packages/framework/esm-globals/src/types.ts:351](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L351)
package/docs/type-aliases/CurrentPatient.md CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  # Type Alias: CurrentPatient
4
4
 
5
- > **CurrentPatient** = `fhir.Patient` \| `FetchResponse`\<`fhir.Patient`\>
5
+ > **CurrentPatient** = `fhir.Patient` \| [`FetchResponse`](../interfaces/FetchResponse.md)\<`fhir.Patient`\>
6
6
 
7
7
  Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L5)
package/docs/type-aliases/DateInput.md CHANGED
@@ -4,4 +4,4 @@
4
4
 
5
5
  > **DateInput** = `string` \| `number` \| `Date`
6
6
 
7
- Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:7
7
+ Defined in: [packages/framework/esm-utils/src/dates/date-util.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/dates/date-util.ts#L27)