Merge pull request #12 from hmrc/DTR-714_Screen_MA2c-_Agent_contact_details_T2

WIP - Created Agent contact details screen.

Author: tioadesola1

app/controllers/HomeController.scala

@@ -20,22 +20,62 @@ import controllers.actions.IdentifierAction
 import models.Mode
 import javax.inject.{Inject, Singleton}
 import play.api.i18n.I18nSupport
+import controllers.JourneyRecoveryController
+import controllers.actions.*
+import forms.manageAgents.AgentContactDetailsFormProvider
+import models.manageAgents.AgentContactDetails
+
+import javax.inject.Inject
+import navigation.Navigator
+import models.Mode
+import pages.manageAgents.{AgentContactDetailsPage, AgentCheckYourAnswersPage}
+import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
+import repositories.SessionRepository
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
-import views.html.IndexView
+import views.html.manageAgents.AgentContactDetailsView
+
+import scala.concurrent.{ExecutionContext, Future}
+
 
 @Singleton
 class AgentContactDetailsController @Inject()(
-                                               val controllerComponents: MessagesControllerComponents,
+                                               override val messagesApi: MessagesApi,
+                                               sessionRepository: SessionRepository,
+                                               navigator: Navigator,
                                                identify: IdentifierAction,
-                                               view: IndexView
-                                             ) extends FrontendBaseController with I18nSupport {
+                                               getData: DataRetrievalAction,
+                                               requireData: DataRequiredAction,
+                                               formProvider: AgentContactDetailsFormProvider,
+                                               val controllerComponents: MessagesControllerComponents,
+                                               view: AgentContactDetailsView
+                                       )(implicit ec: ExecutionContext) extends FrontendBaseController with I18nSupport {
 
-  def onPageLoad(mode: Mode): Action[AnyContent] = identify { implicit request =>
-    Ok(view())
+  val form = formProvider()
+
+  def onPageLoad(mode: Mode): Action[AnyContent] = (identify andThen getData andThen requireData) {
+    implicit request =>
+
+      val preparedForm = request.userAnswers.get(AgentContactDetailsPage) match {
+        case None => form
+        case Some(value) => form.fill(value)
+      }
+
+      Ok(view(preparedForm, mode))
   }
 
-  def onSubmit(mode: Mode): Action[AnyContent] = identify { implicit request =>
-    Ok(view())
+  def onSubmit(mode: Mode): Action[AnyContent] = (identify andThen getData andThen requireData).async {
+    implicit request =>
+
+      form.bindFromRequest().fold(
+        formWithErrors =>
+          Future.successful(BadRequest(view(formWithErrors, mode))),
+
+        value =>
+          for {
+            updatedAnswers <- Future.fromTry(request.userAnswers.set(AgentContactDetailsPage, value))
+            _              <- sessionRepository.set(updatedAnswers)
+          } yield Redirect(navigator.nextPage(AgentCheckYourAnswersPage, mode, updatedAnswers))
+      )
   }
-}
+}

app/controllers/manageAgents/AgentContactDetailsController.scala

@@ -47,7 +47,7 @@ class CheckYourAnswersController @Inject()(
         rows = Seq(
           AgentNameSummary.row(request.userAnswers),
           AddressSummary.row(request.userAnswers),
-          ContactTelephoneNumberSummary.row(request.userAnswers),
+          ContactPhoneNumberSummary.row(request.userAnswers),
           ContactEmailSummary.row(request.userAnswers)
         ).flatten
       )

app/controllers/manageAgents/CheckYourAnswersController.scala

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2025 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package forms.constraints
+
+import play.api.data.validation._
+
+object OptionalMaxLength {
+  def apply(max: Int, errorKey: String): Constraint[Option[String]] =
+    Constraint("constraints.maxLength") {
+      case Some(value) if value.length > max =>
+        Invalid(ValidationError(errorKey, max))
+      case _ => Valid
+    }
+}
+
+object OptionalEmailFormat {
+  def apply(errorKey: String): Constraint[Option[String]] =
+    Constraint("constraints.email") {
+      case Some(value) if !value.matches("^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$") =>
+        Invalid(ValidationError(errorKey))
+      case _ => Valid
+    }
+}
+
+object OptionalPhoneFormat {
+  def apply(errorKey: String): Constraint[Option[String]] =
+    Constraint("constraints.phone") {
+      case Some(value) if !value.matches("""^\d+$""") =>
+        Invalid(ValidationError(errorKey))
+      case _ => Valid
+    }
+}

app/forms/constraints/OptionalVerification.scala

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2025 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package forms.manageAgents
+
+import forms.constraints.{OptionalEmailFormat, OptionalMaxLength, OptionalPhoneFormat}
+import models.manageAgents.AgentContactDetails
+import play.api.data.Form
+import play.api.data.Forms.{mapping, optional, text}
+import play.api.data.validation.Constraint
+
+class AgentContactDetailsFormProvider {
+
+  def apply(): Form[AgentContactDetails] = {
+    Form(
+      mapping(
+        "phone" -> optional(text)
+          .verifying(OptionalMaxLength(14, "manageAgents.agentContactDetails.error.phoneLength"))
+          .verifying(OptionalPhoneFormat("manageAgents.agentContactDetails.error.phoneInvalid")),
+        "email" -> optional(text)
+          .verifying(OptionalMaxLength(36, "manageAgents.agentContactDetails.error.emailLength"))
+          .verifying(OptionalEmailFormat("manageAgents.agentContactDetails.error.emailInvalid"))
+      )(AgentContactDetails.apply)(contactDetails => Some((contactDetails.phone, contactDetails.email)))
+    )
+  }
+}

app/forms/manageAgents/AgentContactDetailsFormProvider.scala

@@ -16,11 +16,12 @@
 
 package models.manageAgents
 
-import play.api.libs.json.*
+import play.api.libs.json.{Json, OFormat}
 
-case class AgentContactDetails(contactTelephoneNumber: String, contactEmail: String)
+case class AgentContactDetails(
+                                phone: Option[String], email: Option[String]
+                              )
 
 object AgentContactDetails {
-
-  implicit val format: OFormat[AgentContactDetails] = Json.format
+  implicit val format: OFormat[AgentContactDetails] = Json.format[AgentContactDetails]
 }

app/models/manageAgents/AgentContactDetails.scala

@@ -25,5 +25,5 @@ case object AgentContactDetailsPage extends QuestionPage[AgentContactDetails] {
   override def path: JsPath = JsPath \ toString
 
   override def toString: String = "agentContactDetails"
-  
-}
+
+}

app/pages/manageAgents/AgentContactDetailsPage.scala

@@ -30,7 +30,7 @@ object ContactEmailSummary {
     answers.get(AgentContactDetailsPage).map { answer =>
       SummaryListRowViewModel(
         key = s"manageAgents.contactEmail.checkYourAnswersLabel",
-        value = ValueViewModel(HtmlFormat.escape(answer.contactEmail).toString),
+        value = ValueViewModel(HtmlFormat.escape(answer.email.getOrElse("")).toString),
         actions = Seq(
           ActionItemViewModel(
             "site.change",

app/viewmodels/manageAgents/checkAnswers/ContactEmailSummary.scala

@@ -24,13 +24,13 @@ import uk.gov.hmrc.govukfrontend.views.viewmodels.summarylist.SummaryListRow
 import viewmodels.govuk.summarylist.*
 import viewmodels.implicits.*
 
-object ContactTelephoneNumberSummary {
+object ContactPhoneNumberSummary {
 
   def row(answers: UserAnswers)(implicit messages: Messages): Option[SummaryListRow] = {
     answers.get(AgentContactDetailsPage).map { answer =>
       SummaryListRowViewModel(
         key = s"manageAgents.contactTelephoneNumber.checkYourAnswersLabel",
-        value = ValueViewModel(HtmlFormat.escape(answer.contactTelephoneNumber).toString),
+        value = ValueViewModel(HtmlFormat.escape(answer.phone.getOrElse("")).toString),
         actions = Seq(
           ActionItemViewModel(
             "site.change",

app/viewmodels/manageAgents/checkAnswers/ContactTelephoneNumberSummary.scala renamed to app/viewmodels/manageAgents/checkAnswers/ContactPhoneNumberSummary.scala

@@ -0,0 +1,63 @@
+@*
+ * Copyright 2025 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *@
+
+@import viewmodels.InputWidth._
+
+@this(
+        layout: templates.Layout,
+        formHelper: FormWithCSRF,
+        govukErrorSummary: GovukErrorSummary,
+        govukInput: GovukInput,
+        govukButton: GovukButton
+    )
+
+    @(form: Form[_], mode: Mode)(implicit request: Request[_], messages: Messages)
+
+    @layout(pageTitle = title(form, messages("manageAgents.agentContactDetails.title"))) {
+
+    @formHelper(action = controllers.manageAgents.routes.AgentContactDetailsController.onSubmit(mode), Symbol("autoComplete") -> "off") {
+
+        @if(form.errors.nonEmpty) {
+            @govukErrorSummary(ErrorSummaryViewModel(form))
+        }
+
+
+        <span class="govuk-caption-xl">@messages("manageAgents.agentContactDetails.caption")</span>
+        <h1 class="govuk-heading-xl">@messages("manageAgents.agentContactDetails.heading")</h1>
+
+        @govukInput(
+            InputViewModel(
+                field = form("phone"),
+                label = LabelViewModel(messages("manageAgents.agentContactDetails.question1"))
+        )
+    .withWidth(Full)
+        )
+
+        @govukInput(
+            InputViewModel(
+                field = form("email"),
+                label = LabelViewModel(messages("manageAgents.agentContactDetails.question2"))
+
+        )
+    .withWidth(Full)
+    .withHint(HintViewModel(HtmlContent(messages("manageAgents.agentContactDetails.hint"))))
+        )
+
+        @govukButton(
+            ButtonViewModel(messages("site.continue"))
+        )
+    }
+}