@openmrs/esm-framework 8.0.1-pre.3331 → 8.0.1-pre.3349

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.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: FeatureFlagDefinition
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:300
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:296
6
6
 
7
7
  A definition of a feature flag extracted from the routes.json
8
8
 
@@ -12,7 +12,7 @@ A definition of a feature flag extracted from the routes.json
12
12
 
13
13
  > **description**: `string`
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:306
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:302
16
16
 
17
17
  An explanation of what the flag does, which will be displayed in the Implementer Tools
18
18
 
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
22
22
 
23
23
  > **flagName**: `string`
24
24
 
25
- Defined in: packages/framework/esm-globals/dist/types.d.ts:302
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:298
26
26
 
27
27
  A code-friendly name for the flag, which will be used to reference it in code
28
28
 
@@ -32,6 +32,6 @@ A code-friendly name for the flag, which will be used to reference it in code
32
32
 
33
33
  > **label**: `string`
34
34
 
35
- Defined in: packages/framework/esm-globals/dist/types.d.ts:304
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:300
36
36
 
37
37
  A human-friendly name which will be displayed in the Implementer Tools
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: OpenmrsAppRoutes
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:309
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:305
6
6
 
7
7
  This interface describes the format of the routes provided by an app
8
8
 
@@ -12,7 +12,7 @@ This interface describes the format of the routes provided by an app
12
12
 
13
13
  > `optional` **backendDependencies**: `Record`\<`string`, `string`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:313
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:309
16
16
 
17
17
  A list of backend modules necessary for this frontend module and the corresponding required versions.
18
18
 
@@ -22,7 +22,7 @@ A list of backend modules necessary for this frontend module and the correspondi
22
22
 
23
23
  > `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
24
24
 
25
- Defined in: packages/framework/esm-globals/dist/types.d.ts:327
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:323
26
26
 
27
27
  An array of all extensions supported by this frontend module. Extensions can be mounted in extension slots, either via declarations in this file or configuration.
28
28
 
@@ -32,7 +32,7 @@ An array of all extensions supported by this frontend module. Extensions can be
32
32
 
33
33
  > `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
34
34
 
35
- Defined in: packages/framework/esm-globals/dist/types.d.ts:329
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:325
36
36
 
37
37
  An array of all feature flags for any beta-stage features this module provides.
38
38
 
@@ -42,7 +42,7 @@ An array of all feature flags for any beta-stage features this module provides.
42
42
 
43
43
  > `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
44
44
 
45
- Defined in: packages/framework/esm-globals/dist/types.d.ts:331
45
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:327
46
46
 
47
47
  An array of all modals supported by this frontend module. Modals can be launched by name.
48
48
 
@@ -52,7 +52,7 @@ An array of all modals supported by this frontend module. Modals can be launched
52
52
 
53
53
  > `optional` **optionalBackendDependencies**: `object`
54
54
 
55
- Defined in: packages/framework/esm-globals/dist/types.d.ts:315
55
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:311
56
56
 
57
57
  A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
58
58
 
@@ -68,7 +68,7 @@ The name of the backend dependency and either the required version or an object
68
68
 
69
69
  > `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
70
70
 
71
- Defined in: packages/framework/esm-globals/dist/types.d.ts:325
71
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:321
72
72
 
73
73
  An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
74
74
 
@@ -78,7 +78,7 @@ An array of all pages supported by this frontend module. Pages are automatically
78
78
 
79
79
  > `optional` **version**: `string`
80
80
 
81
- Defined in: packages/framework/esm-globals/dist/types.d.ts:311
81
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:307
82
82
 
83
83
  The version of this frontend module.
84
84
 
@@ -88,7 +88,7 @@ The version of this frontend module.
88
88
 
89
89
  > `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
90
90
 
91
- Defined in: packages/framework/esm-globals/dist/types.d.ts:335
91
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:331
92
92
 
93
93
  An array of all workspace groups supported by this frontend module.
94
94
 
@@ -98,6 +98,6 @@ An array of all workspace groups supported by this frontend module.
98
98
 
99
99
  > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
100
100
 
101
- Defined in: packages/framework/esm-globals/dist/types.d.ts:333
101
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:329
102
102
 
103
103
  An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ResourceLoader()\<T\>
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:342
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:338
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:342
12
12
 
13
13
  > **ResourceLoader**(): `Promise`\<`T`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:343
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:339
16
16
 
17
17
  ## Returns
18
18
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceGroupDefinition
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:287
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:283
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:287
10
10
 
11
11
  > `optional` **members**: `string`[]
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:295
13
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:291
14
14
 
15
15
  List of workspace names which are part of the workspace group.
16
16
 
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
20
20
 
21
21
  > **name**: `string`
22
22
 
23
- Defined in: packages/framework/esm-globals/dist/types.d.ts:291
23
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:287
24
24
 
25
25
  Name of the workspace group. This is used to launch the workspace group
@@ -14,27 +14,17 @@ A definition of an extension as extracted from an app's routes.json
14
14
 
15
15
  > **component**: `string`
16
16
 
17
- Defined in: packages/framework/esm-globals/dist/types.d.ts:214
17
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:210
18
18
 
19
19
  The name of the component exported by this frontend module.
20
20
 
21
21
  ***
22
22
 
23
- ### displayExpression?
24
-
25
- > `optional` **displayExpression**: `string`
26
-
27
- Defined in: packages/framework/esm-globals/dist/types.d.ts:200
28
-
29
- The expression that determines whether the extension is displayed.
30
-
31
- ***
32
-
33
23
  ### featureFlag?
34
24
 
35
25
  > `optional` **featureFlag**: `string`
36
26
 
37
- Defined in: packages/framework/esm-globals/dist/types.d.ts:204
27
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:200
38
28
 
39
29
  If supplied, the extension will only be rendered when this feature flag is enabled.
40
30
 
@@ -44,7 +34,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
44
34
 
45
35
  > `optional` **meta**: `object`
46
36
 
47
- Defined in: packages/framework/esm-globals/dist/types.d.ts:208
37
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:204
48
38
 
49
39
  Meta describes any properties that are passed down to the extension when it is loaded
50
40
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **ModalDefinition** = `object`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/types.d.ts:219
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:215
8
8
 
9
9
  A definition of a modal as extracted from an app's routes.json
10
10
 
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
14
14
 
15
15
  > **component**: `string`
16
16
 
17
- Defined in: packages/framework/esm-globals/dist/types.d.ts:227
17
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:223
18
18
 
19
19
  The name of the component exported by this frontend module.
20
20
 
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
24
24
 
25
25
  > **name**: `string`
26
26
 
27
- Defined in: packages/framework/esm-globals/dist/types.d.ts:223
27
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:219
28
28
 
29
29
  The name of this modal. This is used to launch the modal.
@@ -4,4 +4,4 @@
4
4
 
5
5
  > **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/types.d.ts:345
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:341
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/types.d.ts:341
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:337
8
8
 
9
9
  This interfaces describes the format of the overall routes.json loaded by the app shell.
10
10
  Basically, this is the same as the app routes, with each routes definition keyed by the app's name
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **WorkspaceDefinition** = `object`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/types.d.ts:233
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:229
8
8
 
9
9
  A definition of a workspace as extracted from an app's routes.json
10
10
 
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
14
14
 
15
15
  > `optional` **canHide**: `boolean`
16
16
 
17
- Defined in: packages/framework/esm-globals/dist/types.d.ts:249
17
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:245
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:249
22
22
 
23
23
  > `optional` **canMaximize**: `boolean`
24
24
 
25
- Defined in: packages/framework/esm-globals/dist/types.d.ts:250
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:246
26
26
 
27
27
  ***
28
28
 
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:250
30
30
 
31
31
  > **component**: `string`
32
32
 
33
- Defined in: packages/framework/esm-globals/dist/types.d.ts:285
33
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:281
34
34
 
35
35
  The name of the component exported by this frontend module.
36
36
 
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
40
40
 
41
41
  > **groups**: `string`[]
42
42
 
43
- Defined in: packages/framework/esm-globals/dist/types.d.ts:281
43
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:277
44
44
 
45
45
  Workspaces can open either independently or as part of a "workspace group". A
46
46
  "workspace group" groups related workspaces together, so that only one is visible
@@ -68,7 +68,7 @@ name, the entire workspace group will close, and the new workspace will launch i
68
68
 
69
69
  > **name**: `string`
70
70
 
71
- Defined in: packages/framework/esm-globals/dist/types.d.ts:237
71
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:233
72
72
 
73
73
  The name of this workspace. This is used to launch the workspace.
74
74
 
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
78
78
 
79
79
  > `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
80
80
 
81
- Defined in: packages/framework/esm-globals/dist/types.d.ts:260
81
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:256
82
82
 
83
83
  Launches the workspace in the preferred size, it defaults to the 'narrow' width
84
84
 
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
88
88
 
89
89
  > **title**: `string`
90
90
 
91
- Defined in: packages/framework/esm-globals/dist/types.d.ts:242
91
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:238
92
92
 
93
93
  The title of the workspace. This will be looked up as a key in the translations of the module
94
94
  defining the workspace.
@@ -99,7 +99,7 @@ defining the workspace.
99
99
 
100
100
  > **type**: `string`
101
101
 
102
- Defined in: packages/framework/esm-globals/dist/types.d.ts:248
102
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:244
103
103
 
104
104
  The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
105
105
  time. The default is "form". If the right sidebar is in use, then the type determines which
@@ -111,7 +111,7 @@ right sidebar icon corresponds to the workspace.
111
111
 
112
112
  > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
113
113
 
114
- Defined in: packages/framework/esm-globals/dist/types.d.ts:256
114
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:252
115
115
 
116
116
  Controls the width of the workspace. The default is "narrow" and this should only be
117
117
  changed to "wider" if the workspace itself has internal navigation, like the form editor.
@@ -4,4 +4,4 @@
4
4
 
5
5
  > **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
6
6
 
7
- Defined in: packages/framework/esm-globals/dist/types.d.ts:229
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:225
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3331",
3
+ "version": "8.0.1-pre.3349",
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": "8.0.1-pre.3331",
63
- "@openmrs/esm-config": "8.0.1-pre.3331",
64
- "@openmrs/esm-context": "8.0.1-pre.3331",
65
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3331",
66
- "@openmrs/esm-emr-api": "8.0.1-pre.3331",
67
- "@openmrs/esm-error-handling": "8.0.1-pre.3331",
68
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3331",
69
- "@openmrs/esm-extensions": "8.0.1-pre.3331",
70
- "@openmrs/esm-feature-flags": "8.0.1-pre.3331",
71
- "@openmrs/esm-globals": "8.0.1-pre.3331",
72
- "@openmrs/esm-navigation": "8.0.1-pre.3331",
73
- "@openmrs/esm-offline": "8.0.1-pre.3331",
74
- "@openmrs/esm-react-utils": "8.0.1-pre.3331",
75
- "@openmrs/esm-routes": "8.0.1-pre.3331",
76
- "@openmrs/esm-state": "8.0.1-pre.3331",
77
- "@openmrs/esm-styleguide": "8.0.1-pre.3331",
78
- "@openmrs/esm-translations": "8.0.1-pre.3331",
79
- "@openmrs/esm-utils": "8.0.1-pre.3331"
62
+ "@openmrs/esm-api": "8.0.1-pre.3349",
63
+ "@openmrs/esm-config": "8.0.1-pre.3349",
64
+ "@openmrs/esm-context": "8.0.1-pre.3349",
65
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3349",
66
+ "@openmrs/esm-emr-api": "8.0.1-pre.3349",
67
+ "@openmrs/esm-error-handling": "8.0.1-pre.3349",
68
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3349",
69
+ "@openmrs/esm-extensions": "8.0.1-pre.3349",
70
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3349",
71
+ "@openmrs/esm-globals": "8.0.1-pre.3349",
72
+ "@openmrs/esm-navigation": "8.0.1-pre.3349",
73
+ "@openmrs/esm-offline": "8.0.1-pre.3349",
74
+ "@openmrs/esm-react-utils": "8.0.1-pre.3349",
75
+ "@openmrs/esm-routes": "8.0.1-pre.3349",
76
+ "@openmrs/esm-state": "8.0.1-pre.3349",
77
+ "@openmrs/esm-styleguide": "8.0.1-pre.3349",
78
+ "@openmrs/esm-translations": "8.0.1-pre.3349",
79
+ "@openmrs/esm-utils": "8.0.1-pre.3349"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "dayjs": "1.x",
@@ -89,7 +89,7 @@
89
89
  "swr": "2.x"
90
90
  },
91
91
  "devDependencies": {
92
- "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3331",
92
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3349",
93
93
  "@rspack/cli": "^1.3.11",
94
94
  "@rspack/core": "^1.3.11",
95
95
  "concurrently": "^9.1.2",