@openmrs/esm-framework 4.0.0-pre.1 → 4.0.1-pre.204
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 +23 -119
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -22
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +330 -774
- package/docs/classes/OpenmrsFetchError.md +4 -10
- package/docs/enums/Type.md +20 -20
- package/docs/enums/VisitMode.md +8 -8
- package/docs/enums/VisitStatus.md +6 -6
- package/docs/interfaces/AssignedExtension.md +7 -9
- package/docs/interfaces/BreadcrumbRegistration.md +2 -2
- package/docs/interfaces/BreadcrumbSettings.md +4 -22
- package/docs/interfaces/CancelLoading.md +1 -1
- package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
- package/docs/interfaces/ComponentDefinition.md +7 -19
- package/docs/interfaces/Config.md +3 -17
- package/docs/interfaces/ConfigObject.md +14 -17
- package/docs/interfaces/ConfigSchema.md +3 -3
- package/docs/interfaces/ConfigurableLinkProps.md +2 -2
- package/docs/interfaces/ConnectedExtension.md +4 -6
- package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
- package/docs/interfaces/CurrentPatientOptions.md +1 -1
- package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
- package/docs/interfaces/DynamicOfflineData.md +5 -20
- package/docs/interfaces/DynamicOfflineDataHandler.md +9 -26
- package/docs/interfaces/DynamicOfflineDataSyncState.md +5 -17
- package/docs/interfaces/ErrorStateProps.md +2 -2
- package/docs/interfaces/ExtensionData.md +3 -3
- package/docs/interfaces/ExtensionDefinition.md +13 -37
- package/docs/interfaces/ExtensionProps.md +2 -2
- package/docs/interfaces/ExtensionRegistration.md +18 -7
- package/docs/interfaces/ExtensionSlotBaseProps.md +15 -4
- package/docs/interfaces/ExtensionSlotConfig.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
- package/docs/interfaces/ExtensionSlotState.md +2 -2
- package/docs/interfaces/ExtensionStore.md +1 -1
- package/docs/interfaces/FHIRCode.md +3 -3
- package/docs/interfaces/FHIRRequestObj.md +3 -3
- package/docs/interfaces/FHIRRequestOptions.md +41 -0
- package/docs/interfaces/FHIRResource.md +1 -1
- package/docs/interfaces/FetchResponse.md +1 -1
- package/docs/interfaces/FetchResponseJson.md +7 -0
- package/docs/interfaces/ImportMap.md +1 -1
- package/docs/interfaces/Lifecycle.md +4 -4
- package/docs/interfaces/Location.md +3 -3
- package/docs/interfaces/LoggedInUser.md +11 -11
- package/docs/interfaces/LoggedInUserFetchResponse.md +1 -1
- package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
- package/docs/interfaces/NavigateOptions.md +2 -2
- package/docs/interfaces/NewVisitPayload.md +6 -6
- package/docs/interfaces/NotificationDescriptor.md +6 -6
- package/docs/interfaces/OfflineModeResult.md +3 -3
- package/docs/interfaces/OfflinePatientArgs.md +2 -4
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +2 -4
- package/docs/interfaces/OfflinePatientDataSyncState.md +6 -8
- package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -4
- package/docs/interfaces/OldExtensionSlotBaseProps.md +65 -0
- package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
- package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
- package/docs/interfaces/OnlyThePatient.md +1 -1
- package/docs/interfaces/OpenmrsResource.md +2 -2
- package/docs/interfaces/PageDefinition.md +9 -25
- package/docs/interfaces/PatientWithFullResponse.md +1 -1
- package/docs/interfaces/Person.md +3 -3
- package/docs/interfaces/Privilege.md +3 -3
- package/docs/interfaces/QueueItemDescriptor.md +4 -9
- package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
- package/docs/interfaces/ResourceLoader.md +1 -1
- package/docs/interfaces/RetryOptions.md +7 -18
- package/docs/interfaces/Role.md +3 -3
- package/docs/interfaces/Session.md +7 -7
- package/docs/interfaces/SessionLocation.md +3 -3
- package/docs/interfaces/ShowNotificationEvent.md +5 -5
- package/docs/interfaces/ShowToastEvent.md +4 -4
- package/docs/interfaces/SpaConfig.md +5 -19
- package/docs/interfaces/SyncItem.md +7 -11
- package/docs/interfaces/SyncProcessOptions.md +5 -7
- package/docs/interfaces/ToastDescriptor.md +5 -5
- package/docs/interfaces/ToastNotificationMeta.md +6 -6
- package/docs/interfaces/UserHasAccessProps.md +4 -4
- package/docs/interfaces/Visit.md +9 -9
- package/docs/interfaces/VisitItem.md +4 -4
- package/docs/interfaces/VisitType.md +3 -3
- package/jest.config.js +3 -0
- package/mock.tsx +3 -7
- package/package.json +13 -13
- package/src/integration-tests/extension-config.test.tsx +215 -17
- package/typedoc.json +1 -1
- package/.turbo/turbo-lint.log +0 -2
- package/.turbo/turbo-test.log +0 -451
- package/.turbo/turbo-typescript.log +0 -2
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
|
|
23
23
|
#### Defined in
|
|
24
24
|
|
|
25
|
-
[packages/framework/esm-config/src/types.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
25
|
+
[packages/framework/esm-config/src/types.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L21)
|
|
26
26
|
|
|
27
27
|
___
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ ___
|
|
|
32
32
|
|
|
33
33
|
#### Defined in
|
|
34
34
|
|
|
35
|
-
[packages/framework/esm-config/src/types.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
35
|
+
[packages/framework/esm-config/src/types.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L19)
|
|
36
36
|
|
|
37
37
|
___
|
|
38
38
|
|
|
@@ -42,4 +42,4 @@ ___
|
|
|
42
42
|
|
|
43
43
|
#### Defined in
|
|
44
44
|
|
|
45
|
-
[packages/framework/esm-config/src/types.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
45
|
+
[packages/framework/esm-config/src/types.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L20)
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
|
|
24
24
|
#### Defined in
|
|
25
25
|
|
|
26
|
-
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
26
|
+
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L27)
|
|
27
27
|
|
|
28
28
|
___
|
|
29
29
|
|
|
@@ -33,4 +33,4 @@ ___
|
|
|
33
33
|
|
|
34
34
|
#### Defined in
|
|
35
35
|
|
|
36
|
-
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
36
|
+
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L26)
|
|
@@ -17,11 +17,9 @@
|
|
|
17
17
|
|
|
18
18
|
• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
|
|
19
19
|
|
|
20
|
-
The extension's config. Note that this will be `null` until the slot is mounted.
|
|
21
|
-
|
|
22
20
|
#### Defined in
|
|
23
21
|
|
|
24
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
22
|
+
[packages/framework/esm-extensions/src/store.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L90)
|
|
25
23
|
|
|
26
24
|
___
|
|
27
25
|
|
|
@@ -31,7 +29,7 @@ ___
|
|
|
31
29
|
|
|
32
30
|
#### Defined in
|
|
33
31
|
|
|
34
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
32
|
+
[packages/framework/esm-extensions/src/store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L86)
|
|
35
33
|
|
|
36
34
|
___
|
|
37
35
|
|
|
@@ -41,7 +39,7 @@ ___
|
|
|
41
39
|
|
|
42
40
|
#### Defined in
|
|
43
41
|
|
|
44
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
42
|
+
[packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L88)
|
|
45
43
|
|
|
46
44
|
___
|
|
47
45
|
|
|
@@ -51,4 +49,4 @@ ___
|
|
|
51
49
|
|
|
52
50
|
#### Defined in
|
|
53
51
|
|
|
54
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
52
|
+
[packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L87)
|
|
@@ -16,4 +16,4 @@
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
19
|
+
[packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L2)
|
|
@@ -24,4 +24,4 @@
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
27
|
+
[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L8)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / DisplayConditionsConfigObject
|
|
2
|
+
|
|
3
|
+
# Interface: DisplayConditionsConfigObject
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [privileges](DisplayConditionsConfigObject.md#privileges)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### privileges
|
|
14
|
+
|
|
15
|
+
• `Optional` **privileges**: `string`[]
|
|
16
|
+
|
|
17
|
+
#### Defined in
|
|
18
|
+
|
|
19
|
+
[packages/framework/esm-config/src/types.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L34)
|
|
@@ -2,8 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: DynamicOfflineData
|
|
4
4
|
|
|
5
|
-
Represents the registration of a single dynamic offline data entry.
|
|
6
|
-
|
|
7
5
|
## Table of contents
|
|
8
6
|
|
|
9
7
|
### Offline Properties
|
|
@@ -20,11 +18,9 @@ Represents the registration of a single dynamic offline data entry.
|
|
|
20
18
|
|
|
21
19
|
• `Optional` **id**: `number`
|
|
22
20
|
|
|
23
|
-
The internal ID of the data entry, as assigned by the IndexedDB where it is stored.
|
|
24
|
-
|
|
25
21
|
#### Defined in
|
|
26
22
|
|
|
27
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
23
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48)
|
|
28
24
|
|
|
29
25
|
___
|
|
30
26
|
|
|
@@ -32,12 +28,9 @@ ___
|
|
|
32
28
|
|
|
33
29
|
• **identifier**: `string`
|
|
34
30
|
|
|
35
|
-
The externally provided identifier of the data entry.
|
|
36
|
-
This is typically the ID of the resource as assigned by a remote API.
|
|
37
|
-
|
|
38
31
|
#### Defined in
|
|
39
32
|
|
|
40
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
33
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58)
|
|
41
34
|
|
|
42
35
|
___
|
|
43
36
|
|
|
@@ -45,12 +38,9 @@ ___
|
|
|
45
38
|
|
|
46
39
|
• `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
|
|
47
40
|
|
|
48
|
-
If this entry has already been synced, returns the result of that last sync attempt.
|
|
49
|
-
Otherwise this is `undefined`.
|
|
50
|
-
|
|
51
41
|
#### Defined in
|
|
52
42
|
|
|
53
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
43
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67)
|
|
54
44
|
|
|
55
45
|
___
|
|
56
46
|
|
|
@@ -58,12 +48,9 @@ ___
|
|
|
58
48
|
|
|
59
49
|
• **type**: `string`
|
|
60
50
|
|
|
61
|
-
The underlying type used for categorizing the data entry.
|
|
62
|
-
Examples could be `"patient"` or `"form"`.
|
|
63
|
-
|
|
64
51
|
#### Defined in
|
|
65
52
|
|
|
66
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
53
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53)
|
|
67
54
|
|
|
68
55
|
___
|
|
69
56
|
|
|
@@ -71,8 +58,6 @@ ___
|
|
|
71
58
|
|
|
72
59
|
• **users**: `string`[]
|
|
73
60
|
|
|
74
|
-
The UUIDs of the users who need this data entry available offline.
|
|
75
|
-
|
|
76
61
|
#### Defined in
|
|
77
62
|
|
|
78
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
63
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)
|
|
@@ -2,9 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: DynamicOfflineDataHandler
|
|
4
4
|
|
|
5
|
-
A handler for synchronizing dynamically declared offline data.
|
|
6
|
-
Can be setup using the [setupDynamicOfflineDataHandler](../API.md#setupdynamicofflinedatahandler) function.
|
|
7
|
-
|
|
8
5
|
## Table of contents
|
|
9
6
|
|
|
10
7
|
### Offline Properties
|
|
@@ -24,12 +21,9 @@ Can be setup using the [setupDynamicOfflineDataHandler](../API.md#setupdynamicof
|
|
|
24
21
|
|
|
25
22
|
• `Optional` **displayName**: `string`
|
|
26
23
|
|
|
27
|
-
A human-readable string representing the handler.
|
|
28
|
-
If provided, the handler can be rendered in the UI using that string.
|
|
29
|
-
|
|
30
24
|
#### Defined in
|
|
31
25
|
|
|
32
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
26
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L24)
|
|
33
27
|
|
|
34
28
|
___
|
|
35
29
|
|
|
@@ -37,11 +31,9 @@ ___
|
|
|
37
31
|
|
|
38
32
|
• **id**: `string`
|
|
39
33
|
|
|
40
|
-
A string uniquely identifying the handler.
|
|
41
|
-
|
|
42
34
|
#### Defined in
|
|
43
35
|
|
|
44
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
36
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
|
|
45
37
|
|
|
46
38
|
___
|
|
47
39
|
|
|
@@ -49,12 +41,9 @@ ___
|
|
|
49
41
|
|
|
50
42
|
• **type**: `string`
|
|
51
43
|
|
|
52
|
-
The type of offline data handled by this handler.
|
|
53
|
-
See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
|
|
54
|
-
|
|
55
44
|
#### Defined in
|
|
56
45
|
|
|
57
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
46
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L19)
|
|
58
47
|
|
|
59
48
|
## Methods
|
|
60
49
|
|
|
@@ -62,16 +51,12 @@ See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
|
|
|
62
51
|
|
|
63
52
|
▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
|
|
64
53
|
|
|
65
|
-
Evaluates whether the given offline data is correctly synced at this point in time from the perspective
|
|
66
|
-
of this single handler.
|
|
67
|
-
If `false`, the handler would have to (re-)sync the data in order for offline mode to properly work.
|
|
68
|
-
|
|
69
54
|
#### Parameters
|
|
70
55
|
|
|
71
56
|
| Name | Type | Description |
|
|
72
57
|
| :------ | :------ | :------ |
|
|
73
|
-
| `identifier` | `string` |
|
|
74
|
-
| `abortSignal?` | `AbortSignal` |
|
|
58
|
+
| `identifier` | `string` | |
|
|
59
|
+
| `abortSignal?` | `AbortSignal` | |
|
|
75
60
|
|
|
76
61
|
#### Returns
|
|
77
62
|
|
|
@@ -79,7 +64,7 @@ If `false`, the handler would have to (re-)sync the data in order for offline mo
|
|
|
79
64
|
|
|
80
65
|
#### Defined in
|
|
81
66
|
|
|
82
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
67
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L32)
|
|
83
68
|
|
|
84
69
|
___
|
|
85
70
|
|
|
@@ -87,14 +72,12 @@ ___
|
|
|
87
72
|
|
|
88
73
|
▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
|
|
89
74
|
|
|
90
|
-
Synchronizes the given offline data.
|
|
91
|
-
|
|
92
75
|
#### Parameters
|
|
93
76
|
|
|
94
77
|
| Name | Type | Description |
|
|
95
78
|
| :------ | :------ | :------ |
|
|
96
|
-
| `identifier` | `string` |
|
|
97
|
-
| `abortSignal?` | `AbortSignal` |
|
|
79
|
+
| `identifier` | `string` | |
|
|
80
|
+
| `abortSignal?` | `AbortSignal` | |
|
|
98
81
|
|
|
99
82
|
#### Returns
|
|
100
83
|
|
|
@@ -102,4 +85,4 @@ Synchronizes the given offline data.
|
|
|
102
85
|
|
|
103
86
|
#### Defined in
|
|
104
87
|
|
|
105
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
88
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L38)
|
|
@@ -2,8 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: DynamicOfflineDataSyncState
|
|
4
4
|
|
|
5
|
-
Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData.md) entry.
|
|
6
|
-
|
|
7
5
|
## Table of contents
|
|
8
6
|
|
|
9
7
|
### Offline Properties
|
|
@@ -20,11 +18,9 @@ Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData
|
|
|
20
18
|
|
|
21
19
|
• **erroredHandlers**: `string`[]
|
|
22
20
|
|
|
23
|
-
The IDs of the handlers which failed to synchronize their data.
|
|
24
|
-
|
|
25
21
|
#### Defined in
|
|
26
22
|
|
|
27
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
23
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L89)
|
|
28
24
|
|
|
29
25
|
___
|
|
30
26
|
|
|
@@ -32,11 +28,9 @@ ___
|
|
|
32
28
|
|
|
33
29
|
• **errors**: { `handlerId`: `string` ; `message`: `string` }[]
|
|
34
30
|
|
|
35
|
-
A collection of the errors caught while synchronizing, per handler.
|
|
36
|
-
|
|
37
31
|
#### Defined in
|
|
38
32
|
|
|
39
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
33
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L93)
|
|
40
34
|
|
|
41
35
|
___
|
|
42
36
|
|
|
@@ -44,11 +38,9 @@ ___
|
|
|
44
38
|
|
|
45
39
|
• **succeededHandlers**: `string`[]
|
|
46
40
|
|
|
47
|
-
The IDs of the handlers which successfully synchronized their data.
|
|
48
|
-
|
|
49
41
|
#### Defined in
|
|
50
42
|
|
|
51
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
43
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L85)
|
|
52
44
|
|
|
53
45
|
___
|
|
54
46
|
|
|
@@ -56,11 +48,9 @@ ___
|
|
|
56
48
|
|
|
57
49
|
• **syncedBy**: `string`
|
|
58
50
|
|
|
59
|
-
The ID of the user who has triggered the data synchronization.
|
|
60
|
-
|
|
61
51
|
#### Defined in
|
|
62
52
|
|
|
63
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
53
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L81)
|
|
64
54
|
|
|
65
55
|
___
|
|
66
56
|
|
|
@@ -68,8 +58,6 @@ ___
|
|
|
68
58
|
|
|
69
59
|
• **syncedOn**: `Date`
|
|
70
60
|
|
|
71
|
-
The time when the entry has been synced the last time.
|
|
72
|
-
|
|
73
61
|
#### Defined in
|
|
74
62
|
|
|
75
|
-
[packages/framework/esm-offline/src/dynamic-offline-data.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
63
|
+
[packages/framework/esm-offline/src/dynamic-offline-data.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L77)
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
#### Defined in
|
|
19
19
|
|
|
20
|
-
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
20
|
+
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L8)
|
|
21
21
|
|
|
22
22
|
___
|
|
23
23
|
|
|
@@ -27,4 +27,4 @@ ___
|
|
|
27
27
|
|
|
28
28
|
#### Defined in
|
|
29
29
|
|
|
30
|
-
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
30
|
+
[packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
#### Defined in
|
|
20
20
|
|
|
21
|
-
[packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
21
|
+
[packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
|
|
22
22
|
|
|
23
23
|
___
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ ___
|
|
|
28
28
|
|
|
29
29
|
#### Defined in
|
|
30
30
|
|
|
31
|
-
[packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
31
|
+
[packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
|
|
32
32
|
|
|
33
33
|
___
|
|
34
34
|
|
|
@@ -38,4 +38,4 @@ ___
|
|
|
38
38
|
|
|
39
39
|
#### Defined in
|
|
40
40
|
|
|
41
|
-
[packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
41
|
+
[packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)
|
|
@@ -34,15 +34,13 @@
|
|
|
34
34
|
|
|
35
35
|
• **appName**: `string`
|
|
36
36
|
|
|
37
|
-
The module/app that defines the component
|
|
38
|
-
|
|
39
37
|
#### Inherited from
|
|
40
38
|
|
|
41
39
|
[ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
|
|
42
40
|
|
|
43
41
|
#### Defined in
|
|
44
42
|
|
|
45
|
-
[packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
43
|
+
[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)
|
|
46
44
|
|
|
47
45
|
___
|
|
48
46
|
|
|
@@ -50,11 +48,9 @@ ___
|
|
|
50
48
|
|
|
51
49
|
• `Optional` **id**: `string`
|
|
52
50
|
|
|
53
|
-
**`deprecated`** A confusing way to specify the name of the extension
|
|
54
|
-
|
|
55
51
|
#### Defined in
|
|
56
52
|
|
|
57
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
53
|
+
[packages/framework/esm-globals/src/types.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L135)
|
|
58
54
|
|
|
59
55
|
___
|
|
60
56
|
|
|
@@ -62,11 +58,9 @@ ___
|
|
|
62
58
|
|
|
63
59
|
• `Optional` **meta**: `Record`<`string`, `any`\>
|
|
64
60
|
|
|
65
|
-
The meta data used for reflection by other components
|
|
66
|
-
|
|
67
61
|
#### Defined in
|
|
68
62
|
|
|
69
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
63
|
+
[packages/framework/esm-globals/src/types.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L131)
|
|
70
64
|
|
|
71
65
|
___
|
|
72
66
|
|
|
@@ -74,11 +68,9 @@ ___
|
|
|
74
68
|
|
|
75
69
|
• **name**: `string`
|
|
76
70
|
|
|
77
|
-
The name of the extension being registered
|
|
78
|
-
|
|
79
71
|
#### Defined in
|
|
80
72
|
|
|
81
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
73
|
+
[packages/framework/esm-globals/src/types.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L125)
|
|
82
74
|
|
|
83
75
|
___
|
|
84
76
|
|
|
@@ -86,15 +78,13 @@ ___
|
|
|
86
78
|
|
|
87
79
|
• `Optional` **offline**: `boolean` \| `object`
|
|
88
80
|
|
|
89
|
-
Defines the offline support / properties of the component.
|
|
90
|
-
|
|
91
81
|
#### Inherited from
|
|
92
82
|
|
|
93
83
|
[ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
|
|
94
84
|
|
|
95
85
|
#### Defined in
|
|
96
86
|
|
|
97
|
-
[packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
87
|
+
[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)
|
|
98
88
|
|
|
99
89
|
___
|
|
100
90
|
|
|
@@ -102,15 +92,13 @@ ___
|
|
|
102
92
|
|
|
103
93
|
• `Optional` **online**: `boolean` \| `object`
|
|
104
94
|
|
|
105
|
-
Defines the online support / properties of the component.
|
|
106
|
-
|
|
107
95
|
#### Inherited from
|
|
108
96
|
|
|
109
97
|
[ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
|
|
110
98
|
|
|
111
99
|
#### Defined in
|
|
112
100
|
|
|
113
|
-
[packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
101
|
+
[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)
|
|
114
102
|
|
|
115
103
|
___
|
|
116
104
|
|
|
@@ -118,19 +106,15 @@ ___
|
|
|
118
106
|
|
|
119
107
|
• `Optional` **order**: `number`
|
|
120
108
|
|
|
121
|
-
Specifies the relative order in which the extension renders in a slot
|
|
122
|
-
|
|
123
109
|
#### Defined in
|
|
124
110
|
|
|
125
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
111
|
+
[packages/framework/esm-globals/src/types.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L133)
|
|
126
112
|
|
|
127
113
|
___
|
|
128
114
|
|
|
129
115
|
### privilege
|
|
130
116
|
|
|
131
|
-
• `Optional` **privilege**: `string`
|
|
132
|
-
|
|
133
|
-
Defines the access privilege required for this component, if any.
|
|
117
|
+
• `Optional` **privilege**: `string` \| `string`[]
|
|
134
118
|
|
|
135
119
|
#### Inherited from
|
|
136
120
|
|
|
@@ -138,7 +122,7 @@ Defines the access privilege required for this component, if any.
|
|
|
138
122
|
|
|
139
123
|
#### Defined in
|
|
140
124
|
|
|
141
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
125
|
+
[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)
|
|
142
126
|
|
|
143
127
|
___
|
|
144
128
|
|
|
@@ -146,15 +130,13 @@ ___
|
|
|
146
130
|
|
|
147
131
|
• `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
|
|
148
132
|
|
|
149
|
-
Defines resources that are loaded when the component should mount.
|
|
150
|
-
|
|
151
133
|
#### Inherited from
|
|
152
134
|
|
|
153
135
|
[ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
|
|
154
136
|
|
|
155
137
|
#### Defined in
|
|
156
138
|
|
|
157
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
139
|
+
[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)
|
|
158
140
|
|
|
159
141
|
___
|
|
160
142
|
|
|
@@ -162,11 +144,9 @@ ___
|
|
|
162
144
|
|
|
163
145
|
• `Optional` **slot**: `string`
|
|
164
146
|
|
|
165
|
-
A slot to attach to
|
|
166
|
-
|
|
167
147
|
#### Defined in
|
|
168
148
|
|
|
169
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
149
|
+
[packages/framework/esm-globals/src/types.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L127)
|
|
170
150
|
|
|
171
151
|
___
|
|
172
152
|
|
|
@@ -174,11 +154,9 @@ ___
|
|
|
174
154
|
|
|
175
155
|
• `Optional` **slots**: `string`[]
|
|
176
156
|
|
|
177
|
-
Slots to attach to
|
|
178
|
-
|
|
179
157
|
#### Defined in
|
|
180
158
|
|
|
181
|
-
[packages/framework/esm-globals/src/types.ts:
|
|
159
|
+
[packages/framework/esm-globals/src/types.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L129)
|
|
182
160
|
|
|
183
161
|
## Methods
|
|
184
162
|
|
|
@@ -186,8 +164,6 @@ Slots to attach to
|
|
|
186
164
|
|
|
187
165
|
▸ **load**(): `Promise`<`any`\>
|
|
188
166
|
|
|
189
|
-
Defines a function to use for actually loading the component's lifecycle.
|
|
190
|
-
|
|
191
167
|
#### Returns
|
|
192
168
|
|
|
193
169
|
`Promise`<`any`\>
|
|
@@ -198,4 +174,4 @@ Defines a function to use for actually loading the component's lifecycle.
|
|
|
198
174
|
|
|
199
175
|
#### Defined in
|
|
200
176
|
|
|
201
|
-
[packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/
|
|
177
|
+
[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)
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
#### Defined in
|
|
22
22
|
|
|
23
|
-
[packages/framework/esm-react-utils/src/Extension.tsx:
|
|
23
|
+
[packages/framework/esm-react-utils/src/Extension.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L14)
|
|
24
24
|
|
|
25
25
|
## Methods
|
|
26
26
|
|
|
@@ -41,4 +41,4 @@
|
|
|
41
41
|
|
|
42
42
|
#### Defined in
|
|
43
43
|
|
|
44
|
-
[packages/framework/esm-react-utils/src/Extension.tsx:
|
|
44
|
+
[packages/framework/esm-react-utils/src/Extension.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L16)
|