@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/NotificationDescriptor.md CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
  #### Defined in
23
23
 
24
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L11)
24
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L11)
25
25
 
26
26
  ___
27
27
 
@@ -31,7 +31,7 @@ ___
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L13)
34
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L13)
35
35
 
36
36
  ___
37
37
 
@@ -41,7 +41,7 @@ ___
41
41
 
42
42
  #### Defined in
43
43
 
44
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L10)
44
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L10)
45
45
 
46
46
  ___
47
47
 
@@ -51,7 +51,7 @@ ___
51
51
 
52
52
  #### Defined in
53
53
 
54
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L12)
54
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L12)
55
55
 
56
56
  ___
57
57
 
@@ -61,7 +61,7 @@ ___
61
61
 
62
62
  #### Defined in
63
63
 
64
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L14)
64
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L14)
65
65
 
66
66
  ___
67
67
 
@@ -71,4 +71,4 @@ ___
71
71
 
72
72
  #### Defined in
73
73
 
74
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L15)
74
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L15)
package/docs/interfaces/OfflineModeResult.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-offline/src/mode.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L43)
21
+ [packages/framework/esm-offline/src/mode.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L43)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-offline/src/mode.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L41)
31
+ [packages/framework/esm-offline/src/mode.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L41)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-offline/src/mode.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L42)
41
+ [packages/framework/esm-offline/src/mode.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L42)
package/docs/interfaces/OfflinePatientArgs.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: OfflinePatientArgs
4
4
 
5
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
6
-
7
5
  ## Table of contents
8
6
 
9
7
  ### Offline Properties
@@ -19,7 +17,7 @@
19
17
 
20
18
  #### Defined in
21
19
 
22
- [packages/framework/esm-offline/src/offline-patient-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L32)
20
+ [packages/framework/esm-offline/src/offline-patient-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L32)
23
21
 
24
22
  ___
25
23
 
@@ -29,4 +27,4 @@ ___
29
27
 
30
28
  #### Defined in
31
29
 
32
- [packages/framework/esm-offline/src/offline-patient-data.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L33)
30
+ [packages/framework/esm-offline/src/offline-patient-data.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L33)
package/docs/interfaces/OfflinePatientDataSyncHandler.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: OfflinePatientDataSyncHandler
4
4
 
5
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
6
-
7
5
  ## Table of contents
8
6
 
9
7
  ### Offline Properties
@@ -22,7 +20,7 @@
22
20
 
23
21
  #### Defined in
24
22
 
25
- [packages/framework/esm-offline/src/offline-patient-data.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L26)
23
+ [packages/framework/esm-offline/src/offline-patient-data.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L26)
26
24
 
27
25
  ## Methods
28
26
 
@@ -42,4 +40,4 @@
42
40
 
43
41
  #### Defined in
44
42
 
45
- [packages/framework/esm-offline/src/offline-patient-data.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L27)
43
+ [packages/framework/esm-offline/src/offline-patient-data.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L27)
package/docs/interfaces/OfflinePatientDataSyncState.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: OfflinePatientDataSyncState
4
4
 
5
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
6
-
7
5
  ## Table of contents
8
6
 
9
7
  ### Offline Properties
@@ -26,7 +24,7 @@
26
24
 
27
25
  #### Defined in
28
26
 
29
- [packages/framework/esm-offline/src/offline-patient-data.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L20)
27
+ [packages/framework/esm-offline/src/offline-patient-data.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L20)
30
28
 
31
29
  ___
32
30
 
@@ -36,7 +34,7 @@ ___
36
34
 
37
35
  #### Defined in
38
36
 
39
- [packages/framework/esm-offline/src/offline-patient-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L19)
37
+ [packages/framework/esm-offline/src/offline-patient-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L19)
40
38
 
41
39
  ___
42
40
 
@@ -46,7 +44,7 @@ ___
46
44
 
47
45
  #### Defined in
48
46
 
49
- [packages/framework/esm-offline/src/offline-patient-data.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L18)
47
+ [packages/framework/esm-offline/src/offline-patient-data.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L18)
50
48
 
51
49
  ___
52
50
 
@@ -56,7 +54,7 @@ ___
56
54
 
57
55
  #### Defined in
58
56
 
59
- [packages/framework/esm-offline/src/offline-patient-data.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L17)
57
+ [packages/framework/esm-offline/src/offline-patient-data.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L17)
60
58
 
61
59
  ___
62
60
 
@@ -66,7 +64,7 @@ ___
66
64
 
67
65
  #### Defined in
68
66
 
69
- [packages/framework/esm-offline/src/offline-patient-data.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
67
+ [packages/framework/esm-offline/src/offline-patient-data.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
70
68
 
71
69
  ## Methods
72
70
 
@@ -80,4 +78,4 @@ ___
80
78
 
81
79
  #### Defined in
82
80
 
83
- [packages/framework/esm-offline/src/offline-patient-data.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L21)
81
+ [packages/framework/esm-offline/src/offline-patient-data.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L21)
package/docs/interfaces/OfflinePatientDataSyncStore.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  # Interface: OfflinePatientDataSyncStore
4
4
 
5
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
6
-
7
5
  ## Table of contents
8
6
 
9
7
  ### Offline Properties
@@ -19,7 +17,7 @@
19
17
 
20
18
  #### Defined in
21
19
 
22
- [packages/framework/esm-offline/src/offline-patient-data.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L11)
20
+ [packages/framework/esm-offline/src/offline-patient-data.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L11)
23
21
 
24
22
  ___
25
23
 
@@ -29,4 +27,4 @@ ___
29
27
 
30
28
  #### Defined in
31
29
 
32
- [packages/framework/esm-offline/src/offline-patient-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L10)
30
+ [packages/framework/esm-offline/src/offline-patient-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L10)
package/docs/interfaces/OldExtensionSlotBaseProps.md ADDED
@@ -0,0 +1,65 @@
1
+ [@openmrs/esm-framework](../API.md) / OldExtensionSlotBaseProps
2
+
3
+ # Interface: OldExtensionSlotBaseProps
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [extensionSlotName](OldExtensionSlotBaseProps.md#extensionslotname)
10
+ - [name](OldExtensionSlotBaseProps.md#name)
11
+ - [state](OldExtensionSlotBaseProps.md#state)
12
+
13
+ ### Methods
14
+
15
+ - [select](OldExtensionSlotBaseProps.md#select)
16
+
17
+ ## Properties
18
+
19
+ ### extensionSlotName
20
+
21
+ • **extensionSlotName**: `string`
22
+
23
+ #### Defined in
24
+
25
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L18)
26
+
27
+ ___
28
+
29
+ ### name
30
+
31
+ • `Optional` **name**: `string`
32
+
33
+ #### Defined in
34
+
35
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L16)
36
+
37
+ ___
38
+
39
+ ### state
40
+
41
+ • `Optional` **state**: `Record`<`string`, `any`\>
42
+
43
+ #### Defined in
44
+
45
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L20)
46
+
47
+ ## Methods
48
+
49
+ ### select
50
+
51
+ ▸ `Optional` **select**(`extensions`): [`ConnectedExtension`](ConnectedExtension.md)[]
52
+
53
+ #### Parameters
54
+
55
+ | Name | Type |
56
+ | :------ | :------ |
57
+ | `extensions` | [`ConnectedExtension`](ConnectedExtension.md)[] |
58
+
59
+ #### Returns
60
+
61
+ [`ConnectedExtension`](ConnectedExtension.md)[]
62
+
63
+ #### Defined in
64
+
65
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L19)
package/docs/interfaces/OmrsServiceWorkerMessage.md CHANGED
@@ -32,4 +32,4 @@
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
35
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
package/docs/interfaces/OnImportMapChangedMessage.md CHANGED
@@ -23,7 +23,7 @@
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/framework/esm-offline/src/service-worker-messaging.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L33)
26
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L33)
27
27
 
28
28
  ___
29
29
 
@@ -37,4 +37,4 @@ ___
37
37
 
38
38
  #### Defined in
39
39
 
40
- [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
40
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
package/docs/interfaces/OnlyThePatient.md CHANGED
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L16)
29
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L16)
package/docs/interfaces/OpenmrsResource.md CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
  #### Defined in
23
23
 
24
- [packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
24
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
25
25
 
26
26
  ___
27
27
 
@@ -31,4 +31,4 @@ ___
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)
34
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)
package/docs/interfaces/PageDefinition.md CHANGED
@@ -30,15 +30,13 @@
30
30
 
31
31
  • **appName**: `string`
32
32
 
33
- The module/app that defines the component
34
-
35
33
  #### Inherited from
36
34
 
37
35
  [ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
38
36
 
39
37
  #### Defined in
40
38
 
41
- [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L99)
39
+ [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L99)
42
40
 
43
41
  ___
44
42
 
@@ -46,15 +44,13 @@ ___
46
44
 
47
45
  • `Optional` **offline**: `boolean` \| `object`
48
46
 
49
- Defines the offline support / properties of the component.
50
-
51
47
  #### Inherited from
52
48
 
53
49
  [ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
54
50
 
55
51
  #### Defined in
56
52
 
57
- [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L111)
53
+ [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L111)
58
54
 
59
55
  ___
60
56
 
@@ -62,15 +58,13 @@ ___
62
58
 
63
59
  • `Optional` **online**: `boolean` \| `object`
64
60
 
65
- Defines the online support / properties of the component.
66
-
67
61
  #### Inherited from
68
62
 
69
63
  [ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
70
64
 
71
65
  #### Defined in
72
66
 
73
- [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L107)
67
+ [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L107)
74
68
 
75
69
  ___
76
70
 
@@ -78,19 +72,15 @@ ___
78
72
 
79
73
  • **order**: `number`
80
74
 
81
- The order in which to load the page. This determines DOM order.
82
-
83
75
  #### Defined in
84
76
 
85
- [packages/framework/esm-globals/src/types.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L145)
77
+ [packages/framework/esm-globals/src/types.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L146)
86
78
 
87
79
  ___
88
80
 
89
81
  ### privilege
90
82
 
91
- • `Optional` **privilege**: `string`
92
-
93
- Defines the access privilege required for this component, if any.
83
+ • `Optional` **privilege**: `string` \| `string`[]
94
84
 
95
85
  #### Inherited from
96
86
 
@@ -98,7 +88,7 @@ Defines the access privilege required for this component, if any.
98
88
 
99
89
  #### Defined in
100
90
 
101
- [packages/framework/esm-globals/src/types.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L115)
91
+ [packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L116)
102
92
 
103
93
  ___
104
94
 
@@ -106,15 +96,13 @@ ___
106
96
 
107
97
  • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
108
98
 
109
- Defines resources that are loaded when the component should mount.
110
-
111
99
  #### Inherited from
112
100
 
113
101
  [ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
114
102
 
115
103
  #### Defined in
116
104
 
117
- [packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
105
+ [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)
118
106
 
119
107
  ___
120
108
 
@@ -122,11 +110,9 @@ ___
122
110
 
123
111
  • **route**: `string`
124
112
 
125
- The route of the page.
126
-
127
113
  #### Defined in
128
114
 
129
- [packages/framework/esm-globals/src/types.ts:141](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L141)
115
+ [packages/framework/esm-globals/src/types.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L142)
130
116
 
131
117
  ## Methods
132
118
 
@@ -134,8 +120,6 @@ The route of the page.
134
120
 
135
121
  ▸ **load**(): `Promise`<`any`\>
136
122
 
137
- Defines a function to use for actually loading the component's lifecycle.
138
-
139
123
  #### Returns
140
124
 
141
125
  `Promise`<`any`\>
@@ -146,4 +130,4 @@ Defines a function to use for actually loading the component's lifecycle.
146
130
 
147
131
  #### Defined in
148
132
 
149
- [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L103)
133
+ [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L103)
package/docs/interfaces/PatientWithFullResponse.md CHANGED
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L12)
29
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L12)
package/docs/interfaces/Person.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L34)
21
+ [packages/framework/esm-api/src/types/user-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L34)
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:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L35)
31
+ [packages/framework/esm-api/src/types/user-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L35)
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:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L33)
41
+ [packages/framework/esm-api/src/types/user-resource.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L33)
package/docs/interfaces/Privilege.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L40)
21
+ [packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L40)
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:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L41)
31
+ [packages/framework/esm-api/src/types/user-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L41)
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:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L39)
41
+ [packages/framework/esm-api/src/types/user-resource.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L39)
package/docs/interfaces/QueueItemDescriptor.md CHANGED
@@ -2,11 +2,6 @@
2
2
 
3
3
  # Interface: QueueItemDescriptor
4
4
 
5
- Contains information about the sync item which has been provided externally by the caller
6
- who added the item to the queue.
7
- This information is all optional, but, when provided while enqueuing the item, can be used in other
8
- locations to better represent the sync item, e.g. in the UI.
9
-
10
5
  ## Table of contents
11
6
 
12
7
  ### Offline Properties
@@ -24,7 +19,7 @@ locations to better represent the sync item, e.g. in the UI.
24
19
 
25
20
  #### Defined in
26
21
 
27
- [packages/framework/esm-offline/src/sync.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L33)
22
+ [packages/framework/esm-offline/src/sync.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L33)
28
23
 
29
24
  ___
30
25
 
@@ -34,7 +29,7 @@ ___
34
29
 
35
30
  #### Defined in
36
31
 
37
- [packages/framework/esm-offline/src/sync.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L38)
32
+ [packages/framework/esm-offline/src/sync.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L38)
38
33
 
39
34
  ___
40
35
 
@@ -44,7 +39,7 @@ ___
44
39
 
45
40
  #### Defined in
46
41
 
47
- [packages/framework/esm-offline/src/sync.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L32)
42
+ [packages/framework/esm-offline/src/sync.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L32)
48
43
 
49
44
  ___
50
45
 
@@ -54,4 +49,4 @@ ___
54
49
 
55
50
  #### Defined in
56
51
 
57
- [packages/framework/esm-offline/src/sync.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L37)
52
+ [packages/framework/esm-offline/src/sync.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L37)
package/docs/interfaces/RegisterDynamicRouteMessage.md CHANGED
@@ -25,7 +25,7 @@
25
25
 
26
26
  #### Defined in
27
27
 
28
- [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
28
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
29
29
 
30
30
  ___
31
31
 
@@ -35,7 +35,7 @@ ___
35
35
 
36
36
  #### Defined in
37
37
 
38
- [packages/framework/esm-offline/src/service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
38
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
39
39
 
40
40
  ___
41
41
 
@@ -49,7 +49,7 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
52
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L28)
53
53
 
54
54
  ___
55
55
 
@@ -59,4 +59,4 @@ ___
59
59
 
60
60
  #### Defined in
61
61
 
62
- [packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)
62
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)
package/docs/interfaces/ResourceLoader.md CHANGED
@@ -20,4 +20,4 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-globals/src/types.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L92)
23
+ [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)