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

[chibongho]

Requirements

• This PR has a title that briefly describes the work done including the ticket number. Ensure your PR title includes a conventional commit label (such as feat, fix, or chore, among others). See existing PR titles for inspiration.

For changes to apps

• My work conforms to the O3 Styleguide and design documentation.

If applicable

• My work includes tests or is validated by existing tests.
• I have updated the esm-framework mock to reflect any API changes I have made.

Summary

We currently have a useLocations() hook which calls the v1 REST API for a list of locations. The REST API can already take in an additional parameter to specify a tag to filter by all locations with that tag. This PR changes the hook to support passing a tag parameter.

Screenshots

Related Issue

Other

Note that the git commit hook generated some styling and documentation changes that I had to manually re-add into the commit.

[github-actions]

Size Change: -332 kB (-11%) 👏

Total Size: 2.71 MB

Filename	Size	Change
packages/shell/esm-app-shell/dist/openmrs.b0d966b4c60235da.js	0 B	-333 kB (removed)	🏆

ℹ️ View Unchanged

Filename	Size	Change
packages/apps/esm-devtools-app/dist/630.js	1.76 kB	0 B
packages/apps/esm-devtools-app/dist/729.js	6.79 kB	0 B
packages/apps/esm-devtools-app/dist/735.js	2.63 kB	0 B
packages/apps/esm-devtools-app/dist/788.js	42.9 kB	0 B
packages/apps/esm-devtools-app/dist/875.js	9.76 kB	0 B
packages/apps/esm-devtools-app/dist/889.js	108 kB	+38 B (0%)
packages/apps/esm-devtools-app/dist/961.js	25.3 kB	0 B
packages/apps/esm-devtools-app/dist/988.js	328 B	0 B
packages/apps/esm-devtools-app/dist/main.js	3.14 kB	0 B
packages/apps/esm-devtools-app/dist/openmrs-esm-devtools-app.js	3.18 kB	0 B
packages/apps/esm-implementer-tools-app/dist/319.js	633 B	0 B
packages/apps/esm-implementer-tools-app/dist/329.js	10 kB	0 B
packages/apps/esm-implementer-tools-app/dist/426.js	1.66 kB	0 B
packages/apps/esm-implementer-tools-app/dist/460.js	735 B	0 B
packages/apps/esm-implementer-tools-app/dist/56.js	3.07 kB	0 B
packages/apps/esm-implementer-tools-app/dist/560.js	9.6 kB	0 B
packages/apps/esm-implementer-tools-app/dist/574.js	560 B	0 B
packages/apps/esm-implementer-tools-app/dist/587.js	2.81 kB	0 B
packages/apps/esm-implementer-tools-app/dist/620.js	126 kB	0 B
packages/apps/esm-implementer-tools-app/dist/625.js	562 B	0 B
packages/apps/esm-implementer-tools-app/dist/651.js	6.86 kB	0 B
packages/apps/esm-implementer-tools-app/dist/727.js	32.9 kB	0 B
packages/apps/esm-implementer-tools-app/dist/735.js	2.63 kB	0 B
packages/apps/esm-implementer-tools-app/dist/738.js	6.79 kB	0 B
packages/apps/esm-implementer-tools-app/dist/757.js	560 B	0 B
packages/apps/esm-implementer-tools-app/dist/788.js	42.9 kB	0 B
packages/apps/esm-implementer-tools-app/dist/807.js	559 B	0 B
packages/apps/esm-implementer-tools-app/dist/833.js	681 B	0 B
packages/apps/esm-implementer-tools-app/dist/889.js	108 kB	+37 B (0%)
packages/apps/esm-implementer-tools-app/dist/913.js	61.2 kB	0 B
packages/apps/esm-implementer-tools-app/dist/main.js	73.3 kB	0 B
packages/apps/esm-implementer-tools-app/dist/openmrs-esm-implementer-tools-app.js	3.3 kB	0 B
packages/apps/esm-login-app/dist/111.js	1.22 kB	0 B
packages/apps/esm-login-app/dist/126.js	2.5 kB	0 B
packages/apps/esm-login-app/dist/173.js	1.22 kB	0 B
packages/apps/esm-login-app/dist/224.js	256 B	0 B
packages/apps/esm-login-app/dist/236.js	272 B	0 B
packages/apps/esm-login-app/dist/240.js	364 B	0 B
packages/apps/esm-login-app/dist/272.js	264 B	0 B
packages/apps/esm-login-app/dist/319.js	692 B	0 B
packages/apps/esm-login-app/dist/336.js	234 B	0 B
packages/apps/esm-login-app/dist/370.js	30.6 kB	0 B
packages/apps/esm-login-app/dist/460.js	782 B	0 B
packages/apps/esm-login-app/dist/539.js	298 B	0 B
packages/apps/esm-login-app/dist/56.js	3.06 kB	0 B
packages/apps/esm-login-app/dist/574.js	609 B	0 B
packages/apps/esm-login-app/dist/625.js	600 B	0 B
packages/apps/esm-login-app/dist/627.js	257 B	0 B
packages/apps/esm-login-app/dist/63.js	16.5 kB	0 B
packages/apps/esm-login-app/dist/644.js	305 B	0 B
packages/apps/esm-login-app/dist/673.js	284 B	0 B
packages/apps/esm-login-app/dist/729.js	6.78 kB	0 B
packages/apps/esm-login-app/dist/735.js	2.63 kB	0 B
packages/apps/esm-login-app/dist/757.js	698 B	0 B
packages/apps/esm-login-app/dist/788.js	42.9 kB	0 B
packages/apps/esm-login-app/dist/807.js	961 B	0 B
packages/apps/esm-login-app/dist/812.js	22.5 kB	0 B
packages/apps/esm-login-app/dist/833.js	727 B	0 B
packages/apps/esm-login-app/dist/889.js	108 kB	+37 B (0%)
packages/apps/esm-login-app/dist/main.js	57 kB	0 B
packages/apps/esm-login-app/dist/openmrs-esm-login-app.js	3.32 kB	0 B
packages/apps/esm-offline-tools-app/dist/102.js	81.3 kB	0 B
packages/apps/esm-offline-tools-app/dist/193.js	55 kB	0 B
packages/apps/esm-offline-tools-app/dist/319.js	1.14 kB	0 B
packages/apps/esm-offline-tools-app/dist/460.js	1.32 kB	0 B
packages/apps/esm-offline-tools-app/dist/56.js	3.07 kB	0 B
packages/apps/esm-offline-tools-app/dist/574.js	1.04 kB	0 B
packages/apps/esm-offline-tools-app/dist/625.js	1.04 kB	0 B
packages/apps/esm-offline-tools-app/dist/63.js	16.5 kB	0 B
packages/apps/esm-offline-tools-app/dist/729.js	6.79 kB	0 B
packages/apps/esm-offline-tools-app/dist/735.js	2.63 kB	0 B
packages/apps/esm-offline-tools-app/dist/757.js	1.2 kB	0 B
packages/apps/esm-offline-tools-app/dist/788.js	42.9 kB	0 B
packages/apps/esm-offline-tools-app/dist/807.js	1.1 kB	0 B
packages/apps/esm-offline-tools-app/dist/833.js	1.22 kB	0 B
packages/apps/esm-offline-tools-app/dist/889.js	108 kB	+37 B (0%)
packages/apps/esm-offline-tools-app/dist/main.js	136 kB	0 B
packages/apps/esm-offline-tools-app/dist/openmrs-esm-offline-tools-app.js	3.29 kB	0 B
packages/apps/esm-primary-navigation-app/dist/262.js	13.3 kB	0 B
packages/apps/esm-primary-navigation-app/dist/319.js	200 B	0 B
packages/apps/esm-primary-navigation-app/dist/460.js	217 B	0 B
packages/apps/esm-primary-navigation-app/dist/574.js	183 B	0 B
packages/apps/esm-primary-navigation-app/dist/625.js	184 B	0 B
packages/apps/esm-primary-navigation-app/dist/63.js	16.5 kB	0 B
packages/apps/esm-primary-navigation-app/dist/729.js	6.79 kB	0 B
packages/apps/esm-primary-navigation-app/dist/735.js	18.7 kB	0 B
packages/apps/esm-primary-navigation-app/dist/757.js	209 B	0 B
packages/apps/esm-primary-navigation-app/dist/788.js	42.9 kB	0 B
packages/apps/esm-primary-navigation-app/dist/807.js	235 B	0 B
packages/apps/esm-primary-navigation-app/dist/833.js	210 B	0 B
packages/apps/esm-primary-navigation-app/dist/889.js	108 kB	+37 B (0%)
packages/apps/esm-primary-navigation-app/dist/960.js	2.64 kB	0 B
packages/apps/esm-primary-navigation-app/dist/main.js	33.7 kB	0 B
packages/apps/esm-primary-navigation-app/dist/openmrs-esm-primary-navigation-app.js	3.23 kB	0 B
packages/framework/esm-api/dist/openmrs-esm-api.js	9.77 kB	+21 B (0%)
packages/framework/esm-breadcrumbs/dist/openmrs-esm-breadcrumbs.js	2.66 kB	0 B
packages/framework/esm-config/dist/openmrs-esm-module-config.js	7.87 kB	0 B
packages/framework/esm-dynamic-loading/dist/openmrs-esm-dynamic-loading.js	2.12 kB	0 B
packages/framework/esm-error-handling/dist/openmrs-esm-error-handling.js	894 B	0 B
packages/framework/esm-extensions/dist/openmrs-esm-extensions.js	8.05 kB	0 B
packages/framework/esm-feature-flags/dist/openmrs-esm-feature-flags.js	1.67 kB	0 B
packages/framework/esm-framework/dist/455.openmrs-esm-framework.js	4.57 kB	0 B
packages/framework/esm-framework/dist/530.openmrs-esm-framework.js	2.92 kB	0 B
packages/framework/esm-framework/dist/645.openmrs-esm-framework.js	9.31 kB	0 B
packages/framework/esm-framework/dist/655.openmrs-esm-framework.js	6.83 kB	0 B
packages/framework/esm-framework/dist/710.openmrs-esm-framework.js	6.48 kB	0 B
packages/framework/esm-framework/dist/735.openmrs-esm-framework.js	2.66 kB	0 B
packages/framework/esm-framework/dist/788.openmrs-esm-framework.js	42.9 kB	0 B
packages/framework/esm-framework/dist/openmrs-esm-framework.js	374 kB	+73 B (0%)
packages/framework/esm-globals/dist/openmrs-esm-globals.js	756 B	0 B
packages/framework/esm-offline/dist/openmrs-esm-offline.js	34.4 kB	0 B
packages/framework/esm-react-utils/dist/openmrs-esm-react-utils.js	15.2 kB	+14 B (0%)
packages/framework/esm-routes/dist/openmrs-esm-utils.js	1.43 kB	0 B
packages/framework/esm-state/dist/openmrs-esm-state.js	888 B	0 B
packages/framework/esm-styleguide/dist/openmrs-esm-styleguide.js	19.3 kB	0 B
packages/framework/esm-utils/dist/openmrs-esm-utils.js	11 kB	0 B
packages/shell/esm-app-shell/dist/0cca64a12dd8e4d8.js	6.45 kB	0 B
packages/shell/esm-app-shell/dist/b66a463116735f62.js	3.81 kB	0 B
packages/shell/esm-app-shell/dist/d81faa62d5818f52.js	1.58 kB	0 B
packages/shell/esm-app-shell/dist/openmrs.68f92444c585f161.js	333 kB	0 B
packages/shell/esm-app-shell/dist/service-worker.js	60.5 kB	+3 B (0%)
packages/tooling/openmrs/dist/cli.js	2.86 kB	0 B
packages/tooling/openmrs/dist/commands/assemble.js	2.4 kB	0 B
packages/tooling/openmrs/dist/commands/build.js	1.34 kB	0 B
packages/tooling/openmrs/dist/commands/debug.js	545 B	0 B
packages/tooling/openmrs/dist/commands/develop.js	1.86 kB	0 B
packages/tooling/openmrs/dist/commands/index.js	438 B	0 B
packages/tooling/openmrs/dist/commands/start.js	851 B	0 B
packages/tooling/openmrs/dist/index.js	517 B	0 B
packages/tooling/openmrs/dist/runner.js	637 B	0 B
packages/tooling/openmrs/dist/utils/config.js	728 B	0 B
packages/tooling/openmrs/dist/utils/debugger.js	528 B	0 B
packages/tooling/openmrs/dist/utils/dependencies.js	640 B	0 B
packages/tooling/openmrs/dist/utils/helpers.js	395 B	0 B
packages/tooling/openmrs/dist/utils/importmap.js	2.95 kB	0 B
packages/tooling/openmrs/dist/utils/index.js	444 B	0 B
packages/tooling/openmrs/dist/utils/logger.js	368 B	0 B
packages/tooling/openmrs/dist/utils/npmConfig.js	830 B	0 B
packages/tooling/openmrs/dist/utils/untar.js	722 B	0 B
packages/tooling/openmrs/dist/utils/variables.js	192 B	0 B
packages/tooling/openmrs/dist/utils/webpack.js	278 B	0 B
packages/tooling/webpack-config/dist/index.js	3.58 kB	0 B

_{compressed-size-action}

[mogoodrich]

Thanks @chibongho ! Genrerally LGTM, what's up with those SnackarDescriptor name changes?

[mseaton]

LGTM, same comment as @mogoodrich about the Snackbar file changes that appear

[chibongho]

The git commit hook changed the casing of those file names.

[denniskigen]

These are fine. The pre-commit hook runs a task that updates the markdown files that updates our API docs. They likely got updated in a previous commit that @chibongho might not have had on his local.

[denniskigen]

LGTM, @chibongho. Thanks! Possible future improvements to this code would better type annotations and possibly refactoring getLocations to use just one pipe invocation.