@defra/forms-engine-plugin 0.0.4 → 0.0.5

package/src/server/views/help/terms-and-conditions.html

@@ -0,0 +1,83 @@
+{% extends 'layout.html' %}
+
+{% block content %}
+<div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+        <h1 class="govuk-heading-l">Terms and conditions</h1>
+        <p class="govuk-body">By using this digital service you agree to our <a rel=noopener
+                href="https://www.gov.uk/government/publications/foreign-and-commonwealth-office-privacy-notice-consular-services-in-the-uk-and-at-british-embassies-high-commissions-and-consulates-overseas/foreign-and-commonwealth-office-privacy-notice-consular-services-in-the-uk-and-missions-overseas">
+            privacy policy</a> and to these terms and conditions. Read them carefully.
+        </p>
+        <h2 class="govuk-heading-l">General</h2>
+        <p class="govuk-body">These terms and conditions affect your rights and liabilities under
+            the law. They govern your use of, and relationship with, the service. They don’t apply to other services
+            provided by the Foreign &amp; Commonwealth Office, or to any other department or service which is linked
+            to in this service.</p>
+        <p class="govuk-body">You agree to use this site only for lawful purposes, and in a
+            manner that does not infringe the rights of, or restrict or inhibit the use and enjoyment of, this site
+            by any third party.</p>
+        <p class="govuk-body">We may occasionally update these terms and conditions. This might happen if there’s a change in the law or to the way this service works. Check these terms and conditions regularly, as continued use of the service after a change has been made is your acceptance of the change. If you don't agree to the terms and conditions and </span><a
+                rel=noopener href="https://www.gov.uk/government/publications/foreign-and-commonwealth-office-privacy-notice-consular-services-in-the-uk-and-at-british-embassies-high-commissions-and-consulates-overseas/foreign-and-commonwealth-office-privacy-notice-consular-services-in-the-uk-and-missions-overseas">
+            privacy policy</a>, you should not use this service.</p>
+        <h2 class="govuk-heading-l">Applicable law</h2>
+        <p class="govuk-body">Your use of this service and any dispute arising from its use will
+            be governed by and construed in accordance with the laws of England and Wales, including but not limited
+            to the:</p>
+        <ul class="govuk-list">
+            <li>Computer Misuse Act 1990</li>
+            <li>Data Protection Act</li>
+            <li>Mental Capacity Act 2005</li>
+        </ul>
+        <h2 class="govuk-heading-l">How to use this service responsibly</h2>
+        <p class="govuk-body">You must provide us with enough information for us to assess the
+            case fairly and if appropriate to provide the service. We also need these details to provide information
+            about the appointment, including rescheduling and cancellation when necessary, so you must provide
+            accurate details where we can reliably contact you.</p>
+        <p class="govuk-body">When attending their appointment the person requiring an emergency
+            travel document will have to pass through Security checks. They should expect their belongings to be
+            checked, and will have to leave their mobile phone and other belongings with the Security Officer. Do
+            not bring laptops or other electronic devices. Arrive in advance of the appointment. If you need to
+            cancel or modify your booking, you will be able to do so by following the link in the confirmation
+            email.</p>
+        <p class="govuk-body">There are risks in using a shared computer, such as in an internet
+            café, to use this digital service. It’s your responsibility to be aware of these risks and to avoid
+            using any computer which may leave your personal information accessible to others. You are responsible
+            if you choose to leave a computer unprotected while in the process of using the service.</p>
+        <p class="govuk-body">We make every effort to check and test this service whenever we
+            amend or update it. However, you must take your own precautions to ensure that the way you access this
+            service does not expose you to the risk of viruses, malicious computer code or other forms of
+            interference which may damage your own computer system.</p>
+        <p class="govuk-body">You must not misuse our service by knowingly introducing viruses,
+            trojans, worms, logic bombs or other material which is malicious or technologically harmful. You must
+            not attempt to gain unauthorised access to our service, the system on which our service is stored or any
+            server, computer or database connected to our service. You must not attack our site via a
+            denial-of-service attack or a distributed denial-of-service attack.</p>
+        <h1 class="govuk-heading-l">Disclaimer</h1>
+        <p class="govuk-body">While we make every effort to keep this service up to date, we
+            don’t provide any guarantees, conditions or warranties as to the accuracy of the information on the
+            site.</p>
+        <p class="govuk-body">While Consular staff will give you as much advice as they can, it
+            is your responsibility to ensure that you are obtaining the correct service and that you bring all the
+            necessary documentation for the service. If you are unsure, you may wish to take legal advice before
+            booking the service </p>
+        <p class="govuk-body">Our consular fees are not refundable, and are subject to change without notice. Check the relevant <a
+                href="https://www.gov.uk/search?q=consular+fees" target="_blank" rel="noopener noreferrer">consular fees list</a> for the latest information.</p>
+        <p class="govuk-body">We don’t accept liability for loss or damage incurred by users of
+            this service, whether direct, indirect or consequential, whether caused by tort, breach of contract or
+            otherwise. This includes loss of income or revenue, business, profits or contracts, anticipated savings,
+            data, goodwill, tangible property or wasted time in connection with this service or any websites linked
+            to it and any materials posted on it. This condition shall not prevent claims for loss of or damage to
+            your tangible property or any other claims for direct financial loss that are not excluded by any of the
+            categories set out above.</p>
+        <p class="govuk-body">This does not affect our liability for death or personal injury
+            arising from our negligence, nor our liability for fraudulent misrepresentation or misrepresentation as
+            to a fundamental matter, nor any other liability which cannot be excluded or limited under applicable
+            law. </p>
+        <h2 class="govuk-heading-l">Information provided by this service</h2>
+        <p class="govuk-body"> We work hard to ensure that information within this service is
+            accurate. However, we can’t guarantee the accuracy and completeness of any information at all times.
+            While we make every effort to ensure this service is accessible at all times, we are not liable if it is
+            unavailable for any period of time. </p>
+    </div>
+</div>
+{% endblock %}

package/src/server/views/layout.html

@@ -0,0 +1,199 @@
+{% extends "govuk/template.njk" %}
+
+{% from "govuk/components/back-link/macro.njk" import govukBackLink -%}
+{% from "govuk/components/footer/macro.njk" import govukFooter -%}
+{% from "govuk/components/phase-banner/macro.njk" import govukPhaseBanner -%}
+{% from "govuk/components/skip-link/macro.njk" import govukSkipLink -%}
+{% from "govuk/macros/attributes.njk" import govukAttributes -%}
+{% from "components/service-banner/macro.njk" import appServiceBanner -%}
+{% from "components/tag-env/macro.njk" import appTagEnv -%}
+{% from "govuk/components/cookie-banner/macro.njk" import govukCookieBanner -%}
+{% from "govuk/components/notification-banner/macro.njk" import govukNotificationBanner -%}
+
+{% set productName %}
+  {% if config.cdpEnvironment !== "prod" %}
+    {{ appTagEnv({ env: config.cdpEnvironment }) }}
+  {% endif %}
+{% endset %}
+
+{% block head %}
+  <meta name="application-name" content="@defra/forms-runner" {{- govukAttributes({
+    "data-environment": {
+      value: config.cdpEnvironment,
+      optional: true
+    },
+    "data-version": {
+      value: config.serviceVersion,
+      optional: true
+    }
+  }) }}>
+
+  <link rel="preload" as="font" href="{{ assetPath }}/fonts/bold-b542beb274-v2.woff2" type="font/woff2" crossorigin="anonymous">
+  <link rel="preload" as="font" href="{{ assetPath }}/fonts/light-94a07e06a1-v2.woff2" type="font/woff2" crossorigin="anonymous">
+  <link rel="stylesheet" href="{{ getAssetPath("stylesheets/application.scss") }}">
+{% endblock %}
+
+{% block pageTitle -%}
+  {{ "Error: " if errors | length }}{{ pageTitle | evaluate }} - {{ name if name else config.serviceName }} - GOV.UK
+{%- endblock %}
+
+{% block skipLink %}
+  {{ govukSkipLink({
+    href: '#main-content',
+    text: 'Skip to main content'
+  }) }}
+{% endblock %}
+
+{% block header %}
+  {% if config.googleAnalyticsTrackingId and slug %}
+    <form method="post" action="/help/cookie-preferences/{{ slug }}?returnUrl={{ currentPath | urlencode }}">
+      <input type="hidden" name="crumb" value="{{ crumb }}">
+
+    {% set acceptHtml %}
+      <p class="govuk-body">You’ve accepted analytics cookies. You can <a class="govuk-link" href="/help/cookies/{{ slug }}">change your cookie settings</a> at any time.</p>
+    {% endset %}
+
+    {% set rejectedHtml %}
+      <p class="govuk-body">You’ve rejected analytics cookies. You can <a class="govuk-link" href="/help/cookies/{{ slug }}">change your cookie settings</a> at any time.</p>
+    {% endset %}
+
+    {% if cookieConsent.analytics !== true and cookieConsent.analytics !== false and cookieConsent.dismissed !== true %}
+      {% set html %}
+        <p class="govuk-body">We use some essential cookies to make this service work.</p>
+        <p class="govuk-body">We’d like to set analytics cookies so we can understand how people use the service and make improvements.</p>
+      {% endset %}
+
+      {{ govukCookieBanner({
+        ariaLabel: "Cookies on " + config.serviceName,
+        messages: [
+          {
+            headingText: config.serviceName,
+            html: html,
+            actions: [
+              {
+                text: "Accept analytics cookies",
+                type: "submit",
+                name: "cookies[analytics]",
+                value: "yes"
+              },
+              {
+                text: "Reject analytics cookies",
+                type: "submit",
+                name: "cookies[analytics]",
+                value: "no"
+              },
+              {
+                text: "View cookies",
+                href: "/help/cookies/" + slug
+              }
+            ]
+          }
+        ]
+      }) }}
+    {% elif cookieConsent.dismissed === false %}
+      {{ govukCookieBanner({
+        ariaLabel: "Cookies on " + config.serviceName,
+        messages: [
+          {
+            html: acceptHtml if cookieConsent.analytics === true else rejectedHtml,
+            actions: [
+              {
+                text: "Hide cookie message",
+                type: "submit",
+                name: "cookies[dismissed]",
+                value: "yes"
+              }
+            ]
+          }
+        ]
+      }) }}
+    {% endif %}
+
+    </form>
+  {% endif %}
+
+  {% if config.serviceBannerText | length %}
+    {{ appServiceBanner({
+      title: "Service status",
+      text: config.serviceBannerText
+    }) }}
+  {% endif %}
+
+  {{ govukHeader({
+    homepageUrl: currentPath if context.isForceAccess else "https://www.gov.uk",
+    containerClasses: "govuk-width-container",
+    productName: productName | safe | trim,
+    serviceName: name if name else config.serviceName,
+    serviceUrl: currentPath if context.isForceAccess else serviceUrl
+  }) }}
+{% endblock %}
+
+{% block beforeContent %}
+  {% set feedbackLink = feedbackLink or config.feedbackLink -%}
+  {% set phaseTag = phaseTag or config.phaseTag -%}
+
+  {% if phaseTag %}
+    {% set feedbackLinkHtml -%}
+      <a href="{{ currentPath if context.isForceAccess else feedbackLink }}" class="govuk-link" {%- if not context.isForceAccess %} target="_blank" rel="noopener noreferrer" {%- endif %}>
+        {%- if "mailto:" in feedbackLink -%}
+          give your feedback by email
+        {%- else -%}
+          give your feedback (opens in new tab)
+        {%- endif -%}
+      </a>
+    {%- endset %}
+
+    {{ govukPhaseBanner({
+      tag: { text: phaseTag | capitalize },
+      html: "This is a new service. Help us improve it and " + feedbackLinkHtml | safe + "."
+    }) }}
+  {% endif %}
+  {% if backLink %}
+    {{ govukBackLink(backLink) }}
+  {% endif %}
+{% endblock %}
+
+{% block content %}
+  <h1 class="govuk-heading-l">Default page template</h1>
+{% endblock %}
+
+{% block bodyEnd %}
+  <script type="module" nonce="{{ cspNonce }}" src="{{ getAssetPath("application.js") }}"></script>
+
+  {% if config.googleAnalyticsTrackingId and cookieConsent.analytics === true %}
+  <script id="ga-tag-js-main" nonce="{{ cspNonce }}" src="https://www.googletagmanager.com/gtag/js?id={{ config.googleAnalyticsTrackingId }}" defer></script>
+  <script id="ga-tag-js-init" nonce="{{ cspNonce }}">
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+    gtag('config', '{{ config.googleAnalyticsTrackingId }}');
+  </script>
+{% endif %}
+{% endblock %}
+
+{% block footer %}
+  {% set meta = {
+    items: [
+      {
+        href: '/help/get-support/' + slug,
+        text: 'Get help with this form'
+      },
+      {
+        href: '/help/privacy/' + slug,
+        text: 'Privacy'
+      },
+      {
+        href: '/help/cookies/' + slug,
+        text: 'Cookies'
+      },
+      {
+        href: '/help/accessibility-statement/' + slug,
+        text: 'Accessibility Statement'
+      }
+    ]
+  } if slug %}
+
+  {% if not context.isForceAccess %}
+    {{ govukFooter({ meta: meta }) }}
+  {% endif %}
+{% endblock %}

package/src/server/views/summary.html

@@ -0,0 +1,50 @@
+{% extends "layout.html" %}
+
+{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
+{% from "govuk/components/summary-list/macro.njk" import govukSummaryList %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      {% if previewMode %}
+        {% include "partials/preview-banner.html" %}
+      {% endif %}
+
+      {% if hasMissingNotificationEmail %}
+        {% include "partials/warn-missing-notification-email.html" %}
+      {% endif %}
+
+      <h1 class="govuk-heading-l">
+        {{ pageTitle }}
+      </h1>
+
+      {% for section in checkAnswers %}
+        {% if section.title.text %}
+          <h2 class="govuk-heading-m">
+            {{ section.title.text }}
+          </h2>
+        {% endif %}
+
+        {{ govukSummaryList(section.summaryList) }}
+      {% endfor %}
+
+      <form method="post" novalidate>
+        <input type="hidden" name="crumb" value="{{ crumb }}">
+        <input type="hidden" name="action" value="send">
+
+        {% if declaration %}
+          <h2 class="govuk-heading-m" id="declaration">Declaration</h2>
+          {{ declaration | safe }}
+        {% endif %}
+
+        <button data-prevent-double-click="true" class="govuk-button" data-module="govuk-button">
+          {{ "Accept and send" if declaration else "Send" }}
+        </button>
+      </form>
+    </div>
+  </div>
+
+  {% if config.cdpEnvironment == 'local' and context | length and not context.isForceAccess %}
+    {% include "partials/debug.html" %}
+  {% endif %}
+{% endblock %}

package/src/typings/hapi/index.d.ts

@@ -0,0 +1,95 @@
+/* eslint-disable @typescript-eslint/unified-signatures */
+
+import { type Plugin } from '@hapi/hapi'
+import { type ServerYar, type Yar } from '@hapi/yar'
+import { type Logger } from 'pino'
+
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+import {
+  type FormRequest,
+  type FormRequestPayload
+} from '~/src/server/routes/types.js'
+import { type CacheService } from '~/src/server/services/index.js'
+
+declare module '@hapi/hapi' {
+  // Here we are decorating Hapi interface types with
+  // props from plugins which doesn't export @types
+  interface PluginProperties {
+    crumb: {
+      generate?: (request: Request | FormRequest | FormRequestPayload) => string
+    }
+  }
+
+  interface PluginsStates {
+    blankie?: {
+      nonces?: {
+        script?: string
+        style?: string
+      }
+    }
+  }
+
+  interface Request {
+    logger: Logger
+    yar: Yar
+  }
+
+  interface RequestApplicationState {
+    model?: FormModel
+  }
+
+  interface Server {
+    logger: Logger
+    yar: ServerYar
+  }
+
+  interface ServerApplicationState {
+    model?: FormModel
+    models: Map<string, { model: FormModel; updatedAt: Date }>
+  }
+}
+
+declare module '@hapipal/schmervice' {
+  interface RegisteredServices {
+    cacheService: CacheService
+  }
+
+  interface SchmerviceDecorator {
+    (all?: boolean): RegisteredServices
+    (namespace?: string[]): RegisteredServices
+  }
+}
+
+declare module '@hapi/scooter' {
+  declare const hapiScooter: {
+    plugin: Plugin
+  }
+
+  export = hapiScooter
+}
+
+declare module 'blankie' {
+  declare const blankie: {
+    plugin: Plugin<Record<string, boolean | string | string[]>>
+  }
+
+  export = blankie
+}
+
+declare module 'blipp' {
+  declare const blipp: {
+    plugin: Plugin
+  }
+
+  export = blipp
+}
+
+declare module 'hapi-pulse' {
+  declare const hapiPulse: {
+    plugin: Plugin<{
+      timeout: number
+    }>
+  }
+
+  export = hapiPulse
+}

package/src/typings/hapi-tracing/index.d.ts

@@ -0,0 +1,6 @@
+declare module '@defra/hapi-tracing' {
+  import { type Plugin } from '@hapi/hapi'
+
+  export const tracing: Plugin<unknown>
+  export function getTraceId(): string | null
+}

package/src/typings/index.d.ts

@@ -0,0 +1,3 @@
+declare module '@hapi/scooter'
+declare module 'blankie'
+declare module 'blipp'

package/src/typings/joi/index.d.ts

@@ -0,0 +1,22 @@
+import { type FormPayload } from '~/src/server/plugins/engine/types.ts'
+
+declare module 'joi' {
+  interface Context {
+    present?: string[]
+    presentWithLabels?: string[]
+    missing?: string[]
+    missingWithLabels?: string[]
+  }
+
+  /**
+   * Add context types for `object.and` error reports
+   * {@link https://joi.dev/api/?v=17.13.3#objectand}
+   */
+  interface ErrorReportCollection extends ErrorReport {
+    local: Context & {
+      value: FormPayload
+      label?: string
+      title?: string
+    }
+  }
+}