@defra/forms-engine-plugin 0.1.9 → 0.1.10

package/.server/server/forms/test.yaml

@@ -0,0 +1,363 @@
+---
+startPage: "/start"
+pages:
+- title: Start
+  path: "/start"
+  components: []
+  next:
+  - path: "/uk-passport"
+  controller: StartPageController
+- path: "/uk-passport"
+  components:
+  - type: YesNoField
+    name: ukPassport
+    title: Do you have a UK passport?
+    options:
+      required: true
+    schema: {}
+  section: checkBeforeYouStart
+  next:
+  - path: "/how-many-people"
+  - path: "/no-uk-passport"
+    condition: doesntHaveUKPassport
+  title: Do you have a UK passport?
+- path: "/no-uk-passport"
+  title: You're not eligible for this service
+  components:
+  - type: Html
+    name: html
+    title: Html
+    content: >-
+      <p class="govuk-body">
+        If you still think you're eligible please contact the Foreign and Commonwealth Office.
+      </p>
+    options: {}
+    schema: {}
+  next: []
+- path: "/how-many-people"
+  section: applicantDetails
+  components:
+  - options:
+      classes: govuk-input--width-10
+      required: true
+    type: SelectField
+    name: numberOfApplicants
+    title: How many applicants are there?
+    list: numberOfApplicants
+  next:
+  - path: "/applicant-one"
+  title: How many applicants are there?
+- path: "/applicant-one"
+  title: Applicant 1
+  section: applicantOneDetails
+  components:
+  - type: Html
+    name: html
+    title: Html
+    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
+    options: {}
+    schema: {}
+  - type: TextField
+    name: firstName
+    title: First name
+    options:
+      required: true
+    schema: {}
+  - options:
+      required: false
+      optionalText: false
+    type: TextField
+    name: middleName
+    title: Middle name
+    hint: If you have a middle name on your passport you must include it here
+    schema: {}
+  - type: TextField
+    name: lastName
+    title: Surname
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-one-address"
+- path: "/applicant-one-address"
+  section: applicantOneDetails
+  components:
+  - type: UkAddressField
+    name: address
+    title: Address
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-two"
+    condition: moreThanOneApplicant
+  - path: "/contact-details"
+  title: Address
+- path: "/applicant-two"
+  title: Applicant 2
+  section: applicantTwoDetails
+  components:
+  - type: Html
+    name: html
+    title: Html
+    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
+    options: {}
+    schema: {}
+  - type: TextField
+    name: firstName
+    title: First name
+    options:
+      required: true
+    schema: {}
+  - options:
+      required: false
+      optionalText: false
+    type: TextField
+    name: middleName
+    title: Middle name
+    hint: If you have a middle name on your passport you must include it here
+    schema: {}
+  - type: TextField
+    name: lastName
+    title: Surname
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-two-address"
+- path: "/applicant-two-address"
+  section: applicantTwoDetails
+  components:
+  - type: UkAddressField
+    name: address
+    title: Address
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-three"
+    condition: moreThanTwoApplicants
+  - path: "/contact-details"
+  title: Address
+- path: "/applicant-three"
+  title: Applicant 3
+  section: applicantThreeDetails
+  components:
+  - type: Html
+    name: html
+    title: Html
+    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
+    options: {}
+    schema: {}
+  - type: TextField
+    name: firstName
+    title: First name
+    options:
+      required: true
+    schema: {}
+  - options:
+      required: false
+      optionalText: false
+    type: TextField
+    name: middleName
+    title: Middle name
+    hint: If you have a middle name on your passport you must include it here
+    schema: {}
+  - type: TextField
+    name: lastName
+    title: Surname
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-three-address"
+- path: "/applicant-three-address"
+  section: applicantThreeDetails
+  components:
+  - type: UkAddressField
+    name: address
+    title: Address
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-four"
+    condition: moreThanThreeApplicants
+  - path: "/contact-details"
+  title: Address
+- path: "/applicant-four"
+  title: Applicant 4
+  section: applicantFourDetails
+  components:
+  - type: Html
+    name: html
+    title: Html
+    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
+    options: {}
+    schema: {}
+  - type: TextField
+    name: firstName
+    title: First name
+    options:
+      required: true
+    schema: {}
+  - options:
+      required: false
+      optionalText: false
+    type: TextField
+    name: middleName
+    title: Middle name
+    hint: If you have a middle name on your passport you must include it here
+    schema: {}
+  - type: TextField
+    name: lastName
+    title: Surname
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/applicant-four-address"
+- path: "/applicant-four-address"
+  section: applicantFourDetails
+  components:
+  - type: UkAddressField
+    name: address
+    title: Address
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/contact-details"
+  title: Address
+- path: "/contact-details"
+  section: applicantDetails
+  components:
+  - type: TelephoneNumberField
+    name: phoneNumber
+    title: Phone number
+    hint: If you haven't got a UK phone number, include country code
+    options:
+      required: true
+    schema: {}
+  - type: EmailAddressField
+    name: emailAddress
+    title: Your email address
+    options:
+      required: true
+    schema: {}
+  next:
+  - path: "/summary"
+  title: Applicant contact details
+- path: "/summary"
+  controller: SummaryPageController
+  title: Summary
+  components: []
+  next: []
+lists:
+- name: numberOfApplicants
+  title: Number of people
+  type: number
+  items:
+  - text: '1'
+    value: 1
+    description: ''
+    condition: ''
+  - text: '2'
+    value: 2
+    description: ''
+    condition: ''
+  - text: '3'
+    value: 3
+    description: ''
+    condition: ''
+  - text: '4'
+    value: 4
+    description: ''
+    condition: ''
+sections:
+- name: checkBeforeYouStart
+  title: Check before you start
+- name: applicantDetails
+  title: Applicant details
+- name: applicantOneDetails
+  title: Applicant 1
+- name: applicantTwoDetails
+  title: Applicant 2
+- name: applicantThreeDetails
+  title: Applicant 3
+- name: applicantFourDetails
+  title: Applicant 4
+phaseBanner: {}
+declaration: <p class="govuk-body">All the answers you have provided are true to the
+  best of your knowledge.</p>
+conditions:
+- name: hasUKPassport
+  displayName: hasUKPassport
+  value:
+    name: hasUKPassport
+    conditions:
+    - field:
+        name: checkBeforeYouStart.ukPassport
+        type: YesNoField
+        display: Do you have a UK passport?
+      operator: is
+      value:
+        type: Value
+        value: 'true'
+        display: 'true'
+- name: doesntHaveUKPassport
+  displayName: doesntHaveUKPassport
+  value:
+    name: doesntHaveUKPassport
+    conditions:
+    - field:
+        name: checkBeforeYouStart.ukPassport
+        type: YesNoField
+        display: Do you have a UK passport?
+      operator: is
+      value:
+        type: Value
+        value: 'false'
+        display: 'false'
+- name: moreThanOneApplicant
+  displayName: moreThanOneApplicant
+  value:
+    name: moreThanOneApplicant
+    conditions:
+    - field:
+        name: applicantDetails.numberOfApplicants
+        type: SelectField
+        display: How many applicants are there?
+      operator: is more than
+      value:
+        type: Value
+        value: '1'
+        display: '1'
+- name: moreThanTwoApplicants
+  displayName: moreThanTwoApplicants
+  value:
+    name: moreThanTwoApplicants
+    conditions:
+    - field:
+        name: applicantDetails.numberOfApplicants
+        type: SelectField
+        display: How many applicants are there?
+      operator: is more than
+      value:
+        type: Value
+        value: '2'
+        display: '2'
+- name: moreThanThreeApplicants
+  displayName: moreThanThreeApplicants
+  value:
+    name: moreThanThreeApplicants
+    conditions:
+    - field:
+        name: applicantDetails.numberOfApplicants
+        type: SelectField
+        display: How many applicants are there?
+      operator: is more than
+      value:
+        type: Value
+        value: '3'
+        display: '3'

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

@@ -0,0 +1,134 @@
+import fs from 'fs/promises';
+import path from 'node:path';
+import YAML from 'yaml';
+
+/**
+ * FileFormService class
+ */
+export class FileFormService {
+  /**
+   * The map of form metadatas by slug
+   * @type {Map<string, FormMetadata>}
+   */
+  #metadata = new Map();
+
+  /**
+   * The map of form definitions by id
+   * @type {Map<string, FormDefinition>}
+   */
+  #definition = new Map();
+
+  /**
+   * Add form from a file
+   * @param {string} filepath - the file path
+   * @param {FormMetadata} metadata - the metadata to use for this form
+   * @returns {Promise<FormDefinition>}
+   */
+  async addForm(filepath, metadata) {
+    const definition = await this.readForm(filepath);
+    this.#metadata.set(metadata.slug, metadata);
+    this.#definition.set(metadata.id, definition);
+    return definition;
+  }
+
+  /**
+   * Read the form definition from file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readForm(filepath) {
+    const ext = path.extname(filepath).toLowerCase();
+    switch (ext) {
+      case '.json':
+        return this.readJsonForm(filepath);
+      case '.yaml':
+        return this.readYamlForm(filepath);
+      default:
+        throw new Error(`Invalid file extension '${ext}'`);
+    }
+  }
+
+  /**
+   * Read the form definition from a json file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readJsonForm(filepath) {
+    /**
+     * @type {FormDefinition}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'));
+    return definition;
+  }
+
+  /**
+   * Read the form definition from a yaml file
+   * @param {string} filepath - the file path
+   * @returns {Promise<FormDefinition>}
+   */
+  async readYamlForm(filepath) {
+    /**
+     * @type {FormDefinition}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'));
+    return definition;
+  }
+
+  /**
+   * Get the form metadata by slug
+   * @param {string} slug - the form slug
+   * @returns {FormMetadata}
+   */
+  getFormMetadata(slug) {
+    const metadata = this.#metadata.get(slug);
+    if (!metadata) {
+      throw new Error(`Form metadata '${slug}' not found`);
+    }
+    return metadata;
+  }
+
+  /**
+   * Get the form defintion by id
+   * @param {string} id - the form id
+   * @returns {FormDefinition}
+   */
+  getFormDefinition(id) {
+    const definition = this.#definition.get(id);
+    if (!definition) {
+      throw new Error(`Form definition '${id}' not found`);
+    }
+    return definition;
+  }
+
+  /**
+   * Returns a FormsService compliant interface
+   * @returns {import('~/src/server/types.js').FormsService}
+   */
+  toFormsService() {
+    return {
+      /**
+       * Get the form metadata by slug
+       * @param {string} slug
+       * @returns {Promise<FormMetadata>}
+       */
+      getFormMetadata: slug => {
+        return Promise.resolve(this.getFormMetadata(slug));
+      },
+      /**
+       * Get the form defintion by id
+       * @param {string} id
+       * @returns {Promise<FormDefinition>}
+       */
+      getFormDefinition: id => {
+        return Promise.resolve(this.getFormDefinition(id));
+      }
+    };
+  }
+}
+
+/**
+ * @import { FormMetadata, FormDefinition } from '@defra/forms-model'
+ */
+//# sourceMappingURL=file-form-service.js.map

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

@@ -0,0 +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":[]}

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

@@ -0,0 +1,52 @@
+import { FormStatus } from "../routes/types.js";
+import { FileFormService } from "./file-form-service.js";
+
+// Create the metadata which is shared for all forms
+const now = new Date();
+const user = {
+  id: 'user',
+  displayName: 'Username'
+};
+const author = {
+  createdAt: now,
+  createdBy: user,
+  updatedAt: now,
+  updatedBy: user
+};
+const metadata = {
+  id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
+  slug: 'example-form',
+  title: 'Example form',
+  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
+};
+describe('File Form Service', () => {
+  it('should load JSON files from disk', async () => {
+    const loader = new FileFormService();
+    const definition = await loader.addForm('src/server/forms/test.json', metadata);
+    const formsService = loader.toFormsService();
+    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata);
+    expect(await formsService.getFormDefinition(metadata.id, FormStatus.Draft)).toBe(definition);
+    expect(() => loader.getFormMetadata('invalid-slug')).toThrow("Form metadata 'invalid-slug' not found");
+    expect(() => loader.getFormDefinition('invalid-id')).toThrow("Form definition 'invalid-id' not found");
+  });
+  it('should load YAML files from disk', async () => {
+    const loader = new FileFormService();
+    const definition = await loader.addForm('src/server/forms/test.yaml', metadata);
+    const formsService = loader.toFormsService();
+    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata);
+    expect(await formsService.getFormDefinition(metadata.id, FormStatus.Draft)).toBe(definition);
+    expect(() => loader.getFormMetadata('invalid-slug')).toThrow("Form metadata 'invalid-slug' not found");
+    expect(() => loader.getFormDefinition('invalid-id')).toThrow("Form definition 'invalid-id' not found");
+  });
+  it("should throw if the file isn't JSON or YAML", async () => {
+    const loader = new FileFormService();
+    await expect(loader.addForm('src/server/forms/test.txt', metadata)).rejects.toThrow("Invalid file extension '.txt'");
+  });
+});
+//# 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":["FormStatus","FileFormService","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","slug","title","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","live","describe","it","loader","definition","addForm","formsService","toFormsService","expect","getFormMetadata","toBe","getFormDefinition","Draft","toThrow","rejects"],"sources":["../../../src/server/utils/file-form-service.test.js"],"sourcesContent":["import { FormStatus } from '~/src/server/routes/types.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\n// Create the metadata which is shared for all forms\nconst now = new Date()\nconst user = { id: 'user', displayName: 'Username' }\nconst author = {\n  createdAt: now,\n  createdBy: user,\n  updatedAt: now,\n  updatedBy: user\n}\n\nconst metadata = {\n  id: '95e92559-968d-44ae-8666-2b1ad3dffd31',\n  slug: 'example-form',\n  title: 'Example form',\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\ndescribe('File Form Service', () => {\n  it('should load JSON files from disk', async () => {\n    const loader = new FileFormService()\n\n    const definition = await loader.addForm(\n      'src/server/forms/test.json',\n      metadata\n    )\n\n    const formsService = loader.toFormsService()\n    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata)\n    expect(\n      await formsService.getFormDefinition(metadata.id, FormStatus.Draft)\n    ).toBe(definition)\n\n    expect(() => loader.getFormMetadata('invalid-slug')).toThrow(\n      \"Form metadata 'invalid-slug' not found\"\n    )\n    expect(() => loader.getFormDefinition('invalid-id')).toThrow(\n      \"Form definition 'invalid-id' not found\"\n    )\n  })\n\n  it('should load YAML files from disk', async () => {\n    const loader = new FileFormService()\n\n    const definition = await loader.addForm(\n      'src/server/forms/test.yaml',\n      metadata\n    )\n\n    const formsService = loader.toFormsService()\n    expect(await formsService.getFormMetadata(metadata.slug)).toBe(metadata)\n    expect(\n      await formsService.getFormDefinition(metadata.id, FormStatus.Draft)\n    ).toBe(definition)\n\n    expect(() => loader.getFormMetadata('invalid-slug')).toThrow(\n      \"Form metadata 'invalid-slug' not found\"\n    )\n    expect(() => loader.getFormDefinition('invalid-id')).toThrow(\n      \"Form definition 'invalid-id' not found\"\n    )\n  })\n\n  it(\"should throw if the file isn't JSON or YAML\", async () => {\n    const loader = new FileFormService()\n\n    await expect(\n      loader.addForm('src/server/forms/test.txt', metadata)\n    ).rejects.toThrow(\"Invalid file extension '.txt'\")\n  })\n})\n"],"mappings":"AAAA,SAASA,UAAU;AACnB,SAASC,eAAe;;AAExB;AACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;AACtB,MAAMC,IAAI,GAAG;EAAEC,EAAE,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAW,CAAC;AACpD,MAAMC,MAAM,GAAG;EACbC,SAAS,EAAEN,GAAG;EACdO,SAAS,EAAEL,IAAI;EACfM,SAAS,EAAER,GAAG;EACdS,SAAS,EAAEP;AACb,CAAC;AAED,MAAMQ,QAAQ,GAAG;EACfP,EAAE,EAAE,sCAAsC;EAC1CQ,IAAI,EAAE,cAAc;EACpBC,KAAK,EAAE,cAAc;EACrBC,YAAY,EAAE,OAAO;EACrBC,QAAQ,EAAE,WAAW;EACrBC,SAAS,EAAE,mBAAmB;EAC9BC,kBAAkB,EAAE,+CAA+C;EACnEC,iBAAiB,EAAE,kBAAkB;EACrC,GAAGZ,MAAM;EACTa,IAAI,EAAEb;AACR,CAAC;AAEDc,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClCC,EAAE,CAAC,kCAAkC,EAAE,YAAY;IACjD,MAAMC,MAAM,GAAG,IAAItB,eAAe,CAAC,CAAC;IAEpC,MAAMuB,UAAU,GAAG,MAAMD,MAAM,CAACE,OAAO,CACrC,4BAA4B,EAC5Bb,QACF,CAAC;IAED,MAAMc,YAAY,GAAGH,MAAM,CAACI,cAAc,CAAC,CAAC;IAC5CC,MAAM,CAAC,MAAMF,YAAY,CAACG,eAAe,CAACjB,QAAQ,CAACC,IAAI,CAAC,CAAC,CAACiB,IAAI,CAAClB,QAAQ,CAAC;IACxEgB,MAAM,CACJ,MAAMF,YAAY,CAACK,iBAAiB,CAACnB,QAAQ,CAACP,EAAE,EAAEL,UAAU,CAACgC,KAAK,CACpE,CAAC,CAACF,IAAI,CAACN,UAAU,CAAC;IAElBI,MAAM,CAAC,MAAML,MAAM,CAACM,eAAe,CAAC,cAAc,CAAC,CAAC,CAACI,OAAO,CAC1D,wCACF,CAAC;IACDL,MAAM,CAAC,MAAML,MAAM,CAACQ,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAACE,OAAO,CAC1D,wCACF,CAAC;EACH,CAAC,CAAC;EAEFX,EAAE,CAAC,kCAAkC,EAAE,YAAY;IACjD,MAAMC,MAAM,GAAG,IAAItB,eAAe,CAAC,CAAC;IAEpC,MAAMuB,UAAU,GAAG,MAAMD,MAAM,CAACE,OAAO,CACrC,4BAA4B,EAC5Bb,QACF,CAAC;IAED,MAAMc,YAAY,GAAGH,MAAM,CAACI,cAAc,CAAC,CAAC;IAC5CC,MAAM,CAAC,MAAMF,YAAY,CAACG,eAAe,CAACjB,QAAQ,CAACC,IAAI,CAAC,CAAC,CAACiB,IAAI,CAAClB,QAAQ,CAAC;IACxEgB,MAAM,CACJ,MAAMF,YAAY,CAACK,iBAAiB,CAACnB,QAAQ,CAACP,EAAE,EAAEL,UAAU,CAACgC,KAAK,CACpE,CAAC,CAACF,IAAI,CAACN,UAAU,CAAC;IAElBI,MAAM,CAAC,MAAML,MAAM,CAACM,eAAe,CAAC,cAAc,CAAC,CAAC,CAACI,OAAO,CAC1D,wCACF,CAAC;IACDL,MAAM,CAAC,MAAML,MAAM,CAACQ,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAACE,OAAO,CAC1D,wCACF,CAAC;EACH,CAAC,CAAC;EAEFX,EAAE,CAAC,6CAA6C,EAAE,YAAY;IAC5D,MAAMC,MAAM,GAAG,IAAItB,eAAe,CAAC,CAAC;IAEpC,MAAM2B,MAAM,CACVL,MAAM,CAACE,OAAO,CAAC,2BAA2B,EAAEb,QAAQ,CACtD,CAAC,CAACsB,OAAO,CAACD,OAAO,CAAC,+BAA+B,CAAC;EACpD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/README.md

@@ -18,7 +18,9 @@ It is designed to be embedded in the frontend of a digital service and provide a
 
 ## Demo of DXT
 
-TODO: Link to CDP exemplar
+If you are within the Defra network, [see a live demo](https://forms-engine-plugin-example-ui.dev.cdp-int.defra.cloud/example-form).
+
+If you aren't within the Defra network, [see our example UI and run it locally](https://github.com/DEFRA/forms-engine-plugin-example-ui).
 
 ## Installation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -21,6 +21,7 @@
     "./file-upload.min.js": "./.public/javascripts/file-upload.min.js",
     "./file-upload.min.js.map": "./.public/javascripts/file-upload.min.js.map",
     "./application.min.css": "./.public/stylesheets/application.min.css",
+    "./file-form-service.js": "./.server/server/utils/file-form-service.js",
     "./controllers/*": "./.server/server/plugins/engine/pageControllers/*",
     "./services/*": "./.server/server/plugins/engine/services/*",
     "./package.json": "./package.json"
@@ -33,6 +34,7 @@
     "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "format": "npm run format:check -- --write",
     "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,scss,ts}\"",
+    "generate-schema-docs": "node scripts/generate-schema-docs.js",
     "postinstall": "npm run setup:husky",
     "lint": "npm run lint:editorconfig && npm run lint:js && npm run lint:types",
     "lint:editorconfig": "editorconfig-checker",
@@ -60,7 +62,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.432",
+    "@defra/forms-model": "^3.0.438",
     "@defra/hapi-tracing": "^1.0.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
@@ -102,7 +104,8 @@
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
     "proxy-agent": "^6.5.0",
-    "resolve": "^1.22.10"
+    "resolve": "^1.22.10",
+    "yaml": "^2.7.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",