@openmrs/esm-framework 7.0.0 → 7.0.1-pre.3258

package/docs/interfaces/ExtensionRegistration.md

@@ -72,10 +72,10 @@ Defined in: [packages/framework/esm-extensions/src/store.ts:20](https://github.c
 
 ### load()
 
-> **load**(): `Promise`\<`object` & `LifeCycles`\>
+> **load**(): `Promise`\<`LifeCycles`\>
 
 Defined in: [packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L14)
 
 #### Returns
 
-`Promise`\<`object` & `LifeCycles`\>
+`Promise`\<`LifeCycles`\>

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:347
+Defined in: packages/framework/esm-globals/dist/types.d.ts:298
 
 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:353
+Defined in: packages/framework/esm-globals/dist/types.d.ts:304
 
 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:349
+Defined in: packages/framework/esm-globals/dist/types.d.ts:300
 
 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:351
+Defined in: packages/framework/esm-globals/dist/types.d.ts:302
 
 A human-friendly name which will be displayed in the Implementer Tools

package/docs/interfaces/ImportMap.md

@@ -2,7 +2,7 @@
 
 # Interface: ImportMap
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:74
+Defined in: packages/framework/esm-globals/dist/types.d.ts:73
 
 ## Properties
 
@@ -10,4 +10,4 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:74
 
 > **imports**: `Record`\<`string`, `string`\>
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:75
+Defined in: packages/framework/esm-globals/dist/types.d.ts:74

package/docs/interfaces/OpenWorkspace.md

@@ -56,7 +56,7 @@ Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:115]
 
 > **groups**: `string`[]
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:18
+Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:16
 
 #### Inherited from
 
@@ -64,27 +64,11 @@ Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:18
 
 ***
 
-### load()
-
-> **load**: () => `Promise`\<`object` & `LifeCycles`\>
-
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
-
-#### Returns
-
-`Promise`\<`object` & `LifeCycles`\>
-
-#### Inherited from
-
-`WorkspaceRegistration.load`
-
-***
-
 ### moduleName
 
 > **moduleName**: `string`
 
-Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:17
+Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:15
 
 #### Inherited from
 
@@ -217,6 +201,22 @@ will directly close the workspace without any prompt
 
 ***
 
+### load()
+
+> **load**(): `Promise`\<`LifeCycles`\>
+
+Defined in: packages/framework/esm-extensions/dist/workspaces.d.ts:14
+
+#### Returns
+
+`Promise`\<`LifeCycles`\>
+
+#### Inherited from
+
+`WorkspaceRegistration.load`
+
+***
+
 ### promptBeforeClosing()
 
 > **promptBeforeClosing**(`testFcn`): `void`

package/docs/interfaces/OpenmrsAppRoutes.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsAppRoutes
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:356
+Defined in: packages/framework/esm-globals/dist/types.d.ts:307
 
 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:360
+Defined in: packages/framework/esm-globals/dist/types.d.ts:311
 
 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:374
+Defined in: packages/framework/esm-globals/dist/types.d.ts:325
 
 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:376
+Defined in: packages/framework/esm-globals/dist/types.d.ts:327
 
 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:378
+Defined in: packages/framework/esm-globals/dist/types.d.ts:329
 
 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:362
+Defined in: packages/framework/esm-globals/dist/types.d.ts:313
 
 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:372
+Defined in: packages/framework/esm-globals/dist/types.d.ts:323
 
 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:358
+Defined in: packages/framework/esm-globals/dist/types.d.ts:309
 
 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:382
+Defined in: packages/framework/esm-globals/dist/types.d.ts:333
 
 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:380
+Defined in: packages/framework/esm-globals/dist/types.d.ts:331
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.

package/docs/interfaces/OpenmrsDatePickerProps.md

@@ -747,7 +747,7 @@ prop instead.
 
 ### validationBehavior?
 
-> `optional` **validationBehavior**: `"aria"` \| `"native"`
+> `optional` **validationBehavior**: `"native"` \| `"aria"`
 
 Defined in: node\_modules/react-aria-components/dist/types.d.ts:81
 

package/docs/interfaces/OpenmrsDateRangePickerProps.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsDateRangePickerProps
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L36)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L32)
 
 ## Extends
 
@@ -113,7 +113,7 @@ The children of the component. A function may be provided to alter the children
 
 > `optional` **className**: `Argument`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L39)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L35)
 
 Any CSS classes to add to the outer div of the date picker
 
@@ -137,7 +137,7 @@ Whether the overlay is open by default (uncontrolled).
 
 > `optional` **defaultValue**: \[`DateInputValue`, `DateInputValue`\]
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L41)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L37)
 
 The default value (uncontrolled)
 
@@ -237,7 +237,7 @@ The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/d
 
 > `optional` **invalid**: `boolean`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L43)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L39)
 
 Whether the input value is invalid.
 
@@ -247,7 +247,7 @@ Whether the input value is invalid.
 
 > `optional` **invalidText**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L45)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L41)
 
 Text to show if the input is invalid e.g. an error message
 
@@ -351,7 +351,7 @@ Whether user input is required on the input before form submission.
 
 > `optional` **label**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L50)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L46)
 
 The label for this DatePicker element
 
@@ -365,7 +365,7 @@ Use labelText instead
 
 > `optional` **labelText**: `string` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L52)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L48)
 
 The label for this DatePicker element.
 
@@ -375,7 +375,7 @@ The label for this DatePicker element.
 
 > `optional` **light**: `boolean`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L54)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L50)
 
 'true' to use the light version.
 
@@ -385,7 +385,7 @@ Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-ra
 
 > `optional` **maxDate**: `DateInputValue`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L56)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L52)
 
 The latest date it is possible to select
 
@@ -409,7 +409,7 @@ The maximum allowed date that a user may select.
 
 > `optional` **minDate**: `DateInputValue`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L58)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L54)
 
 The earliest date it is possible to select
 
@@ -457,7 +457,7 @@ Handler that is called when the element loses focus.
 
 > `optional` **onChange**: (`value`) => `void`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L60)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L56)
 
 Handler that is called when the value changes.
 
@@ -477,7 +477,7 @@ Handler that is called when the value changes.
 
 > `optional` **onChangeRaw**: (`value`) => `void`
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L62)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L58)
 
 Handler that is called when the value changes. Note that this provides types from @internationalized/date.
 
@@ -754,7 +754,7 @@ prop instead.
 
 ### validationBehavior?
 
-> `optional` **validationBehavior**: `"aria"` \| `"native"`
+> `optional` **validationBehavior**: `"native"` \| `"aria"`
 
 Defined in: node\_modules/react-aria-components/dist/types.d.ts:81
 
@@ -778,6 +778,6 @@ or invalid via ARIA.
 
 > `optional` **value**: \[`DateInputValue`, `DateInputValue`\]
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L64)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/date-range/date-range-picker.component.tsx#L60)
 
 The value (controlled)

package/docs/interfaces/ResourceLoader.md

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

package/docs/interfaces/SpaConfig.md

@@ -2,7 +2,7 @@
 
 # Interface: SpaConfig
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:80
+Defined in: packages/framework/esm-globals/dist/types.d.ts:79
 
 The configuration passed to the app shell initialization function
 
@@ -12,7 +12,7 @@ The configuration passed to the app shell initialization function
 
 > **apiUrl**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:84
+Defined in: packages/framework/esm-globals/dist/types.d.ts:83
 
 The base path or URL for the OpenMRS API / endpoints.
 
@@ -22,7 +22,7 @@ The base path or URL for the OpenMRS API / endpoints.
 
 > `optional` **configUrls**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:97
+Defined in: packages/framework/esm-globals/dist/types.d.ts:96
 
 URLs of configurations to load in the system.
 
@@ -32,7 +32,7 @@ URLs of configurations to load in the system.
 
 > `optional` **env**: [`SpaEnvironment`](../type-aliases/SpaEnvironment.md)
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:93
+Defined in: packages/framework/esm-globals/dist/types.d.ts:92
 
 The environment to use.
 
@@ -48,7 +48,7 @@ production
 
 > `optional` **offline**: `boolean`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:102
+Defined in: packages/framework/esm-globals/dist/types.d.ts:101
 
 Defines if offline should be supported by installing a service worker.
 
@@ -64,6 +64,6 @@ true
 
 > **spaPath**: `string`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:88
+Defined in: packages/framework/esm-globals/dist/types.d.ts:87
 
 The base path for the SPA root path.

package/docs/interfaces/WorkspaceGroupDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceGroupDefinition
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:334
+Defined in: packages/framework/esm-globals/dist/types.d.ts:285
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: packages/framework/esm-globals/dist/types.d.ts:334
 
 > `optional` **members**: `string`[]
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:342
+Defined in: packages/framework/esm-globals/dist/types.d.ts:293
 
 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:338
+Defined in: packages/framework/esm-globals/dist/types.d.ts:289
 
 Name of the workspace group. This is used to launch the workspace group

package/docs/interfaces/WorkspaceRegistration.md

@@ -32,18 +32,6 @@ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:20](https://git
 
 ***
 
-### load()
-
-> **load**: () => `Promise`\<`object` & `LifeCycles`\>
-
-Defined in: [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)
-
-#### Returns
-
-`Promise`\<`object` & `LifeCycles`\>
-
-***
-
 ### moduleName
 
 > **moduleName**: `string`
@@ -97,3 +85,15 @@ Defined in: [packages/framework/esm-extensions/src/workspaces.ts:13](https://git
 > **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
 Defined in: [packages/framework/esm-extensions/src/workspaces.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/workspaces.ts#L16)
+
+## Methods
+
+### load()
+
+> **load**(): `Promise`\<`LifeCycles`\>
+
+Defined in: [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)
+
+#### Returns
+
+`Promise`\<`LifeCycles`\>

package/docs/type-aliases/ExtensionDefinition.md

@@ -2,68 +2,112 @@
 
 # Type Alias: ExtensionDefinition
 
-> **ExtensionDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
+> **ExtensionDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:171
+Defined in: packages/framework/esm-globals/dist/types.d.ts:170
 
 A definition of an extension as extracted from an app's routes.json
 
-## Type declaration
+## Properties
+
+### component
+
+> **component**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:212
+
+The name of the component exported by this frontend module.
+
+***
 
 ### featureFlag?
 
 > `optional` **featureFlag**: `string`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:202
+
 If supplied, the extension will only be rendered when this feature flag is enabled.
 
+***
+
 ### meta?
 
 > `optional` **meta**: `object`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:206
+
 Meta describes any properties that are passed down to the extension when it is loaded
 
 #### Index Signature
 
 \[`k`: `string`\]: `unknown`
 
+***
+
 ### name
 
 > **name**: `string`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:174
+
 The name of this extension. This is used to refer to the extension in configuration.
 
+***
+
 ### offline?
 
 > `optional` **offline**: `boolean`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:190
+
 Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
 
+***
+
 ### online?
 
 > `optional` **online**: `boolean`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:186
+
 Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
 
+***
+
 ### order?
 
 > `optional` **order**: `number`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:194
+
 Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
 
+***
+
 ### privileges?
 
 > `optional` **privileges**: `string` \| `string`[]
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:198
+
 The user must have ANY of these privileges to see this extension.
 
+***
+
 ### slot?
 
 > `optional` **slot**: `string`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:178
+
 If supplied, the slot that this extension is rendered into by default.
 
+***
+
 ### slots?
 
 > `optional` **slots**: `string`[]
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:182
+
 If supplied, the slots that this extension is rendered into by default.

package/docs/type-aliases/ModalDefinition.md

@@ -2,16 +2,28 @@
 
 # Type Alias: ModalDefinition
 
-> **ModalDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
+> **ModalDefinition** = `object`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:234
+Defined in: packages/framework/esm-globals/dist/types.d.ts:217
 
 A definition of a modal as extracted from an app's routes.json
 
-## Type declaration
+## Properties
+
+### component
+
+> **component**: `string`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:225
+
+The name of the component exported by this frontend module.
+
+***
 
 ### name
 
 > **name**: `string`
 
+Defined in: packages/framework/esm-globals/dist/types.d.ts:221
+
 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:392
+Defined in: packages/framework/esm-globals/dist/types.d.ts:343

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:388
+Defined in: packages/framework/esm-globals/dist/types.d.ts:339
 
-This interfaces describes the format of the overall rotues.json loaded by the app shell.
+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/PageDefinition.md

@@ -4,7 +4,7 @@
 
 > **PageDefinition** = `object` & \{ `route`: `string` \| `boolean`; `routeRegex?`: `never`; \} \| \{ `route?`: `never`; `routeRegex`: `string`; \}
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:113
+Defined in: packages/framework/esm-globals/dist/types.d.ts:112
 
 A definition of a page extracted from an app's routes.json
 

package/docs/type-aliases/SpaEnvironment.md

@@ -4,4 +4,4 @@
 
 > **SpaEnvironment** = `"production"` \| `"development"` \| `"test"`
 
-Defined in: packages/framework/esm-globals/dist/types.d.ts:73
+Defined in: packages/framework/esm-globals/dist/types.d.ts:72