@openmrs/esm-framework 3.1.15-pre.757 → 3.1.15-pre.759
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/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +343 -113
- package/docs/interfaces/ConfigStore.md +34 -0
- package/docs/interfaces/ConnectedExtension.md +106 -3
- package/docs/interfaces/ExtensionDetails.md +81 -0
- package/docs/interfaces/ExtensionInfo.md +8 -8
- package/docs/interfaces/ExtensionInstance.md +1 -1
- package/docs/interfaces/ExtensionProps.md +2 -2
- package/docs/interfaces/ExtensionRegistration.md +9 -7
- package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
- package/docs/interfaces/ExtensionSlotConfigsStore.md +32 -0
- package/docs/interfaces/ExtensionSlotInfo.md +9 -23
- package/docs/interfaces/ExtensionSlotInstance.md +51 -0
- package/docs/interfaces/ExtensionStore.md +17 -2
- package/docs/interfaces/ImplementerToolsConfigStore.md +19 -0
- package/mock.tsx +5 -13
- package/package.json +13 -13
- package/src/integration-tests/extension-config.test.tsx +10 -4
- package/docs/interfaces/AssignedExtension.md +0 -63
- package/docs/interfaces/ExtensionInternalStore.md +0 -34
- package/docs/interfaces/ExtensionSlotState.md +0 -30
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ConfigStore
|
|
2
|
+
|
|
3
|
+
# Interface: ConfigStore
|
|
4
|
+
|
|
5
|
+
Output configs
|
|
6
|
+
|
|
7
|
+
Each module has its own stores for its config and its extension slots' configs.
|
|
8
|
+
|
|
9
|
+
## Table of contents
|
|
10
|
+
|
|
11
|
+
### Properties
|
|
12
|
+
|
|
13
|
+
- [config](ConfigStore.md#config)
|
|
14
|
+
- [loaded](ConfigStore.md#loaded)
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
### config
|
|
19
|
+
|
|
20
|
+
• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
|
|
21
|
+
|
|
22
|
+
#### Defined in
|
|
23
|
+
|
|
24
|
+
[packages/framework/esm-config/src/module-config/state.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L125)
|
|
25
|
+
|
|
26
|
+
___
|
|
27
|
+
|
|
28
|
+
### loaded
|
|
29
|
+
|
|
30
|
+
• **loaded**: `boolean`
|
|
31
|
+
|
|
32
|
+
#### Defined in
|
|
33
|
+
|
|
34
|
+
[packages/framework/esm-config/src/module-config/state.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L126)
|
|
@@ -2,13 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ConnectedExtension
|
|
4
4
|
|
|
5
|
+
We have the following extension modes:
|
|
6
|
+
|
|
7
|
+
- attached (set via code in form of: attach, detach, ...)
|
|
8
|
+
- configured (set via configuration in form of: added, removed, ...)
|
|
9
|
+
- assigned (computed from attached and configured)
|
|
10
|
+
- connected (computed from assigned using connectivity and online / offline)
|
|
11
|
+
|
|
12
|
+
## Hierarchy
|
|
13
|
+
|
|
14
|
+
- [`ExtensionRegistration`](ExtensionRegistration.md)
|
|
15
|
+
|
|
16
|
+
↳ **`ConnectedExtension`**
|
|
17
|
+
|
|
5
18
|
## Table of contents
|
|
6
19
|
|
|
7
20
|
### Properties
|
|
8
21
|
|
|
9
22
|
- [id](ConnectedExtension.md#id)
|
|
10
23
|
- [meta](ConnectedExtension.md#meta)
|
|
24
|
+
- [moduleName](ConnectedExtension.md#modulename)
|
|
11
25
|
- [name](ConnectedExtension.md#name)
|
|
26
|
+
- [offline](ConnectedExtension.md#offline)
|
|
27
|
+
- [online](ConnectedExtension.md#online)
|
|
28
|
+
- [order](ConnectedExtension.md#order)
|
|
29
|
+
|
|
30
|
+
### Methods
|
|
31
|
+
|
|
32
|
+
- [load](ConnectedExtension.md#load)
|
|
12
33
|
|
|
13
34
|
## Properties
|
|
14
35
|
|
|
@@ -18,7 +39,7 @@
|
|
|
18
39
|
|
|
19
40
|
#### Defined in
|
|
20
41
|
|
|
21
|
-
[packages/framework/esm-
|
|
42
|
+
[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L28)
|
|
22
43
|
|
|
23
44
|
___
|
|
24
45
|
|
|
@@ -26,9 +47,27 @@ ___
|
|
|
26
47
|
|
|
27
48
|
• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
|
|
28
49
|
|
|
50
|
+
#### Inherited from
|
|
51
|
+
|
|
52
|
+
[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
|
|
53
|
+
|
|
29
54
|
#### Defined in
|
|
30
55
|
|
|
31
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
56
|
+
[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)
|
|
57
|
+
|
|
58
|
+
___
|
|
59
|
+
|
|
60
|
+
### moduleName
|
|
61
|
+
|
|
62
|
+
• **moduleName**: `string`
|
|
63
|
+
|
|
64
|
+
#### Inherited from
|
|
65
|
+
|
|
66
|
+
[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
|
|
67
|
+
|
|
68
|
+
#### Defined in
|
|
69
|
+
|
|
70
|
+
[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)
|
|
32
71
|
|
|
33
72
|
___
|
|
34
73
|
|
|
@@ -36,6 +75,70 @@ ___
|
|
|
36
75
|
|
|
37
76
|
• **name**: `string`
|
|
38
77
|
|
|
78
|
+
#### Inherited from
|
|
79
|
+
|
|
80
|
+
[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
|
|
81
|
+
|
|
82
|
+
#### Defined in
|
|
83
|
+
|
|
84
|
+
[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
85
|
+
|
|
86
|
+
___
|
|
87
|
+
|
|
88
|
+
### offline
|
|
89
|
+
|
|
90
|
+
• `Optional` **offline**: `boolean` \| `object`
|
|
91
|
+
|
|
92
|
+
#### Inherited from
|
|
93
|
+
|
|
94
|
+
[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
|
|
95
|
+
|
|
96
|
+
#### Defined in
|
|
97
|
+
|
|
98
|
+
[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)
|
|
99
|
+
|
|
100
|
+
___
|
|
101
|
+
|
|
102
|
+
### online
|
|
103
|
+
|
|
104
|
+
• `Optional` **online**: `boolean` \| `object`
|
|
105
|
+
|
|
106
|
+
#### Inherited from
|
|
107
|
+
|
|
108
|
+
[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
|
|
109
|
+
|
|
110
|
+
#### Defined in
|
|
111
|
+
|
|
112
|
+
[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)
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### order
|
|
117
|
+
|
|
118
|
+
• `Optional` **order**: `number`
|
|
119
|
+
|
|
120
|
+
#### Inherited from
|
|
121
|
+
|
|
122
|
+
[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
|
|
123
|
+
|
|
124
|
+
#### Defined in
|
|
125
|
+
|
|
126
|
+
[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)
|
|
127
|
+
|
|
128
|
+
## Methods
|
|
129
|
+
|
|
130
|
+
### load
|
|
131
|
+
|
|
132
|
+
▸ **load**(): `Promise`<`any`\>
|
|
133
|
+
|
|
134
|
+
#### Returns
|
|
135
|
+
|
|
136
|
+
`Promise`<`any`\>
|
|
137
|
+
|
|
138
|
+
#### Inherited from
|
|
139
|
+
|
|
140
|
+
[ExtensionRegistration](ExtensionRegistration.md).[load](ExtensionRegistration.md#load)
|
|
141
|
+
|
|
39
142
|
#### Defined in
|
|
40
143
|
|
|
41
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
144
|
+
[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ExtensionDetails
|
|
2
|
+
|
|
3
|
+
# Interface: ExtensionDetails
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [meta](ExtensionDetails.md#meta)
|
|
10
|
+
- [moduleName](ExtensionDetails.md#modulename)
|
|
11
|
+
- [offline](ExtensionDetails.md#offline)
|
|
12
|
+
- [online](ExtensionDetails.md#online)
|
|
13
|
+
- [order](ExtensionDetails.md#order)
|
|
14
|
+
|
|
15
|
+
### Methods
|
|
16
|
+
|
|
17
|
+
- [load](ExtensionDetails.md#load)
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### meta
|
|
22
|
+
|
|
23
|
+
• **meta**: `Record`<`string`, `any`\>
|
|
24
|
+
|
|
25
|
+
#### Defined in
|
|
26
|
+
|
|
27
|
+
[packages/framework/esm-extensions/src/extensions.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L56)
|
|
28
|
+
|
|
29
|
+
___
|
|
30
|
+
|
|
31
|
+
### moduleName
|
|
32
|
+
|
|
33
|
+
• **moduleName**: `string`
|
|
34
|
+
|
|
35
|
+
#### Defined in
|
|
36
|
+
|
|
37
|
+
[packages/framework/esm-extensions/src/extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### offline
|
|
42
|
+
|
|
43
|
+
• `Optional` **offline**: `boolean` \| `object`
|
|
44
|
+
|
|
45
|
+
#### Defined in
|
|
46
|
+
|
|
47
|
+
[packages/framework/esm-extensions/src/extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
|
|
48
|
+
|
|
49
|
+
___
|
|
50
|
+
|
|
51
|
+
### online
|
|
52
|
+
|
|
53
|
+
• `Optional` **online**: `boolean` \| `object`
|
|
54
|
+
|
|
55
|
+
#### Defined in
|
|
56
|
+
|
|
57
|
+
[packages/framework/esm-extensions/src/extensions.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L57)
|
|
58
|
+
|
|
59
|
+
___
|
|
60
|
+
|
|
61
|
+
### order
|
|
62
|
+
|
|
63
|
+
• `Optional` **order**: `number`
|
|
64
|
+
|
|
65
|
+
#### Defined in
|
|
66
|
+
|
|
67
|
+
[packages/framework/esm-extensions/src/extensions.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L59)
|
|
68
|
+
|
|
69
|
+
## Methods
|
|
70
|
+
|
|
71
|
+
### load
|
|
72
|
+
|
|
73
|
+
▸ **load**(): `Promise`<`any`\>
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`Promise`<`any`\>
|
|
78
|
+
|
|
79
|
+
#### Defined in
|
|
80
|
+
|
|
81
|
+
[packages/framework/esm-extensions/src/extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)
|
|
@@ -35,7 +35,7 @@ indexed by slotModuleName and slotName.
|
|
|
35
35
|
|
|
36
36
|
#### Defined in
|
|
37
37
|
|
|
38
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
38
|
+
[packages/framework/esm-extensions/src/store.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L27)
|
|
39
39
|
|
|
40
40
|
___
|
|
41
41
|
|
|
@@ -49,7 +49,7 @@ ___
|
|
|
49
49
|
|
|
50
50
|
#### Defined in
|
|
51
51
|
|
|
52
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
52
|
+
[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)
|
|
53
53
|
|
|
54
54
|
___
|
|
55
55
|
|
|
@@ -63,7 +63,7 @@ ___
|
|
|
63
63
|
|
|
64
64
|
#### Defined in
|
|
65
65
|
|
|
66
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
66
|
+
[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)
|
|
67
67
|
|
|
68
68
|
___
|
|
69
69
|
|
|
@@ -77,7 +77,7 @@ ___
|
|
|
77
77
|
|
|
78
78
|
#### Defined in
|
|
79
79
|
|
|
80
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
80
|
+
[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
81
81
|
|
|
82
82
|
___
|
|
83
83
|
|
|
@@ -91,7 +91,7 @@ ___
|
|
|
91
91
|
|
|
92
92
|
#### Defined in
|
|
93
93
|
|
|
94
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
94
|
+
[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)
|
|
95
95
|
|
|
96
96
|
___
|
|
97
97
|
|
|
@@ -105,7 +105,7 @@ ___
|
|
|
105
105
|
|
|
106
106
|
#### Defined in
|
|
107
107
|
|
|
108
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
108
|
+
[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)
|
|
109
109
|
|
|
110
110
|
___
|
|
111
111
|
|
|
@@ -119,7 +119,7 @@ ___
|
|
|
119
119
|
|
|
120
120
|
#### Defined in
|
|
121
121
|
|
|
122
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
122
|
+
[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)
|
|
123
123
|
|
|
124
124
|
## Methods
|
|
125
125
|
|
|
@@ -137,4 +137,4 @@ ___
|
|
|
137
137
|
|
|
138
138
|
#### Defined in
|
|
139
139
|
|
|
140
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
140
|
+
[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -16,4 +16,4 @@
|
|
|
16
16
|
|
|
17
17
|
#### Defined in
|
|
18
18
|
|
|
19
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
19
|
+
[packages/framework/esm-extensions/src/store.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L31)
|
|
@@ -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:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L6)
|
|
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:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)
|
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
↳ [`ExtensionInfo`](ExtensionInfo.md)
|
|
10
10
|
|
|
11
|
+
↳ [`ConnectedExtension`](ConnectedExtension.md)
|
|
12
|
+
|
|
11
13
|
## Table of contents
|
|
12
14
|
|
|
13
15
|
### Properties
|
|
@@ -31,7 +33,7 @@
|
|
|
31
33
|
|
|
32
34
|
#### Defined in
|
|
33
35
|
|
|
34
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
36
|
+
[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)
|
|
35
37
|
|
|
36
38
|
___
|
|
37
39
|
|
|
@@ -41,7 +43,7 @@ ___
|
|
|
41
43
|
|
|
42
44
|
#### Defined in
|
|
43
45
|
|
|
44
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
46
|
+
[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)
|
|
45
47
|
|
|
46
48
|
___
|
|
47
49
|
|
|
@@ -51,7 +53,7 @@ ___
|
|
|
51
53
|
|
|
52
54
|
#### Defined in
|
|
53
55
|
|
|
54
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
56
|
+
[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)
|
|
55
57
|
|
|
56
58
|
___
|
|
57
59
|
|
|
@@ -61,7 +63,7 @@ ___
|
|
|
61
63
|
|
|
62
64
|
#### Defined in
|
|
63
65
|
|
|
64
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
66
|
+
[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)
|
|
65
67
|
|
|
66
68
|
___
|
|
67
69
|
|
|
@@ -71,7 +73,7 @@ ___
|
|
|
71
73
|
|
|
72
74
|
#### Defined in
|
|
73
75
|
|
|
74
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
76
|
+
[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)
|
|
75
77
|
|
|
76
78
|
___
|
|
77
79
|
|
|
@@ -81,7 +83,7 @@ ___
|
|
|
81
83
|
|
|
82
84
|
#### Defined in
|
|
83
85
|
|
|
84
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
86
|
+
[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)
|
|
85
87
|
|
|
86
88
|
## Methods
|
|
87
89
|
|
|
@@ -95,4 +97,4 @@ ___
|
|
|
95
97
|
|
|
96
98
|
#### Defined in
|
|
97
99
|
|
|
98
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
100
|
+
[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
|
|
@@ -16,11 +16,9 @@
|
|
|
16
16
|
|
|
17
17
|
• `Optional` **add**: `string`[]
|
|
18
18
|
|
|
19
|
-
Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
|
|
20
|
-
|
|
21
19
|
#### Defined in
|
|
22
20
|
|
|
23
|
-
[packages/framework/esm-config/src/types.ts:
|
|
21
|
+
[packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L50)
|
|
24
22
|
|
|
25
23
|
___
|
|
26
24
|
|
|
@@ -28,11 +26,9 @@ ___
|
|
|
28
26
|
|
|
29
27
|
• `Optional` **order**: `string`[]
|
|
30
28
|
|
|
31
|
-
Overrides the default ordering of extensions.
|
|
32
|
-
|
|
33
29
|
#### Defined in
|
|
34
30
|
|
|
35
|
-
[packages/framework/esm-config/src/types.ts:
|
|
31
|
+
[packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L52)
|
|
36
32
|
|
|
37
33
|
___
|
|
38
34
|
|
|
@@ -40,8 +36,6 @@ ___
|
|
|
40
36
|
|
|
41
37
|
• `Optional` **remove**: `string`[]
|
|
42
38
|
|
|
43
|
-
Extension IDs which were `attach`ed to the slot but which should not be assigned.
|
|
44
|
-
|
|
45
39
|
#### Defined in
|
|
46
40
|
|
|
47
|
-
[packages/framework/esm-config/src/types.ts:
|
|
41
|
+
[packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L51)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ExtensionSlotConfigsStore
|
|
2
|
+
|
|
3
|
+
# Interface: ExtensionSlotConfigsStore
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [extensionSlotConfigs](ExtensionSlotConfigsStore.md#extensionslotconfigs)
|
|
10
|
+
- [loaded](ExtensionSlotConfigsStore.md#loaded)
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### extensionSlotConfigs
|
|
15
|
+
|
|
16
|
+
• **extensionSlotConfigs**: `Record`<`string`, [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)\>
|
|
17
|
+
|
|
18
|
+
Configs for each extension slot in the module, indexed by slot name
|
|
19
|
+
|
|
20
|
+
#### Defined in
|
|
21
|
+
|
|
22
|
+
[packages/framework/esm-config/src/module-config/state.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L146)
|
|
23
|
+
|
|
24
|
+
___
|
|
25
|
+
|
|
26
|
+
### loaded
|
|
27
|
+
|
|
28
|
+
• **loaded**: `boolean`
|
|
29
|
+
|
|
30
|
+
#### Defined in
|
|
31
|
+
|
|
32
|
+
[packages/framework/esm-config/src/module-config/state.ts:147](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L147)
|
|
@@ -7,8 +7,7 @@
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
9
|
- [attachedIds](ExtensionSlotInfo.md#attachedids)
|
|
10
|
-
- [
|
|
11
|
-
- [moduleName](ExtensionSlotInfo.md#modulename)
|
|
10
|
+
- [instances](ExtensionSlotInfo.md#instances)
|
|
12
11
|
- [name](ExtensionSlotInfo.md#name)
|
|
13
12
|
|
|
14
13
|
## Properties
|
|
@@ -17,39 +16,26 @@
|
|
|
17
16
|
|
|
18
17
|
• **attachedIds**: `string`[]
|
|
19
18
|
|
|
20
|
-
The set of extension IDs which have been attached to this slot
|
|
19
|
+
The set of extension IDs which have been attached to this slot.
|
|
20
|
+
This is essentially a complete history of `attach` calls to this specific slot.
|
|
21
21
|
However, not all of these extension IDs should be rendered.
|
|
22
22
|
`assignedIds` is the set defining those.
|
|
23
23
|
|
|
24
24
|
#### Defined in
|
|
25
25
|
|
|
26
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
26
|
+
[packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
|
|
27
27
|
|
|
28
28
|
___
|
|
29
29
|
|
|
30
|
-
###
|
|
30
|
+
### instances
|
|
31
31
|
|
|
32
|
-
• **
|
|
32
|
+
• **instances**: `Record`<`string`, [`ExtensionSlotInstance`](ExtensionSlotInstance.md)\>
|
|
33
33
|
|
|
34
|
-
The
|
|
34
|
+
The mapping of modules / extension slot instances where the extension slot has been used.
|
|
35
35
|
|
|
36
36
|
#### Defined in
|
|
37
37
|
|
|
38
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
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:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L48)
|
|
38
|
+
[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)
|
|
53
39
|
|
|
54
40
|
___
|
|
55
41
|
|
|
@@ -61,4 +47,4 @@ The name under which the extension slot has been registered.
|
|
|
61
47
|
|
|
62
48
|
#### Defined in
|
|
63
49
|
|
|
64
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
50
|
+
[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)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ExtensionSlotInstance
|
|
2
|
+
|
|
3
|
+
# Interface: ExtensionSlotInstance
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [addedIds](ExtensionSlotInstance.md#addedids)
|
|
10
|
+
- [idOrder](ExtensionSlotInstance.md#idorder)
|
|
11
|
+
- [removedIds](ExtensionSlotInstance.md#removedids)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### addedIds
|
|
16
|
+
|
|
17
|
+
• **addedIds**: `string`[]
|
|
18
|
+
|
|
19
|
+
A set of additional extension IDs which have been added to to this slot despite not being
|
|
20
|
+
explicitly `attach`ed to it.
|
|
21
|
+
An example may be an extension which is added to the slot via the configuration.
|
|
22
|
+
|
|
23
|
+
#### Defined in
|
|
24
|
+
|
|
25
|
+
[packages/framework/esm-extensions/src/store.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L47)
|
|
26
|
+
|
|
27
|
+
___
|
|
28
|
+
|
|
29
|
+
### idOrder
|
|
30
|
+
|
|
31
|
+
• **idOrder**: `string`[]
|
|
32
|
+
|
|
33
|
+
A set allowing explicit ordering of the `assignedIds`.
|
|
34
|
+
|
|
35
|
+
#### Defined in
|
|
36
|
+
|
|
37
|
+
[packages/framework/esm-extensions/src/store.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L57)
|
|
38
|
+
|
|
39
|
+
___
|
|
40
|
+
|
|
41
|
+
### removedIds
|
|
42
|
+
|
|
43
|
+
• **removedIds**: `string`[]
|
|
44
|
+
|
|
45
|
+
A set of extension IDs which have been removed/hidden from this slot, even though they have
|
|
46
|
+
previously been `attach`ed/added to it.
|
|
47
|
+
An example may be an extension which is removed from the slot via the configuration.
|
|
48
|
+
|
|
49
|
+
#### Defined in
|
|
50
|
+
|
|
51
|
+
[packages/framework/esm-extensions/src/store.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L53)
|
|
@@ -6,14 +6,29 @@
|
|
|
6
6
|
|
|
7
7
|
### Properties
|
|
8
8
|
|
|
9
|
+
- [extensions](ExtensionStore.md#extensions)
|
|
9
10
|
- [slots](ExtensionStore.md#slots)
|
|
10
11
|
|
|
11
12
|
## Properties
|
|
12
13
|
|
|
14
|
+
### extensions
|
|
15
|
+
|
|
16
|
+
• **extensions**: `Record`<`string`, [`ExtensionInfo`](ExtensionInfo.md)\>
|
|
17
|
+
|
|
18
|
+
Extensions indexed by name
|
|
19
|
+
|
|
20
|
+
#### Defined in
|
|
21
|
+
|
|
22
|
+
[packages/framework/esm-extensions/src/store.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L38)
|
|
23
|
+
|
|
24
|
+
___
|
|
25
|
+
|
|
13
26
|
### slots
|
|
14
27
|
|
|
15
|
-
• **slots**: `Record`<`string`, [`
|
|
28
|
+
• **slots**: `Record`<`string`, [`ExtensionSlotInfo`](ExtensionSlotInfo.md)\>
|
|
29
|
+
|
|
30
|
+
Slots indexed by name
|
|
16
31
|
|
|
17
32
|
#### Defined in
|
|
18
33
|
|
|
19
|
-
[packages/framework/esm-extensions/src/store.ts:
|
|
34
|
+
[packages/framework/esm-extensions/src/store.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L36)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / ImplementerToolsConfigStore
|
|
2
|
+
|
|
3
|
+
# Interface: ImplementerToolsConfigStore
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [config](ImplementerToolsConfigStore.md#config)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### config
|
|
14
|
+
|
|
15
|
+
• **config**: [`Config`](Config.md)
|
|
16
|
+
|
|
17
|
+
#### Defined in
|
|
18
|
+
|
|
19
|
+
[packages/framework/esm-config/src/module-config/state.ts:179](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L179)
|