@defra/forms-engine-plugin 0.0.4 → 0.0.6

package/src/server/plugins/engine/pageControllers/PageController.ts

@@ -0,0 +1,176 @@
+import {
+  ControllerPath,
+  type Events,
+  type FormDefinition,
+  type Page,
+  type Section
+} from '@defra/forms-model'
+import Boom from '@hapi/boom'
+import {
+  type Lifecycle,
+  type ResponseToolkit,
+  type RouteOptions
+} from '@hapi/hapi'
+
+import { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
+import {
+  encodeUrl,
+  getStartPath,
+  normalisePath
+} from '~/src/server/plugins/engine/helpers.js'
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'
+import {
+  type FormContext,
+  type PageViewModelBase
+} from '~/src/server/plugins/engine/types.js'
+import {
+  type FormRequest,
+  type FormRequestPayload,
+  type FormRequestPayloadRefs,
+  type FormRequestRefs
+} from '~/src/server/routes/types.js'
+
+export class PageController {
+  /**
+   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.
+   */
+  def: FormDefinition
+  name?: string
+  model: FormModel
+  pageDef: Page
+  title: string
+  section?: Section
+  condition?: ExecutableCondition
+  events?: Events
+  collection?: ComponentCollection
+  viewName = 'index'
+
+  constructor(model: FormModel, pageDef: Page) {
+    const { def } = model
+
+    this.def = def
+    this.name = def.name
+    this.model = model
+    this.pageDef = pageDef
+    this.title = pageDef.title
+    this.events = pageDef.events
+
+    // Resolve section
+    this.section = model.sections.find(
+      (section) => section.name === pageDef.section
+    )
+
+    // Resolve condition
+    if (pageDef.condition) {
+      this.condition = model.conditions[pageDef.condition]
+    }
+
+    // Override view name
+    if (pageDef.view) {
+      this.viewName = pageDef.view
+    }
+  }
+
+  get path() {
+    return this.pageDef.path
+  }
+
+  get href() {
+    const { path } = this
+    return this.getHref(`/${normalisePath(path)}`)
+  }
+
+  get keys() {
+    return this.collection?.keys ?? []
+  }
+
+  /**
+   * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+   */
+  get getRouteOptions(): RouteOptions<FormRequestRefs> {
+    return {}
+  }
+
+  /**
+   * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+   */
+  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {
+    return {}
+  }
+
+  get viewModel(): PageViewModelBase {
+    const { name, section, title } = this
+
+    const showTitle = true
+    const pageTitle = title
+    const sectionTitle = section?.hideTitle !== true ? section?.title : ''
+
+    return {
+      name,
+      page: this,
+      pageTitle,
+      sectionTitle,
+      showTitle,
+      isStartPage: false,
+      serviceUrl: this.getHref('/'),
+      feedbackLink: this.feedbackLink,
+      phaseTag: this.phaseTag
+    }
+  }
+
+  get feedbackLink() {
+    const { def } = this
+
+    // setting the feedbackLink to undefined here for feedback forms prevents the feedback link from being shown
+    const feedbackLink = def.feedback?.emailAddress
+      ? `mailto:${def.feedback.emailAddress}`
+      : def.feedback?.url
+
+    return encodeUrl(feedbackLink)
+  }
+
+  get phaseTag() {
+    const { def } = this
+    return def.phaseBanner?.phase
+  }
+
+  getHref(path: string) {
+    const { model } = this
+
+    return path === '/'
+      ? `/${model.basePath}` // Strip trailing slash
+      : `/${model.basePath}${path}`
+  }
+
+  getStartPath() {
+    return getStartPath(this.model)
+  }
+
+  getSummaryPath() {
+    return ControllerPath.Summary.valueOf()
+  }
+
+  getStatusPath() {
+    return ControllerPath.Status.valueOf()
+  }
+
+  makeGetRouteHandler(): (
+    request: FormRequest,
+    context: FormContext,
+    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {
+    return (request, context, h) => {
+      const { viewModel, viewName } = this
+      return h.view(viewName, viewModel)
+    }
+  }
+
+  makePostRouteHandler(): (
+    request: FormRequestPayload,
+    context: FormContext,
+    h: Pick<ResponseToolkit, 'redirect' | 'view'>
+  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {
+    throw Boom.badRequest('Unsupported POST route handler for this page')
+  }
+}