Scaffold VAMC facility and render title and intro text #923

cvalarida · 2025-03-06T23:00:40Z

Description

Renders title, intro text, and placeholders.

I started adding the operating status flags, but after I saw I needed to pull in the sidebar data, I decided to save it for later. Kept the work hanging around, though, because the whole page is still a WIP. I can pull it out if y'all like, though. No worries there.

Generated description

This pull request includes significant updates to the handling and display of healthcare local facility data. The changes involve enhancing the data structure, updating the import statements, modifying the query parameters, and adding new components for rendering the facility details.

Enhancements to data structure and imports:

src/data/queries/healthCareLocalFacility.ts: Added introText and operatingStatusFacility fields to the query formatter and included the addInclude method in the query parameters. [1] [2]
src/types/drupal/node.ts: Introduced FacilityOperatingStatusFlags type and updated NodeHealthCareLocalFacility and NodeVetCenter interfaces to use this type. [1] [2] [3]
src/types/formatted/healthCareLocalFacility.ts: Added introText and operatingStatusFacility fields to the HealthCareLocalFacility type.

Updates to components and pages:

src/pages/[[...slug]].tsx: Added imports and rendering logic for HealthCareLocalFacility component based on the resource type. (src/pages/[[...slug]].tsxR38, src/pages/[[...slug]].tsxR54-R55, src/pages/[[...slug]].tsxR158-R162)
src/templates/layouts/healthCareLocalFacility/index.tsx: Updated the HealthCareLocalFacility component to include new fields and added a detailed layout for displaying facility information.

Testing and snapshots:

src/templates/layouts/healthCareLocalFacility/index.test.tsx: Updated tests to use mock data and verify the rendering of new fields.
src/data/queries/tests/__snapshots__/healthCareLocalFacility.test.tsx.snap: Updated snapshot tests to include introText and operatingStatusFacility fields. [1] [2]

Ticket

Closes department-of-veterans-affairs/va.gov-cms#20766
Closes department-of-veterans-affairs/va.gov-cms#20767

Developer Task

- [ ] PR submitted against the `main` branch of `next-build`.
- [ ] Link to the issue that this PR addresses (if applicable).
- [ ] Define all changes in your PR and note any changes that could potentially be breaking changes.
- [ ] PR includes steps to test your changes and links to these changes in the Tugboat preview (if applicable).
- [ ] Provided before and after screenshots of your changes (if applicable).
- [ ] Alerted the #accelerated-publishing Slack channel to request a PR review.
- [ ] You understand that once approved, you are responsible for merging your changes into `main`. (Note that changes to `main` will move automatically into production.)

Testing Steps

Explain the steps needed for testing

QA steps

What needs to be checked to prove this works?
What needs to be checked to prove it didn't break any related things?
What variations of circumstances (users, actions, values) need to be checked?

Screenshots

Is this PR blocked by another PR?

Add the DO NOT MERGE label
Add links to additional PRs here:

Reviewer

Reviewing a PR

This section lists items that need to be checked or updated when making changes to this repository.

Standard Checks

- [ ] Code Quality: Readabilty, Naming Conventions, Consistency, Reusability
- [ ] Test Coverage: 80% coverage
- [ ] Functionality: Change functions as expected with no additional bugs
- [ ] Performance: Code does not introduce performance issues
- [ ] Documentation: Changes are documented in their respective README.md files
- [ ] Security: Packages have been approved in the TRM

Merging an Approved Layout

When merging a layout, you must ensure that the content type has been turned on for next-build inside the CMS. This CMS flag must be turned on for editors to preview their work using the next build preview server.

Resource types (layouts) that have not been approved by design should NOT be pushed to production. Ensure that slug.tsx does not include your resource type if it is not approved.

The status of layouts should be kept up to date inside templates.md. This includes QA progress, development progress, etc. A link should be provided for where testing can occur.

Merging a Non-Approved Layout

Your new resource type should not be included inside slug.tsx. Items added here will go into production once merged into the main branch. It is imperative that we do not push anything live that has not been approved.

Ensure that this layout has been added to the templates.md file with the current status of the work.

Because consistency, eh?

We'll break these placeholders out into individual components later.

Still need to fix up those links, though.

cvalarida · 2025-03-06T23:02:23Z

src/templates/layouts/healthCareLocalFacility/index.tsx

+                        <script type="application/ld+json">
+                          {/* TODO: Fill this in */}
+                        </script>


Not sure how this will work yet. 🤷 I've never added a <script> element inside React before. 😅

cvalarida · 2025-03-06T23:04:24Z

src/types/drupal/node.ts

@@ -160,7 +168,7 @@ export interface NodeVetCenter extends DrupalNode {
  field_last_saved_by_an_editor?: string
  field_office_hours: FieldOfficeHours[]
  field_official_name: string
-  field_operating_status_facility: string
+  field_operating_status_facility: FacilityOperatingStatusFlags


@laflannery, @randimays, or @chriskim2311: Do you know if this is accurate? Given that it has the same field name, I assume it'll share the same values as the VAMC facility's field_operating_status_facility. 🤷

Yes, @cvalarida Vet Centers and VAMC facilities will use the same values for operating status.

cvalarida · 2025-03-06T23:05:07Z

src/types/drupal/node.ts

+  | 'notice'
+  | 'limited'
+  | 'closed'
+  | string // TODO: Remove the catch-all; needed right now for importing JSON mock data; can remove after we implement runtime data validation


It's actually pretty annoying that I still need | string on this. Makes this union kinda silly because the static type gets collapsed to string, and we don't get even get any auto-fill suggestions from our language server. Still, it's good to call out the expected values. 🤷

va-cms-bot · 2025-03-06T23:33:18Z

Tugboat has finished building the preview for this pull request!

Links:

Link (redis):

https://pr923-vcvk41tn0r0wxa9grth1fl07q58jfhy5.tugboat.vfs.va.gov

Dashboard:

https://tugboat.vfs.va.gov/67ca291aeb1907cf0c64083d

jamigibbs · 2025-03-07T14:22:03Z

src/templates/layouts/healthCareLocalFacility/index.tsx

+          class="vads-u-font-weight--bold operating-status-link"
+          onclick="recordEvent({
+            'event': 'nav-info-box-click',
+            'infoBoxText': 'Facility notice'});"


Design system parachuting in 🪂 to let you know that the va-link component has analytics built into it already. If you need to emit custom analytics details, add the disable-analytics prop so it doesn't log twice.

@cvalarida We won't need the custom analytics details here, they can be removed.

Sweet! I just copied this over from content-build. I love deleting code. 🤓

laflannery · 2025-03-07T15:18:34Z

@cvalarida Just noting that eventually we will want to get this working on Tugboat so I can see it and start QA

cvalarida added 17 commits February 20, 2025 10:48

Rename VAMC_FACILITY const to the node name

f7a5ea0

Because consistency, eh?

Update the existing node type

be7e95e

Add mock data

a76a4f6

Scaffold VAMC facility

7e1ab1a

Add the VAMC facility to page resource types

c036944

Rename back to VAMC_FACILITY

8f53e68

Merge branch 'main' into cvalarida/scaffold-vamc-facility

fb604dd

Merge branch 'main' into cvalarida/scaffold-vamc-facility

bf0cb6f

Actually render the page

ee89e5a

Add intro text to the query

2010bc2

Add some data and a lot of placeholders to the page

5f92fd2

We'll break these placeholders out into individual components later.

Update test

7cfe9d4

It's not actually optional, but nullable

658227a

Check for title and intro text

f6a718f

Update snapshot data

c3619da

Refactor: Extract operating status flags

2c0b9dc

Still need to fix up those links, though.

Add to do

4168831

cvalarida requested review from a team as code owners March 6, 2025 23:00

va-cms-bot temporarily deployed to Tugboat March 6, 2025 23:00 Destroyed

cvalarida commented Mar 6, 2025

View reviewed changes

va-cms-bot deployed to Tugboat March 6, 2025 23:06 View deployment

jamigibbs reviewed Mar 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scaffold VAMC facility and render title and intro text #923

Scaffold VAMC facility and render title and intro text #923

cvalarida commented Mar 6, 2025

cvalarida Mar 6, 2025

cvalarida Mar 6, 2025

laflannery Mar 7, 2025

cvalarida Mar 6, 2025

va-cms-bot commented Mar 6, 2025

jamigibbs Mar 7, 2025

randimays Mar 7, 2025

cvalarida Mar 7, 2025

laflannery commented Mar 7, 2025

Scaffold VAMC facility and render title and intro text #923

Are you sure you want to change the base?

Scaffold VAMC facility and render title and intro text #923

Conversation

cvalarida commented Mar 6, 2025

Description

Generated description

Enhancements to data structure and imports:

Updates to components and pages:

Testing and snapshots:

Ticket

Developer Task

Testing Steps

QA steps

Screenshots

Is this PR blocked by another PR?

Reviewer

Reviewing a PR

Standard Checks

Merging an Approved Layout

Merging a Non-Approved Layout

cvalarida Mar 6, 2025

Choose a reason for hiding this comment

cvalarida Mar 6, 2025

Choose a reason for hiding this comment

laflannery Mar 7, 2025

Choose a reason for hiding this comment

cvalarida Mar 6, 2025

Choose a reason for hiding this comment

va-cms-bot commented Mar 6, 2025

jamigibbs Mar 7, 2025

Choose a reason for hiding this comment

randimays Mar 7, 2025

Choose a reason for hiding this comment

cvalarida Mar 7, 2025

Choose a reason for hiding this comment

laflannery commented Mar 7, 2025