@defra/forms-model 3.0.678 → 3.0.680

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

@@ -85,8 +85,7 @@ export interface FormTitleUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormTitleChanges>
 }
 
-export interface FormOrganisationUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormOrganisationUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormOrganisationChanges>
 }
 
@@ -98,43 +97,35 @@ export interface FormTeamEmailUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormTeamEmailChanges>
 }
 
-export interface FormSupportContactUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormSupportContactUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormSupportContactChanges>
 }
 
-export interface FormSupportPhoneUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormSupportPhoneUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormSupportPhoneChanges>
 }
 
-export interface FormSupportEmailUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormSupportEmailUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormSupportEmailChanges>
 }
 
-export interface FormSupportOnlineUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormSupportOnlineUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormSupportOnlineChanges>
 }
 
-export interface FormPrivacyNoticeUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormPrivacyNoticeUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormPrivacyNoticeChanges>
 }
 
-export interface FormTermsAndConditionsAgreedMessageData
-  extends FormMessageDataBase {
+export interface FormTermsAndConditionsAgreedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormTermsAndConditionsChanges>
 }
 
-export interface FormNotificationEmailUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormNotificationEmailUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormNotificationEmailChanges>
 }
 
-export interface FormSubmissionGuidanceUpdatedMessageData
-  extends FormMessageDataBase {
+export interface FormSubmissionGuidanceUpdatedMessageData extends FormMessageDataBase {
   changes: ChangesMessageData<FormSubmissionGuidanceChanges>
 }
 
@@ -321,24 +312,21 @@ export interface FormPrivacyNoticeUpdatedMessage extends ManagerMessageBase {
   data: FormPrivacyNoticeUpdatedMessageData
 }
 
-export interface FormTermsAndConditionsAgreedMessage
-  extends ManagerMessageBase {
+export interface FormTermsAndConditionsAgreedMessage extends ManagerMessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_TERMS_AND_CONDITIONS_AGREED
   source: AuditEventMessageSource.FORMS_MANAGER
   data: FormTermsAndConditionsAgreedMessageData
 }
 
-export interface FormNotificationEmailUpdatedMessage
-  extends ManagerMessageBase {
+export interface FormNotificationEmailUpdatedMessage extends ManagerMessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_NOTIFICATION_EMAIL_UPDATED
   source: AuditEventMessageSource.FORMS_MANAGER
   data: FormNotificationEmailUpdatedMessageData
 }
 
-export interface FormSubmissionGuidanceUpdatedMessage
-  extends ManagerMessageBase {
+export interface FormSubmissionGuidanceUpdatedMessage extends ManagerMessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_SUBMISSION_GUIDANCE_UPDATED
   source: AuditEventMessageSource.FORMS_MANAGER
@@ -419,29 +407,25 @@ export interface AuthenticationLoginMessage extends AuthenticationMessageBase {
   data: AuthenticationMessageData
 }
 
-export interface AuthenticationLogoutManualMessage
-  extends AuthenticationMessageBase {
+export interface AuthenticationLogoutManualMessage extends AuthenticationMessageBase {
   category: AuditEventMessageCategory.AUTHENTICATION
   type: AuditEventMessageType.AUTHENTICATION_LOGOUT_MANUAL
   data: AuthenticationMessageData
 }
 
-export interface AuthenticationLogoutAutoMessage
-  extends AuthenticationMessageBase {
+export interface AuthenticationLogoutAutoMessage extends AuthenticationMessageBase {
   category: AuditEventMessageCategory.AUTHENTICATION
   type: AuditEventMessageType.AUTHENTICATION_LOGOUT_AUTO
   data: AuthenticationMessageData
 }
 
-export interface AuthenticationLogoutDifferentDeviceMessage
-  extends AuthenticationMessageBase {
+export interface AuthenticationLogoutDifferentDeviceMessage extends AuthenticationMessageBase {
   category: AuditEventMessageCategory.AUTHENTICATION
   type: AuditEventMessageType.AUTHENTICATION_LOGOUT_DIFFERENT_DEVICE
   data: AuthenticationMessageData
 }
 
-export interface FormSubmissionExcelRequestedMessage
-  extends DesignerMessageBase {
+export interface FormSubmissionExcelRequestedMessage extends DesignerMessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.FORM_SUBMISSION_EXCEL_REQUESTED
   data: ExcelGenerationMessageData
@@ -459,8 +443,7 @@ export interface PlatformCsatExcelRequestedMessage extends DesignerMessageBase {
   data: ExcelGenerationMessageData
 }
 
-export interface PlatformMetricsDownloadRequestedMessage
-  extends DesignerMessageBase {
+export interface PlatformMetricsDownloadRequestedMessage extends DesignerMessageBase {
   category: AuditEventMessageCategory.FORM
   type: AuditEventMessageType.PLATFORM_METRICS_DOWNLOAD_REQUESTED
 }

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

@@ -28,7 +28,7 @@ export function isFormDefinition(
 /**
  * TypeGuard to check if something is a ConditionListItemRefValueDataV2
  * @param { unknown } conditionValueData
- * @returns { definition is ConditionListItemRefValueDataV2 }
+ * @returns { conditionValueData is ConditionListItemRefValueDataV2 }
  */
 export function isConditionListItemRefValueData(
   conditionValueData: unknown

package/src/form/form-editor/__stubs__/preview.js

@@ -85,6 +85,11 @@ export class QuestionPreviewElements {
    * @protected
    */
   _shortDesc = ''
+  /**
+   * @type {string}
+   * @protected
+   */
+  _errorDesc = ''
   /**
    * @type {string}
    * @protected
@@ -133,6 +138,7 @@ export class QuestionPreviewElements {
       hintText: this._hintText,
       optional: this._optional,
       shortDesc: this._shortDesc,
+      errorDesc: this._errorDesc,
       userClasses: this._userClasses,
       items: this._items,
       content: this._content
@@ -307,6 +313,7 @@ export const baseElements = /** @type {BaseSettings} */ ({
   hintText: 'Choose one adventure that best suits you.',
   userClasses: '',
   shortDesc: '',
+  errorDesc: '',
   content: '',
   largeTitle: true
 })
@@ -318,6 +325,7 @@ export const numberElements = /** @type {NumberSettings} */ ({
   hintText: 'Choose one adventure that best suits you.',
   userClasses: '',
   shortDesc: '',
+  errorDesc: '',
   content: '',
   largeTitle: true,
   prefix: '',
@@ -396,6 +404,11 @@ export class NumberPreviewElements {
    * @protected
    */
   _shortDesc = ''
+  /**
+   * @type {string}
+   * @protected
+   */
+  _errorDesc = ''
   /**
    * @type {string}
    * @protected
@@ -458,6 +471,7 @@ export class NumberPreviewElements {
       hintText: this._hintText,
       optional: this._optional,
       shortDesc: this._shortDesc,
+      errorDesc: this._errorDesc,
       userClasses: this._userClasses,
       prefix: this._prefix,
       suffix: this._suffix,

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

@@ -276,6 +276,12 @@ export const shortDescriptionSchema = Joi.string()
   .required()
   .description('Brief description of the question for internal use')
 
+export const errorDescriptionSchema = Joi.string()
+  .custom(rtrimOnly)
+  .allow('')
+  .optional()
+  .description('Description that will be displayed in error messages')
+
 export const pageHeadingAndGuidanceSchema = Joi.string()
   .trim()
   .optional()
@@ -496,8 +502,9 @@ type GenericRuleOptions<K extends string, T> = Omit<GetRuleOptions, 'args'> & {
   args: Record<K, T>
 }
 
-interface DSLSchema<TSchema = Record<string, unknown>[]>
-  extends ArraySchema<TSchema> {
+interface DSLSchema<
+  TSchema = Record<string, unknown>[]
+> extends ArraySchema<TSchema> {
   rowSeparator: (rowSep: string | RegExp) => DSLSchema<TSchema>
   row: (rowSep: string | RegExp) => DSLSchema<TSchema>
   colSeparator: (colSep: string | RegExp) => DSLSchema<TSchema>
@@ -678,6 +685,7 @@ export const questionDetailsFullSchema = {
   regexSchema,
   rowsSchema,
   shortDescriptionSchema,
+  errorDescriptionSchema,
   suffixSchema,
   tabularDataTypesSchema,
   usePostcodeLookupSchema,
@@ -706,7 +714,7 @@ export const formEditorInputPageSchema = Joi.object<FormEditorInputPage>()
   .required()
   .description('Input schema for creating a new page in the form editor')
 
-export const formEditorInputheckAnswersSettingsKeys = {
+export const formEditorInputCheckAnswersSettingsKeys = {
   declarationText: shortDescriptionSchema
 }
 
@@ -716,13 +724,14 @@ export const formEditorInputheckAnswersSettingsKeys = {
  */
 export const formEditorInputCheckAnswersSettingSchema =
   Joi.object<FormEditorInputCheckAnswersSettings>()
-    .keys(formEditorInputheckAnswersSettingsKeys)
+    .keys(formEditorInputCheckAnswersSettingsKeys)
     .required()
     .description('Configuration for the check-answers page')
 
 export const formEditorInputQuestionKeys = {
   question: questionSchema,
   shortDescription: shortDescriptionSchema,
+  errorDescription: errorDescriptionSchema,
   hintText: hintTextSchema,
   questionOptional: questionOptionalSchema
 }
@@ -762,6 +771,7 @@ export function govukFieldValueIsString(
     'question',
     'hintText',
     'shortDescription',
+    'errorDescription',
     'autoCompleteOptions',
     'classes',
     'prefix',

package/src/form/form-editor/preview/component-elements.js

@@ -26,6 +26,7 @@ export class ComponentElements {
       hintText: '',
       optional: !required,
       shortDesc: '',
+      errorDesc: '',
       userClasses:
         this._component.options && 'classes' in this._component.options
           ? (this._component.options.classes ?? '')

package/src/form/form-editor/preview/types.ts

@@ -20,6 +20,7 @@ export interface BaseSettings {
   hintText: string
   optional: boolean
   shortDesc: string
+  errorDesc: string
   userClasses: string
   items: ListElement[]
   content: string

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

@@ -72,6 +72,11 @@ export interface FormEditor {
    */
   shortDescription: string
 
+  /**
+   * The error description of the question
+   */
+  errorDescription: string
+
   /**
    * The value of checkbox to reveal instruction text field
    */
@@ -460,6 +465,7 @@ export type FormEditorInputQuestion = Pick<
   | 'name'
   | 'question'
   | 'shortDescription'
+  | 'errorDescription'
   | 'hintText'
   | 'declarationText'
   | 'questionOptional'
@@ -537,6 +543,7 @@ export type FormEditorInputQuestionDetails = Pick<
   | 'question'
   | 'hintText'
   | 'shortDescription'
+  | 'errorDescription'
   | 'questionOptional'
   | 'questionType'
   | 'fileTypes'
@@ -745,6 +752,7 @@ export interface FormEditorGovukField {
   instructionText?: GovukField
   questionOptional?: GovukField
   shortDescription?: GovukField
+  errorDescription?: GovukField
   fileTypes?: GovukField
   documentTypes?: GovukField
   imageTypes?: GovukField