@defra/forms-engine-plugin 2.1.6 → 2.1.8

package/src/server/plugins/engine/components/FormComponent.ts

@@ -157,17 +157,21 @@ export class FormComponent extends ComponentBase {
     }
   }
 
-  getDisplayStringFromState(state: FormSubmissionState): string {
-    const value = this.getFormValueFromState(state)
+  getDisplayStringFromFormValue(value: FormValue | FormPayload): string {
+    // Map selected values to text
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
     return this.isValue(value) ? value.toString() : ''
   }
 
-  getContextValueFromState(
-    state: FormSubmissionState
-  ): Item['value'] | Item['value'][] | null {
+  getDisplayStringFromState(state: FormSubmissionState): string {
     const value = this.getFormValueFromState(state)
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    return this.getDisplayStringFromFormValue(value)
+  }
 
+  getContextValueFromFormValue(
+    value: FormValue | FormPayload
+  ): Item['value'] | Item['value'][] | null {
     // Filter object field values
     if (this.isState(value)) {
       const values = Object.values(value).filter(isFormValue)
@@ -182,6 +186,14 @@ export class FormComponent extends ComponentBase {
     return this.isValue(value) ? value : null
   }
 
+  getContextValueFromState(
+    state: FormSubmissionState
+  ): Item['value'] | Item['value'][] | null {
+    const value = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(value)
+  }
+
   isValue(
     value?: FormStateValue | FormState
   ): value is NonNullable<FormStateValue> {

package/src/server/plugins/engine/components/ListFormComponent.ts

@@ -99,11 +99,11 @@ export class ListFormComponent extends FormComponent {
     return selected.at(0)?.value
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
+  getDisplayStringFromFormValue(
+    value: string | number | boolean | Item['value'][] | undefined
+  ): string {
     const { items } = this
 
-    // Allow for array values via subclass
-    const value = this.getFormValueFromState(state)
     const values = [value ?? []].flat()
 
     return items
@@ -112,6 +112,13 @@ export class ListFormComponent extends FormComponent {
       .join(', ')
   }
 
+  getDisplayStringFromState(state: FormSubmissionState) {
+    // Allow for array values via subclass
+    const value = this.getFormValueFromState(state)
+
+    return this.getDisplayStringFromFormValue(value)
+  }
+
   getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
     const { items: listItems } = this
 

package/src/server/plugins/engine/components/MonthYearField.ts

@@ -103,9 +103,7 @@ export class MonthYearField extends FormComponent {
     return MonthYearField.isMonthYear(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    const value = this.getFormValueFromState(state)
-
+  getDisplayStringFromFormValue(value: MonthYearState | undefined): string {
     if (!value) {
       return ''
     }
@@ -117,9 +115,15 @@ export class MonthYearField extends FormComponent {
     return `${monthString} ${value.year}`
   }
 
-  getContextValueFromState(state: FormSubmissionState) {
+  getDisplayStringFromState(state: FormSubmissionState) {
     const value = this.getFormValueFromState(state)
 
+    return this.getDisplayStringFromFormValue(value)
+  }
+
+  getContextValueFromFormValue(
+    value: MonthYearState | undefined
+  ): string | null {
     if (
       !value ||
       !isValid(
@@ -137,6 +141,12 @@ export class MonthYearField extends FormComponent {
     return format(`${value.year}-${value.month}-01`, 'yyyy-MM')
   }
 
+  getContextValueFromState(state: FormSubmissionState) {
+    const value = this.getFormValueFromState(state)
+
+    return this.getContextValueFromFormValue(value)
+  }
+
   getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {
     const { collection, name } = this
 

package/src/server/plugins/engine/components/UkAddressField.ts

@@ -110,18 +110,28 @@ export class UkAddressField extends FormComponent {
     return this.isState(value) ? value : undefined
   }
 
-  getDisplayStringFromState(state: FormSubmissionState) {
-    return this.getContextValueFromState(state)?.join(', ') ?? ''
+  getContextValueFromFormValue(value: UkAddressState | undefined) {
+    if (!value) {
+      return null
+    }
+
+    return Object.values(value).filter(Boolean)
   }
 
   getContextValueFromState(state: FormSubmissionState) {
     const value = this.getFormValueFromState(state)
 
-    if (!value) {
-      return null
-    }
+    return this.getContextValueFromFormValue(value)
+  }
 
-    return Object.values(value).filter(Boolean)
+  getDisplayStringFromFormValue(value: UkAddressState | undefined): string {
+    return this.getContextValueFromFormValue(value)?.join(', ') ?? ''
+  }
+
+  getDisplayStringFromState(state: FormSubmissionState) {
+    const value = this.getFormValueFromState(state)
+
+    return this.getDisplayStringFromFormValue(value)
   }
 
   /**

package/src/server/plugins/engine/outputFormatters/adapter/v1.test.ts

@@ -10,9 +10,9 @@ import {
 } from '~/src/server/plugins/engine/models/types.js'
 import { format } from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js'
 import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
+import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/index.js'
 import {
   FileStatus,
-  FormAdapterSubmissionSchemaVersion,
   UploadStatus,
   type FileState,
   type FormAdapterSubmissionMessagePayload

package/src/server/plugins/engine/outputFormatters/adapter/v1.ts

@@ -7,8 +7,8 @@ import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { format as machineV2 } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
+import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
 import {
-  FormAdapterSubmissionSchemaVersion,
   type FormAdapterSubmissionMessageData,
   type FormAdapterSubmissionMessagePayload,
   type FormContext

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

@@ -0,0 +1,15 @@
+export enum UploadStatus {
+  initiated = 'initiated',
+  pending = 'pending',
+  ready = 'ready'
+}
+
+export enum FileStatus {
+  complete = 'complete',
+  rejected = 'rejected',
+  pending = 'pending'
+}
+
+export enum FormAdapterSubmissionSchemaVersion {
+  V1 = 1
+}

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

@@ -41,11 +41,7 @@ export type {
   UploadStatusResponse
 } from '~/src/server/plugins/engine/types.js'
 
-export {
-  FileStatus,
-  FormAdapterSubmissionSchemaVersion,
-  UploadStatus
-} from '~/src/server/plugins/engine/types.js'
+export { FileStatus, UploadStatus } from '~/src/server/plugins/engine/types.js'
 
 export type {
   Detail,
@@ -94,3 +90,4 @@ export type {
 export type { RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
 
 export * from '~/src/server/plugins/engine/types/schema.js'
+export { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'

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

@@ -1,12 +1,12 @@
 import { FormStatus } from '@defra/forms-model'
 
+import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
 import {
   formAdapterSubmissionMessageDataSchema,
   formAdapterSubmissionMessageMetaSchema,
   formAdapterSubmissionMessagePayloadSchema
 } from '~/src/server/plugins/engine/types/schema.js'
 import {
-  FormAdapterSubmissionSchemaVersion,
   type FormAdapterSubmissionMessageData,
   type FormAdapterSubmissionMessageMeta,
   type FormAdapterSubmissionMessagePayload

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

@@ -7,8 +7,8 @@ import {
 } from '@defra/forms-model'
 import Joi from 'joi'
 
+import { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'
 import {
-  FormAdapterSubmissionSchemaVersion,
   type FormAdapterSubmissionMessageData,
   type FormAdapterSubmissionMessageMeta,
   type FormAdapterSubmissionMessagePayload

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

@@ -21,6 +21,11 @@ import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
 import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
+import {
+  type FileStatus,
+  type FormAdapterSubmissionSchemaVersion,
+  type UploadStatus
+} from '~/src/server/plugins/engine/types/enums.js'
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
 import {
   type FormAction,
@@ -190,17 +195,10 @@ export interface UploadInitiateResponse {
   statusUrl: string
 }
 
-export enum UploadStatus {
-  initiated = 'initiated',
-  pending = 'pending',
-  ready = 'ready'
-}
-
-export enum FileStatus {
-  complete = 'complete',
-  rejected = 'rejected',
-  pending = 'pending'
-}
+export {
+  FileStatus,
+  UploadStatus
+} from '~/src/server/plugins/engine/types/enums.js'
 
 export type UploadState = FileState[]
 
@@ -414,10 +412,6 @@ export interface FormAdapterSubmissionMessageData {
   files: Record<string, Record<string, string>[]>
 }
 
-export enum FormAdapterSubmissionSchemaVersion {
-  V1 = 1
-}
-
 export interface FormAdapterSubmissionMessagePayload {
   meta: FormAdapterSubmissionMessageMeta
   data: FormAdapterSubmissionMessageData