@defra/forms-model 3.0.679 → 3.0.681

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/enums.ts

@@ -0,0 +1,5 @@
+export enum FormLibraryActions {
+  CREATE_DRAFT_FROM_LIVE = 'create-draft-from-live',
+  TAKE_FORM_OFFLINE = 'take-form-offline',
+  MAKE_ONLINE_AGAIN = 'make-online-again'
+}

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()
@@ -679,6 +685,7 @@ export const questionDetailsFullSchema = {
   regexSchema,
   rowsSchema,
   shortDescriptionSchema,
+  errorDescriptionSchema,
   suffixSchema,
   tabularDataTypesSchema,
   usePostcodeLookupSchema,
@@ -707,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
 }
 
@@ -717,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
 }
@@ -763,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

package/src/index.ts

@@ -16,6 +16,7 @@ export * from '~/src/form/form-metrics/index.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/form-submission/enums.js'
 export * from '~/src/form/utils/index.js'
+export * from '~/src/form/form-editor/enums.js'
 export * from '~/src/form/form-editor/index.js'
 export * from '~/src/form/form-editor/preview/index.js'
 export * from '~/src/form/form-manager/types.js'