@openmrs/esm-framework 3.2.1-pre.972 → 3.3.1-pre.1173

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 (76) hide show
  1. package/.turbo/turbo-build.log +154 -0
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +47 -1
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +1395 -1964
  6. package/docs/classes/OpenmrsFetchError.md +3 -3
  7. package/docs/enums/Type.md +11 -0
  8. package/docs/enums/VisitMode.md +3 -3
  9. package/docs/enums/VisitStatus.md +2 -2
  10. package/docs/interfaces/AssignedExtension.md +31 -7
  11. package/docs/interfaces/BreadcrumbRegistration.md +4 -4
  12. package/docs/interfaces/BreadcrumbSettings.md +6 -6
  13. package/docs/interfaces/ClearDynamicRoutesMessage.md +3 -3
  14. package/docs/interfaces/ConfigSchema.md +3 -3
  15. package/docs/interfaces/ConfigurableLinkProps.md +3 -3
  16. package/docs/interfaces/ConnectedExtension.md +18 -5
  17. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  18. package/docs/interfaces/ExtensionRegistration.md +9 -15
  19. package/docs/interfaces/ExtensionSlotConfig.md +4 -4
  20. package/docs/interfaces/ExtensionSlotConfigObject.md +3 -3
  21. package/docs/interfaces/ExtensionSlotState.md +5 -5
  22. package/docs/interfaces/ExtensionStore.md +3 -3
  23. package/docs/interfaces/FHIRRequestObj.md +3 -3
  24. package/docs/interfaces/LoggedInUser.md +12 -12
  25. package/docs/interfaces/LoggedInUserFetchResponse.md +2 -2
  26. package/docs/interfaces/MessageServiceWorkerResult.md +5 -5
  27. package/docs/interfaces/NavigateOptions.md +3 -3
  28. package/docs/interfaces/NotificationDescriptor.md +74 -0
  29. package/docs/interfaces/OfflineModeResult.md +5 -5
  30. package/docs/interfaces/OfflinePatientArgs.md +4 -4
  31. package/docs/interfaces/OfflinePatientDataSyncHandler.md +4 -4
  32. package/docs/interfaces/OfflinePatientDataSyncState.md +8 -8
  33. package/docs/interfaces/OfflinePatientDataSyncStore.md +4 -4
  34. package/docs/interfaces/OmrsServiceWorkerMessage.md +3 -3
  35. package/docs/interfaces/OnImportMapChangedMessage.md +4 -4
  36. package/docs/interfaces/OnlyThePatient.md +1 -1
  37. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  38. package/docs/interfaces/Person.md +3 -3
  39. package/docs/interfaces/Privilege.md +4 -4
  40. package/docs/interfaces/QueueItemDescriptor.md +6 -6
  41. package/docs/interfaces/RegisterDynamicRouteMessage.md +6 -6
  42. package/docs/interfaces/RetryOptions.md +3 -3
  43. package/docs/interfaces/Role.md +3 -3
  44. package/docs/interfaces/Session.md +92 -0
  45. package/docs/interfaces/SessionLocation.md +3 -3
  46. package/docs/interfaces/ShowNotificationEvent.md +5 -5
  47. package/docs/interfaces/ShowToastEvent.md +4 -4
  48. package/docs/interfaces/SyncItem.md +9 -9
  49. package/docs/interfaces/SyncProcessOptions.md +8 -8
  50. package/docs/interfaces/ToastDescriptor.md +69 -0
  51. package/docs/interfaces/ToastNotificationMeta.md +100 -0
  52. package/docs/interfaces/UserHasAccessProps.md +3 -3
  53. package/docs/interfaces/VisitItem.md +4 -4
  54. package/jest.config.js +1 -1
  55. package/mock.tsx +34 -3
  56. package/package.json +13 -13
  57. package/src/index.ts +8 -8
  58. package/src/integration-tests/extension-config.test.tsx +129 -14
  59. package/src/internal.ts +11 -0
  60. package/webpack.config.js +10 -2
  61. package/babel.config.js +0 -7
  62. package/docs/interfaces/ComponentConfig.md +0 -30
  63. package/docs/interfaces/ComponentDecoratorOptions.md +0 -52
  64. package/docs/interfaces/ExtensionInfo.md +0 -140
  65. package/docs/interfaces/ExtensionInstance.md +0 -19
  66. package/docs/interfaces/ExtensionInternalStore.md +0 -34
  67. package/docs/interfaces/ExtensionSlotInfo.md +0 -64
  68. package/docs/interfaces/NavigationContext.md +0 -50
  69. package/docs/interfaces/NetworkRequestFailedEvent.md +0 -49
  70. package/docs/interfaces/OfflineSynchronizationStore.md +0 -30
  71. package/docs/interfaces/OmrsServiceWorkerEvent.md +0 -31
  72. package/docs/interfaces/OpenmrsReactComponentProps.md +0 -19
  73. package/docs/interfaces/OpenmrsReactComponentState.md +0 -41
  74. package/docs/interfaces/SessionUser.md +0 -92
  75. package/docs/interfaces/UnauthenticatedUser.md +0 -52
  76. package/docs/interfaces/User.md +0 -107
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Defined in
32
32
 
33
- [packages/framework/esm-api/src/types/user-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L24)
33
+ [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)
34
34
 
35
35
  ___
36
36
 
@@ -40,7 +40,7 @@ ___
40
40
 
41
41
  #### Defined in
42
42
 
43
- [packages/framework/esm-api/src/types/user-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L15)
43
+ [packages/framework/esm-api/src/types/user-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L25)
44
44
 
45
45
  ___
46
46
 
@@ -50,7 +50,7 @@ ___
50
50
 
51
51
  #### Defined in
52
52
 
53
- [packages/framework/esm-api/src/types/user-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L23)
53
+ [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)
54
54
 
55
55
  ___
56
56
 
@@ -60,7 +60,7 @@ ___
60
60
 
61
61
  #### Defined in
62
62
 
63
- [packages/framework/esm-api/src/types/user-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L19)
63
+ [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)
64
64
 
65
65
  ___
66
66
 
@@ -70,7 +70,7 @@ ___
70
70
 
71
71
  #### Defined in
72
72
 
73
- [packages/framework/esm-api/src/types/user-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L20)
73
+ [packages/framework/esm-api/src/types/user-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L30)
74
74
 
75
75
  ___
76
76
 
@@ -80,7 +80,7 @@ ___
80
80
 
81
81
  #### Defined in
82
82
 
83
- [packages/framework/esm-api/src/types/user-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L22)
83
+ [packages/framework/esm-api/src/types/user-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L32)
84
84
 
85
85
  ___
86
86
 
@@ -90,7 +90,7 @@ ___
90
90
 
91
91
  #### Defined in
92
92
 
93
- [packages/framework/esm-api/src/types/user-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L21)
93
+ [packages/framework/esm-api/src/types/user-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L31)
94
94
 
95
95
  ___
96
96
 
@@ -100,17 +100,17 @@ ___
100
100
 
101
101
  #### Defined in
102
102
 
103
- [packages/framework/esm-api/src/types/user-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L17)
103
+ [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)
104
104
 
105
105
  ___
106
106
 
107
107
  ### userProperties
108
108
 
109
- • **userProperties**: `any`
109
+ • **userProperties**: ``null`` \| { `[key: string]`: `any`; }
110
110
 
111
111
  #### Defined in
112
112
 
113
- [packages/framework/esm-api/src/types/user-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L18)
113
+ [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)
114
114
 
115
115
  ___
116
116
 
@@ -120,7 +120,7 @@ ___
120
120
 
121
121
  #### Defined in
122
122
 
123
- [packages/framework/esm-api/src/types/user-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L16)
123
+ [packages/framework/esm-api/src/types/user-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L26)
124
124
 
125
125
  ___
126
126
 
@@ -130,4 +130,4 @@ ___
130
130
 
131
131
  #### Defined in
132
132
 
133
- [packages/framework/esm-api/src/types/user-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L14)
133
+ [packages/framework/esm-api/src/types/user-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L24)
@@ -64,7 +64,7 @@ ___
64
64
 
65
65
  ### data
66
66
 
67
- • **data**: [`LoggedInUserData`](../API.md#loggedinuserdata)
67
+ • **data**: [`Session`](Session.md)
68
68
 
69
69
  #### Overrides
70
70
 
@@ -72,7 +72,7 @@ ___
72
72
 
73
73
  #### Defined in
74
74
 
75
- [packages/framework/esm-api/src/types/fetch.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L12)
75
+ [packages/framework/esm-api/src/types/fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L8)
76
76
 
77
77
  ___
78
78
 
@@ -10,13 +10,13 @@
10
10
 
11
11
  ## Table of contents
12
12
 
13
- ### Properties
13
+ ### Offline Properties
14
14
 
15
15
  - [error](MessageServiceWorkerResult.md#error)
16
16
  - [result](MessageServiceWorkerResult.md#result)
17
17
  - [success](MessageServiceWorkerResult.md#success)
18
18
 
19
- ## Properties
19
+ ## Offline Properties
20
20
 
21
21
  ### error
22
22
 
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-offline/src/service-worker-messaging.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L53)
27
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L54)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-offline/src/service-worker-messaging.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L52)
37
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L53)
38
38
 
39
39
  ___
40
40
 
@@ -44,4 +44,4 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-offline/src/service-worker-messaging.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L51)
47
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L52)
@@ -4,11 +4,11 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Navigation Properties
8
8
 
9
9
  - [to](NavigateOptions.md#to)
10
10
 
11
- ## Properties
11
+ ## Navigation Properties
12
12
 
13
13
  ### to
14
14
 
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L10)
19
+ [packages/framework/esm-config/src/navigation/navigate.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L11)
@@ -0,0 +1,74 @@
1
+ [@openmrs/esm-framework](../API.md) / NotificationDescriptor
2
+
3
+ # Interface: NotificationDescriptor
4
+
5
+ ## Table of contents
6
+
7
+ ### UI Properties
8
+
9
+ - [action](NotificationDescriptor.md#action)
10
+ - [critical](NotificationDescriptor.md#critical)
11
+ - [description](NotificationDescriptor.md#description)
12
+ - [kind](NotificationDescriptor.md#kind)
13
+ - [millis](NotificationDescriptor.md#millis)
14
+ - [title](NotificationDescriptor.md#title)
15
+
16
+ ## UI Properties
17
+
18
+ ### action
19
+
20
+ • `Optional` **action**: `ReactNode`
21
+
22
+ #### Defined in
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)
25
+
26
+ ___
27
+
28
+ ### critical
29
+
30
+ • `Optional` **critical**: `boolean`
31
+
32
+ #### Defined in
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)
35
+
36
+ ___
37
+
38
+ ### description
39
+
40
+ • **description**: `ReactNode`
41
+
42
+ #### Defined in
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)
45
+
46
+ ___
47
+
48
+ ### kind
49
+
50
+ • `Optional` **kind**: [`InlineNotificationType`](../API.md#inlinenotificationtype)
51
+
52
+ #### Defined in
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)
55
+
56
+ ___
57
+
58
+ ### millis
59
+
60
+ • `Optional` **millis**: `number`
61
+
62
+ #### Defined in
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)
65
+
66
+ ___
67
+
68
+ ### title
69
+
70
+ • `Optional` **title**: `string`
71
+
72
+ #### Defined in
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)
@@ -4,13 +4,13 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Offline Properties
8
8
 
9
9
  - [active](OfflineModeResult.md#active)
10
10
  - [current](OfflineModeResult.md#current)
11
11
  - [notAvailable](OfflineModeResult.md#notavailable)
12
12
 
13
- ## Properties
13
+ ## Offline Properties
14
14
 
15
15
  ### active
16
16
 
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [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)
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)
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:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L39)
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)
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:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L40)
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)
@@ -4,12 +4,12 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Offline Properties
8
8
 
9
9
  - [patientUuid](OfflinePatientArgs.md#patientuuid)
10
10
  - [signal](OfflinePatientArgs.md#signal)
11
11
 
12
- ## Properties
12
+ ## Offline Properties
13
13
 
14
14
  ### patientUuid
15
15
 
@@ -19,7 +19,7 @@ The UUID of the patient that should be made available offline.
19
19
 
20
20
  #### Defined in
21
21
 
22
- [packages/framework/esm-offline/src/offline-patient-data.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L70)
22
+ [packages/framework/esm-offline/src/offline-patient-data.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
23
23
 
24
24
  ___
25
25
 
@@ -31,4 +31,4 @@ An {@link AbortSignal} which notifies about the cancellation of the operation.
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/framework/esm-offline/src/offline-patient-data.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L74)
34
+ [packages/framework/esm-offline/src/offline-patient-data.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L75)
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Offline Properties
8
8
 
9
9
  - [displayName](OfflinePatientDataSyncHandler.md#displayname)
10
10
 
@@ -12,7 +12,7 @@
12
12
 
13
13
  - [onOfflinePatientAdded](OfflinePatientDataSyncHandler.md#onofflinepatientadded)
14
14
 
15
- ## Properties
15
+ ## Offline Properties
16
16
 
17
17
  ### displayName
18
18
 
@@ -23,7 +23,7 @@ This is ideally translated.
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/framework/esm-offline/src/offline-patient-data.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L55)
26
+ [packages/framework/esm-offline/src/offline-patient-data.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L56)
27
27
 
28
28
  ## Methods
29
29
 
@@ -49,4 +49,4 @@ A promise which should resolve if all data could be cached and reject when there
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-offline/src/offline-patient-data.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L63)
52
+ [packages/framework/esm-offline/src/offline-patient-data.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L64)
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Offline Properties
8
8
 
9
9
  - [errors](OfflinePatientDataSyncState.md#errors)
10
10
  - [failedHandlers](OfflinePatientDataSyncState.md#failedhandlers)
@@ -16,7 +16,7 @@
16
16
 
17
17
  - [abort](OfflinePatientDataSyncState.md#abort)
18
18
 
19
- ## Properties
19
+ ## Offline Properties
20
20
 
21
21
  ### errors
22
22
 
@@ -26,7 +26,7 @@ A set of error messages associated with the identifers of the failed handlers.
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-offline/src/offline-patient-data.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L41)
29
+ [packages/framework/esm-offline/src/offline-patient-data.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L42)
30
30
 
31
31
  ___
32
32
 
@@ -39,7 +39,7 @@ patient's data.
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/framework/esm-offline/src/offline-patient-data.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L37)
42
+ [packages/framework/esm-offline/src/offline-patient-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L38)
43
43
 
44
44
  ___
45
45
 
@@ -52,7 +52,7 @@ patient's data.
52
52
 
53
53
  #### Defined in
54
54
 
55
- [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)
55
+ [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)
56
56
 
57
57
  ___
58
58
 
@@ -65,7 +65,7 @@ of synchronizing the patient's data.
65
65
 
66
66
  #### Defined in
67
67
 
68
- [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)
68
+ [packages/framework/esm-offline/src/offline-patient-data.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L28)
69
69
 
70
70
  ___
71
71
 
@@ -77,7 +77,7 @@ The time when this state snapshot was initially created.
77
77
 
78
78
  #### Defined in
79
79
 
80
- [packages/framework/esm-offline/src/offline-patient-data.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L22)
80
+ [packages/framework/esm-offline/src/offline-patient-data.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L23)
81
81
 
82
82
  ## Methods
83
83
 
@@ -96,4 +96,4 @@ Aborts the process of downloading data.
96
96
 
97
97
  #### Defined in
98
98
 
99
- [packages/framework/esm-offline/src/offline-patient-data.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L47)
99
+ [packages/framework/esm-offline/src/offline-patient-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L48)
@@ -4,12 +4,12 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### Offline Properties
8
8
 
9
9
  - [handlers](OfflinePatientDataSyncStore.md#handlers)
10
10
  - [offlinePatientDataSyncState](OfflinePatientDataSyncStore.md#offlinepatientdatasyncstate)
11
11
 
12
- ## Properties
12
+ ## Offline Properties
13
13
 
14
14
  ### handlers
15
15
 
@@ -21,7 +21,7 @@ the handler registration.
21
21
 
22
22
  #### Defined in
23
23
 
24
- [packages/framework/esm-offline/src/offline-patient-data.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L15)
24
+ [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)
25
25
 
26
26
  ___
27
27
 
@@ -34,4 +34,4 @@ the current data synchronizaton state.
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-offline/src/offline-patient-data.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L9)
37
+ [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)
@@ -20,11 +20,11 @@
20
20
 
21
21
  ## Table of contents
22
22
 
23
- ### Properties
23
+ ### Offline Properties
24
24
 
25
25
  - [type](OmrsServiceWorkerMessage.md#type)
26
26
 
27
- ## Properties
27
+ ## Offline Properties
28
28
 
29
29
  ### type
30
30
 
@@ -32,4 +32,4 @@
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-offline/src/service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
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)
@@ -10,12 +10,12 @@
10
10
 
11
11
  ## Table of contents
12
12
 
13
- ### Properties
13
+ ### Offline Properties
14
14
 
15
15
  - [importMap](OnImportMapChangedMessage.md#importmap)
16
16
  - [type](OnImportMapChangedMessage.md#type)
17
17
 
18
- ## Properties
18
+ ## Offline Properties
19
19
 
20
20
  ### importMap
21
21
 
@@ -23,7 +23,7 @@
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/framework/esm-offline/src/service-worker-messaging.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L32)
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)
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:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
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)
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L20)
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)
@@ -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:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L12)
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L43)
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)
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:44](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L44)
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)
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:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L42)
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)
@@ -18,17 +18,17 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/types/user-resource.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L49)
21
+ [packages/framework/esm-api/src/types/user-resource.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L52)
22
22
 
23
23
  ___
24
24
 
25
25
  ### links
26
26
 
27
- • **links**: `any`[]
27
+ `Optional` **links**: `any`[]
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/types/user-resource.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L50)
31
+ [packages/framework/esm-api/src/types/user-resource.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L53)
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:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L48)
41
+ [packages/framework/esm-api/src/types/user-resource.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L51)
@@ -9,14 +9,14 @@ locations to better represent the sync item, e.g. in the UI.
9
9
 
10
10
  ## Table of contents
11
11
 
12
- ### Properties
12
+ ### Offline Properties
13
13
 
14
14
  - [dependencies](QueueItemDescriptor.md#dependencies)
15
15
  - [displayName](QueueItemDescriptor.md#displayname)
16
16
  - [id](QueueItemDescriptor.md#id)
17
17
  - [patientUuid](QueueItemDescriptor.md#patientuuid)
18
18
 
19
- ## Properties
19
+ ## Offline Properties
20
20
 
21
21
  ### dependencies
22
22
 
@@ -24,7 +24,7 @@ locations to better represent the sync item, e.g. in the UI.
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-offline/src/sync.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L31)
27
+ [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)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-offline/src/sync.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L36)
37
+ [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)
38
38
 
39
39
  ___
40
40
 
@@ -44,7 +44,7 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-offline/src/sync.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L30)
47
+ [packages/framework/esm-offline/src/sync.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L31)
48
48
 
49
49
  ___
50
50
 
@@ -54,4 +54,4 @@ ___
54
54
 
55
55
  #### Defined in
56
56
 
57
- [packages/framework/esm-offline/src/sync.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L35)
57
+ [packages/framework/esm-offline/src/sync.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L36)