@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/src/server/plugins/payment/service.js

@@ -1,11 +1,11 @@
 import { StatusCodes } from 'http-status-codes'
 
-import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+import { createLogger } from '../../common/helpers/logging/logger.js'
 import {
   buildPaymentInfo,
   convertPenceToPounds
-} from '~/src/server/plugins/engine/routes/payment-helper.js'
-import { get, post, postJson } from '~/src/server/services/httpService.js'
+} from '../engine/routes/payment-helper.js'
+import { get, post, postJson } from '../../services/httpService.js'
 
 const PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'
 const PAYMENT_ENDPOINT = '/v1/payments'
@@ -231,5 +231,5 @@ export class PaymentService {
 }
 
 /**
- * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from '~/src/server/plugins/payment/types.js'
+ * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from './types.js'
  */

package/src/server/plugins/postcode-lookup/index.js

@@ -1,4 +1,4 @@
-import { getRoutes } from '~/src/server/plugins/postcode-lookup/routes/index.js'
+import { getRoutes } from './routes/index.js'
 
 export const VIEW_PATH = 'src/server/plugins/postcode-lookup/views'
 
@@ -17,5 +17,5 @@ export const postcodeLookupPlugin = {
 
 /**
  * @import { NamedPlugin } from '@hapi/hapi'
- * @import { PostcodeLookupConfiguration } from '~/src/server/plugins/postcode-lookup/types.js'
+ * @import { PostcodeLookupConfiguration } from './types.js'
  */

package/src/server/plugins/postcode-lookup/models/index.js

@@ -1,7 +1,7 @@
 import Joi from 'joi'
 
-import * as service from '~/src/server/plugins/postcode-lookup/service.js'
-import { crumbSchema } from '~/src/server/schemas/index.js'
+import * as service from '../service.js'
+import { crumbSchema } from '../../../schemas/index.js'
 
 // Field names/ids
 const postcodeQueryFieldName = 'postcodeQuery'
@@ -550,5 +550,5 @@ export function manualViewModel(data, payload, err) {
 
 /**
  * @import { ObjectSchema, ValidationErrorItem } from 'joi'
- * @import { Address, PostcodeLookupDetailsData, PostcodeLookupDetailsPayload, PostcodeLookupManualPayload, PostcodeLookupSelectPayload, PostcodeLookupSessionData } from '~/src/server/plugins/postcode-lookup/types.js'
+ * @import { Address, PostcodeLookupDetailsData, PostcodeLookupDetailsPayload, PostcodeLookupManualPayload, PostcodeLookupSelectPayload, PostcodeLookupSessionData } from '../types.js'
  */

package/src/server/plugins/postcode-lookup/routes/index.js

@@ -2,7 +2,7 @@ import Boom from '@hapi/boom'
 import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
-import { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'
+import { EXTERNAL_STATE_APPENDAGE } from '../../../constants.js'
 import {
   JOURNEY_BASE_URL,
   detailsPayloadSchema,
@@ -13,8 +13,8 @@ import {
   selectViewModel,
   stepSchema,
   steps
-} from '~/src/server/plugins/postcode-lookup/models/index.js'
-import * as service from '~/src/server/plugins/postcode-lookup/service.js'
+} from '../models/index.js'
+import * as service from '../service.js'
 
 const viewName = 'postcode-lookup-details'
 
@@ -170,10 +170,14 @@ function postRoute(options) {
  * @param {PostcodeLookupConfiguration} options
  */
 async function detailsPostHandler(request, h, options) {
-  const { payload } = request
   const session = getSessionState(request)
   const { ordnanceSurveyApiKey: apiKey } = options
-  const { value: details, error } = detailsPayloadSchema.validate(payload)
+
+  /** @type {{ value: PostcodeLookupDetailsPayload, error?: import('joi').ValidationError }} */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const { value: details, error } = detailsPayloadSchema.validate(
+    request.payload
+  )
 
   let model
 
@@ -201,10 +205,12 @@ async function detailsPostHandler(request, h, options) {
  * @param {PostcodeLookupConfiguration} options
  */
 async function selectPostHandler(request, h, options) {
-  const { payload } = request
   const session = getSessionState(request)
   const { ordnanceSurveyApiKey: apiKey } = options
-  const { value: select, error } = selectPayloadSchema.validate(payload)
+
+  /** @type {{ value: PostcodeLookupSelectPayload, error?: import('joi').ValidationError }} */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const { value: select, error } = selectPayloadSchema.validate(request.payload)
 
   if (error) {
     const model = await selectViewModel({ session, apiKey }, select, error)
@@ -232,12 +238,16 @@ async function selectPostHandler(request, h, options) {
  * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h
  */
 function manualPostHandler(request, h) {
-  const { payload } = request
   const session = getSessionState(request)
 
-  const { value: manual, error } = manualPayloadSchema.validate(payload, {
-    abortEarly: false
-  })
+  /** @type {{ value: PostcodeLookupManualPayload, error?: import('joi').ValidationError }} */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const { value: manual, error } = manualPayloadSchema.validate(
+    request.payload,
+    {
+      abortEarly: false
+    }
+  )
 
   if (error) {
     const model = manualViewModel(session, manual, error)
@@ -254,7 +264,7 @@ function manualPostHandler(request, h) {
 
 /**
  * @import { ResponseToolkit, ServerRoute } from '@hapi/hapi'
- * @import { PostcodeLookupManualPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '~/src/server/plugins/postcode-lookup/types.js'
- * @import { FormRequestPayload, FormResponseToolkit } from '~/src/server/routes/types.js'
- * @import { ExternalStateAppendage } from '~/src/server/plugins/engine/types.js'
+ * @import { PostcodeLookupManualPayload, PostcodeLookupDetailsPayload, PostcodeLookupSelectPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '../types.js'
+ * @import { FormRequestPayload, FormResponseToolkit } from '../../../routes/types.js'
+ * @import { ExternalStateAppendage } from '../../engine/types.js'
  */

package/src/server/plugins/postcode-lookup/service.js

@@ -1,8 +1,8 @@
 import { getErrorMessage } from '@defra/forms-model'
 import Boom from '@hapi/boom'
 
-import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
-import { getJson } from '~/src/server/services/httpService.js'
+import { createLogger } from '../../common/helpers/logging/logger.js'
+import { getJson } from '../../services/httpService.js'
 
 const logger = createLogger()
 
@@ -19,7 +19,10 @@ function empty() {
  * @param {string} endpoint - the OS api endpoint
  */
 function logErrorAndReturnEmpty(err, endpoint) {
-  const msg = `${getErrorMessage(err)} ${(Boom.isBoom(err) && err.data?.payload?.error?.message) ?? ''}`
+  /** @type {{ payload?: { error?: { message?: string } } } | false} */
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const boomData = Boom.isBoom(err) && err.data
+  const msg = `${getErrorMessage(err)} ${(boomData && boomData.payload?.error?.message) ?? ''}`
 
   logger.error(err, `Exception occured calling OS places ${endpoint} - ${msg}}`)
 
@@ -184,5 +187,5 @@ function titleCase(address) {
 }
 
 /**
- * @import { Address, DeliveryPointAddress, DeliveryPointAddressResult } from '~/src/server/plugins/postcode-lookup/types.js'
+ * @import { Address, DeliveryPointAddress, DeliveryPointAddressResult } from './types.js'
  */

package/src/server/plugins/postcode-lookup/types.js

@@ -139,5 +139,5 @@
 
 /**
  * @import { Request } from '@hapi/hapi'
- * @import { FormPayload } from '~/src/server/plugins/engine/types.js'
+ * @import { FormPayload } from '../engine/types.js'
  */

package/src/server/plugins/session.ts

@@ -1,7 +1,7 @@
 import { type ServerRegisterPluginObject } from '@hapi/hapi'
 import yar, { type YarOptions } from '@hapi/yar'
 
-import { config } from '~/src/config/index.js'
+import { config } from '../../config/index.js'
 
 /**
  * Yar is used for temporary session data but not form submissions, e.g. UI helpers, session flags.

package/src/server/routes/index.ts

@@ -1,2 +1,2 @@
-export { default as publicRoutes } from '~/src/server/routes/public.js'
-export { default as dummyApiRoutes } from '~/src/server/routes/dummy-api.js'
+export { default as publicRoutes } from './public.js'
+export { default as dummyApiRoutes } from './dummy-api.js'

package/src/server/routes/public.ts

@@ -2,7 +2,7 @@ import { join } from 'node:path'
 
 import { type HandlerDecorations, type ServerRoute } from '@hapi/hapi'
 
-import { config } from '~/src/config/index.js'
+import { config } from '../../config/index.js'
 
 export default [
   {

package/src/server/routes/types.ts

@@ -4,7 +4,7 @@ import {
   type ResponseToolkit
 } from '@hapi/hapi'
 
-import { type FormPayload } from '~/src/server/plugins/engine/types.js'
+import { type FormPayload } from '../plugins/engine/types.js'
 
 export interface FormQuery extends Partial<Record<string, string>> {
   /**

package/src/server/schemas/index.ts

@@ -1,7 +1,7 @@
 import Joi from 'joi'
 
-import { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'
-import { FormAction, FormStatus } from '~/src/server/routes/types.js'
+import { type FormPayloadParams } from '../plugins/engine/types.js'
+import { FormAction, FormStatus } from '../routes/types.js'
 
 export const stateSchema = Joi.string<FormStatus>()
   .valid(FormStatus.Draft, FormStatus.Live)

package/src/server/secure-context.js

@@ -1,6 +1,6 @@
 import tls from 'node:tls'
 
-import { getTrustStoreCerts } from '~/src/server/utils/secure-context/get-trust-store-certs.js'
+import { getTrustStoreCerts } from './utils/secure-context/get-trust-store-certs.js'
 
 /**
  * @type {SecureContext}

package/src/server/services/cacheService.ts

@@ -2,17 +2,17 @@ import { type Server } from '@hapi/hapi'
 import * as Hoek from '@hapi/hoek'
 import unset from 'lodash/unset.js'
 
-import { config } from '~/src/config/index.js'
-import { type createServer } from '~/src/server/index.js'
+import { config } from '../../config/index.js'
+import { type createServer } from '../index.js'
 import {
   type AnyFormRequest,
-  type AnyRequest,
+  type CacheRequest,
   type FormConfirmationState,
   type FormPayload,
   type FormState,
   type FormSubmissionError,
   type FormSubmissionState
-} from '~/src/server/plugins/engine/types.js'
+} from '../plugins/engine/types.js'
 
 const partition = 'cache'
 
@@ -39,14 +39,14 @@ export class CacheService {
     this.logger = server.logger
   }
 
-  async getState(request: AnyRequest): Promise<FormSubmissionState> {
+  async getState(request: CacheRequest): Promise<FormSubmissionState> {
     const key = this.Key(request)
     const cached = await this.cache.get(key)
 
     return cached ?? {}
   }
 
-  async setState(request: AnyFormRequest, state: FormSubmissionState) {
+  async setState(request: CacheRequest, state: FormSubmissionState) {
     const key = this.Key(request)
     const ttl = config.get('sessionTimeout')
 
@@ -56,7 +56,7 @@ export class CacheService {
   }
 
   async getConfirmationState(
-    request: AnyFormRequest
+    request: CacheRequest
   ): Promise<FormConfirmationState> {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
     const value = await this.cache.get(key)
@@ -65,7 +65,7 @@ export class CacheService {
   }
 
   async setConfirmationState(
-    request: AnyFormRequest,
+    request: CacheRequest,
     confirmationState: FormConfirmationState
   ) {
     const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)
@@ -74,7 +74,7 @@ export class CacheService {
     return this.cache.set(key, confirmationState, ttl)
   }
 
-  async clearState(request: AnyFormRequest) {
+  async clearState(request: CacheRequest) {
     if (request.yar.id) {
       await this.cache.drop(this.Key(request))
     }
@@ -123,10 +123,7 @@ export class CacheService {
    * ```
    * @returns The updated state after removal
    */
-  async resetComponentStates(
-    request: AnyFormRequest,
-    componentNames: string[]
-  ) {
+  async resetComponentStates(request: CacheRequest, componentNames: string[]) {
     const state = await this.getState(request)
 
     for (const componentName of componentNames) {
@@ -142,15 +139,13 @@ export class CacheService {
    * @param request - hapi request object
    * @param additionalIdentifier - appended to the id
    */
-  Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {
+  Key(request: CacheRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {
     if (!request.yar.id) {
       throw new Error('No session ID found')
     }
 
-    // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
-    const state = (request.params.state as string) || ''
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-    const slug = (request.params.slug as string) || ''
+    const state = request.params.state ?? ''
+    const slug = request.params.slug ?? ''
     const key = `${request.yar.id}:${state}:${slug}:`
 
     return {

package/src/server/services/httpService.ts

@@ -1,6 +1,6 @@
 import Wreck from '@hapi/wreck'
 
-import { applyTraceHeaders } from '~/src/server/utils/utils.js'
+import { applyTraceHeaders } from '../utils/utils.js'
 
 export type Method = keyof Pick<typeof Wreck, 'get' | 'post' | 'put' | 'delete'>
 export type RequestOptions = Parameters<typeof Wreck.defaults>[0]

package/src/server/services/index.ts

@@ -1 +1 @@
-export { CacheService } from '~/src/server/services/cacheService.js'
+export { CacheService } from './cacheService.js'

package/src/server/types.ts

@@ -6,21 +6,21 @@ import {
 } from '@defra/forms-model'
 import { type Server } from '@hapi/hapi'
 
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
-import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
+import { type FormModel } from './plugins/engine/models/index.js'
+import { type DetailItem } from './plugins/engine/models/types.js'
+import { type PageController } from './plugins/engine/pageControllers/PageController.js'
 import {
   type FormContext,
   type OnRequestCallback,
   type PluginOptions,
   type PreparePageEventRequestOptions
-} from '~/src/server/plugins/engine/types.js'
-import { type PaymentService } from '~/src/server/plugins/payment/service.js'
+} from './plugins/engine/types.js'
+import { type PaymentService } from './plugins/payment/service.js'
 import {
   type FormRequestPayload,
   type FormStatus
-} from '~/src/server/routes/types.js'
-import { type CacheService } from '~/src/server/services/cacheService.js'
+} from './routes/types.js'
+import { type CacheService } from './services/cacheService.js'
 
 export interface FormsService {
   getFormMetadata: (slug: string) => Promise<FormMetadata>

package/src/server/utils/notify.ts

@@ -1,7 +1,7 @@
 import { token } from '@hapi/jwt'
 
-import { config } from '~/src/config/index.js'
-import { postJson } from '~/src/server/services/httpService.js'
+import { config } from '../../config/index.js'
+import { postJson } from '../services/httpService.js'
 
 const notifyAPIKey = config.get('notifyAPIKey')
 

package/src/server/utils/utils.js

@@ -1,7 +1,7 @@
 import { getTraceId } from '@defra/hapi-tracing'
 import Joi from 'joi'
 
-import { config } from '~/src/config/index.js'
+import { config } from '../../config/index.js'
 
 /**
  * Returns a set of headers to use in an HTTP request, merging them with any existing headers in options.

package/src/typings/hapi/index.d.ts

@@ -6,14 +6,14 @@ import {
   type COMPONENT_STATE_ERROR,
   type EXTERNAL_STATE_APPENDAGE,
   type EXTERNAL_STATE_PAYLOAD
-} from '~/src/server/constants.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
+} from '../../server/constants.js'
+import { type FormModel } from '../../server/plugins/engine/models/index.js'
 import {
   type AnyFormRequest,
   type FormSubmissionError,
   type PluginOptions
-} from '~/src/server/plugins/engine/types.ts'
-import { type CacheService } from '~/src/server/services/index.js'
+} from '../../server/plugins/engine/types.ts'
+import { type CacheService } from '../../server/services/index.js'
 
 declare module '@hapi/yar' {
   interface YarFlashes {

package/src/typings/joi/index.d.ts

@@ -1,4 +1,4 @@
-import { type FormPayload } from '~/src/server/plugins/engine/types.ts'
+import { type FormPayload } from '../../server/plugins/engine/types.ts'
 
 declare module 'joi' {
   interface Context {

package/src/server/common/helpers/logging/logger-options.test.ts

@@ -1,50 +0,0 @@
-import { getTraceId } from '@defra/hapi-tracing'
-
-import { loggerOptions } from '~/src/server/common/helpers/logging/logger-options.js'
-
-jest.mock('@defra/hapi-tracing', () => ({
-  getTraceId: jest.fn()
-}))
-
-describe('logger-options', () => {
-  beforeEach(() => {
-    jest.clearAllMocks()
-  })
-
-  describe('configuration', () => {
-    it('has the expected properties', () => {
-      expect(loggerOptions).toHaveProperty('enabled')
-      expect(loggerOptions).toHaveProperty('ignorePaths')
-      expect(loggerOptions).toHaveProperty('redact')
-      expect(loggerOptions).toHaveProperty('level')
-    })
-
-    it('ignores health endpoint', () => {
-      expect(loggerOptions.ignorePaths).toContain('/health')
-    })
-
-    it('has redaction configuration', () => {
-      expect(loggerOptions.redact).toBeDefined()
-    })
-  })
-
-  describe('mixin function', () => {
-    it('returns an empty object when no trace ID is available', () => {
-      jest.mocked(getTraceId).mockReturnValue(null)
-
-      const result = loggerOptions.mixin()
-      expect(result).toEqual({})
-    })
-
-    it('includes trace ID when available', () => {
-      jest.mocked(getTraceId).mockReturnValue('some-trace-id')
-
-      const result = loggerOptions.mixin()
-      expect(result).toEqual({
-        trace: {
-          id: 'some-trace-id'
-        }
-      })
-    })
-  })
-})