CCM-14747: Add BSL to routing pages by ClareJonesBJSS · Pull Request #894 · NHSDigital/nhs-notify-web-template-management

ClareJonesBJSS · 2026-03-27T11:16:21Z

Description

Remove 'q4' exclusion from routing config accessibility types
Add choose BSL page

Context

Type of changes

Refactoring (non-breaking change)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would change existing functionality)
Bug fix (non-breaking change which fixes an issue)

Checklist

I am familiar with the contributing guidelines
I have followed the code style of the project
I have added tests to cover my changes
I have updated the documentation accordingly
This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

Copilot

Pull request overview

Adds British Sign Language (BSL, q4) as a supported accessible-format option in message plan (routing) flows, aligning it with existing large print and other-language routing pages.

Changes:

Extend routing-supported letter/accessibility enums and validators to include BSL (q4).
Add new “choose BSL template” and “preview BSL template” routing pages (plus auth protection and content).
Add/update unit, component, routing-component, and accessibility tests to cover the new routes and UI.

Reviewed changes

Copilot reviewed 28 out of 29 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
utils/utils/src/zod-validators.ts	Adds Zod validator and helper for BSL letter templates (`q4`).
utils/utils/src/enum.ts	Updates routing-supported letter types and accessible formats to include `q4`.
utils/utils/src/tests/enum.test.ts	Updates URL mapping test to cover `q4` routing choose page.
tests/test-team/template-mgmt-routing-component-tests/letter/preview-british-sign-language-letter-template.routing-component.spec.ts	New Playwright routing-component coverage for BSL preview page.
tests/test-team/template-mgmt-routing-component-tests/letter/choose-british-sign-language-letter-template.routing-component.spec.ts	New Playwright routing-component coverage for choosing a BSL template.
tests/test-team/template-mgmt-routing-component-tests/edit-message-plan.routing-component.spec.ts	Updates edit message plan routing-component test expectations to include BSL card/linking.
tests/test-team/template-mgmt-component-tests/template-protected-routes.component.spec.ts	Includes new BSL routing pages in protected-routes coverage.
tests/test-team/template-mgmt-accessibility/routing.accessibility.spec.ts	Adds accessibility scans for BSL choose/preview routing pages.
tests/test-team/template-mgmt-accessibility/route-coverage.accessibility.spec.ts	Adds BSL routing pages to accessibility route coverage list.
tests/test-team/pages/routing/letter/preview-british-sign-language-letter-template-page.ts	New page object model for BSL preview routing page.
tests/test-team/pages/routing/letter/index.ts	Exposes new BSL routing page objects via barrel export.
tests/test-team/pages/routing/letter/choose-british-sign-language-letter-template-page.ts	New page object model for BSL choose routing page.
tests/test-team/pages/routing/edit-message-plan-page.ts	Adds BSL locator helpers to the edit message plan page object.
package-lock.json	Patch-level AWS SDK dependency updates captured in lockfile.
frontend/src/middleware.ts	Protects the new BSL routing paths behind auth middleware.
frontend/src/content/content.ts	Adds content entries for BSL choose/preview routing pages.
frontend/src/app/message-plans/choose-british-sign-language-letter-template/[routingConfigId]/preview-template/[templateId]/page.tsx	New Next.js routing page to preview a BSL template from a message plan.
frontend/src/app/message-plans/choose-british-sign-language-letter-template/[routingConfigId]/page.tsx	New Next.js routing page to choose a BSL template for a message plan.
frontend/src/tests/utils/routing-utils.test.ts	Updates accessible-template extraction test to include `q4`.
frontend/src/tests/helpers/helpers.ts	Adds a reusable BSL authoring letter template test fixture.
frontend/src/tests/app/message-plans/review-and-move-to-production/page.test.tsx	Ensures review page renders `q4` conditional template.
frontend/src/tests/app/message-plans/review-and-move-to-production/snapshots/page.test.tsx.snap	Snapshot updates reflecting BSL conditional template rendering.
frontend/src/tests/app/message-plans/preview-message-plan/page.test.tsx	Ensures message plan preview renders `q4` conditional template.
frontend/src/tests/app/message-plans/preview-message-plan/snapshots/page.test.tsx.snap	Snapshot updates reflecting BSL conditional template rendering.
frontend/src/tests/app/message-plans/choose-british-sign-language-letter-template/preview-template/page.test.tsx	New unit test coverage for BSL preview routing page.
frontend/src/tests/app/message-plans/choose-british-sign-language-letter-template/preview-template/snapshots/page.test.tsx.snap	Snapshot for BSL preview routing page.
frontend/src/tests/app/message-plans/choose-british-sign-language-letter-template/page.test.tsx	New unit test coverage for BSL choose routing page.
frontend/src/tests/app/message-plans/choose-british-sign-language-letter-template/snapshots/page.test.tsx.snap	Snapshot for BSL choose routing page.
frontend/src/tests/app/edit-message-plan/snapshots/page.test.tsx.snap	Snapshot updates to include BSL conditional template card.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

utils/utils/src/enum.ts

frontend/src/__tests__/utils/routing-utils.test.ts

…CCM-14747_add-bsl-to-routing-frontend

This reverts commit 0748b7c.

alexnuttall · 2026-03-30T10:34:06Z

.../test-team/template-mgmt-routing-component-tests/edit-message-plan.routing-component.spec.ts

      'PASSED',
      { letterType: 'x1' }
    ),
+    BSL_LETTER: TemplateFactory.uploadLetterTemplate(


Optional suggestion, but this might be a good time to convert these to carbone letters

True, I did that in the the unit test helpers and thought about scrubbing through tests and shifting to default to authoring across the board, but then figured we'd surely start actively retiring pdf letters pretty quickly and it could be done then. But if vaccs means it'll be May before we can even start talking about that I'm more inclined to after all

OK, definitely too fiddly for a tangential task to shift everything, but I've amended 'uploadLetterTemplate' to 'uploadPdfLetterTemplate' so its easier to spot, changed all the routing-related component tests except for template previews to use authoring templates, and added BSL to the review/preview message plan page tests

I enjoy the renaming :D

Could you add renders, if the new factory templates are authoring letters in PROOF_APPROVED or SUBMITTED status please? The options object should be e.g.

{ shortFormRender: { status: 'RENDERED' }, longFormRender: { status: 'RENDERED' }, }

It shouldn't make a difference in a routing context probably, but its good to keep them realistic if possible I think

...omponent-tests/letter/choose-british-sign-language-letter-template.routing-component.spec.ts

tests/test-team/template-mgmt-accessibility/routing.accessibility.spec.ts

utils/utils/src/enum.ts

...st-team/template-mgmt-routing-component-tests/preview-message-plan.routing-component.spec.ts

…CCM-14747_add-bsl-to-routing-frontend

nicki-nhs · 2026-04-01T13:38:45Z

utils/utils/src/enum.ts

-export const accessibleFormatDisplayMappings = (letterType: LetterType) => {
-  const map: Record<LetterType, string> = {
+export const accessibleFormatDisplayMappings = (
+  letterType: Exclude<FrontendSupportedLetterType, 'language'>


Suggested change

letterType: Exclude<FrontendSupportedLetterType, 'language'>

letterType: FrontendSupportedAccessibleFormats

?

nicki-nhs · 2026-04-01T13:39:36Z

utils/utils/src/enum.ts

-export const letterTypeMapping = (letterType: LetterType) =>
-  `${letterTypeMap[letterType]} letter`;
+export const letterTypeMapping = (
+  letterType: Exclude<FrontendSupportedLetterType, 'language'>


Suggested change

letterType: Exclude<FrontendSupportedLetterType, 'language'>

letterType: FrontendSupportedAccessibleFormats

is it not this ?

nicki-nhs · 2026-04-01T13:39:45Z

utils/utils/src/enum.ts


 export const letterTypeDisplayMappings = (
-  letterType: LetterType,
+  letterType: Exclude<FrontendSupportedLetterType, 'language'>,


Both check against letterTypeMap which doesn't include 'language'

…CCM-14747_add-bsl-to-routing-frontend

CCM-14747: Add BSL to routing pages

215e0f0

ClareJonesBJSS requested a review from a team as a code owner March 27, 2026 11:16

Switch from pdf templates to authoring in tests

3c64b7c

ClareJonesBJSS force-pushed the feature/CCM-14747_add-bsl-to-routing-frontend branch from d396508 to 3c64b7c Compare March 27, 2026 12:02

ClareJonesBJSS added 3 commits March 27, 2026 12:09

package-lock

8718543

Protected routes test

92d401f

Keep large print template submitted in review-and-move-to-production

d85f157

ClareJonesBJSS requested a review from Copilot March 27, 2026 13:12

Copilot started reviewing on behalf of ClareJonesBJSS March 27, 2026 13:13 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

nicki-nhs reviewed Mar 27, 2026

View reviewed changes

utils/utils/src/enum.ts Outdated Show resolved Hide resolved

nicki-nhs reviewed Mar 27, 2026

View reviewed changes

frontend/src/__tests__/utils/routing-utils.test.ts Show resolved Hide resolved

Review updates

b859392

ClareJonesBJSS force-pushed the feature/CCM-14747_add-bsl-to-routing-frontend branch from acc99b5 to b859392 Compare March 27, 2026 18:39

ClareJonesBJSS added 4 commits March 30, 2026 10:37

Merge commit '390a3f565f81abd796d1c205e799d77edb27fd2c' into feature/…

58721f6

…CCM-14747_add-bsl-to-routing-frontend

package-lock

701b3c8

zod schema

0748b7c

Revert "zod schema"

fa20405

This reverts commit 0748b7c.

alexnuttall reviewed Mar 30, 2026

View reviewed changes

...omponent-tests/letter/choose-british-sign-language-letter-template.routing-component.spec.ts Show resolved Hide resolved

alexnuttall reviewed Mar 30, 2026

View reviewed changes

tests/test-team/template-mgmt-accessibility/routing.accessibility.spec.ts Show resolved Hide resolved

nicki-nhs reviewed Mar 30, 2026

View reviewed changes

utils/utils/src/enum.ts Outdated Show resolved Hide resolved

ClareJonesBJSS added 2 commits March 31, 2026 11:30

review updates

bc96c97

Rename UploadLetterTemplate test factory method

8861e2d

ClareJonesBJSS force-pushed the feature/CCM-14747_add-bsl-to-routing-frontend branch from 553c14a to 8861e2d Compare March 31, 2026 11:26

nicki-nhs reviewed Mar 31, 2026

View reviewed changes

...st-team/template-mgmt-routing-component-tests/preview-message-plan.routing-component.spec.ts Show resolved Hide resolved

ClareJonesBJSS added 4 commits March 31, 2026 15:09

Add BSL to e2e

3378a1b

Remove routing supported letter types

cb1e756

Add renders to approved/submitted templates

2f59c82

linting

05b4db8

ClareJonesBJSS added 2 commits April 1, 2026 11:46

Merge commit '94dc6db617e8f12b2416ca8be0818e713133a171' into feature/…

7afd6d0

…CCM-14747_add-bsl-to-routing-frontend

Merge fix

9c406a2

nicki-nhs reviewed Apr 1, 2026

View reviewed changes

ClareJonesBJSS added 4 commits April 1, 2026 16:03

Package lock

f34dbba

Type fix

fbc225c

Merge commit 'f665e061adb64de8a6af813a598a333df0e7c95d' into feature/…

e120d98

…CCM-14747_add-bsl-to-routing-frontend

Test fixes

c01907f

alexnuttall approved these changes Apr 2, 2026

View reviewed changes

	letterType: Exclude<FrontendSupportedLetterType, 'language'>
	letterType: FrontendSupportedAccessibleFormats

Conversation

ClareJonesBJSS commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

alexnuttall Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

ClareJonesBJSS Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ClareJonesBJSS Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicki-nhs Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

alexnuttall Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicki-nhs Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

nicki-nhs Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

nicki-nhs Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

ClareJonesBJSS Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ClareJonesBJSS commented Mar 27, 2026 •

edited

Loading

ClareJonesBJSS Mar 31, 2026 •

edited

Loading

ClareJonesBJSS Mar 31, 2026 •

edited

Loading

alexnuttall Mar 31, 2026 •

edited

Loading