@openmrs/esm-framework 10.0.1-pre.5141 → 10.0.1-pre.5147

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 3 files with swc (149.33ms)
+[0] Successfully compiled: 3 files with swc (94.91ms)
 [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:230](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L230)
+Defined in: [packages/framework/esm-api/src/current-user.ts:234](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L234)
 
 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/getLocale.md

@@ -4,7 +4,7 @@
 
 > **getLocale**(): `string`
 
-Defined in: [packages/framework/esm-utils/src/get-locale.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/get-locale.ts#L5)
+Defined in: [packages/framework/esm-utils/src/get-locale.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/get-locale.ts#L7)
 
 Returns the current locale of the application.
 

package/docs/functions/getLocaleDisplayName.md

@@ -0,0 +1,37 @@
+[O3 Framework](../API.md) / getLocaleDisplayName
+
+# Function: getLocaleDisplayName()
+
+> **getLocaleDisplayName**(`locale`): `string`
+
+Defined in: [packages/framework/esm-utils/src/language-tag.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/language-tag.ts#L54)
+
+Returns the name of a locale as written in that locale, so `fr` becomes "français" and `sw_KE`
+becomes "Kiswahili (Kenya)". Falls back to the identifier itself for anything `Intl` cannot
+resolve, so the result is always safe to render.
+
+The name is CLDR's middle-of-sentence form. When presenting it as a standalone label, capitalize
+only the first character: lowercasing the remainder corrupts names carrying internal capitals,
+turning "American English" into "American english".
+
+## Parameters
+
+### locale
+
+An OpenMRS locale identifier, e.g. `sw_KE`.
+
+`undefined` | `null` | `string`
+
+## Returns
+
+`string`
+
+The locale's name in its own language, `locale` itself if it cannot be resolved, or an
+  empty string if no locale was given.
+
+## Example
+
+```ts
+getLocaleDisplayName('fr'); // => 'français'
+getLocaleDisplayName('sw_KE'); // => 'Kiswahili (Kenya)'
+```

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:287](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L287)
+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)
 
 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:325](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L325)
+Defined in: [packages/framework/esm-api/src/current-user.ts:329](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L329)
 
 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/matchLocale.md

@@ -4,7 +4,7 @@
 
 > **matchLocale**(`requested`, `available`, `fallback?`): `undefined` \| `string`
 
-Defined in: [packages/framework/esm-utils/src/match-locale.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/match-locale.ts#L53)
+Defined in: [packages/framework/esm-utils/src/match-locale.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/match-locale.ts#L35)
 
 Resolves a requested locale against a list of available locales using the
 BCP 47 lookup algorithm (RFC 4647, §3.4).

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:204](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L204)
+Defined in: [packages/framework/esm-api/src/current-user.ts:208](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L208)
 
 The `refetchCurrentUser` function causes a network request to redownload
 the user. All subscribers to the current user 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:351](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L351)
+Defined in: [packages/framework/esm-api/src/current-user.ts:355](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L355)
 
 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/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:387](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L387)
+Defined in: [packages/framework/esm-api/src/current-user.ts:391](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L391)
 
 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/toLanguageTag.md

@@ -0,0 +1,44 @@
+[O3 Framework](../API.md) / toLanguageTag
+
+# Function: toLanguageTag()
+
+> **toLanguageTag**(`locale`): `undefined` \| `string`
+
+Defined in: [packages/framework/esm-utils/src/language-tag.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/language-tag.ts#L25)
+
+Converts an OpenMRS locale identifier into a canonical BCP 47 language tag.
+
+OpenMRS locale identifiers are not always language tags. User properties such as
+`defaultLocale` store Java's `Locale#toString()` form (`en_US`, `sw_KE`) verbatim, some backends
+serialize session locales the same way, and some installs configure POSIX-style variants
+(`uz@Latn`). The `Intl` constructors throw `RangeError` rather than degrading when handed any of
+them, so convert before passing an OpenMRS locale to `Intl`.
+
+Both `_` and `@` are treated as subtag separators, which covers the `@Latn` script modifier.
+Other POSIX modifiers have no BCP 47 equivalent and parse as whatever their length implies
+(`de@euro` becomes the script subtag `de-Euro`), so they are converted rather than rejected.
+
+## Parameters
+
+### locale
+
+An OpenMRS locale identifier, e.g. `sw_KE`. Locale data reaching this function
+  comes from the REST session and from configuration, so anything that is not a string is
+  treated as an unresolvable locale rather than an error.
+
+`undefined` | `null` | `string`
+
+## Returns
+
+`undefined` \| `string`
+
+The canonical language tag, or `undefined` if `locale` is not a structurally valid tag.
+
+## Example
+
+```ts
+toLanguageTag('sw_KE'); // => 'sw-KE'
+toLanguageTag('uz@Latn'); // => 'uz-Latn'
+toLanguageTag('en_us'); // => 'en-US'
+toLanguageTag('not a locale'); // => undefined
+```

package/docs/functions/userHasAccess.md

@@ -4,7 +4,7 @@
 
 > **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
 
-Defined in: [packages/framework/esm-api/src/current-user.ts:255](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L255)
+Defined in: [packages/framework/esm-api/src/current-user.ts:259](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L259)
 
 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/mock-jest.tsx

@@ -28,6 +28,8 @@ export {
   ageAsDuration,
   isOmrsDateToday,
   matchLocale,
+  toLanguageTag,
+  getLocaleDisplayName,
 } from '@openmrs/esm-utils';
 
 /* esm-globals */

package/mock.tsx

@@ -29,6 +29,8 @@ export {
   ageAsDuration,
   isOmrsDateToday,
   matchLocale,
+  toLanguageTag,
+  getLocaleDisplayName,
 } from '@openmrs/esm-utils';
 
 /* esm-globals */

package/package.json

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