@openmrs/esm-framework 4.0.0-pre.1 → 4.0.1-pre.208

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 (91) hide show
  1. package/.turbo/turbo-build.log +23 -119
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -22
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +330 -774
  6. package/docs/classes/OpenmrsFetchError.md +4 -10
  7. package/docs/enums/Type.md +20 -20
  8. package/docs/enums/VisitMode.md +8 -8
  9. package/docs/enums/VisitStatus.md +6 -6
  10. package/docs/interfaces/AssignedExtension.md +7 -9
  11. package/docs/interfaces/BreadcrumbRegistration.md +2 -2
  12. package/docs/interfaces/BreadcrumbSettings.md +4 -22
  13. package/docs/interfaces/CancelLoading.md +1 -1
  14. package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
  15. package/docs/interfaces/ComponentDefinition.md +7 -19
  16. package/docs/interfaces/Config.md +3 -17
  17. package/docs/interfaces/ConfigObject.md +14 -17
  18. package/docs/interfaces/ConfigSchema.md +3 -3
  19. package/docs/interfaces/ConfigurableLinkProps.md +2 -2
  20. package/docs/interfaces/ConnectedExtension.md +4 -6
  21. package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
  22. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  23. package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
  24. package/docs/interfaces/DynamicOfflineData.md +5 -20
  25. package/docs/interfaces/DynamicOfflineDataHandler.md +9 -26
  26. package/docs/interfaces/DynamicOfflineDataSyncState.md +5 -17
  27. package/docs/interfaces/ErrorStateProps.md +2 -2
  28. package/docs/interfaces/ExtensionData.md +3 -3
  29. package/docs/interfaces/ExtensionDefinition.md +13 -37
  30. package/docs/interfaces/ExtensionProps.md +2 -2
  31. package/docs/interfaces/ExtensionRegistration.md +18 -7
  32. package/docs/interfaces/ExtensionSlotBaseProps.md +15 -4
  33. package/docs/interfaces/ExtensionSlotConfig.md +4 -4
  34. package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
  35. package/docs/interfaces/ExtensionSlotState.md +2 -2
  36. package/docs/interfaces/ExtensionStore.md +1 -1
  37. package/docs/interfaces/FHIRCode.md +3 -3
  38. package/docs/interfaces/FHIRRequestObj.md +3 -3
  39. package/docs/interfaces/FHIRRequestOptions.md +41 -0
  40. package/docs/interfaces/FHIRResource.md +1 -1
  41. package/docs/interfaces/FetchResponse.md +1 -1
  42. package/docs/interfaces/FetchResponseJson.md +7 -0
  43. package/docs/interfaces/ImportMap.md +1 -1
  44. package/docs/interfaces/Lifecycle.md +4 -4
  45. package/docs/interfaces/Location.md +3 -3
  46. package/docs/interfaces/LoggedInUser.md +11 -11
  47. package/docs/interfaces/LoggedInUserFetchResponse.md +1 -1
  48. package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
  49. package/docs/interfaces/NavigateOptions.md +2 -2
  50. package/docs/interfaces/NewVisitPayload.md +6 -6
  51. package/docs/interfaces/NotificationDescriptor.md +6 -6
  52. package/docs/interfaces/OfflineModeResult.md +3 -3
  53. package/docs/interfaces/OfflinePatientArgs.md +2 -4
  54. package/docs/interfaces/OfflinePatientDataSyncHandler.md +2 -4
  55. package/docs/interfaces/OfflinePatientDataSyncState.md +6 -8
  56. package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -4
  57. package/docs/interfaces/OldExtensionSlotBaseProps.md +65 -0
  58. package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
  59. package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
  60. package/docs/interfaces/OnlyThePatient.md +1 -1
  61. package/docs/interfaces/OpenmrsResource.md +2 -2
  62. package/docs/interfaces/PageDefinition.md +9 -25
  63. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  64. package/docs/interfaces/Person.md +3 -3
  65. package/docs/interfaces/Privilege.md +3 -3
  66. package/docs/interfaces/QueueItemDescriptor.md +4 -9
  67. package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
  68. package/docs/interfaces/ResourceLoader.md +1 -1
  69. package/docs/interfaces/RetryOptions.md +7 -18
  70. package/docs/interfaces/Role.md +3 -3
  71. package/docs/interfaces/Session.md +7 -7
  72. package/docs/interfaces/SessionLocation.md +3 -3
  73. package/docs/interfaces/ShowNotificationEvent.md +5 -5
  74. package/docs/interfaces/ShowToastEvent.md +4 -4
  75. package/docs/interfaces/SpaConfig.md +5 -19
  76. package/docs/interfaces/SyncItem.md +7 -11
  77. package/docs/interfaces/SyncProcessOptions.md +5 -7
  78. package/docs/interfaces/ToastDescriptor.md +5 -5
  79. package/docs/interfaces/ToastNotificationMeta.md +6 -6
  80. package/docs/interfaces/UserHasAccessProps.md +4 -4
  81. package/docs/interfaces/Visit.md +9 -9
  82. package/docs/interfaces/VisitItem.md +4 -4
  83. package/docs/interfaces/VisitType.md +3 -3
  84. package/jest.config.js +3 -0
  85. package/mock.tsx +3 -7
  86. package/package.json +13 -13
  87. package/src/integration-tests/extension-config.test.tsx +215 -17
  88. package/typedoc.json +1 -1
  89. package/.turbo/turbo-lint.log +0 -2
  90. package/.turbo/turbo-test.log +0 -451
  91. package/.turbo/turbo-typescript.log +0 -2
package/docs/interfaces/RetryOptions.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: RetryOptions
4
4
 
5
- Options for configuring the behavior of the [retry](../API.md#retry) function.
6
-
7
5
  ## Table of contents
8
6
 
9
7
  ### Methods
@@ -18,14 +16,11 @@ Options for configuring the behavior of the [retry](../API.md#retry) function.
18
16
 
19
17
  ▸ `Optional` **getDelay**(`attempt`): `number`
20
18
 
21
- Calculates the next delay (in milliseconds) before a retry attempt.
22
- Returning a value for the inital attempt (`0`) delays the initial function invocation.
23
-
24
19
  #### Parameters
25
20
 
26
21
  | Name | Type | Description |
27
22
  | :------ | :------ | :------ |
28
- | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
23
+ | `attempt` | `number` | |
29
24
 
30
25
  #### Returns
31
26
 
@@ -33,7 +28,7 @@ Returning a value for the inital attempt (`0`) delays the initial function invoc
33
28
 
34
29
  #### Defined in
35
30
 
36
- [packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L18)
31
+ [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)
37
32
 
38
33
  ___
39
34
 
@@ -41,15 +36,12 @@ ___
41
36
 
42
37
  ▸ `Optional` **onError**(`e`, `attempt`): `void`
43
38
 
44
- Called when invoking the function resulted in an error.
45
- Allows running side-effects on errors, e.g. logging.
46
-
47
39
  #### Parameters
48
40
 
49
41
  | Name | Type | Description |
50
42
  | :------ | :------ | :------ |
51
- | `e` | `any` | The error thrown by the function. |
52
- | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
43
+ | `e` | `any` | |
44
+ | `attempt` | `number` | |
53
45
 
54
46
  #### Returns
55
47
 
@@ -57,7 +49,7 @@ Allows running side-effects on errors, e.g. logging.
57
49
 
58
50
  #### Defined in
59
51
 
60
- [packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L25)
52
+ [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)
61
53
 
62
54
  ___
63
55
 
@@ -65,14 +57,11 @@ ___
65
57
 
66
58
  ▸ `Optional` **shouldRetry**(`attempt`): `any`
67
59
 
68
- Determines whether the retry function should retry executing the function after it failed
69
- with an error on the current attempt.
70
-
71
60
  #### Parameters
72
61
 
73
62
  | Name | Type | Description |
74
63
  | :------ | :------ | :------ |
75
- | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
64
+ | `attempt` | `number` | |
76
65
 
77
66
  #### Returns
78
67
 
@@ -80,4 +69,4 @@ with an error on the current attempt.
80
69
 
81
70
  #### Defined in
82
71
 
83
- [packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L12)
72
+ [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)
package/docs/interfaces/Role.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L46)
21
+ [packages/framework/esm-api/src/types/user-resource.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L46)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/types/user-resource.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L47)
31
+ [packages/framework/esm-api/src/types/user-resource.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L47)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-api/src/types/user-resource.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L45)
41
+ [packages/framework/esm-api/src/types/user-resource.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L45)
package/docs/interfaces/Session.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Defined in
24
24
 
25
- [packages/framework/esm-api/src/types/user-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L2)
25
+ [packages/framework/esm-api/src/types/user-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L2)
26
26
 
27
27
  ___
28
28
 
@@ -32,7 +32,7 @@ ___
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-api/src/types/user-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L3)
35
+ [packages/framework/esm-api/src/types/user-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L3)
36
36
 
37
37
  ___
38
38
 
@@ -49,7 +49,7 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-api/src/types/user-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L7)
52
+ [packages/framework/esm-api/src/types/user-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L7)
53
53
 
54
54
  ___
55
55
 
@@ -59,7 +59,7 @@ ___
59
59
 
60
60
  #### Defined in
61
61
 
62
- [packages/framework/esm-api/src/types/user-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L4)
62
+ [packages/framework/esm-api/src/types/user-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L4)
63
63
 
64
64
  ___
65
65
 
@@ -69,7 +69,7 @@ ___
69
69
 
70
70
  #### Defined in
71
71
 
72
- [packages/framework/esm-api/src/types/user-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L5)
72
+ [packages/framework/esm-api/src/types/user-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L5)
73
73
 
74
74
  ___
75
75
 
@@ -79,7 +79,7 @@ ___
79
79
 
80
80
  #### Defined in
81
81
 
82
- [packages/framework/esm-api/src/types/user-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L8)
82
+ [packages/framework/esm-api/src/types/user-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L8)
83
83
 
84
84
  ___
85
85
 
@@ -89,4 +89,4 @@ ___
89
89
 
90
90
  #### Defined in
91
91
 
92
- [packages/framework/esm-api/src/types/user-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L6)
92
+ [packages/framework/esm-api/src/types/user-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L6)
package/docs/interfaces/SessionLocation.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L28)
21
+ [packages/framework/esm-api/src/types/user-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L28)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/types/user-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L29)
31
+ [packages/framework/esm-api/src/types/user-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L29)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-api/src/types/user-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L27)
41
+ [packages/framework/esm-api/src/types/user-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L27)
package/docs/interfaces/ShowNotificationEvent.md CHANGED
@@ -20,7 +20,7 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-globals/src/events.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L65)
23
+ [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)
24
24
 
25
25
  ___
26
26
 
@@ -30,7 +30,7 @@ ___
30
30
 
31
31
  #### Defined in
32
32
 
33
- [packages/framework/esm-globals/src/events.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L56)
33
+ [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)
34
34
 
35
35
  ___
36
36
 
@@ -40,7 +40,7 @@ ___
40
40
 
41
41
  #### Defined in
42
42
 
43
- [packages/framework/esm-globals/src/events.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L57)
43
+ [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)
44
44
 
45
45
  ___
46
46
 
@@ -50,7 +50,7 @@ ___
50
50
 
51
51
  #### Defined in
52
52
 
53
- [packages/framework/esm-globals/src/events.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L66)
53
+ [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)
54
54
 
55
55
  ___
56
56
 
@@ -60,4 +60,4 @@ ___
60
60
 
61
61
  #### Defined in
62
62
 
63
- [packages/framework/esm-globals/src/events.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L64)
63
+ [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)
package/docs/interfaces/ShowToastEvent.md CHANGED
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- [packages/framework/esm-globals/src/events.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L71)
22
+ [packages/framework/esm-globals/src/events.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L71)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [packages/framework/esm-globals/src/events.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L72)
32
+ [packages/framework/esm-globals/src/events.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L72)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/framework/esm-globals/src/events.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L80)
42
+ [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)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-globals/src/events.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L79)
52
+ [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)
package/docs/interfaces/SpaConfig.md CHANGED
@@ -18,11 +18,9 @@
18
18
 
19
19
  • **apiUrl**: `string`
20
20
 
21
- The base path or URL for the OpenMRS API / endpoints.
22
-
23
21
  #### Defined in
24
22
 
25
- [packages/framework/esm-globals/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L70)
23
+ [packages/framework/esm-globals/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L70)
26
24
 
27
25
  ___
28
26
 
@@ -30,11 +28,9 @@ ___
30
28
 
31
29
  • `Optional` **configUrls**: `string`[]
32
30
 
33
- URLs of configurations to load in the system.
34
-
35
31
  #### Defined in
36
32
 
37
- [packages/framework/esm-globals/src/types.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L83)
33
+ [packages/framework/esm-globals/src/types.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L83)
38
34
 
39
35
  ___
40
36
 
@@ -42,13 +38,9 @@ ___
42
38
 
43
39
  • `Optional` **env**: [`SpaEnvironment`](../API.md#spaenvironment)
44
40
 
45
- The environment to use.
46
-
47
- **`default`** production
48
-
49
41
  #### Defined in
50
42
 
51
- [packages/framework/esm-globals/src/types.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L79)
43
+ [packages/framework/esm-globals/src/types.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L79)
52
44
 
53
45
  ___
54
46
 
@@ -56,13 +48,9 @@ ___
56
48
 
57
49
  • `Optional` **offline**: `boolean`
58
50
 
59
- Defines if offline should be supported by installing a service worker.
60
-
61
- **`default`** true
62
-
63
51
  #### Defined in
64
52
 
65
- [packages/framework/esm-globals/src/types.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L88)
53
+ [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)
66
54
 
67
55
  ___
68
56
 
@@ -70,8 +58,6 @@ ___
70
58
 
71
59
  • **spaPath**: `string`
72
60
 
73
- The base path for the SPA root path.
74
-
75
61
  #### Defined in
76
62
 
77
- [packages/framework/esm-globals/src/types.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L74)
63
+ [packages/framework/esm-globals/src/types.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L74)
package/docs/interfaces/SyncItem.md CHANGED
@@ -2,10 +2,6 @@
2
2
 
3
3
  # Interface: SyncItem<T\>
4
4
 
5
- Defines an item queued up in the offline synchronization queue.
6
- A `SyncItem` contains both meta information about the item in the sync queue, as well as the
7
- actual data to be synchronized (i.e. the item's `content`).
8
-
9
5
  ## Type parameters
10
6
 
11
7
  | Name | Type |
@@ -32,7 +28,7 @@ actual data to be synchronized (i.e. the item's `content`).
32
28
 
33
29
  #### Defined in
34
30
 
35
- [packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L16)
31
+ [packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L16)
36
32
 
37
33
  ___
38
34
 
@@ -42,7 +38,7 @@ ___
42
38
 
43
39
  #### Defined in
44
40
 
45
- [packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L17)
41
+ [packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L17)
46
42
 
47
43
  ___
48
44
 
@@ -52,7 +48,7 @@ ___
52
48
 
53
49
  #### Defined in
54
50
 
55
- [packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L18)
51
+ [packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L18)
56
52
 
57
53
  ___
58
54
 
@@ -62,7 +58,7 @@ ___
62
58
 
63
59
  #### Defined in
64
60
 
65
- [packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L13)
61
+ [packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L13)
66
62
 
67
63
  ___
68
64
 
@@ -79,7 +75,7 @@ ___
79
75
 
80
76
  #### Defined in
81
77
 
82
- [packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L19)
78
+ [packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L19)
83
79
 
84
80
  ___
85
81
 
@@ -89,7 +85,7 @@ ___
89
85
 
90
86
  #### Defined in
91
87
 
92
- [packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L15)
88
+ [packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L15)
93
89
 
94
90
  ___
95
91
 
@@ -99,4 +95,4 @@ ___
99
95
 
100
96
  #### Defined in
101
97
 
102
- [packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L14)
98
+ [packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L14)
package/docs/interfaces/SyncProcessOptions.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: SyncProcessOptions<T\>
4
4
 
5
- Additional data which can be used for synchronizing data in a {@link ProcessSyncItem} function.
6
-
7
5
  ## Type parameters
8
6
 
9
7
  | Name |
@@ -28,7 +26,7 @@ Additional data which can be used for synchronizing data in a {@link ProcessSync
28
26
 
29
27
  #### Defined in
30
28
 
31
- [packages/framework/esm-offline/src/sync.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L56)
29
+ [packages/framework/esm-offline/src/sync.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L56)
32
30
 
33
31
  ___
34
32
 
@@ -38,7 +36,7 @@ ___
38
36
 
39
37
  #### Defined in
40
38
 
41
- [packages/framework/esm-offline/src/sync.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L60)
39
+ [packages/framework/esm-offline/src/sync.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L60)
42
40
 
43
41
  ___
44
42
 
@@ -48,7 +46,7 @@ ___
48
46
 
49
47
  #### Defined in
50
48
 
51
- [packages/framework/esm-offline/src/sync.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L58)
49
+ [packages/framework/esm-offline/src/sync.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L58)
52
50
 
53
51
  ___
54
52
 
@@ -58,7 +56,7 @@ ___
58
56
 
59
57
  #### Defined in
60
58
 
61
- [packages/framework/esm-offline/src/sync.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L59)
59
+ [packages/framework/esm-offline/src/sync.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L59)
62
60
 
63
61
  ___
64
62
 
@@ -68,4 +66,4 @@ ___
68
66
 
69
67
  #### Defined in
70
68
 
71
- [packages/framework/esm-offline/src/sync.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L57)
69
+ [packages/framework/esm-offline/src/sync.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L57)
package/docs/interfaces/ToastDescriptor.md CHANGED
@@ -26,7 +26,7 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
29
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
30
30
 
31
31
  ___
32
32
 
@@ -36,7 +36,7 @@ ___
36
36
 
37
37
  #### Defined in
38
38
 
39
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
39
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
40
40
 
41
41
  ___
42
42
 
@@ -46,7 +46,7 @@ ___
46
46
 
47
47
  #### Defined in
48
48
 
49
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
49
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
50
50
 
51
51
  ___
52
52
 
@@ -56,7 +56,7 @@ ___
56
56
 
57
57
  #### Defined in
58
58
 
59
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
59
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
60
60
 
61
61
  ___
62
62
 
@@ -66,4 +66,4 @@ ___
66
66
 
67
67
  #### Defined in
68
68
 
69
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
69
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
package/docs/interfaces/ToastNotificationMeta.md CHANGED
@@ -31,7 +31,7 @@
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
34
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
35
35
 
36
36
  ___
37
37
 
@@ -45,7 +45,7 @@ ___
45
45
 
46
46
  #### Defined in
47
47
 
48
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
48
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
49
49
 
50
50
  ___
51
51
 
@@ -55,7 +55,7 @@ ___
55
55
 
56
56
  #### Defined in
57
57
 
58
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L23)
58
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L23)
59
59
 
60
60
  ___
61
61
 
@@ -69,7 +69,7 @@ ___
69
69
 
70
70
  #### Defined in
71
71
 
72
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
72
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
73
73
 
74
74
  ___
75
75
 
@@ -83,7 +83,7 @@ ___
83
83
 
84
84
  #### Defined in
85
85
 
86
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
86
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
87
87
 
88
88
  ___
89
89
 
@@ -97,4 +97,4 @@ ___
97
97
 
98
98
  #### Defined in
99
99
 
100
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
100
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
package/docs/interfaces/UserHasAccessProps.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L8)
21
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L8)
22
22
 
23
23
  ___
24
24
 
@@ -28,14 +28,14 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)
31
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)
32
32
 
33
33
  ___
34
34
 
35
35
  ### privilege
36
36
 
37
- • **privilege**: `string`
37
+ • **privilege**: `string` \| `string`[]
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L6)
41
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L6)
package/docs/interfaces/Visit.md CHANGED
@@ -28,7 +28,7 @@
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/types/visit-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L23)
31
+ [packages/framework/esm-api/src/types/visit-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L23)
32
32
 
33
33
  ___
34
34
 
@@ -38,7 +38,7 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-api/src/types/visit-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L16)
41
+ [packages/framework/esm-api/src/types/visit-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L16)
42
42
 
43
43
  ___
44
44
 
@@ -48,7 +48,7 @@ ___
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/framework/esm-api/src/types/visit-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L17)
51
+ [packages/framework/esm-api/src/types/visit-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L17)
52
52
 
53
53
  ___
54
54
 
@@ -58,7 +58,7 @@ ___
58
58
 
59
59
  #### Defined in
60
60
 
61
- [packages/framework/esm-api/src/types/visit-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L20)
61
+ [packages/framework/esm-api/src/types/visit-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L20)
62
62
 
63
63
  ___
64
64
 
@@ -68,7 +68,7 @@ ___
68
68
 
69
69
  #### Defined in
70
70
 
71
- [packages/framework/esm-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L18)
71
+ [packages/framework/esm-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L18)
72
72
 
73
73
  ___
74
74
 
@@ -78,7 +78,7 @@ ___
78
78
 
79
79
  #### Defined in
80
80
 
81
- [packages/framework/esm-api/src/types/visit-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L21)
81
+ [packages/framework/esm-api/src/types/visit-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L21)
82
82
 
83
83
  ___
84
84
 
@@ -88,7 +88,7 @@ ___
88
88
 
89
89
  #### Defined in
90
90
 
91
- [packages/framework/esm-api/src/types/visit-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L22)
91
+ [packages/framework/esm-api/src/types/visit-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L22)
92
92
 
93
93
  ___
94
94
 
@@ -98,7 +98,7 @@ ___
98
98
 
99
99
  #### Defined in
100
100
 
101
- [packages/framework/esm-api/src/types/visit-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L15)
101
+ [packages/framework/esm-api/src/types/visit-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L15)
102
102
 
103
103
  ___
104
104
 
@@ -108,4 +108,4 @@ ___
108
108
 
109
109
  #### Defined in
110
110
 
111
- [packages/framework/esm-api/src/types/visit-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L19)
111
+ [packages/framework/esm-api/src/types/visit-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L19)