@openmrs/esm-framework 6.3.1-pre.3119 → 6.3.1-pre.3124

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 (17) 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/DashboardExtension.md +1 -1
  5. package/docs/functions/attach.md +1 -1
  6. package/docs/functions/detach.md +1 -1
  7. package/docs/functions/detachAll.md +1 -1
  8. package/docs/functions/getAssignedExtensions.md +1 -1
  9. package/docs/functions/getExtensionNameFromId.md +1 -1
  10. package/docs/interfaces/DashboardExtensionProps.md +5 -5
  11. package/docs/interfaces/ExtensionSlotConfig.md +10 -4
  12. package/docs/interfaces/ExtensionSlotConfigureValueObject.md +1 -1
  13. package/docs/type-aliases/ProvidedConfig.md +3 -3
  14. package/docs/type-aliases/Validator.md +1 -1
  15. package/docs/type-aliases/ValidatorFunction.md +1 -1
  16. package/package.json +20 -20
  17. package/docs/interfaces/ExtensionSlotConfigObject.md +0 -35
package/docs/functions/DashboardExtension.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **DashboardExtension**(`__namedParameters`): `Element`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L16)
7
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L18)
8
8
 
9
9
  ## Parameters
10
10
 
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:215](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L215)
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)
8
8
 
9
9
  Attach an extension to an extension slot.
10
10
 
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:248](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L248)
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)
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:272](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L272)
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)
8
8
 
9
9
  ## Parameters
10
10
 
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:399](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L399)
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)
8
8
 
9
9
  Gets the list of extensions assigned to a given slot
10
10
 
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:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L163)
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)
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/interfaces/DashboardExtensionProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DashboardExtensionProps
4
4
 
5
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L9)
5
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L11)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx
10
10
 
11
11
  > **basePath**: `string`
12
12
 
13
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L12)
13
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L14)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx
18
18
 
19
19
  > **icon**: `string`
20
20
 
21
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L13)
21
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L15)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx
26
26
 
27
27
  > **path**: `string`
28
28
 
29
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L10)
29
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L12)
30
30
 
31
31
  ***
32
32
 
@@ -34,4 +34,4 @@ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx
34
34
 
35
35
  > **title**: `string`
36
36
 
37
- Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L11)
37
+ Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L13)
package/docs/interfaces/ExtensionSlotConfig.md CHANGED
@@ -10,7 +10,9 @@ Defined in: [packages/framework/esm-config/src/types.ts:48](https://github.com/o
10
10
 
11
11
  > `optional` **add**: `string`[]
12
12
 
13
- Defined in: [packages/framework/esm-config/src/types.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L49)
13
+ Defined in: [packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
14
+
15
+ Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
14
16
 
15
17
  ***
16
18
 
@@ -18,7 +20,7 @@ Defined in: [packages/framework/esm-config/src/types.ts:49](https://github.com/o
18
20
 
19
21
  > `optional` **configure**: [`ExtensionSlotConfigureValueObject`](ExtensionSlotConfigureValueObject.md)
20
22
 
21
- Defined in: [packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L52)
23
+ Defined in: [packages/framework/esm-config/src/types.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L55)
22
24
 
23
25
  ***
24
26
 
@@ -26,7 +28,9 @@ Defined in: [packages/framework/esm-config/src/types.ts:52](https://github.com/o
26
28
 
27
29
  > `optional` **order**: `string`[]
28
30
 
29
- Defined in: [packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L51)
31
+ Defined in: [packages/framework/esm-config/src/types.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L54)
32
+
33
+ Overrides the default ordering of extensions.
30
34
 
31
35
  ***
32
36
 
@@ -34,4 +38,6 @@ Defined in: [packages/framework/esm-config/src/types.ts:51](https://github.com/o
34
38
 
35
39
  > `optional` **remove**: `string`[]
36
40
 
37
- Defined in: [packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
41
+ Defined in: [packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L52)
42
+
43
+ Extension IDs which were `attach`ed to the slot but which should not be assigned.
package/docs/interfaces/ExtensionSlotConfigureValueObject.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ExtensionSlotConfigureValueObject
4
4
 
5
- Defined in: [packages/framework/esm-config/src/types.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L55)
5
+ Defined in: [packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L58)
6
6
 
7
7
  ## Indexable
8
8
 
package/docs/type-aliases/ProvidedConfig.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **ProvidedConfig** = `object`
6
6
 
7
- Defined in: [packages/framework/esm-config/src/types.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L68)
7
+ Defined in: [packages/framework/esm-config/src/types.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L62)
8
8
 
9
9
  ## Properties
10
10
 
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-config/src/types.ts:68](https://github.com/o
12
12
 
13
13
  > **config**: [`Config`](../interfaces/Config.md)
14
14
 
15
- Defined in: [packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L70)
15
+ Defined in: [packages/framework/esm-config/src/types.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L64)
16
16
 
17
17
  ***
18
18
 
@@ -20,4 +20,4 @@ Defined in: [packages/framework/esm-config/src/types.ts:70](https://github.com/o
20
20
 
21
21
  > **source**: `string`
22
22
 
23
- Defined in: [packages/framework/esm-config/src/types.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L69)
23
+ Defined in: [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
package/docs/type-aliases/Validator.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **Validator** = (`value`) => `void` \| `string`
6
6
 
7
- Defined in: [packages/framework/esm-config/src/types.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L75)
7
+ Defined in: [packages/framework/esm-config/src/types.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L69)
8
8
 
9
9
  ## Parameters
10
10
 
package/docs/type-aliases/ValidatorFunction.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **ValidatorFunction** = (`value`) => `boolean`
6
6
 
7
- Defined in: [packages/framework/esm-config/src/types.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L73)
7
+ Defined in: [packages/framework/esm-config/src/types.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L67)
8
8
 
9
9
  ## Parameters
10
10
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "6.3.1-pre.3119",
3
+ "version": "6.3.1-pre.3124",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/openmrs-esm-framework.js",
@@ -59,24 +59,24 @@
59
59
  "access": "public"
60
60
  },
61
61
  "dependencies": {
62
- "@openmrs/esm-api": "6.3.1-pre.3119",
63
- "@openmrs/esm-config": "6.3.1-pre.3119",
64
- "@openmrs/esm-context": "6.3.1-pre.3119",
65
- "@openmrs/esm-dynamic-loading": "6.3.1-pre.3119",
66
- "@openmrs/esm-emr-api": "6.3.1-pre.3119",
67
- "@openmrs/esm-error-handling": "6.3.1-pre.3119",
68
- "@openmrs/esm-expression-evaluator": "6.3.1-pre.3119",
69
- "@openmrs/esm-extensions": "6.3.1-pre.3119",
70
- "@openmrs/esm-feature-flags": "6.3.1-pre.3119",
71
- "@openmrs/esm-globals": "6.3.1-pre.3119",
72
- "@openmrs/esm-navigation": "6.3.1-pre.3119",
73
- "@openmrs/esm-offline": "6.3.1-pre.3119",
74
- "@openmrs/esm-react-utils": "6.3.1-pre.3119",
75
- "@openmrs/esm-routes": "6.3.1-pre.3119",
76
- "@openmrs/esm-state": "6.3.1-pre.3119",
77
- "@openmrs/esm-styleguide": "6.3.1-pre.3119",
78
- "@openmrs/esm-translations": "6.3.1-pre.3119",
79
- "@openmrs/esm-utils": "6.3.1-pre.3119"
62
+ "@openmrs/esm-api": "6.3.1-pre.3124",
63
+ "@openmrs/esm-config": "6.3.1-pre.3124",
64
+ "@openmrs/esm-context": "6.3.1-pre.3124",
65
+ "@openmrs/esm-dynamic-loading": "6.3.1-pre.3124",
66
+ "@openmrs/esm-emr-api": "6.3.1-pre.3124",
67
+ "@openmrs/esm-error-handling": "6.3.1-pre.3124",
68
+ "@openmrs/esm-expression-evaluator": "6.3.1-pre.3124",
69
+ "@openmrs/esm-extensions": "6.3.1-pre.3124",
70
+ "@openmrs/esm-feature-flags": "6.3.1-pre.3124",
71
+ "@openmrs/esm-globals": "6.3.1-pre.3124",
72
+ "@openmrs/esm-navigation": "6.3.1-pre.3124",
73
+ "@openmrs/esm-offline": "6.3.1-pre.3124",
74
+ "@openmrs/esm-react-utils": "6.3.1-pre.3124",
75
+ "@openmrs/esm-routes": "6.3.1-pre.3124",
76
+ "@openmrs/esm-state": "6.3.1-pre.3124",
77
+ "@openmrs/esm-styleguide": "6.3.1-pre.3124",
78
+ "@openmrs/esm-translations": "6.3.1-pre.3124",
79
+ "@openmrs/esm-utils": "6.3.1-pre.3124"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "dayjs": "1.x",
@@ -98,7 +98,7 @@
98
98
  "sass-embedded": "^1.89.0",
99
99
  "svgo-loader": "^4.0.0",
100
100
  "typedoc": "^0.28.5",
101
- "typedoc-plugin-file-categories": "6.3.1-pre.3119",
101
+ "typedoc-plugin-file-categories": "6.3.1-pre.3124",
102
102
  "typedoc-plugin-markdown": "^4.6.3",
103
103
  "typedoc-plugin-no-inherit": "^1.6.1",
104
104
  "typescript": "^5.8.3",
package/docs/interfaces/ExtensionSlotConfigObject.md DELETED
@@ -1,35 +0,0 @@
1
- [O3 Framework](../API.md) / ExtensionSlotConfigObject
2
-
3
- # Interface: ExtensionSlotConfigObject
4
-
5
- Defined in: [packages/framework/esm-config/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L59)
6
-
7
- ## Properties
8
-
9
- ### add?
10
-
11
- > `optional` **add**: `string`[]
12
-
13
- Defined in: [packages/framework/esm-config/src/types.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L61)
14
-
15
- Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
16
-
17
- ***
18
-
19
- ### order?
20
-
21
- > `optional` **order**: `string`[]
22
-
23
- Defined in: [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
24
-
25
- Overrides the default ordering of extensions.
26
-
27
- ***
28
-
29
- ### remove?
30
-
31
- > `optional` **remove**: `string`[]
32
-
33
- Defined in: [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
34
-
35
- Extension IDs which were `attach`ed to the slot but which should not be assigned.