@openmrs/esm-framework 3.2.1-pre.1084 → 3.2.1-pre.1086

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 (57) hide show
  1. package/dist/openmrs-esm-framework.js +1 -1
  2. package/dist/openmrs-esm-framework.js.LICENSE.txt +1 -41
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +2069 -1352
  5. package/docs/classes/OpenmrsFetchError.md +3 -3
  6. package/docs/enums/VisitMode.md +3 -3
  7. package/docs/enums/VisitStatus.md +2 -2
  8. package/docs/interfaces/AssignedExtension.md +9 -9
  9. package/docs/interfaces/BreadcrumbRegistration.md +4 -4
  10. package/docs/interfaces/BreadcrumbSettings.md +6 -6
  11. package/docs/interfaces/CancelLoading.md +1 -1
  12. package/docs/interfaces/ClearDynamicRoutesMessage.md +3 -3
  13. package/docs/interfaces/ComponentConfig.md +30 -0
  14. package/docs/interfaces/ComponentDecoratorOptions.md +52 -0
  15. package/docs/interfaces/ConfigurableLinkProps.md +3 -3
  16. package/docs/interfaces/ConnectedExtension.md +6 -6
  17. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  18. package/docs/interfaces/ExtensionInfo.md +139 -0
  19. package/docs/interfaces/ExtensionInstance.md +41 -0
  20. package/docs/interfaces/ExtensionInternalStore.md +34 -0
  21. package/docs/interfaces/ExtensionRegistration.md +15 -9
  22. package/docs/interfaces/ExtensionSlotInfo.md +64 -0
  23. package/docs/interfaces/ExtensionSlotState.md +4 -4
  24. package/docs/interfaces/ExtensionStore.md +3 -3
  25. package/docs/interfaces/FHIRRequestObj.md +3 -3
  26. package/docs/interfaces/MessageServiceWorkerResult.md +5 -5
  27. package/docs/interfaces/NavigateOptions.md +3 -3
  28. package/docs/interfaces/NavigationContext.md +50 -0
  29. package/docs/interfaces/NetworkRequestFailedEvent.md +49 -0
  30. package/docs/interfaces/OfflineModeResult.md +5 -5
  31. package/docs/interfaces/OfflinePatientArgs.md +4 -4
  32. package/docs/interfaces/OfflinePatientDataSyncHandler.md +4 -4
  33. package/docs/interfaces/OfflinePatientDataSyncState.md +8 -8
  34. package/docs/interfaces/OfflinePatientDataSyncStore.md +4 -4
  35. package/docs/interfaces/OfflineSynchronizationStore.md +30 -0
  36. package/docs/interfaces/OmrsServiceWorkerEvent.md +31 -0
  37. package/docs/interfaces/OmrsServiceWorkerMessage.md +3 -3
  38. package/docs/interfaces/OnImportMapChangedMessage.md +4 -4
  39. package/docs/interfaces/OnlyThePatient.md +1 -1
  40. package/docs/interfaces/OpenmrsReactComponentProps.md +19 -0
  41. package/docs/interfaces/OpenmrsReactComponentState.md +41 -0
  42. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  43. package/docs/interfaces/QueueItemDescriptor.md +6 -6
  44. package/docs/interfaces/RegisterDynamicRouteMessage.md +6 -6
  45. package/docs/interfaces/RetryOptions.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/UserHasAccessProps.md +3 -3
  51. package/docs/interfaces/VisitItem.md +4 -4
  52. package/package.json +13 -13
  53. package/src/index.ts +8 -8
  54. package/docs/interfaces/NotificationDescriptor.md +0 -74
  55. package/docs/interfaces/ToastDescriptor.md +0 -69
  56. package/docs/interfaces/ToastNotificationMeta.md +0 -100
  57. package/src/internal.ts +0 -11
package/docs/interfaces/ExtensionRegistration.md CHANGED
@@ -2,9 +2,15 @@
2
2
 
3
3
  # Interface: ExtensionRegistration
4
4
 
5
+ ## Hierarchy
6
+
7
+ - **`ExtensionRegistration`**
8
+
9
+ ↳ [`ExtensionInfo`](ExtensionInfo.md)
10
+
5
11
  ## Table of contents
6
12
 
7
- ### Extension Properties
13
+ ### Properties
8
14
 
9
15
  - [meta](ExtensionRegistration.md#meta)
10
16
  - [moduleName](ExtensionRegistration.md#modulename)
@@ -17,7 +23,7 @@
17
23
 
18
24
  - [load](ExtensionRegistration.md#load)
19
25
 
20
- ## Extension Properties
26
+ ## Properties
21
27
 
22
28
  ### meta
23
29
 
@@ -25,7 +31,7 @@
25
31
 
26
32
  #### Defined in
27
33
 
28
- [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
34
+ [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
29
35
 
30
36
  ___
31
37
 
@@ -35,7 +41,7 @@ ___
35
41
 
36
42
  #### Defined in
37
43
 
38
- [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
44
+ [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
39
45
 
40
46
  ___
41
47
 
@@ -45,7 +51,7 @@ ___
45
51
 
46
52
  #### Defined in
47
53
 
48
- [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
54
+ [packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
49
55
 
50
56
  ___
51
57
 
@@ -55,7 +61,7 @@ ___
55
61
 
56
62
  #### Defined in
57
63
 
58
- [packages/framework/esm-extensions/src/store.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L22)
64
+ [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L21)
59
65
 
60
66
  ___
61
67
 
@@ -65,7 +71,7 @@ ___
65
71
 
66
72
  #### Defined in
67
73
 
68
- [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L21)
74
+ [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
69
75
 
70
76
  ___
71
77
 
@@ -75,7 +81,7 @@ ___
75
81
 
76
82
  #### Defined in
77
83
 
78
- [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
84
+ [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
79
85
 
80
86
  ## Methods
81
87
 
@@ -89,4 +95,4 @@ ___
89
95
 
90
96
  #### Defined in
91
97
 
92
- [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
98
+ [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
package/docs/interfaces/ExtensionSlotInfo.md ADDED
@@ -0,0 +1,64 @@
1
+ [@openmrs/esm-framework](../API.md) / ExtensionSlotInfo
2
+
3
+ # Interface: ExtensionSlotInfo
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [attachedIds](ExtensionSlotInfo.md#attachedids)
10
+ - [config](ExtensionSlotInfo.md#config)
11
+ - [moduleName](ExtensionSlotInfo.md#modulename)
12
+ - [name](ExtensionSlotInfo.md#name)
13
+
14
+ ## Properties
15
+
16
+ ### attachedIds
17
+
18
+ • **attachedIds**: `string`[]
19
+
20
+ The set of extension IDs which have been attached to this slot using `attach`.
21
+ However, not all of these extension IDs should be rendered.
22
+ `assignedIds` is the set defining those.
23
+
24
+ #### Defined in
25
+
26
+ [packages/framework/esm-extensions/src/store.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L58)
27
+
28
+ ___
29
+
30
+ ### config
31
+
32
+ • **config**: ``null`` \| [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)
33
+
34
+ The configuration provided for this slot. `null` if not yet loaded.
35
+
36
+ #### Defined in
37
+
38
+ [packages/framework/esm-extensions/src/store.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L60)
39
+
40
+ ___
41
+
42
+ ### moduleName
43
+
44
+ • `Optional` **moduleName**: `string`
45
+
46
+ The module in which the extension slot exists. Undefined if the slot
47
+ hasn't been registered yet (but it has been attached or assigned to
48
+ an extension.
49
+
50
+ #### Defined in
51
+
52
+ [packages/framework/esm-extensions/src/store.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L50)
53
+
54
+ ___
55
+
56
+ ### name
57
+
58
+ • **name**: `string`
59
+
60
+ The name under which the extension slot has been registered.
61
+
62
+ #### Defined in
63
+
64
+ [packages/framework/esm-extensions/src/store.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L52)
package/docs/interfaces/ExtensionSlotState.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Extension Properties
7
+ ### Properties
8
8
 
9
9
  - [assignedExtensions](ExtensionSlotState.md#assignedextensions)
10
10
  - [moduleName](ExtensionSlotState.md#modulename)
11
11
 
12
- ## Extension Properties
12
+ ## Properties
13
13
 
14
14
  ### assignedExtensions
15
15
 
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [packages/framework/esm-extensions/src/store.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L70)
20
+ [packages/framework/esm-extensions/src/store.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L69)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/framework/esm-extensions/src/store.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L69)
30
+ [packages/framework/esm-extensions/src/store.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L68)
package/docs/interfaces/ExtensionStore.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Extension Properties
7
+ ### Properties
8
8
 
9
9
  - [slots](ExtensionStore.md#slots)
10
10
 
11
- ## Extension Properties
11
+ ## Properties
12
12
 
13
13
  ### slots
14
14
 
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [packages/framework/esm-extensions/src/store.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L65)
19
+ [packages/framework/esm-extensions/src/store.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L64)
package/docs/interfaces/FHIRRequestObj.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-api/src/fhir.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L50)
21
+ [packages/framework/esm-api/src/fhir.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L53)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-api/src/fhir.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L49)
31
+ [packages/framework/esm-api/src/fhir.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L52)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-api/src/fhir.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L48)
41
+ [packages/framework/esm-api/src/fhir.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L51)
package/docs/interfaces/MessageServiceWorkerResult.md CHANGED
@@ -10,13 +10,13 @@
10
10
 
11
11
  ## Table of contents
12
12
 
13
- ### Offline Properties
13
+ ### Properties
14
14
 
15
15
  - [error](MessageServiceWorkerResult.md#error)
16
16
  - [result](MessageServiceWorkerResult.md#result)
17
17
  - [success](MessageServiceWorkerResult.md#success)
18
18
 
19
- ## Offline Properties
19
+ ## 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:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L54)
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)
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:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L53)
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)
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:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L52)
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)
package/docs/interfaces/NavigateOptions.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Navigation Properties
7
+ ### Properties
8
8
 
9
9
  - [to](NavigateOptions.md#to)
10
10
 
11
- ## Navigation Properties
11
+ ## 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:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L11)
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)
package/docs/interfaces/NavigationContext.md ADDED
@@ -0,0 +1,50 @@
1
+ [@openmrs/esm-framework](../API.md) / NavigationContext
2
+
3
+ # Interface: NavigationContext
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [type](NavigationContext.md#type)
10
+
11
+ ### Methods
12
+
13
+ - [handler](NavigationContext.md#handler)
14
+
15
+ ## Properties
16
+
17
+ ### type
18
+
19
+ • **type**: [`NavigationContextType`](../API.md#navigationcontexttype)
20
+
21
+ #### Defined in
22
+
23
+ [packages/framework/esm-extensions/src/contexts.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L6)
24
+
25
+ ## Methods
26
+
27
+ ### handler
28
+
29
+ ▸ **handler**<`T`\>(`link`, `state`): `boolean`
30
+
31
+ #### Type parameters
32
+
33
+ | Name | Type |
34
+ | :------ | :------ |
35
+ | `T` | `any` |
36
+
37
+ #### Parameters
38
+
39
+ | Name | Type |
40
+ | :------ | :------ |
41
+ | `link` | `string` |
42
+ | `state` | `T` |
43
+
44
+ #### Returns
45
+
46
+ `boolean`
47
+
48
+ #### Defined in
49
+
50
+ [packages/framework/esm-extensions/src/contexts.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L7)
package/docs/interfaces/NetworkRequestFailedEvent.md ADDED
@@ -0,0 +1,49 @@
1
+ [@openmrs/esm-framework](../API.md) / NetworkRequestFailedEvent
2
+
3
+ # Interface: NetworkRequestFailedEvent
4
+
5
+ ## Hierarchy
6
+
7
+ - [`OmrsServiceWorkerEvent`](OmrsServiceWorkerEvent.md)<``"networkRequestFailed"``\>
8
+
9
+ ↳ **`NetworkRequestFailedEvent`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Properties
14
+
15
+ - [request](NetworkRequestFailedEvent.md#request)
16
+ - [type](NetworkRequestFailedEvent.md#type)
17
+
18
+ ## Properties
19
+
20
+ ### request
21
+
22
+ • **request**: `Object`
23
+
24
+ #### Type declaration
25
+
26
+ | Name | Type |
27
+ | :------ | :------ |
28
+ | `body` | `string` |
29
+ | `headers` | `Record`<`string`, `string`\> |
30
+ | `method` | `string` |
31
+ | `url` | `string` |
32
+
33
+ #### Defined in
34
+
35
+ [packages/framework/esm-offline/src/service-worker-events.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L7)
36
+
37
+ ___
38
+
39
+ ### type
40
+
41
+ • **type**: ``"networkRequestFailed"``
42
+
43
+ #### Inherited from
44
+
45
+ [OmrsServiceWorkerEvent](OmrsServiceWorkerEvent.md).[type](OmrsServiceWorkerEvent.md#type)
46
+
47
+ #### Defined in
48
+
49
+ [packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)
package/docs/interfaces/OfflineModeResult.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Offline Properties
7
+ ### Properties
8
8
 
9
9
  - [active](OfflineModeResult.md#active)
10
10
  - [current](OfflineModeResult.md#current)
11
11
  - [notAvailable](OfflineModeResult.md#notavailable)
12
12
 
13
- ## Offline Properties
13
+ ## 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: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:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L41)
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:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L39)
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:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L40)
package/docs/interfaces/OfflinePatientArgs.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Offline Properties
7
+ ### Properties
8
8
 
9
9
  - [patientUuid](OfflinePatientArgs.md#patientuuid)
10
10
  - [signal](OfflinePatientArgs.md#signal)
11
11
 
12
- ## Offline Properties
12
+ ## 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:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
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)
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:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L75)
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)
package/docs/interfaces/OfflinePatientDataSyncHandler.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Offline Properties
7
+ ### 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
- ## Offline Properties
15
+ ## 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:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L56)
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)
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:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L64)
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)
package/docs/interfaces/OfflinePatientDataSyncState.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Offline Properties
7
+ ### 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
- ## Offline Properties
19
+ ## 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:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L42)
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)
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:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L38)
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)
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:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L33)
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)
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:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L28)
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)
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:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L23)
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)
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:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L48)
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)
package/docs/interfaces/OfflinePatientDataSyncStore.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Offline Properties
7
+ ### Properties
8
8
 
9
9
  - [handlers](OfflinePatientDataSyncStore.md#handlers)
10
10
  - [offlinePatientDataSyncState](OfflinePatientDataSyncStore.md#offlinepatientdatasyncstate)
11
11
 
12
- ## Offline Properties
12
+ ## 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:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
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)
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:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L10)
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)
package/docs/interfaces/OfflineSynchronizationStore.md ADDED
@@ -0,0 +1,30 @@
1
+ [@openmrs/esm-framework](../API.md) / OfflineSynchronizationStore
2
+
3
+ # Interface: OfflineSynchronizationStore
4
+
5
+ Represents the data inside the global offline synchronization store.
6
+ Provides information about a currently ongoing synchronization.
7
+
8
+ ## Table of contents
9
+
10
+ ### Properties
11
+
12
+ - [synchronization](OfflineSynchronizationStore.md#synchronization)
13
+
14
+ ## Properties
15
+
16
+ ### synchronization
17
+
18
+ • `Optional` **synchronization**: `Object`
19
+
20
+ #### Type declaration
21
+
22
+ | Name | Type |
23
+ | :------ | :------ |
24
+ | `abortController` | `AbortController` |
25
+ | `pendingCount` | `number` |
26
+ | `totalCount` | `number` |
27
+
28
+ #### Defined in
29
+
30
+ [packages/framework/esm-offline/src/sync.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L93)
package/docs/interfaces/OmrsServiceWorkerEvent.md ADDED
@@ -0,0 +1,31 @@
1
+ [@openmrs/esm-framework](../API.md) / OmrsServiceWorkerEvent
2
+
3
+ # Interface: OmrsServiceWorkerEvent<TypeIdentifier\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name | Type |
8
+ | :------ | :------ |
9
+ | `TypeIdentifier` | extends `string` |
10
+
11
+ ## Hierarchy
12
+
13
+ - **`OmrsServiceWorkerEvent`**
14
+
15
+ ↳ [`NetworkRequestFailedEvent`](NetworkRequestFailedEvent.md)
16
+
17
+ ## Table of contents
18
+
19
+ ### Properties
20
+
21
+ - [type](OmrsServiceWorkerEvent.md#type)
22
+
23
+ ## Properties
24
+
25
+ ### type
26
+
27
+ • **type**: `TypeIdentifier`
28
+
29
+ #### Defined in
30
+
31
+ [packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)
package/docs/interfaces/OmrsServiceWorkerMessage.md CHANGED
@@ -20,11 +20,11 @@
20
20
 
21
21
  ## Table of contents
22
22
 
23
- ### Offline Properties
23
+ ### Properties
24
24
 
25
25
  - [type](OmrsServiceWorkerMessage.md#type)
26
26
 
27
- ## Offline Properties
27
+ ## 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: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:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)