Add and export JSON and YAML file loaders

[davidjamesstone]

Proposed change

Adds some convenient classes to remove the boilerplate involved when loading files from disk.
Supports both JSON definitions and YAML.

Usage:

import { FileFormService } from '@defra/forms-engine-plugin/file-form-service.js'

// Create shared form metadata
const now = new Date()
const user = { id: 'user', displayName: 'Username' }
const author = { createdAt: now, createdBy: user, updatedAt: now, updatedBy: user }
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
}

// Instantiate the file loader form service
const loader = new FileFormService()

// Add a Json form
await loader.addForm(
  'src/definitions/example-form.json', {
    ...metadata,
    id: '95e92559-968d-44ae-8666-2b1ad3dffd31',
    title: 'Example Json',
    slug: 'example-json'
  }
)

// Add a Yaml form
await loader.addForm(
  'src/definitions/example-form.yaml', {
    ...metadata,
    id: '641aeafd-13dd-40fa-9186-001703800efb',
    title: 'Example Yaml',
    slug: 'example-yaml'
  }
)

// Get the forms service
const formsService = loader.toFormsService()

Azure DevOps work item: https://dev.azure.com/defragovuk/DEFRA-CDP/_workitems/edit/543861

Type of change

• Bug fix
• New feature
• Breaking change
• Misc. (documentation, build updates, etc)

Checklist

• You have executed this code locally and it performs as expected.
• You have added tests to verify your code works.
• You have added code comments and JSDoc, where appropriate.
• There is no commented-out code.
• You have added developer docs in README.md and docs/* (where appropriate, e.g. new features).
• The tests are passing (npm run test).
• The linting checks are passing (npm run lint).
• The code has been formatted (npm run format).

[jbarnsley10]

Would this normally have a .yaml extension?

[davidjamesstone]

Thanks @jbarnsley10

[jbarnsley10]

Looks nice. Just that typo in the README to do with yaml extension

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud