@openmrs/esm-framework 10.0.1-pre.5227 → 10.0.1-pre.5251

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 3 files with swc (145.1ms)
+[0] Successfully compiled: 3 files with swc (96.16ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/docs/functions/getVisitStore.md

@@ -4,7 +4,7 @@
 
 > **getVisitStore**(): `StoreApi`\<[`VisitStoreState`](../interfaces/VisitStoreState.md)\>
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L78)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L68)
 
 Returns the global visit store that manages the current visit state. The store
 contains information about the current patient's visit and provides methods

package/docs/functions/getVisitsForPatient.md

@@ -4,7 +4,7 @@
 
 > **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<\{ `results`: [`Visit`](../interfaces/Visit.md)[]; \}\>\>
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:183](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L183)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:173](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L173)
 
 ## Parameters
 

package/docs/functions/saveVisit.md

@@ -4,7 +4,7 @@
 
 > **saveVisit**(`payload`, `abortController`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:137](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L137)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L127)
 
 Creates a new visit by sending a POST request to the OpenMRS REST API.
 

package/docs/functions/setCurrentVisit.md

@@ -4,7 +4,7 @@
 
 > **setCurrentVisit**(`patientUuid`, `visitUuid`): `void`
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L98)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L88)
 
 Sets the current visit for a patient in the global visit store. This is used
 to manually specify which visit should be considered "active" for the given patient.

package/docs/functions/updateVisit.md

@@ -4,7 +4,7 @@
 
 > **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<[`Visit`](../interfaces/Visit.md)\>\>
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L165)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:155](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L155)
 
 Updates an existing visit by sending a POST request to the OpenMRS REST API.
 

package/docs/functions/useVisitContextStore.md

@@ -2,9 +2,9 @@
 
 # Function: useVisitContextStore()
 
-> **useVisitContextStore**(`mutateVisitCallback?`): [`VisitStoreState`](../interfaces/VisitStoreState.md) & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
+> **useVisitContextStore**(`mutateVisitCallback?`): `object`
 
-Defined in: [packages/framework/esm-react-utils/src/useVisitContextStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitContextStore.ts#L30)
+Defined in: [packages/framework/esm-react-utils/src/useVisitContextStore.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitContextStore.ts#L44)
 
 A hook to return the visit context store and corresponding actions.
 
@@ -15,9 +15,43 @@ A hook to return the visit context store and corresponding actions.
 () => `void`
 
 An optional mutate callback to register. If provided, the
-store action's `mutateVisit` function will invoke this callback (along with any other
-callbacks also registered into the store)
+returned `mutateVisit` function will invoke this callback (along with any other
+callbacks registered by other components). Pass a callback with a stable identity;
+one that changes on every render re-registers on every render.
 
 ## Returns
 
-[`VisitStoreState`](../interfaces/VisitStoreState.md) & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null`; `patientUuid?`: `undefined`; \} \| \{ `manuallySetVisitUuid`: `string`; `patientUuid`: `undefined` \| `string`; \}; \}\>
+### manuallySetVisitUuid
+
+> **manuallySetVisitUuid**: `null` \| `string`
+
+### mutateVisit()
+
+> **mutateVisit**: () => `void`
+
+Invokes every registered mutate callback, revalidating visit data across the application.
+
+Iterates over a copy so that a callback which registers or unregisters another does not
+disturb the traversal.
+
+#### Returns
+
+`void`
+
+### patientUuid
+
+> **patientUuid**: `null` \| `string`
+
+### setVisitContext()
+
+> **setVisitContext**(...`args`): `void`
+
+#### Parameters
+
+##### args
+
+...\[`null` \| [`Visit`](../interfaces/Visit.md)\]
+
+#### Returns
+
+`void`

package/docs/interfaces/FeatureFlagDefinition.md

@@ -2,7 +2,7 @@
 
 # Interface: FeatureFlagDefinition
 
-Defined in: [packages/framework/esm-globals/src/types.ts:350](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L350)
+Defined in: [packages/framework/esm-globals/src/types.ts:354](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L354)
 
 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/src/types.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L356)
+Defined in: [packages/framework/esm-globals/src/types.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L360)
 
 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/src/types.ts:352](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L352)
+Defined in: [packages/framework/esm-globals/src/types.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L356)
 
 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/src/types.ts:354](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L354)
+Defined in: [packages/framework/esm-globals/src/types.ts:358](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L358)
 
 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/src/types.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L360)
+Defined in: [packages/framework/esm-globals/src/types.ts:364](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L364)
 
 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/src/types.ts:364](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L364)
+Defined in: [packages/framework/esm-globals/src/types.ts:368](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L368)
 
 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/src/types.ts:380](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L380)
+Defined in: [packages/framework/esm-globals/src/types.ts:384](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L384)
 
 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/src/types.ts:382](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L382)
+Defined in: [packages/framework/esm-globals/src/types.ts:386](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L386)
 
 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/src/types.ts:384](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L384)
+Defined in: [packages/framework/esm-globals/src/types.ts:388](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L388)
 
 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/src/types.ts:366](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L366)
+Defined in: [packages/framework/esm-globals/src/types.ts:370](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L370)
 
 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/src/types.ts:378](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L378)
+Defined in: [packages/framework/esm-globals/src/types.ts:382](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L382)
 
 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/src/types.ts:362](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L362)
+Defined in: [packages/framework/esm-globals/src/types.ts:366](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L366)
 
 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/src/types.ts:388](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L388)
+Defined in: [packages/framework/esm-globals/src/types.ts:392](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L392)
 
 An array of all workspace groups supported by this frontend module.
 
@@ -98,7 +98,7 @@ An array of all workspace groups supported by this frontend module.
 
 > `optional` **workspaceGroups2**: [`WorkspaceGroupDefinition2`](WorkspaceGroupDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:391](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L391)
+Defined in: [packages/framework/esm-globals/src/types.ts:395](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L395)
 
 An array of all workspace groups (v2) supported by this frontend module.
 
@@ -108,7 +108,7 @@ An array of all workspace groups (v2) supported by this frontend module.
 
 > `optional` **workspaces**: [`WorkspaceDefinition`](../type-aliases/WorkspaceDefinition.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:386](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L386)
+Defined in: [packages/framework/esm-globals/src/types.ts:390](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L390)
 
 An array of all workspaces supported by this frontend module. Workspaces can be launched by name.
 
@@ -118,7 +118,7 @@ An array of all workspaces supported by this frontend module. Workspaces can be
 
 > `optional` **workspaces2**: [`WorkspaceDefinition2`](WorkspaceDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:397](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L397)
+Defined in: [packages/framework/esm-globals/src/types.ts:401](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L401)
 
 An array of all workspaces (v2) supported by this frontend module.
 
@@ -128,6 +128,6 @@ An array of all workspaces (v2) supported by this frontend module.
 
 > `optional` **workspaceWindows2**: [`WorkspaceWindowDefinition2`](WorkspaceWindowDefinition2.md)[]
 
-Defined in: [packages/framework/esm-globals/src/types.ts:394](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L394)
+Defined in: [packages/framework/esm-globals/src/types.ts:398](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L398)
 
 An array of all workspace windows (v2) supported by this frontend module.

package/docs/interfaces/OpenmrsRoutes.md

@@ -2,7 +2,7 @@
 
 # Interface: OpenmrsRoutes
 
-Defined in: [packages/framework/esm-globals/src/types.ts:404](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L404)
+Defined in: [packages/framework/esm-globals/src/types.ts:408](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L408)
 
 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
@@ -13,7 +13,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
 
 > **routes**: `Record`\<`Exclude`\<`string`, `"version"`\>, [`OpenmrsAppRoutes`](OpenmrsAppRoutes.md)\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:408](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L408)
+Defined in: [packages/framework/esm-globals/src/types.ts:412](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L412)
 
 The routes associated with this application keyed by module id
 
@@ -23,6 +23,6 @@ The routes associated with this application keyed by module id
 
 > `optional` **version**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:406](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L406)
+Defined in: [packages/framework/esm-globals/src/types.ts:410](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L410)
 
 The overall version for this application

package/docs/interfaces/ResourceLoader.md

@@ -2,7 +2,7 @@
 
 # Interface: ResourceLoader()\<T\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:411](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L411)
+Defined in: [packages/framework/esm-globals/src/types.ts:415](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L415)
 
 ## Type Parameters
 
@@ -12,7 +12,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:411](https://github.com
 
 > **ResourceLoader**(): `Promise`\<`T`\>
 
-Defined in: [packages/framework/esm-globals/src/types.ts:412](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L412)
+Defined in: [packages/framework/esm-globals/src/types.ts:416](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L416)
 
 ## Returns
 

package/docs/interfaces/VisitStoreState.md

@@ -14,22 +14,6 @@ Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:27](https://githu
 
 ***
 
-### mutateVisitCallbacks
-
-> **mutateVisitCallbacks**: `object`
-
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L34)
-
-Stores a record of SWR mutate callbacks that should be called when
-the Visit with the specified uuid is modified. The callbacks are keyed
-by unique component IDs.
-
-#### Index Signature
-
-\[`componentId`: `string`\]: () => `void`
-
-***
-
 ### patientUuid
 
 > **patientUuid**: `null` \| `string`

package/docs/interfaces/WorkspaceDefinition2.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceDefinition2
 
-Defined in: [packages/framework/esm-globals/src/types.ts:341](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L341)
+Defined in: [packages/framework/esm-globals/src/types.ts:345](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L345)
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:341](https://github.com
 
 > **component**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:343](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L343)
+Defined in: [packages/framework/esm-globals/src/types.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L347)
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:343](https://github.com
 
 > **name**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:342](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L342)
+Defined in: [packages/framework/esm-globals/src/types.ts:346](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L346)
 
 ***
 
@@ -26,4 +26,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:342](https://github.com
 
 > **window**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:344](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L344)
+Defined in: [packages/framework/esm-globals/src/types.ts:348](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L348)

package/docs/interfaces/WorkspaceGroupDefinition2.md

@@ -50,9 +50,13 @@ with any opened windows / workspaces.
 
 > `optional` **scopePattern**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:329](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L329)
+Defined in: [packages/framework/esm-globals/src/types.ts:333](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L333)
 
 URL pattern that defines the scope where workspaces in this group should persist.
+The pattern is matched against the pathname relative to the configured SPA base path.
+Navigating outside the configured SPA base path closes the workspace group.
+For backward compatibility, if the pattern does not match both SPA-relative pathnames, it is
+retried against both full pathnames.
 - If not defined: workspaces close only when navigating to a different app
 - If defined without capture groups: workspaces close when URL doesn't match pattern
 - If defined with capture groups: workspaces close when captured values change

package/docs/interfaces/WorkspaceWindowDefinition2.md

@@ -2,7 +2,7 @@
 
 # Interface: WorkspaceWindowDefinition2
 
-Defined in: [packages/framework/esm-globals/src/types.ts:332](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L332)
+Defined in: [packages/framework/esm-globals/src/types.ts:336](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L336)
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:332](https://github.com
 
 > `optional` **canMaximize**: `boolean`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:335](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L335)
+Defined in: [packages/framework/esm-globals/src/types.ts:339](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L339)
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:335](https://github.com
 
 > **group**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:336](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L336)
+Defined in: [packages/framework/esm-globals/src/types.ts:340](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L340)
 
 ***
 
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:336](https://github.com
 
 > `optional` **icon**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L334)
+Defined in: [packages/framework/esm-globals/src/types.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L338)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:334](https://github.com
 
 > **name**: `string`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:333](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L333)
+Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L337)
 
 ***
 
@@ -42,7 +42,7 @@ Defined in: [packages/framework/esm-globals/src/types.ts:333](https://github.com
 
 > `optional` **order**: `number`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L337)
+Defined in: [packages/framework/esm-globals/src/types.ts:341](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L341)
 
 ***
 
@@ -50,4 +50,4 @@ Defined in: [packages/framework/esm-globals/src/types.ts:337](https://github.com
 
 > `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L338)
+Defined in: [packages/framework/esm-globals/src/types.ts:342](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L342)

package/docs/type-aliases/NameUse.md

@@ -4,4 +4,4 @@
 
 > **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
 
-Defined in: [packages/framework/esm-globals/src/types.ts:418](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L418)
+Defined in: [packages/framework/esm-globals/src/types.ts:422](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L422)

package/docs/variables/defaultVisitCustomRepresentation.md

@@ -4,7 +4,7 @@
 
 > `const` **defaultVisitCustomRepresentation**: `string`
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L44)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L35)
 
 The default custom representation string for fetching visit data from the REST API.
 This representation includes comprehensive visit details such as encounters, patient,

package/docs/variables/getStartedVisit.md

@@ -4,6 +4,6 @@
 
 > `const` **getStartedVisit**: `BehaviorSubject`\<`null` \| [`VisitItem`](../interfaces/VisitItem.md)\>
 
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L200)
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:190](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L190)
 
 ## Deprecated

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "10.0.1-pre.5227",
+  "version": "10.0.1-pre.5251",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/index.js",
@@ -59,24 +59,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "10.0.1-pre.5227",
-    "@openmrs/esm-config": "10.0.1-pre.5227",
-    "@openmrs/esm-context": "10.0.1-pre.5227",
-    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5227",
-    "@openmrs/esm-emr-api": "10.0.1-pre.5227",
-    "@openmrs/esm-error-handling": "10.0.1-pre.5227",
-    "@openmrs/esm-expression-evaluator": "10.0.1-pre.5227",
-    "@openmrs/esm-extensions": "10.0.1-pre.5227",
-    "@openmrs/esm-feature-flags": "10.0.1-pre.5227",
-    "@openmrs/esm-globals": "10.0.1-pre.5227",
-    "@openmrs/esm-navigation": "10.0.1-pre.5227",
-    "@openmrs/esm-offline": "10.0.1-pre.5227",
-    "@openmrs/esm-react-utils": "10.0.1-pre.5227",
-    "@openmrs/esm-routes": "10.0.1-pre.5227",
-    "@openmrs/esm-state": "10.0.1-pre.5227",
-    "@openmrs/esm-styleguide": "10.0.1-pre.5227",
-    "@openmrs/esm-translations": "10.0.1-pre.5227",
-    "@openmrs/esm-utils": "10.0.1-pre.5227"
+    "@openmrs/esm-api": "10.0.1-pre.5251",
+    "@openmrs/esm-config": "10.0.1-pre.5251",
+    "@openmrs/esm-context": "10.0.1-pre.5251",
+    "@openmrs/esm-dynamic-loading": "10.0.1-pre.5251",
+    "@openmrs/esm-emr-api": "10.0.1-pre.5251",
+    "@openmrs/esm-error-handling": "10.0.1-pre.5251",
+    "@openmrs/esm-expression-evaluator": "10.0.1-pre.5251",
+    "@openmrs/esm-extensions": "10.0.1-pre.5251",
+    "@openmrs/esm-feature-flags": "10.0.1-pre.5251",
+    "@openmrs/esm-globals": "10.0.1-pre.5251",
+    "@openmrs/esm-navigation": "10.0.1-pre.5251",
+    "@openmrs/esm-offline": "10.0.1-pre.5251",
+    "@openmrs/esm-react-utils": "10.0.1-pre.5251",
+    "@openmrs/esm-routes": "10.0.1-pre.5251",
+    "@openmrs/esm-state": "10.0.1-pre.5251",
+    "@openmrs/esm-styleguide": "10.0.1-pre.5251",
+    "@openmrs/esm-translations": "10.0.1-pre.5251",
+    "@openmrs/esm-utils": "10.0.1-pre.5251"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -89,7 +89,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5227",
+    "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5251",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",