@defra/forms-engine-plugin 4.0.35 → 4.0.37

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

@@ -83,7 +83,8 @@ export class DeclarationField extends FormComponent {
         classes: 'govuk-fieldset__legend--m'
       }
     };
-    const isChecked = payload[this.name] === 'true' || payload[this.name] === true;
+    const payloadValue = payload[this.name];
+    const isChecked = payloadValue === 'true' || payloadValue === true || Array.isArray(payloadValue) && payloadValue.some(x => x === 'true');
     return {
       ...viewModel,
       hint: hint ? {

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

@@ -1 +1 @@
-{"version":3,"file":"DeclarationField.js","names":["ComponentType","hasFormComponents","isFormType","joi","FormComponent","isFormValue","messageTemplate","DeclarationField","DEFAULT_DECLARATION_LABEL","headerStartLevel","constructor","def","props","options","content","checkboxSchema","string","valid","required","formSchema","array","items","strip","label","single","messages","declarationRequired","stateSchema","boolean","cast","declarationConfirmationLabel","formComponents","page","pageDef","components","numOfQuestionsOnPage","filter","q","type","length","hasGuidance","some","comp","idx","Markdown","getFormValueFromState","state","name","getFormDataFromState","getStateFromValidForm","payload","payloadValue","value","isValue","every","v","getContextValueFromFormValue","getFormValue","undefined","getDisplayStringFromFormValue","getViewModel","errors","defaultDeclarationConfirmationLabel","hint","viewModel","fieldset","legend","text","classes","isChecked","checked","Array","isArray","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isBool"],"sources":["../../../../../src/server/plugins/engine/components/DeclarationField.ts"],"sourcesContent":["import {\n  ComponentType,\n  hasFormComponents,\n  isFormType,\n  type DeclarationFieldComponent,\n  type Item\n} 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  headerStartLevel: number\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    const formComponents = hasFormComponents(props.page?.pageDef)\n      ? props.page.pageDef.components\n      : []\n    const numOfQuestionsOnPage = formComponents.filter((q) =>\n      isFormType(q.type)\n    ).length\n    const hasGuidance = formComponents.some(\n      (comp, idx) => comp.type === ComponentType.Markdown && idx === 0\n    )\n    this.headerStartLevel = numOfQuestionsOnPage < 2 && !hasGuidance ? 2 : 3\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return state[name] === true ? 'true' : 'false'\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { name } = this\n    return { [name]: state[name] === true ? 'true' : 'false' }\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 === 'true' ? this.declarationConfirmationLabel : 'Not provided'\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const defaultDeclarationConfirmationLabel =\n      'I confirm that I understand and accept this declaration'\n    const {\n      hint,\n      content,\n      declarationConfirmationLabel = defaultDeclarationConfirmationLabel\n    } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    const isChecked =\n      payload[this.name] === 'true' || payload[this.name] === true\n    return {\n      ...viewModel,\n      hint: hint ? { text: hint } : undefined,\n      fieldset,\n      content,\n      items: [\n        {\n          text: declarationConfirmationLabel,\n          value: 'true',\n          checked: isChecked\n        }\n      ],\n      headerStartLevel: this.headerStartLevel\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":"AAAA,SACEA,aAAa,EACbC,iBAAiB,EACjBC,UAAU,QAGL,oBAAoB;AAC3B,OAAOC,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAWxB,OAAO,MAAMC,gBAAgB,SAASH,aAAa,CAAC;EACjCI,yBAAyB,GAAG,wBAAwB;EASrEC,gBAAgB;EAEhBC,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,GAAGZ,GAAG,CAACa,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,GAAGhB,GAAG,CACnBiB,KAAK,CAAC,CAAC,CACPC,KAAK,CAACN,cAAc,EAAEZ,GAAG,CAACa,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,EAAEnB,eAAe,CAACoB,mBAA6B;MAC7D,aAAa,EAAEpB,eAAe,CAACoB,mBAA6B;MAC5D,gCAAgC,EAC9BpB,eAAe,CAACoB;IACpB,CAAC,CAAgC;IAEnC,IAAI,CAACP,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACQ,WAAW,GAAGxB,GAAG,CAACyB,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,CAACtB,yBAAyB;IACxE,MAAMuB,cAAc,GAAG9B,iBAAiB,CAACW,KAAK,CAACoB,IAAI,EAAEC,OAAO,CAAC,GACzDrB,KAAK,CAACoB,IAAI,CAACC,OAAO,CAACC,UAAU,GAC7B,EAAE;IACN,MAAMC,oBAAoB,GAAGJ,cAAc,CAACK,MAAM,CAAEC,CAAC,IACnDnC,UAAU,CAACmC,CAAC,CAACC,IAAI,CACnB,CAAC,CAACC,MAAM;IACR,MAAMC,WAAW,GAAGT,cAAc,CAACU,IAAI,CACrC,CAACC,IAAI,EAAEC,GAAG,KAAKD,IAAI,CAACJ,IAAI,KAAKtC,aAAa,CAAC4C,QAAQ,IAAID,GAAG,KAAK,CACjE,CAAC;IACD,IAAI,CAAClC,gBAAgB,GAAG0B,oBAAoB,GAAG,CAAC,IAAI,CAACK,WAAW,GAAG,CAAC,GAAG,CAAC;EAC1E;EAEAK,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAOD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG,OAAO;EAChD;EAEAC,oBAAoBA,CAACF,KAA0B,EAAe;IAC5D,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO;MAAE,CAACA,IAAI,GAAGD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG;IAAQ,CAAC;EAC5D;EAEAE,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEH;IAAK,CAAC,GAAG,IAAI;IACrB,MAAMI,YAAY,GAAGD,OAAO,CAACH,IAAI,CAAC;IAClC,MAAMK,KAAK,GACT,IAAI,CAACC,OAAO,CAACF,YAAY,CAAC,IAC1BA,YAAY,CAACZ,MAAM,GAAG,CAAC,IACvBY,YAAY,CAACG,KAAK,CAAEC,CAAC,IAAK;MACxB,OAAOA,CAAC,KAAK,MAAM;IACrB,CAAC,CAAC;IAEJ,OAAO;MAAE,CAACR,IAAI,GAAGK;IAAM,CAAC;EAC1B;EAEAI,4BAA4BA,CAACJ,KAA8B,EAAW;IACpE,OAAOA,KAAK,KAAK,MAAM;EACzB;EAEAK,YAAYA,CAACL,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGM,SAAS;EAChD;EAEAC,6BAA6BA,CAACP,KAA8B,EAAU;IACpE,OAAOA,KAAK,KAAK,MAAM,GAAG,IAAI,CAACtB,4BAA4B,GAAG,cAAc;EAC9E;EAEA8B,YAAYA,CAACV,OAAoB,EAAEW,MAA8B,EAAE;IACjE,MAAMC,mCAAmC,GACvC,yDAAyD;IAC3D,MAAM;MACJC,IAAI;MACJjD,OAAO;MACPgB,4BAA4B,GAAGgC;IACjC,CAAC,GAAG,IAAI;IAER,MAAME,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACV,OAAO,EAAEW,MAAM,CAAC;IACrD,IAAI;MAAEI,QAAQ;MAAE1C;IAAM,CAAC,GAAGyC,SAAS;IAEnCC,QAAQ,KAAK;MACXC,MAAM,EAAE;QACNC,IAAI,EAAE5C,KAAK,CAAC4C,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAED,MAAMC,SAAS,GACbnB,OAAO,CAAC,IAAI,CAACH,IAAI,CAAC,KAAK,MAAM,IAAIG,OAAO,CAAC,IAAI,CAACH,IAAI,CAAC,KAAK,IAAI;IAC9D,OAAO;MACL,GAAGiB,SAAS;MACZD,IAAI,EAAEA,IAAI,GAAG;QAAEI,IAAI,EAAEJ;MAAK,CAAC,GAAGL,SAAS;MACvCO,QAAQ;MACRnD,OAAO;MACPO,KAAK,EAAE,CACL;QACE8C,IAAI,EAAErC,4BAA4B;QAClCsB,KAAK,EAAE,MAAM;QACbkB,OAAO,EAAED;MACX,CAAC,CACF;MACD5D,gBAAgB,EAAE,IAAI,CAACA;IACzB,CAAC;EACH;EAEA4C,OAAOA,CAACD,KAAkC,EAA4B;IACpE,IAAI,CAACmB,KAAK,CAACC,OAAO,CAACpB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACb,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOa,KAAK,CAACE,KAAK,CAACjD,WAAW,CAAC;EACjC;;EAEA;AACF;AACA;EACEoE,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOlE,gBAAgB,CAACkE,oBAAoB,CAAC,CAAC;EAChD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAEpC,IAAI,EAAE,UAAU;QAAEqC,QAAQ,EAAErE,eAAe,CAACoB;MAAoB,CAAC,CACpE;MACDkD,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOC,MAAMA,CAACzB,KAAkC,EAAoB;IAClE,OAAO/C,WAAW,CAAC+C,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,SAAS;EACzD;AACF","ignoreList":[]}
+{"version":3,"file":"DeclarationField.js","names":["ComponentType","hasFormComponents","isFormType","joi","FormComponent","isFormValue","messageTemplate","DeclarationField","DEFAULT_DECLARATION_LABEL","headerStartLevel","constructor","def","props","options","content","checkboxSchema","string","valid","required","formSchema","array","items","strip","label","single","messages","declarationRequired","stateSchema","boolean","cast","declarationConfirmationLabel","formComponents","page","pageDef","components","numOfQuestionsOnPage","filter","q","type","length","hasGuidance","some","comp","idx","Markdown","getFormValueFromState","state","name","getFormDataFromState","getStateFromValidForm","payload","payloadValue","value","isValue","every","v","getContextValueFromFormValue","getFormValue","undefined","getDisplayStringFromFormValue","getViewModel","errors","defaultDeclarationConfirmationLabel","hint","viewModel","fieldset","legend","text","classes","isChecked","Array","isArray","x","checked","getAllPossibleErrors","baseErrors","template","advancedSettingsErrors","isBool"],"sources":["../../../../../src/server/plugins/engine/components/DeclarationField.ts"],"sourcesContent":["import {\n  ComponentType,\n  hasFormComponents,\n  isFormType,\n  type DeclarationFieldComponent,\n  type Item\n} 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  headerStartLevel: number\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    const formComponents = hasFormComponents(props.page?.pageDef)\n      ? props.page.pageDef.components\n      : []\n    const numOfQuestionsOnPage = formComponents.filter((q) =>\n      isFormType(q.type)\n    ).length\n    const hasGuidance = formComponents.some(\n      (comp, idx) => comp.type === ComponentType.Markdown && idx === 0\n    )\n    this.headerStartLevel = numOfQuestionsOnPage < 2 && !hasGuidance ? 2 : 3\n  }\n\n  getFormValueFromState(state: FormSubmissionState) {\n    const { name } = this\n    return state[name] === true ? 'true' : 'false'\n  }\n\n  getFormDataFromState(state: FormSubmissionState): FormPayload {\n    const { name } = this\n    return { [name]: state[name] === true ? 'true' : 'false' }\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 === 'true' ? this.declarationConfirmationLabel : 'Not provided'\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const defaultDeclarationConfirmationLabel =\n      'I confirm that I understand and accept this declaration'\n    const {\n      hint,\n      content,\n      declarationConfirmationLabel = defaultDeclarationConfirmationLabel\n    } = this\n\n    const viewModel = super.getViewModel(payload, errors)\n    let { fieldset, label } = viewModel\n\n    fieldset ??= {\n      legend: {\n        text: label.text,\n        classes: 'govuk-fieldset__legend--m'\n      }\n    }\n\n    const payloadValue = payload[this.name]\n    const isChecked =\n      payloadValue === 'true' ||\n      payloadValue === true ||\n      (Array.isArray(payloadValue) && payloadValue.some((x) => x === 'true'))\n\n    return {\n      ...viewModel,\n      hint: hint ? { text: hint } : undefined,\n      fieldset,\n      content,\n      items: [\n        {\n          text: declarationConfirmationLabel,\n          value: 'true',\n          checked: isChecked\n        }\n      ],\n      headerStartLevel: this.headerStartLevel\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":"AAAA,SACEA,aAAa,EACbC,iBAAiB,EACjBC,UAAU,QAGL,oBAAoB;AAC3B,OAAOC,GAAG,MAIH,KAAK;AAEZ,SACEC,aAAa,EACbC,WAAW;AAEb,SAASC,eAAe;AAWxB,OAAO,MAAMC,gBAAgB,SAASH,aAAa,CAAC;EACjCI,yBAAyB,GAAG,wBAAwB;EASrEC,gBAAgB;EAEhBC,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,GAAGZ,GAAG,CAACa,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,GAAGhB,GAAG,CACnBiB,KAAK,CAAC,CAAC,CACPC,KAAK,CAACN,cAAc,EAAEZ,GAAG,CAACa,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,EAAEnB,eAAe,CAACoB,mBAA6B;MAC7D,aAAa,EAAEpB,eAAe,CAACoB,mBAA6B;MAC5D,gCAAgC,EAC9BpB,eAAe,CAACoB;IACpB,CAAC,CAAgC;IAEnC,IAAI,CAACP,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACQ,WAAW,GAAGxB,GAAG,CAACyB,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,CAACtB,yBAAyB;IACxE,MAAMuB,cAAc,GAAG9B,iBAAiB,CAACW,KAAK,CAACoB,IAAI,EAAEC,OAAO,CAAC,GACzDrB,KAAK,CAACoB,IAAI,CAACC,OAAO,CAACC,UAAU,GAC7B,EAAE;IACN,MAAMC,oBAAoB,GAAGJ,cAAc,CAACK,MAAM,CAAEC,CAAC,IACnDnC,UAAU,CAACmC,CAAC,CAACC,IAAI,CACnB,CAAC,CAACC,MAAM;IACR,MAAMC,WAAW,GAAGT,cAAc,CAACU,IAAI,CACrC,CAACC,IAAI,EAAEC,GAAG,KAAKD,IAAI,CAACJ,IAAI,KAAKtC,aAAa,CAAC4C,QAAQ,IAAID,GAAG,KAAK,CACjE,CAAC;IACD,IAAI,CAAClC,gBAAgB,GAAG0B,oBAAoB,GAAG,CAAC,IAAI,CAACK,WAAW,GAAG,CAAC,GAAG,CAAC;EAC1E;EAEAK,qBAAqBA,CAACC,KAA0B,EAAE;IAChD,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAOD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG,OAAO;EAChD;EAEAC,oBAAoBA,CAACF,KAA0B,EAAe;IAC5D,MAAM;MAAEC;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO;MAAE,CAACA,IAAI,GAAGD,KAAK,CAACC,IAAI,CAAC,KAAK,IAAI,GAAG,MAAM,GAAG;IAAQ,CAAC;EAC5D;EAEAE,qBAAqBA,CAACC,OAAoB,EAAa;IACrD,MAAM;MAAEH;IAAK,CAAC,GAAG,IAAI;IACrB,MAAMI,YAAY,GAAGD,OAAO,CAACH,IAAI,CAAC;IAClC,MAAMK,KAAK,GACT,IAAI,CAACC,OAAO,CAACF,YAAY,CAAC,IAC1BA,YAAY,CAACZ,MAAM,GAAG,CAAC,IACvBY,YAAY,CAACG,KAAK,CAAEC,CAAC,IAAK;MACxB,OAAOA,CAAC,KAAK,MAAM;IACrB,CAAC,CAAC;IAEJ,OAAO;MAAE,CAACR,IAAI,GAAGK;IAAM,CAAC;EAC1B;EAEAI,4BAA4BA,CAACJ,KAA8B,EAAW;IACpE,OAAOA,KAAK,KAAK,MAAM;EACzB;EAEAK,YAAYA,CAACL,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACC,OAAO,CAACD,KAAK,CAAC,GAAGA,KAAK,GAAGM,SAAS;EAChD;EAEAC,6BAA6BA,CAACP,KAA8B,EAAU;IACpE,OAAOA,KAAK,KAAK,MAAM,GAAG,IAAI,CAACtB,4BAA4B,GAAG,cAAc;EAC9E;EAEA8B,YAAYA,CAACV,OAAoB,EAAEW,MAA8B,EAAE;IACjE,MAAMC,mCAAmC,GACvC,yDAAyD;IAC3D,MAAM;MACJC,IAAI;MACJjD,OAAO;MACPgB,4BAA4B,GAAGgC;IACjC,CAAC,GAAG,IAAI;IAER,MAAME,SAAS,GAAG,KAAK,CAACJ,YAAY,CAACV,OAAO,EAAEW,MAAM,CAAC;IACrD,IAAI;MAAEI,QAAQ;MAAE1C;IAAM,CAAC,GAAGyC,SAAS;IAEnCC,QAAQ,KAAK;MACXC,MAAM,EAAE;QACNC,IAAI,EAAE5C,KAAK,CAAC4C,IAAI;QAChBC,OAAO,EAAE;MACX;IACF,CAAC;IAED,MAAMjB,YAAY,GAAGD,OAAO,CAAC,IAAI,CAACH,IAAI,CAAC;IACvC,MAAMsB,SAAS,GACblB,YAAY,KAAK,MAAM,IACvBA,YAAY,KAAK,IAAI,IACpBmB,KAAK,CAACC,OAAO,CAACpB,YAAY,CAAC,IAAIA,YAAY,CAACV,IAAI,CAAE+B,CAAC,IAAKA,CAAC,KAAK,MAAM,CAAE;IAEzE,OAAO;MACL,GAAGR,SAAS;MACZD,IAAI,EAAEA,IAAI,GAAG;QAAEI,IAAI,EAAEJ;MAAK,CAAC,GAAGL,SAAS;MACvCO,QAAQ;MACRnD,OAAO;MACPO,KAAK,EAAE,CACL;QACE8C,IAAI,EAAErC,4BAA4B;QAClCsB,KAAK,EAAE,MAAM;QACbqB,OAAO,EAAEJ;MACX,CAAC,CACF;MACD5D,gBAAgB,EAAE,IAAI,CAACA;IACzB,CAAC;EACH;EAEA4C,OAAOA,CAACD,KAAkC,EAA4B;IACpE,IAAI,CAACkB,KAAK,CAACC,OAAO,CAACnB,KAAK,CAAC,EAAE;MACzB,OAAO,KAAK;IACd;;IAEA;IACA,IAAI,CAACA,KAAK,CAACb,MAAM,EAAE;MACjB,OAAO,IAAI;IACb;IAEA,OAAOa,KAAK,CAACE,KAAK,CAACjD,WAAW,CAAC;EACjC;;EAEA;AACF;AACA;EACEqE,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOnE,gBAAgB,CAACmE,oBAAoB,CAAC,CAAC;EAChD;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QAAErC,IAAI,EAAE,UAAU;QAAEsC,QAAQ,EAAEtE,eAAe,CAACoB;MAAoB,CAAC,CACpE;MACDmD,sBAAsB,EAAE;IAC1B,CAAC;EACH;EAEA,OAAOC,MAAMA,CAAC1B,KAAkC,EAAoB;IAClE,OAAO/C,WAAW,CAAC+C,KAAK,CAAC,IAAI,OAAOA,KAAK,KAAK,SAAS;EACzD;AACF","ignoreList":[]}

package/.server/server/plugins/engine/components/helpers/index.d.ts

@@ -10,6 +10,11 @@ export declare const addClassOptionIfNone: (options: Extract<ComponentDef, {
         classes?: string;
     };
 }>["options"], className: string) => void;
+/**
+ * Applies lowerFirst but preserves capitalisation of proper nouns
+ * like "National Grid", "Ordnance Survey" and "OS".
+ */
+export declare function lowerFirstPreserveProperNouns(text: string): string;
 /**
  * Configuration for Joi expressions that use lowerFirst function
  */

package/.server/server/plugins/engine/components/helpers/index.js

@@ -16,12 +16,21 @@ export const addClassOptionIfNone = (options, className) => {
   options.classes ??= className;
 };
 
+/**
+ * Applies lowerFirst but preserves capitalisation of proper nouns
+ * like "National Grid", "Ordnance Survey" and "OS".
+ */
+export function lowerFirstPreserveProperNouns(text) {
+  const result = lowerFirst(text);
+  return result.replace(/\bnational [Gg]rid\b/g, 'National Grid').replace(/\bordnance [Ss]urvey\b/g, 'Ordnance Survey').replace(/\b[oO][sS]\b/g, 'OS');
+}
+
 /**
  * Configuration for Joi expressions that use lowerFirst function
  */
 export const lowerFirstExpressionOptions = {
   functions: {
-    lowerFirst
+    lowerFirst: lowerFirstPreserveProperNouns
   }
 };
 

package/.server/server/plugins/engine/components/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["joi","lowerFirst","escapeMarkdown","answer","punctuation","character","replaceAll","addClassOptionIfNone","options","className","classes","lowerFirstExpressionOptions","functions","createLowerFirstExpression","template","expression"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/index.ts"],"sourcesContent":["import { type ComponentDef } from '@defra/forms-model'\nimport joi, { type JoiExpression, type ReferenceOptions } from 'joi'\nimport lowerFirst from 'lodash/lowerFirst.js'\n\n/**\n * Prevent Markdown formatting\n * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}\n */\nexport function escapeMarkdown(answer: string) {\n  const punctuation = [\n    '`',\n    \"'\",\n    '*',\n    '_',\n    '{',\n    '}',\n    '[',\n    ']',\n    '(',\n    ')',\n    '#',\n    '+',\n    '-',\n    '.',\n    '!'\n  ]\n\n  for (const character of punctuation) {\n    answer = answer.replaceAll(character, `\\\\${character}`)\n  }\n\n  return answer\n}\n\nexport const addClassOptionIfNone = (\n  options: Extract<ComponentDef, { options: { classes?: string } }>['options'],\n  className: string\n) => {\n  options.classes ??= className\n}\n\n/**\n * Configuration for Joi expressions that use lowerFirst function\n */\nexport const lowerFirstExpressionOptions = {\n  functions: {\n    lowerFirst\n  }\n} as ReferenceOptions\n\n/**\n * Creates a Joi expression with lowerFirst function support\n * Used for error messages in location field components\n */\nexport const createLowerFirstExpression = (template: string): JoiExpression =>\n  joi.expression(template, lowerFirstExpressionOptions) as JoiExpression\n"],"mappings":"AACA,OAAOA,GAAG,MAAqD,KAAK;AACpE,OAAOC,UAAU,MAAM,sBAAsB;;AAE7C;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACC,MAAc,EAAE;EAC7C,MAAMC,WAAW,GAAG,CAClB,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,CACJ;EAED,KAAK,MAAMC,SAAS,IAAID,WAAW,EAAE;IACnCD,MAAM,GAAGA,MAAM,CAACG,UAAU,CAACD,SAAS,EAAE,KAAKA,SAAS,EAAE,CAAC;EACzD;EAEA,OAAOF,MAAM;AACf;AAEA,OAAO,MAAMI,oBAAoB,GAAGA,CAClCC,OAA4E,EAC5EC,SAAiB,KACd;EACHD,OAAO,CAACE,OAAO,KAAKD,SAAS;AAC/B,CAAC;;AAED;AACA;AACA;AACA,OAAO,MAAME,2BAA2B,GAAG;EACzCC,SAAS,EAAE;IACTX;EACF;AACF,CAAqB;;AAErB;AACA;AACA;AACA;AACA,OAAO,MAAMY,0BAA0B,GAAIC,QAAgB,IACzDd,GAAG,CAACe,UAAU,CAACD,QAAQ,EAAEH,2BAA2B,CAAkB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["joi","lowerFirst","escapeMarkdown","answer","punctuation","character","replaceAll","addClassOptionIfNone","options","className","classes","lowerFirstPreserveProperNouns","text","result","replace","lowerFirstExpressionOptions","functions","createLowerFirstExpression","template","expression"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/index.ts"],"sourcesContent":["import { type ComponentDef } from '@defra/forms-model'\nimport joi, { type JoiExpression, type ReferenceOptions } from 'joi'\nimport lowerFirst from 'lodash/lowerFirst.js'\n\n/**\n * Prevent Markdown formatting\n * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}\n */\nexport function escapeMarkdown(answer: string) {\n  const punctuation = [\n    '`',\n    \"'\",\n    '*',\n    '_',\n    '{',\n    '}',\n    '[',\n    ']',\n    '(',\n    ')',\n    '#',\n    '+',\n    '-',\n    '.',\n    '!'\n  ]\n\n  for (const character of punctuation) {\n    answer = answer.replaceAll(character, `\\\\${character}`)\n  }\n\n  return answer\n}\n\nexport const addClassOptionIfNone = (\n  options: Extract<ComponentDef, { options: { classes?: string } }>['options'],\n  className: string\n) => {\n  options.classes ??= className\n}\n\n/**\n * Applies lowerFirst but preserves capitalisation of proper nouns\n * like \"National Grid\", \"Ordnance Survey\" and \"OS\".\n */\nexport function lowerFirstPreserveProperNouns(text: string): string {\n  const result = lowerFirst(text)\n  return result\n    .replace(/\\bnational [Gg]rid\\b/g, 'National Grid')\n    .replace(/\\bordnance [Ss]urvey\\b/g, 'Ordnance Survey')\n    .replace(/\\b[oO][sS]\\b/g, 'OS')\n}\n\n/**\n * Configuration for Joi expressions that use lowerFirst function\n */\nexport const lowerFirstExpressionOptions = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * Creates a Joi expression with lowerFirst function support\n * Used for error messages in location field components\n */\nexport const createLowerFirstExpression = (template: string): JoiExpression =>\n  joi.expression(template, lowerFirstExpressionOptions) as JoiExpression\n"],"mappings":"AACA,OAAOA,GAAG,MAAqD,KAAK;AACpE,OAAOC,UAAU,MAAM,sBAAsB;;AAE7C;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACC,MAAc,EAAE;EAC7C,MAAMC,WAAW,GAAG,CAClB,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,CACJ;EAED,KAAK,MAAMC,SAAS,IAAID,WAAW,EAAE;IACnCD,MAAM,GAAGA,MAAM,CAACG,UAAU,CAACD,SAAS,EAAE,KAAKA,SAAS,EAAE,CAAC;EACzD;EAEA,OAAOF,MAAM;AACf;AAEA,OAAO,MAAMI,oBAAoB,GAAGA,CAClCC,OAA4E,EAC5EC,SAAiB,KACd;EACHD,OAAO,CAACE,OAAO,KAAKD,SAAS;AAC/B,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,SAASE,6BAA6BA,CAACC,IAAY,EAAU;EAClE,MAAMC,MAAM,GAAGZ,UAAU,CAACW,IAAI,CAAC;EAC/B,OAAOC,MAAM,CACVC,OAAO,CAAC,uBAAuB,EAAE,eAAe,CAAC,CACjDA,OAAO,CAAC,yBAAyB,EAAE,iBAAiB,CAAC,CACrDA,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC;AACnC;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,2BAA2B,GAAG;EACzCC,SAAS,EAAE;IACTf,UAAU,EAAEU;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA;AACA,OAAO,MAAMM,0BAA0B,GAAIC,QAAgB,IACzDlB,GAAG,CAACmB,UAAU,CAACD,QAAQ,EAAEH,2BAA2B,CAAkB","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/validationOptions.js

@@ -2,10 +2,10 @@
 // Declaration above is needed for: https://github.com/hapijs/joi/issues/3064
 
 import joi from 'joi';
-import lowerFirst from 'lodash/lowerFirst.js';
+import { lowerFirstPreserveProperNouns } from "../components/helpers/index.js";
 const opts = {
   functions: {
-    lowerFirst
+    lowerFirst: lowerFirstPreserveProperNouns
   }
 };
 

package/.server/server/plugins/engine/pageControllers/validationOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationOptions.js","names":["joi","lowerFirst","opts","functions","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unsafe-assignment */\n// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\nimport lowerFirst from 'lodash/lowerFirst.js'\n\nconst opts = {\n  functions: {\n    lowerFirst\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;AACA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AACZ,OAAOC,UAAU,MAAM,sBAAsB;AAE7C,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTF;EACF;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMG,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEL,GAAG,CAACM,UAAU,CACjC,uFAAuF,EACvFJ,IACF,CAAkB;EAClBK,QAAQ,EAAEP,GAAG,CAACM,UAAU,CACtB,8BAA8B,EAC9BJ,IACF,CAAkB;EAClBM,cAAc,EAAER,GAAG,CAACM,UAAU,CAC5B,+BAA+B,EAC/BJ,IACF,CAAkB;EAClBO,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEb,GAAG,CAACM,UAAU,CACrB,sCAAsC,EACtCJ,IACF,CAAkB;EAClBY,MAAM,EAAEd,GAAG,CAACM,UAAU,CACpB,oDAAoD,EACpDJ,IACF,CAAkB;EAClBa,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAErB,GAAG,CAACM,UAAU,CAAC,kBAAkB,EAAEJ,IAAI,CAAkB;EACzEoB,aAAa,EAAEtB,GAAG,CAACM,UAAU,CAC3B,kDAAkD,EAClDJ,IACF,CAAkB;EAClBqB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEtB,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,qBAAqB,EAAEV,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACgB,QAAQ;EAE3C,aAAa,EAAEhB,eAAe,CAACW,MAAM;EACrC,kBAAkB,EAAEX,eAAe,CAACY,eAAe;EACnD,gBAAgB,EAAEZ,eAAe,CAACa,aAAa;EAC/C,eAAe,EAAEb,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACc,SAAS;EACvC,YAAY,EAAEd,eAAe,CAACe,SAAS;EAEvC,iBAAiB,EAAEf,eAAe,CAACiB,cAAc;EACjD,YAAY,EAAEjB,eAAe,CAACkB,aAAa;EAE3C,UAAU,EAAElB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACmB,UAAU;EACvC,aAAa,EAAEnB,eAAe,CAACmB,UAAU;EACzC,UAAU,EAAEnB,eAAe,CAACoB,OAAO;EACnC,UAAU,EAAEpB,eAAe,CAACqB;AAC9B,CAAC;AAED,OAAO,MAAME,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"validationOptions.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unsafe-assignment */\n// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;AACA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AAEZ,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMI,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEN,GAAG,CAACO,UAAU,CACjC,uFAAuF,EACvFL,IACF,CAAkB;EAClBM,QAAQ,EAAER,GAAG,CAACO,UAAU,CACtB,8BAA8B,EAC9BL,IACF,CAAkB;EAClBO,cAAc,EAAET,GAAG,CAACO,UAAU,CAC5B,+BAA+B,EAC/BL,IACF,CAAkB;EAClBQ,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEd,GAAG,CAACO,UAAU,CACrB,sCAAsC,EACtCL,IACF,CAAkB;EAClBa,MAAM,EAAEf,GAAG,CAACO,UAAU,CACpB,oDAAoD,EACpDL,IACF,CAAkB;EAClBc,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAEtB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEqB,aAAa,EAAEvB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBsB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEtB,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,qBAAqB,EAAEV,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACgB,QAAQ;EAE3C,aAAa,EAAEhB,eAAe,CAACW,MAAM;EACrC,kBAAkB,EAAEX,eAAe,CAACY,eAAe;EACnD,gBAAgB,EAAEZ,eAAe,CAACa,aAAa;EAC/C,eAAe,EAAEb,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACc,SAAS;EACvC,YAAY,EAAEd,eAAe,CAACe,SAAS;EAEvC,iBAAiB,EAAEf,eAAe,CAACiB,cAAc;EACjD,YAAY,EAAEjB,eAAe,CAACkB,aAAa;EAE3C,UAAU,EAAElB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACmB,UAAU;EACvC,aAAa,EAAEnB,eAAe,CAACmB,UAAU;EACzC,UAAU,EAAEnB,eAAe,CAACoB,OAAO;EACnC,UAAU,EAAEpB,eAAe,CAACqB;AAC9B,CAAC;AAED,OAAO,MAAME,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.35",
+  "version": "4.0.37",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package/src/server/plugins/engine/components/DeclarationField.test.ts

@@ -293,6 +293,58 @@ describe('DeclarationField', () => {
         )
       })
 
+      it('sets Nunjucks component to true when checked from save-anbd-exit', () => {
+        def = {
+          ...def,
+          hint: 'Please read and confirm the following'
+        } satisfies DeclarationFieldComponent
+
+        collection = new ComponentCollection([def], { model })
+        field = collection.fields[0]
+        const viewModel = field.getViewModel(getFormData(['true', 'unchecked']))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            hint: {
+              text: 'Please read and confirm the following'
+            },
+            items: [
+              {
+                value: 'true',
+                text: 'I understand and agree',
+                checked: true
+              }
+            ]
+          })
+        )
+      })
+
+      it('sets Nunjucks component to false when unchecked from save-anbd-exit', () => {
+        def = {
+          ...def,
+          hint: 'Please read and confirm the following'
+        } satisfies DeclarationFieldComponent
+
+        collection = new ComponentCollection([def], { model })
+        field = collection.fields[0]
+        const viewModel = field.getViewModel(getFormData(['unchecked']))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            hint: {
+              text: 'Please read and confirm the following'
+            },
+            items: [
+              {
+                value: 'true',
+                text: 'I understand and agree',
+                checked: false
+              }
+            ]
+          })
+        )
+      })
+
       it('sets Nunjucks component value when posted', () => {
         def = {
           ...def,

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

@@ -137,8 +137,12 @@ export class DeclarationField extends FormComponent {
       }
     }
 
+    const payloadValue = payload[this.name]
     const isChecked =
-      payload[this.name] === 'true' || payload[this.name] === true
+      payloadValue === 'true' ||
+      payloadValue === true ||
+      (Array.isArray(payloadValue) && payloadValue.some((x) => x === 'true'))
+
     return {
       ...viewModel,
       hint: hint ? { text: hint } : undefined,

package/src/server/plugins/engine/components/helpers/helpers.test.ts

@@ -9,7 +9,8 @@ import { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRef
 import { createComponent } from '~/src/server/plugins/engine/components/helpers/components.js'
 import {
   createLowerFirstExpression,
-  lowerFirstExpressionOptions
+  lowerFirstExpressionOptions,
+  lowerFirstPreserveProperNouns
 } from '~/src/server/plugins/engine/components/helpers/index.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
@@ -145,6 +146,42 @@ describe('ComponentBase tests', () => {
   })
 })
 
+describe('lowerFirstPreserveProperNouns', () => {
+  test('should preserve "National Grid" capitalisation', () => {
+    expect(lowerFirstPreserveProperNouns('National Grid field number')).toBe(
+      'National Grid field number'
+    )
+  })
+
+  test('should preserve "Ordnance Survey" capitalisation', () => {
+    expect(
+      lowerFirstPreserveProperNouns('Ordnance Survey (OS) grid reference')
+    ).toBe('Ordnance Survey (OS) grid reference')
+  })
+
+  test('should preserve "OS" capitalisation', () => {
+    expect(lowerFirstPreserveProperNouns('OS grid reference')).toBe(
+      'OS grid reference'
+    )
+  })
+
+  test('should lowercase first character for regular text', () => {
+    expect(lowerFirstPreserveProperNouns('Enter your name')).toBe(
+      'enter your name'
+    )
+  })
+
+  test('should handle text without special terms', () => {
+    expect(lowerFirstPreserveProperNouns('Latitude and longitude')).toBe(
+      'latitude and longitude'
+    )
+  })
+
+  test('should handle empty string', () => {
+    expect(lowerFirstPreserveProperNouns('')).toBe('')
+  })
+})
+
 describe('lowerFirst expression helpers', () => {
   test('lowerFirstExpressionOptions should have lowerFirst function', () => {
     expect(lowerFirstExpressionOptions).toHaveProperty('functions')

package/src/server/plugins/engine/components/helpers/index.ts

@@ -39,12 +39,24 @@ export const addClassOptionIfNone = (
   options.classes ??= className
 }
 
+/**
+ * Applies lowerFirst but preserves capitalisation of proper nouns
+ * like "National Grid", "Ordnance Survey" and "OS".
+ */
+export function lowerFirstPreserveProperNouns(text: string): string {
+  const result = lowerFirst(text)
+  return result
+    .replace(/\bnational [Gg]rid\b/g, 'National Grid')
+    .replace(/\bordnance [Ss]urvey\b/g, 'Ordnance Survey')
+    .replace(/\b[oO][sS]\b/g, 'OS')
+}
+
 /**
  * Configuration for Joi expressions that use lowerFirst function
  */
 export const lowerFirstExpressionOptions = {
   functions: {
-    lowerFirst
+    lowerFirst: lowerFirstPreserveProperNouns
   }
 } as ReferenceOptions
 

package/src/server/plugins/engine/pageControllers/validationOptions.ts

@@ -8,11 +8,12 @@ import joi, {
   type ReferenceOptions,
   type ValidationOptions
 } from 'joi'
-import lowerFirst from 'lodash/lowerFirst.js'
+
+import { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'
 
 const opts = {
   functions: {
-    lowerFirst
+    lowerFirst: lowerFirstPreserveProperNouns
   }
 } as ReferenceOptions