@defra/forms-engine-plugin 4.2.0 → 4.4.0

package/src/server/plugins/engine/routes/index.ts

@@ -23,6 +23,10 @@ import {
   proceed
 } from '~/src/server/plugins/engine/helpers.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
+import {
+  checkSaveAndExitRepeater,
+  copyNotYetValidatedState
+} from '~/src/server/plugins/engine/pageControllers/helpers/state.js'
 import { generateUniqueReference } from '~/src/server/plugins/engine/referenceNumbers.js'
 import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
 import {
@@ -78,6 +82,9 @@ export async function redirectOrMakeHandler(
 
   const flash = cacheService.getFlash(request)
   const context = model.getFormContext(request, state, flash?.errors)
+
+  await copyNotYetValidatedState(request, context)
+
   const relevantPath = page.getRelevantPath(request, context)
   const summaryPath = page.getSummaryPath()
 
@@ -89,6 +96,12 @@ export async function redirectOrMakeHandler(
     }
   }
 
+  // Check whether save-and-exit should resume from within a repeater
+  const resumeInRepeaterUrl = checkSaveAndExitRepeater(context, model)
+  if (resumeInRepeaterUrl) {
+    return proceed(request, h, resumeInRepeaterUrl)
+  }
+
   // Return handler for relevant pages or preview URL direct access
   if (relevantPath.startsWith(page.path) || context.isForceAccess) {
     return makeHandler(page, context)
@@ -96,7 +109,6 @@ export async function redirectOrMakeHandler(
 
   // Redirect back to last relevant page
   const redirectTo = findPage(model, relevantPath)
-
   // Set the return URL unless an exit page
   if (redirectTo?.next.length) {
     request.query.returnUrl = page.getHref(summaryPath)

package/src/server/plugins/engine/types.ts

@@ -94,8 +94,10 @@ export type FormSubmissionState = {
   upload?: Record<string, TempFileState>
 } & FormState
 
-export interface FormSubmissionError
-  extends Pick<ValidationErrorItem, 'context' | 'path'> {
+export interface FormSubmissionError extends Pick<
+  ValidationErrorItem,
+  'context' | 'path'
+> {
   href: string // e.g: '#dateField__day'
   name: string // e.g: 'dateField__day'
   text: string // e.g: 'Date field must be a real date'
@@ -125,6 +127,7 @@ export type FormValue =
   | Item['value'][]
   | UploadState
   | RepeatListState
+  | GeospatialState
   | undefined
 
 export type FormState = Partial<Record<string, FormStateValue>>
@@ -285,6 +288,76 @@ export interface RepeatItemState extends FormPayload {
 
 export type RepeatListState = RepeatItemState[]
 
+/**
+ * A longitude/latitude coordinate pair in WGS84 format
+ * Format: [longitude, latitude]
+ */
+export type Coordinates = [longitude: number, latitude: number]
+
+/**
+ * GeoJSON Point geometry
+ */
+export interface PointGeometry {
+  type: 'Point'
+  coordinates: Coordinates
+}
+
+/**
+ * GeoJSON LineString geometry
+ */
+export interface LineStringGeometry {
+  type: 'LineString'
+  coordinates: Coordinates[]
+}
+
+/**
+ * GeoJSON Polygon geometry
+ */
+export interface PolygonGeometry {
+  type: 'Polygon'
+  coordinates: Coordinates[][]
+}
+
+/**
+ * Supported geometry types
+ */
+export type Geometry = PointGeometry | LineStringGeometry | PolygonGeometry
+
+/**
+ * Feature metadata
+ */
+export interface FeatureProperties {
+  /**
+   * Human-readable description of the feature
+   */
+  description: string
+  /**
+   * The OS grid reference of the first coordinate of the feature
+   */
+  coordinateGridReference?: string
+  /**
+   * The OS grid reference of the centroid of the feature
+   */
+  centroidGridReference?: string
+}
+
+/**
+ * A single GeoJSON Feature
+ */
+export interface Feature {
+  id: string
+  type: 'Feature'
+  properties: FeatureProperties
+  geometry: Geometry
+}
+
+/**
+ * A GeoJSON FeatureCollection
+ */
+export type FeatureCollection = Feature[]
+
+export type GeospatialState = FeatureCollection
+
 export interface CheckAnswers {
   title?: ComponentText
   summaryList: SummaryList
@@ -502,6 +575,7 @@ export type RichFormValue =
   | UkAddressState
   | EastingNorthingState
   | LatLongState
+  | GeospatialState
 
 export interface FormAdapterSubmissionMessageData {
   main: Record<string, RichFormValue | null>
@@ -516,8 +590,7 @@ export interface FormAdapterSubmissionMessagePayload {
   result: FormAdapterSubmissionMessageResult
 }
 
-export interface FormAdapterSubmissionMessage
-  extends FormAdapterSubmissionMessagePayload {
+export interface FormAdapterSubmissionMessage extends FormAdapterSubmissionMessagePayload {
   messageId: string
   recordCreatedAt: Date
 }

package/src/server/plugins/engine/views/components/geospatialfield.html

@@ -0,0 +1,7 @@
+{% from "govuk/components/textarea/macro.njk" import govukTextarea %}
+
+{% macro GeospatialField(component) %}
+  <div class="app-geospatial-field">
+    {{ govukTextarea(component.model) }}
+  </div>
+{% endmacro %}

package/src/server/plugins/nunjucks/context.test.js

@@ -33,9 +33,8 @@ describe('Nunjucks context', () => {
         const { config } = await import('~/src/config/index.js')
 
         // Import when isolated to avoid cache
-        const { devtoolContext } = await import(
-          '~/src/server/plugins/nunjucks/context.js'
-        )
+        const { devtoolContext } =
+          await import('~/src/server/plugins/nunjucks/context.js')
 
         // Update config for missing manifest
         config.set('publicDir', tmpdir())

package/src/server/routes/types.ts

@@ -24,8 +24,10 @@ export interface FormParams extends Partial<Record<string, string>> {
   state?: FormStatus
 }
 
-export interface FormRequestRefs
-  extends Omit<ReqRefDefaults, 'Params' | 'Payload' | 'Query'> {
+export interface FormRequestRefs extends Omit<
+  ReqRefDefaults,
+  'Params' | 'Payload' | 'Query'
+> {
   Params: FormParams
   Payload: object | undefined
   Query: FormQuery

package/src/server/services/cacheService.ts

@@ -147,7 +147,9 @@ export class CacheService {
       throw new Error('No session ID found')
     }
 
+    // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
     const state = (request.params.state as string) || ''
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
     const slug = (request.params.slug as string) || ''
     const key = `${request.yar.id}:${state}:${slug}:`