bcgov / bcgov/entity

Auth Web and other UIs: use common Business Search composable

Open
#16,821 1 comment 0 reactions 0 assignees View on GitHub
ENTITY - DO NOT USE techdebt
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

In #16621, a business search component was written, based on a similar component in Create UI and Edit UI. In fact, a similar component also exists in MHR and in Business Search. Some are written in Class API and some are written in Composition API.

Ideally, there would be 1 common business search component, written as a composable, that all UIs could import once they are upgraded to Vue3.

- [ ] create reusable composable (from Business Search?)
- needs to support various search parameters
- needs to support various business search URLs
- needs to support various business search API keys
- needs to supoprt various account IDs
- probably needs slot(s) to display results (list) in a flexible manner
- may need props (or equivalent) to display messages in a flexible manner
- see also extra functionality in Auth Web for disabling businesses that are already affiliated
- what about the Business Search service (API code)?
- add more here as needed...
- [ ] import and use it in Auth Web
- [ ] import and use it in Create UI
- [ ] import and use it in Edit UI
- [ ] import and use it in MHR?

Refs:
https://github.com/bcgov/sbc-auth/pull/2365#discussion_r1235819821
https://github.com/bcgov/sbc-auth/pull/2365#discussion_r1235945743

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the existing Business Search components in Create UI, Edit UI, MHR, Business Search, and Auth Web, starting with the referenced discussion in bcgov/sbc-auth pull request 2365. Define the shared composable's supported parameters, URLs, API keys, account IDs, result slots, messages, and Auth Web's affiliation behavior before implementation. Done means the agreed composable is used by the applicable upgraded UIs and its behavior is covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.