@defra/forms-engine-plugin 4.0.23 → 4.0.25

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

@@ -1 +1 @@
-{"version":3,"file":"OsGridRefField.js","names":["LocationFieldBase","OsGridRefField","getValidationConfig","pattern","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","instance","Object","create","prototype"],"sources":["../../../../../src/server/plugins/engine/components/OsGridRefField.ts"],"sourcesContent":["import { type OsGridRefFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\n\nexport class OsGridRefField extends LocationFieldBase {\n  declare options: OsGridRefFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid references (NGR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 6 digits in 2 blocks of 3 e.g. ST 678 678\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    // - 2 letters & 10 digits in 2 blocks of 5 e.g. SO 12345 12345\n    // Optional spaces between each block\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?(([0-9]{3})\\s?([0-9]{3})|([0-9]{4})\\s?([0-9]{4})|([0-9]{5})\\s?([0-9]{5}))$/\n\n    return {\n      pattern,\n      patternErrorMessage: `Enter a valid OS grid reference for {{#title}} like TQ123456`,\n      requiredMessage: 'Enter {{#title}}'\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: 'Enter a valid OS grid reference for {{#title}} like TQ123456'\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors() {\n    const instance = Object.create(OsGridRefField.prototype) as OsGridRefField\n    return instance.getAllPossibleErrors()\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAE1B,OAAO,MAAMC,cAAc,SAASD,iBAAiB,CAAC;EAG1CE,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA;IACA;IACA;IACA,MAAMC,OAAO,GACX,qLAAqL;IAEvL,OAAO;MACLA,OAAO;MACPC,mBAAmB,EAAE,8DAA8D;MACnFC,eAAe,EAAE;IACnB,CAAC;EACH;EAEUC,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAE;IACZ,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOC,oBAAoBA,CAAA,EAAG;IAC5B,MAAMC,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAACX,cAAc,CAACY,SAAS,CAAmB;IAC1E,OAAOH,QAAQ,CAACD,oBAAoB,CAAC,CAAC;EACxC;AACF","ignoreList":[]}
+{"version":3,"file":"OsGridRefField.js","names":["LocationFieldBase","createLowerFirstExpression","OsGridRefField","getValidationConfig","pattern","patternTemplate","patternErrorMessage","requiredMessage","getErrorTemplates","type","template","getAllPossibleErrors","instance","Object","create","prototype"],"sources":["../../../../../src/server/plugins/engine/components/OsGridRefField.ts"],"sourcesContent":["import { type OsGridRefFieldComponent } from '@defra/forms-model'\n\nimport { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'\nimport { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nexport class OsGridRefField extends LocationFieldBase {\n  declare options: OsGridRefFieldComponent['options']\n\n  protected getValidationConfig() {\n    // Regex for OS national grid references (NGR)\n    // Validates specific valid OS grid letter combinations with:\n    // - 2 letters & 6 digits in 2 blocks of 3 e.g. ST 678 678\n    // - 2 letters & 8 digits in 2 blocks of 4 e.g. ST 6789 6789\n    // - 2 letters & 10 digits in 2 blocks of 5 e.g. SO 12345 12345\n    // Optional spaces between each block\n    const pattern =\n      /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\\s?(([0-9]{3})\\s?([0-9]{3})|([0-9]{4})\\s?([0-9]{4})|([0-9]{5})\\s?([0-9]{5}))$/\n\n    const patternTemplate =\n      'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'\n\n    return {\n      pattern,\n      patternErrorMessage: createLowerFirstExpression(patternTemplate),\n      requiredMessage: createLowerFirstExpression(\n        'Enter {{lowerFirst(#title)}}'\n      )\n    }\n  }\n\n  protected getErrorTemplates() {\n    return [\n      {\n        type: 'pattern',\n        template: createLowerFirstExpression(\n          'Enter a valid OS grid reference for {{lowerFirst(#title)}} like TQ123456'\n        )\n      }\n    ]\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors() {\n    const instance = Object.create(OsGridRefField.prototype) as OsGridRefField\n    return instance.getAllPossibleErrors()\n  }\n}\n"],"mappings":"AAEA,SAASA,iBAAiB;AAC1B,SAASC,0BAA0B;AAEnC,OAAO,MAAMC,cAAc,SAASF,iBAAiB,CAAC;EAG1CG,mBAAmBA,CAAA,EAAG;IAC9B;IACA;IACA;IACA;IACA;IACA;IACA,MAAMC,OAAO,GACX,qLAAqL;IAEvL,MAAMC,eAAe,GACnB,0EAA0E;IAE5E,OAAO;MACLD,OAAO;MACPE,mBAAmB,EAAEL,0BAA0B,CAACI,eAAe,CAAC;MAChEE,eAAe,EAAEN,0BAA0B,CACzC,8BACF;IACF,CAAC;EACH;EAEUO,iBAAiBA,CAAA,EAAG;IAC5B,OAAO,CACL;MACEC,IAAI,EAAE,SAAS;MACfC,QAAQ,EAAET,0BAA0B,CAClC,0EACF;IACF,CAAC,CACF;EACH;;EAEA;AACF;AACA;EACE,OAAOU,oBAAoBA,CAAA,EAAG;IAC5B,MAAMC,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAACZ,cAAc,CAACa,SAAS,CAAmB;IAC1E,OAAOH,QAAQ,CAACD,oBAAoB,CAAC,CAAC;EACxC;AACF","ignoreList":[]}

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

@@ -1,4 +1,5 @@
 import { type ComponentDef } from '@defra/forms-model';
+import { type JoiExpression, type ReferenceOptions } from 'joi';
 /**
  * Prevent Markdown formatting
  * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
@@ -9,3 +10,12 @@ export declare const addClassOptionIfNone: (options: Extract<ComponentDef, {
         classes?: string;
     };
 }>["options"], className: string) => void;
+/**
+ * Configuration for Joi expressions that use lowerFirst function
+ */
+export declare const lowerFirstExpressionOptions: ReferenceOptions;
+/**
+ * Creates a Joi expression with lowerFirst function support
+ * Used for error messages in location field components
+ */
+export declare const createLowerFirstExpression: (template: string) => JoiExpression;

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

@@ -1,3 +1,6 @@
+import joi from 'joi';
+import lowerFirst from 'lodash/lowerFirst.js';
+
 /**
  * Prevent Markdown formatting
  * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
@@ -12,4 +15,19 @@ export function escapeMarkdown(answer) {
 export const addClassOptionIfNone = (options, className) => {
   options.classes ??= className;
 };
+
+/**
+ * Configuration for Joi expressions that use lowerFirst function
+ */
+export const lowerFirstExpressionOptions = {
+  functions: {
+    lowerFirst
+  }
+};
+
+/**
+ * Creates a Joi expression with lowerFirst function support
+ * Used for error messages in location field components
+ */
+export const createLowerFirstExpression = template => joi.expression(template, lowerFirstExpressionOptions);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["escapeMarkdown","answer","punctuation","character","replaceAll","addClassOptionIfNone","options","className","classes"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/index.ts"],"sourcesContent":["import { type ComponentDef } from '@defra/forms-model'\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"],"mappings":"AAEA;AACA;AACA;AACA;AACA,OAAO,SAASA,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","ignoreList":[]}
+{"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":[]}

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

@@ -17,7 +17,10 @@ export const prepareNunjucksEnvironment = function (env, pluginOptions) {
   for (const [name, nunjucksFilter] of Object.entries(filters)) {
     env.addFilter(name, nunjucksFilter);
   }
-  env.addFilter('markdown', text => markdownToHtml(text, pluginOptions.baseUrl));
+  env.addFilter('markdown', (text, startingHeaderLevel) => markdownToHtml(text, {
+    baseUrl: pluginOptions.baseUrl,
+    startingHeaderLevel
+  }));
   for (const [name, nunjucksGlobal] of Object.entries(globals)) {
     env.addGlobal(name, nunjucksGlobal);
   }

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["markdownToHtml","engine","plugin","checkComponentTemplates","checkErrorTemplates","evaluate","govukRebrand","filters","getPageHref","context","globals","VIEW_PATH","PLUGIN_PATH","prepareNunjucksEnvironment","env","pluginOptions","name","nunjucksFilter","Object","entries","addFilter","text","baseUrl","nunjucksGlobal","addGlobal","filter","registerFilter","forEach","fn"],"sources":["../../../../src/server/plugins/engine/index.ts"],"sourcesContent":["import { markdownToHtml } from '@defra/forms-model'\nimport { type Environment } from 'nunjucks'\n\nimport { engine } from '~/src/server/plugins/engine/helpers.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n} from '~/src/server/plugins/nunjucks/environment.js'\nimport * as filters from '~/src/server/plugins/nunjucks/filters/index.js'\n\nexport { getPageHref } from '~/src/server/plugins/engine/helpers.js'\nexport { context } from '~/src/server/plugins/nunjucks/context.js'\n\nconst globals = {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n}\n\nexport const VIEW_PATH = 'src/server/plugins/engine/views'\nexport const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin'\n\nexport const prepareNunjucksEnvironment = function (\n  env: Environment,\n  pluginOptions: PluginOptions\n) {\n  for (const [name, nunjucksFilter] of Object.entries(filters)) {\n    env.addFilter(name, nunjucksFilter)\n  }\n\n  env.addFilter('markdown', (text: string) =>\n    markdownToHtml(text, pluginOptions.baseUrl)\n  )\n\n  for (const [name, nunjucksGlobal] of Object.entries(globals)) {\n    env.addGlobal(name, nunjucksGlobal)\n  }\n\n  // Apply any additional filters to both the liquid and nunjucks engines\n  if (pluginOptions.filters) {\n    for (const [name, filter] of Object.entries(pluginOptions.filters)) {\n      env.addFilter(name, filter)\n      engine.registerFilter(name, filter)\n    }\n  }\n\n  // Apply any additional globals to nunjucks engines\n  if (pluginOptions.globals) {\n    Object.entries(pluginOptions.globals).forEach(([name, fn]) => {\n      env.addGlobal(name, fn)\n    })\n  }\n}\n\nexport default plugin\n"],"mappings":"AAAA,SAASA,cAAc,QAAQ,oBAAoB;AAGnD,SAASC,MAAM;AACf,SAASC,MAAM;AAEf,SACEC,uBAAuB,EACvBC,mBAAmB,EACnBC,QAAQ,EACRC,YAAY;AAEd,OAAO,KAAKC,OAAO;AAEnB,SAASC,WAAW;AACpB,SAASC,OAAO;AAEhB,MAAMC,OAAO,GAAG;EACdP,uBAAuB;EACvBC,mBAAmB;EACnBC,QAAQ;EACRC;AACF,CAAC;AAED,OAAO,MAAMK,SAAS,GAAG,iCAAiC;AAC1D,OAAO,MAAMC,WAAW,GAAG,yCAAyC;AAEpE,OAAO,MAAMC,0BAA0B,GAAG,SAAAA,CACxCC,GAAgB,EAChBC,aAA4B,EAC5B;EACA,KAAK,MAAM,CAACC,IAAI,EAAEC,cAAc,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACZ,OAAO,CAAC,EAAE;IAC5DO,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEC,cAAc,CAAC;EACrC;EAEAH,GAAG,CAACM,SAAS,CAAC,UAAU,EAAGC,IAAY,IACrCrB,cAAc,CAACqB,IAAI,EAAEN,aAAa,CAACO,OAAO,CAC5C,CAAC;EAED,KAAK,MAAM,CAACN,IAAI,EAAEO,cAAc,CAAC,IAAIL,MAAM,CAACC,OAAO,CAACT,OAAO,CAAC,EAAE;IAC5DI,GAAG,CAACU,SAAS,CAACR,IAAI,EAAEO,cAAc,CAAC;EACrC;;EAEA;EACA,IAAIR,aAAa,CAACR,OAAO,EAAE;IACzB,KAAK,MAAM,CAACS,IAAI,EAAES,MAAM,CAAC,IAAIP,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACR,OAAO,CAAC,EAAE;MAClEO,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAES,MAAM,CAAC;MAC3BxB,MAAM,CAACyB,cAAc,CAACV,IAAI,EAAES,MAAM,CAAC;IACrC;EACF;;EAEA;EACA,IAAIV,aAAa,CAACL,OAAO,EAAE;IACzBQ,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACL,OAAO,CAAC,CAACiB,OAAO,CAAC,CAAC,CAACX,IAAI,EAAEY,EAAE,CAAC,KAAK;MAC5Dd,GAAG,CAACU,SAAS,CAACR,IAAI,EAAEY,EAAE,CAAC;IACzB,CAAC,CAAC;EACJ;AACF,CAAC;AAED,eAAe1B,MAAM","ignoreList":[]}
+{"version":3,"file":"index.js","names":["markdownToHtml","engine","plugin","checkComponentTemplates","checkErrorTemplates","evaluate","govukRebrand","filters","getPageHref","context","globals","VIEW_PATH","PLUGIN_PATH","prepareNunjucksEnvironment","env","pluginOptions","name","nunjucksFilter","Object","entries","addFilter","text","startingHeaderLevel","baseUrl","nunjucksGlobal","addGlobal","filter","registerFilter","forEach","fn"],"sources":["../../../../src/server/plugins/engine/index.ts"],"sourcesContent":["import { markdownToHtml } from '@defra/forms-model'\nimport { type Environment } from 'nunjucks'\n\nimport { engine } from '~/src/server/plugins/engine/helpers.js'\nimport { plugin } from '~/src/server/plugins/engine/plugin.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n} from '~/src/server/plugins/nunjucks/environment.js'\nimport * as filters from '~/src/server/plugins/nunjucks/filters/index.js'\n\nexport { getPageHref } from '~/src/server/plugins/engine/helpers.js'\nexport { context } from '~/src/server/plugins/nunjucks/context.js'\n\nconst globals = {\n  checkComponentTemplates,\n  checkErrorTemplates,\n  evaluate,\n  govukRebrand\n}\n\nexport const VIEW_PATH = 'src/server/plugins/engine/views'\nexport const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin'\n\nexport const prepareNunjucksEnvironment = function (\n  env: Environment,\n  pluginOptions: PluginOptions\n) {\n  for (const [name, nunjucksFilter] of Object.entries(filters)) {\n    env.addFilter(name, nunjucksFilter)\n  }\n\n  env.addFilter('markdown', (text: string, startingHeaderLevel?: number) =>\n    markdownToHtml(text, {\n      baseUrl: pluginOptions.baseUrl,\n      startingHeaderLevel\n    })\n  )\n\n  for (const [name, nunjucksGlobal] of Object.entries(globals)) {\n    env.addGlobal(name, nunjucksGlobal)\n  }\n\n  // Apply any additional filters to both the liquid and nunjucks engines\n  if (pluginOptions.filters) {\n    for (const [name, filter] of Object.entries(pluginOptions.filters)) {\n      env.addFilter(name, filter)\n      engine.registerFilter(name, filter)\n    }\n  }\n\n  // Apply any additional globals to nunjucks engines\n  if (pluginOptions.globals) {\n    Object.entries(pluginOptions.globals).forEach(([name, fn]) => {\n      env.addGlobal(name, fn)\n    })\n  }\n}\n\nexport default plugin\n"],"mappings":"AAAA,SAASA,cAAc,QAAQ,oBAAoB;AAGnD,SAASC,MAAM;AACf,SAASC,MAAM;AAEf,SACEC,uBAAuB,EACvBC,mBAAmB,EACnBC,QAAQ,EACRC,YAAY;AAEd,OAAO,KAAKC,OAAO;AAEnB,SAASC,WAAW;AACpB,SAASC,OAAO;AAEhB,MAAMC,OAAO,GAAG;EACdP,uBAAuB;EACvBC,mBAAmB;EACnBC,QAAQ;EACRC;AACF,CAAC;AAED,OAAO,MAAMK,SAAS,GAAG,iCAAiC;AAC1D,OAAO,MAAMC,WAAW,GAAG,yCAAyC;AAEpE,OAAO,MAAMC,0BAA0B,GAAG,SAAAA,CACxCC,GAAgB,EAChBC,aAA4B,EAC5B;EACA,KAAK,MAAM,CAACC,IAAI,EAAEC,cAAc,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACZ,OAAO,CAAC,EAAE;IAC5DO,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEC,cAAc,CAAC;EACrC;EAEAH,GAAG,CAACM,SAAS,CAAC,UAAU,EAAE,CAACC,IAAY,EAAEC,mBAA4B,KACnEtB,cAAc,CAACqB,IAAI,EAAE;IACnBE,OAAO,EAAER,aAAa,CAACQ,OAAO;IAC9BD;EACF,CAAC,CACH,CAAC;EAED,KAAK,MAAM,CAACN,IAAI,EAAEQ,cAAc,CAAC,IAAIN,MAAM,CAACC,OAAO,CAACT,OAAO,CAAC,EAAE;IAC5DI,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEQ,cAAc,CAAC;EACrC;;EAEA;EACA,IAAIT,aAAa,CAACR,OAAO,EAAE;IACzB,KAAK,MAAM,CAACS,IAAI,EAAEU,MAAM,CAAC,IAAIR,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACR,OAAO,CAAC,EAAE;MAClEO,GAAG,CAACM,SAAS,CAACJ,IAAI,EAAEU,MAAM,CAAC;MAC3BzB,MAAM,CAAC0B,cAAc,CAACX,IAAI,EAAEU,MAAM,CAAC;IACrC;EACF;;EAEA;EACA,IAAIX,aAAa,CAACL,OAAO,EAAE;IACzBQ,MAAM,CAACC,OAAO,CAACJ,aAAa,CAACL,OAAO,CAAC,CAACkB,OAAO,CAAC,CAAC,CAACZ,IAAI,EAAEa,EAAE,CAAC,KAAK;MAC5Df,GAAG,CAACW,SAAS,CAACT,IAAI,EAAEa,EAAE,CAAC;IACzB,CAAC,CAAC;EACJ;AACF,CAAC;AAED,eAAe3B,MAAM","ignoreList":[]}

package/.server/server/plugins/engine/views/components/declarationfield.html

@@ -5,7 +5,7 @@
 {% macro DeclarationField(component) %}
   {% set content %}
     <div class="app-prose-scope">
-      {{ component.model.content | markdown | safe }}
+      {{ component.model.content | markdown(component.model.headerStartLevel)  | safe }}
     </div>
   {% endset %}
   {% set checkboxes = component.model | merge({ formGroup: { beforeInputs: { html: content } } }) %}

package/.server/server/plugins/engine/views/components/markdown.html

@@ -1,5 +1,5 @@
 {% macro Markdown(component) %}
   <div class="app-prose-scope">
-    {{ component.model.content | markdown | safe }}
+    {{ component.model.content | markdown(component.model.headerStartLevel) | safe }}
   </div>
 {% endmacro %}

package/.server/server/plugins/engine/views/confirmation.html

@@ -12,7 +12,7 @@
       }) }}
       <h2 class="govuk-heading-m">What happens next</h2>
       <div class="app-prose-scope">
-        {{ submissionGuidance | markdown | safe }}
+        {{ submissionGuidance | markdown(3) | safe }}
       </div>
     </div>
   </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.23",
+  "version": "4.0.25",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.580",
+    "@defra/forms-model": "^3.0.584",
     "@defra/hapi-tracing": "^1.29.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
@@ -91,6 +91,7 @@
     "blankie": "^5.0.0",
     "blipp": "^4.0.2",
     "btoa": "^1.2.1",
+    "chokidar": "3.6.0",
     "convict": "^6.2.4",
     "date-fns": "^4.1.0",
     "dotenv": "^17.2.3",

package/src/server/forms/components.json

@@ -139,7 +139,7 @@
           "type": "Markdown",
           "name": "markdown",
           "title": "Title",
-          "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)",
+          "content": "# Markdown - This is H1\n## This is H2\n### This is H3\n#### This is H4\n##### This is H5\n###### This is H6\n\n[An internal link](http://localhost:3009/fictional-page)\n\n[An external link](https://defra.gov.uk/fictional-page)",
           "options": {},
           "schema": {}
         },
@@ -147,7 +147,7 @@
           "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",
+          "content": "# H1\nBy 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",
           "options": {
             "required": false

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

@@ -11,6 +11,8 @@ import {
 } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
+import declarationWithGuidance from '~/test/form/definitions/declaration-with-guidance.js'
+import declarationWithoutGuidance from '~/test/form/definitions/declaration-without-guidance.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
 
 describe('DeclarationField', () => {
@@ -481,4 +483,26 @@ describe('DeclarationField', () => {
       expect(DeclarationField.isBool(true)).toBe(true)
     })
   })
+
+  describe('Markdown header starting level', () => {
+    test('should determine startHeadingLevel is 3 some guidance', () => {
+      const modelDecl = new FormModel(declarationWithGuidance, {
+        basePath: 'test'
+      })
+      const field = modelDecl.componentMap.get(
+        'declarationField'
+      ) as DeclarationField
+      expect(field.headerStartLevel).toBe(3)
+    })
+
+    test('should determine startHeadingLevel is 2 when no guidance', () => {
+      const modelDecl = new FormModel(declarationWithoutGuidance, {
+        basePath: 'test'
+      })
+      const field = modelDecl.componentMap.get(
+        'declarationField'
+      ) as DeclarationField
+      expect(field.headerStartLevel).toBe(2)
+    })
+  })
 })

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

@@ -1,4 +1,10 @@
-import { type DeclarationFieldComponent, type Item } from '@defra/forms-model'
+import {
+  ComponentType,
+  hasFormComponents,
+  isFormType,
+  type DeclarationFieldComponent,
+  type Item
+} from '@defra/forms-model'
 import joi, {
   type ArraySchema,
   type BooleanSchema,
@@ -30,6 +36,7 @@ export class DeclarationField extends FormComponent {
   declare formSchema: ArraySchema<StringSchema[]>
   declare stateSchema: BooleanSchema
   declare content: string
+  headerStartLevel: number
 
   constructor(
     def: DeclarationFieldComponent,
@@ -64,6 +71,16 @@ export class DeclarationField extends FormComponent {
     this.content = content
     this.declarationConfirmationLabel =
       options.declarationConfirmationLabel ?? this.DEFAULT_DECLARATION_LABEL
+    const formComponents = hasFormComponents(props.page?.pageDef)
+      ? props.page.pageDef.components
+      : []
+    const numOfQuestionsOnPage = formComponents.filter((q) =>
+      isFormType(q.type)
+    ).length
+    const hasGuidance = formComponents.some(
+      (comp, idx) => comp.type === ComponentType.Markdown && idx === 0
+    )
+    this.headerStartLevel = numOfQuestionsOnPage < 2 && !hasGuidance ? 2 : 3
   }
 
   getFormValueFromState(state: FormSubmissionState) {
@@ -133,7 +150,8 @@ export class DeclarationField extends FormComponent {
           value: 'true',
           checked: isChecked
         }
-      ]
+      ],
+      headerStartLevel: this.headerStartLevel
     }
   }
 

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

@@ -416,7 +416,36 @@ describe('EastingNorthingField', () => {
         const staticResult = EastingNorthingField.getAllPossibleErrors()
         const instanceResult = field.getAllPossibleErrors()
 
-        expect(instanceResult).toEqual(staticResult)
+        // Compare structure and content
+        expect(instanceResult.baseErrors).toHaveLength(
+          staticResult.baseErrors.length
+        )
+        expect(instanceResult.advancedSettingsErrors).toHaveLength(
+          staticResult.advancedSettingsErrors.length
+        )
+
+        // Compare error types
+        expect(instanceResult.baseErrors.map((e) => e.type)).toEqual(
+          staticResult.baseErrors.map((e) => e.type)
+        )
+        expect(
+          instanceResult.advancedSettingsErrors.map((e) => e.type)
+        ).toEqual(staticResult.advancedSettingsErrors.map((e) => e.type))
+
+        // Compare rendered templates
+        expect(
+          instanceResult.baseErrors.map((e) =>
+            typeof e.template === 'object' && 'rendered' in e.template
+              ? e.template.rendered
+              : e.template
+          )
+        ).toEqual(
+          staticResult.baseErrors.map((e) =>
+            typeof e.template === 'object' && 'rendered' in e.template
+              ? e.template.rendered
+              : e.template
+          )
+        )
       })
     })
   })

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

@@ -15,6 +15,7 @@ import {
   getLocationFieldViewModel
 } from '~/src/server/plugins/engine/components/LocationFieldHelpers.js'
 import { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'
+import { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'
 import { type EastingNorthingState } from '~/src/server/plugins/engine/components/types.js'
 import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import {
@@ -198,29 +199,41 @@ export class EastingNorthingField extends FormComponent {
         { type: 'required', template: messageTemplate.required },
         {
           type: 'eastingFormat',
-          template: 'Easting for {{#title}} must be between 1 and 6 digits'
+          template: createLowerFirstExpression(
+            'Easting for {{lowerFirst(#title)}} must be between 1 and 6 digits'
+          )
         },
         {
           type: 'northingFormat',
-          template: 'Northing for {{#title}} must be between 1 and 7 digits'
+          template: createLowerFirstExpression(
+            'Northing for {{lowerFirst(#title)}} must be between 1 and 7 digits'
+          )
         }
       ],
       advancedSettingsErrors: [
         {
           type: 'eastingMin',
-          template: `Easting for {{#title}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+          template: createLowerFirstExpression(
+            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+          )
         },
         {
           type: 'eastingMax',
-          template: `Easting for {{#title}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+          template: createLowerFirstExpression(
+            `Easting for {{lowerFirst(#title)}} must be between ${DEFAULT_EASTING_MIN} and ${DEFAULT_EASTING_MAX}`
+          )
         },
         {
           type: 'northingMin',
-          template: `Northing for {{#title}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+          template: createLowerFirstExpression(
+            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+          )
         },
         {
           type: 'northingMax',
-          template: `Northing for {{#title}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+          template: createLowerFirstExpression(
+            `Northing for {{lowerFirst(#title)}} must be between ${DEFAULT_NORTHING_MIN} and ${DEFAULT_NORTHING_MAX}`
+          )
         }
       ]
     }

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

@@ -404,7 +404,36 @@ describe('LatLongField', () => {
         const staticResult = LatLongField.getAllPossibleErrors()
         const instanceResult = field.getAllPossibleErrors()
 
-        expect(instanceResult).toEqual(staticResult)
+        // Compare structure and content
+        expect(instanceResult.baseErrors).toHaveLength(
+          staticResult.baseErrors.length
+        )
+        expect(instanceResult.advancedSettingsErrors).toHaveLength(
+          staticResult.advancedSettingsErrors.length
+        )
+
+        // Compare error types
+        expect(instanceResult.baseErrors.map((e) => e.type)).toEqual(
+          staticResult.baseErrors.map((e) => e.type)
+        )
+        expect(
+          instanceResult.advancedSettingsErrors.map((e) => e.type)
+        ).toEqual(staticResult.advancedSettingsErrors.map((e) => e.type))
+
+        // Compare rendered templates
+        expect(
+          instanceResult.baseErrors.map((e) =>
+            typeof e.template === 'object' && 'rendered' in e.template
+              ? e.template.rendered
+              : e.template
+          )
+        ).toEqual(
+          staticResult.baseErrors.map((e) =>
+            typeof e.template === 'object' && 'rendered' in e.template
+              ? e.template.rendered
+              : e.template
+          )
+        )
       })
     })
   })

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

@@ -12,6 +12,7 @@ import {
   getLocationFieldViewModel
 } from '~/src/server/plugins/engine/components/LocationFieldHelpers.js'
 import { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'
+import { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'
 import { type LatLongState } from '~/src/server/plugins/engine/components/types.js'
 import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import {
@@ -194,29 +195,41 @@ export class LatLongField extends FormComponent {
         { type: 'required', template: messageTemplate.required },
         {
           type: 'latitudeFormat',
-          template: 'Enter a valid latitude for {{#title}} like 51.519450'
+          template: createLowerFirstExpression(
+            'Enter a valid latitude for {{lowerFirst(#title)}} like 51.519450'
+          )
         },
         {
           type: 'longitudeFormat',
-          template: 'Enter a valid longitude for {{#title}} like -0.127758'
+          template: createLowerFirstExpression(
+            'Enter a valid longitude for {{lowerFirst(#title)}} like -0.127758'
+          )
         }
       ],
       advancedSettingsErrors: [
         {
           type: 'latitudeMin',
-          template: 'Latitude for {{#title}} must be between 49 and 60'
+          template: createLowerFirstExpression(
+            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'
+          )
         },
         {
           type: 'latitudeMax',
-          template: 'Latitude for {{#title}} must be between 49 and 60'
+          template: createLowerFirstExpression(
+            'Latitude for {{lowerFirst(#title)}} must be between 49 and 60'
+          )
         },
         {
           type: 'longitudeMin',
-          template: 'Longitude for {{#title}} must be between -9 and 2'
+          template: createLowerFirstExpression(
+            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'
+          )
         },
         {
           type: 'longitudeMax',
-          template: 'Longitude for {{#title}} must be between -9 and 2'
+          template: createLowerFirstExpression(
+            'Longitude for {{lowerFirst(#title)}} must be between -9 and 2'
+          )
         }
       ]
     }

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

@@ -1,5 +1,9 @@
 import { type FormComponentsDef } from '@defra/forms-model'
-import joi, { type LanguageMessages, type StringSchema } from 'joi'
+import joi, {
+  type JoiExpression,
+  type LanguageMessages,
+  type StringSchema
+} from 'joi'
 
 import {
   FormComponent,
@@ -15,6 +19,7 @@ import {
   type FormSubmissionError,
   type FormSubmissionState
 } from '~/src/server/plugins/engine/types.js'
+import { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'
 
 interface LocationFieldOptions {
   instructionText?: string
@@ -26,8 +31,8 @@ interface LocationFieldOptions {
 
 interface ValidationConfig {
   pattern: RegExp
-  patternErrorMessage: string
-  requiredMessage?: string
+  patternErrorMessage: JoiExpression
+  requiredMessage?: JoiExpression
 }
 
 /**
@@ -42,7 +47,7 @@ export abstract class LocationFieldBase extends FormComponent {
   protected abstract getValidationConfig(): ValidationConfig
   protected abstract getErrorTemplates(): {
     type: string
-    template: string
+    template: JoiExpression
   }[]
 
   constructor(
@@ -61,11 +66,11 @@ export abstract class LocationFieldBase extends FormComponent {
     const requiredMessage =
       config.requiredMessage ?? (messageTemplate.required as string)
 
-    const messages: LanguageMessages = {
+    const messages = convertToLanguageMessages({
       'any.required': requiredMessage,
       'string.empty': requiredMessage,
       'string.pattern.base': config.patternErrorMessage
-    }
+    })
 
     let formSchema = joi
       .string()

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

@@ -5,6 +5,7 @@ import { ComponentBase } from '~/src/server/plugins/engine/components/ComponentB
 export class Markdown extends ComponentBase {
   declare options: MarkdownComponent['options']
   content: MarkdownComponent['content']
+  headerStartLevel: number
 
   constructor(
     def: MarkdownComponent,
@@ -16,6 +17,7 @@ export class Markdown extends ComponentBase {
 
     this.content = content
     this.options = options
+    this.headerStartLevel = 2
   }
 
   getViewModel() {
@@ -23,7 +25,8 @@ export class Markdown extends ComponentBase {
 
     return {
       ...viewModel,
-      content
+      content,
+      headerStartLevel: this.headerStartLevel
     }
   }
 }

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

@@ -129,7 +129,7 @@ describe('NationalGridFieldNumberField', () => {
 
         expect(result.errors).toEqual([
           expect.objectContaining({
-            text: 'Enter Example National Grid field number'
+            text: 'Enter example National Grid field number'
           })
         ])
       })
@@ -293,7 +293,7 @@ describe('NationalGridFieldNumberField', () => {
               value: getFormData('NG1234567'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid National Grid field number for Grid field like NG 1234 5678'
+                  text: 'Enter a valid National Grid field number for grid field like NG 1234 5678'
                 })
               ])
             }
@@ -304,7 +304,7 @@ describe('NationalGridFieldNumberField', () => {
               value: getFormData('N123456789'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid National Grid field number for Grid field like NG 1234 5678'
+                  text: 'Enter a valid National Grid field number for grid field like NG 1234 5678'
                 })
               ])
             }
@@ -315,7 +315,7 @@ describe('NationalGridFieldNumberField', () => {
               value: getFormData('NGABCDEFGH'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid National Grid field number for Grid field like NG 1234 5678'
+                  text: 'Enter a valid National Grid field number for grid field like NG 1234 5678'
                 })
               ])
             }

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

@@ -1,6 +1,7 @@
 import { type NationalGridFieldNumberFieldComponent } from '@defra/forms-model'
 
 import { LocationFieldBase } from '~/src/server/plugins/engine/components/LocationFieldBase.js'
+import { createLowerFirstExpression } from '~/src/server/plugins/engine/components/helpers/index.js'
 
 export class NationalGridFieldNumberField extends LocationFieldBase {
   declare options: NationalGridFieldNumberFieldComponent['options']
@@ -12,10 +13,15 @@ export class NationalGridFieldNumberField extends LocationFieldBase {
     const pattern =
       /^((([sS]|[nN])[a-hA-Hj-zJ-Z])|(([tT]|[oO])[abfglmqrvwABFGLMQRVW])|([hH][l-zL-Z])|([jJ][lmqrvwLMQRVW]))\s?([0-9]{4})\s?([0-9]{4})$/
 
+    const patternTemplate =
+      'Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678'
+
     return {
       pattern,
-      patternErrorMessage: `Enter a valid National Grid field number for {{#title}} like NG 1234 5678`,
-      requiredMessage: 'Enter {{#title}}'
+      patternErrorMessage: createLowerFirstExpression(patternTemplate),
+      requiredMessage: createLowerFirstExpression(
+        'Enter {{lowerFirst(#title)}}'
+      )
     }
   }
 
@@ -23,8 +29,9 @@ export class NationalGridFieldNumberField extends LocationFieldBase {
     return [
       {
         type: 'pattern',
-        template:
-          'Enter a valid National Grid field number for {{#title}} like NG 1234 5678'
+        template: createLowerFirstExpression(
+          'Enter a valid National Grid field number for {{lowerFirst(#title)}} like NG 1234 5678'
+        )
       }
     ]
   }

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

@@ -135,7 +135,7 @@ describe('OsGridRefField', () => {
 
         expect(result.errors).toEqual([
           expect.objectContaining({
-            text: 'Enter Example OS grid reference'
+            text: 'Enter example OS grid reference'
           })
         ])
       })
@@ -308,7 +308,7 @@ describe('OsGridRefField', () => {
               value: getFormData('TQ12345'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid OS grid reference for Grid reference like TQ123456'
+                  text: 'Enter a valid OS grid reference for grid reference like TQ123456'
                 })
               ])
             }
@@ -319,7 +319,7 @@ describe('OsGridRefField', () => {
               value: getFormData('AA1234567'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid OS grid reference for Grid reference like TQ123456'
+                  text: 'Enter a valid OS grid reference for grid reference like TQ123456'
                 })
               ])
             }
@@ -330,7 +330,7 @@ describe('OsGridRefField', () => {
               value: getFormData('TQABCDEF'),
               errors: expect.arrayContaining([
                 expect.objectContaining({
-                  text: 'Enter a valid OS grid reference for Grid reference like TQ123456'
+                  text: 'Enter a valid OS grid reference for grid reference like TQ123456'
                 })
               ])
             }