(feat) allow useLocations react hook to take in tag parameter (#849)

openmrs · Dec 14, 2023 · 0067e39 · 0067e39
1 parent 9db3402
commit 0067e39
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 6 deletions.
diff --git a/packages/framework/esm-api/src/shared-api-objects/location.ts b/packages/framework/esm-api/src/shared-api-objects/location.ts
@@ -11,8 +11,9 @@ export function toLocationObject(openmrsRestForm: any): Location {
   };
 }
 
-export function getLocations(): Observable<Array<Location>> {
-  return openmrsObservableFetch<any>(`/ws/rest/v1/location`)
+export function getLocations(tagUuidOrName: string | null = null): Observable<Array<Location>> {
+  const url = `/ws/rest/v1/location` + (tagUuidOrName ? '?tag=' + tagUuidOrName : '');
+  return openmrsObservableFetch<any>(url)
     .pipe(
       map((results) => {
         const locations: Array<Location> = results.data.results.map(toLocationObject);

diff --git a/packages/framework/esm-framework/docs/API.md b/packages/framework/esm-framework/docs/API.md
@@ -1038,7 +1038,13 @@ ___
 
 ### getLocations
 
-▸ **getLocations**(): `Observable`<[`Location`](interfaces/Location.md)[]\>
+▸ **getLocations**(`tagUuidOrName?`): `Observable`<[`Location`](interfaces/Location.md)[]\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `tagUuidOrName` | ``null`` \| `string` | `null` |
 
 #### Returns
 
@@ -1484,7 +1490,13 @@ ___
 
 ### useLocations
 
-▸ **useLocations**(): [`Location`](interfaces/Location.md)[]
+▸ **useLocations**(`tagUuidOrName?`): [`Location`](interfaces/Location.md)[]
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `tagUuidOrName` | ``null`` \| `string` | `null` |
 
 #### Returns
 

diff --git a/...work/docs/interfaces/ShowSnackBarEvent.md → ...work/docs/interfaces/ShowSnackbarEvent.md b/...work/docs/interfaces/ShowSnackBarEvent.md → ...work/docs/interfaces/ShowSnackbarEvent.md
diff --git a/...ork/docs/interfaces/SnackBarDescriptor.md → ...ork/docs/interfaces/SnackbarDescriptor.md b/...ork/docs/interfaces/SnackBarDescriptor.md → ...ork/docs/interfaces/SnackbarDescriptor.md
diff --git a/...framework/docs/interfaces/SnackBarMeta.md → ...framework/docs/interfaces/SnackbarMeta.md b/...framework/docs/interfaces/SnackBarMeta.md → ...framework/docs/interfaces/SnackbarMeta.md
diff --git a/packages/framework/esm-react-utils/src/useLocations.tsx b/packages/framework/esm-react-utils/src/useLocations.tsx
@@ -2,11 +2,11 @@
 import { getLocations, Location } from '@openmrs/esm-api';
 import { useState, useEffect } from 'react';
 
-export function useLocations() {
+export function useLocations(tagUuidOrName: string | null = null) {
   const [locations, setLocations] = useState<Array<Location>>([]);
 
   useEffect(() => {
-    const locationSub = getLocations().subscribe(
+    const locationSub = getLocations(tagUuidOrName).subscribe(
       (locations) => {
         setLocations(locations);
       },