@openmrs/esm-framework 10.0.1-pre.5263 → 10.0.1-pre.5299
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 +1 -1
- package/docs/functions/attach.md +1 -1
- package/docs/functions/createUseStore.md +1 -1
- package/docs/functions/defineConfigSchema.md +1 -1
- package/docs/functions/defineExtensionConfigSchema.md +1 -1
- package/docs/functions/detach.md +1 -1
- package/docs/functions/detachAll.md +1 -1
- package/docs/functions/getAssignedExtensions.md +17 -5
- package/docs/functions/getConfig.md +1 -1
- package/docs/functions/getExtensionNameFromId.md +1 -1
- package/docs/functions/getExtensionStore.md +1 -1
- package/docs/functions/provide.md +1 -1
- package/docs/functions/renderExtension.md +1 -1
- package/docs/functions/showModal.md +1 -1
- package/docs/functions/useAssignedExtensionIds.md +1 -2
- package/docs/functions/useAssignedExtensions.md +17 -2
- package/docs/functions/useExtensionSlotStore.md +1 -1
- package/docs/functions/useFhirPagination.md +1 -1
- package/docs/functions/useOpenmrsPagination.md +1 -1
- package/docs/functions/usePagination.md +5 -1
- package/docs/functions/useStore.md +4 -4
- package/docs/functions/useStoreWithActions.md +1 -1
- package/docs/interfaces/AssignedExtension.md +19 -9
- package/docs/interfaces/CancelLoading.md +2 -2
- package/docs/interfaces/ConnectedExtension.md +6 -6
- package/docs/interfaces/ExtensionMeta.md +1 -1
- package/docs/interfaces/ExtensionRegistration.md +11 -11
- package/docs/interfaces/ExtensionSlotState.md +8 -13
- package/docs/interfaces/ExtensionStore.md +2 -2
- package/docs/type-aliases/ExtensionSlotCustomState.md +11 -0
- package/package.json +20 -20
- package/src/integration-tests/extension-config-expressions.test.tsx +64 -2
- package/src/integration-tests/extension-config-propagation.test.tsx +185 -0
- package/src/integration-tests/extension-config.test.tsx +57 -2
- package/src/integration-tests/extension-recomputation.test.tsx +652 -0
- package/vitest.config.ts +22 -0
package/.turbo/turbo-build.log
CHANGED
package/docs/functions/attach.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **attach**(`slotName`, `extensionId`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:309](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L309)
|
|
8
8
|
|
|
9
9
|
Attach an extension to an extension slot.
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **createUseStore**\<`T`\>(`store`): \{(): `T`; \<`A`\>(`actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \<`A`\>(`actions?`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \}
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L111)
|
|
8
8
|
|
|
9
9
|
Whenever possible, use `useStore(yourStore)` instead. This function is for creating a
|
|
10
10
|
custom hook for a specific store.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **defineConfigSchema**(`moduleName`, `schema`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:312](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L312)
|
|
8
8
|
|
|
9
9
|
This defines a configuration schema for a module. The schema tells the
|
|
10
10
|
configuration system how the module can be configured. It specifies
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **defineExtensionConfigSchema**(`extensionName`, `schema`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:388](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L388)
|
|
8
8
|
|
|
9
9
|
This defines a configuration schema for an extension. When a schema is defined
|
|
10
10
|
for an extension, that extension will receive the configuration corresponding
|
package/docs/functions/detach.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **detach**(`extensionSlotName`, `extensionId`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L347)
|
|
8
8
|
|
|
9
9
|
Detaches an extension from an extension slot.
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **detachAll**(`extensionSlotName`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:375](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L375)
|
|
8
8
|
|
|
9
9
|
Detaches all extensions from an extension slot.
|
|
10
10
|
|
|
@@ -2,11 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
# Function: getAssignedExtensions()
|
|
4
4
|
|
|
5
|
-
> **getAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
5
|
+
> **getAssignedExtensions**(`slotName`, `state?`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:554](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L554)
|
|
8
8
|
|
|
9
|
-
Gets the
|
|
9
|
+
Gets the extensions a given rendering of a slot should display, in order. This is the supported
|
|
10
|
+
way to ask what belongs in a slot; reading the extension store directly skips display conditions.
|
|
11
|
+
|
|
12
|
+
Display conditions are evaluated against `state`, so pass whatever the slot is being rendered
|
|
13
|
+
for. The same slot can be rendered many times with different state — once per row of a table,
|
|
14
|
+
say — and each rendering can resolve to a different set of extensions. Omitting `state` hides
|
|
15
|
+
every extension whose condition refers to it, since the condition cannot be evaluated.
|
|
10
16
|
|
|
11
17
|
## Parameters
|
|
12
18
|
|
|
@@ -14,10 +20,16 @@ Gets the list of extensions assigned to a given slot
|
|
|
14
20
|
|
|
15
21
|
`string`
|
|
16
22
|
|
|
17
|
-
The slot to load the
|
|
23
|
+
The slot to load the extensions for
|
|
24
|
+
|
|
25
|
+
### state?
|
|
26
|
+
|
|
27
|
+
[`ExtensionSlotCustomState`](../type-aliases/ExtensionSlotCustomState.md)
|
|
28
|
+
|
|
29
|
+
The state of the rendering of the slot the extensions will be displayed in
|
|
18
30
|
|
|
19
31
|
## Returns
|
|
20
32
|
|
|
21
33
|
[`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
22
34
|
|
|
23
|
-
|
|
35
|
+
Those extensions assigned to the slot whose display conditions hold
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **getConfig**\<`T`\>(`moduleName`): `Promise`\<`T`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:461](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L461)
|
|
8
8
|
|
|
9
9
|
A promise-based way to access the config as soon as it is fully loaded.
|
|
10
10
|
If it is already loaded, resolves the config in its present state.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **getExtensionNameFromId**(`extensionId`): `string`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:257](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L257)
|
|
8
8
|
|
|
9
9
|
Given an extension ID, which is a string uniquely identifying
|
|
10
10
|
an instance of an extension within an extension slot, this
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **getExtensionStore**(): `StoreApi`\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:236](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L236)
|
|
8
8
|
|
|
9
9
|
This returns a store that modules can use to get information about the
|
|
10
10
|
state of the extension system.
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **provide**(`config`, `sourceName`): `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:414](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L414)
|
|
8
8
|
|
|
9
9
|
Provides configuration values programmatically. This is an alternative to
|
|
10
10
|
providing configuration through the config-file. Configuration provided this
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction`, `additionalProps`): `Promise`\<`null` \| `Parcel`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:164](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L164)
|
|
8
8
|
|
|
9
9
|
Mounts into a DOM node (representing an extension slot)
|
|
10
10
|
a lazy-loaded component from *any* frontend module
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **showModal**(`modalName`, `props`, `onClose`): () => `void`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/modals/index.tsx:
|
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/modals/index.tsx:293](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L293)
|
|
8
8
|
|
|
9
9
|
Shows a modal dialog.
|
|
10
10
|
|
|
@@ -4,10 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
> **useAssignedExtensionIds**(`slotName`): `string`[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L12)
|
|
8
8
|
|
|
9
9
|
Gets the assigned extension ids for a given extension slot name.
|
|
10
|
-
Does not consider if offline or online.
|
|
11
10
|
|
|
12
11
|
## Parameters
|
|
13
12
|
|
|
@@ -2,12 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
# Function: useAssignedExtensions()
|
|
4
4
|
|
|
5
|
-
> **useAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
5
|
+
> **useAssignedExtensions**(`slotName`, `state?`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L26)
|
|
8
8
|
|
|
9
9
|
Gets the assigned extensions for a given extension slot name.
|
|
10
10
|
|
|
11
|
+
The reactive form of `getAssignedExtensions`, and it answers the same thing: display conditions
|
|
12
|
+
are always applied, so the result is what should actually be displayed. Pass `state` whenever you
|
|
13
|
+
know it: the same slot can be rendered in several places at once with different state, so
|
|
14
|
+
conditions are resolved against the state of this rendering. Omitting it resolves them against
|
|
15
|
+
the session alone, hiding any extension whose condition depends on state.
|
|
16
|
+
|
|
17
|
+
The returned array is a copy, so sorting or filtering it in place can't corrupt the extension
|
|
18
|
+
store. Its reference is stable for as long as the slot's extensions, the state and the session are.
|
|
19
|
+
|
|
11
20
|
## Parameters
|
|
12
21
|
|
|
13
22
|
### slotName
|
|
@@ -16,6 +25,12 @@ Gets the assigned extensions for a given extension slot name.
|
|
|
16
25
|
|
|
17
26
|
The name of the slot to get the assigned extensions for.
|
|
18
27
|
|
|
28
|
+
### state?
|
|
29
|
+
|
|
30
|
+
[`ExtensionSlotCustomState`](../type-aliases/ExtensionSlotCustomState.md)
|
|
31
|
+
|
|
32
|
+
The state of this rendering of the slot.
|
|
33
|
+
|
|
19
34
|
## Returns
|
|
20
35
|
|
|
21
36
|
[`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useExtensionSlotStore**(`slot`): [`ExtensionSlotState`](../interfaces/ExtensionSlotState.md)
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotStore.ts#L22)
|
|
8
8
|
|
|
9
9
|
## Parameters
|
|
10
10
|
|
|
@@ -4,11 +4,15 @@
|
|
|
4
4
|
|
|
5
5
|
> **usePagination**\<`T`\>(`data`, `resultsPerPage`): `object`
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/usePagination.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/usePagination.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePagination.ts#L20)
|
|
8
8
|
|
|
9
9
|
Use this hook to paginate data that already exists on the client side.
|
|
10
10
|
Note that if the data is obtained from server-side, the caller must handle server-side pagination manually.
|
|
11
11
|
|
|
12
|
+
`goTo`, `goToNext` and `goToPrevious` keep the same identity for the life of the component, so they are
|
|
13
|
+
safe to list in a dependency array. `currentPage` is bounded by the data, so it can change on its own
|
|
14
|
+
when the data shrinks; a component reacting to `currentPage` should expect that.
|
|
15
|
+
|
|
12
16
|
## Type Parameters
|
|
13
17
|
|
|
14
18
|
### T
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
> **useStore**\<`T`\>(`store`): `T`
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
9
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L56)
|
|
10
10
|
|
|
11
11
|
### Type Parameters
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:52](https://gith
|
|
|
28
28
|
|
|
29
29
|
> **useStore**\<`T`, `U`\>(`store`, `select`): `U`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
31
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L57)
|
|
32
32
|
|
|
33
33
|
### Type Parameters
|
|
34
34
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:53](https://gith
|
|
|
58
58
|
|
|
59
59
|
> **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
61
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L58)
|
|
62
62
|
|
|
63
63
|
### Type Parameters
|
|
64
64
|
|
|
@@ -96,7 +96,7 @@ Defined in: [packages/framework/esm-react-utils/src/useStore.ts:54](https://gith
|
|
|
96
96
|
|
|
97
97
|
> **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
|
|
98
98
|
|
|
99
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
99
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L63)
|
|
100
100
|
|
|
101
101
|
### Type Parameters
|
|
102
102
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
> **useStoreWithActions**\<`T`, `A`\>(`store`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:
|
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useStore.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L103)
|
|
8
8
|
|
|
9
9
|
## Type Parameters
|
|
10
10
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: AssignedExtension
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L112)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,17 +10,27 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:77](https://github.c
|
|
|
10
10
|
|
|
11
11
|
> `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L118)
|
|
14
14
|
|
|
15
15
|
The extension's config. Note that this will be `null` until the slot is mounted.
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
19
|
+
### displayConditionExpression?
|
|
20
|
+
|
|
21
|
+
> `readonly` `optional` **displayConditionExpression**: `string`
|
|
22
|
+
|
|
23
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:123](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L123)
|
|
24
|
+
|
|
25
|
+
The condition under which this extension should be displayed.
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
19
29
|
### featureFlag?
|
|
20
30
|
|
|
21
31
|
> `readonly` `optional` **featureFlag**: `string`
|
|
22
32
|
|
|
23
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
33
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:121](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L121)
|
|
24
34
|
|
|
25
35
|
***
|
|
26
36
|
|
|
@@ -28,7 +38,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:86](https://github.c
|
|
|
28
38
|
|
|
29
39
|
> `readonly` **id**: `string`
|
|
30
40
|
|
|
31
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
41
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L113)
|
|
32
42
|
|
|
33
43
|
***
|
|
34
44
|
|
|
@@ -36,7 +46,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:78](https://github.c
|
|
|
36
46
|
|
|
37
47
|
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
|
38
48
|
|
|
39
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
49
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L116)
|
|
40
50
|
|
|
41
51
|
***
|
|
42
52
|
|
|
@@ -44,7 +54,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:81](https://github.c
|
|
|
44
54
|
|
|
45
55
|
> `readonly` **moduleName**: `string`
|
|
46
56
|
|
|
47
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
57
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L115)
|
|
48
58
|
|
|
49
59
|
***
|
|
50
60
|
|
|
@@ -52,7 +62,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:80](https://github.c
|
|
|
52
62
|
|
|
53
63
|
> `readonly` **name**: `string`
|
|
54
64
|
|
|
55
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
65
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L114)
|
|
56
66
|
|
|
57
67
|
***
|
|
58
68
|
|
|
@@ -60,7 +70,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:79](https://github.c
|
|
|
60
70
|
|
|
61
71
|
> `readonly` `optional` **offline**: `boolean` \| `object`
|
|
62
72
|
|
|
63
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
73
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L120)
|
|
64
74
|
|
|
65
75
|
***
|
|
66
76
|
|
|
@@ -68,4 +78,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:85](https://github.c
|
|
|
68
78
|
|
|
69
79
|
> `readonly` `optional` **online**: `boolean` \| `object`
|
|
70
80
|
|
|
71
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
81
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L119)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: CancelLoading()
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L15)
|
|
6
6
|
|
|
7
7
|
> **CancelLoading**(): `void`
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/framework/esm-extensions/src/render.ts:
|
|
9
|
+
Defined in: [packages/framework/esm-extensions/src/render.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L16)
|
|
10
10
|
|
|
11
11
|
## Returns
|
|
12
12
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ~~ConnectedExtension~~
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L127)
|
|
6
6
|
|
|
7
7
|
## Deprecated
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@ replaced with AssignedExtension
|
|
|
14
14
|
|
|
15
15
|
> `readonly` **config**: `null` \| `Readonly`\<[`ConfigObject`](ConfigObject.md)\>
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
17
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L133)
|
|
18
18
|
|
|
19
19
|
The extension's config. Note that this will be `null` until the slot is mounted.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **id**: `string`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
27
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L128)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:91](https://github.c
|
|
|
32
32
|
|
|
33
33
|
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
35
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L131)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:94](https://github.c
|
|
|
40
40
|
|
|
41
41
|
> `readonly` **moduleName**: `string`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
43
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L130)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
@@ -48,4 +48,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:93](https://github.c
|
|
|
48
48
|
|
|
49
49
|
> `readonly` **name**: `string`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
51
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L129)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionMeta
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L7)
|
|
6
6
|
|
|
7
7
|
## Indexable
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionRegistration
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L11)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:12](https://github.c
|
|
|
10
10
|
|
|
11
11
|
> `readonly` `optional` **displayExpression**: `string`
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L21)
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:22](https://github.c
|
|
|
18
18
|
|
|
19
19
|
> `readonly` `optional` **featureFlag**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
21
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L20)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:21](https://github.c
|
|
|
26
26
|
|
|
27
27
|
> `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
29
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L15)
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:16](https://github.c
|
|
|
34
34
|
|
|
35
35
|
> `readonly` **moduleName**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
37
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L14)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:15](https://github.c
|
|
|
42
42
|
|
|
43
43
|
> `readonly` **name**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
45
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L12)
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:13](https://github.c
|
|
|
50
50
|
|
|
51
51
|
> `readonly` `optional` **offline**: `boolean`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
53
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L18)
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:19](https://github.c
|
|
|
58
58
|
|
|
59
59
|
> `readonly` `optional` **online**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
61
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L17)
|
|
62
62
|
|
|
63
63
|
***
|
|
64
64
|
|
|
@@ -66,7 +66,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:18](https://github.c
|
|
|
66
66
|
|
|
67
67
|
> `readonly` `optional` **order**: `number`
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
69
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L16)
|
|
70
70
|
|
|
71
71
|
***
|
|
72
72
|
|
|
@@ -74,7 +74,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:17](https://github.c
|
|
|
74
74
|
|
|
75
75
|
> `readonly` `optional` **privileges**: `string` \| `string`[]
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
77
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L19)
|
|
78
78
|
|
|
79
79
|
## Methods
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:20](https://github.c
|
|
|
82
82
|
|
|
83
83
|
> **load**(): `Promise`\<`LifeCycles`\>
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
85
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L13)
|
|
86
86
|
|
|
87
87
|
#### Returns
|
|
88
88
|
|
|
@@ -2,15 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: ExtensionSlotState
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
5
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L103)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### candidateExtensions
|
|
10
10
|
|
|
11
|
-
> **
|
|
11
|
+
> **candidateExtensions**: [`AssignedExtension`](AssignedExtension.md)[]
|
|
12
12
|
|
|
13
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
13
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L109)
|
|
14
|
+
|
|
15
|
+
Candidates only. Call `getAssignedExtensions()` for the extensions a given rendering of
|
|
16
|
+
this slot should actually display.
|
|
14
17
|
|
|
15
18
|
***
|
|
16
19
|
|
|
@@ -18,12 +21,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:73](https://github.c
|
|
|
18
21
|
|
|
19
22
|
> `optional` **moduleName**: `string`
|
|
20
23
|
|
|
21
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:
|
|
22
|
-
|
|
23
|
-
***
|
|
24
|
-
|
|
25
|
-
### state?
|
|
26
|
-
|
|
27
|
-
> `optional` **state**: `ExtensionSlotCustomState`
|
|
28
|
-
|
|
29
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L74)
|
|
24
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L104)
|