@openmrs/esm-framework 5.1.1-pre.999 → 5.2.0

package/docs/API.md

@@ -26,6 +26,7 @@
 - [toLocationObject](API.md#tolocationobject)
 - [toVisitTypeObject](API.md#tovisittypeobject)
 - [updateVisit](API.md#updatevisit)
+- [useDebounce](API.md#usedebounce)
 - [useLocations](API.md#uselocations)
 - [usePatient](API.md#usepatient)
 - [useSession](API.md#usesession)
@@ -62,6 +63,7 @@
 - [formatDate](API.md#formatdate)
 - [formatDatetime](API.md#formatdatetime)
 - [formatTime](API.md#formattime)
+- [getLocale](API.md#getlocale)
 - [isOmrsDateStrict](API.md#isomrsdatestrict)
 - [isOmrsDateToday](API.md#isomrsdatetoday)
 - [parseDate](API.md#parsedate)
@@ -818,6 +820,16 @@ and *must* only be used once within that `<ExtensionSlot>`.
 
 ___
 
+### OpenmrsDatePicker
+
+• `Const` **OpenmrsDatePicker**: `React.FC`<`OpenmrsDatePickerProps`\>
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/datepicker/openmrs/openmrs-date-picker.component.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/datepicker/openmrs/openmrs-date-picker.component.tsx#L41)
+
+___
+
 ### backendDependencies
 
 • `Const` **backendDependencies**: `Object`
@@ -839,7 +851,7 @@ ___
 
 ### LeftNavMenu
 
-• `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`Pick`<`SideNavProps`, `string` \| `number` \| `symbol`\> & `RefAttributes`<`HTMLElement`\>\>
+• `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`RefAttributes`<`HTMLElement`\>\>
 
 #### Defined in
 
@@ -1366,6 +1378,58 @@ ___
 
 ___
 
+### useDebounce
+
+▸ **useDebounce**<`T`\>(`value`, `delay?`): `T`
+
+This hook debounces a state variable. That state variable can then be used as the
+value of a controlled input, while the return value of this hook is used for making
+a request.
+
+**`example`**
+```tsx
+import { useDebounce } from "@openmrs/esm-react-utils";
+
+function MyComponent() {
+  const [searchTerm, setSearchTerm] = useState('');
+  const debouncedSearchTerm = useDebounce(searchTerm);
+  const swrResult = useSWR(`/api/search?q=${debouncedSearchTerm}`)
+
+ return (
+   <Search
+     labelText={t('search', 'Search')}
+     onChange={(e) => setSearchTerm(e.target.value)}
+     value={searchTerm}
+   />
+ )
+}
+```
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `T` | `undefined` | The value that will be used to set `debounceValue` |
+| `delay` | `number` | `300` | The number of milliseconds to wait before updating `debounceValue` |
+
+#### Returns
+
+`T`
+
+The debounced value
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useDebounce.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useDebounce.ts#L32)
+
+___
+
 ### useLocations
 
 ▸ **useLocations**(): [`Location`](interfaces/Location.md)[]
@@ -1969,6 +2033,24 @@ Formats the input as a time, according to the current locale.
 
 ___
 
+### getLocale
+
+▸ **getLocale**(): `string`
+
+Returns the current locale of the application.
+
+#### Returns
+
+`string`
+
+string
+
+#### Defined in
+
+[packages/framework/esm-utils/src/omrs-dates.ts:273](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L273)
+
+___
+
 ### isOmrsDateStrict
 
 ▸ **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
@@ -2383,7 +2465,7 @@ An array of extensions assigned to the named slot
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:373](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L373)
+[packages/framework/esm-extensions/src/extensions.ts:375](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L375)
 
 ___
 
@@ -3098,11 +3180,17 @@ ___
 
 ### getDynamicOfflineDataEntries
 
-▸ **getDynamicOfflineDataEntries**(`type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
+▸ **getDynamicOfflineDataEntries**<`T`\>(`type?`): `Promise`<`T`[]\>
 
 Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the currently logged in user.
 Optionally returns only entries of a given type.
 
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`DynamicOfflineData`](interfaces/DynamicOfflineData.md) |
+
 #### Parameters
 
 | Name | Type | Description |
@@ -3111,7 +3199,7 @@ Optionally returns only entries of a given type.
 
 #### Returns
 
-`Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
+`Promise`<`T`[]\>
 
 #### Defined in
 
@@ -3121,11 +3209,17 @@ ___
 
 ### getDynamicOfflineDataEntriesFor
 
-▸ **getDynamicOfflineDataEntriesFor**(`userId`, `type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
+▸ **getDynamicOfflineDataEntriesFor**<`T`\>(`userId`, `type?`): `Promise`<`T`[]\>
 
 Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the given user.
 Optionally returns only entries of a given type.
 
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`DynamicOfflineData`](interfaces/DynamicOfflineData.md) |
+
 #### Parameters
 
 | Name | Type | Description |
@@ -3135,7 +3229,7 @@ Optionally returns only entries of a given type.
 
 #### Returns
 
-`Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
+`Promise`<`T`[]\>
 
 #### Defined in
 
@@ -3354,7 +3448,7 @@ should be made available offline for the currently logged in user.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L162)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:161](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L161)
 
 ___
 
@@ -3379,7 +3473,7 @@ should be made available offline for the user with the given ID.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L177)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:176](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L176)
 
 ___
 
@@ -3456,7 +3550,7 @@ no longer needs to be available offline for the currently logged in user.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:212](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L212)
 
 ___
 
@@ -3481,7 +3575,7 @@ no longer needs to be available offline for the user with the given ID.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L228)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L227)
 
 ___
 
@@ -3636,7 +3730,7 @@ Synchronizes all offline data entries of the given [type](interfaces/FetchRespon
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L262)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L261)
 
 ___
 
@@ -3660,7 +3754,7 @@ Synchronizes a single offline data entry of the given [type](interfaces/FetchRes
 
 #### Defined in
 
-[packages/framework/esm-offline/src/dynamic-offline-data.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L280)
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:279](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L279)
 
 ___
 
@@ -4382,7 +4476,7 @@ ___
 
 ▸ **age**(`dateString`): `string`
 
-Gets a human readable age represention of the provided date string.
+Gets a human readable and locale supported age represention of the provided date string.
 
 #### Parameters
 
@@ -4398,7 +4492,7 @@ A human-readable string version of the age.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L39)
+[packages/framework/esm-utils/src/age-helpers.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L41)
 
 ___
 
@@ -4422,7 +4516,7 @@ The number of days.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L8)
+[packages/framework/esm-utils/src/age-helpers.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L10)
 
 ___
 
@@ -4447,7 +4541,7 @@ True if both are located on the same day.
 
 #### Defined in
 
-[packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L25)
+[packages/framework/esm-utils/src/age-helpers.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L27)
 
 ___
 

package/mock.tsx

@@ -1,7 +1,7 @@
 import React from "react";
 import type {} from "@openmrs/esm-globals";
 import { createStore, StoreApi } from "zustand";
-import { never, of } from "rxjs";
+import { NEVER, of } from "rxjs";
 import { interpolateUrl } from "@openmrs/esm-config";
 import { SessionStore } from "@openmrs/esm-api";
 export {
@@ -193,7 +193,7 @@ export const ConfigurableLink = jest
 export const importDynamic = jest.fn();
 
 /* esm-error-handling */
-export const createErrorHandler = () => jest.fn().mockReturnValue(never());
+export const createErrorHandler = () => jest.fn().mockReturnValue(NEVER);
 
 export const reportError = jest.fn().mockImplementation((error) => {
   throw error;
@@ -294,6 +294,8 @@ export const useVisit = jest.fn().mockReturnValue({
 
 export const useVisitTypes = jest.fn(() => []);
 
+export const useDebounce = jest.fn().mockImplementation((value) => value);
+
 /* esm-styleguide */
 
 export const showNotification = jest.fn();
@@ -305,4 +307,4 @@ export const LeftNavMenu = jest.fn();
 export const setLeftNav = jest.fn();
 export const unsetLeftNav = jest.fn();
 
-export { OpenmrsDatePicker } from "@openmrs/esm-styleguide";
+export const OpenmrsDatePicker = jest.fn();

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "5.1.1-pre.999",
+  "version": "5.2.0",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
   "source": true,
   "scripts": {
     "document": "../../../document.sh esm-framework",
-    "test": "jest --config jest.config.js --passWithNoTests",
+    "test": "cross-env TZ=UTC jest --config jest.config.js --verbose false --passWithNoTests --color",
+    "test:watch": "cross-env TZ=UTC jest --watch --config jest.config.js --color",
     "build": "webpack --mode=production",
     "build:development": "webpack --mode development",
     "analyze": "webpack --mode=production --env analyze=true",
@@ -36,19 +37,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^5.1.1-pre.999",
-    "@openmrs/esm-breadcrumbs": "^5.1.1-pre.999",
-    "@openmrs/esm-config": "^5.1.1-pre.999",
-    "@openmrs/esm-dynamic-loading": "^5.1.1-pre.999",
-    "@openmrs/esm-error-handling": "^5.1.1-pre.999",
-    "@openmrs/esm-extensions": "^5.1.1-pre.999",
-    "@openmrs/esm-feature-flags": "^5.1.1-pre.999",
-    "@openmrs/esm-globals": "^5.1.1-pre.999",
-    "@openmrs/esm-offline": "^5.1.1-pre.999",
-    "@openmrs/esm-react-utils": "^5.1.1-pre.999",
-    "@openmrs/esm-state": "^5.1.1-pre.999",
-    "@openmrs/esm-styleguide": "^5.1.1-pre.999",
-    "@openmrs/esm-utils": "^5.1.1-pre.999",
+    "@openmrs/esm-api": "^5.2.0",
+    "@openmrs/esm-breadcrumbs": "^5.2.0",
+    "@openmrs/esm-config": "^5.2.0",
+    "@openmrs/esm-dynamic-loading": "^5.2.0",
+    "@openmrs/esm-error-handling": "^5.2.0",
+    "@openmrs/esm-extensions": "^5.2.0",
+    "@openmrs/esm-feature-flags": "^5.2.0",
+    "@openmrs/esm-globals": "^5.2.0",
+    "@openmrs/esm-offline": "^5.2.0",
+    "@openmrs/esm-react-utils": "^5.2.0",
+    "@openmrs/esm-state": "^5.2.0",
+    "@openmrs/esm-styleguide": "^5.2.0",
+    "@openmrs/esm-utils": "^5.2.0",
     "dayjs": "^1.10.7"
   },
   "peerDependencies": {
@@ -58,7 +59,8 @@
     "react-dom": "18.x",
     "react-i18next": "11.x",
     "rxjs": "6.x",
-    "single-spa": "5.x"
+    "single-spa": "5.x",
+    "swr": "2.x"
   },
   "devDependencies": {
     "jest": "28.1.0",
@@ -66,5 +68,5 @@
     "jest-environment-jsdom": "28.1.0",
     "webpack": "^5.88.0"
   },
-  "gitHead": "a216f155e09508cf5bdc3d244fb7a154d1e74325"
+  "gitHead": "f46cd16443cae13069a55067ca317ac995eef570"
 }

package/webpack.config.js

@@ -26,7 +26,14 @@ module.exports = (env) => ({
         use: "swc-loader",
       },
       {
-        test: /\.s?css$/,
+        test: /\.css$/,
+        use: [
+          { loader: require.resolve("style-loader") },
+          { loader: require.resolve("css-loader") },
+        ],
+      },
+      {
+        test: /\.scss$/,
         use: [
           { loader: require.resolve("style-loader") },
           { loader: require.resolve("css-loader") },