@defra/forms-engine-plugin 4.0.6 → 4.0.8

package/.server/client/stylesheets/_location-input.scss

@@ -0,0 +1,60 @@
+@use "govuk-frontend" as *;
+
+.app-location-input {
+  @include govuk-clearfix;
+  font-size: 0; // removes whitespace caused by inline-block
+  margin-bottom: govuk-spacing(6);
+
+  &:has(.govuk-input--error) {
+    border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+    padding-left: govuk-spacing(3);
+    margin-top: 0;
+  }
+}
+
+.govuk-hint:has(+ .app-location-input .govuk-input--error) {
+  border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+  padding-left: govuk-spacing(3);
+  margin-bottom: 0;
+}
+
+.govuk-fieldset:has(.app-location-input .govuk-input--error) {
+  .govuk-fieldset__legend {
+    border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+    padding-left: govuk-spacing(3);
+    margin-bottom: 0;
+  }
+
+  .govuk-fieldset__legend + .govuk-hint {
+    margin-top: 0;
+  }
+}
+
+.app-location-input__item {
+  display: inline-block;
+  margin-right: govuk-spacing(4);
+  margin-bottom: govuk-spacing(4);
+
+  &:last-child {
+    margin-right: 0;
+  }
+
+  @include govuk-media-query($from: tablet) {
+    margin-bottom: 0;
+  }
+
+  .govuk-form-group {
+    margin-bottom: 0;
+    display: inline-block;
+    width: auto;
+  }
+
+  .govuk-label {
+    display: block;
+  }
+
+  .govuk-input {
+    margin-bottom: 0;
+    width: auto;
+  }
+}

package/.server/client/stylesheets/application.scss

@@ -2,6 +2,7 @@
 @use "shared";
 @use "code";
 @use "tag-env";
+@use "location-input";
 
 //  An example of some user-supplied styling
 //  Not great practice but it illustrates the point

package/.server/client/stylesheets/shared.scss

@@ -2,6 +2,7 @@
 @use "pkg:accessible-autocomplete";
 @use "prose";
 @use "summary-list";
+@use "location-input";
 
 // Use default GDS Transport font for autocomplete
 .autocomplete__hint,

package/.server/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": {}
+        },
+        {
+          "type": "DeclarationField",
+          "name": "declaration",
+          "title": "Declaration",
+          "content": "By submitting this form, I agree to:\n\n- Provide accurate and complete information\n- Comply with all applicable regulations\n- Accept responsibility for any false statements",
+          "hint": "Please read and confirm the following terms"
         }
       ]
     },

package/.server/server/forms/register-as-a-unicorn-breeder.yaml

@@ -163,6 +163,34 @@ pages:
     next:
       - path: '/how-many-members-of-staff-will-look-after-the-unicorns'
     components:
+      - name: dfGYuk
+        options: {}
+        schema: {}
+        type: EastingNorthingField
+        title: Easting and northing
+        hint:
+          This is an Easting and Northing component
+      - name: seTThb
+        options: {}
+        schema: {}
+        type: LatLongField
+        title: Latitute and longitude
+        hint:
+          This is an Latitute and Longitude component
+      - name: bhjloS
+        options: {}
+        schema: {}
+        type: NationalGridFieldNumberField
+        title: National grid field number
+        hint:
+          This is an National Grid Field Number component
+      - name: dfQQws
+        options: {}
+        schema: {}
+        type: OsGridRefField
+        title: Ordnance survey grid reference
+        hint:
+          This is an Ordnance survey Grid Reference component
       - name: bClCvo
         options: {}
         schema: {}
@@ -191,7 +219,7 @@ pages:
     controller: FileUploadPageController
     section: Regnsa
     next:
-      - path: '/how-many-unicorns-do-you-expect-to-breed-each-year'
+      - path: '/declaration'
     components:
       - name: dLzALM
         title: Documents
@@ -202,6 +230,17 @@ pages:
         schema:
           min: 1
           max: 3
+  - title: Declaration
+    path: '/declaration'
+    section: section
+    components:
+      - name: diLmal
+        title: Declaration
+        type: DeclarationField
+        content: 'Fill in this field'
+        options: {}
+    next:
+      - path: '/summary'
 conditions:
   - displayName: Address is different
     name: IrVmYz

package/.server/server/plugins/engine/components/ComponentBase.d.ts

@@ -13,7 +13,7 @@ export declare class ComponentBase {
     name: ComponentDef['name'];
     title: ComponentDef['title'];
     schema?: Extract<ComponentDef, {
-        schema: object;
+        schema?: object;
     }>['schema'];
     options?: Extract<ComponentDef, {
         options: object;
@@ -30,4 +30,4 @@ export declare class ComponentBase {
     });
     get viewModel(): ViewModel;
 }
-export type ComponentSchema = ArraySchema<string> | ArraySchema<number> | ArraySchema<boolean> | ArraySchema<object> | BooleanSchema<string> | DateSchema | NumberSchema<string> | NumberSchema | ObjectSchema | StringSchema;
+export type ComponentSchema = ArraySchema<string> | ArraySchema<number> | ArraySchema<boolean> | ArraySchema<object> | BooleanSchema<string> | BooleanSchema | DateSchema | NumberSchema<string> | NumberSchema | ObjectSchema | StringSchema;

package/.server/server/plugins/engine/components/ComponentBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComponentBase.js","names":["isConditionalRevealType","joi","ComponentBase","page","parent","collection","type","name","title","schema","options","isFormComponent","model","formSchema","string","stateSchema","constructor","def","props","viewModel","attributes","autocomplete","classes","condition"],"sources":["../../../../../src/server/plugins/engine/components/ComponentBase.ts"],"sourcesContent":["import { isConditionalRevealType, type ComponentDef } from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type DateSchema,\n  type NumberSchema,\n  type ObjectSchema,\n  type StringSchema\n} from 'joi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type ViewModel } from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\n\nexport class ComponentBase {\n  page?: PageControllerClass\n  parent: Component | undefined\n  collection: ComponentCollection | undefined\n\n  type: ComponentDef['type']\n  name: ComponentDef['name']\n  title: ComponentDef['title']\n  schema?: Extract<ComponentDef, { schema: object }>['schema']\n  options?: Extract<ComponentDef, { options: object }>['options']\n\n  isFormComponent = false\n  model: FormModel\n\n  /** joi schemas based on a component defined in the form JSON. This validates a user's answer and is generated from {@link ComponentDef} */\n  formSchema: ComponentSchema = joi.string()\n  stateSchema: ComponentSchema = joi.string()\n\n  constructor(\n    def: ComponentDef,\n    props: {\n      page?: PageControllerClass\n      parent?: Component\n      model: FormModel\n    }\n  ) {\n    this.type = def.type\n    this.name = def.name\n    this.title = def.title\n\n    if ('schema' in def) {\n      this.schema = def.schema\n    }\n\n    if ('options' in def) {\n      this.options = def.options\n    }\n\n    this.page = props.page\n    this.parent = props.parent\n    this.model = props.model\n  }\n\n  get viewModel() {\n    const { options, type } = this\n\n    const viewModel: ViewModel = {\n      attributes: {}\n    }\n\n    if (!options) {\n      return viewModel\n    }\n\n    if ('autocomplete' in options) {\n      viewModel.attributes.autocomplete = options.autocomplete\n    }\n\n    if ('classes' in options) {\n      viewModel.classes = options.classes\n    }\n\n    if ('condition' in options && isConditionalRevealType(type)) {\n      viewModel.condition = options.condition\n    }\n\n    return viewModel\n  }\n}\n\nexport type ComponentSchema =\n  | ArraySchema<string>\n  | ArraySchema<number>\n  | ArraySchema<boolean>\n  | ArraySchema<object>\n  | BooleanSchema<string>\n  | DateSchema\n  | NumberSchema<string>\n  | NumberSchema\n  | ObjectSchema\n  | StringSchema\n"],"mappings":"AAAA,SAASA,uBAAuB,QAA2B,oBAAoB;AAC/E,OAAOC,GAAG,MAOH,KAAK;AAQZ,OAAO,MAAMC,aAAa,CAAC;EACzBC,IAAI;EACJC,MAAM;EACNC,UAAU;EAEVC,IAAI;EACJC,IAAI;EACJC,KAAK;EACLC,MAAM;EACNC,OAAO;EAEPC,eAAe,GAAG,KAAK;EACvBC,KAAK;;EAEL;EACAC,UAAU,GAAoBZ,GAAG,CAACa,MAAM,CAAC,CAAC;EAC1CC,WAAW,GAAoBd,GAAG,CAACa,MAAM,CAAC,CAAC;EAE3CE,WAAWA,CACTC,GAAiB,EACjBC,KAIC,EACD;IACA,IAAI,CAACZ,IAAI,GAAGW,GAAG,CAACX,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGU,GAAG,CAACV,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGS,GAAG,CAACT,KAAK;IAEtB,IAAI,QAAQ,IAAIS,GAAG,EAAE;MACnB,IAAI,CAACR,MAAM,GAAGQ,GAAG,CAACR,MAAM;IAC1B;IAEA,IAAI,SAAS,IAAIQ,GAAG,EAAE;MACpB,IAAI,CAACP,OAAO,GAAGO,GAAG,CAACP,OAAO;IAC5B;IAEA,IAAI,CAACP,IAAI,GAAGe,KAAK,CAACf,IAAI;IACtB,IAAI,CAACC,MAAM,GAAGc,KAAK,CAACd,MAAM;IAC1B,IAAI,CAACQ,KAAK,GAAGM,KAAK,CAACN,KAAK;EAC1B;EAEA,IAAIO,SAASA,CAAA,EAAG;IACd,MAAM;MAAET,OAAO;MAAEJ;IAAK,CAAC,GAAG,IAAI;IAE9B,MAAMa,SAAoB,GAAG;MAC3BC,UAAU,EAAE,CAAC;IACf,CAAC;IAED,IAAI,CAACV,OAAO,EAAE;MACZ,OAAOS,SAAS;IAClB;IAEA,IAAI,cAAc,IAAIT,OAAO,EAAE;MAC7BS,SAAS,CAACC,UAAU,CAACC,YAAY,GAAGX,OAAO,CAACW,YAAY;IAC1D;IAEA,IAAI,SAAS,IAAIX,OAAO,EAAE;MACxBS,SAAS,CAACG,OAAO,GAAGZ,OAAO,CAACY,OAAO;IACrC;IAEA,IAAI,WAAW,IAAIZ,OAAO,IAAIV,uBAAuB,CAACM,IAAI,CAAC,EAAE;MAC3Da,SAAS,CAACI,SAAS,GAAGb,OAAO,CAACa,SAAS;IACzC;IAEA,OAAOJ,SAAS;EAClB;AACF","ignoreList":[]}
+{"version":3,"file":"ComponentBase.js","names":["isConditionalRevealType","joi","ComponentBase","page","parent","collection","type","name","title","schema","options","isFormComponent","model","formSchema","string","stateSchema","constructor","def","props","viewModel","attributes","autocomplete","classes","condition"],"sources":["../../../../../src/server/plugins/engine/components/ComponentBase.ts"],"sourcesContent":["import { isConditionalRevealType, type ComponentDef } from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type DateSchema,\n  type NumberSchema,\n  type ObjectSchema,\n  type StringSchema\n} from 'joi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type ViewModel } from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\n\nexport class ComponentBase {\n  page?: PageControllerClass\n  parent: Component | undefined\n  collection: ComponentCollection | undefined\n\n  type: ComponentDef['type']\n  name: ComponentDef['name']\n  title: ComponentDef['title']\n  schema?: Extract<ComponentDef, { schema?: object }>['schema']\n  options?: Extract<ComponentDef, { options: object }>['options']\n\n  isFormComponent = false\n  model: FormModel\n\n  /** joi schemas based on a component defined in the form JSON. This validates a user's answer and is generated from {@link ComponentDef} */\n  formSchema: ComponentSchema = joi.string()\n  stateSchema: ComponentSchema = joi.string()\n\n  constructor(\n    def: ComponentDef,\n    props: {\n      page?: PageControllerClass\n      parent?: Component\n      model: FormModel\n    }\n  ) {\n    this.type = def.type\n    this.name = def.name\n    this.title = def.title\n\n    if ('schema' in def) {\n      this.schema = def.schema\n    }\n\n    if ('options' in def) {\n      this.options = def.options\n    }\n\n    this.page = props.page\n    this.parent = props.parent\n    this.model = props.model\n  }\n\n  get viewModel() {\n    const { options, type } = this\n\n    const viewModel: ViewModel = {\n      attributes: {}\n    }\n\n    if (!options) {\n      return viewModel\n    }\n\n    if ('autocomplete' in options) {\n      viewModel.attributes.autocomplete = options.autocomplete\n    }\n\n    if ('classes' in options) {\n      viewModel.classes = options.classes\n    }\n\n    if ('condition' in options && isConditionalRevealType(type)) {\n      viewModel.condition = options.condition\n    }\n\n    return viewModel\n  }\n}\n\nexport type ComponentSchema =\n  | ArraySchema<string>\n  | ArraySchema<number>\n  | ArraySchema<boolean>\n  | ArraySchema<object>\n  | BooleanSchema<string>\n  | BooleanSchema\n  | DateSchema\n  | NumberSchema<string>\n  | NumberSchema\n  | ObjectSchema\n  | StringSchema\n"],"mappings":"AAAA,SAASA,uBAAuB,QAA2B,oBAAoB;AAC/E,OAAOC,GAAG,MAOH,KAAK;AAQZ,OAAO,MAAMC,aAAa,CAAC;EACzBC,IAAI;EACJC,MAAM;EACNC,UAAU;EAEVC,IAAI;EACJC,IAAI;EACJC,KAAK;EACLC,MAAM;EACNC,OAAO;EAEPC,eAAe,GAAG,KAAK;EACvBC,KAAK;;EAEL;EACAC,UAAU,GAAoBZ,GAAG,CAACa,MAAM,CAAC,CAAC;EAC1CC,WAAW,GAAoBd,GAAG,CAACa,MAAM,CAAC,CAAC;EAE3CE,WAAWA,CACTC,GAAiB,EACjBC,KAIC,EACD;IACA,IAAI,CAACZ,IAAI,GAAGW,GAAG,CAACX,IAAI;IACpB,IAAI,CAACC,IAAI,GAAGU,GAAG,CAACV,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGS,GAAG,CAACT,KAAK;IAEtB,IAAI,QAAQ,IAAIS,GAAG,EAAE;MACnB,IAAI,CAACR,MAAM,GAAGQ,GAAG,CAACR,MAAM;IAC1B;IAEA,IAAI,SAAS,IAAIQ,GAAG,EAAE;MACpB,IAAI,CAACP,OAAO,GAAGO,GAAG,CAACP,OAAO;IAC5B;IAEA,IAAI,CAACP,IAAI,GAAGe,KAAK,CAACf,IAAI;IACtB,IAAI,CAACC,MAAM,GAAGc,KAAK,CAACd,MAAM;IAC1B,IAAI,CAACQ,KAAK,GAAGM,KAAK,CAACN,KAAK;EAC1B;EAEA,IAAIO,SAASA,CAAA,EAAG;IACd,MAAM;MAAET,OAAO;MAAEJ;IAAK,CAAC,GAAG,IAAI;IAE9B,MAAMa,SAAoB,GAAG;MAC3BC,UAAU,EAAE,CAAC;IACf,CAAC;IAED,IAAI,CAACV,OAAO,EAAE;MACZ,OAAOS,SAAS;IAClB;IAEA,IAAI,cAAc,IAAIT,OAAO,EAAE;MAC7BS,SAAS,CAACC,UAAU,CAACC,YAAY,GAAGX,OAAO,CAACW,YAAY;IAC1D;IAEA,IAAI,SAAS,IAAIX,OAAO,EAAE;MACxBS,SAAS,CAACG,OAAO,GAAGZ,OAAO,CAACY,OAAO;IACrC;IAEA,IAAI,WAAW,IAAIZ,OAAO,IAAIV,uBAAuB,CAACM,IAAI,CAAC,EAAE;MAC3Da,SAAS,CAACI,SAAS,GAAGb,OAAO,CAACa,SAAS;IACzC;IAEA,OAAOJ,SAAS;EAClB;AACF","ignoreList":[]}

package/.server/server/plugins/engine/components/ComponentCollection.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComponentCollection.js","names":["joi","FormComponent","isFormState","isFormValue","createComponent","getErrors","validationOptions","opts","ComponentCollection","page","parent","components","fields","guidance","formSchema","stateSchema","constructor","defs","props","schema","map","def","filter","component","isFormComponent","object","required","field","collection","name","concat","keys","error","errors","flatMap","isErrorContext","local","title","missing","key","path","find","item","split","shift","child","label","length","peers","and","isPresent","custom","getFormDataFromState","state","payload","forEach","Object","assign","getFormValueFromState","value","entries","pop","getStateFromValidForm","getContextValueFromState","context","getFieldErrors","getViewErrors","getViewModel","query","result","type","model","validate","details","callback","list","fieldErrors","push"],"sources":["../../../../../src/server/plugins/engine/components/ComponentCollection.ts"],"sourcesContent":["import { type ComponentDef } from '@defra/forms-model'\nimport joi, {\n  type CustomValidator,\n  type ErrorReportCollection,\n  type ObjectSchema\n} from 'joi'\n\nimport {\n  FormComponent,\n  isFormState,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  createComponent,\n  type Component,\n  type Field,\n  type Guidance\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js'\nimport { getErrors } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type FormValidationResult\n} from '~/src/server/plugins/engine/types.js'\nimport { type FormQuery } from '~/src/server/routes/types.js'\n\nexport class ComponentCollection {\n  page?: PageControllerClass\n  parent?: Component\n\n  components: Component[]\n  fields: Field[]\n  guidance: Guidance[]\n\n  formSchema: ObjectSchema<FormPayload>\n  stateSchema: ObjectSchema<FormSubmissionState>\n\n  constructor(\n    defs: ComponentDef[],\n    props: {\n      page?: PageControllerClass\n      parent?: Component\n      model: FormModel\n    },\n    schema?: {\n      /**\n       * Defines an all-or-nothing relationship between keys where if one\n       * of the peers is present, all of them are required as well\n       */\n      peers?: string[]\n\n      /**\n       * Defines a custom validation rule for the object schema\n       */\n      custom?: CustomValidator\n    }\n  ) {\n    const components = defs.map((def) => createComponent(def, props))\n\n    const fields = components.filter(\n      (component): component is Field => component.isFormComponent\n    )\n\n    const guidance = components.filter(\n      (component): component is Guidance => !component.isFormComponent\n    )\n\n    let formSchema = joi.object<FormPayload>().required()\n    let stateSchema = joi.object<FormSubmissionState>().required()\n\n    // Add each field or concat collection\n    for (const field of fields) {\n      const { collection, name } = field\n\n      formSchema = collection\n        ? formSchema.concat(collection.formSchema)\n        : formSchema.keys({ [name]: field.formSchema })\n\n      stateSchema = collection\n        ? stateSchema.concat(collection.stateSchema)\n        : stateSchema.keys({ [name]: field.stateSchema })\n    }\n\n    // Add parent field title to collection field errors\n    formSchema = formSchema.error((errors) => {\n      return errors.flatMap((error) => {\n        if (!isErrorContext(error.local) || error.local.title) {\n          return error\n        }\n\n        // Use field key or first missing child field\n        let { missing, key = missing?.[0] } = error.local\n\n        // But avoid numeric key used by array payloads\n        if (typeof key === 'number') {\n          key = error.path[0]\n        }\n\n        // Find the parent field\n        const parent = fields.find(\n          (item) => item.name === key?.split('__').shift()\n        )\n\n        // Find the child field\n        const child = (parent?.collection?.fields ?? fields).find(\n          (item) => item.name === key\n        )\n\n        // Update error with child label\n        if (child && (!error.local.label || error.local.label === 'value')) {\n          error.local.label = child.title\n        }\n\n        // Fix error summary links for missing fields\n        if (missing?.length) {\n          error.path = missing\n          error.local.key = missing[0]\n        }\n\n        // Update error with parent title\n        error.local.title ??= parent?.label\n\n        return error\n      })\n    })\n\n    if (schema?.peers) {\n      formSchema = formSchema.and(...schema.peers, {\n        isPresent: isFormValue\n      })\n    }\n\n    if (schema?.custom) {\n      formSchema = formSchema.custom(schema.custom)\n    }\n\n    this.page = props.page\n    this.parent = props.parent\n\n    this.components = components\n    this.fields = fields\n    this.guidance = guidance\n\n    this.formSchema = formSchema\n    this.stateSchema = stateSchema\n  }\n\n  get keys() {\n    return this.fields.flatMap((field) => {\n      const { name, collection } = field\n\n      if (collection) {\n        const { fields } = collection\n        return [name, ...fields.map(({ name }) => name)]\n      }\n\n      return [name]\n    })\n  }\n\n  getFormDataFromState(state: FormSubmissionState) {\n    const payload: FormPayload = {}\n\n    this.fields.forEach((component) => {\n      Object.assign(payload, component.getFormDataFromState(state))\n    })\n\n    return payload\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const payload: FormPayload = {}\n\n    // Remove name prefix for formatted value\n    for (const [name, value] of Object.entries(\n      this.getFormDataFromState(state)\n    )) {\n      const key = name.split('__').pop()\n      if (!key) {\n        continue\n      }\n\n      payload[key] = value\n    }\n\n    return payload\n  }\n\n  getStateFromValidForm(payload: FormPayload) {\n    const state: FormState = {}\n\n    this.fields.forEach((component) => {\n      Object.assign(state, component.getStateFromValidForm(payload))\n    })\n\n    return state\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const context: FormState = {}\n\n    for (const component of this.fields) {\n      context[component.name] = component.getContextValueFromState(state)\n    }\n\n    return context\n  }\n\n  /**\n   * Get all errors for all fields in this collection\n   */\n  getErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined {\n    return this.getFieldErrors((field) => field.getErrors(errors), errors)\n  }\n\n  /**\n   * Get view errors for all fields in this collection.\n   * For most fields this means filtering to the first error in the list.\n   * Composite fields like UKAddress can choose to return more than one error.\n   */\n  getViewErrors(\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    return this.getFieldErrors((field) => field.getViewErrors(errors), errors)\n  }\n\n  getViewModel(\n    payload: FormPayload,\n    errors?: FormSubmissionError[],\n    query: FormQuery = {}\n  ) {\n    const { components } = this\n\n    const result: ComponentViewModel[] = components.map((component) => {\n      const { isFormComponent, type } = component\n\n      const model =\n        component instanceof FormComponent\n          ? component.getViewModel(payload, errors, query)\n          : component.getViewModel()\n\n      return { type, isFormComponent, model }\n    })\n\n    return result\n  }\n\n  /**\n   * Validate form payload\n   */\n  validate(value: FormPayload = {}): FormValidationResult<FormPayload> {\n    const result = this.formSchema.validate(value, opts)\n    const details = result.error?.details\n\n    return {\n      value: (result.value ?? {}) as typeof value,\n      errors: this.page?.getErrors(details) ?? getErrors(details)\n    }\n  }\n\n  /**\n   * Helper to get errors from all fields\n   */\n  private getFieldErrors(\n    callback: (field: Field) => FormSubmissionError[] | undefined,\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const { fields } = this\n\n    if (!errors?.length) {\n      return\n    }\n\n    const list: FormSubmissionError[] = []\n\n    for (const field of fields) {\n      const fieldErrors = callback(field)\n\n      if (fieldErrors?.length) {\n        list.push(...fieldErrors)\n      }\n    }\n\n    if (!list.length) {\n      return\n    }\n\n    return list\n  }\n}\n\n/**\n * Check for field local state\n */\nexport function isErrorContext(\n  value?: unknown\n): value is ErrorReportCollection['local'] {\n  return isFormState(value) && typeof value.label === 'string'\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW,EACXC,WAAW;AAEb,SACEC,eAAe;AAMjB,SAASC,SAAS;AAGlB,SAASC,iBAAiB,IAAIC,IAAI;AAUlC,OAAO,MAAMC,mBAAmB,CAAC;EAC/BC,IAAI;EACJC,MAAM;EAENC,UAAU;EACVC,MAAM;EACNC,QAAQ;EAERC,UAAU;EACVC,WAAW;EAEXC,WAAWA,CACTC,IAAoB,EACpBC,KAIC,EACDC,MAWC,EACD;IACA,MAAMR,UAAU,GAAGM,IAAI,CAACG,GAAG,CAAEC,GAAG,IAAKjB,eAAe,CAACiB,GAAG,EAAEH,KAAK,CAAC,CAAC;IAEjE,MAAMN,MAAM,GAAGD,UAAU,CAACW,MAAM,CAC7BC,SAAS,IAAyBA,SAAS,CAACC,eAC/C,CAAC;IAED,MAAMX,QAAQ,GAAGF,UAAU,CAACW,MAAM,CAC/BC,SAAS,IAA4B,CAACA,SAAS,CAACC,eACnD,CAAC;IAED,IAAIV,UAAU,GAAGd,GAAG,CAACyB,MAAM,CAAc,CAAC,CAACC,QAAQ,CAAC,CAAC;IACrD,IAAIX,WAAW,GAAGf,GAAG,CAACyB,MAAM,CAAsB,CAAC,CAACC,QAAQ,CAAC,CAAC;;IAE9D;IACA,KAAK,MAAMC,KAAK,IAAIf,MAAM,EAAE;MAC1B,MAAM;QAAEgB,UAAU;QAAEC;MAAK,CAAC,GAAGF,KAAK;MAElCb,UAAU,GAAGc,UAAU,GACnBd,UAAU,CAACgB,MAAM,CAACF,UAAU,CAACd,UAAU,CAAC,GACxCA,UAAU,CAACiB,IAAI,CAAC;QAAE,CAACF,IAAI,GAAGF,KAAK,CAACb;MAAW,CAAC,CAAC;MAEjDC,WAAW,GAAGa,UAAU,GACpBb,WAAW,CAACe,MAAM,CAACF,UAAU,CAACb,WAAW,CAAC,GAC1CA,WAAW,CAACgB,IAAI,CAAC;QAAE,CAACF,IAAI,GAAGF,KAAK,CAACZ;MAAY,CAAC,CAAC;IACrD;;IAEA;IACAD,UAAU,GAAGA,UAAU,CAACkB,KAAK,CAAEC,MAAM,IAAK;MACxC,OAAOA,MAAM,CAACC,OAAO,CAAEF,KAAK,IAAK;QAC/B,IAAI,CAACG,cAAc,CAACH,KAAK,CAACI,KAAK,CAAC,IAAIJ,KAAK,CAACI,KAAK,CAACC,KAAK,EAAE;UACrD,OAAOL,KAAK;QACd;;QAEA;QACA,IAAI;UAAEM,OAAO;UAAEC,GAAG,GAAGD,OAAO,GAAG,CAAC;QAAE,CAAC,GAAGN,KAAK,CAACI,KAAK;;QAEjD;QACA,IAAI,OAAOG,GAAG,KAAK,QAAQ,EAAE;UAC3BA,GAAG,GAAGP,KAAK,CAACQ,IAAI,CAAC,CAAC,CAAC;QACrB;;QAEA;QACA,MAAM9B,MAAM,GAAGE,MAAM,CAAC6B,IAAI,CACvBC,IAAI,IAAKA,IAAI,CAACb,IAAI,KAAKU,GAAG,EAAEI,KAAK,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,CACjD,CAAC;;QAED;QACA,MAAMC,KAAK,GAAG,CAACnC,MAAM,EAAEkB,UAAU,EAAEhB,MAAM,IAAIA,MAAM,EAAE6B,IAAI,CACtDC,IAAI,IAAKA,IAAI,CAACb,IAAI,KAAKU,GAC1B,CAAC;;QAED;QACA,IAAIM,KAAK,KAAK,CAACb,KAAK,CAACI,KAAK,CAACU,KAAK,IAAId,KAAK,CAACI,KAAK,CAACU,KAAK,KAAK,OAAO,CAAC,EAAE;UAClEd,KAAK,CAACI,KAAK,CAACU,KAAK,GAAGD,KAAK,CAACR,KAAK;QACjC;;QAEA;QACA,IAAIC,OAAO,EAAES,MAAM,EAAE;UACnBf,KAAK,CAACQ,IAAI,GAAGF,OAAO;UACpBN,KAAK,CAACI,KAAK,CAACG,GAAG,GAAGD,OAAO,CAAC,CAAC,CAAC;QAC9B;;QAEA;QACAN,KAAK,CAACI,KAAK,CAACC,KAAK,KAAK3B,MAAM,EAAEoC,KAAK;QAEnC,OAAOd,KAAK;MACd,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,IAAIb,MAAM,EAAE6B,KAAK,EAAE;MACjBlC,UAAU,GAAGA,UAAU,CAACmC,GAAG,CAAC,GAAG9B,MAAM,CAAC6B,KAAK,EAAE;QAC3CE,SAAS,EAAE/C;MACb,CAAC,CAAC;IACJ;IAEA,IAAIgB,MAAM,EAAEgC,MAAM,EAAE;MAClBrC,UAAU,GAAGA,UAAU,CAACqC,MAAM,CAAChC,MAAM,CAACgC,MAAM,CAAC;IAC/C;IAEA,IAAI,CAAC1C,IAAI,GAAGS,KAAK,CAACT,IAAI;IACtB,IAAI,CAACC,MAAM,GAAGQ,KAAK,CAACR,MAAM;IAE1B,IAAI,CAACC,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IAExB,IAAI,CAACC,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,WAAW,GAAGA,WAAW;EAChC;EAEA,IAAIgB,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACnB,MAAM,CAACsB,OAAO,CAAEP,KAAK,IAAK;MACpC,MAAM;QAAEE,IAAI;QAAED;MAAW,CAAC,GAAGD,KAAK;MAElC,IAAIC,UAAU,EAAE;QACd,MAAM;UAAEhB;QAAO,CAAC,GAAGgB,UAAU;QAC7B,OAAO,CAACC,IAAI,EAAE,GAAGjB,MAAM,CAACQ,GAAG,CAAC,CAAC;UAAES;QAAK,CAAC,KAAKA,IAAI,CAAC,CAAC;MAClD;MAEA,OAAO,CAACA,IAAI,CAAC;IACf,CAAC,CAAC;EACJ;EAEAuB,oBAAoBA,CAACC,KAA0B,EAAE;IAC/C,MAAMC,OAAoB,GAAG,CAAC,CAAC;IAE/B,IAAI,CAAC1C,MAAM,CAAC2C,OAAO,CAAEhC,SAAS,IAAK;MACjCiC,MAAM,CAACC,MAAM,CAACH,OAAO,EAAE/B,SAAS,CAAC6B,oBAAoB,CAACC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF,OAAOC,OAAO;EAChB;EAEAI,qBAAqBA,CAACL,KAA0B,EAAE;IAChD,MAAMC,OAAoB,GAAG,CAAC,CAAC;;IAE/B;IACA,KAAK,MAAM,CAACzB,IAAI,EAAE8B,KAAK,CAAC,IAAIH,MAAM,CAACI,OAAO,CACxC,IAAI,CAACR,oBAAoB,CAACC,KAAK,CACjC,CAAC,EAAE;MACD,MAAMd,GAAG,GAAGV,IAAI,CAACc,KAAK,CAAC,IAAI,CAAC,CAACkB,GAAG,CAAC,CAAC;MAClC,IAAI,CAACtB,GAAG,EAAE;QACR;MACF;MAEAe,OAAO,CAACf,GAAG,CAAC,GAAGoB,KAAK;IACtB;IAEA,OAAOL,OAAO;EAChB;EAEAQ,qBAAqBA,CAACR,OAAoB,EAAE;IAC1C,MAAMD,KAAgB,GAAG,CAAC,CAAC;IAE3B,IAAI,CAACzC,MAAM,CAAC2C,OAAO,CAAEhC,SAAS,IAAK;MACjCiC,MAAM,CAACC,MAAM,CAACJ,KAAK,EAAE9B,SAAS,CAACuC,qBAAqB,CAACR,OAAO,CAAC,CAAC;IAChE,CAAC,CAAC;IAEF,OAAOD,KAAK;EACd;EAEAU,wBAAwBA,CAACV,KAA0B,EAAE;IACnD,MAAMW,OAAkB,GAAG,CAAC,CAAC;IAE7B,KAAK,MAAMzC,SAAS,IAAI,IAAI,CAACX,MAAM,EAAE;MACnCoD,OAAO,CAACzC,SAAS,CAACM,IAAI,CAAC,GAAGN,SAAS,CAACwC,wBAAwB,CAACV,KAAK,CAAC;IACrE;IAEA,OAAOW,OAAO;EAChB;;EAEA;AACF;AACA;EACE3D,SAASA,CAAC4B,MAA8B,EAAqC;IAC3E,OAAO,IAAI,CAACgC,cAAc,CAAEtC,KAAK,IAAKA,KAAK,CAACtB,SAAS,CAAC4B,MAAM,CAAC,EAAEA,MAAM,CAAC;EACxE;;EAEA;AACF;AACA;AACA;AACA;EACEiC,aAAaA,CACXjC,MAA8B,EACK;IACnC,OAAO,IAAI,CAACgC,cAAc,CAAEtC,KAAK,IAAKA,KAAK,CAACuC,aAAa,CAACjC,MAAM,CAAC,EAAEA,MAAM,CAAC;EAC5E;EAEAkC,YAAYA,CACVb,OAAoB,EACpBrB,MAA8B,EAC9BmC,KAAgB,GAAG,CAAC,CAAC,EACrB;IACA,MAAM;MAAEzD;IAAW,CAAC,GAAG,IAAI;IAE3B,MAAM0D,MAA4B,GAAG1D,UAAU,CAACS,GAAG,CAAEG,SAAS,IAAK;MACjE,MAAM;QAAEC,eAAe;QAAE8C;MAAK,CAAC,GAAG/C,SAAS;MAE3C,MAAMgD,KAAK,GACThD,SAAS,YAAYtB,aAAa,GAC9BsB,SAAS,CAAC4C,YAAY,CAACb,OAAO,EAAErB,MAAM,EAAEmC,KAAK,CAAC,GAC9C7C,SAAS,CAAC4C,YAAY,CAAC,CAAC;MAE9B,OAAO;QAAEG,IAAI;QAAE9C,eAAe;QAAE+C;MAAM,CAAC;IACzC,CAAC,CAAC;IAEF,OAAOF,MAAM;EACf;;EAEA;AACF;AACA;EACEG,QAAQA,CAACb,KAAkB,GAAG,CAAC,CAAC,EAAqC;IACnE,MAAMU,MAAM,GAAG,IAAI,CAACvD,UAAU,CAAC0D,QAAQ,CAACb,KAAK,EAAEpD,IAAI,CAAC;IACpD,MAAMkE,OAAO,GAAGJ,MAAM,CAACrC,KAAK,EAAEyC,OAAO;IAErC,OAAO;MACLd,KAAK,EAAGU,MAAM,CAACV,KAAK,IAAI,CAAC,CAAkB;MAC3C1B,MAAM,EAAE,IAAI,CAACxB,IAAI,EAAEJ,SAAS,CAACoE,OAAO,CAAC,IAAIpE,SAAS,CAACoE,OAAO;IAC5D,CAAC;EACH;;EAEA;AACF;AACA;EACUR,cAAcA,CACpBS,QAA6D,EAC7DzC,MAA8B,EACK;IACnC,MAAM;MAAErB;IAAO,CAAC,GAAG,IAAI;IAEvB,IAAI,CAACqB,MAAM,EAAEc,MAAM,EAAE;MACnB;IACF;IAEA,MAAM4B,IAA2B,GAAG,EAAE;IAEtC,KAAK,MAAMhD,KAAK,IAAIf,MAAM,EAAE;MAC1B,MAAMgE,WAAW,GAAGF,QAAQ,CAAC/C,KAAK,CAAC;MAEnC,IAAIiD,WAAW,EAAE7B,MAAM,EAAE;QACvB4B,IAAI,CAACE,IAAI,CAAC,GAAGD,WAAW,CAAC;MAC3B;IACF;IAEA,IAAI,CAACD,IAAI,CAAC5B,MAAM,EAAE;MAChB;IACF;IAEA,OAAO4B,IAAI;EACb;AACF;;AAEA;AACA;AACA;AACA,OAAO,SAASxC,cAAcA,CAC5BwB,KAAe,EAC0B;EACzC,OAAOzD,WAAW,CAACyD,KAAK,CAAC,IAAI,OAAOA,KAAK,CAACb,KAAK,KAAK,QAAQ;AAC9D","ignoreList":[]}
+{"version":3,"file":"ComponentCollection.js","names":["joi","FormComponent","isFormState","isFormValue","createComponent","getErrors","validationOptions","opts","ComponentCollection","page","parent","components","fields","guidance","formSchema","stateSchema","constructor","defs","props","schema","map","def","filter","component","isFormComponent","object","required","field","collection","name","concat","keys","error","errors","flatMap","isErrorContext","local","title","missing","key","path","find","item","split","shift","child","label","length","peers","and","isPresent","custom","getFormDataFromState","state","payload","forEach","Object","assign","getFormValueFromState","value","entries","pop","getStateFromValidForm","getContextValueFromState","context","getFieldErrors","getViewErrors","getViewModel","query","result","type","model","validate","details","callback","list","fieldErrors","push"],"sources":["../../../../../src/server/plugins/engine/components/ComponentCollection.ts"],"sourcesContent":["import { type ComponentDef } from '@defra/forms-model'\nimport joi, {\n  type CustomValidator,\n  type ErrorReportCollection,\n  type ObjectSchema\n} from 'joi'\n\nimport {\n  FormComponent,\n  isFormState,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  createComponent,\n  type Component,\n  type Field,\n  type Guidance\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js'\nimport { getErrors } from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type FormValidationResult\n} from '~/src/server/plugins/engine/types.js'\nimport { type FormQuery } from '~/src/server/routes/types.js'\n\nexport class ComponentCollection {\n  page?: PageControllerClass\n  parent?: Component\n\n  components: Component[]\n  fields: Field[]\n  guidance: Guidance[]\n\n  formSchema: ObjectSchema<FormPayload>\n  stateSchema: ObjectSchema<FormSubmissionState>\n\n  constructor(\n    defs: ComponentDef[],\n    props: {\n      page?: PageControllerClass\n      parent?: Component\n      model: FormModel\n    },\n    schema?: {\n      /**\n       * Defines an all-or-nothing relationship between keys where if one\n       * of the peers is present, all of them are required as well\n       */\n      peers?: string[]\n\n      /**\n       * Defines a custom validation rule for the object schema\n       */\n      custom?: CustomValidator\n    }\n  ) {\n    const components = defs.map((def) => createComponent(def, props))\n\n    const fields = components.filter(\n      (component): component is Field => component.isFormComponent\n    )\n\n    const guidance = components.filter(\n      (component): component is Guidance => !component.isFormComponent\n    )\n\n    let formSchema = joi.object<FormPayload>().required()\n    let stateSchema = joi.object<FormSubmissionState>().required()\n\n    // Add each field or concat collection\n    for (const field of fields) {\n      const { collection, name } = field\n\n      formSchema = collection\n        ? formSchema.concat(collection.formSchema)\n        : formSchema.keys({ [name]: field.formSchema })\n\n      stateSchema = collection\n        ? stateSchema.concat(collection.stateSchema)\n        : stateSchema.keys({ [name]: field.stateSchema })\n    }\n\n    // Add parent field title to collection field errors\n    formSchema = formSchema.error((errors) => {\n      return errors.flatMap((error) => {\n        if (!isErrorContext(error.local) || error.local.title) {\n          return error\n        }\n\n        // Use field key or first missing child field\n        let { missing, key = missing?.[0] } = error.local\n\n        // But avoid numeric key used by array payloads\n        if (typeof key === 'number') {\n          key = error.path[0]\n        }\n\n        // Find the parent field\n        const parent = fields.find(\n          (item) => item.name === key?.split('__').shift()\n        )\n\n        // Find the child field\n        const child = (parent?.collection?.fields ?? fields).find(\n          (item) => item.name === key\n        )\n\n        // Update error with child label\n        if (child && (!error.local.label || error.local.label === 'value')) {\n          error.local.label = child.title\n        }\n\n        // Fix error summary links for missing fields\n        if (missing?.length) {\n          error.path = missing\n          error.local.key = missing[0]\n        }\n\n        // Update error with parent title\n        error.local.title ??= parent?.label\n\n        return error\n      })\n    })\n\n    if (schema?.peers) {\n      formSchema = formSchema.and(...schema.peers, {\n        isPresent: isFormValue\n      })\n    }\n\n    if (schema?.custom) {\n      formSchema = formSchema.custom(schema.custom)\n    }\n\n    this.page = props.page\n    this.parent = props.parent\n\n    this.components = components\n    this.fields = fields\n    this.guidance = guidance\n\n    this.formSchema = formSchema\n    this.stateSchema = stateSchema\n  }\n\n  get keys() {\n    return this.fields.flatMap((field) => {\n      const { name, collection } = field\n\n      if (collection) {\n        const { fields } = collection\n        return [name, ...fields.map(({ name }) => name)]\n      }\n\n      return [name]\n    })\n  }\n\n  getFormDataFromState(state: FormSubmissionState) {\n    const payload: FormPayload = {}\n\n    this.fields.forEach((component) => {\n      Object.assign(payload, component.getFormDataFromState(state))\n    })\n\n    return payload\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const payload: FormPayload = {}\n\n    // Remove name prefix for formatted value\n    for (const [name, value] of Object.entries(\n      this.getFormDataFromState(state)\n    )) {\n      const key = name.split('__').pop()\n      if (!key) {\n        continue\n      }\n\n      payload[key] = value\n    }\n\n    return payload\n  }\n\n  getStateFromValidForm(payload: FormPayload) {\n    const state: FormState = {}\n\n    this.fields.forEach((component) => {\n      Object.assign(state, component.getStateFromValidForm(payload))\n    })\n\n    return state\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    const context: FormState = {}\n\n    for (const component of this.fields) {\n      context[component.name] = component.getContextValueFromState(state)\n    }\n\n    return context\n  }\n\n  /**\n   * Get all errors for all fields in this collection\n   */\n  getErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined {\n    return this.getFieldErrors((field) => field.getErrors(errors), errors)\n  }\n\n  /**\n   * Get view errors for all fields in this collection.\n   * For most fields this means filtering to the first error in the list.\n   * Composite fields like UKAddress can choose to return more than one error.\n   */\n  getViewErrors(\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    return this.getFieldErrors((field) => field.getViewErrors(errors), errors)\n  }\n\n  getViewModel(\n    payload: FormPayload,\n    errors?: FormSubmissionError[],\n    query: FormQuery = {}\n  ) {\n    const { components } = this\n\n    const result: ComponentViewModel[] = components.map((component) => {\n      const { isFormComponent, type } = component\n\n      const model =\n        component instanceof FormComponent\n          ? component.getViewModel(payload, errors, query)\n          : component.getViewModel()\n\n      return { type, isFormComponent, model }\n    })\n\n    return result\n  }\n\n  /**\n   * Validate form payload\n   */\n  validate(value: FormPayload = {}): FormValidationResult<FormPayload> {\n    const result = this.formSchema.validate(value, opts)\n\n    const details = result.error?.details\n\n    return {\n      value: (result.value ?? {}) as typeof value,\n      errors: this.page?.getErrors(details) ?? getErrors(details)\n    }\n  }\n\n  /**\n   * Helper to get errors from all fields\n   */\n  private getFieldErrors(\n    callback: (field: Field) => FormSubmissionError[] | undefined,\n    errors?: FormSubmissionError[]\n  ): FormSubmissionError[] | undefined {\n    const { fields } = this\n\n    if (!errors?.length) {\n      return\n    }\n\n    const list: FormSubmissionError[] = []\n\n    for (const field of fields) {\n      const fieldErrors = callback(field)\n\n      if (fieldErrors?.length) {\n        list.push(...fieldErrors)\n      }\n    }\n\n    if (!list.length) {\n      return\n    }\n\n    return list\n  }\n}\n\n/**\n * Check for field local state\n */\nexport function isErrorContext(\n  value?: unknown\n): value is ErrorReportCollection['local'] {\n  return isFormState(value) && typeof value.label === 'string'\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW,EACXC,WAAW;AAEb,SACEC,eAAe;AAMjB,SAASC,SAAS;AAGlB,SAASC,iBAAiB,IAAIC,IAAI;AAUlC,OAAO,MAAMC,mBAAmB,CAAC;EAC/BC,IAAI;EACJC,MAAM;EAENC,UAAU;EACVC,MAAM;EACNC,QAAQ;EAERC,UAAU;EACVC,WAAW;EAEXC,WAAWA,CACTC,IAAoB,EACpBC,KAIC,EACDC,MAWC,EACD;IACA,MAAMR,UAAU,GAAGM,IAAI,CAACG,GAAG,CAAEC,GAAG,IAAKjB,eAAe,CAACiB,GAAG,EAAEH,KAAK,CAAC,CAAC;IAEjE,MAAMN,MAAM,GAAGD,UAAU,CAACW,MAAM,CAC7BC,SAAS,IAAyBA,SAAS,CAACC,eAC/C,CAAC;IAED,MAAMX,QAAQ,GAAGF,UAAU,CAACW,MAAM,CAC/BC,SAAS,IAA4B,CAACA,SAAS,CAACC,eACnD,CAAC;IAED,IAAIV,UAAU,GAAGd,GAAG,CAACyB,MAAM,CAAc,CAAC,CAACC,QAAQ,CAAC,CAAC;IACrD,IAAIX,WAAW,GAAGf,GAAG,CAACyB,MAAM,CAAsB,CAAC,CAACC,QAAQ,CAAC,CAAC;;IAE9D;IACA,KAAK,MAAMC,KAAK,IAAIf,MAAM,EAAE;MAC1B,MAAM;QAAEgB,UAAU;QAAEC;MAAK,CAAC,GAAGF,KAAK;MAElCb,UAAU,GAAGc,UAAU,GACnBd,UAAU,CAACgB,MAAM,CAACF,UAAU,CAACd,UAAU,CAAC,GACxCA,UAAU,CAACiB,IAAI,CAAC;QAAE,CAACF,IAAI,GAAGF,KAAK,CAACb;MAAW,CAAC,CAAC;MAEjDC,WAAW,GAAGa,UAAU,GACpBb,WAAW,CAACe,MAAM,CAACF,UAAU,CAACb,WAAW,CAAC,GAC1CA,WAAW,CAACgB,IAAI,CAAC;QAAE,CAACF,IAAI,GAAGF,KAAK,CAACZ;MAAY,CAAC,CAAC;IACrD;;IAEA;IACAD,UAAU,GAAGA,UAAU,CAACkB,KAAK,CAAEC,MAAM,IAAK;MACxC,OAAOA,MAAM,CAACC,OAAO,CAAEF,KAAK,IAAK;QAC/B,IAAI,CAACG,cAAc,CAACH,KAAK,CAACI,KAAK,CAAC,IAAIJ,KAAK,CAACI,KAAK,CAACC,KAAK,EAAE;UACrD,OAAOL,KAAK;QACd;;QAEA;QACA,IAAI;UAAEM,OAAO;UAAEC,GAAG,GAAGD,OAAO,GAAG,CAAC;QAAE,CAAC,GAAGN,KAAK,CAACI,KAAK;;QAEjD;QACA,IAAI,OAAOG,GAAG,KAAK,QAAQ,EAAE;UAC3BA,GAAG,GAAGP,KAAK,CAACQ,IAAI,CAAC,CAAC,CAAC;QACrB;;QAEA;QACA,MAAM9B,MAAM,GAAGE,MAAM,CAAC6B,IAAI,CACvBC,IAAI,IAAKA,IAAI,CAACb,IAAI,KAAKU,GAAG,EAAEI,KAAK,CAAC,IAAI,CAAC,CAACC,KAAK,CAAC,CACjD,CAAC;;QAED;QACA,MAAMC,KAAK,GAAG,CAACnC,MAAM,EAAEkB,UAAU,EAAEhB,MAAM,IAAIA,MAAM,EAAE6B,IAAI,CACtDC,IAAI,IAAKA,IAAI,CAACb,IAAI,KAAKU,GAC1B,CAAC;;QAED;QACA,IAAIM,KAAK,KAAK,CAACb,KAAK,CAACI,KAAK,CAACU,KAAK,IAAId,KAAK,CAACI,KAAK,CAACU,KAAK,KAAK,OAAO,CAAC,EAAE;UAClEd,KAAK,CAACI,KAAK,CAACU,KAAK,GAAGD,KAAK,CAACR,KAAK;QACjC;;QAEA;QACA,IAAIC,OAAO,EAAES,MAAM,EAAE;UACnBf,KAAK,CAACQ,IAAI,GAAGF,OAAO;UACpBN,KAAK,CAACI,KAAK,CAACG,GAAG,GAAGD,OAAO,CAAC,CAAC,CAAC;QAC9B;;QAEA;QACAN,KAAK,CAACI,KAAK,CAACC,KAAK,KAAK3B,MAAM,EAAEoC,KAAK;QAEnC,OAAOd,KAAK;MACd,CAAC,CAAC;IACJ,CAAC,CAAC;IAEF,IAAIb,MAAM,EAAE6B,KAAK,EAAE;MACjBlC,UAAU,GAAGA,UAAU,CAACmC,GAAG,CAAC,GAAG9B,MAAM,CAAC6B,KAAK,EAAE;QAC3CE,SAAS,EAAE/C;MACb,CAAC,CAAC;IACJ;IAEA,IAAIgB,MAAM,EAAEgC,MAAM,EAAE;MAClBrC,UAAU,GAAGA,UAAU,CAACqC,MAAM,CAAChC,MAAM,CAACgC,MAAM,CAAC;IAC/C;IAEA,IAAI,CAAC1C,IAAI,GAAGS,KAAK,CAACT,IAAI;IACtB,IAAI,CAACC,MAAM,GAAGQ,KAAK,CAACR,MAAM;IAE1B,IAAI,CAACC,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,QAAQ,GAAGA,QAAQ;IAExB,IAAI,CAACC,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,WAAW,GAAGA,WAAW;EAChC;EAEA,IAAIgB,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACnB,MAAM,CAACsB,OAAO,CAAEP,KAAK,IAAK;MACpC,MAAM;QAAEE,IAAI;QAAED;MAAW,CAAC,GAAGD,KAAK;MAElC,IAAIC,UAAU,EAAE;QACd,MAAM;UAAEhB;QAAO,CAAC,GAAGgB,UAAU;QAC7B,OAAO,CAACC,IAAI,EAAE,GAAGjB,MAAM,CAACQ,GAAG,CAAC,CAAC;UAAES;QAAK,CAAC,KAAKA,IAAI,CAAC,CAAC;MAClD;MAEA,OAAO,CAACA,IAAI,CAAC;IACf,CAAC,CAAC;EACJ;EAEAuB,oBAAoBA,CAACC,KAA0B,EAAE;IAC/C,MAAMC,OAAoB,GAAG,CAAC,CAAC;IAE/B,IAAI,CAAC1C,MAAM,CAAC2C,OAAO,CAAEhC,SAAS,IAAK;MACjCiC,MAAM,CAACC,MAAM,CAACH,OAAO,EAAE/B,SAAS,CAAC6B,oBAAoB,CAACC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF,OAAOC,OAAO;EAChB;EAEAI,qBAAqBA,CAACL,KAA0B,EAAE;IAChD,MAAMC,OAAoB,GAAG,CAAC,CAAC;;IAE/B;IACA,KAAK,MAAM,CAACzB,IAAI,EAAE8B,KAAK,CAAC,IAAIH,MAAM,CAACI,OAAO,CACxC,IAAI,CAACR,oBAAoB,CAACC,KAAK,CACjC,CAAC,EAAE;MACD,MAAMd,GAAG,GAAGV,IAAI,CAACc,KAAK,CAAC,IAAI,CAAC,CAACkB,GAAG,CAAC,CAAC;MAClC,IAAI,CAACtB,GAAG,EAAE;QACR;MACF;MAEAe,OAAO,CAACf,GAAG,CAAC,GAAGoB,KAAK;IACtB;IAEA,OAAOL,OAAO;EAChB;EAEAQ,qBAAqBA,CAACR,OAAoB,EAAE;IAC1C,MAAMD,KAAgB,GAAG,CAAC,CAAC;IAE3B,IAAI,CAACzC,MAAM,CAAC2C,OAAO,CAAEhC,SAAS,IAAK;MACjCiC,MAAM,CAACC,MAAM,CAACJ,KAAK,EAAE9B,SAAS,CAACuC,qBAAqB,CAACR,OAAO,CAAC,CAAC;IAChE,CAAC,CAAC;IAEF,OAAOD,KAAK;EACd;EAEAU,wBAAwBA,CAACV,KAA0B,EAAE;IACnD,MAAMW,OAAkB,GAAG,CAAC,CAAC;IAE7B,KAAK,MAAMzC,SAAS,IAAI,IAAI,CAACX,MAAM,EAAE;MACnCoD,OAAO,CAACzC,SAAS,CAACM,IAAI,CAAC,GAAGN,SAAS,CAACwC,wBAAwB,CAACV,KAAK,CAAC;IACrE;IAEA,OAAOW,OAAO;EAChB;;EAEA;AACF;AACA;EACE3D,SAASA,CAAC4B,MAA8B,EAAqC;IAC3E,OAAO,IAAI,CAACgC,cAAc,CAAEtC,KAAK,IAAKA,KAAK,CAACtB,SAAS,CAAC4B,MAAM,CAAC,EAAEA,MAAM,CAAC;EACxE;;EAEA;AACF;AACA;AACA;AACA;EACEiC,aAAaA,CACXjC,MAA8B,EACK;IACnC,OAAO,IAAI,CAACgC,cAAc,CAAEtC,KAAK,IAAKA,KAAK,CAACuC,aAAa,CAACjC,MAAM,CAAC,EAAEA,MAAM,CAAC;EAC5E;EAEAkC,YAAYA,CACVb,OAAoB,EACpBrB,MAA8B,EAC9BmC,KAAgB,GAAG,CAAC,CAAC,EACrB;IACA,MAAM;MAAEzD;IAAW,CAAC,GAAG,IAAI;IAE3B,MAAM0D,MAA4B,GAAG1D,UAAU,CAACS,GAAG,CAAEG,SAAS,IAAK;MACjE,MAAM;QAAEC,eAAe;QAAE8C;MAAK,CAAC,GAAG/C,SAAS;MAE3C,MAAMgD,KAAK,GACThD,SAAS,YAAYtB,aAAa,GAC9BsB,SAAS,CAAC4C,YAAY,CAACb,OAAO,EAAErB,MAAM,EAAEmC,KAAK,CAAC,GAC9C7C,SAAS,CAAC4C,YAAY,CAAC,CAAC;MAE9B,OAAO;QAAEG,IAAI;QAAE9C,eAAe;QAAE+C;MAAM,CAAC;IACzC,CAAC,CAAC;IAEF,OAAOF,MAAM;EACf;;EAEA;AACF;AACA;EACEG,QAAQA,CAACb,KAAkB,GAAG,CAAC,CAAC,EAAqC;IACnE,MAAMU,MAAM,GAAG,IAAI,CAACvD,UAAU,CAAC0D,QAAQ,CAACb,KAAK,EAAEpD,IAAI,CAAC;IAEpD,MAAMkE,OAAO,GAAGJ,MAAM,CAACrC,KAAK,EAAEyC,OAAO;IAErC,OAAO;MACLd,KAAK,EAAGU,MAAM,CAACV,KAAK,IAAI,CAAC,CAAkB;MAC3C1B,MAAM,EAAE,IAAI,CAACxB,IAAI,EAAEJ,SAAS,CAACoE,OAAO,CAAC,IAAIpE,SAAS,CAACoE,OAAO;IAC5D,CAAC;EACH;;EAEA;AACF;AACA;EACUR,cAAcA,CACpBS,QAA6D,EAC7DzC,MAA8B,EACK;IACnC,MAAM;MAAErB;IAAO,CAAC,GAAG,IAAI;IAEvB,IAAI,CAACqB,MAAM,EAAEc,MAAM,EAAE;MACnB;IACF;IAEA,MAAM4B,IAA2B,GAAG,EAAE;IAEtC,KAAK,MAAMhD,KAAK,IAAIf,MAAM,EAAE;MAC1B,MAAMgE,WAAW,GAAGF,QAAQ,CAAC/C,KAAK,CAAC;MAEnC,IAAIiD,WAAW,EAAE7B,MAAM,EAAE;QACvB4B,IAAI,CAACE,IAAI,CAAC,GAAGD,WAAW,CAAC;MAC3B;IACF;IAEA,IAAI,CAACD,IAAI,CAAC5B,MAAM,EAAE;MAChB;IACF;IAEA,OAAO4B,IAAI;EACb;AACF;;AAEA;AACA;AACA;AACA,OAAO,SAASxC,cAAcA,CAC5BwB,KAAe,EAC0B;EACzC,OAAOzD,WAAW,CAACyD,KAAK,CAAC,IAAI,OAAOA,KAAK,CAACb,KAAK,KAAK,QAAQ;AAC9D","ignoreList":[]}

package/.server/server/plugins/engine/components/DeclarationField.d.ts

@@ -0,0 +1,81 @@
+import { type DeclarationFieldComponent, type Item } from '@defra/forms-model';
+import { type ArraySchema, type BooleanSchema, type StringSchema } from 'joi';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState, type FormValue } from '~/src/server/plugins/engine/types.js';
+export declare class DeclarationField extends FormComponent {
+    private readonly DEFAULT_DECLARATION_LABEL;
+    options: DeclarationFieldComponent['options'];
+    declarationConfirmationLabel: string;
+    formSchema: ArraySchema<StringSchema[]>;
+    stateSchema: BooleanSchema;
+    content: string;
+    constructor(def: DeclarationFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): "true" | undefined;
+    getFormDataFromState(state: FormSubmissionState): FormPayload;
+    getStateFromValidForm(payload: FormPayload): FormState;
+    getContextValueFromFormValue(value: FormValue | FormPayload): boolean;
+    getFormValue(value?: FormStateValue | FormState): (string | number | boolean)[] | undefined;
+    getDisplayStringFromFormValue(value: FormValue | FormPayload): string;
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        hint: {
+            text: string;
+        } | undefined;
+        fieldset: {
+            legend: {
+                text: string;
+            };
+        };
+        content: string;
+        values: FormValue;
+        items: {
+            text: string;
+            value: string;
+        }[];
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: FormValue;
+        type?: string;
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("./types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    isValue(value?: FormStateValue | FormState): value is Item['value'][];
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    /**
+     * Static version of getAllPossibleErrors that doesn't require a component instance.
+     */
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isBool(value?: FormStateValue | FormState): value is boolean;
+}

package/.server/server/plugins/engine/components/DeclarationField.js

@@ -0,0 +1,123 @@
+import joi from 'joi';
+import { FormComponent, isFormValue } from "./FormComponent.js";
+import { messageTemplate } from "../pageControllers/validationOptions.js";
+export class DeclarationField extends FormComponent {
+  DEFAULT_DECLARATION_LABEL = 'I understand and agree';
+  constructor(def, props) {
+    super(def, props);
+    const {
+      options,
+      content
+    } = def;
+    let checkboxSchema = joi.string().valid('true');
+    if (options.required !== false) {
+      checkboxSchema = checkboxSchema.required();
+    }
+    const formSchema = joi.array().items(checkboxSchema, joi.string().valid('unchecked').strip()).label(this.label).single().messages({
+      'any.required': messageTemplate.declarationRequired,
+      'any.unknown': messageTemplate.declarationRequired,
+      'array.includesRequiredUnknowns': messageTemplate.declarationRequired
+    });
+    this.formSchema = formSchema;
+    this.stateSchema = joi.boolean().cast('string').label(this.label).required();
+    this.options = options;
+    this.content = content;
+    this.declarationConfirmationLabel = options.declarationConfirmationLabel ?? this.DEFAULT_DECLARATION_LABEL;
+  }
+  getFormValueFromState(state) {
+    const {
+      name
+    } = this;
+    return state[name] === true ? 'true' : undefined;
+  }
+  getFormDataFromState(state) {
+    const {
+      name
+    } = this;
+    return {
+      [name]: state[name] === true ? 'true' : undefined
+    };
+  }
+  getStateFromValidForm(payload) {
+    const {
+      name
+    } = this;
+    const payloadValue = payload[name];
+    const value = this.isValue(payloadValue) && payloadValue.length > 0 && payloadValue.every(v => {
+      return v === 'true';
+    });
+    return {
+      [name]: value
+    };
+  }
+  getContextValueFromFormValue(value) {
+    return value === 'true';
+  }
+  getFormValue(value) {
+    return this.isValue(value) ? value : undefined;
+  }
+  getDisplayStringFromFormValue(value) {
+    return value ? this.declarationConfirmationLabel : '';
+  }
+  getViewModel(payload, errors) {
+    const defaultDeclarationConfirmationLabel = 'I confirm that I understand and accept this declaration';
+    const {
+      title,
+      hint,
+      content,
+      declarationConfirmationLabel = defaultDeclarationConfirmationLabel
+    } = this;
+    return {
+      ...super.getViewModel(payload, errors),
+      hint: hint ? {
+        text: hint
+      } : undefined,
+      fieldset: {
+        legend: {
+          text: title
+        }
+      },
+      content,
+      values: payload[this.name],
+      items: [{
+        text: declarationConfirmationLabel,
+        value: 'true'
+      }]
+    };
+  }
+  isValue(value) {
+    if (!Array.isArray(value)) {
+      return false;
+    }
+
+    // Skip checks when empty
+    if (!value.length) {
+      return true;
+    }
+    return value.every(isFormValue);
+  }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors() {
+    return DeclarationField.getAllPossibleErrors();
+  }
+
+  /**
+   * Static version of getAllPossibleErrors that doesn't require a component instance.
+   */
+  static getAllPossibleErrors() {
+    return {
+      baseErrors: [{
+        type: 'required',
+        template: messageTemplate.declarationRequired
+      }],
+      advancedSettingsErrors: []
+    };
+  }
+  static isBool(value) {
+    return isFormValue(value) && typeof value === 'boolean';
+  }
+}
+//# sourceMappingURL=DeclarationField.js.map

package/.server/server/plugins/engine/components/DeclarationField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclarationField.js","names":["joi","FormComponent","isFormValue","messageTemplate","DeclarationField","DEFAULT_DECLARATION_LABEL","constructor","def","props","options","content","checkboxSchema","string","valid","required","formSchema","array","items","strip","label","single","messages","declarationRequired","stateSchema","boolean","cast","declarationConfirmationLabel","getFormValueFromState","state","name","undefined","getFormDataFromState","getStateFromValidForm","payload","payloadValue","value","isValue","length","every","v","getContextValueFromFormValue","getFormValue","getDisplayStringFromFormValue","getViewModel","errors","defaultDeclarationConfirmationLabel","title","hint","text","fieldset","legend","values","Array","isArray","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","isBool"],"sources":["../../../../../src/server/plugins/engine/components/DeclarationField.ts"],"sourcesContent":["import { type DeclarationFieldComponent, type Item } from '@defra/forms-model'\nimport joi, {\n  type ArraySchema,\n  type BooleanSchema,\n  type StringSchema\n} from 'joi'\n\nimport {\n  FormComponent,\n  isFormValue\n} from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport class DeclarationField extends FormComponent {\n  private readonly DEFAULT_DECLARATION_LABEL = 'I understand and agree'\n\n  declare options: DeclarationFieldComponent['options']\n\n  declare declarationConfirmationLabel: string\n\n  declare formSchema: ArraySchema<StringSchema[]>\n  declare stateSchema: BooleanSchema\n  declare content: string\n\n  constructor(\n    def: DeclarationFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    const { options, content } = def\n\n    let checkboxSchema = joi.string().valid('true')\n\n    if (options.required !== false) {\n      checkboxSchema = checkboxSchema.required()\n    }\n\n    const formSchema = joi\n      .array()\n      .items(checkboxSchema, joi.string().valid('unchecked').strip())\n      .label(this.label)\n      .single()\n      .messages({\n        'any.required': messageTemplate.declarationRequired as string,\n        'any.unknown': messageTemplate.declarationRequired as string,\n        'array.includesRequiredUnknowns':\n          messageTemplate.declarationRequired as string\n      }) as ArraySchema<StringSchema[]>\n\n    this.formSchema = formSchema\n    this.stateSchema = joi.boolean().cast('string').label(this.label).required()\n\n    this.options = options\n    this.content = content\n    this.declarationConfirmationLabel =\n      options.declarationConfirmationLabel ?? this.DEFAULT_DECLARATION_LABEL\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return state[name] === true ? 'true' : undefined\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { name } = this\n    return { [name]: state[name] === true ? 'true' : undefined }\n  }\n\n  getStateFromValidForm(payload: FormPayload): FormState {\n    const { name } = this\n    const payloadValue = payload[name]\n    const value =\n      this.isValue(payloadValue) &&\n      payloadValue.length > 0 &&\n      payloadValue.every((v) => {\n        return v === 'true'\n      })\n\n    return { [name]: value }\n  }\n\n  getContextValueFromFormValue(value: FormValue | FormPayload): boolean {\n    return value === 'true'\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isValue(value) ? value : undefined\n  }\n\n  getDisplayStringFromFormValue(value: FormValue | FormPayload): string {\n    return value ? this.declarationConfirmationLabel : ''\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const defaultDeclarationConfirmationLabel =\n      'I confirm that I understand and accept this declaration'\n    const {\n      title,\n      hint,\n      content,\n      declarationConfirmationLabel = defaultDeclarationConfirmationLabel\n    } = this\n    return {\n      ...super.getViewModel(payload, errors),\n      hint: hint ? { text: hint } : undefined,\n      fieldset: {\n        legend: {\n          text: title\n        }\n      },\n      content,\n      values: payload[this.name],\n      items: [\n        {\n          text: declarationConfirmationLabel,\n          value: 'true'\n        }\n      ]\n    }\n  }\n\n  isValue(value?: FormStateValue | FormState): value is Item['value'][] {\n    if (!Array.isArray(value)) {\n      return false\n    }\n\n    // Skip checks when empty\n    if (!value.length) {\n      return true\n    }\n\n    return value.every(isFormValue)\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return DeclarationField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        { type: 'required', template: messageTemplate.declarationRequired }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  static isBool(value?: FormStateValue | FormState): value is boolean {\n    return isFormValue(value) && typeof value === 'boolean'\n  }\n}\n"],"mappings":"AACA,OAAOA,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAWxB,OAAO,MAAMC,gBAAgB,SAASH,aAAa,CAAC;EACjCI,yBAAyB,GAAG,wBAAwB;EAUrEC,WAAWA,CACTC,GAA8B,EAC9BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,MAAM;MAAEC,OAAO;MAAEC;IAAQ,CAAC,GAAGH,GAAG;IAEhC,IAAII,cAAc,GAAGX,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,MAAM,CAAC;IAE/C,IAAIJ,OAAO,CAACK,QAAQ,KAAK,KAAK,EAAE;MAC9BH,cAAc,GAAGA,cAAc,CAACG,QAAQ,CAAC,CAAC;IAC5C;IAEA,MAAMC,UAAU,GAAGf,GAAG,CACnBgB,KAAK,CAAC,CAAC,CACPC,KAAK,CAACN,cAAc,EAAEX,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,WAAW,CAAC,CAACK,KAAK,CAAC,CAAC,CAAC,CAC9DC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CACjBC,MAAM,CAAC,CAAC,CACRC,QAAQ,CAAC;MACR,cAAc,EAAElB,eAAe,CAACmB,mBAA6B;MAC7D,aAAa,EAAEnB,eAAe,CAACmB,mBAA6B;MAC5D,gCAAgC,EAC9BnB,eAAe,CAACmB;IACpB,CAAC,CAAgC;IAEnC,IAAI,CAACP,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACQ,WAAW,GAAGvB,GAAG,CAACwB,OAAO,CAAC,CAAC,CAACC,IAAI,CAAC,QAAQ,CAAC,CAACN,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC,CAACL,QAAQ,CAAC,CAAC;IAE5E,IAAI,CAACL,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACgB,4BAA4B,GAC/BjB,OAAO,CAACiB,4BAA4B,IAAI,IAAI,CAACrB,yBAAyB;EAC1E;EAEAsB,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAOD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAGC,SAAS;EAClD;EAEAC,oBAAoBA,CAACH,KAA0B,EAAe;IAC5D,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO;MAAE,CAACA,IAAI,GAAGD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAGC;IAAU,CAAC;EAC9D;EAEAE,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEJ;IAAK,CAAC,GAAG,IAAI;IACrB,MAAMK,YAAY,GAAGD,OAAO,CAACJ,IAAI,CAAC;IAClC,MAAMM,KAAK,GACT,IAAI,CAACC,OAAO,CAACF,YAAY,CAAC,IAC1BA,YAAY,CAACG,MAAM,GAAG,CAAC,IACvBH,YAAY,CAACI,KAAK,CAAEC,CAAC,IAAK;MACxB,OAAOA,CAAC,KAAK,MAAM;IACrB,CAAC,CAAC;IAEJ,OAAO;MAAE,CAACV,IAAI,GAAGM;IAAM,CAAC;EAC1B;EAEAK,4BAA4BA,CAACL,KAA8B,EAAW;IACpE,OAAOA,KAAK,KAAK,MAAM;EACzB;EAEAM,YAAYA,CAACN,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGL,SAAS;EAChD;EAEAY,6BAA6BA,CAACP,KAA8B,EAAU;IACpE,OAAOA,KAAK,GAAG,IAAI,CAACT,4BAA4B,GAAG,EAAE;EACvD;EAEAiB,YAAYA,CAACV,OAAoB,EAAEW,MAA8B,EAAE;IACjE,MAAMC,mCAAmC,GACvC,yDAAyD;IAC3D,MAAM;MACJC,KAAK;MACLC,IAAI;MACJrC,OAAO;MACPgB,4BAA4B,GAAGmB;IACjC,CAAC,GAAG,IAAI;IACR,OAAO;MACL,GAAG,KAAK,CAACF,YAAY,CAACV,OAAO,EAAEW,MAAM,CAAC;MACtCG,IAAI,EAAEA,IAAI,GAAG;QAAEC,IAAI,EAAED;MAAK,CAAC,GAAGjB,SAAS;MACvCmB,QAAQ,EAAE;QACRC,MAAM,EAAE;UACNF,IAAI,EAAEF;QACR;MACF,CAAC;MACDpC,OAAO;MACPyC,MAAM,EAAElB,OAAO,CAAC,IAAI,CAACJ,IAAI,CAAC;MAC1BZ,KAAK,EAAE,CACL;QACE+B,IAAI,EAAEtB,4BAA4B;QAClCS,KAAK,EAAE;MACT,CAAC;IAEL,CAAC;EACH;EAEAC,OAAOA,CAACD,KAAkC,EAA4B;IACpE,IAAI,CAACiB,KAAK,CAACC,OAAO,CAAClB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACE,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOF,KAAK,CAACG,KAAK,CAACpC,WAAW,CAAC;EACjC;;EAEA;AACF;AACA;EACEoD,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOlD,gBAAgB,CAACkD,oBAAoB,CAAC,CAAC;EAChD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEC,IAAI,EAAE,UAAU;QAAEC,QAAQ,EAAEtD,eAAe,CAACmB;MAAoB,CAAC,CACpE;MACDoC,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOC,MAAMA,CAACxB,KAAkC,EAAoB;IAClE,OAAOjC,WAAW,CAACiC,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,SAAS;EACzD;AACF","ignoreList":[]}

package/.server/server/plugins/engine/components/EastingNorthingField.d.ts

@@ -0,0 +1,121 @@
+import { type EastingNorthingFieldComponent } from '@defra/forms-model';
+import { type ObjectSchema } from 'joi';
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type EastingNorthingState } from '~/src/server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+export declare class EastingNorthingField extends FormComponent {
+    options: EastingNorthingFieldComponent['options'];
+    formSchema: ObjectSchema<FormPayload>;
+    stateSchema: ObjectSchema<FormState>;
+    collection: ComponentCollection;
+    constructor(def: EastingNorthingFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): EastingNorthingState | undefined;
+    getDisplayStringFromFormValue(value: EastingNorthingState | undefined): string;
+    getDisplayStringFromState(state: FormSubmissionState): string;
+    getContextValueFromFormValue(value: EastingNorthingState | undefined): string | null;
+    getContextValueFromState(state: FormSubmissionState): string | null;
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        fieldset: {
+            attributes?: string | Record<string, string>;
+            legend?: import("~/src/server/plugins/engine/components/types.js").Label;
+        };
+        items: import("~/src/server/plugins/engine/components/types.js").DateInputItem[];
+        label: import("~/src/server/plugins/engine/components/types.js").Label;
+        type?: string;
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        suffix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("~/src/server/plugins/engine/components/types.js").Content | import("~/src/server/plugins/engine/components/types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    } | {
+        instructionText: string;
+        fieldset: {
+            attributes?: string | Record<string, string>;
+            legend?: import("~/src/server/plugins/engine/components/types.js").Label;
+        };
+        items: import("~/src/server/plugins/engine/components/types.js").DateInputItem[];
+        label: import("~/src/server/plugins/engine/components/types.js").Label;
+        type?: string;
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        suffix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("~/src/server/plugins/engine/components/types.js").Content | import("~/src/server/plugins/engine/components/types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    isState(value?: FormStateValue | FormState): value is EastingNorthingState;
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    /**
+     * Static version of getAllPossibleErrors that doesn't require a component instance.
+     */
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isEastingNorthing(value?: FormStateValue | FormState): value is EastingNorthingState;
+}
+export declare function getValidatorEastingNorthing(component: EastingNorthingField): import("joi").CustomValidator;