@openmrs/esm-framework 9.0.0 → 9.0.1-pre.3992

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/docs/API.md CHANGED
@@ -251,11 +251,11 @@
251
251
  ## Workspace
252
252
 
253
253
  - [ActionMenuButtonProps](interfaces/ActionMenuButtonProps.md)
254
- - [closeWorkspace](functions/closeWorkspace.md)
255
- - [launchWorkspace](functions/launchWorkspace.md)
256
- - [navigateAndLaunchWorkspace](functions/navigateAndLaunchWorkspace.md)
257
- - [useWorkspaces](functions/useWorkspaces.md)
258
- - [launchWorkspaceGroup](functions/launchWorkspaceGroup.md)
254
+ - [~~closeWorkspace~~](functions/closeWorkspace.md)
255
+ - [~~launchWorkspace~~](functions/launchWorkspace.md)
256
+ - [~~navigateAndLaunchWorkspace~~](functions/navigateAndLaunchWorkspace.md)
257
+ - [~~useWorkspaces~~](functions/useWorkspaces.md)
258
+ - [~~launchWorkspaceGroup~~](functions/launchWorkspaceGroup.md)
259
259
  - [DefaultWorkspaceProps](interfaces/DefaultWorkspaceProps.md)
260
260
  - [CloseWorkspaceOptions](interfaces/CloseWorkspaceOptions.md)
261
261
  - [OpenWorkspace](interfaces/OpenWorkspace.md)
@@ -1,10 +1,10 @@
1
1
  [O3 Framework](../API.md) / WorkspaceContainer
2
2
 
3
- # Function: WorkspaceContainer()
3
+ # Function: ~~WorkspaceContainer()~~
4
4
 
5
5
  > **WorkspaceContainer**(`__namedParameters`): `Element`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:76](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L76)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L81)
8
8
 
9
9
  Use this component to render the [workspace window](https://zeroheight.com/23a080e38/p/483a22-workspace)
10
10
  in an app such as the patient chart, or a workspace overlay in an app such as the clinic dashboard.
@@ -53,3 +53,7 @@ This component also provides everything needed for workspace notifications to be
53
53
  ## Returns
54
54
 
55
55
  `Element`
56
+
57
+ ## Deprecated
58
+
59
+ Workspace container is no longer needed with workspace v2.
@@ -1,10 +1,10 @@
1
1
  [O3 Framework](../API.md) / closeWorkspace
2
2
 
3
- # Function: closeWorkspace()
3
+ # Function: ~~closeWorkspace()~~
4
4
 
5
5
  > **closeWorkspace**(`name`, `options`): `boolean`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:433](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L433)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:448](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L448)
8
8
 
9
9
  Function to close an opened workspace
10
10
 
@@ -25,3 +25,8 @@ Options to close workspace
25
25
  ## Returns
26
26
 
27
27
  `boolean`
28
+
29
+ ## Deprecated
30
+
31
+ migrate to workspace v2 and call closeWorkspace from Workspace2DefinitionProps instead. See:
32
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
@@ -1,10 +1,10 @@
1
1
  [O3 Framework](../API.md) / launchWorkspace
2
2
 
3
- # Function: launchWorkspace()
3
+ # Function: ~~launchWorkspace()~~
4
4
 
5
5
  > **launchWorkspace**\<`T`\>(`name`, `additionalProps?`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L296)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:305](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L305)
8
8
 
9
9
  This launches a workspace by its name. The workspace must have been registered.
10
10
  Workspaces should be registered in the `routes.json` file.
@@ -54,3 +54,8 @@ Props to pass to the workspace component being launched. Passing
54
54
  ## Returns
55
55
 
56
56
  `void`
57
+
58
+ ## Deprecated
59
+
60
+ migrate to workspace v2 and use launchWorkspace2 instead. See:
61
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
@@ -1,10 +1,10 @@
1
1
  [O3 Framework](../API.md) / launchWorkspaceGroup
2
2
 
3
- # Function: launchWorkspaceGroup()
3
+ # Function: ~~launchWorkspaceGroup()~~
4
4
 
5
5
  > **launchWorkspaceGroup**(`groupName`, `args`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L210)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:216](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L216)
8
8
 
9
9
  Launches a workspace group with the specified name and configuration.
10
10
  If there are any open workspaces, it will first close them before launching the new workspace group.
@@ -36,3 +36,8 @@ launchWorkspaceGroup("myGroup", {
36
36
  workspaceGroupCleanup: () => console.log("Cleaning up workspace group")
37
37
  });
38
38
  ```
39
+
40
+ ## Deprecated
41
+
42
+ migrate to workspace v2 and use launchWorkspaceGroup2 instead. See:
43
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
@@ -1,10 +1,10 @@
1
1
  [O3 Framework](../API.md) / navigateAndLaunchWorkspace
2
2
 
3
- # Function: navigateAndLaunchWorkspace()
3
+ # Function: ~~navigateAndLaunchWorkspace()~~
4
4
 
5
5
  > **navigateAndLaunchWorkspace**(`options`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:390](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L390)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:402](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L402)
8
8
 
9
9
  Use this function to navigate to a new page and launch a workspace on that page.
10
10
 
@@ -41,3 +41,8 @@ The name of the workspace to launch.
41
41
  ## Returns
42
42
 
43
43
  `void`
44
+
45
+ ## Deprecated
46
+
47
+ migrate to workspace v2 and call launchWorkspace2 instead. See:
48
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
@@ -1,11 +1,16 @@
1
1
  [O3 Framework](../API.md) / useWorkspaces
2
2
 
3
- # Function: useWorkspaces()
3
+ # Function: ~~useWorkspaces()~~
4
4
 
5
5
  > **useWorkspaces**(): [`WorkspacesInfo`](../interfaces/WorkspacesInfo.md)
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:544](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L544)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:563](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L563)
8
8
 
9
9
  ## Returns
10
10
 
11
11
  [`WorkspacesInfo`](../interfaces/WorkspacesInfo.md)
12
+
13
+ ## Deprecated
14
+
15
+ migrate to workspace v2. See:
16
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
@@ -1,26 +1,30 @@
1
1
  [O3 Framework](../API.md) / WorkspaceContainerProps
2
2
 
3
- # Interface: WorkspaceContainerProps
3
+ # Interface: ~~WorkspaceContainerProps~~
4
4
 
5
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L15)
5
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L18)
6
+
7
+ ## Deprecated
8
+
9
+ Workspace container is no longer needed with workspace v2.
6
10
 
7
11
  ## Properties
8
12
 
9
- ### actionMenuProps?
13
+ ### ~~actionMenuProps?~~
10
14
 
11
15
  > `optional` **actionMenuProps**: `Record`\<`string`, `unknown`\>
12
16
 
13
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L34)
17
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L37)
14
18
 
15
19
  Props to pass to the action menu component.
16
20
 
17
21
  ***
18
22
 
19
- ### additionalWorkspaceProps?
23
+ ### ~~additionalWorkspaceProps?~~
20
24
 
21
25
  > `optional` **additionalWorkspaceProps**: `object`
22
26
 
23
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L32)
27
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L35)
24
28
 
25
29
  Additional props to pass to the workspace. Using this is unusual; you will generally
26
30
  want to pass props to the workspace when you open it using `launchWorkspace`. Use this
@@ -29,11 +33,11 @@ component is mounted.
29
33
 
30
34
  ***
31
35
 
32
- ### contextKey
36
+ ### ~~contextKey~~
33
37
 
34
38
  > **contextKey**: `string`
35
39
 
36
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L21)
40
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L24)
37
41
 
38
42
  The context key is a path element that identifies the pages on which workspaces should
39
43
  appear. Defined to ensure workspaces do not stay open when navigating between pages.
@@ -41,20 +45,20 @@ Must be a valid sub-path of the URL, with no initial or trailing slash.
41
45
 
42
46
  ***
43
47
 
44
- ### overlay?
48
+ ### ~~overlay?~~
45
49
 
46
50
  > `optional` **overlay**: `boolean`
47
51
 
48
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L23)
52
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L26)
49
53
 
50
54
  When true, renders the workspace as an overlay instead of a side panel window.
51
55
 
52
56
  ***
53
57
 
54
- ### showSiderailAndBottomNav?
58
+ ### ~~showSiderailAndBottomNav?~~
55
59
 
56
60
  > `optional` **showSiderailAndBottomNav**: `boolean`
57
61
 
58
- Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L25)
62
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L28)
59
63
 
60
64
  When true, renders the Siderail (desktop) or Bottom Nav (tablet/mobile) action menu.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspacesInfo
4
4
 
5
- Defined in: [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)
5
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:551](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L551)
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:536]
10
10
 
11
11
  > **active**: `boolean`
12
12
 
13
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:537](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L537)
13
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:552](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L552)
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:537]
18
18
 
19
19
  > **prompt**: `null` \| [`Prompt`](Prompt.md)
20
20
 
21
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:538](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L538)
21
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:553](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L553)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:538]
26
26
 
27
27
  > `optional` **workspaceGroup**: `object`
28
28
 
29
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:541](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L541)
29
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:556](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L556)
30
30
 
31
31
  #### cleanup()?
32
32
 
@@ -50,7 +50,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:541]
50
50
 
51
51
  > **workspaces**: [`OpenWorkspace`](OpenWorkspace.md)[]
52
52
 
53
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:540](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L540)
53
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:555](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L555)
54
54
 
55
55
  ***
56
56
 
@@ -58,4 +58,4 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:540]
58
58
 
59
59
  > **workspaceWindowState**: [`WorkspaceWindowState`](../type-aliases/WorkspaceWindowState.md)
60
60
 
61
- Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:539](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L539)
61
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:554](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L554)
@@ -4,4 +4,9 @@
4
4
 
5
5
  > `const` **ActionMenuButton**: `React.FC`\<[`ActionMenuButtonProps`](../interfaces/ActionMenuButtonProps.md)\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L38)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L42)
8
+
9
+ ## Depcreated
10
+
11
+ migrate to workspace v2 and use ActionMenuButton2. See:
12
+ https://openmrs.atlassian.net/wiki/spaces/docs/pages/615677981/Workspace+v2+Migration+Guide
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "9.0.0",
3
+ "version": "9.0.1-pre.3992",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/openmrs-esm-framework.js",
@@ -60,24 +60,24 @@
60
60
  "access": "public"
61
61
  },
62
62
  "dependencies": {
63
- "@openmrs/esm-api": "9.0.0",
64
- "@openmrs/esm-config": "9.0.0",
65
- "@openmrs/esm-context": "9.0.0",
66
- "@openmrs/esm-dynamic-loading": "9.0.0",
67
- "@openmrs/esm-emr-api": "9.0.0",
68
- "@openmrs/esm-error-handling": "9.0.0",
69
- "@openmrs/esm-expression-evaluator": "9.0.0",
70
- "@openmrs/esm-extensions": "9.0.0",
71
- "@openmrs/esm-feature-flags": "9.0.0",
72
- "@openmrs/esm-globals": "9.0.0",
73
- "@openmrs/esm-navigation": "9.0.0",
74
- "@openmrs/esm-offline": "9.0.0",
75
- "@openmrs/esm-react-utils": "9.0.0",
76
- "@openmrs/esm-routes": "9.0.0",
77
- "@openmrs/esm-state": "9.0.0",
78
- "@openmrs/esm-styleguide": "9.0.0",
79
- "@openmrs/esm-translations": "9.0.0",
80
- "@openmrs/esm-utils": "9.0.0"
63
+ "@openmrs/esm-api": "9.0.1-pre.3992",
64
+ "@openmrs/esm-config": "9.0.1-pre.3992",
65
+ "@openmrs/esm-context": "9.0.1-pre.3992",
66
+ "@openmrs/esm-dynamic-loading": "9.0.1-pre.3992",
67
+ "@openmrs/esm-emr-api": "9.0.1-pre.3992",
68
+ "@openmrs/esm-error-handling": "9.0.1-pre.3992",
69
+ "@openmrs/esm-expression-evaluator": "9.0.1-pre.3992",
70
+ "@openmrs/esm-extensions": "9.0.1-pre.3992",
71
+ "@openmrs/esm-feature-flags": "9.0.1-pre.3992",
72
+ "@openmrs/esm-globals": "9.0.1-pre.3992",
73
+ "@openmrs/esm-navigation": "9.0.1-pre.3992",
74
+ "@openmrs/esm-offline": "9.0.1-pre.3992",
75
+ "@openmrs/esm-react-utils": "9.0.1-pre.3992",
76
+ "@openmrs/esm-routes": "9.0.1-pre.3992",
77
+ "@openmrs/esm-state": "9.0.1-pre.3992",
78
+ "@openmrs/esm-styleguide": "9.0.1-pre.3992",
79
+ "@openmrs/esm-translations": "9.0.1-pre.3992",
80
+ "@openmrs/esm-utils": "9.0.1-pre.3992"
81
81
  },
82
82
  "peerDependencies": {
83
83
  "dayjs": "1.x",
@@ -90,7 +90,7 @@
90
90
  "swr": "2.x"
91
91
  },
92
92
  "devDependencies": {
93
- "@openmrs/typedoc-plugin-file-categories": "9.0.0",
93
+ "@openmrs/typedoc-plugin-file-categories": "9.0.1-pre.3992",
94
94
  "@rspack/cli": "1.3.15",
95
95
  "@rspack/core": "1.3.15",
96
96
  "@vitest/coverage-v8": "^4.0.18",
@@ -105,5 +105,6 @@
105
105
  "typedoc-plugin-no-inherit": "^1.6.1",
106
106
  "typescript": "^5.8.3",
107
107
  "vitest": "^4.0.18"
108
- }
108
+ },
109
+ "stableVersion": "9.0.0"
109
110
  }