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

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Rspack compiled successfully in 6.29 s
+[0] Rspack compiled successfully in 6.40 s
 [0] rspack --mode=production exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:296
+Defined in: packages/framework/esm-globals/dist/types.d.ts:300
 
 A definition of a feature flag extracted from the routes.json
 
@@ -12,7 +12,7 @@ A definition of a feature flag extracted from the routes.json
 
 > **description**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:302
+Defined in: packages/framework/esm-globals/dist/types.d.ts:306
 
 An explanation of what the flag does, which will be displayed in the Implementer Tools
 
@@ -22,7 +22,7 @@ An explanation of what the flag does, which will be displayed in the Implementer
 
 > **flagName**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:298
+Defined in: packages/framework/esm-globals/dist/types.d.ts:302
 
 A code-friendly name for the flag, which will be used to reference it in code
 
@@ -32,6 +32,6 @@ A code-friendly name for the flag, which will be used to reference it in code
 
 > **label**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:300
+Defined in: packages/framework/esm-globals/dist/types.d.ts:304
 
 A human-friendly name which will be displayed in the Implementer Tools

package/docs/interfaces/OpenmrsAppRoutes.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsAppRoutes
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:305
+Defined in: packages/framework/esm-globals/dist/types.d.ts:309
 
 This interface describes the format of the routes provided by an app
 
@@ -12,7 +12,7 @@ This interface describes the format of the routes provided by an app
 
 > `optional` **backendDependencies**: `Record`\<`string`, `string`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:309
+Defined in: packages/framework/esm-globals/dist/types.d.ts:313
 
 A list of backend modules necessary for this frontend module and the corresponding required versions.
 
@@ -22,7 +22,7 @@ A list of backend modules necessary for this frontend module and the correspondi
 
 > `optional` **extensions**: [`ExtensionDefinition`](../type-aliases/ExtensionDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:323
+Defined in: packages/framework/esm-globals/dist/types.d.ts:327
 
 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.
 
@@ -32,7 +32,7 @@ An array of all extensions supported by this frontend module. Extensions can be
 
 > `optional` **featureFlags**: [`FeatureFlagDefinition`](FeatureFlagDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:325
+Defined in: packages/framework/esm-globals/dist/types.d.ts:329
 
 An array of all feature flags for any beta-stage features this module provides.
 
@@ -42,7 +42,7 @@ An array of all feature flags for any beta-stage features this module provides.
 
 > `optional` **modals**: [`ModalDefinition`](../type-aliases/ModalDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:327
+Defined in: packages/framework/esm-globals/dist/types.d.ts:331
 
 An array of all modals supported by this frontend module. Modals can be launched by name.
 
@@ -52,7 +52,7 @@ An array of all modals supported by this frontend module. Modals can be launched
 
 > `optional` **optionalBackendDependencies**: `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:311
+Defined in: packages/framework/esm-globals/dist/types.d.ts:315
 
 A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions.
 
@@ -68,7 +68,7 @@ The name of the backend dependency and either the required version or an object
 
 > `optional` **pages**: [`PageDefinition`](../type-aliases/PageDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:321
+Defined in: packages/framework/esm-globals/dist/types.d.ts:325
 
 An array of all pages supported by this frontend module. Pages are automatically mounted based on a route.
 
@@ -78,7 +78,7 @@ An array of all pages supported by this frontend module. Pages are automatically
 
 > `optional` **version**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:307
+Defined in: packages/framework/esm-globals/dist/types.d.ts:311
 
 The version of this frontend module.
 
@@ -88,7 +88,7 @@ The version of this frontend module.
 
 > `optional` **workspaceGroups**: [`WorkspaceGroupDefinition`](WorkspaceGroupDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:331
+Defined in: packages/framework/esm-globals/dist/types.d.ts:335
 
 An array of all workspace groups supported by this frontend module.
 
@@ -98,6 +98,6 @@ An array of all workspace groups supported by this frontend module.
 
 > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:329
+Defined in: packages/framework/esm-globals/dist/types.d.ts:333
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.

package/docs/interfaces/ResourceLoader.md

@@ -2,7 +2,7 @@
 
 # Interface: ResourceLoader()\<T\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:338
+Defined in: packages/framework/esm-globals/dist/types.d.ts:342
 
 ## Type Parameters
 
@@ -12,7 +12,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:338
 
 > **ResourceLoader**(): `Promise`\<`T`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:339
+Defined in: packages/framework/esm-globals/dist/types.d.ts:343
 
 ## Returns
 

package/docs/interfaces/WorkspaceGroupDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceGroupDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:283
+Defined in: packages/framework/esm-globals/dist/types.d.ts:287
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:283
 
 > `optional` **members**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:291
+Defined in: packages/framework/esm-globals/dist/types.d.ts:295
 
 List of workspace names which are part of the workspace group.
 
@@ -20,6 +20,6 @@ List of workspace names which are part of the workspace group.
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:287
+Defined in: packages/framework/esm-globals/dist/types.d.ts:291
 
 Name of the workspace group. This is used to launch the workspace group

package/docs/type-aliases/ExtensionDefinition.md

@@ -14,17 +14,27 @@ A definition of an extension as extracted from an app's routes.json
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:210
+Defined in: packages/framework/esm-globals/dist/types.d.ts:214
 
 The name of the component exported by this frontend module.
 
 ***
 
+### displayExpression?
+
+> `optional` **displayExpression**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:200
+
+The expression that determines whether the extension is displayed.
+
+***
+
 ### featureFlag?
 
 > `optional` **featureFlag**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:200
+Defined in: packages/framework/esm-globals/dist/types.d.ts:204
 
 If supplied, the extension will only be rendered when this feature flag is enabled.
 
@@ -34,7 +44,7 @@ If supplied, the extension will only be rendered when this feature flag is enabl
 
 > `optional` **meta**: `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:204
+Defined in: packages/framework/esm-globals/dist/types.d.ts:208
 
 Meta describes any properties that are passed down to the extension when it is loaded
 

package/docs/type-aliases/ModalDefinition.md

@@ -4,7 +4,7 @@
 
 > **ModalDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:215
+Defined in: packages/framework/esm-globals/dist/types.d.ts:219
 
 A definition of a modal as extracted from an app's routes.json
 
@@ -14,7 +14,7 @@ A definition of a modal as extracted from an app's routes.json
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:223
+Defined in: packages/framework/esm-globals/dist/types.d.ts:227
 
 The name of the component exported by this frontend module.
 
@@ -24,6 +24,6 @@ The name of the component exported by this frontend module.
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:219
+Defined in: packages/framework/esm-globals/dist/types.d.ts:223
 
 The name of this modal. This is used to launch the modal.

package/docs/type-aliases/NameUse.md

@@ -4,4 +4,4 @@
 
 > **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:341
+Defined in: packages/framework/esm-globals/dist/types.d.ts:345

package/docs/type-aliases/OpenmrsRoutes.md

@@ -4,7 +4,7 @@
 
 > **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:337
+Defined in: packages/framework/esm-globals/dist/types.d.ts:341
 
 This interfaces describes the format of the overall routes.json loaded by the app shell.
 Basically, this is the same as the app routes, with each routes definition keyed by the app's name

package/docs/type-aliases/WorkspaceDefinition.md

@@ -4,7 +4,7 @@
 
 > **WorkspaceDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:229
+Defined in: packages/framework/esm-globals/dist/types.d.ts:233
 
 A definition of a workspace as extracted from an app's routes.json
 
@@ -14,7 +14,7 @@ A definition of a workspace as extracted from an app's routes.json
 
 > `optional` **canHide**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:245
+Defined in: packages/framework/esm-globals/dist/types.d.ts:249
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:245
 
 > `optional` **canMaximize**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:246
+Defined in: packages/framework/esm-globals/dist/types.d.ts:250
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:246
 
 > **component**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:281
+Defined in: packages/framework/esm-globals/dist/types.d.ts:285
 
 The name of the component exported by this frontend module.
 
@@ -40,7 +40,7 @@ The name of the component exported by this frontend module.
 
 > **groups**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:277
+Defined in: packages/framework/esm-globals/dist/types.d.ts:281
 
 Workspaces can open either independently or as part of a "workspace group". A
 "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
 
 > **name**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:233
+Defined in: packages/framework/esm-globals/dist/types.d.ts:237
 
 The name of this workspace. This is used to launch the workspace.
 
@@ -78,7 +78,7 @@ The name of this workspace. This is used to launch the workspace.
 
 > `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:256
+Defined in: packages/framework/esm-globals/dist/types.d.ts:260
 
 Launches the workspace in the preferred size, it defaults to the 'narrow' width
 
@@ -88,7 +88,7 @@ Launches the workspace in the preferred size, it defaults to the 'narrow' width
 
 > **title**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:238
+Defined in: packages/framework/esm-globals/dist/types.d.ts:242
 
 The title of the workspace. This will be looked up as a key in the translations of the module
 defining the workspace.
@@ -99,7 +99,7 @@ defining the workspace.
 
 > **type**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:244
+Defined in: packages/framework/esm-globals/dist/types.d.ts:248
 
 The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
 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.
 
 > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:252
+Defined in: packages/framework/esm-globals/dist/types.d.ts:256
 
 Controls the width of the workspace. The default is "narrow" and this should only be
 changed to "wider" if the workspace itself has internal navigation, like the form editor.

package/docs/type-aliases/WorkspaceWindowState.md

@@ -4,4 +4,4 @@
 
 > **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:225
+Defined in: packages/framework/esm-globals/dist/types.d.ts:229

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "8.0.1-pre.3327",
+  "version": "8.0.1-pre.3331",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/openmrs-esm-framework.js",
@@ -59,24 +59,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "8.0.1-pre.3327",
-    "@openmrs/esm-config": "8.0.1-pre.3327",
-    "@openmrs/esm-context": "8.0.1-pre.3327",
-    "@openmrs/esm-dynamic-loading": "8.0.1-pre.3327",
-    "@openmrs/esm-emr-api": "8.0.1-pre.3327",
-    "@openmrs/esm-error-handling": "8.0.1-pre.3327",
-    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3327",
-    "@openmrs/esm-extensions": "8.0.1-pre.3327",
-    "@openmrs/esm-feature-flags": "8.0.1-pre.3327",
-    "@openmrs/esm-globals": "8.0.1-pre.3327",
-    "@openmrs/esm-navigation": "8.0.1-pre.3327",
-    "@openmrs/esm-offline": "8.0.1-pre.3327",
-    "@openmrs/esm-react-utils": "8.0.1-pre.3327",
-    "@openmrs/esm-routes": "8.0.1-pre.3327",
-    "@openmrs/esm-state": "8.0.1-pre.3327",
-    "@openmrs/esm-styleguide": "8.0.1-pre.3327",
-    "@openmrs/esm-translations": "8.0.1-pre.3327",
-    "@openmrs/esm-utils": "8.0.1-pre.3327"
+    "@openmrs/esm-api": "8.0.1-pre.3331",
+    "@openmrs/esm-config": "8.0.1-pre.3331",
+    "@openmrs/esm-context": "8.0.1-pre.3331",
+    "@openmrs/esm-dynamic-loading": "8.0.1-pre.3331",
+    "@openmrs/esm-emr-api": "8.0.1-pre.3331",
+    "@openmrs/esm-error-handling": "8.0.1-pre.3331",
+    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3331",
+    "@openmrs/esm-extensions": "8.0.1-pre.3331",
+    "@openmrs/esm-feature-flags": "8.0.1-pre.3331",
+    "@openmrs/esm-globals": "8.0.1-pre.3331",
+    "@openmrs/esm-navigation": "8.0.1-pre.3331",
+    "@openmrs/esm-offline": "8.0.1-pre.3331",
+    "@openmrs/esm-react-utils": "8.0.1-pre.3331",
+    "@openmrs/esm-routes": "8.0.1-pre.3331",
+    "@openmrs/esm-state": "8.0.1-pre.3331",
+    "@openmrs/esm-styleguide": "8.0.1-pre.3331",
+    "@openmrs/esm-translations": "8.0.1-pre.3331",
+    "@openmrs/esm-utils": "8.0.1-pre.3331"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -89,7 +89,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3327",
+    "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3331",
     "@rspack/cli": "^1.3.11",
     "@rspack/core": "^1.3.11",
     "concurrently": "^9.1.2",