@defra/forms-engine-plugin 4.0.24 → 4.0.26

package/.server/server/utils/file-form-service.d.ts

@@ -33,6 +33,12 @@ export class FileFormService {
      * @returns {FormMetadata}
      */
     getFormMetadata(slug: string): FormMetadata;
+    /**
+     * Get the form metadata by form id
+     * @param {string} id - the form id
+     * @returns {FormMetadata}
+     */
+    getFormMetadataById(id: string): FormMetadata;
     /**
      * Get the form defintion by id
      * @param {string} id - the form id

package/.server/server/utils/file-form-service.js

@@ -89,6 +89,19 @@ export class FileFormService {
     return metadata;
   }
 
+  /**
+   * Get the form metadata by form id
+   * @param {string} id - the form id
+   * @returns {FormMetadata}
+   */
+  getFormMetadataById(id) {
+    const metadata = Array.from(this.#metadata.values()).find(form => form.id === id);
+    if (!metadata) {
+      throw new Error(`Form metadata id '${id}' not found`);
+    }
+    return metadata;
+  }
+
   /**
    * Get the form defintion by id
    * @param {string} id - the form id
@@ -116,6 +129,14 @@ export class FileFormService {
       getFormMetadata: slug => {
         return Promise.resolve(this.getFormMetadata(slug));
       },
+      /**
+       * Get the form metadata by form id
+       * @param {string} id
+       * @returns {Promise<FormMetadata>}
+       */
+      getFormMetadataById: id => {
+        return Promise.resolve(this.getFormMetadataById(id));
+      },
       /**
        * Get the form defintion by id
        * @param {string} id
@@ -129,6 +150,6 @@ export class FileFormService {
 }
 
 /**
- * @import { FormMetadata, FormDefinition } from '@defra/forms-model'
+ * @import { FormMetadata, FormDefinition, FormStatus } from '@defra/forms-model'
  */
 //# sourceMappingURL=file-form-service.js.map

package/.server/server/utils/file-form-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-form-service.js","names":["fs","path","YAML","FileFormService","metadata","Map","definition","addForm","filepath","readForm","set","slug","id","ext","extname","toLowerCase","readJsonForm","readYamlForm","Error","JSON","parse","readFile","getFormMetadata","get","getFormDefinition","toFormsService","Promise","resolve"],"sources":["../../../src/server/utils/file-form-service.js"],"sourcesContent":["import fs from 'fs/promises'\nimport path from 'node:path'\n\nimport YAML from 'yaml'\n\n/**\n * FileFormService class\n */\nexport class FileFormService {\n  /**\n   * The map of form metadatas by slug\n   * @type {Map<string, FormMetadata>}\n   */\n  #metadata = new Map()\n\n  /**\n   * The map of form definitions by id\n   * @type {Map<string, FormDefinition>}\n   */\n  #definition = new Map()\n\n  /**\n   * Add form from a file\n   * @param {string} filepath - the file path\n   * @param {FormMetadata} metadata - the metadata to use for this form\n   * @returns {Promise<FormDefinition>}\n   */\n  async addForm(filepath, metadata) {\n    const definition = await this.readForm(filepath)\n\n    this.#metadata.set(metadata.slug, metadata)\n    this.#definition.set(metadata.id, definition)\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readForm(filepath) {\n    const ext = path.extname(filepath).toLowerCase()\n\n    switch (ext) {\n      case '.json':\n        return this.readJsonForm(filepath)\n      case '.yaml':\n        return this.readYamlForm(filepath)\n      default:\n        throw new Error(`Invalid file extension '${ext}'`)\n    }\n  }\n\n  /**\n   * Read the form definition from a json file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readJsonForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from a yaml file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readYamlForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Get the form metadata by slug\n   * @param {string} slug - the form slug\n   * @returns {FormMetadata}\n   */\n  getFormMetadata(slug) {\n    const metadata = this.#metadata.get(slug)\n\n    if (!metadata) {\n      throw new Error(`Form metadata '${slug}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form defintion by id\n   * @param {string} id - the form id\n   * @returns {FormDefinition}\n   */\n  getFormDefinition(id) {\n    const definition = this.#definition.get(id)\n\n    if (!definition) {\n      throw new Error(`Form definition '${id}' not found`)\n    }\n\n    return definition\n  }\n\n  /**\n   * Returns a FormsService compliant interface\n   * @returns {import('~/src/server/types.js').FormsService}\n   */\n  toFormsService() {\n    return {\n      /**\n       * Get the form metadata by slug\n       * @param {string} slug\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadata: (slug) => {\n        return Promise.resolve(this.getFormMetadata(slug))\n      },\n\n      /**\n       * Get the form defintion by id\n       * @param {string} id\n       * @returns {Promise<FormDefinition>}\n       */\n      getFormDefinition: (id) => {\n        return Promise.resolve(this.getFormDefinition(id))\n      }\n    }\n  }\n}\n\n/**\n * @import { FormMetadata, FormDefinition } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,aAAa;AAC5B,OAAOC,IAAI,MAAM,WAAW;AAE5B,OAAOC,IAAI,MAAM,MAAM;;AAEvB;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;EACE,CAACC,QAAQ,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,CAACC,UAAU,GAAG,IAAID,GAAG,CAAC,CAAC;;EAEvB;AACF;AACA;AACA;AACA;AACA;EACE,MAAME,OAAOA,CAACC,QAAQ,EAAEJ,QAAQ,EAAE;IAChC,MAAME,UAAU,GAAG,MAAM,IAAI,CAACG,QAAQ,CAACD,QAAQ,CAAC;IAEhD,IAAI,CAAC,CAACJ,QAAQ,CAACM,GAAG,CAACN,QAAQ,CAACO,IAAI,EAAEP,QAAQ,CAAC;IAC3C,IAAI,CAAC,CAACE,UAAU,CAACI,GAAG,CAACN,QAAQ,CAACQ,EAAE,EAAEN,UAAU,CAAC;IAE7C,OAAOA,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,QAAQA,CAACD,QAAQ,EAAE;IACvB,MAAMK,GAAG,GAAGZ,IAAI,CAACa,OAAO,CAACN,QAAQ,CAAC,CAACO,WAAW,CAAC,CAAC;IAEhD,QAAQF,GAAG;MACT,KAAK,OAAO;QACV,OAAO,IAAI,CAACG,YAAY,CAACR,QAAQ,CAAC;MACpC,KAAK,OAAO;QACV,OAAO,IAAI,CAACS,YAAY,CAACT,QAAQ,CAAC;MACpC;QACE,MAAM,IAAIU,KAAK,CAAC,2BAA2BL,GAAG,GAAG,CAAC;IACtD;EACF;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,YAAYA,CAACR,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGa,IAAI,CAACC,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMW,YAAYA,CAACT,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGJ,IAAI,CAACkB,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEgB,eAAeA,CAACX,IAAI,EAAE;IACpB,MAAMP,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ,CAACmB,GAAG,CAACZ,IAAI,CAAC;IAEzC,IAAI,CAACP,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,kBAAkBP,IAAI,aAAa,CAAC;IACtD;IAEA,OAAOP,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACEoB,iBAAiBA,CAACZ,EAAE,EAAE;IACpB,MAAMN,UAAU,GAAG,IAAI,CAAC,CAACA,UAAU,CAACiB,GAAG,CAACX,EAAE,CAAC;IAE3C,IAAI,CAACN,UAAU,EAAE;MACf,MAAM,IAAIY,KAAK,CAAC,oBAAoBN,EAAE,aAAa,CAAC;IACtD;IAEA,OAAON,UAAU;EACnB;;EAEA;AACF;AACA;AACA;EACEmB,cAAcA,CAAA,EAAG;IACf,OAAO;MACL;AACN;AACA;AACA;AACA;MACMH,eAAe,EAAGX,IAAI,IAAK;QACzB,OAAOe,OAAO,CAACC,OAAO,CAAC,IAAI,CAACL,eAAe,CAACX,IAAI,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMa,iBAAiB,EAAGZ,EAAE,IAAK;QACzB,OAAOc,OAAO,CAACC,OAAO,CAAC,IAAI,CAACH,iBAAiB,CAACZ,EAAE,CAAC,CAAC;MACpD;IACF,CAAC;EACH;AACF;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"file-form-service.js","names":["fs","path","YAML","FileFormService","metadata","Map","definition","addForm","filepath","readForm","set","slug","id","ext","extname","toLowerCase","readJsonForm","readYamlForm","Error","JSON","parse","readFile","getFormMetadata","get","getFormMetadataById","Array","from","values","find","form","getFormDefinition","toFormsService","Promise","resolve"],"sources":["../../../src/server/utils/file-form-service.js"],"sourcesContent":["import fs from 'fs/promises'\nimport path from 'node:path'\n\nimport YAML from 'yaml'\n\n/**\n * FileFormService class\n */\nexport class FileFormService {\n  /**\n   * The map of form metadatas by slug\n   * @type {Map<string, FormMetadata>}\n   */\n  #metadata = new Map()\n\n  /**\n   * The map of form definitions by id\n   * @type {Map<string, FormDefinition>}\n   */\n  #definition = new Map()\n\n  /**\n   * Add form from a file\n   * @param {string} filepath - the file path\n   * @param {FormMetadata} metadata - the metadata to use for this form\n   * @returns {Promise<FormDefinition>}\n   */\n  async addForm(filepath, metadata) {\n    const definition = await this.readForm(filepath)\n\n    this.#metadata.set(metadata.slug, metadata)\n    this.#definition.set(metadata.id, definition)\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readForm(filepath) {\n    const ext = path.extname(filepath).toLowerCase()\n\n    switch (ext) {\n      case '.json':\n        return this.readJsonForm(filepath)\n      case '.yaml':\n        return this.readYamlForm(filepath)\n      default:\n        throw new Error(`Invalid file extension '${ext}'`)\n    }\n  }\n\n  /**\n   * Read the form definition from a json file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readJsonForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from a yaml file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readYamlForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Get the form metadata by slug\n   * @param {string} slug - the form slug\n   * @returns {FormMetadata}\n   */\n  getFormMetadata(slug) {\n    const metadata = this.#metadata.get(slug)\n\n    if (!metadata) {\n      throw new Error(`Form metadata '${slug}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form metadata by form id\n   * @param {string} id - the form id\n   * @returns {FormMetadata}\n   */\n  getFormMetadataById(id) {\n    const metadata = Array.from(this.#metadata.values()).find(\n      (form) => form.id === id\n    )\n\n    if (!metadata) {\n      throw new Error(`Form metadata id '${id}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form defintion by id\n   * @param {string} id - the form id\n   * @returns {FormDefinition}\n   */\n  getFormDefinition(id) {\n    const definition = this.#definition.get(id)\n\n    if (!definition) {\n      throw new Error(`Form definition '${id}' not found`)\n    }\n\n    return definition\n  }\n\n  /**\n   * Returns a FormsService compliant interface\n   * @returns {import('~/src/server/types.js').FormsService}\n   */\n  toFormsService() {\n    return {\n      /**\n       * Get the form metadata by slug\n       * @param {string} slug\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadata: (slug) => {\n        return Promise.resolve(this.getFormMetadata(slug))\n      },\n\n      /**\n       * Get the form metadata by form id\n       * @param {string} id\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadataById: (id) => {\n        return Promise.resolve(this.getFormMetadataById(id))\n      },\n\n      /**\n       * Get the form defintion by id\n       * @param {string} id\n       * @returns {Promise<FormDefinition>}\n       */\n      getFormDefinition: (id) => {\n        return Promise.resolve(this.getFormDefinition(id))\n      }\n    }\n  }\n}\n\n/**\n * @import { FormMetadata, FormDefinition, FormStatus } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,aAAa;AAC5B,OAAOC,IAAI,MAAM,WAAW;AAE5B,OAAOC,IAAI,MAAM,MAAM;;AAEvB;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;EACE,CAACC,QAAQ,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,CAACC,UAAU,GAAG,IAAID,GAAG,CAAC,CAAC;;EAEvB;AACF;AACA;AACA;AACA;AACA;EACE,MAAME,OAAOA,CAACC,QAAQ,EAAEJ,QAAQ,EAAE;IAChC,MAAME,UAAU,GAAG,MAAM,IAAI,CAACG,QAAQ,CAACD,QAAQ,CAAC;IAEhD,IAAI,CAAC,CAACJ,QAAQ,CAACM,GAAG,CAACN,QAAQ,CAACO,IAAI,EAAEP,QAAQ,CAAC;IAC3C,IAAI,CAAC,CAACE,UAAU,CAACI,GAAG,CAACN,QAAQ,CAACQ,EAAE,EAAEN,UAAU,CAAC;IAE7C,OAAOA,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,QAAQA,CAACD,QAAQ,EAAE;IACvB,MAAMK,GAAG,GAAGZ,IAAI,CAACa,OAAO,CAACN,QAAQ,CAAC,CAACO,WAAW,CAAC,CAAC;IAEhD,QAAQF,GAAG;MACT,KAAK,OAAO;QACV,OAAO,IAAI,CAACG,YAAY,CAACR,QAAQ,CAAC;MACpC,KAAK,OAAO;QACV,OAAO,IAAI,CAACS,YAAY,CAACT,QAAQ,CAAC;MACpC;QACE,MAAM,IAAIU,KAAK,CAAC,2BAA2BL,GAAG,GAAG,CAAC;IACtD;EACF;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,YAAYA,CAACR,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGa,IAAI,CAACC,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMW,YAAYA,CAACT,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGJ,IAAI,CAACkB,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEgB,eAAeA,CAACX,IAAI,EAAE;IACpB,MAAMP,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ,CAACmB,GAAG,CAACZ,IAAI,CAAC;IAEzC,IAAI,CAACP,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,kBAAkBP,IAAI,aAAa,CAAC;IACtD;IAEA,OAAOP,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACEoB,mBAAmBA,CAACZ,EAAE,EAAE;IACtB,MAAMR,QAAQ,GAAGqB,KAAK,CAACC,IAAI,CAAC,IAAI,CAAC,CAACtB,QAAQ,CAACuB,MAAM,CAAC,CAAC,CAAC,CAACC,IAAI,CACtDC,IAAI,IAAKA,IAAI,CAACjB,EAAE,KAAKA,EACxB,CAAC;IAED,IAAI,CAACR,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,qBAAqBN,EAAE,aAAa,CAAC;IACvD;IAEA,OAAOR,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACE0B,iBAAiBA,CAAClB,EAAE,EAAE;IACpB,MAAMN,UAAU,GAAG,IAAI,CAAC,CAACA,UAAU,CAACiB,GAAG,CAACX,EAAE,CAAC;IAE3C,IAAI,CAACN,UAAU,EAAE;MACf,MAAM,IAAIY,KAAK,CAAC,oBAAoBN,EAAE,aAAa,CAAC;IACtD;IAEA,OAAON,UAAU;EACnB;;EAEA;AACF;AACA;AACA;EACEyB,cAAcA,CAAA,EAAG;IACf,OAAO;MACL;AACN;AACA;AACA;AACA;MACMT,eAAe,EAAGX,IAAI,IAAK;QACzB,OAAOqB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACX,eAAe,CAACX,IAAI,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMa,mBAAmB,EAAGZ,EAAE,IAAK;QAC3B,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACT,mBAAmB,CAACZ,EAAE,CAAC,CAAC;MACtD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMkB,iBAAiB,EAAGlB,EAAE,IAAK;QACzB,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACH,iBAAiB,CAAClB,EAAE,CAAC,CAAC;MACpD;IACF,CAAC;EACH;AACF;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/utils/file-form-service.test.js

@@ -0,0 +1,86 @@
+import { join } from 'node:path';
+import { FormStatus } from "../routes/types.js";
+import { FileFormService } from "./file-form-service.js";
+describe('File-form-service', () => {
+  /** @type {FileFormService} */
+  let service;
+  beforeEach(async () => {
+    const now = new Date();
+    const user = {
+      id: 'user',
+      displayName: 'Username'
+    };
+    const author = {
+      createdAt: now,
+      createdBy: user,
+      updatedAt: now,
+      updatedBy: user
+    };
+    service = new FileFormService();
+    const metadata = {
+      organisation: 'Defra',
+      teamName: 'Team name',
+      teamEmail: 'team@defra.gov.uk',
+      submissionGuidance: "Thanks for your submission, we'll be in touch",
+      notificationEmail: 'email@domain.com',
+      ...author,
+      live: author
+    };
+    await service.addForm(`${join(import.meta.dirname, '../../../test/form/definitions')}/components.json`, {
+      ...metadata,
+      id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
+      title: 'Form test',
+      slug: 'form-test'
+    });
+  });
+  describe('metadata by slug', () => {
+    it('should get form metadata by slug', () => {
+      const meta = service.getFormMetadata('form-test');
+      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(meta.title).toBe('Form test');
+    });
+    it('should throw if not found', () => {
+      expect(() => service.getFormMetadata('form-test-missing')).toThrow("Form metadata 'form-test-missing' not found");
+    });
+  });
+  describe('metadata by id', () => {
+    it('should get form metadata by id', () => {
+      const meta = service.getFormMetadataById('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(meta.title).toBe('Form test');
+    });
+    it('should throw if not found', () => {
+      expect(() => service.getFormMetadataById('id-missing')).toThrow("Form metadata id 'id-missing' not found");
+    });
+  });
+  describe('definition by id', () => {
+    it('should get form definition by id', () => {
+      const form = service.getFormDefinition('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(form.name).toBe('All components');
+      expect(form.startPage).toBe('/all-components');
+    });
+    it('should throw if not found', () => {
+      expect(() => service.getFormDefinition('id-missing')).toThrow("Form definition 'id-missing' not found");
+    });
+  });
+  describe('toFormsService', () => {
+    it('should create interface', async () => {
+      const interfaceImpl = service.toFormsService();
+      const res1 = await interfaceImpl.getFormMetadata('form-test');
+      expect(res1.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(res1.title).toBe('Form test');
+      const res2 = await interfaceImpl.getFormMetadataById('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(res2.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31');
+      expect(res2.title).toBe('Form test');
+      const res3 = await interfaceImpl.getFormDefinition('95e92559-968d-44ae-8666-2b1ad3dffd31', FormStatus.Draft);
+      expect(res3?.name).toBe('All components');
+      expect(res3?.startPage).toBe('/all-components');
+    });
+  });
+  describe('readForm', () => {
+    it('should throw if invalid extension', async () => {
+      await expect(service.readForm('/some-folder/some-file.bad')).rejects.toThrow("Invalid file extension '.bad'");
+    });
+  });
+});
+//# sourceMappingURL=file-form-service.test.js.map

package/.server/server/utils/file-form-service.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-form-service.test.js","names":["join","FormStatus","FileFormService","describe","service","beforeEach","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","live","addForm","import","meta","dirname","title","slug","it","getFormMetadata","expect","toBe","toThrow","getFormMetadataById","form","getFormDefinition","name","startPage","interfaceImpl","toFormsService","res1","res2","res3","Draft","readForm","rejects"],"sources":["../../../src/server/utils/file-form-service.test.js"],"sourcesContent":["import { join } from 'node:path'\n\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\ndescribe('File-form-service', () => {\n  /** @type {FileFormService} */\n  let service\n  beforeEach(async () => {\n    const now = new Date()\n    const user = { id: 'user', displayName: 'Username' }\n    const author = {\n      createdAt: now,\n      createdBy: user,\n      updatedAt: now,\n      updatedBy: user\n    }\n    service = new FileFormService()\n    const metadata = {\n      organisation: 'Defra',\n      teamName: 'Team name',\n      teamEmail: 'team@defra.gov.uk',\n      submissionGuidance: \"Thanks for your submission, we'll be in touch\",\n      notificationEmail: 'email@domain.com',\n      ...author,\n      live: author\n    }\n    await service.addForm(\n      `${join(import.meta.dirname, '../../../test/form/definitions')}/components.json`,\n      {\n        ...metadata,\n        id: '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        title: 'Form test',\n        slug: 'form-test'\n      }\n    )\n  })\n\n  describe('metadata by slug', () => {\n    it('should get form metadata by slug', () => {\n      const meta = service.getFormMetadata('form-test')\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadata('form-test-missing')).toThrow(\n        \"Form metadata 'form-test-missing' not found\"\n      )\n    })\n  })\n\n  describe('metadata by id', () => {\n    it('should get form metadata by id', () => {\n      const meta = service.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadataById('id-missing')).toThrow(\n        \"Form metadata id 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('definition by id', () => {\n    it('should get form definition by id', () => {\n      const form = service.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(form.name).toBe('All components')\n      expect(form.startPage).toBe('/all-components')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormDefinition('id-missing')).toThrow(\n        \"Form definition 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('toFormsService', () => {\n    it('should create interface', async () => {\n      const interfaceImpl = service.toFormsService()\n      const res1 = await interfaceImpl.getFormMetadata('form-test')\n      expect(res1.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res1.title).toBe('Form test')\n\n      const res2 = await interfaceImpl.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(res2.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res2.title).toBe('Form test')\n\n      const res3 = await interfaceImpl.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        FormStatus.Draft\n      )\n      expect(res3?.name).toBe('All components')\n      expect(res3?.startPage).toBe('/all-components')\n    })\n  })\n\n  describe('readForm', () => {\n    it('should throw if invalid extension', async () => {\n      await expect(\n        service.readForm('/some-folder/some-file.bad')\n      ).rejects.toThrow(\"Invalid file extension '.bad'\")\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,IAAI,QAAQ,WAAW;AAEhC,SAASC,UAAU;AACnB,SAASC,eAAe;AAExBC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClC;EACA,IAAIC,OAAO;EACXC,UAAU,CAAC,YAAY;IACrB,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;IACtB,MAAMC,IAAI,GAAG;MAAEC,EAAE,EAAE,MAAM;MAAEC,WAAW,EAAE;IAAW,CAAC;IACpD,MAAMC,MAAM,GAAG;MACbC,SAAS,EAAEN,GAAG;MACdO,SAAS,EAAEL,IAAI;MACfM,SAAS,EAAER,GAAG;MACdS,SAAS,EAAEP;IACb,CAAC;IACDJ,OAAO,GAAG,IAAIF,eAAe,CAAC,CAAC;IAC/B,MAAMc,QAAQ,GAAG;MACfC,YAAY,EAAE,OAAO;MACrBC,QAAQ,EAAE,WAAW;MACrBC,SAAS,EAAE,mBAAmB;MAC9BC,kBAAkB,EAAE,+CAA+C;MACnEC,iBAAiB,EAAE,kBAAkB;MACrC,GAAGV,MAAM;MACTW,IAAI,EAAEX;IACR,CAAC;IACD,MAAMP,OAAO,CAACmB,OAAO,CACnB,GAAGvB,IAAI,CAACwB,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,gCAAgC,CAAC,kBAAkB,EAChF;MACE,GAAGV,QAAQ;MACXP,EAAE,EAAE,sCAAsC;MAC1CkB,KAAK,EAAE,WAAW;MAClBC,IAAI,EAAE;IACR,CACF,CAAC;EACH,CAAC,CAAC;EAEFzB,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMJ,IAAI,GAAGrB,OAAO,CAAC0B,eAAe,CAAC,WAAW,CAAC;MACjDC,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC0B,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAACG,OAAO,CAChE,6CACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,gCAAgC,EAAE,MAAM;MACzC,MAAMJ,IAAI,GAAGrB,OAAO,CAAC8B,mBAAmB,CACtC,sCACF,CAAC;MACDH,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC8B,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAACD,OAAO,CAC7D,yCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMM,IAAI,GAAG/B,OAAO,CAACgC,iBAAiB,CACpC,sCACF,CAAC;MACDL,MAAM,CAACI,IAAI,CAACE,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACxCD,MAAM,CAACI,IAAI,CAACG,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;IAChD,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAACgC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAACH,OAAO,CAC3D,wCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMU,aAAa,GAAGnC,OAAO,CAACoC,cAAc,CAAC,CAAC;MAC9C,MAAMC,IAAI,GAAG,MAAMF,aAAa,CAACT,eAAe,CAAC,WAAW,CAAC;MAC7DC,MAAM,CAACU,IAAI,CAAChC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACU,IAAI,CAACd,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMU,IAAI,GAAG,MAAMH,aAAa,CAACL,mBAAmB,CAClD,sCACF,CAAC;MACDH,MAAM,CAACW,IAAI,CAACjC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACW,IAAI,CAACf,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMW,IAAI,GAAG,MAAMJ,aAAa,CAACH,iBAAiB,CAChD,sCAAsC,EACtCnC,UAAU,CAAC2C,KACb,CAAC;MACDb,MAAM,CAACY,IAAI,EAAEN,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACzCD,MAAM,CAACY,IAAI,EAAEL,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;IACjD,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF7B,QAAQ,CAAC,UAAU,EAAE,MAAM;IACzB0B,EAAE,CAAC,mCAAmC,EAAE,YAAY;MAClD,MAAME,MAAM,CACV3B,OAAO,CAACyC,QAAQ,CAAC,4BAA4B,CAC/C,CAAC,CAACC,OAAO,CAACb,OAAO,CAAC,+BAA+B,CAAC;IACpD,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.24",
+  "version": "4.0.26",
   "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.585",
     "@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/HiddenField.test.ts

@@ -0,0 +1,188 @@
+import { ComponentType, type HiddenFieldComponent } from '@defra/forms-model'
+
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
+import {
+  getAnswer,
+  type Field
+} 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 { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
+
+describe('HiddenField', () => {
+  let model: FormModel
+
+  beforeEach(() => {
+    model = new FormModel(definition, {
+      basePath: 'test'
+    })
+  })
+
+  describe('Defaults', () => {
+    let def: HiddenFieldComponent
+    let collection: ComponentCollection
+    let field: Field
+
+    beforeEach(() => {
+      def = {
+        title: 'Hidden field',
+        name: 'myComponent',
+        type: ComponentType.HiddenField,
+        options: {}
+      } satisfies HiddenFieldComponent
+
+      collection = new ComponentCollection([def], { model })
+      field = collection.fields[0]
+    })
+
+    describe('Schema', () => {
+      it('uses component title as label as default', () => {
+        const { formSchema } = collection
+        const { keys } = formSchema.describe()
+
+        expect(keys).toHaveProperty(
+          'myComponent',
+          expect.objectContaining({
+            flags: expect.objectContaining({
+              label: 'Hidden field'
+            })
+          })
+        )
+      })
+
+      it('uses component name as keys', () => {
+        const { formSchema } = collection
+        const { keys } = formSchema.describe()
+
+        expect(field.keys).toEqual(['myComponent'])
+        expect(field.collection).toBeUndefined()
+
+        for (const key of field.keys) {
+          expect(keys).toHaveProperty(key)
+        }
+      })
+
+      it('is required by default', () => {
+        const { formSchema } = collection
+        const { keys } = formSchema.describe()
+
+        expect(keys).toHaveProperty(
+          'myComponent',
+          expect.objectContaining({
+            flags: expect.objectContaining({
+              presence: 'required'
+            })
+          })
+        )
+      })
+      it('accepts valid values', () => {
+        const result1 = collection.validate(getFormData('Hidden value'))
+        const result2 = collection.validate(getFormData('Hidden value 2'))
+
+        expect(result1.errors).toBeUndefined()
+        expect(result2.errors).toBeUndefined()
+      })
+
+      it('adds errors for empty value', () => {
+        const result = collection.validate(getFormData(''))
+
+        expect(result.errors).toEqual([
+          expect.objectContaining({
+            text: 'Enter hidden field'
+          })
+        ])
+      })
+
+      it('adds errors for invalid values', () => {
+        const result1 = collection.validate(getFormData(['invalid']))
+        const result2 = collection.validate(
+          // @ts-expect-error - Allow invalid param for test
+          getFormData({ unknown: 'invalid' })
+        )
+
+        expect(result1.errors).toBeTruthy()
+        expect(result2.errors).toBeTruthy()
+      })
+    })
+
+    describe('State', () => {
+      it('returns text from state', () => {
+        const state1 = getFormState('Hidden field')
+        const state2 = getFormState(null)
+
+        const answer1 = getAnswer(field, state1)
+        const answer2 = getAnswer(field, state2)
+
+        expect(answer1).toBe('Hidden field')
+        expect(answer2).toBe('')
+      })
+
+      it('returns payload from state', () => {
+        const state1 = getFormState('Hidden field')
+        const state2 = getFormState(null)
+
+        const payload1 = field.getFormDataFromState(state1)
+        const payload2 = field.getFormDataFromState(state2)
+
+        expect(payload1).toEqual(getFormData('Hidden field'))
+        expect(payload2).toEqual(getFormData())
+      })
+
+      it('returns value from state', () => {
+        const state1 = getFormState('Hidden field')
+        const state2 = getFormState(null)
+
+        const value1 = field.getFormValueFromState(state1)
+        const value2 = field.getFormValueFromState(state2)
+
+        expect(value1).toBe('Hidden field')
+        expect(value2).toBeUndefined()
+      })
+
+      it('returns context for conditions and form submission', () => {
+        const state1 = getFormState('Hidden field')
+        const state2 = getFormState(null)
+
+        const value1 = field.getContextValueFromState(state1)
+        const value2 = field.getContextValueFromState(state2)
+
+        expect(value1).toBe('Hidden field')
+        expect(value2).toBeNull()
+      })
+
+      it('returns state from payload', () => {
+        const payload1 = getFormData('Hidden field')
+        const payload2 = getFormData()
+
+        const value1 = field.getStateFromValidForm(payload1)
+        const value2 = field.getStateFromValidForm(payload2)
+
+        expect(value1).toEqual(getFormState('Hidden field'))
+        expect(value2).toEqual(getFormState(null))
+      })
+    })
+
+    describe('View model', () => {
+      it('sets Nunjucks component defaults', () => {
+        const viewModel = field.getViewModel(getFormData('Hidden field'))
+
+        expect(viewModel).toEqual(
+          expect.objectContaining({
+            label: { text: def.title },
+            name: 'myComponent',
+            id: 'myComponent',
+            value: 'Hidden field'
+          })
+        )
+      })
+    })
+
+    describe('AllPossibleErrors', () => {
+      it('should return errors', () => {
+        const errors = field.getAllPossibleErrors()
+        expect(errors.baseErrors).not.toBeEmpty()
+        expect(errors.advancedSettingsErrors).toBeEmpty()
+      })
+    })
+  })
+})

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

@@ -0,0 +1,68 @@
+import {
+  type HiddenFieldComponent,
+  type TextFieldComponent
+} from '@defra/forms-model'
+import joi, { type StringSchema } from 'joi'
+
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
+import { TextField } from '~/src/server/plugins/engine/components/TextField.js'
+import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
+import {
+  type ErrorMessageTemplateList,
+  type FormState,
+  type FormStateValue,
+  type FormSubmissionState
+} from '~/src/server/plugins/engine/types.js'
+
+export class HiddenField extends FormComponent {
+  declare formSchema: StringSchema
+  declare stateSchema: StringSchema
+  declare schema: TextFieldComponent['schema']
+  declare options: TextFieldComponent['options']
+
+  constructor(
+    def: HiddenFieldComponent,
+    props: ConstructorParameters<typeof FormComponent>[1]
+  ) {
+    super(def, props)
+
+    const { options } = def
+
+    let formSchema = joi.string().trim().label(this.label).required()
+
+    if (options.required === false) {
+      formSchema = formSchema.allow('')
+    }
+
+    this.formSchema = formSchema.default('')
+    this.stateSchema = formSchema.default(null).allow(null)
+    this.schema = {}
+    this.options = {}
+  }
+
+  getFormValueFromState(state: FormSubmissionState) {
+    const { name } = this
+    return this.getFormValue(state[name])
+  }
+
+  isValue(value?: FormStateValue | FormState): value is string {
+    return TextField.isText(value)
+  }
+
+  /**
+   * For error preview page that shows all possible errors on a component
+   */
+  getAllPossibleErrors(): ErrorMessageTemplateList {
+    return HiddenField.getAllPossibleErrors()
+  }
+
+  /**
+   * Static version of getAllPossibleErrors that doesn't require a component instance.
+   */
+  static getAllPossibleErrors(): ErrorMessageTemplateList {
+    return {
+      baseErrors: [{ type: 'required', template: messageTemplate.required }],
+      advancedSettingsErrors: []
+    }
+  }
+}

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/helpers/components.ts

@@ -34,6 +34,7 @@ export type Field = InstanceType<
   | typeof Components.TextField
   | typeof Components.UkAddressField
   | typeof Components.FileUploadField
+  | typeof Components.HiddenField
 >
 
 // Guidance component instances only
@@ -186,6 +187,10 @@ export function createComponent(
     case ComponentType.LatLongField:
       component = new Components.LatLongField(def, options)
       break
+
+    case ComponentType.HiddenField:
+      component = new Components.HiddenField(def, options)
+      break
   }
 
   if (typeof component === 'undefined') {

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

@@ -2,6 +2,7 @@ import { ComponentType, type ComponentDef } from '@defra/forms-model'
 
 import { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'
 import { EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'
+import { HiddenField } from '~/src/server/plugins/engine/components/HiddenField.js'
 import { LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'
 import { NationalGridFieldNumberField } from '~/src/server/plugins/engine/components/NationalGridFieldNumberField.js'
 import { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'
@@ -96,6 +97,22 @@ describe('helpers tests', () => {
     expect(component.name).toBe('testField')
     expect(component.title).toBe('Test National Grid')
   })
+
+  test('should create HiddenField component', () => {
+    const component = createComponent(
+      {
+        type: ComponentType.HiddenField,
+        name: 'hiddenField',
+        title: 'Hidden field',
+        options: {}
+      },
+      { model: formModel }
+    )
+
+    expect(component).toBeInstanceOf(HiddenField)
+    expect(component.name).toBe('hiddenField')
+    expect(component.title).toBe('Hidden field')
+  })
 })
 
 describe('ComponentBase tests', () => {

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

@@ -28,3 +28,4 @@ export { EastingNorthingField } from '~/src/server/plugins/engine/components/Eas
 export { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'
 export { NationalGridFieldNumberField } from '~/src/server/plugins/engine/components/NationalGridFieldNumberField.js'
 export { LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'
+export { HiddenField } from '~/src/server/plugins/engine/components/HiddenField.js'