@openmrs/esm-framework 8.0.1-pre.3473 → 8.0.1-pre.3485

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 (12) hide show
  1. package/.turbo/turbo-build.log +4 -1
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/functions/closeWorkspaceGroup2.md +1 -1
  5. package/docs/functions/getRegisteredWorkspace2Names.md +13 -0
  6. package/docs/functions/launchWorkspace2.md +1 -1
  7. package/docs/functions/launchWorkspaceGroup2.md +1 -1
  8. package/docs/functions/useWorkspace2Context.md +14 -0
  9. package/docs/interfaces/Workspace2DefinitionProps.md +27 -7
  10. package/docs/type-aliases/Workspace2Definition.md +1 -1
  11. package/docs/variables/Workspace2.md +1 -1
  12. package/package.json +20 -20
package/docs/functions/closeWorkspaceGroup2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **closeWorkspaceGroup2**(`discardUnsavedChanges?`): `Promise`\<`boolean`\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L72)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L75)
8
8
 
9
9
  **`Experimental`**
10
10
 
package/docs/functions/getRegisteredWorkspace2Names.md ADDED
@@ -0,0 +1,13 @@
1
+ [O3 Framework](../API.md) / getRegisteredWorkspace2Names
2
+
3
+ # Function: getRegisteredWorkspace2Names()
4
+
5
+ > **getRegisteredWorkspace2Names**(): `string`[]
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:561](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L561)
8
+
9
+ ## Returns
10
+
11
+ `string`[]
12
+
13
+ a list of registered workspaces.
package/docs/functions/launchWorkspace2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **launchWorkspace2**\<`WorkspaceProps`, `WindowProps`, `GroupProp`\>(`workspaceName`, `workspaceProps`, `windowProps`, `groupProps`): `Promise`\<`boolean`\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L132)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L135)
8
8
 
9
9
  **`Experimental`**
10
10
 
package/docs/functions/launchWorkspaceGroup2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **launchWorkspaceGroup2**\<`GroupProps`\>(`groupName`, `groupProps`): `Promise`\<`boolean`\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L29)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L32)
8
8
 
9
9
  **`Experimental`**
10
10
 
package/docs/functions/useWorkspace2Context.md ADDED
@@ -0,0 +1,14 @@
1
+ [O3 Framework](../API.md) / useWorkspace2Context
2
+
3
+ # Function: useWorkspace2Context()
4
+
5
+ > **useWorkspace2Context**(): [`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>
6
+
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.ts:555](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.ts#L555)
8
+
9
+ Returns the react Context containing props passed into a workspace.
10
+ This hook MUST be called inside a child of <Workspace2>
11
+
12
+ ## Returns
13
+
14
+ [`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`object`, `object`, `object`\>
package/docs/interfaces/Workspace2DefinitionProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Workspace2DefinitionProps\<WorkspaceProps, WindowProps, GroupProps\>
4
4
 
5
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L21)
5
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L20)
6
6
 
7
7
  **`Experimental`**
8
8
 
@@ -26,7 +26,27 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
26
26
 
27
27
  > **groupProps**: `null` \| `GroupProps`
28
28
 
29
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L45)
29
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
30
+
31
+ **`Experimental`**
32
+
33
+ ***
34
+
35
+ ### isRootWorkspace
36
+
37
+ > **isRootWorkspace**: `boolean`
38
+
39
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L47)
40
+
41
+ **`Experimental`**
42
+
43
+ ***
44
+
45
+ ### windowName
46
+
47
+ > **windowName**: `string`
48
+
49
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L46)
30
50
 
31
51
  **`Experimental`**
32
52
 
@@ -36,7 +56,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
36
56
 
37
57
  > **windowProps**: `null` \| `WindowProps`
38
58
 
39
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L44)
59
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L43)
40
60
 
41
61
  **`Experimental`**
42
62
 
@@ -46,7 +66,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
46
66
 
47
67
  > **workspaceName**: `string`
48
68
 
49
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L46)
69
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L45)
50
70
 
51
71
  **`Experimental`**
52
72
 
@@ -56,7 +76,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
56
76
 
57
77
  > **workspaceProps**: `null` \| `WorkspaceProps`
58
78
 
59
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L43)
79
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L42)
60
80
 
61
81
  **`Experimental`**
62
82
 
@@ -66,7 +86,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.compon
66
86
 
67
87
  > **closeWorkspace**(`options?`): `Promise`\<`boolean`\>
68
88
 
69
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L41)
89
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L40)
70
90
 
71
91
  **`Experimental`**
72
92
 
@@ -96,7 +116,7 @@ a Promise that resolves to true if the workspace is closed, false otherwise.
96
116
 
97
117
  > **launchChildWorkspace**\<`Props`\>(`workspaceName`, `workspaceProps?`): `void`
98
118
 
99
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L33)
119
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L32)
100
120
 
101
121
  **`Experimental`**
102
122
 
package/docs/type-aliases/Workspace2Definition.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **Workspace2Definition**\<`WorkspaceProps`, `WindowProps`, `GroupProps`\> = `React.FC`\<[`Workspace2DefinitionProps`](../interfaces/Workspace2DefinitionProps.md)\<`WorkspaceProps`, `WindowProps`, `GroupProps`\>\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L52)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L53)
8
8
 
9
9
  **`Experimental`**
10
10
 
package/docs/variables/Workspace2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > `const` **Workspace2**: `React.FC`\<`Workspace2Props`\>
6
6
 
7
- Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L65)
7
+ Defined in: [packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces2/workspace2.component.tsx#L66)
8
8
 
9
9
  **`Experimental`**
10
10
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3473",
3
+ "version": "8.0.1-pre.3485",
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.3473",
63
- "@openmrs/esm-config": "8.0.1-pre.3473",
64
- "@openmrs/esm-context": "8.0.1-pre.3473",
65
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3473",
66
- "@openmrs/esm-emr-api": "8.0.1-pre.3473",
67
- "@openmrs/esm-error-handling": "8.0.1-pre.3473",
68
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3473",
69
- "@openmrs/esm-extensions": "8.0.1-pre.3473",
70
- "@openmrs/esm-feature-flags": "8.0.1-pre.3473",
71
- "@openmrs/esm-globals": "8.0.1-pre.3473",
72
- "@openmrs/esm-navigation": "8.0.1-pre.3473",
73
- "@openmrs/esm-offline": "8.0.1-pre.3473",
74
- "@openmrs/esm-react-utils": "8.0.1-pre.3473",
75
- "@openmrs/esm-routes": "8.0.1-pre.3473",
76
- "@openmrs/esm-state": "8.0.1-pre.3473",
77
- "@openmrs/esm-styleguide": "8.0.1-pre.3473",
78
- "@openmrs/esm-translations": "8.0.1-pre.3473",
79
- "@openmrs/esm-utils": "8.0.1-pre.3473"
62
+ "@openmrs/esm-api": "8.0.1-pre.3485",
63
+ "@openmrs/esm-config": "8.0.1-pre.3485",
64
+ "@openmrs/esm-context": "8.0.1-pre.3485",
65
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3485",
66
+ "@openmrs/esm-emr-api": "8.0.1-pre.3485",
67
+ "@openmrs/esm-error-handling": "8.0.1-pre.3485",
68
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3485",
69
+ "@openmrs/esm-extensions": "8.0.1-pre.3485",
70
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3485",
71
+ "@openmrs/esm-globals": "8.0.1-pre.3485",
72
+ "@openmrs/esm-navigation": "8.0.1-pre.3485",
73
+ "@openmrs/esm-offline": "8.0.1-pre.3485",
74
+ "@openmrs/esm-react-utils": "8.0.1-pre.3485",
75
+ "@openmrs/esm-routes": "8.0.1-pre.3485",
76
+ "@openmrs/esm-state": "8.0.1-pre.3485",
77
+ "@openmrs/esm-styleguide": "8.0.1-pre.3485",
78
+ "@openmrs/esm-translations": "8.0.1-pre.3485",
79
+ "@openmrs/esm-utils": "8.0.1-pre.3485"
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.3473",
92
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3485",
93
93
  "@rspack/cli": "^1.3.11",
94
94
  "@rspack/core": "^1.3.11",
95
95
  "concurrently": "^9.1.2",