@openmrs/esm-framework 10.0.1-pre.5630 → 10.0.1-pre.5642

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 4 files with swc (164.47ms)
+[0] Successfully compiled: 4 files with swc (136.72ms)
 [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/clearCurrentUser.md

@@ -4,7 +4,7 @@
 
 > **clearCurrentUser**(): `void`
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:276](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L276)
+Defined in: [packages/framework/esm-api/src/current-user.ts:291](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L291)
 
 Clears the current user session from the session store, setting the session
 to an unauthenticated state. This is typically called during logout to reset

package/docs/functions/getCoreTranslation.md

@@ -19,7 +19,7 @@ invalid key to this function will result in a type error.
 
 The translation key from the set of core translations.
 
-`"error"` | `"cancel"` | `"change"` | `"close"` | `"unknown"` | `"state"` | `"Clinic"` | `"abnormalValue"` | `"actions"` | `"actionableNotification"` | `"address"` | `"age"` | `"batchActionItemSelected"` | `"batchActionsItemsSelected"` | `"closesActionableNotification"` | `"closeSnackbar"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"delete"` | `"discardChanges"` | `"edit"` | `"emptyStateText"` | `"errorCopy"` | `"errorLoadingLoginLocations"` | `"female"` | `"leftNavigation"` | `"loading"` | `"localVersion"` | `"male"` | `"navigateNonHttp"` | `"noResultsToDisplay"` | `"notAvailable"` | `"other"` | `"paginationItemsCount"` | `"paginationOfPages"` | `"patientAvatarAlt"` | `"patientIdentifierSticker"` | `"patientLists"` | `"patientPhotoAlt"` | `"patientPhotoPlaceholder"` | `"prereleaseVersion"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"recordNewEntry"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"searchForLocation"` | `"seeAll"` | `"seeMoreLists"` | `"selectAll"` | `"sex"` | `"showLess"` | `"showMore"` | `"snackbarNotification"` | `"toggleDevTools"` | `"yearAbbreviation"` | `"yearsAbbreviation"` | `"discardUnsavedChangesPromptBodyMultiple"` | `"discardUnsavedChangesPromptBodySingle"` | `"discardUnsavedChangesPromptTitle"` | `"keepEditing"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"stateProvince"`
+`"error"` | `"cancel"` | `"change"` | `"close"` | `"unknown"` | `"state"` | `"Clinic"` | `"abnormalValue"` | `"actions"` | `"actionableNotification"` | `"address"` | `"age"` | `"applicationError"` | `"batchActionItemSelected"` | `"batchActionsItemsSelected"` | `"clearDevOverrides"` | `"closesActionableNotification"` | `"closeSnackbar"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"copied"` | `"copyToClipboard"` | `"delete"` | `"discardChanges"` | `"edit"` | `"emptyStateText"` | `"errorCopy"` | `"errorLoadingLoginLocations"` | `"female"` | `"leftNavigation"` | `"loading"` | `"localVersion"` | `"male"` | `"navigateNonHttp"` | `"noResultsToDisplay"` | `"notAvailable"` | `"other"` | `"paginationItemsCount"` | `"paginationOfPages"` | `"patientAvatarAlt"` | `"patientIdentifierSticker"` | `"patientLists"` | `"patientPhotoAlt"` | `"patientPhotoPlaceholder"` | `"prereleaseVersion"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"recordNewEntry"` | `"relationships"` | `"reload"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"searchForLocation"` | `"seeAll"` | `"seeMoreLists"` | `"selectAll"` | `"serverStartingUp"` | `"serverStartingUpExplainer"` | `"serverStartingUpSlowExplainer"` | `"sex"` | `"showLess"` | `"showMore"` | `"snackbarNotification"` | `"somethingWentWrongTryReloading"` | `"toggleDevTools"` | `"viewSetupProgress"` | `"waitingForServer"` | `"yearAbbreviation"` | `"yearsAbbreviation"` | `"discardUnsavedChangesPromptBodyMultiple"` | `"discardUnsavedChangesPromptBodySingle"` | `"discardUnsavedChangesPromptTitle"` | `"keepEditing"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"stateProvince"`
 
 ### defaultText?
 

package/docs/functions/getCurrentUser.md

@@ -6,7 +6,7 @@
 
 > **getCurrentUser**(): `Promise`\<[`Session`](../interfaces/Session.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L91)
+Defined in: [packages/framework/esm-api/src/current-user.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L105)
 
 The getCurrentUser function returns a Promise that resolves once with the
 current user's session. If the session hasn't been loaded, was loaded more than
@@ -44,7 +44,7 @@ console.log(session.authenticated)
 
 > **getCurrentUser**(`opts`): `Promise`\<[`Session`](../interfaces/Session.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L98)
+Defined in: [packages/framework/esm-api/src/current-user.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L112)
 
 ### Parameters
 
@@ -69,7 +69,7 @@ A Promise resolving to a [Session](../interfaces/Session.md) object.
 
 > **getCurrentUser**(`opts`): `Promise`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L105)
+Defined in: [packages/framework/esm-api/src/current-user.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L119)
 
 ### Parameters
 

package/docs/functions/getLoggedInUser.md

@@ -4,7 +4,7 @@
 
 > **getLoggedInUser**(): `Promise`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:336](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L336)
+Defined in: [packages/framework/esm-api/src/current-user.ts:351](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L351)
 
 Returns a Promise that resolves with the currently logged-in user object.
 If the user is already loaded in the session store, the Promise resolves immediately.

package/docs/functions/getSessionLocation.md

@@ -4,7 +4,7 @@
 
 > **getSessionLocation**(): `Promise`\<`undefined` \| [`SessionLocation`](../interfaces/SessionLocation.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:374](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L374)
+Defined in: [packages/framework/esm-api/src/current-user.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L389)
 
 Returns a Promise that resolves with the current session location, if one is set.
 The session location represents the physical location where the user is currently

package/docs/functions/getSessionStore.md

@@ -4,7 +4,7 @@
 
 > **getSessionStore**(): `StoreApi`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:150](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L150)
+Defined in: [packages/framework/esm-api/src/current-user.ts:164](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L164)
 
 Returns the global session store containing the current user's session information.
 If the session data is stale (older than 1 minute) or not yet loaded, this function

package/docs/functions/refetchCurrentUser.md

@@ -4,7 +4,7 @@
 
 > **refetchCurrentUser**(`username?`, `password?`): `Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:237](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L237)
+Defined in: [packages/framework/esm-api/src/current-user.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L251)
 
 The `refetchCurrentUser` function causes a network request to redownload
 the user. All subscribers to the session store will be notified of the

package/docs/functions/setSessionLocation.md

@@ -4,7 +4,7 @@
 
 > **setSessionLocation**(`locationUuid`, `abortController?`): `Promise`\<`any`\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:396](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L396)
+Defined in: [packages/framework/esm-api/src/current-user.ts:411](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L411)
 
 Sets the session location for the current user. The session location represents
 the physical location where the user is working (e.g., a clinic or ward).

package/docs/functions/setUserLanguage.md

@@ -4,7 +4,7 @@
 
 > **setUserLanguage**(`data`): `void`
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L181)
+Defined in: [packages/framework/esm-api/src/current-user.ts:195](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L195)
 
 Sets the document's language attribute based on the user's locale preference
 from the session data. This affects the HTML `lang` attribute which is used

package/docs/functions/setUserProperties.md

@@ -4,7 +4,7 @@
 
 > **setUserProperties**(`userUuid`, `userProperties`, `abortController?`): `Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:463](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L463)
+Defined in: [packages/framework/esm-api/src/current-user.ts:478](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L478)
 
 Updates the user properties for a specific user. User properties are key-value
 pairs that store user-specific settings and preferences. After updating the

package/docs/functions/userHasAccess.md

@@ -4,7 +4,7 @@
 
 > **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:304](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L304)
+Defined in: [packages/framework/esm-api/src/current-user.ts:319](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L319)
 
 Checks whether the given user has access based on the required privilege(s).
 A user has access if they have the required privilege(s) or if they are a

package/docs/interfaces/StyleguideConfigObject.md

@@ -2,7 +2,7 @@
 
 # Interface: StyleguideConfigObject
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L3)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L4)
 
 ## Properties
 
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:3](https://g
 
 > **Brand color #1**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L4)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L5)
 
 ***
 
@@ -18,7 +18,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:4](https://g
 
 > **Brand color #2**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L5)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L6)
 
 ***
 
@@ -26,7 +26,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:5](https://g
 
 > **Brand color #3**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L6)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L7)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:6](https://g
 
 > **diagnosisTags**: `object`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L18)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L23)
 
 #### primaryColor
 
@@ -50,7 +50,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:18](https://
 
 > **excludePatientIdentifierCodeTypes**: `object`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L7)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L8)
 
 #### uuids
 
@@ -62,7 +62,23 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:7](https://g
 
 > **implementationName**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L10)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L11)
+
+***
+
+### logo
+
+> **logo**: `object`
+
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L12)
+
+#### alt
+
+> **alt**: `string`
+
+#### src
+
+> **src**: `string`
 
 ***
 
@@ -70,7 +86,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:10](https://
 
 > **patientPhotoConceptUuid**: `string`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L11)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L16)
 
 ***
 
@@ -78,7 +94,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:11](https://
 
 > **preferredCalendar**: `object`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L12)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L17)
 
 #### Index Signature
 
@@ -90,7 +106,7 @@ Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:12](https://
 
 > **preferredDateLocale**: `object`
 
-Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L15)
+Defined in: [packages/framework/esm-styleguide/src/config-schema.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/config-schema.ts#L20)
 
 #### Index Signature
 

package/docs/type-aliases/UnloadedSessionStore.md

@@ -18,6 +18,18 @@ Set when fetching the session failed before any session had loaded.
 
 ***
 
+### initializing?
+
+> `optional` **initializing**: `boolean`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L25)
+
+Set alongside `error`. `true` when the backend appears to be still starting up rather than broken:
+it redirected the session request to its initial setup page, or its gateway answered with a 502
+shortly after the page loaded.
+
+***
+
 ### loaded
 
 > **loaded**: `false`

package/package.json

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