@openmrs/esm-framework 9.0.3-pre.4708 → 9.0.3-pre.4728

package/.turbo/turbo-build.log

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

@@ -0,0 +1,62 @@
+[O3 Framework](../API.md) / matchLocale
+
+# Function: matchLocale()
+
+> **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)
+
+Resolves a requested locale against a list of available locales using the
+BCP 47 lookup algorithm (RFC 4647, §3.4).
+
+Tags are compared in canonical form via Intl.Locale, so casing and
+underscore-vs-hyphen differences in the inputs do not affect matching. The
+value returned is taken verbatim from `available`, preserving the caller's
+original casing.
+
+In addition to the truncation steps prescribed by RFC 4647, this function
+also performs prefix expansion at each level: when the requested tag is
+truncated to a more general range (e.g. `en` after stripping `en-CA`), any
+available locale whose canonical form begins with that range plus a hyphen
+(e.g. `en-US`, `en-GB`) is treated as a match. This is a relaxation of the
+strict lookup algorithm but typically reflects user intent — a user who
+asked for `en-CA` will usually accept `en-US` over a non-English fallback.
+
+Tags that fail to parse are skipped with a console warning; they never match
+and never throw.
+
+## Parameters
+
+### requested
+
+The locale the caller would like to use, or `null`/`undefined`
+  if no preference is known.
+
+`undefined` | `null` | `string`
+
+### available
+
+readonly `string`[]
+
+The list of locales the application supports.
+
+### fallback?
+
+`string`
+
+The value to return when no match is found. Defaults to
+  `undefined`.
+
+## Returns
+
+`undefined` \| `string`
+
+The matched locale from `available`, or `fallback` if nothing matches.
+
+## Example
+
+```ts
+matchLocale('en-CA', ['en-US', 'en-GB', 'fr-FR'], 'en-US'); // => 'en-US'
+matchLocale('fr-BE', ['en-US', 'fr-FR', 'de-DE'], 'en-US'); // => 'fr-FR'
+matchLocale('zh-Hant-TW', ['zh-Hant', 'zh-Hans', 'en'], 'en'); // => 'zh-Hant'
+```

package/docs/interfaces/OpenmrsDateRangePickerProps.md

@@ -716,6 +716,16 @@ By default, this is determined by the user's locale.
 
 ***
 
+### size?
+
+> `optional` **size**: `"sm"` \| `"md"` \| `"lg"`
+
+Defined in: [packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx#L36)
+
+Specifies the size of the input. Currently supports either `sm`, `md`, or `lg` as an option
+
+***
+
 ### slot?
 
 > `optional` **slot**: `null` \| `string`
@@ -812,6 +822,6 @@ or invalid via ARIA.
 
 > `optional` **value**: \[`DateInputValue`, `DateInputValue`\]
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx#L36)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx#L38)
 
 The value (controlled)

package/docs/variables/OpenmrsDateRangePicker.md

@@ -4,6 +4,6 @@
 
 > `const` **OpenmrsDateRangePicker**: `ForwardRefExoticComponent`\<[`OpenmrsDateRangePickerProps`](../interfaces/OpenmrsDateRangePickerProps.md) & `RefAttributes`\<`HTMLDivElement`\>\>
 
-Defined in: [packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx#L42)
+Defined in: [packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs-date-range-picker.component.tsx#L44)
 
 A date range picker to enter or select a date and time range. Based on React Aria, but styled to look like Carbon.

package/mock-jest.tsx

@@ -17,7 +17,7 @@ export * from '@openmrs/esm-state/mock';
 export * from '@openmrs/esm-styleguide/mock';
 export * from '@openmrs/esm-translations/mock';
 
-export { parseDate, formatDate, formatDatetime, formatTime, isOmrsDateToday } from '@openmrs/esm-utils';
+export { parseDate, formatDate, formatDatetime, formatTime, isOmrsDateToday, matchLocale } from '@openmrs/esm-utils';
 
 /* esm-globals */
 

package/mock.tsx

@@ -18,7 +18,7 @@ export * from '@openmrs/esm-state/mock';
 export * from '@openmrs/esm-styleguide/mock';
 export * from '@openmrs/esm-translations/mock';
 
-export { parseDate, formatDate, formatDatetime, formatTime, isOmrsDateToday } from '@openmrs/esm-utils';
+export { parseDate, formatDate, formatDatetime, formatTime, isOmrsDateToday, matchLocale } from '@openmrs/esm-utils';
 
 /* esm-globals */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "9.0.3-pre.4708",
+  "version": "9.0.3-pre.4728",
   "license": "MPL-2.0",
   "type": "module",
   "module": "dist/index.js",
@@ -28,7 +28,7 @@
   },
   "source": true,
   "scripts": {
-    "document": "../../../document.sh esm-framework",
+    "document": "../../../tools/document.sh",
     "test": "cross-env TZ=UTC vitest run --passWithNoTests",
     "test:watch": "cross-env TZ=UTC vitest watch",
     "coverage": "cross-env TZ=UTC vitest run --coverage --passWithNoTests",
@@ -59,24 +59,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "9.0.3-pre.4708",
-    "@openmrs/esm-config": "9.0.3-pre.4708",
-    "@openmrs/esm-context": "9.0.3-pre.4708",
-    "@openmrs/esm-dynamic-loading": "9.0.3-pre.4708",
-    "@openmrs/esm-emr-api": "9.0.3-pre.4708",
-    "@openmrs/esm-error-handling": "9.0.3-pre.4708",
-    "@openmrs/esm-expression-evaluator": "9.0.3-pre.4708",
-    "@openmrs/esm-extensions": "9.0.3-pre.4708",
-    "@openmrs/esm-feature-flags": "9.0.3-pre.4708",
-    "@openmrs/esm-globals": "9.0.3-pre.4708",
-    "@openmrs/esm-navigation": "9.0.3-pre.4708",
-    "@openmrs/esm-offline": "9.0.3-pre.4708",
-    "@openmrs/esm-react-utils": "9.0.3-pre.4708",
-    "@openmrs/esm-routes": "9.0.3-pre.4708",
-    "@openmrs/esm-state": "9.0.3-pre.4708",
-    "@openmrs/esm-styleguide": "9.0.3-pre.4708",
-    "@openmrs/esm-translations": "9.0.3-pre.4708",
-    "@openmrs/esm-utils": "9.0.3-pre.4708"
+    "@openmrs/esm-api": "9.0.3-pre.4728",
+    "@openmrs/esm-config": "9.0.3-pre.4728",
+    "@openmrs/esm-context": "9.0.3-pre.4728",
+    "@openmrs/esm-dynamic-loading": "9.0.3-pre.4728",
+    "@openmrs/esm-emr-api": "9.0.3-pre.4728",
+    "@openmrs/esm-error-handling": "9.0.3-pre.4728",
+    "@openmrs/esm-expression-evaluator": "9.0.3-pre.4728",
+    "@openmrs/esm-extensions": "9.0.3-pre.4728",
+    "@openmrs/esm-feature-flags": "9.0.3-pre.4728",
+    "@openmrs/esm-globals": "9.0.3-pre.4728",
+    "@openmrs/esm-navigation": "9.0.3-pre.4728",
+    "@openmrs/esm-offline": "9.0.3-pre.4728",
+    "@openmrs/esm-react-utils": "9.0.3-pre.4728",
+    "@openmrs/esm-routes": "9.0.3-pre.4728",
+    "@openmrs/esm-state": "9.0.3-pre.4728",
+    "@openmrs/esm-styleguide": "9.0.3-pre.4728",
+    "@openmrs/esm-translations": "9.0.3-pre.4728",
+    "@openmrs/esm-utils": "9.0.3-pre.4728"
   },
   "peerDependencies": {
     "dayjs": "1.x",
@@ -89,7 +89,7 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4708",
+    "@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4728",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",

package/typedoc.json

@@ -18,6 +18,7 @@
   "excludeInternal": true,
   "entryFileName": "API.md",
   "gitRevision": "main",
+  "sourceLinkTemplate": "https://github.com/openmrs/openmrs-esm-core/blob/{gitRevision}/{path}#L{line}",
   "hidePageHeader": true,
   "sort": ["alphabetical"]
 }