@openmrs/esm-framework 8.0.1-pre.3790 → 8.0.1-pre.3802

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 (10) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/interfaces/FeatureFlagDefinition.md +4 -4
  3. package/docs/interfaces/OpenmrsAppRoutes.md +13 -13
  4. package/docs/interfaces/ResourceLoader.md +2 -2
  5. package/docs/interfaces/WorkspaceDefinition2.md +4 -4
  6. package/docs/interfaces/WorkspaceGroupDefinition2.md +23 -0
  7. package/docs/interfaces/WorkspaceWindowDefinition2.md +7 -7
  8. package/docs/type-aliases/NameUse.md +1 -1
  9. package/docs/type-aliases/OpenmrsRoutes.md +1 -1
  10. package/package.json +20 -20
package/.turbo/turbo-build.log CHANGED
@@ -1,3 +1,3 @@
1
- [0] Rspack compiled successfully in 6.42 s
1
+ [0] Rspack compiled successfully in 6.88 s
2
2
  [0] rspack --mode=production exited with code 0
3
3
  [1] tsc --project tsconfig.build.json exited with code 0
package/docs/interfaces/FeatureFlagDefinition.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: FeatureFlagDefinition
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:328
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:338
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:334
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:344
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:330
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:340
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:332
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:342
36
36
 
37
37
  A human-friendly name which will be displayed in the Implementer Tools
package/docs/interfaces/OpenmrsAppRoutes.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: OpenmrsAppRoutes
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:337
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:347
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:341
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:351
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:355
25
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:365
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:357
35
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:367
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:359
45
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:369
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:343
55
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:353
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:353
71
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:363
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:339
81
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:349
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:363
91
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:373
92
92
 
93
93
  An array of all workspace groups supported by this frontend module.
94
94
 
@@ -98,7 +98,7 @@ An array of all workspace groups supported by this frontend module.
98
98
 
99
99
  > `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
100
100
 
101
- Defined in: packages/framework/esm-globals/dist/types.d.ts:365
101
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:375
102
102
 
103
103
  An array of all workspace groups (v2) supported by this frontend module.
104
104
 
@@ -108,7 +108,7 @@ An array of all workspace groups (v2) supported by this frontend module.
108
108
 
109
109
  > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
110
110
 
111
- Defined in: packages/framework/esm-globals/dist/types.d.ts:361
111
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:371
112
112
 
113
113
  An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
114
114
 
@@ -118,7 +118,7 @@ An array of all workspaces supported by this frontend module. Workspaces can be
118
118
 
119
119
  > `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
120
120
 
121
- Defined in: packages/framework/esm-globals/dist/types.d.ts:369
121
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:379
122
122
 
123
123
  An array of all workspaces (v2) supported by this frontend module.
124
124
 
@@ -128,6 +128,6 @@ An array of all workspaces (v2) supported by this frontend module.
128
128
 
129
129
  > `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
130
130
 
131
- Defined in: packages/framework/esm-globals/dist/types.d.ts:367
131
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:377
132
132
 
133
133
  An array of all workspace windows (v2) supported by this frontend module.
package/docs/interfaces/ResourceLoader.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ResourceLoader()\<T\>
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:376
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:386
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:376
12
12
 
13
13
  > **ResourceLoader**(): `Promise`\<`T`\>
14
14
 
15
- Defined in: packages/framework/esm-globals/dist/types.d.ts:377
15
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:387
16
16
 
17
17
  ## Returns
18
18
 
package/docs/interfaces/WorkspaceDefinition2.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceDefinition2
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:320
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:330
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:320
10
10
 
11
11
  > **component**: `string`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:322
13
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:332
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:322
18
18
 
19
19
  > **name**: `string`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/types.d.ts:321
21
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:331
22
22
 
23
23
  ***
24
24
 
@@ -26,4 +26,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:321
26
26
 
27
27
  > **window**: `string`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/types.d.ts:323
29
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:333
package/docs/interfaces/WorkspaceGroupDefinition2.md CHANGED
@@ -43,3 +43,26 @@ workspace groups that are meant to be opened for the entire duration of the app
43
43
  In closable persistence mode, a workspace group renders its
44
44
  action menu with a close button. User may explicitly close the group, along
45
45
  with any opened windows / workspaces.
46
+
47
+ ***
48
+
49
+ ### scopePattern?
50
+
51
+ > `optional` **scopePattern**: `string`
52
+
53
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:320
54
+
55
+ URL pattern that defines the scope where workspaces in this group should persist.
56
+ - If not defined: workspaces close only when navigating to a different app
57
+ - If defined without capture groups: workspaces close when URL doesn't match pattern
58
+ - If defined with capture groups: workspaces close when captured values change
59
+
60
+ #### Examples
61
+
62
+ ```ts
63
+ "^/home/appointments" - static scope for appointments dashboard
64
+ ```
65
+
66
+ ```ts
67
+ "^/patient/([^/]+)/chart" - dynamic scope by patient UUID
68
+ ```
package/docs/interfaces/WorkspaceWindowDefinition2.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WorkspaceWindowDefinition2
4
4
 
5
- Defined in: packages/framework/esm-globals/dist/types.d.ts:312
5
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:322
6
6
 
7
7
  ## Properties
8
8
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:312
10
10
 
11
11
  > `optional` **canMaximize**: `boolean`
12
12
 
13
- Defined in: packages/framework/esm-globals/dist/types.d.ts:315
13
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:325
14
14
 
15
15
  ***
16
16
 
@@ -18,7 +18,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:315
18
18
 
19
19
  > **group**: `string`
20
20
 
21
- Defined in: packages/framework/esm-globals/dist/types.d.ts:316
21
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:326
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:316
26
26
 
27
27
  > `optional` **icon**: `string`
28
28
 
29
- Defined in: packages/framework/esm-globals/dist/types.d.ts:314
29
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:324
30
30
 
31
31
  ***
32
32
 
@@ -34,7 +34,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:314
34
34
 
35
35
  > **name**: `string`
36
36
 
37
- Defined in: packages/framework/esm-globals/dist/types.d.ts:313
37
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:323
38
38
 
39
39
  ***
40
40
 
@@ -42,7 +42,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:313
42
42
 
43
43
  > `optional` **order**: `number`
44
44
 
45
- Defined in: packages/framework/esm-globals/dist/types.d.ts:317
45
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:327
46
46
 
47
47
  ***
48
48
 
@@ -50,4 +50,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:317
50
50
 
51
51
  > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
52
52
 
53
- Defined in: packages/framework/esm-globals/dist/types.d.ts:318
53
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:328
package/docs/type-aliases/NameUse.md CHANGED
@@ -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:379
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:389
package/docs/type-aliases/OpenmrsRoutes.md CHANGED
@@ -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:375
7
+ Defined in: packages/framework/esm-globals/dist/types.d.ts:385
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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3790",
3
+ "version": "8.0.1-pre.3802",
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": "8.0.1-pre.3790",
64
- "@openmrs/esm-config": "8.0.1-pre.3790",
65
- "@openmrs/esm-context": "8.0.1-pre.3790",
66
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3790",
67
- "@openmrs/esm-emr-api": "8.0.1-pre.3790",
68
- "@openmrs/esm-error-handling": "8.0.1-pre.3790",
69
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3790",
70
- "@openmrs/esm-extensions": "8.0.1-pre.3790",
71
- "@openmrs/esm-feature-flags": "8.0.1-pre.3790",
72
- "@openmrs/esm-globals": "8.0.1-pre.3790",
73
- "@openmrs/esm-navigation": "8.0.1-pre.3790",
74
- "@openmrs/esm-offline": "8.0.1-pre.3790",
75
- "@openmrs/esm-react-utils": "8.0.1-pre.3790",
76
- "@openmrs/esm-routes": "8.0.1-pre.3790",
77
- "@openmrs/esm-state": "8.0.1-pre.3790",
78
- "@openmrs/esm-styleguide": "8.0.1-pre.3790",
79
- "@openmrs/esm-translations": "8.0.1-pre.3790",
80
- "@openmrs/esm-utils": "8.0.1-pre.3790"
63
+ "@openmrs/esm-api": "8.0.1-pre.3802",
64
+ "@openmrs/esm-config": "8.0.1-pre.3802",
65
+ "@openmrs/esm-context": "8.0.1-pre.3802",
66
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3802",
67
+ "@openmrs/esm-emr-api": "8.0.1-pre.3802",
68
+ "@openmrs/esm-error-handling": "8.0.1-pre.3802",
69
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3802",
70
+ "@openmrs/esm-extensions": "8.0.1-pre.3802",
71
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3802",
72
+ "@openmrs/esm-globals": "8.0.1-pre.3802",
73
+ "@openmrs/esm-navigation": "8.0.1-pre.3802",
74
+ "@openmrs/esm-offline": "8.0.1-pre.3802",
75
+ "@openmrs/esm-react-utils": "8.0.1-pre.3802",
76
+ "@openmrs/esm-routes": "8.0.1-pre.3802",
77
+ "@openmrs/esm-state": "8.0.1-pre.3802",
78
+ "@openmrs/esm-styleguide": "8.0.1-pre.3802",
79
+ "@openmrs/esm-translations": "8.0.1-pre.3802",
80
+ "@openmrs/esm-utils": "8.0.1-pre.3802"
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": "8.0.1-pre.3790",
93
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3802",
94
94
  "@rspack/cli": "^1.3.11",
95
95
  "@rspack/core": "^1.3.11",
96
96
  "@vitest/coverage-v8": "^4.0.7",