@defra/forms-engine-plugin 4.0.24 → 4.0.26

package/src/server/services/cacheService.ts

@@ -6,6 +6,7 @@ import { type createServer } from '~/src/server/index.js'
 import {
   type AnyFormRequest,
   type AnyRequest,
+  type FormConfirmationState,
   type FormPayload,
   type FormState,
   type FormSubmissionError,
@@ -55,7 +56,7 @@ export class CacheService {
 
   async getConfirmationState(
     request: AnyFormRequest
-  ): Promise<{ confirmed?: true }> {
+  ): Promise<FormConfirmationState> {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
     const value = await this.cache.get(key)
 
@@ -64,7 +65,7 @@ export class CacheService {
 
   async setConfirmationState(
     request: AnyFormRequest,
-    confirmationState: { confirmed?: true }
+    confirmationState: FormConfirmationState
   ) {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
     const ttl = config.get('confirmationSessionTimeout')

package/src/server/types.ts

@@ -23,6 +23,7 @@ import { type CacheService } from '~/src/server/services/cacheService.js'
 
 export interface FormsService {
   getFormMetadata: (slug: string) => Promise<FormMetadata>
+  getFormMetadataById: (id: string) => Promise<FormMetadata>
   getFormDefinition: (
     id: string,
     state: FormStatus

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

@@ -97,6 +97,23 @@ 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
@@ -127,6 +144,15 @@ export class FileFormService {
         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
@@ -140,5 +166,5 @@ export class FileFormService {
 }
 
 /**
- * @import { FormMetadata, FormDefinition } from '@defra/forms-model'
+ * @import { FormMetadata, FormDefinition, FormStatus } from '@defra/forms-model'
  */

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

@@ -0,0 +1,114 @@
+import { join } from 'node:path'
+
+import { FormStatus } from '~/src/server/routes/types.js'
+import { FileFormService } from '~/src/server/utils/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'")
+    })
+  })
+})