(feat) O3-4143: useLocations should support searching by tag or query… (

#1191)

---------

Co-authored-by: Dennis Kigen <kigen.work@gmail.com>

packages/framework/esm-api/src/shared-api-objects/location.ts

@@ -11,9 +11,21 @@ export function toLocationObject(openmrsRestForm: any): Location {
   };
 }
 
-export function getLocations(tagUuidOrName: string | null = null): Observable<Array<Location>> {
-  const url = `${restBaseUrl}/location` + (tagUuidOrName ? '?tag=' + tagUuidOrName : '');
-  return openmrsObservableFetch<any>(url)
+export function getLocations(
+  tagUuidOrName: string | null = null,
+  query: string | null = null,
+): Observable<Array<Location>> {
+  const params = new URLSearchParams();
+  if (tagUuidOrName) {
+    params.set('tag', tagUuidOrName);
+  }
+  if (query) {
+    params.set('q', query);
+  }
+  const queryString = params.toString();
+  const url = `${restBaseUrl}/location${queryString ? '?' + queryString : ''}`;
+
+  return openmrsObservableFetch<{ results: Array<Location> }>(url)
     .pipe(
       map((results) => {
         const locations: Array<Location> = results.data.results.map(toLocationObject);

packages/framework/esm-react-utils/src/useLocations.tsx

@@ -3,11 +3,11 @@ import type { Location } from '@openmrs/esm-api';
 import { getLocations } from '@openmrs/esm-api';
 import { useState, useEffect } from 'react';
 
-export function useLocations(tagUuidOrName: string | null = null) {
+export function useLocations(tagUuidOrName: string | null = null, query: string | null = null): Array<Location> {
   const [locations, setLocations] = useState<Array<Location>>([]);
 
   useEffect(() => {
-    const locationSub = getLocations(tagUuidOrName).subscribe(
+    const locationSub = getLocations(tagUuidOrName, query).subscribe(
       (locations) => {
         setLocations(locations);
       },
@@ -16,7 +16,7 @@ export function useLocations(tagUuidOrName: string | null = null) {
       },
     );
     return () => locationSub.unsubscribe();
-  }, []);
+  }, [tagUuidOrName, query]);
 
   return locations;
 }