@openmrs/esm-react-utils 5.1.1-pre.997 → 5.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "5.1.1-pre.997",
+  "version": "5.2.0",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "browser": "dist/openmrs-esm-react-utils.js",
@@ -40,8 +40,7 @@
   },
   "dependencies": {
     "lodash-es": "^4.17.21",
-    "single-spa-react": "~5.0.0",
-    "swr": "^2.0.1"
+    "single-spa-react": "~5.0.0"
   },
   "peerDependencies": {
     "@openmrs/esm-api": "5.x",
@@ -53,22 +52,24 @@
     "i18next": "19.x",
     "react": "18.x",
     "react-dom": "18.x",
-    "react-i18next": "11.x"
+    "react-i18next": "11.x",
+    "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "^5.1.1-pre.997",
-    "@openmrs/esm-config": "^5.1.1-pre.997",
-    "@openmrs/esm-error-handling": "^5.1.1-pre.997",
-    "@openmrs/esm-extensions": "^5.1.1-pre.997",
-    "@openmrs/esm-feature-flags": "^5.1.1-pre.997",
-    "@openmrs/esm-globals": "^5.1.1-pre.997",
+    "@openmrs/esm-api": "^5.2.0",
+    "@openmrs/esm-config": "^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",
     "dayjs": "^1.10.8",
     "i18next": "^19.6.0",
     "react": "^18.1.0",
     "react-dom": "^18.1.0",
     "react-i18next": "^11.16.9",
     "rxjs": "^6.5.3",
+    "swr": "^2.2.2",
     "webpack": "^5.88.0"
   },
-  "gitHead": "e178ff32e60aa9de9d889e292a3d320ff7d16906"
+  "gitHead": "f46cd16443cae13069a55067ca317ac995eef570"
 }

package/src/index.ts

@@ -26,3 +26,4 @@ export * from "./useStore";
 export * from "./useVisit";
 export * from "./useVisitTypes";
 export * from "./usePagination";
+export * from "./useDebounce";

package/src/public.ts

@@ -22,3 +22,4 @@ export * from "./useStore";
 export * from "./useVisit";
 export * from "./useVisitTypes";
 export * from "./usePagination";
+export * from "./useDebounce";

package/src/useDebounce.ts

@@ -0,0 +1,43 @@
+/** @module @category API */
+import { useEffect, useState } from "react";
+
+/**
+ * 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}
+ *    />
+ *  )
+ * }
+ * ```
+ *
+ * @param value The value that will be used to set `debounceValue`
+ * @param delay The number of milliseconds to wait before updating `debounceValue`
+ * @returns The debounced value
+ */
+export function useDebounce<T>(value: T, delay: number = 300) {
+  const [debounceValue, setDebounceValue] = useState<T>(value);
+  useEffect(() => {
+    const timer = setTimeout(() => {
+      setDebounceValue(value);
+    }, delay);
+    return () => {
+      clearTimeout(timer);
+    };
+  }, [value, delay]);
+  return debounceValue;
+}

package/dist/openmrs-esm-react-utils.js.LICENSE.txt

@@ -1,9 +0,0 @@
-/**
- * @license React
- * use-sync-external-store-shim.production.min.js
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */