@openmrs/esm-framework 3.2.1-pre.986 → 3.3.1-pre.1177
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.
- package/.turbo/turbo-build.log +154 -0
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +47 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +1387 -1947
- package/docs/classes/OpenmrsFetchError.md +3 -3
- package/docs/enums/Type.md +11 -0
- package/docs/enums/VisitMode.md +3 -3
- package/docs/enums/VisitStatus.md +2 -2
- package/docs/interfaces/AssignedExtension.md +21 -8
- package/docs/interfaces/BreadcrumbRegistration.md +4 -4
- package/docs/interfaces/BreadcrumbSettings.md +6 -6
- package/docs/interfaces/ClearDynamicRoutesMessage.md +3 -3
- package/docs/interfaces/ConfigSchema.md +3 -3
- package/docs/interfaces/ConfigurableLinkProps.md +3 -3
- package/docs/interfaces/ConnectedExtension.md +18 -5
- package/docs/interfaces/CurrentPatientOptions.md +1 -1
- package/docs/interfaces/ExtensionRegistration.md +9 -15
- package/docs/interfaces/ExtensionSlotConfig.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigObject.md +3 -3
- package/docs/interfaces/ExtensionSlotState.md +5 -5
- package/docs/interfaces/ExtensionStore.md +3 -3
- package/docs/interfaces/FHIRRequestObj.md +3 -3
- package/docs/interfaces/LoggedInUser.md +12 -12
- package/docs/interfaces/LoggedInUserFetchResponse.md +2 -2
- package/docs/interfaces/MessageServiceWorkerResult.md +5 -5
- package/docs/interfaces/NavigateOptions.md +3 -3
- package/docs/interfaces/NotificationDescriptor.md +74 -0
- package/docs/interfaces/OfflineModeResult.md +5 -5
- package/docs/interfaces/OfflinePatientArgs.md +4 -4
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +4 -4
- package/docs/interfaces/OfflinePatientDataSyncState.md +8 -8
- package/docs/interfaces/OfflinePatientDataSyncStore.md +4 -4
- package/docs/interfaces/OmrsServiceWorkerMessage.md +3 -3
- package/docs/interfaces/OnImportMapChangedMessage.md +4 -4
- package/docs/interfaces/OnlyThePatient.md +1 -1
- package/docs/interfaces/PatientWithFullResponse.md +1 -1
- package/docs/interfaces/Person.md +3 -3
- package/docs/interfaces/Privilege.md +4 -4
- package/docs/interfaces/QueueItemDescriptor.md +6 -6
- package/docs/interfaces/RegisterDynamicRouteMessage.md +6 -6
- package/docs/interfaces/RetryOptions.md +3 -3
- package/docs/interfaces/Role.md +3 -3
- package/docs/interfaces/Session.md +92 -0
- package/docs/interfaces/SessionLocation.md +3 -3
- package/docs/interfaces/ShowNotificationEvent.md +5 -5
- package/docs/interfaces/ShowToastEvent.md +4 -4
- package/docs/interfaces/SyncItem.md +9 -9
- package/docs/interfaces/SyncProcessOptions.md +8 -8
- package/docs/interfaces/ToastDescriptor.md +69 -0
- package/docs/interfaces/ToastNotificationMeta.md +100 -0
- package/docs/interfaces/UserHasAccessProps.md +3 -3
- package/docs/interfaces/VisitItem.md +4 -4
- package/jest.config.js +1 -1
- package/mock.tsx +34 -3
- package/package.json +13 -13
- package/src/index.ts +8 -8
- package/src/integration-tests/extension-config.test.tsx +129 -14
- package/src/internal.ts +11 -0
- package/webpack.config.js +10 -2
- package/babel.config.js +0 -7
- package/docs/interfaces/ComponentConfig.md +0 -30
- package/docs/interfaces/ComponentDecoratorOptions.md +0 -52
- package/docs/interfaces/ExtensionInfo.md +0 -140
- package/docs/interfaces/ExtensionInstance.md +0 -19
- package/docs/interfaces/ExtensionInternalStore.md +0 -34
- package/docs/interfaces/ExtensionSlotInfo.md +0 -64
- package/docs/interfaces/NavigationContext.md +0 -50
- package/docs/interfaces/NetworkRequestFailedEvent.md +0 -49
- package/docs/interfaces/OfflineSynchronizationStore.md +0 -30
- package/docs/interfaces/OmrsServiceWorkerEvent.md +0 -31
- package/docs/interfaces/OpenmrsReactComponentProps.md +0 -19
- package/docs/interfaces/OpenmrsReactComponentState.md +0 -41
- package/docs/interfaces/SessionUser.md +0 -92
- package/docs/interfaces/UnauthenticatedUser.md +0 -52
- package/docs/interfaces/User.md +0 -107
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
|
|
11
11
|
## Table of contents
|
|
12
12
|
|
|
13
|
-
### Properties
|
|
13
|
+
### Offline Properties
|
|
14
14
|
|
|
15
15
|
- [pattern](RegisterDynamicRouteMessage.md#pattern)
|
|
16
16
|
- [strategy](RegisterDynamicRouteMessage.md#strategy)
|
|
17
17
|
- [type](RegisterDynamicRouteMessage.md#type)
|
|
18
18
|
- [url](RegisterDynamicRouteMessage.md#url)
|
|
19
19
|
|
|
20
|
-
## Properties
|
|
20
|
+
## Offline Properties
|
|
21
21
|
|
|
22
22
|
### pattern
|
|
23
23
|
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
|
|
26
26
|
#### Defined in
|
|
27
27
|
|
|
28
|
-
[packages/framework/esm-offline/src/service-worker-messaging.ts:
|
|
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)
|
|
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:
|
|
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)
|
|
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:
|
|
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)
|
|
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:
|
|
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)
|
|
@@ -33,7 +33,7 @@ Returning a value for the inital attempt (`0`) delays the initial function invoc
|
|
|
33
33
|
|
|
34
34
|
#### Defined in
|
|
35
35
|
|
|
36
|
-
[packages/framework/esm-utils/src/retry.ts:
|
|
36
|
+
[packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L18)
|
|
37
37
|
|
|
38
38
|
___
|
|
39
39
|
|
|
@@ -57,7 +57,7 @@ Allows running side-effects on errors, e.g. logging.
|
|
|
57
57
|
|
|
58
58
|
#### Defined in
|
|
59
59
|
|
|
60
|
-
[packages/framework/esm-utils/src/retry.ts:
|
|
60
|
+
[packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L25)
|
|
61
61
|
|
|
62
62
|
___
|
|
63
63
|
|
|
@@ -80,4 +80,4 @@ with an error on the current attempt.
|
|
|
80
80
|
|
|
81
81
|
#### Defined in
|
|
82
82
|
|
|
83
|
-
[packages/framework/esm-utils/src/retry.ts:
|
|
83
|
+
[packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L12)
|
package/docs/interfaces/Role.md
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[packages/framework/esm-api/src/types/user-resource.ts:
|
|
21
|
+
[packages/framework/esm-api/src/types/user-resource.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L58)
|
|
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:
|
|
31
|
+
[packages/framework/esm-api/src/types/user-resource.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L59)
|
|
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:
|
|
41
|
+
[packages/framework/esm-api/src/types/user-resource.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L57)
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / Session
|
|
2
|
+
|
|
3
|
+
# Interface: Session
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [allowedLocales](Session.md#allowedlocales)
|
|
10
|
+
- [authenticated](Session.md#authenticated)
|
|
11
|
+
- [currentProvider](Session.md#currentprovider)
|
|
12
|
+
- [locale](Session.md#locale)
|
|
13
|
+
- [sessionId](Session.md#sessionid)
|
|
14
|
+
- [sessionLocation](Session.md#sessionlocation)
|
|
15
|
+
- [user](Session.md#user)
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### allowedLocales
|
|
20
|
+
|
|
21
|
+
• `Optional` **allowedLocales**: `string`[]
|
|
22
|
+
|
|
23
|
+
#### Defined in
|
|
24
|
+
|
|
25
|
+
[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)
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### authenticated
|
|
30
|
+
|
|
31
|
+
• **authenticated**: `boolean`
|
|
32
|
+
|
|
33
|
+
#### Defined in
|
|
34
|
+
|
|
35
|
+
[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)
|
|
36
|
+
|
|
37
|
+
___
|
|
38
|
+
|
|
39
|
+
### currentProvider
|
|
40
|
+
|
|
41
|
+
• `Optional` **currentProvider**: `Object`
|
|
42
|
+
|
|
43
|
+
#### Type declaration
|
|
44
|
+
|
|
45
|
+
| Name | Type |
|
|
46
|
+
| :------ | :------ |
|
|
47
|
+
| `identifier` | `string` |
|
|
48
|
+
| `uuid` | `string` |
|
|
49
|
+
|
|
50
|
+
#### Defined in
|
|
51
|
+
|
|
52
|
+
[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)
|
|
53
|
+
|
|
54
|
+
___
|
|
55
|
+
|
|
56
|
+
### locale
|
|
57
|
+
|
|
58
|
+
• `Optional` **locale**: `string`
|
|
59
|
+
|
|
60
|
+
#### Defined in
|
|
61
|
+
|
|
62
|
+
[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)
|
|
63
|
+
|
|
64
|
+
___
|
|
65
|
+
|
|
66
|
+
### sessionId
|
|
67
|
+
|
|
68
|
+
• **sessionId**: `string`
|
|
69
|
+
|
|
70
|
+
#### Defined in
|
|
71
|
+
|
|
72
|
+
[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)
|
|
73
|
+
|
|
74
|
+
___
|
|
75
|
+
|
|
76
|
+
### sessionLocation
|
|
77
|
+
|
|
78
|
+
• `Optional` **sessionLocation**: [`SessionLocation`](SessionLocation.md)
|
|
79
|
+
|
|
80
|
+
#### Defined in
|
|
81
|
+
|
|
82
|
+
[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)
|
|
83
|
+
|
|
84
|
+
___
|
|
85
|
+
|
|
86
|
+
### user
|
|
87
|
+
|
|
88
|
+
• `Optional` **user**: [`LoggedInUser`](LoggedInUser.md)
|
|
89
|
+
|
|
90
|
+
#### Defined in
|
|
91
|
+
|
|
92
|
+
[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)
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[packages/framework/esm-api/src/types/user-resource.ts:
|
|
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)
|
|
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:
|
|
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)
|
|
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:
|
|
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)
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
#### Defined in
|
|
22
22
|
|
|
23
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
23
|
+
[packages/framework/esm-globals/src/events.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L65)
|
|
24
24
|
|
|
25
25
|
___
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ ___
|
|
|
30
30
|
|
|
31
31
|
#### Defined in
|
|
32
32
|
|
|
33
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
33
|
+
[packages/framework/esm-globals/src/events.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L56)
|
|
34
34
|
|
|
35
35
|
___
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ ___
|
|
|
40
40
|
|
|
41
41
|
#### Defined in
|
|
42
42
|
|
|
43
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
43
|
+
[packages/framework/esm-globals/src/events.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L57)
|
|
44
44
|
|
|
45
45
|
___
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ ___
|
|
|
50
50
|
|
|
51
51
|
#### Defined in
|
|
52
52
|
|
|
53
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
53
|
+
[packages/framework/esm-globals/src/events.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L66)
|
|
54
54
|
|
|
55
55
|
___
|
|
56
56
|
|
|
@@ -60,4 +60,4 @@ ___
|
|
|
60
60
|
|
|
61
61
|
#### Defined in
|
|
62
62
|
|
|
63
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
63
|
+
[packages/framework/esm-globals/src/events.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L64)
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
#### Defined in
|
|
21
21
|
|
|
22
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
22
|
+
[packages/framework/esm-globals/src/events.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L71)
|
|
23
23
|
|
|
24
24
|
___
|
|
25
25
|
|
|
@@ -29,7 +29,7 @@ ___
|
|
|
29
29
|
|
|
30
30
|
#### Defined in
|
|
31
31
|
|
|
32
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
32
|
+
[packages/framework/esm-globals/src/events.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L72)
|
|
33
33
|
|
|
34
34
|
___
|
|
35
35
|
|
|
@@ -39,7 +39,7 @@ ___
|
|
|
39
39
|
|
|
40
40
|
#### Defined in
|
|
41
41
|
|
|
42
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
42
|
+
[packages/framework/esm-globals/src/events.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L80)
|
|
43
43
|
|
|
44
44
|
___
|
|
45
45
|
|
|
@@ -49,4 +49,4 @@ ___
|
|
|
49
49
|
|
|
50
50
|
#### Defined in
|
|
51
51
|
|
|
52
|
-
[packages/framework/esm-globals/src/events.ts:
|
|
52
|
+
[packages/framework/esm-globals/src/events.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L79)
|
|
@@ -14,7 +14,7 @@ actual data to be synchronized (i.e. the item's `content`).
|
|
|
14
14
|
|
|
15
15
|
## Table of contents
|
|
16
16
|
|
|
17
|
-
### Properties
|
|
17
|
+
### Offline Properties
|
|
18
18
|
|
|
19
19
|
- [content](SyncItem.md#content)
|
|
20
20
|
- [createdOn](SyncItem.md#createdon)
|
|
@@ -24,7 +24,7 @@ actual data to be synchronized (i.e. the item's `content`).
|
|
|
24
24
|
- [type](SyncItem.md#type)
|
|
25
25
|
- [userId](SyncItem.md#userid)
|
|
26
26
|
|
|
27
|
-
## Properties
|
|
27
|
+
## Offline Properties
|
|
28
28
|
|
|
29
29
|
### content
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ actual data to be synchronized (i.e. the item's `content`).
|
|
|
32
32
|
|
|
33
33
|
#### Defined in
|
|
34
34
|
|
|
35
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
35
|
+
[packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L15)
|
|
36
36
|
|
|
37
37
|
___
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ ___
|
|
|
42
42
|
|
|
43
43
|
#### Defined in
|
|
44
44
|
|
|
45
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
45
|
+
[packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L16)
|
|
46
46
|
|
|
47
47
|
___
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ ___
|
|
|
52
52
|
|
|
53
53
|
#### Defined in
|
|
54
54
|
|
|
55
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
55
|
+
[packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L17)
|
|
56
56
|
|
|
57
57
|
___
|
|
58
58
|
|
|
@@ -62,7 +62,7 @@ ___
|
|
|
62
62
|
|
|
63
63
|
#### Defined in
|
|
64
64
|
|
|
65
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
65
|
+
[packages/framework/esm-offline/src/sync.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L12)
|
|
66
66
|
|
|
67
67
|
___
|
|
68
68
|
|
|
@@ -79,7 +79,7 @@ ___
|
|
|
79
79
|
|
|
80
80
|
#### Defined in
|
|
81
81
|
|
|
82
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
82
|
+
[packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L18)
|
|
83
83
|
|
|
84
84
|
___
|
|
85
85
|
|
|
@@ -89,7 +89,7 @@ ___
|
|
|
89
89
|
|
|
90
90
|
#### Defined in
|
|
91
91
|
|
|
92
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
92
|
+
[packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L14)
|
|
93
93
|
|
|
94
94
|
___
|
|
95
95
|
|
|
@@ -99,4 +99,4 @@ ___
|
|
|
99
99
|
|
|
100
100
|
#### Defined in
|
|
101
101
|
|
|
102
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
102
|
+
[packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L13)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: SyncProcessOptions<T\>
|
|
4
4
|
|
|
5
|
-
Additional data which can be used for synchronizing data in a
|
|
5
|
+
Additional data which can be used for synchronizing data in a {@link ProcessSyncItem} function.
|
|
6
6
|
|
|
7
7
|
## Type parameters
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ Additional data which can be used for synchronizing data in a [ProcessSyncItem](
|
|
|
12
12
|
|
|
13
13
|
## Table of contents
|
|
14
14
|
|
|
15
|
-
### Properties
|
|
15
|
+
### Offline Properties
|
|
16
16
|
|
|
17
17
|
- [abort](SyncProcessOptions.md#abort)
|
|
18
18
|
- [dependencies](SyncProcessOptions.md#dependencies)
|
|
@@ -20,7 +20,7 @@ Additional data which can be used for synchronizing data in a [ProcessSyncItem](
|
|
|
20
20
|
- [items](SyncProcessOptions.md#items)
|
|
21
21
|
- [userId](SyncProcessOptions.md#userid)
|
|
22
22
|
|
|
23
|
-
## Properties
|
|
23
|
+
## Offline Properties
|
|
24
24
|
|
|
25
25
|
### abort
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ Additional data which can be used for synchronizing data in a [ProcessSyncItem](
|
|
|
28
28
|
|
|
29
29
|
#### Defined in
|
|
30
30
|
|
|
31
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
31
|
+
[packages/framework/esm-offline/src/sync.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L55)
|
|
32
32
|
|
|
33
33
|
___
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ ___
|
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
41
|
+
[packages/framework/esm-offline/src/sync.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L59)
|
|
42
42
|
|
|
43
43
|
___
|
|
44
44
|
|
|
@@ -48,7 +48,7 @@ ___
|
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
51
|
+
[packages/framework/esm-offline/src/sync.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L57)
|
|
52
52
|
|
|
53
53
|
___
|
|
54
54
|
|
|
@@ -58,7 +58,7 @@ ___
|
|
|
58
58
|
|
|
59
59
|
#### Defined in
|
|
60
60
|
|
|
61
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
61
|
+
[packages/framework/esm-offline/src/sync.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L58)
|
|
62
62
|
|
|
63
63
|
___
|
|
64
64
|
|
|
@@ -68,4 +68,4 @@ ___
|
|
|
68
68
|
|
|
69
69
|
#### Defined in
|
|
70
70
|
|
|
71
|
-
[packages/framework/esm-offline/src/sync.ts:
|
|
71
|
+
[packages/framework/esm-offline/src/sync.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L56)
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ToastDescriptor
|
|
2
|
+
|
|
3
|
+
# Interface: ToastDescriptor
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- **`ToastDescriptor`**
|
|
8
|
+
|
|
9
|
+
↳ [`ToastNotificationMeta`](ToastNotificationMeta.md)
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### UI Properties
|
|
14
|
+
|
|
15
|
+
- [critical](ToastDescriptor.md#critical)
|
|
16
|
+
- [description](ToastDescriptor.md#description)
|
|
17
|
+
- [kind](ToastDescriptor.md#kind)
|
|
18
|
+
- [millis](ToastDescriptor.md#millis)
|
|
19
|
+
- [title](ToastDescriptor.md#title)
|
|
20
|
+
|
|
21
|
+
## UI Properties
|
|
22
|
+
|
|
23
|
+
### critical
|
|
24
|
+
|
|
25
|
+
• `Optional` **critical**: `boolean`
|
|
26
|
+
|
|
27
|
+
#### Defined in
|
|
28
|
+
|
|
29
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
|
|
30
|
+
|
|
31
|
+
___
|
|
32
|
+
|
|
33
|
+
### description
|
|
34
|
+
|
|
35
|
+
• **description**: `ReactNode`
|
|
36
|
+
|
|
37
|
+
#### Defined in
|
|
38
|
+
|
|
39
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### kind
|
|
44
|
+
|
|
45
|
+
• `Optional` **kind**: [`ToastType`](../API.md#toasttype)
|
|
46
|
+
|
|
47
|
+
#### Defined in
|
|
48
|
+
|
|
49
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
|
|
50
|
+
|
|
51
|
+
___
|
|
52
|
+
|
|
53
|
+
### millis
|
|
54
|
+
|
|
55
|
+
• `Optional` **millis**: `number`
|
|
56
|
+
|
|
57
|
+
#### Defined in
|
|
58
|
+
|
|
59
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
|
|
60
|
+
|
|
61
|
+
___
|
|
62
|
+
|
|
63
|
+
### title
|
|
64
|
+
|
|
65
|
+
• `Optional` **title**: `string`
|
|
66
|
+
|
|
67
|
+
#### Defined in
|
|
68
|
+
|
|
69
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ToastNotificationMeta
|
|
2
|
+
|
|
3
|
+
# Interface: ToastNotificationMeta
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`ToastDescriptor`](ToastDescriptor.md)
|
|
8
|
+
|
|
9
|
+
↳ **`ToastNotificationMeta`**
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### UI Properties
|
|
14
|
+
|
|
15
|
+
- [critical](ToastNotificationMeta.md#critical)
|
|
16
|
+
- [description](ToastNotificationMeta.md#description)
|
|
17
|
+
- [id](ToastNotificationMeta.md#id)
|
|
18
|
+
- [kind](ToastNotificationMeta.md#kind)
|
|
19
|
+
- [millis](ToastNotificationMeta.md#millis)
|
|
20
|
+
- [title](ToastNotificationMeta.md#title)
|
|
21
|
+
|
|
22
|
+
## UI Properties
|
|
23
|
+
|
|
24
|
+
### critical
|
|
25
|
+
|
|
26
|
+
• `Optional` **critical**: `boolean`
|
|
27
|
+
|
|
28
|
+
#### Inherited from
|
|
29
|
+
|
|
30
|
+
[ToastDescriptor](ToastDescriptor.md).[critical](ToastDescriptor.md#critical)
|
|
31
|
+
|
|
32
|
+
#### Defined in
|
|
33
|
+
|
|
34
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
|
|
35
|
+
|
|
36
|
+
___
|
|
37
|
+
|
|
38
|
+
### description
|
|
39
|
+
|
|
40
|
+
• **description**: `ReactNode`
|
|
41
|
+
|
|
42
|
+
#### Inherited from
|
|
43
|
+
|
|
44
|
+
[ToastDescriptor](ToastDescriptor.md).[description](ToastDescriptor.md#description)
|
|
45
|
+
|
|
46
|
+
#### Defined in
|
|
47
|
+
|
|
48
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
|
|
49
|
+
|
|
50
|
+
___
|
|
51
|
+
|
|
52
|
+
### id
|
|
53
|
+
|
|
54
|
+
• **id**: `number`
|
|
55
|
+
|
|
56
|
+
#### Defined in
|
|
57
|
+
|
|
58
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L23)
|
|
59
|
+
|
|
60
|
+
___
|
|
61
|
+
|
|
62
|
+
### kind
|
|
63
|
+
|
|
64
|
+
• `Optional` **kind**: [`ToastType`](../API.md#toasttype)
|
|
65
|
+
|
|
66
|
+
#### Inherited from
|
|
67
|
+
|
|
68
|
+
[ToastDescriptor](ToastDescriptor.md).[kind](ToastDescriptor.md#kind)
|
|
69
|
+
|
|
70
|
+
#### Defined in
|
|
71
|
+
|
|
72
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
|
|
73
|
+
|
|
74
|
+
___
|
|
75
|
+
|
|
76
|
+
### millis
|
|
77
|
+
|
|
78
|
+
• `Optional` **millis**: `number`
|
|
79
|
+
|
|
80
|
+
#### Inherited from
|
|
81
|
+
|
|
82
|
+
[ToastDescriptor](ToastDescriptor.md).[millis](ToastDescriptor.md#millis)
|
|
83
|
+
|
|
84
|
+
#### Defined in
|
|
85
|
+
|
|
86
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
|
|
87
|
+
|
|
88
|
+
___
|
|
89
|
+
|
|
90
|
+
### title
|
|
91
|
+
|
|
92
|
+
• `Optional` **title**: `string`
|
|
93
|
+
|
|
94
|
+
#### Inherited from
|
|
95
|
+
|
|
96
|
+
[ToastDescriptor](ToastDescriptor.md).[title](ToastDescriptor.md#title)
|
|
97
|
+
|
|
98
|
+
#### Defined in
|
|
99
|
+
|
|
100
|
+
[packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
## Table of contents
|
|
6
6
|
|
|
7
|
-
### Properties
|
|
7
|
+
### API Properties
|
|
8
8
|
|
|
9
9
|
- [privilege](UserHasAccessProps.md#privilege)
|
|
10
10
|
|
|
11
|
-
## Properties
|
|
11
|
+
## API Properties
|
|
12
12
|
|
|
13
13
|
### privilege
|
|
14
14
|
|
|
@@ -16,4 +16,4 @@
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[packages/framework/esm-react-utils/src/UserHasAccess.tsx:
|
|
19
|
+
[packages/framework/esm-react-utils/src/UserHasAccess.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L6)
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
#### Defined in
|
|
21
21
|
|
|
22
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:
|
|
22
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L80)
|
|
23
23
|
|
|
24
24
|
___
|
|
25
25
|
|
|
@@ -29,7 +29,7 @@ ___
|
|
|
29
29
|
|
|
30
30
|
#### Defined in
|
|
31
31
|
|
|
32
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:
|
|
32
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L77)
|
|
33
33
|
|
|
34
34
|
___
|
|
35
35
|
|
|
@@ -39,7 +39,7 @@ ___
|
|
|
39
39
|
|
|
40
40
|
#### Defined in
|
|
41
41
|
|
|
42
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:
|
|
42
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L79)
|
|
43
43
|
|
|
44
44
|
___
|
|
45
45
|
|
|
@@ -49,4 +49,4 @@ ___
|
|
|
49
49
|
|
|
50
50
|
#### Defined in
|
|
51
51
|
|
|
52
|
-
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:
|
|
52
|
+
[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L78)
|