SAS-620: DTR submission and outcome notes

[David (david-mcdowall)]

This PR adds support for accepting optional free-text notes during the DTR add submission and add outcome flow. As per the prototype, these notes can only be added during creating or updating a referral in SAS and should co-exist so they can be displayed together on the View Referral screen and updated at any time.

Changes

• adds submissionNote field/column
• adds outcomeNote field/column
• validation for new fields in the DutyToReferAggregate
• test coverage

[Copilot]

Pull request overview

Adds optional free-text notes to the Duty To Refer (DTR) submission and outcome flows so they can be stored, retrieved, and displayed together on the referral view.

Changes:

• Extends the DTR API contract and persistence model with submissionNote and outcomeNote.
• Updates domain validation and mapping/transformer layers to carry the new fields through command → aggregate → entity → DTO.
• Adds migration and expands unit/integration test coverage for the new behaviour.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/integration/eligibility/response/GetEligibilityReponses.kt	Updates expected eligibility JSON to include the new note fields.
src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/integration/dutytorefer/json/DutyToReferJson.kt	Extends test JSON builders/expected responses with submissionNote/outcomeNote.
src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/integration/dutytorefer/DutyToReferControllerIT.kt	Adds integration tests around persisting/returning notes and ignoring blank notes.
query/src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/query/unit/dutytorefer/DutyToReferTransformerTest.kt	Verifies query transformer maps note fields.
query/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/query/dutytorefer/DutyToReferTransformer.kt	Maps entity note columns to DTO.
mutation/src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/unit/domain/aggregate/DutyToReferAggregateTest.kt	Adds unit coverage for note validation and applicability rules.
mutation/src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/unit/application/mapper/DutyToReferMapperTest.kt	Verifies mapper carries note fields across snapshot/entity/DTO.
mutation/src/test/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/factories/DutyToReferSnapshotFactory.kt	Extends snapshot factory to include new note fields.
mutation/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/domain/exceptions/DutyToReferExceptions.kt	Introduces new domain exceptions for note applicability.
mutation/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/domain/aggregate/DutyToReferAggregate.kt	Adds note state to aggregate + validation rules and snapshot fields.
mutation/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/application/service/DutyToReferApplicationService.kt	Passes note fields into aggregate updates during create/update (create path needs a fix).
mutation/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/mutation/application/mapper/DutyToReferMapper.kt	Maps note fields between snapshot/entity/aggregate/DTO.
infrastructure/src/testFixtures/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/infrastructure/factories/DutyToReferEntityFactory.kt	Extends entity test factory with note fields.
infrastructure/src/main/resources/db/migration/V0032__add_notes_to_duty_to_refer.sql	Adds submission_note and outcome_note columns.
infrastructure/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/infrastructure/persistence/entity/DutyToReferEntity.kt	Adds entity fields for the new note columns.
common/src/main/kotlin/uk/gov/justice/digital/hmpps/singleaccommodationserviceapi/common/dtos/DutyToReferDto.kt	Extends command/DTO types to include submissionNote and outcomeNote.

---

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

[David (david-mcdowall)]

this was intentional as outcomeNote should never be supplied or used during the create flow and is consistent with existing behaviour (withdrawlReason, outcomeReason etc)