@openmrs/esm-framework 8.0.1-pre.3439 → 8.0.1-pre.3457

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +2 -2
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/functions/attach.md +1 -1
  5. package/docs/functions/compile.md +1 -1
  6. package/docs/functions/defineConfigSchema.md +1 -1
  7. package/docs/functions/defineExtensionConfigSchema.md +1 -1
  8. package/docs/functions/detach.md +1 -1
  9. package/docs/functions/detachAll.md +1 -1
  10. package/docs/functions/evaluateAsTypeAsync.md +1 -1
  11. package/docs/functions/getAssignedExtensions.md +1 -1
  12. package/docs/functions/getConfig.md +1 -1
  13. package/docs/functions/getExtensionNameFromId.md +1 -1
  14. package/docs/functions/getExtensionStore.md +1 -1
  15. package/docs/functions/provide.md +1 -1
  16. package/docs/functions/setLeftNav.md +1 -1
  17. package/docs/functions/unsetLeftNav.md +1 -1
  18. package/docs/interfaces/AssignedExtension.md +9 -9
  19. package/docs/interfaces/ConnectedExtension.md +6 -6
  20. package/docs/interfaces/ExtensionRegistration.md +8 -0
  21. package/docs/interfaces/ExtensionSlotProps.md +264 -264
  22. package/docs/interfaces/ExtensionSlotState.md +11 -3
  23. package/docs/interfaces/ExtensionStore.md +2 -2
  24. package/docs/interfaces/FeatureFlagDefinition.md +4 -4
  25. package/docs/interfaces/LeftNavStore.md +13 -5
  26. package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
  27. package/docs/interfaces/ResourceLoader.md +2 -2
  28. package/docs/interfaces/SetLeftNavParams.md +13 -5
  29. package/docs/interfaces/WorkspaceDefinition2.md +4 -4
  30. package/docs/interfaces/WorkspaceGroupDefinition.md +3 -3
  31. package/docs/interfaces/WorkspaceGroupDefinition2.md +4 -4
  32. package/docs/interfaces/WorkspaceWindowDefinition2.md +9 -9
  33. package/docs/type-aliases/ExtensionDefinition.md +13 -3
  34. package/docs/type-aliases/ModalDefinition.md +3 -3
  35. package/docs/type-aliases/NameUse.md +1 -1
  36. package/docs/type-aliases/OpenmrsRoutes.md +1 -1
  37. package/docs/type-aliases/WorkspaceDefinition.md +10 -10
  38. package/docs/type-aliases/WorkspaceWindowState.md +1 -1
  39. package/package.json +20 -20
  40. package/setup-tests.ts +23 -2
  41. package/src/integration-tests/extension-config-expressions.test.tsx +316 -0
  42. package/src/integration-tests/extension-config.test.tsx +48 -36
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:216](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L216)
7
+ Defined in: [packages/framework/esm-extensions/src/extensions.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L222)
8
8
 
9
9
  Attach an extension to an extension slot.
10
10
 
package/docs/functions/compile.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **compile**(`expression`): `Expression`
6
6
 
7
- Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:324](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L324)
7
+ Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L338)
8
8
 
9
9
  `compile()` is a companion function for use with [()](evaluate.md) and the various `evaluateAs*()` functions.
10
10
  It processes an expression string into the resulting AST that is executed by those functions. This is useful if
package/docs/functions/defineConfigSchema.md CHANGED
@@ -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:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L165)
7
+ Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L177)
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
package/docs/functions/defineExtensionConfigSchema.md CHANGED
@@ -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:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L241)
7
+ Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:253](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L253)
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:249](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L249)
7
+ Defined in: [packages/framework/esm-extensions/src/extensions.ts:255](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L255)
8
8
 
9
9
  ## Parameters
10
10
 
package/docs/functions/detachAll.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **detachAll**(`extensionSlotName`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-extensions/src/extensions.ts:273](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L273)
7
+ Defined in: [packages/framework/esm-extensions/src/extensions.ts:279](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L279)
8
8
 
9
9
  ## Parameters
10
10
 
package/docs/functions/evaluateAsTypeAsync.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **evaluateAsTypeAsync**\<`T`\>(`expression`, `variables`, `typePredicate`): `Promise`\<`T`\>
6
6
 
7
- Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:278](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L278)
7
+ Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:285](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L285)
8
8
 
9
9
  `evaluateAsTypeAsync()` is a type-safe version of [()](evaluateAsync.md) which returns a result if the result
10
10
  passes a custom type predicate. The main use-case for this is to narrow the return types allowed based on
package/docs/functions/getAssignedExtensions.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **getAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
6
6
 
7
- Defined in: [packages/framework/esm-extensions/src/extensions.ts:403](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L403)
7
+ Defined in: [packages/framework/esm-extensions/src/extensions.ts:421](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L421)
8
8
 
9
9
  Gets the list of extensions assigned to a given slot
10
10
 
package/docs/functions/getConfig.md CHANGED
@@ -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:274](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L274)
7
+ Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L286)
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.
package/docs/functions/getExtensionNameFromId.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **getExtensionNameFromId**(`extensionId`): `string`
6
6
 
7
- Defined in: [packages/framework/esm-extensions/src/extensions.ts:164](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L164)
7
+ Defined in: [packages/framework/esm-extensions/src/extensions.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L170)
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
package/docs/functions/getExtensionStore.md CHANGED
@@ -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:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L125)
7
+ 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)
8
8
 
9
9
  This returns a store that modules can use to get information about the
10
10
  state of the extension system.
package/docs/functions/provide.md CHANGED
@@ -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:258](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L258)
7
+ Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:270](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L270)
8
8
 
9
9
  ## Parameters
10
10
 
package/docs/functions/setLeftNav.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **setLeftNav**(`__namedParameters`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-extensions/src/left-nav.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L37)
7
+ Defined in: [packages/framework/esm-extensions/src/left-nav.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L40)
8
8
 
9
9
  Sets the current left nav context. Must be paired with [unsetLeftNav](unsetLeftNav.md).
10
10
 
package/docs/functions/unsetLeftNav.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **unsetLeftNav**(`name`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-extensions/src/left-nav.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L46)
7
+ Defined in: [packages/framework/esm-extensions/src/left-nav.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L49)
8
8
 
9
9
  Unsets the left nav context if the current context is for the supplied name.
10
10
 
package/docs/interfaces/AssignedExtension.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: AssignedExtension
4
4
 
5
- Defined in: [packages/framework/esm-extensions/src/store.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L72)
5
+ Defined in: [packages/framework/esm-extensions/src/store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L77)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:72](https://github.c
10
10
 
11
11
  > `readonly` **config**: `null` \| `Readonly`\<`ConfigObject`\>
12
12
 
13
- Defined in: [packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
13
+ Defined in: [packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L83)
14
14
 
15
15
  The extension's config. Note that this will be `null` until the slot is mounted.
16
16
 
@@ -20,7 +20,7 @@ The extension's config. Note that this will be `null` until the slot is mounted.
20
20
 
21
21
  > `readonly` `optional` **featureFlag**: `string`
22
22
 
23
- Defined in: [packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L81)
23
+ Defined in: [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)
24
24
 
25
25
  ***
26
26
 
@@ -28,7 +28,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:81](https://github.c
28
28
 
29
29
  > `readonly` **id**: `string`
30
30
 
31
- Defined in: [packages/framework/esm-extensions/src/store.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L73)
31
+ Defined in: [packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L78)
32
32
 
33
33
  ***
34
34
 
@@ -36,7 +36,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:73](https://github.c
36
36
 
37
37
  > `readonly` **meta**: `Readonly`\<[`ExtensionMeta`](ExtensionMeta.md)\>
38
38
 
39
- Defined in: [packages/framework/esm-extensions/src/store.ts:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L76)
39
+ Defined in: [packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L81)
40
40
 
41
41
  ***
42
42
 
@@ -44,7 +44,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:76](https://github.c
44
44
 
45
45
  > `readonly` **moduleName**: `string`
46
46
 
47
- Defined in: [packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L75)
47
+ Defined in: [packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L80)
48
48
 
49
49
  ***
50
50
 
@@ -52,7 +52,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:75](https://github.c
52
52
 
53
53
  > `readonly` **name**: `string`
54
54
 
55
- 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)
55
+ Defined in: [packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L79)
56
56
 
57
57
  ***
58
58
 
@@ -60,7 +60,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:74](https://github.c
60
60
 
61
61
  > `readonly` `optional` **offline**: `boolean` \| `object`
62
62
 
63
- Defined in: [packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L80)
63
+ Defined in: [packages/framework/esm-extensions/src/store.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L85)
64
64
 
65
65
  ***
66
66
 
@@ -68,4 +68,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:80](https://github.c
68
68
 
69
69
  > `readonly` `optional` **online**: `boolean` \| `object`
70
70
 
71
- Defined in: [packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L79)
71
+ Defined in: [packages/framework/esm-extensions/src/store.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L84)
package/docs/interfaces/ConnectedExtension.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ~~ConnectedExtension~~
4
4
 
5
- Defined in: [packages/framework/esm-extensions/src/store.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L85)
5
+ Defined in: [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)
6
6
 
7
7
  ## Deprecated
8
8
 
@@ -14,7 +14,7 @@ replaced with AssignedExtension
14
14
 
15
15
  > `readonly` **config**: `null` \| `Readonly`\<`ConfigObject`\>
16
16
 
17
- Defined in: [packages/framework/esm-extensions/src/store.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L91)
17
+ Defined in: [packages/framework/esm-extensions/src/store.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L96)
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:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L86)
27
+ Defined in: [packages/framework/esm-extensions/src/store.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L91)
28
28
 
29
29
  ***
30
30
 
@@ -32,7 +32,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:86](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:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L89)
35
+ Defined in: [packages/framework/esm-extensions/src/store.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L94)
36
36
 
37
37
  ***
38
38
 
@@ -40,7 +40,7 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:89](https://github.c
40
40
 
41
41
  > `readonly` **moduleName**: `string`
42
42
 
43
- Defined in: [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)
43
+ Defined in: [packages/framework/esm-extensions/src/store.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L93)
44
44
 
45
45
  ***
46
46
 
@@ -48,4 +48,4 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:88](https://github.c
48
48
 
49
49
  > `readonly` **name**: `string`
50
50
 
51
- Defined in: [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)
51
+ Defined in: [packages/framework/esm-extensions/src/store.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L92)
package/docs/interfaces/ExtensionRegistration.md CHANGED
@@ -6,6 +6,14 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:12](https://github.c
6
6
 
7
7
  ## Properties
8
8
 
9
+ ### displayExpression?
10
+
11
+ > `readonly` `optional` **displayExpression**: `string`
12
+
13
+ Defined in: [packages/framework/esm-extensions/src/store.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L22)
14
+
15
+ ***
16
+
9
17
  ### featureFlag?
10
18
 
11
19
  > `readonly` `optional` **featureFlag**: `string`