@openmrs/esm-framework 6.0.1-pre.2549 → 6.0.1-pre.2551

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 (16) hide show
  1. package/.turbo/turbo-build.log +2 -2
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +39 -7
  5. package/docs/classes/OpenmrsFetchError.md +3 -3
  6. package/docs/interfaces/CloseWorkspaceOptions.md +17 -0
  7. package/docs/interfaces/DefaultWorkspaceProps.md +4 -4
  8. package/docs/interfaces/FeatureFlagDefinition.md +3 -3
  9. package/docs/interfaces/FetchConfig.md +2 -2
  10. package/docs/interfaces/OpenWorkspace.md +24 -28
  11. package/docs/interfaces/OpenmrsAppRoutes.md +8 -8
  12. package/docs/interfaces/Prompt.md +5 -5
  13. package/docs/interfaces/ResourceLoader.md +1 -1
  14. package/docs/interfaces/WorkspaceRegistration.md +7 -18
  15. package/docs/interfaces/WorkspacesInfo.md +22 -4
  16. package/package.json +18 -18
package/docs/API.md CHANGED
@@ -262,6 +262,7 @@
262
262
 
263
263
  - [closeWorkspace](API.md#closeworkspace)
264
264
  - [launchWorkspace](API.md#launchworkspace)
265
+ - [launchWorkspaceGroup](API.md#launchworkspacegroup)
265
266
  - [navigateAndLaunchWorkspace](API.md#navigateandlaunchworkspace)
266
267
  - [useWorkspaces](API.md#useworkspaces)
267
268
 
@@ -609,7 +610,7 @@ ___
609
610
 
610
611
  #### Defined in
611
612
 
612
- [packages/framework/esm-globals/src/types.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L396)
613
+ [packages/framework/esm-globals/src/types.ts:409](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L409)
613
614
 
614
615
  ___
615
616
 
@@ -622,7 +623,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
622
623
 
623
624
  #### Defined in
624
625
 
625
- [packages/framework/esm-globals/src/types.ts:387](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L387)
626
+ [packages/framework/esm-globals/src/types.ts:400](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L400)
626
627
 
627
628
  ___
628
629
 
@@ -792,7 +793,7 @@ ___
792
793
 
793
794
  ### WorkspaceDefinition
794
795
 
795
- Ƭ **WorkspaceDefinition**: { `canHide?`: `boolean` ; `canMaximize?`: `boolean` ; `hasOwnSidebar?`: `boolean` ; `name`: `string` ; `preferredWindowSize?`: [`WorkspaceWindowState`](API.md#workspacewindowstate) ; `sidebarFamily?`: `string` ; `title`: `string` ; `type`: `string` ; `width?`: ``"narrow"`` \| ``"wider"`` \| ``"extra-wide"`` } & { `component`: `string` } \| { `component?`: `never` }
796
+ Ƭ **WorkspaceDefinition**: { `canHide?`: `boolean` ; `canMaximize?`: `boolean` ; `groups`: `string`[] ; `name`: `string` ; `preferredWindowSize?`: [`WorkspaceWindowState`](API.md#workspacewindowstate) ; `title`: `string` ; `type`: `string` ; `width?`: ``"narrow"`` \| ``"wider"`` \| ``"extra-wide"`` } & { `component`: `string` } \| { `component?`: `never` }
796
797
 
797
798
  A definition of a workspace as extracted from an app's routes.json
798
799
 
@@ -8230,7 +8231,7 @@ Function to close an opened workspace
8230
8231
 
8231
8232
  #### Defined in
8232
8233
 
8233
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:304](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L304)
8234
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:425](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L425)
8234
8235
 
8235
8236
  ___
8236
8237
 
@@ -8281,7 +8282,38 @@ prop named `workspaceTitle` will override the title of the workspace.
8281
8282
 
8282
8283
  #### Defined in
8283
8284
 
8284
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L177)
8285
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:289](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L289)
8286
+
8287
+ ___
8288
+
8289
+ ### launchWorkspaceGroup
8290
+
8291
+ ▸ **launchWorkspaceGroup**(`groupName`, `args`): `void`
8292
+
8293
+ Launches a workspace group with the specified name and configuration.
8294
+ If there are any open workspaces, it will first close them before launching the new workspace group.
8295
+
8296
+ **`example`**
8297
+ launchWorkspaceGroup("myGroup", {
8298
+ state: initialState,
8299
+ onWorkspaceGroupLaunch: () => console.log("Workspace group launched"),
8300
+ workspaceGroupCleanup: () => console.log("Cleaning up workspace group")
8301
+ });
8302
+
8303
+ #### Parameters
8304
+
8305
+ | Name | Type | Description |
8306
+ | :------ | :------ | :------ |
8307
+ | `groupName` | `string` | The name of the workspace group to launch |
8308
+ | `args` | `LaunchWorkspaceGroupArg` | Configuration object for launching the workspace group |
8309
+
8310
+ #### Returns
8311
+
8312
+ `void`
8313
+
8314
+ #### Defined in
8315
+
8316
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L205)
8285
8317
 
8286
8318
  ___
8287
8319
 
@@ -8307,7 +8339,7 @@ Use this function to navigate to a new page and launch a workspace on that page.
8307
8339
 
8308
8340
  #### Defined in
8309
8341
 
8310
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L262)
8342
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:382](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L382)
8311
8343
 
8312
8344
  ___
8313
8345
 
@@ -8321,4 +8353,4 @@ ___
8321
8353
 
8322
8354
  #### Defined in
8323
8355
 
8324
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:418](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L418)
8356
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:536](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L536)
package/docs/classes/OpenmrsFetchError.md CHANGED
@@ -53,7 +53,7 @@ Error.constructor
53
53
 
54
54
  #### Defined in
55
55
 
56
- [packages/framework/esm-api/src/openmrs-fetch.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L296)
56
+ [packages/framework/esm-api/src/openmrs-fetch.ts:304](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L304)
57
57
 
58
58
  ## API Properties
59
59
 
@@ -63,7 +63,7 @@ Error.constructor
63
63
 
64
64
  #### Defined in
65
65
 
66
- [packages/framework/esm-api/src/openmrs-fetch.ts:304](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L304)
66
+ [packages/framework/esm-api/src/openmrs-fetch.ts:312](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L312)
67
67
 
68
68
  ___
69
69
 
@@ -73,7 +73,7 @@ ___
73
73
 
74
74
  #### Defined in
75
75
 
76
- [packages/framework/esm-api/src/openmrs-fetch.ts:305](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L305)
76
+ [packages/framework/esm-api/src/openmrs-fetch.ts:313](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L313)
77
77
 
78
78
  ___
79
79
 
package/docs/interfaces/CloseWorkspaceOptions.md CHANGED
@@ -6,6 +6,7 @@
6
6
 
7
7
  ### Workspace Properties
8
8
 
9
+ - [closeWorkspaceGroup](CloseWorkspaceOptions.md#closeworkspacegroup)
9
10
  - [ignoreChanges](CloseWorkspaceOptions.md#ignorechanges)
10
11
 
11
12
  ### Workspace Methods
@@ -14,6 +15,22 @@
14
15
 
15
16
  ## Workspace Properties
16
17
 
18
+ ### closeWorkspaceGroup
19
+
20
+ • `Optional` **closeWorkspaceGroup**: `boolean`
21
+
22
+ Controls whether the workspace group should be closed and store to be
23
+ cleared when this workspace is closed.
24
+ Defaults to true except when opening a new workspace of the same group.
25
+
26
+ **`default`** true
27
+
28
+ #### Defined in
29
+
30
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L33)
31
+
32
+ ___
33
+
17
34
  ### ignoreChanges
18
35
 
19
36
  • `Optional` **ignoreChanges**: `boolean`
package/docs/interfaces/DefaultWorkspaceProps.md CHANGED
@@ -43,7 +43,7 @@ closed, given the user forcefully closes the workspace.
43
43
 
44
44
  #### Defined in
45
45
 
46
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L46)
46
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L45)
47
47
 
48
48
  ___
49
49
 
@@ -66,7 +66,7 @@ will directly close the workspace without any prompt
66
66
 
67
67
  #### Defined in
68
68
 
69
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L56)
69
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L55)
70
70
 
71
71
  ___
72
72
 
@@ -89,7 +89,7 @@ this workspace is closed; e.g. if there is unsaved data.
89
89
 
90
90
  #### Defined in
91
91
 
92
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L51)
92
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L50)
93
93
 
94
94
  ___
95
95
 
@@ -117,4 +117,4 @@ title needs to be set dynamically.
117
117
 
118
118
  #### Defined in
119
119
 
120
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L71)
120
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L70)
package/docs/interfaces/FeatureFlagDefinition.md CHANGED
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
22
22
 
23
23
  #### Defined in
24
24
 
25
- [packages/framework/esm-globals/src/types.ts:350](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L350)
25
+ [packages/framework/esm-globals/src/types.ts:363](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L363)
26
26
 
27
27
  ___
28
28
 
@@ -34,7 +34,7 @@ A code-friendly name for the flag, which will be used to reference it in code
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-globals/src/types.ts:346](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L346)
37
+ [packages/framework/esm-globals/src/types.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L359)
38
38
 
39
39
  ___
40
40
 
@@ -46,4 +46,4 @@ A human-friendly name which will be displayed in the Implementer Tools
46
46
 
47
47
  #### Defined in
48
48
 
49
- [packages/framework/esm-globals/src/types.ts:348](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L348)
49
+ [packages/framework/esm-globals/src/types.ts:361](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L361)
package/docs/interfaces/FetchConfig.md CHANGED
@@ -37,7 +37,7 @@
37
37
 
38
38
  #### Defined in
39
39
 
40
- [packages/framework/esm-api/src/openmrs-fetch.ts:310](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L310)
40
+ [packages/framework/esm-api/src/openmrs-fetch.ts:318](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L318)
41
41
 
42
42
  ___
43
43
 
@@ -47,7 +47,7 @@ ___
47
47
 
48
48
  #### Defined in
49
49
 
50
- [packages/framework/esm-api/src/openmrs-fetch.ts:309](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L309)
50
+ [packages/framework/esm-api/src/openmrs-fetch.ts:317](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L317)
51
51
 
52
52
  ___
53
53
 
package/docs/interfaces/OpenWorkspace.md CHANGED
@@ -16,11 +16,10 @@
16
16
 
17
17
  - [canHide](OpenWorkspace.md#canhide)
18
18
  - [canMaximize](OpenWorkspace.md#canmaximize)
19
- - [hasOwnSidebar](OpenWorkspace.md#hasownsidebar)
19
+ - [groups](OpenWorkspace.md#groups)
20
20
  - [moduleName](OpenWorkspace.md#modulename)
21
21
  - [name](OpenWorkspace.md#name)
22
22
  - [preferredWindowSize](OpenWorkspace.md#preferredwindowsize)
23
- - [sidebarFamily](OpenWorkspace.md#sidebarfamily)
24
23
  - [title](OpenWorkspace.md#title)
25
24
  - [titleNode](OpenWorkspace.md#titlenode)
26
25
  - [type](OpenWorkspace.md#type)
@@ -29,6 +28,7 @@
29
28
  ### Workspace Properties
30
29
 
31
30
  - [additionalProps](OpenWorkspace.md#additionalprops)
31
+ - [currentWorkspaceGroup](OpenWorkspace.md#currentworkspacegroup)
32
32
 
33
33
  ### Methods
34
34
 
@@ -68,17 +68,17 @@ ___
68
68
 
69
69
  ___
70
70
 
71
- ### hasOwnSidebar
71
+ ### groups
72
72
 
73
- • **hasOwnSidebar**: `boolean`
73
+ • `Optional` **groups**: `string`[]
74
74
 
75
75
  #### Inherited from
76
76
 
77
- [WorkspaceRegistration](WorkspaceRegistration.md).[hasOwnSidebar](WorkspaceRegistration.md#hasownsidebar)
77
+ [WorkspaceRegistration](WorkspaceRegistration.md).[groups](WorkspaceRegistration.md#groups)
78
78
 
79
79
  #### Defined in
80
80
 
81
- [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
81
+ [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
82
82
 
83
83
  ___
84
84
 
@@ -92,7 +92,7 @@ ___
92
92
 
93
93
  #### Defined in
94
94
 
95
- [packages/framework/esm-extensions/src/workspaces.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L21)
95
+ [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
96
96
 
97
97
  ___
98
98
 
@@ -120,21 +120,7 @@ ___
120
120
 
121
121
  #### Defined in
122
122
 
123
- [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
124
-
125
- ___
126
-
127
- ### sidebarFamily
128
-
129
- • **sidebarFamily**: `string`
130
-
131
- #### Inherited from
132
-
133
- [WorkspaceRegistration](WorkspaceRegistration.md).[sidebarFamily](WorkspaceRegistration.md#sidebarfamily)
134
-
135
- #### Defined in
136
-
137
- [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
123
+ [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
138
124
 
139
125
  ___
140
126
 
@@ -202,7 +188,17 @@ ___
202
188
 
203
189
  #### Defined in
204
190
 
205
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:106](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L106)
191
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L109)
192
+
193
+ ___
194
+
195
+ ### currentWorkspaceGroup
196
+
197
+ • `Optional` **currentWorkspaceGroup**: `string`
198
+
199
+ #### Defined in
200
+
201
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L110)
206
202
 
207
203
  ## Methods
208
204
 
@@ -232,7 +228,7 @@ closed, given the user forcefully closes the workspace.
232
228
 
233
229
  #### Defined in
234
230
 
235
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L46)
231
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L45)
236
232
 
237
233
  ___
238
234
 
@@ -259,7 +255,7 @@ will directly close the workspace without any prompt
259
255
 
260
256
  #### Defined in
261
257
 
262
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L56)
258
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L55)
263
259
 
264
260
  ___
265
261
 
@@ -277,7 +273,7 @@ ___
277
273
 
278
274
  #### Defined in
279
275
 
280
- [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
276
+ [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
281
277
 
282
278
  ___
283
279
 
@@ -304,7 +300,7 @@ this workspace is closed; e.g. if there is unsaved data.
304
300
 
305
301
  #### Defined in
306
302
 
307
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L51)
303
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L50)
308
304
 
309
305
  ___
310
306
 
@@ -336,4 +332,4 @@ title needs to be set dynamically.
336
332
 
337
333
  #### Defined in
338
334
 
339
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L71)
335
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L70)
package/docs/interfaces/OpenmrsAppRoutes.md CHANGED
@@ -27,7 +27,7 @@ A list of backend modules necessary for this frontend module and the correspondi
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/framework/esm-globals/src/types.ts:358](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L358)
30
+ [packages/framework/esm-globals/src/types.ts:371](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L371)
31
31
 
32
32
  ___
33
33
 
@@ -39,7 +39,7 @@ An array of all extensions supported by this frontend module. Extensions can be
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/framework/esm-globals/src/types.ts:374](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L374)
42
+ [packages/framework/esm-globals/src/types.ts:387](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L387)
43
43
 
44
44
  ___
45
45
 
@@ -51,7 +51,7 @@ An array of all feature flags for any beta-stage features this module provides.
51
51
 
52
52
  #### Defined in
53
53
 
54
- [packages/framework/esm-globals/src/types.ts:376](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L376)
54
+ [packages/framework/esm-globals/src/types.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L389)
55
55
 
56
56
  ___
57
57
 
@@ -63,7 +63,7 @@ An array of all modals supported by this frontend module. Modals can be launched
63
63
 
64
64
  #### Defined in
65
65
 
66
- [packages/framework/esm-globals/src/types.ts:378](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L378)
66
+ [packages/framework/esm-globals/src/types.ts:391](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L391)
67
67
 
68
68
  ___
69
69
 
@@ -81,7 +81,7 @@ The name of the backend dependency and either the required version or an object
81
81
 
82
82
  #### Defined in
83
83
 
84
- [packages/framework/esm-globals/src/types.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L360)
84
+ [packages/framework/esm-globals/src/types.ts:373](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L373)
85
85
 
86
86
  ___
87
87
 
@@ -93,7 +93,7 @@ An array of all pages supported by this frontend module. Pages are automatically
93
93
 
94
94
  #### Defined in
95
95
 
96
- [packages/framework/esm-globals/src/types.ts:372](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L372)
96
+ [packages/framework/esm-globals/src/types.ts:385](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L385)
97
97
 
98
98
  ___
99
99
 
@@ -105,7 +105,7 @@ The version of this frontend module.
105
105
 
106
106
  #### Defined in
107
107
 
108
- [packages/framework/esm-globals/src/types.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L356)
108
+ [packages/framework/esm-globals/src/types.ts:369](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L369)
109
109
 
110
110
  ___
111
111
 
@@ -117,4 +117,4 @@ An array of all workspaces supported by this frontend module. Workspaces can be
117
117
 
118
118
  #### Defined in
119
119
 
120
- [packages/framework/esm-globals/src/types.ts:380](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L380)
120
+ [packages/framework/esm-globals/src/types.ts:393](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L393)
package/docs/interfaces/Prompt.md CHANGED
@@ -23,7 +23,7 @@
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L90)
26
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L89)
27
27
 
28
28
  ___
29
29
 
@@ -35,7 +35,7 @@ Defaults to "Cancel"
35
35
 
36
36
  #### Defined in
37
37
 
38
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L95)
38
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L94)
39
39
 
40
40
  ___
41
41
 
@@ -47,7 +47,7 @@ Defaults to "Confirm"
47
47
 
48
48
  #### Defined in
49
49
 
50
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L92)
50
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L91)
51
51
 
52
52
  ___
53
53
 
@@ -57,7 +57,7 @@ ___
57
57
 
58
58
  #### Defined in
59
59
 
60
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L89)
60
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L88)
61
61
 
62
62
  ## Methods
63
63
 
@@ -71,4 +71,4 @@ ___
71
71
 
72
72
  #### Defined in
73
73
 
74
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L93)
74
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L92)
package/docs/interfaces/ResourceLoader.md CHANGED
@@ -20,4 +20,4 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-globals/src/types.ts:390](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L390)
23
+ [packages/framework/esm-globals/src/types.ts:403](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L403)
package/docs/interfaces/WorkspaceRegistration.md CHANGED
@@ -16,11 +16,10 @@ See [WorkspaceDefinition](../API.md#workspacedefinition) for more information ab
16
16
 
17
17
  - [canHide](WorkspaceRegistration.md#canhide)
18
18
  - [canMaximize](WorkspaceRegistration.md#canmaximize)
19
- - [hasOwnSidebar](WorkspaceRegistration.md#hasownsidebar)
19
+ - [groups](WorkspaceRegistration.md#groups)
20
20
  - [moduleName](WorkspaceRegistration.md#modulename)
21
21
  - [name](WorkspaceRegistration.md#name)
22
22
  - [preferredWindowSize](WorkspaceRegistration.md#preferredwindowsize)
23
- - [sidebarFamily](WorkspaceRegistration.md#sidebarfamily)
24
23
  - [title](WorkspaceRegistration.md#title)
25
24
  - [titleNode](WorkspaceRegistration.md#titlenode)
26
25
  - [type](WorkspaceRegistration.md#type)
@@ -52,13 +51,13 @@ ___
52
51
 
53
52
  ___
54
53
 
55
- ### hasOwnSidebar
54
+ ### groups
56
55
 
57
- • **hasOwnSidebar**: `boolean`
56
+ • `Optional` **groups**: `string`[]
58
57
 
59
58
  #### Defined in
60
59
 
61
- [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
60
+ [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
62
61
 
63
62
  ___
64
63
 
@@ -68,7 +67,7 @@ ___
68
67
 
69
68
  #### Defined in
70
69
 
71
- [packages/framework/esm-extensions/src/workspaces.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L21)
70
+ [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
72
71
 
73
72
  ___
74
73
 
@@ -88,17 +87,7 @@ ___
88
87
 
89
88
  #### Defined in
90
89
 
91
- [packages/framework/esm-extensions/src/workspaces.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L19)
92
-
93
- ___
94
-
95
- ### sidebarFamily
96
-
97
- • **sidebarFamily**: `string`
98
-
99
- #### Defined in
100
-
101
- [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
90
+ [packages/framework/esm-extensions/src/workspaces.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L17)
102
91
 
103
92
  ___
104
93
 
@@ -152,4 +141,4 @@ ___
152
141
 
153
142
  #### Defined in
154
143
 
155
- [packages/framework/esm-extensions/src/workspaces.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L20)
144
+ [packages/framework/esm-extensions/src/workspaces.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L18)
package/docs/interfaces/WorkspacesInfo.md CHANGED
@@ -8,6 +8,7 @@
8
8
 
9
9
  - [active](WorkspacesInfo.md#active)
10
10
  - [prompt](WorkspacesInfo.md#prompt)
11
+ - [workspaceGroup](WorkspacesInfo.md#workspacegroup)
11
12
  - [workspaceWindowState](WorkspacesInfo.md#workspacewindowstate)
12
13
  - [workspaces](WorkspacesInfo.md#workspaces)
13
14
 
@@ -19,7 +20,7 @@
19
20
 
20
21
  #### Defined in
21
22
 
22
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:412](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L412)
23
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:529](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L529)
23
24
 
24
25
  ___
25
26
 
@@ -29,7 +30,24 @@ ___
29
30
 
30
31
  #### Defined in
31
32
 
32
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:413](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L413)
33
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:530](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L530)
34
+
35
+ ___
36
+
37
+ ### workspaceGroup
38
+
39
+ • `Optional` **workspaceGroup**: `Object`
40
+
41
+ #### Type declaration
42
+
43
+ | Name | Type |
44
+ | :------ | :------ |
45
+ | `cleanup?` | `Function` |
46
+ | `name` | `string` |
47
+
48
+ #### Defined in
49
+
50
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:533](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L533)
33
51
 
34
52
  ___
35
53
 
@@ -39,7 +57,7 @@ ___
39
57
 
40
58
  #### Defined in
41
59
 
42
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:414](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L414)
60
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:531](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L531)
43
61
 
44
62
  ___
45
63
 
@@ -49,4 +67,4 @@ ___
49
67
 
50
68
  #### Defined in
51
69
 
52
- [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:415](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L415)
70
+ [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:532](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L532)