@defra/forms-engine-plugin 3.0.0 → 3.0.2

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

@@ -156,5 +156,45 @@ describe('Schema validation', () => {
         formAdapterSubmissionMessagePayloadSchema.validate(payloadWithoutData)
       expect(error).toBeDefined()
     })
+
+    it('should validate payload with versionMetadata', () => {
+      const payloadWithVersion = {
+        ...validPayload,
+        meta: {
+          ...validPayload.meta,
+          versionMetadata: {
+            versionNumber: 19,
+            createdAt: new Date('2025-09-08T09:28:15.576Z')
+          }
+        }
+      }
+      const { error } =
+        formAdapterSubmissionMessagePayloadSchema.validate(payloadWithVersion)
+      expect(error).toBeUndefined()
+    })
+
+    it('should validate payload without versionMetadata', () => {
+      const { error } =
+        formAdapterSubmissionMessagePayloadSchema.validate(validPayload)
+      expect(error).toBeUndefined()
+    })
+
+    it('should reject invalid versionMetadata', () => {
+      const payloadWithInvalidVersion = {
+        ...validPayload,
+        meta: {
+          ...validPayload.meta,
+          versionMetadata: {
+            versionNumber: 'not-a-number', // Invalid - should be number
+            createdAt: new Date('2025-09-08T09:28:15.576Z')
+          }
+        }
+      }
+      const { error } = formAdapterSubmissionMessagePayloadSchema.validate(
+        payloadWithInvalidVersion
+      )
+      expect(error).toBeDefined()
+      expect(error?.message).toContain('must be a number')
+    })
   })
 })

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

@@ -1,5 +1,6 @@
 import {
   FormStatus,
+  formVersionMetadataSchema,
   idSchema,
   notificationEmailAddressSchema,
   slugSchema,
@@ -29,7 +30,8 @@ export const formAdapterSubmissionMessageMetaSchema =
       .valid(...Object.values(FormStatus))
       .required(),
     isPreview: Joi.boolean().required(),
-    notificationEmail: notificationEmailAddressSchema.required()
+    notificationEmail: notificationEmailAddressSchema.required(),
+    versionMetadata: formVersionMetadataSchema.optional()
   })
 
 export const formAdapterSubmissionMessageDataSchema =

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

@@ -3,6 +3,7 @@ import {
   type Event,
   type FormDefinition,
   type FormMetadata,
+  type FormVersionMetadata,
   type Item,
   type List,
   type Page
@@ -179,6 +180,7 @@ export interface FormContext {
   pageMap: Map<string, PageControllerClass>
   componentMap: Map<string, Component>
   referenceNumber: string
+  submittedVersionNumber?: number
 }
 
 export type FormContextRequest = (
@@ -327,6 +329,7 @@ export interface RepeaterSummaryPageViewModel extends PageViewModelBase {
   errors?: FormSubmissionError[]
   checkAnswers: CheckAnswers[]
   repeatTitle: string
+  allowSaveAndExit: boolean
 }
 
 export interface FeaturedFormPageViewModel extends FormPageViewModel {
@@ -405,6 +408,7 @@ export interface FormAdapterSubmissionMessageMeta {
   status: FormStatus
   isPreview: boolean
   notificationEmail: string
+  versionMetadata?: FormVersionMetadata
 }
 
 export type FormAdapterSubmissionMessageMetaSerialised = Omit<

package/src/server/plugins/engine/views/repeat-list-summary.html

@@ -24,10 +24,10 @@
         {{ govukSummaryList(section.summaryList) }}
       {% endfor %}
 
-      <div class="govuk-button-group">
-        <form method="post" novalidate>
-          <input type="hidden" name="crumb" value="{{ crumb }}">
+      <form method="post" novalidate>
+        <input type="hidden" name="crumb" value="{{ crumb }}">
 
+        <div class="govuk-button-group">
           {{ govukButton({
             text: "Continue",
             name: "action",
@@ -42,8 +42,18 @@
             classes: "govuk-button--secondary",
             preventDoubleClick: true
           }) }}
-        </form>
-      </div>
+
+          {% if allowSaveAndExit %}
+            {{ govukButton({
+              text: "Save and exit",
+              classes: "govuk-button--secondary",
+              name: "action",
+              value: "save-and-exit",
+              preventDoubleClick: true
+            }) }}
+          {% endif %}
+        </div>
+      </form>
     </div>
   </div>