@defra/forms-engine-plugin 4.0.0 → 4.0.2

package/.server/server/plugins/postcode-lookup/types.d.ts

@@ -0,0 +1,204 @@
+export type PostcodeLookupConfiguration = {
+    ordnanceSurveyApiKey: string;
+};
+export type PostcodeLookupDispatchArgs = {
+    name: string;
+    step?: string;
+};
+export type PostcodeLookupDispatchData = {
+    sourceUrl: string;
+    formName: string;
+    componentName: string;
+    componentTitle: string;
+    componentHint?: string;
+    step?: string;
+};
+export type PostcodeLookupSessionData = {
+    initial: PostcodeLookupDispatchData;
+    details: PostcodeLookupDetailsData;
+};
+/**
+ * The postcode lookup details form view model data
+ */
+export type PostcodeLookupDetailsData = {
+    /**
+     * - postcode query
+     */
+    postcodeQuery: string;
+    /**
+     * - Building name or number query
+     */
+    buildingNameQuery: string;
+};
+/**
+ * Postcode lookup query params
+ */
+export type PostcodeLookupQuery = {
+    /**
+     * - step
+     */
+    step?: string | undefined;
+};
+export type PostcodeLookupDetailsPayloadProperties = {
+    /**
+     * - step
+     */
+    step: string;
+};
+export type PostcodeLookupDetailsPayload = PostcodeLookupDetailsData & PostcodeLookupDetailsPayloadProperties;
+export type PostcodeLookupSelectPayload = {
+    /**
+     * - step
+     */
+    step: string;
+    /**
+     * - postcode
+     */
+    uprn: string;
+};
+/**
+ * Postcode lookup get request
+ */
+export type PostcodeLookupGetRequestRefs = {
+    /**
+     * - Request query
+     */
+    Query: PostcodeLookupQuery;
+};
+/**
+ * Postcode lookup post request
+ */
+export type PostcodeLookupPostRequestRefs = {
+    /**
+     * - Request payload
+     */
+    Payload: PostcodeLookupDetailsPayload | PostcodeLookupSelectPayload;
+};
+export type PostcodeLookupRequestRefs = PostcodeLookupGetRequestRefs | PostcodeLookupPostRequestRefs;
+export type PostcodeLookupGetRequest = Request<PostcodeLookupGetRequestRefs>;
+export type PostcodeLookupPostRequest = Request<PostcodeLookupPostRequestRefs>;
+export type PostcodeLookupRequest = PostcodeLookupGetRequest | PostcodeLookupPostRequest;
+export type PostcodeLookupManualPayload = {
+    /**
+     * - The address line 1
+     */
+    addressLine1: string;
+    /**
+     * - The address line 2
+     */
+    addressLine2: string;
+    /**
+     * - The address town or city
+     */
+    town: string;
+    /**
+     * - The address county
+     */
+    county: string;
+    /**
+     * - The address postcode
+     */
+    postcode: string;
+};
+export type Address = {
+    /**
+     * - The unique property reference
+     */
+    uprn: string;
+    /**
+     * - The full address
+     */
+    address: string;
+    /**
+     * - Address line 1
+     */
+    addressLine1: string;
+    /**
+     * - Address line 2
+     */
+    addressLine2: string;
+    /**
+     * - Address town
+     */
+    town: string;
+    /**
+     * - Address county
+     */
+    county: string;
+    /**
+     * - Address postcode
+     */
+    postcode: string;
+    /**
+     * - The full formatted address
+     */
+    formatted: string;
+};
+/**
+ * OS places address response
+ */
+export type DeliveryPointAddress = {
+    /**
+     * - Unique property reference number
+     */
+    UPRN: string;
+    /**
+     * - Unique delivery point Reference Number
+     */
+    UDPRN: string;
+    /**
+     * - Address
+     */
+    ADDRESS: string;
+    /**
+     * - Organisation name
+     */
+    ORGANISATION_NAME: string;
+    /**
+     * - Sub building name
+     */
+    SUB_BUILDING_NAME: string;
+    /**
+     * - Building name
+     */
+    BUILDING_NAME: string;
+    /**
+     * - Building number
+     */
+    BUILDING_NUMBER: string;
+    /**
+     * - Throughfare name
+     */
+    THOROUGHFARE_NAME: string;
+    /**
+     * - Dependent locality
+     */
+    DEPENDENT_LOCALITY: string;
+    /**
+     * - Post town
+     */
+    POST_TOWN: string;
+    /**
+     * - Postcode
+     */
+    POSTCODE: string;
+};
+/**
+ * OS places DPA response
+ */
+export type DeliveryPointAddressItem = {
+    /**
+     * - Delivery point address
+     */
+    DPA: DeliveryPointAddress;
+};
+/**
+ * OS places DPA response
+ */
+export type DeliveryPointAddressResult = {
+    /**
+     * - Delivery point address results
+     */
+    results?: DeliveryPointAddressItem[] | undefined;
+};
+import type { Request } from '@hapi/hapi';

package/.server/server/plugins/postcode-lookup/types.js

@@ -0,0 +1,144 @@
+/**
+ * @typedef {{
+ *   ordnanceSurveyApiKey: string
+ * }} PostcodeLookupConfiguration
+ */
+
+/**
+ * @typedef {{
+ *   name: string
+ *   step?: string
+ * }} PostcodeLookupDispatchArgs
+ */
+
+/**
+ * @typedef {{
+ *   sourceUrl: string,
+ *   formName: string
+ *   componentName: string
+ *   componentTitle: string,
+ *   componentHint?: string
+ *   step?: string
+ * }} PostcodeLookupDispatchData
+ */
+
+/**
+ * @typedef {{
+ *   initial: PostcodeLookupDispatchData
+ *   details: PostcodeLookupDetailsData
+ * }} PostcodeLookupSessionData
+ */
+
+//
+// Model types
+//
+
+/**
+ * The postcode lookup details form view model data
+ * @typedef {object} PostcodeLookupDetailsData
+ * @property {string} postcodeQuery - postcode query
+ * @property {string} buildingNameQuery - Building name or number query
+ */
+
+//
+// Route types
+//
+
+/**
+ * Postcode lookup query params
+ * @typedef {object} PostcodeLookupQuery
+ * @property {string} [step] - step
+ */
+
+/**
+ * @typedef {object} PostcodeLookupDetailsPayloadProperties
+ * @property {string} step - step
+ */
+
+/**
+ * @typedef {PostcodeLookupDetailsData & PostcodeLookupDetailsPayloadProperties} PostcodeLookupDetailsPayload
+ */
+
+/**
+ * @typedef {object} PostcodeLookupSelectPayload
+ * @property {string} step - step
+ * @property {string} uprn - postcode
+ */
+
+/**
+ * Postcode lookup get request
+ * @typedef {object} PostcodeLookupGetRequestRefs
+ * @property {PostcodeLookupQuery} Query - Request query
+ */
+
+/**
+ * Postcode lookup post request
+ * @typedef {object} PostcodeLookupPostRequestRefs
+ * @property {PostcodeLookupDetailsPayload | PostcodeLookupSelectPayload} Payload - Request payload
+ */
+
+/**
+ * @typedef {PostcodeLookupGetRequestRefs | PostcodeLookupPostRequestRefs} PostcodeLookupRequestRefs
+ * @typedef {Request<PostcodeLookupGetRequestRefs>} PostcodeLookupGetRequest
+ * @typedef {Request<PostcodeLookupPostRequestRefs>} PostcodeLookupPostRequest
+ * @typedef {PostcodeLookupGetRequest | PostcodeLookupPostRequest} PostcodeLookupRequest
+ */
+
+/**
+ * @typedef {object} PostcodeLookupManualPayload
+ * @property {string} addressLine1 - The address line 1
+ * @property {string} addressLine2 - The address line 2
+ * @property {string} town - The address town or city
+ * @property {string} county - The address county
+ * @property {string} postcode - The address postcode
+ */
+
+//
+// Service types
+//
+
+/**
+ * @typedef {object} Address
+ * @property {string} uprn - The unique property reference
+ * @property {string} address - The full address
+ * @property {string} addressLine1 - Address line 1
+ * @property {string} addressLine2 - Address line 2
+ * @property {string} town - Address town
+ * @property {string} county - Address county
+ * @property {string} postcode - Address postcode
+ * @property {string} formatted - The full formatted address
+ */
+
+/**
+ * OS places address response
+ * @typedef {object} DeliveryPointAddress
+ * @property {string} UPRN - Unique property reference number
+ * @property {string} UDPRN - Unique delivery point Reference Number
+ * @property {string} ADDRESS - Address
+ * @property {string} ORGANISATION_NAME - Organisation name
+ * @property {string} SUB_BUILDING_NAME - Sub building name
+ * @property {string} BUILDING_NAME - Building name
+ * @property {string} BUILDING_NUMBER - Building number
+ * @property {string} THOROUGHFARE_NAME - Throughfare name
+ * @property {string} DEPENDENT_LOCALITY - Dependent locality
+ * @property {string} POST_TOWN - Post town
+ * @property {string} POSTCODE - Postcode
+ */
+
+/**
+ * OS places DPA response
+ * @typedef {object} DeliveryPointAddressItem
+ * @property {DeliveryPointAddress} DPA - Delivery point address
+ */
+
+/**
+ * OS places DPA response
+ * @typedef {object} DeliveryPointAddressResult
+ * @property {DeliveryPointAddressItem[]} [results] - Delivery point address results
+ */
+
+/**
+ * @import { Request } from '@hapi/hapi'
+ * @import { FormPayload } from '~/src/server/plugins/engine/types.js'
+ */
+//# sourceMappingURL=types.js.map

package/.server/server/plugins/postcode-lookup/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/postcode-lookup/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n * }} PostcodeLookupConfiguration\n */\n\n/**\n * @typedef {{\n *   name: string\n *   step?: string\n * }} PostcodeLookupDispatchArgs\n */\n\n/**\n * @typedef {{\n *   sourceUrl: string,\n *   formName: string\n *   componentName: string\n *   componentTitle: string,\n *   componentHint?: string\n *   step?: string\n * }} PostcodeLookupDispatchData\n */\n\n/**\n * @typedef {{\n *   initial: PostcodeLookupDispatchData\n *   details: PostcodeLookupDetailsData\n * }} PostcodeLookupSessionData\n */\n\n//\n// Model types\n//\n\n/**\n * The postcode lookup details form view model data\n * @typedef {object} PostcodeLookupDetailsData\n * @property {string} postcodeQuery - postcode query\n * @property {string} buildingNameQuery - Building name or number query\n */\n\n//\n// Route types\n//\n\n/**\n * Postcode lookup query params\n * @typedef {object} PostcodeLookupQuery\n * @property {string} [step] - step\n */\n\n/**\n * @typedef {object} PostcodeLookupDetailsPayloadProperties\n * @property {string} step - step\n */\n\n/**\n * @typedef {PostcodeLookupDetailsData & PostcodeLookupDetailsPayloadProperties} PostcodeLookupDetailsPayload\n */\n\n/**\n * @typedef {object} PostcodeLookupSelectPayload\n * @property {string} step - step\n * @property {string} uprn - postcode\n */\n\n/**\n * Postcode lookup get request\n * @typedef {object} PostcodeLookupGetRequestRefs\n * @property {PostcodeLookupQuery} Query - Request query\n */\n\n/**\n * Postcode lookup post request\n * @typedef {object} PostcodeLookupPostRequestRefs\n * @property {PostcodeLookupDetailsPayload | PostcodeLookupSelectPayload} Payload - Request payload\n */\n\n/**\n * @typedef {PostcodeLookupGetRequestRefs | PostcodeLookupPostRequestRefs} PostcodeLookupRequestRefs\n * @typedef {Request<PostcodeLookupGetRequestRefs>} PostcodeLookupGetRequest\n * @typedef {Request<PostcodeLookupPostRequestRefs>} PostcodeLookupPostRequest\n * @typedef {PostcodeLookupGetRequest | PostcodeLookupPostRequest} PostcodeLookupRequest\n */\n\n/**\n * @typedef {object} PostcodeLookupManualPayload\n * @property {string} addressLine1 - The address line 1\n * @property {string} addressLine2 - The address line 2\n * @property {string} town - The address town or city\n * @property {string} county - The address county\n * @property {string} postcode - The address postcode\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} Address\n * @property {string} uprn - The unique property reference\n * @property {string} address - The full address\n * @property {string} addressLine1 - Address line 1\n * @property {string} addressLine2 - Address line 2\n * @property {string} town - Address town\n * @property {string} county - Address county\n * @property {string} postcode - Address postcode\n * @property {string} formatted - The full formatted address\n */\n\n/**\n * OS places address response\n * @typedef {object} DeliveryPointAddress\n * @property {string} UPRN - Unique property reference number\n * @property {string} UDPRN - Unique delivery point Reference Number\n * @property {string} ADDRESS - Address\n * @property {string} ORGANISATION_NAME - Organisation name\n * @property {string} SUB_BUILDING_NAME - Sub building name\n * @property {string} BUILDING_NAME - Building name\n * @property {string} BUILDING_NUMBER - Building number\n * @property {string} THOROUGHFARE_NAME - Throughfare name\n * @property {string} DEPENDENT_LOCALITY - Dependent locality\n * @property {string} POST_TOWN - Post town\n * @property {string} POSTCODE - Postcode\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressItem\n * @property {DeliveryPointAddress} DPA - Delivery point address\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressResult\n * @property {DeliveryPointAddressItem[]} [results] - Delivery point address results\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n * @import { FormPayload } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/views/postcode-lookup-details.html

@@ -0,0 +1,83 @@
+{% extends baseLayoutPath %}
+
+{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
+{% from "govuk/components/input/macro.njk" import govukInput %}
+{% from "govuk/components/select/macro.njk" import govukSelect %}
+{% from "govuk/components/button/macro.njk" import govukButton %}
+{% from "govuk/components/inset-text/macro.njk" import govukInsetText %}
+{% from "govuk/components/hint/macro.njk" import govukHint %}
+{% from "govuk/components/fieldset/macro.njk" import govukFieldset %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      {% if errors %}
+        {{ govukErrorSummary({
+          titleText: "There is a problem",
+          errorList: errors
+        }) }}
+      {% endif %}
+
+      {% include "partials/heading.html" %}
+
+      <form method="post">
+        <input type="hidden" name="crumb" value="{{ crumb }}">
+        <input type="hidden" name="step" value="{{ step }}">
+
+        {% switch step %}
+          {% case "details" %}
+            <!-- Postcode lookup details -->
+            {{ govukInput(fields.postcodeQuery) }}
+            {{ govukInput(fields.buildingNameQuery) }}
+          {% case "select" %}
+            <!-- Postcode lookup select -->
+            <!-- Postcode lookup details display -->
+            {%- set detailsHtml -%}
+              <strong>{{ details.postcodeQuery }}</strong>{% if details.buildingNameQuery %} and <strong>{{ details.buildingNameQuery }}</strong>{% endif %}
+            {%- endset -%}
+
+            {% if hasAddresses %}
+              <p class="govuk-body">
+                {{addressCount}} address{{ "es" if hasMultipleAddresses }} found for {{ detailsHtml | safe }}. <a href="{{ searchAgainLink.href }}" class="govuk-link govuk-link--no-visited-state">{{ searchAgainLink.text }}</a>
+              </p>
+            {% endif %}
+
+            {% if hasMultipleAddresses %}
+              <!-- Multiple address found - show drop down select -->
+              {{ govukSelect(fields.uprn) }}
+            {% elif singleAddress %}
+              <!-- Single address found - show single item -->
+              {{ govukInput(fields.uprn) }}
+              {{ govukInsetText({
+                text: singleAddress.formatted
+              }) }}
+            {% else %}
+              <!-- No addresses found - show try again -->
+              <p class="govuk-body">We could not find an address that matches {{ detailsHtml | safe }}.</p>
+            {% endif %}
+          {% case "manual" %}
+            <!-- Postcode lookup manual entry -->
+            {% if hint %}
+              {{ govukHint(hint) }}
+            {% endif %}
+
+            {{ govukInput(fields.addressLine1) }}
+            {{ govukInput(fields.addressLine2) }}
+            {{ govukInput(fields.town) }}
+            {{ govukInput(fields.county) }}
+            {{ govukInput(fields.postcode) }}
+        {% endswitch %}
+
+        <div class="govuk-button-group">
+          {{ govukButton(buttons.continueButton) }}
+
+          {% if buttons.manualLink %}
+            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.manualLink.href }}">{{buttons.manualLink.text}}</a></p>
+          {% elif buttons.detailsLink %}
+            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.detailsLink.href }}">{{buttons.detailsLink.text}}</a></p>
+          {% endif %}
+        </div>
+      </form>
+    </div>
+  </div>
+{% endblock %}

package/.server/server/routes/types.d.ts

@@ -32,9 +32,14 @@ export declare enum FormAction {
     Delete = "delete",
     AddAnother = "add-another",
     Send = "send",
-    SaveAndExit = "save-and-exit"
+    SaveAndExit = "save-and-exit",
+    External = "external"
 }
 export declare enum FormStatus {
     Draft = "draft",
     Live = "live"
 }
+export declare enum ExternalActions {
+    PostcodeLookup = "postcode-lookup",
+    AnotherExternalAction = "another-external-action"
+}

package/.server/server/routes/types.js

@@ -5,6 +5,7 @@ export let FormAction = /*#__PURE__*/function (FormAction) {
   FormAction["AddAnother"] = "add-another";
   FormAction["Send"] = "send";
   FormAction["SaveAndExit"] = "save-and-exit";
+  FormAction["External"] = "external";
   return FormAction;
 }({});
 export let FormStatus = /*#__PURE__*/function (FormStatus) {
@@ -12,4 +13,9 @@ export let FormStatus = /*#__PURE__*/function (FormStatus) {
   FormStatus["Live"] = "live";
   return FormStatus;
 }({});
+export let ExternalActions = /*#__PURE__*/function (ExternalActions) {
+  ExternalActions["PostcodeLookup"] = "postcode-lookup";
+  ExternalActions["AnotherExternalAction"] = "another-external-action";
+  return ExternalActions;
+}({});
 //# sourceMappingURL=types.js.map

package/.server/server/routes/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["FormAction","FormStatus"],"sources":["../../../src/server/routes/types.ts"],"sourcesContent":["import {\n  type ReqRefDefaults,\n  type Request,\n  type ResponseToolkit\n} from '@hapi/hapi'\n\nimport { type FormPayload } from '~/src/server/plugins/engine/types.js'\n\nexport interface FormQuery extends Partial<Record<string, string>> {\n  /**\n   * Allow preview URL direct access without relevant page checks\n   */\n  force?: string\n\n  /**\n   * Redirect location after 'continue' form action\n   */\n  returnUrl?: string\n}\n\nexport interface FormParams extends Partial<Record<string, string>> {\n  path: string\n  slug: string\n  state?: FormStatus\n}\n\nexport interface FormRequestRefs\n  extends Omit<ReqRefDefaults, 'Params' | 'Payload' | 'Query'> {\n  Params: FormParams\n  Payload: object | undefined\n  Query: FormQuery\n}\n\nexport interface FormRequestPayloadRefs extends FormRequestRefs {\n  Payload: FormPayload\n}\n\nexport type FormRequest = Request<FormRequestRefs>\nexport type FormRequestPayload = Request<FormRequestPayloadRefs>\nexport type FormResponseToolkit = Pick<\n  ResponseToolkit,\n  'redirect' | 'view' | 'continue'\n>\n\nexport enum FormAction {\n  Continue = 'continue',\n  Validate = 'validate',\n  Delete = 'delete',\n  AddAnother = 'add-another',\n  Send = 'send',\n  SaveAndExit = 'save-and-exit'\n}\n\nexport enum FormStatus {\n  Draft = 'draft',\n  Live = 'live'\n}\n"],"mappings":"AA4CA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAStB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FormAction","FormStatus","ExternalActions"],"sources":["../../../src/server/routes/types.ts"],"sourcesContent":["import {\n  type ReqRefDefaults,\n  type Request,\n  type ResponseToolkit\n} from '@hapi/hapi'\n\nimport { type FormPayload } from '~/src/server/plugins/engine/types.js'\n\nexport interface FormQuery extends Partial<Record<string, string>> {\n  /**\n   * Allow preview URL direct access without relevant page checks\n   */\n  force?: string\n\n  /**\n   * Redirect location after 'continue' form action\n   */\n  returnUrl?: string\n}\n\nexport interface FormParams extends Partial<Record<string, string>> {\n  path: string\n  slug: string\n  state?: FormStatus\n}\n\nexport interface FormRequestRefs\n  extends Omit<ReqRefDefaults, 'Params' | 'Payload' | 'Query'> {\n  Params: FormParams\n  Payload: object | undefined\n  Query: FormQuery\n}\n\nexport interface FormRequestPayloadRefs extends FormRequestRefs {\n  Payload: FormPayload\n}\n\nexport type FormRequest = Request<FormRequestRefs>\nexport type FormRequestPayload = Request<FormRequestPayloadRefs>\nexport type FormResponseToolkit = Pick<\n  ResponseToolkit,\n  'redirect' | 'view' | 'continue'\n>\n\nexport enum FormAction {\n  Continue = 'continue',\n  Validate = 'validate',\n  Delete = 'delete',\n  AddAnother = 'add-another',\n  Send = 'send',\n  SaveAndExit = 'save-and-exit',\n  External = 'external'\n}\n\nexport enum FormStatus {\n  Draft = 'draft',\n  Live = 'live'\n}\n\nexport enum ExternalActions {\n  PostcodeLookup = 'postcode-lookup',\n  AnotherExternalAction = 'another-external-action'\n}\n"],"mappings":"AA4CA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAUtB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AAKtB,WAAYC,eAAe,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA","ignoreList":[]}

package/.server/server/schemas/index.js

@@ -1,7 +1,7 @@
 import Joi from 'joi';
 import { FormAction, FormStatus } from "../routes/types.js";
 export const stateSchema = Joi.string().valid(FormStatus.Draft, FormStatus.Live).required();
-export const actionSchema = Joi.string().valid(FormAction.Continue, FormAction.Validate, FormAction.Delete, FormAction.AddAnother, FormAction.Send, FormAction.SaveAndExit).default(FormAction.Validate).optional();
+export const actionSchema = Joi.string().pattern(new RegExp(`^${FormAction.External}-[a-zA-Z-:]*$`)).allow(...Object.values(FormAction).filter(value => value !== FormAction.External)).default(FormAction.Validate).optional();
 export const pathSchema = Joi.string().required();
 export const itemIdSchema = Joi.string().uuid().required();
 export const crumbSchema = Joi.string().optional().allow('');

package/.server/server/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","Continue","Validate","Delete","AddAnother","Send","SaveAndExit","default","optional","pathSchema","itemIdSchema","uuid","crumbSchema","allow","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .valid(\n    FormAction.Continue,\n    FormAction.Validate,\n    FormAction.Delete,\n    FormAction.AddAnother,\n    FormAction.Send,\n    FormAction.SaveAndExit\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormPayloadParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDC,KAAK,CACJJ,UAAU,CAACS,QAAQ,EACnBT,UAAU,CAACU,QAAQ,EACnBV,UAAU,CAACW,MAAM,EACjBX,UAAU,CAACY,UAAU,EACrBZ,UAAU,CAACa,IAAI,EACfb,UAAU,CAACc,WACb,CAAC,CACAC,OAAO,CAACf,UAAU,CAACU,QAAQ,CAAC,CAC5BM,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGlB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMW,YAAY,GAAGnB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACgB,IAAI,CAAC,CAAC,CAACZ,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMa,WAAW,GAAGrB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACa,QAAQ,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMC,aAAa,GAAGvB,GAAG,CAACwB,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAG1B,GAAG,CAAC2B,MAAM,CAAoB,CAAC,CACxDC,IAAI,CAAC;EACJC,MAAM,EAAEpB,YAAY;EACpBqB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAEV,WAAW;EAClBW,MAAM,EAAEb,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDD,OAAO,CAAC,CAAC,CAAC,CAAC,CACXC,QAAQ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","pattern","RegExp","External","allow","Object","values","filter","value","default","Validate","optional","pathSchema","itemIdSchema","uuid","crumbSchema","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .pattern(new RegExp(`^${FormAction.External}-[a-zA-Z-:]*$`))\n  .allow(\n    ...Object.values(FormAction).filter(\n      (value) => value !== FormAction.External\n    )\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormPayloadParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDM,OAAO,CAAC,IAAIC,MAAM,CAAC,IAAIV,UAAU,CAACW,QAAQ,eAAe,CAAC,CAAC,CAC3DC,KAAK,CACJ,GAAGC,MAAM,CAACC,MAAM,CAACd,UAAU,CAAC,CAACe,MAAM,CAChCC,KAAK,IAAKA,KAAK,KAAKhB,UAAU,CAACW,QAClC,CACF,CAAC,CACAM,OAAO,CAACjB,UAAU,CAACkB,QAAQ,CAAC,CAC5BC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGrB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMc,YAAY,GAAGtB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACmB,IAAI,CAAC,CAAC,CAACf,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMgB,WAAW,GAAGxB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACgB,QAAQ,CAAC,CAAC,CAACP,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMY,aAAa,GAAGzB,GAAG,CAAC0B,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAG5B,GAAG,CAAC6B,MAAM,CAAoB,CAAC,CACxDC,IAAI,CAAC;EACJC,MAAM,EAAEtB,YAAY;EACpBuB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAET,WAAW;EAClBU,MAAM,EAAEZ,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDF,OAAO,CAAC,CAAC,CAAC,CAAC,CACXE,QAAQ,CAAC,CAAC","ignoreList":[]}

package/.server/server/types.d.ts

@@ -32,6 +32,7 @@ export interface RouteConfig {
     onRequest?: OnRequestCallback;
     saveAndExit?: PluginOptions['saveAndExit'];
     cacheServiceCreator?: (server: Server) => CacheService;
+    ordnanceSurveyApiKey?: string;
 }
 export interface OutputService {
     submit: (context: FormContext, request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload, formMetadata?: FormMetadata) => Promise<void>;

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.559",
+    "@defra/forms-model": "^3.0.560",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

package/src/client/stylesheets/shared.scss

@@ -9,3 +9,18 @@
 .autocomplete__option {
   @include govuk-typography-common;
 }
+
+.app-hidden {
+  display: none;
+  visibility: hidden;
+}
+
+// Used in postcode lookup
+.govuk-button--link {
+  @extend %govuk-link;
+  color: $govuk-link-colour;
+  border: none;
+  cursor: pointer;
+  background-color: transparent;
+  @include govuk-font($size: 19);
+}

package/src/config/index.ts

@@ -252,7 +252,15 @@ export const config = convict({
     format: String,
     default: '',
     env: 'SUBMISSION_EMAIL_ADDRESS'
-  } as SchemaObj<string>
+  } as SchemaObj<string>,
+
+  ordnanceSurveyApiKey: {
+    doc: 'The ordnance survey api key use by the postcode lookup plugin',
+    format: String,
+    nullable: true,
+    default: undefined,
+    env: 'ORDNANCE_SURVEY_API_KEY'
+  } as SchemaObj<string | undefined>
 })
 
 config.validate({ allowed: 'strict' })

package/src/index.ts

@@ -13,19 +13,20 @@ process.on('unhandledRejection', (error) => {
   throw error
 })
 
+const port = config.get('port')
+const ordnanceSurveyApiKey = config.get('ordnanceSurveyApiKey')
+
 /**
  * Main entrypoint to the application.
  */
 async function startServer() {
-  const server = await createServer()
+  const server = await createServer({ ordnanceSurveyApiKey })
   await server.start()
 
   process.send?.('online')
 
   server.logger.info('Server started successfully')
-  server.logger.info(
-    `Access your frontend on http://localhost:${config.get('port')}`
-  )
+  server.logger.info(`Access your frontend on http://localhost:${port}`)
 }
 
 startServer().catch((error: unknown) => {

package/src/server/constants.js

@@ -1,2 +1,4 @@
 export const PREVIEW_PATH_PREFIX = '/preview'
 export const FORM_PREFIX = ''
+export const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'
+export const EXTERNAL_STATE_APPENDAGE = 'EXTERNAL_STATE_APPENDAGE'

package/src/server/forms/components.json

@@ -120,6 +120,13 @@
           "content": "### This is a H3 in markdown\n\n[An internal link](http://localhost:3009/fictional-page)\n\n[An external link](https://defra.gov.uk/fictional-page)",
           "options": {},
           "schema": {}
+        },
+        {
+          "title": "Summary",
+          "path": "/summary",
+          "controller": "SummaryPageController",
+          "components": [],
+          "next": []
         }
       ]
     }