@defra/forms-model 3.0.644 → 3.0.646

package/src/components/component-types.ts

@@ -198,7 +198,8 @@ export const ComponentTypes: readonly ComponentDef[] = Object.freeze([
     hint: '',
     options: {
       amount: 1,
-      description: 'payment desc'
+      description: 'payment desc',
+      conditionalAmounts: []
     }
   } as PaymentFieldComponent,
   {

package/src/components/types.ts

@@ -260,6 +260,11 @@ export interface PaymentFieldComponent extends FormFieldBase {
   options: FormFieldBase['options'] & {
     amount: number
     description: string
+    conditionalAmounts?: {
+      condition: string
+      amount: number
+    }[]
+    emailField?: string
   }
 }
 

package/src/form/form-definition/index.ts

@@ -580,10 +580,10 @@ export const componentSchema = Joi.object<ComponentDef>()
       amount: Joi.when('type', {
         is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
         then: Joi.number()
-          .min(0.3)
+          .min(0)
           .max(100000)
           .required()
-          .description('Payment amount in GBP (£0.30 - £100,000)')
+          .description('Payment amount in GBP (£0 - £100,000)')
       }).description('Payment amount - for PaymentField only'),
       description: Joi.when('type', {
         is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
@@ -591,7 +591,35 @@ export const componentSchema = Joi.object<ComponentDef>()
           .max(230)
           .required()
           .description('Payment description (max 230 chars)')
-      }).description('Payment description - for PaymentField only')
+      }).description('Payment description - for PaymentField only'),
+      conditionalAmounts: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
+        then: Joi.array()
+          .items(
+            Joi.object({
+              condition: Joi.string()
+                .trim()
+                .required()
+                .description('Condition ID for this amount'),
+              amount: Joi.number()
+                .min(0.3)
+                .max(100000)
+                .required()
+                .description('Amount in GBP when condition is true (min £0.30)')
+            })
+          )
+          .optional()
+          .description('Conditional payment amounts evaluated in order')
+      }).description('Conditional amounts - for PaymentField only'),
+      emailField: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
+        then: Joi.string()
+          .trim()
+          .optional()
+          .description(
+            'Name of EmailAddressField to prepopulate GOV.UK Pay email'
+          )
+      }).description('Email field reference - for PaymentField only')
     })
       .default({})
       .unknown(true)

package/src/form/form-metrics/enums.ts

@@ -0,0 +1,5 @@
+export enum FormMetricType {
+  HeadlineMetric = 'headline-metric',
+  OverviewMetric = 'overview-metric',
+  TimelineMetric = 'timeline-metric'
+}

package/src/form/form-metrics/types.ts

@@ -0,0 +1,39 @@
+import { type FormStatus } from '~/src/common/enums.js'
+import { type FormMetricType } from '~/src/form/form-metrics/enums.js'
+
+export interface FormHeadlineDetail {
+  count: number
+  countSevenDaysAgo: number
+  countThirtyDaysAgo: number
+  countOneYearAgo: number
+}
+
+export interface FormHeadlineMetric {
+  type: FormMetricType.HeadlineMetric
+  headlineCounts: Record<string, FormHeadlineDetail>
+  updatedAt: Date
+}
+
+export interface FormOverviewMetric {
+  type: FormMetricType.OverviewMetric
+  formId: string
+  formStatus: FormStatus
+  summaryMetrics: Record<string, number | string | string[]>
+  featureCounts: Record<string, number>
+  submissionsCount: number
+  updatedAt: Date
+}
+
+export interface FormTimelineMetric {
+  type: FormMetricType.TimelineMetric
+  formId: string
+  formStatus: FormStatus
+  metricName: string
+  metricValue: number
+  createdAt: Date
+}
+
+export type FormMetric =
+  | FormHeadlineMetric
+  | FormOverviewMetric
+  | FormTimelineMetric

package/src/index.ts

@@ -10,6 +10,8 @@ export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-definition/types.js'
 export * from '~/src/form/form-definition/helpers.js'
 export * from '~/src/form/form-metadata/index.js'
+export * from '~/src/form/form-metrics/enums.js'
+export * from '~/src/form/form-metrics/types.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/form-submission/enums.js'
 export * from '~/src/form/utils/index.js'

package/src/pages/helpers.ts

@@ -135,6 +135,47 @@ export function includesPaymentField(components: ComponentDef[]): boolean {
   )
 }
 
+/**
+ * Helper function to determine if a payment question already exists in the form
+ */
+export function hasPaymentQuestionInForm(definition: FormDefinition) {
+  if (definition.pages.length === 0) {
+    return false
+  }
+
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page)
+      ? includesPaymentField(page.components)
+      : false
+    if (hasPayment) {
+      return true
+    }
+  }
+  return false
+}
+
+/**
+ * Helper function to determine if a specific question type exists in the form
+ */
+export function hasSpecificQuestionTypeInForm(
+  definition: FormDefinition,
+  componentType: ComponentType
+) {
+  if (definition.pages.length === 0) {
+    return false
+  }
+
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page)
+      ? page.components.some((component) => component.type === componentType)
+      : false
+    if (hasPayment) {
+      return true
+    }
+  }
+  return false
+}
+
 const SHOW_REPEATER_CONTROLLERS = [ControllerType.Page, ControllerType.Repeat]
 
 export function showRepeaterSettings(page: Page): boolean {
@@ -207,6 +248,7 @@ export function replaceCustomControllers(definition: FormDefinition) {
   const standardControllers = new Set(
     Object.values(ControllerType)
       .filter((x) => x !== ControllerType.SummaryWithConfirmationEmail)
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
       .map((x) => x.toString())
   )
 
@@ -215,6 +257,7 @@ export function replaceCustomControllers(definition: FormDefinition) {
     pages: definition.pages.map((page) => {
       if (
         !standardControllers.has(
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
           (page.controller ?? ControllerType.Page).toString()
         )
       ) {

package/src/pages/index.ts

@@ -14,7 +14,9 @@ export {
   hasComponentsEvenIfNoNext,
   hasFormComponents,
   hasNext,
+  hasPaymentQuestionInForm,
   hasRepeater,
+  hasSpecificQuestionTypeInForm,
   includesFileUploadField,
   includesPaymentField,
   isControllerName,