@defra/forms-model 3.0.643 → 3.0.645

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

@@ -52,9 +52,9 @@ import {
   type FormUploadedMessageData,
   type FormsBackupRequestedMessageData
 } from '~/src/form/form-audit/types.js'
+import { emailAddressNoUnicodeSchema } from '~/src/form/form-editor/index.js'
 import {
   contactSchema,
-  emailAddressSchema,
   emailResponseTimeSchema,
   idSchema,
   notificationEmailAddressSchema,
@@ -181,7 +181,7 @@ export const formSupportOnlineChanges = Joi.object<FormSupportOnlineChanges>()
 
 export const formSupportEmailChanges = Joi.object<FormSupportEmailChanges>()
   .keys({
-    address: emailAddressSchema.optional(),
+    address: emailAddressNoUnicodeSchema.optional(),
     responseTime: emailResponseTimeSchema.optional()
   })
   .description('Changes schema for FORM_SUPPORT_EMAIL_UPDATED event')
@@ -238,7 +238,7 @@ export const entitlementMessageData = Joi.object<EntitlementMessageData>().keys(
   {
     userId: Joi.string().required(),
     displayName: Joi.string().required(),
-    email: Joi.string().email().required(),
+    email: emailAddressNoUnicodeSchema.required(),
     roles: Joi.array().items(Joi.string())
   }
 )
@@ -260,7 +260,7 @@ export const excelGenerationMessageData =
     .keys({
       formId: Joi.string().required(),
       formName: Joi.string().required(),
-      notificationEmail: Joi.string().email().required()
+      notificationEmail: emailAddressNoUnicodeSchema.required()
     })
     .required()
     .description(

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

@@ -0,0 +1,2 @@
+export const MIN_NUMBER_OF_REPEAT_ITEMS = 1
+export const MAX_NUMBER_OF_REPEAT_ITEMS = 200

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

@@ -25,6 +25,10 @@ import {
   type RelativeDateValueData,
   type RelativeDateValueDataV2
 } from '~/src/conditions/types.js'
+import {
+  MAX_NUMBER_OF_REPEAT_ITEMS,
+  MIN_NUMBER_OF_REPEAT_ITEMS
+} from '~/src/form/form-definition/constants.js'
 import {
   isConditionListItemRefValueData,
   isFormDefinition
@@ -47,6 +51,7 @@ import {
   type RepeatSchema,
   type Section
 } from '~/src/form/form-definition/types.js'
+import { emailAddressNoUnicodeSchema } from '~/src/form/form-editor/index.js'
 import { checkErrors } from '~/src/form/form-manager/errors.js'
 import {
   FormDefinitionError,
@@ -348,9 +353,6 @@ const conditionSchema = Joi.object<ConditionData>()
       )
   })
 
-export const MIN_NUMBER_OF_REPEAT_ITEMS = 1
-export const MAX_NUMBER_OF_REPEAT_ITEMS = 200
-
 export const conditionDataSchemaV2 = Joi.object<ConditionDataV2>()
   .description('Condition definition')
   .keys({
@@ -1041,13 +1043,7 @@ const feedbackSchema = Joi.object<FormDefinition['feedback']>()
       .description(
         'URL to an external feedback form when not using built-in feedback'
       ),
-    emailAddress: Joi.string()
-      .trim()
-      .email({
-        tlds: {
-          allow: false
-        }
-      })
+    emailAddress: emailAddressNoUnicodeSchema
       .optional()
       .description('Email address where feedback is sent')
   })
@@ -1155,8 +1151,7 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
       .optional()
       .description('Phase banner configuration'),
     options: optionsSchema.optional().description('Options for the form'),
-    outputEmail: Joi.string()
-      .trim()
+    outputEmail: emailAddressNoUnicodeSchema
       .email({ tlds: { allow: ['uk'] } })
       .optional()
       .description('Email address where form submissions are sent'),
@@ -1165,8 +1160,7 @@ export const formDefinitionSchema = Joi.object<FormDefinition>()
       .description('Configuration for submission output format'),
     outputs: Joi.array()
       .items({
-        emailAddress: Joi.string()
-          .trim()
+        emailAddress: emailAddressNoUnicodeSchema
           .email({ tlds: { allow: ['uk'] } })
           .description('Email address where form submissions are sent'),
         audience: Joi.string()
@@ -1244,6 +1238,11 @@ export const formDefinitionV2Schema = formDefinitionSchema
   })
   .description('Form definition schema for V2')
 
+export {
+  MAX_NUMBER_OF_REPEAT_ITEMS,
+  MIN_NUMBER_OF_REPEAT_ITEMS
+} from '~/src/form/form-definition/constants.js'
+
 // Maintain compatibility with legacy named export
 // E.g. `import { Schema } from '@defra/forms-model'`
 export const Schema = formDefinitionSchema

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

@@ -5,7 +5,7 @@ import { ComponentType } from '~/src/components/enums.js'
 import {
   MAX_NUMBER_OF_REPEAT_ITEMS,
   MIN_NUMBER_OF_REPEAT_ITEMS
-} from '~/src/form/form-definition/index.js'
+} from '~/src/form/form-definition/constants.js'
 import {
   type FormEditorInputCheckAnswersSettings,
   type FormEditorInputPage,
@@ -16,6 +16,16 @@ import {
   type GovukFieldUsePostcodeLookup,
   type GovukStringField
 } from '~/src/form/form-editor/types.js'
+import { preventUnicodeInEmail } from '~/src/form/utils/prevent-unicode.js'
+
+export const emailAddressNoUnicodeSchema = Joi.string()
+  .trim()
+  .email()
+  .custom((value, helpers) => preventUnicodeInEmail(value, helpers))
+  .description('Email address preventing unicode characters')
+
+export const UNICODE_EMAIL_ERROR_MESSAGE =
+  'The email address you entered includes invalid characters, for example, long dashes'
 
 export enum QuestionTypeSubGroup {
   WrittenAnswerSubGroup = 'writtenAnswerSub',

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

@@ -1,5 +1,6 @@
 import Joi from 'joi'
 
+import { emailAddressNoUnicodeSchema } from '~/src/form/form-editor/index.js'
 import {
   type FormMetadata,
   type FormMetadataAuthor,
@@ -53,7 +54,7 @@ export const teamNameSchema = Joi.string()
   .required()
   .description('Name of the team responsible for the form')
 
-export const teamEmailSchema = Joi.string()
+export const teamEmailSchema = emailAddressNoUnicodeSchema
   .email({ tlds: { allow: ['uk'] } })
   .trim()
   .required()
@@ -63,9 +64,7 @@ export const phoneSchema = Joi.string()
   .trim()
   .description('Phone number for form-related inquiries')
 
-export const emailAddressSchema = Joi.string()
-  .email()
-  .trim()
+export const emailAddressSchema = emailAddressNoUnicodeSchema
   .required()
   .description('Email address for form-related inquiries')
 
@@ -132,10 +131,10 @@ export const termsAndConditionsAgreedSchema = Joi.boolean().description(
   'Whether the data protection terms and conditions have been agreed to'
 )
 
-export const notificationEmailAddressSchema = Joi.string()
-  .email()
-  .trim()
-  .description('Email address to receive form submission notifications')
+export const notificationEmailAddressSchema =
+  emailAddressNoUnicodeSchema.description(
+    'Email address to receive form submission notifications'
+  )
 
 export const authoredAtSchema = Joi.date()
   .iso()

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/form/utils/index.ts

@@ -1,2 +1,3 @@
 export { findStartPage } from '~/src/form/utils/find-start-page.js'
 export { findDefinitionListFromComponent } from '~/src/form/utils/list.js'
+export { preventUnicodeInEmail } from '~/src/form/utils/prevent-unicode.js'

package/src/form/utils/prevent-unicode.js

@@ -0,0 +1,19 @@
+/**
+ * Custom Joi validator to prevent Unicode characters in say an email address.
+ * Although Joi has Joi.email({ allowUnicode: false }), we can't differentiate from a general
+ * email format error or a Unicode error - hance the custom validator to allow a different error message
+ * @param {unknown} value
+ * @param {CustomHelpers<string>} helpers
+ */
+export function preventUnicodeInEmail(value, helpers) {
+  if (!value || typeof value !== 'string') {
+    return helpers.error('string.empty')
+  }
+  const invalidCharsRegex = /[^a-zA-Z0-9.!#$%&'*+/=?^_`{|}~@-]/
+  const invalid = invalidCharsRegex.exec(value)
+  return invalid ? helpers.error('string.unicode') : value
+}
+
+/**
+ * @import { type CustomHelpers } from 'joi'
+ */

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,