@defra/forms-engine-plugin 4.0.33 → 4.0.35

package/src/server/plugins/engine/pageControllers/helpers/state.ts

@@ -1,9 +1,17 @@
 import { getHiddenFields } from '@defra/forms-model'
 
+import {
+  CURRENT_PAGE_PATH_KEY,
+  STATE_NOT_YET_VALIDATED
+} from '~/src/server/plugins/engine/index.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
   type AnyFormRequest,
-  type FormStateValue
+  type FormContext,
+  type FormContextRequest,
+  type FormStateValue,
+  type FormSubmissionState,
+  type FormValue
 } from '~/src/server/plugins/engine/types.js'
 import { type FormQuery } from '~/src/server/routes/types.js'
 import { type Services } from '~/src/server/types.js'
@@ -91,3 +99,44 @@ export async function prefillStateFromQueryParameters(
 
   return true
 }
+
+/**
+ * Copies any potentially invalid state into the payload, and removes those values from state
+ * NOTE - this method has a side-effect on 'context.state' and 'context.payload'
+ * @param request - the form request
+ * @param context - the form context
+ */
+export function copyNotYetValidatedState(
+  request: FormContextRequest,
+  context: FormContext
+) {
+  const potentiallyInvalidState = context.state[STATE_NOT_YET_VALIDATED] as
+    | Record<string, FormValue>
+    | undefined
+  if (!potentiallyInvalidState) {
+    return
+  }
+
+  const originalPath = potentiallyInvalidState[CURRENT_PAGE_PATH_KEY]
+
+  if (originalPath && originalPath === request.url.pathname) {
+    context.payload = {
+      ...context.payload,
+      ...potentiallyInvalidState,
+      [CURRENT_PAGE_PATH_KEY]: undefined
+    }
+  }
+}
+
+/**
+ * Remove any temporary 'not yet validated' state now that it's been validated
+ * @param state - the form state
+ */
+export function clearNotYetValidatedState(
+  state: FormSubmissionState
+): FormSubmissionState {
+  if (state[STATE_NOT_YET_VALIDATED]) {
+    state[STATE_NOT_YET_VALIDATED] = undefined
+  }
+  return state
+}

package/src/server/plugins/engine/services/localFormsService.js

@@ -51,5 +51,12 @@ export const formsService = async () => {
     slug: 'components'
   })
 
+  await loader.addForm('src/server/forms/simple-form.yaml', {
+    ...metadata,
+    id: 'a1b2c3d4-e5f6-7890-abcd-ef0123456789',
+    title: 'Simple Form',
+    slug: 'simple-form'
+  })
+
   return loader.toFormsService()
 }

package/src/server/plugins/engine/views/index.html

@@ -10,7 +10,7 @@
         {% include "partials/preview-banner.html" %}
       {% endif %}
 
-      {% if errors %}
+      {% if errors | length  %}
         {{ govukErrorSummary({
           titleText: "There is a problem",
           errorList: checkErrorTemplates(errors)

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

@@ -87,7 +87,11 @@ describe('Nunjucks context', () => {
             }
           },
           path: '/test',
-          url: { search: '' }
+          url: { search: '' },
+          yar: {
+            flash: jest.fn().mockReturnValue([]),
+            commit: jest.fn()
+          }
           // state intentionally omitted to test real malformed requests
         })
       )
@@ -121,7 +125,11 @@ describe('Nunjucks context', () => {
           },
           path: '/test',
           url: { search: '' },
-          state: {}
+          state: {},
+          yar: {
+            flash: jest.fn().mockReturnValue([]),
+            commit: jest.fn()
+          }
         })
       )
 

package/src/server/plugins/nunjucks/types.js

@@ -17,6 +17,7 @@
  * @property {string} [currentPath] - Current path
  * @property {string} [previewMode] - Preview mode
  * @property {string} [slug] - Form slug
+ * @property {string} [error] - Error message for temporary error messages (not related to form state)
  * @property {FormContext} [context] - the current form context
  */
 

package/src/server/services/cacheService.ts

@@ -99,6 +99,22 @@ export class CacheService {
     request.yar.flash(key.id, message)
   }
 
+  async resetComponentStates(
+    request: AnyFormRequest,
+    componentNames: string[]
+  ) {
+    const state = await this.getState(request)
+
+    for (const componentName of componentNames) {
+      if (componentName in state) {
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete state[componentName]
+      }
+    }
+
+    return this.setState(request, state)
+  }
+
   /**
    * The key used to store user session data against.
    * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`

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

@@ -5,6 +5,7 @@ import { type ServerYar, type Yar } from '@hapi/yar'
 import { type Logger } from 'pino'
 
 import {
+  type COMPONENT_STATE_ERROR,
   type EXTERNAL_STATE_APPENDAGE,
   type EXTERNAL_STATE_PAYLOAD
 } from '~/src/server/constants.js'
@@ -20,6 +21,7 @@ declare module '@hapi/yar' {
   interface YarFlashes {
     [EXTERNAL_STATE_APPENDAGE]: object
     [EXTERNAL_STATE_PAYLOAD]: object
+    [COMPONENT_STATE_ERROR]: string
     [key: string]: { errors: FormSubmissionError[] }
   }
 }