@defra/forms-model 3.0.568 → 3.0.570

package/src/components/types.ts

@@ -27,6 +27,7 @@ interface FormFieldBase {
     optionalText?: boolean
     classes?: string
     customValidationMessages?: LanguageMessages
+    instructionText?: string
   }
 }
 
@@ -164,6 +165,59 @@ export interface UkAddressFieldComponent extends FormFieldBase {
   }
 }
 
+// Precise Location Fields
+export interface EastingNorthingFieldComponent extends FormFieldBase {
+  type: ComponentType.EastingNorthingField
+  options: FormFieldBase['options'] & {
+    condition?: string
+    customValidationMessage?: string
+  }
+  schema?: {
+    easting?: {
+      min?: number
+      max?: number
+    }
+    northing?: {
+      min?: number
+      max?: number
+    }
+  }
+}
+
+export interface OsGridRefFieldComponent extends FormFieldBase {
+  type: ComponentType.OsGridRefField
+  options: FormFieldBase['options'] & {
+    condition?: string
+    customValidationMessage?: string
+  }
+}
+
+export interface NationalGridFieldNumberFieldComponent extends FormFieldBase {
+  type: ComponentType.NationalGridFieldNumberField
+  options: FormFieldBase['options'] & {
+    condition?: string
+    customValidationMessage?: string
+  }
+}
+
+export interface LatLongFieldComponent extends FormFieldBase {
+  type: ComponentType.LatLongField
+  options: FormFieldBase['options'] & {
+    condition?: string
+    customValidationMessage?: string
+  }
+  schema?: {
+    latitude?: {
+      min?: number
+      max?: number
+    }
+    longitude?: {
+      min?: number
+      max?: number
+    }
+  }
+}
+
 // Date Fields
 export interface DatePartsFieldComponent extends DateFieldBase {
   type: ComponentType.DatePartsField
@@ -270,6 +324,10 @@ export type InputFieldsComponentsDef =
   | DatePartsFieldComponent
   | UkAddressFieldComponent
   | FileUploadFieldComponent
+  | EastingNorthingFieldComponent
+  | OsGridRefFieldComponent
+  | NationalGridFieldNumberFieldComponent
+  | LatLongFieldComponent
 
 // Components that render content
 export type ContentComponentsDef =

package/src/conditions/condition-operators.ts

@@ -80,7 +80,11 @@ export const customOperators = {
   [ComponentType.EmailAddressField]: withDefaults(textFieldOperators),
   [ComponentType.TelephoneNumberField]: defaultOperators,
   [ComponentType.SelectField]: defaultOperators,
-  [ComponentType.YesNoField]: defaultOperators
+  [ComponentType.YesNoField]: defaultOperators,
+  [ComponentType.EastingNorthingField]: defaultOperators,
+  [ComponentType.OsGridRefField]: defaultOperators,
+  [ComponentType.NationalGridFieldNumberField]: defaultOperators,
+  [ComponentType.LatLongField]: defaultOperators
 }
 
 export function getOperatorNames(fieldType?: ConditionalComponentType) {

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

@@ -19,7 +19,8 @@ import {
 export enum QuestionTypeSubGroup {
   WrittenAnswerSubGroup = 'writtenAnswerSub',
   DateSubGroup = 'dateSub',
-  ListSubGroup = 'listSub'
+  ListSubGroup = 'listSub',
+  LocationSubGroup = 'locationSub'
 }
 
 export const pageTypeSchema = Joi.string()
@@ -32,6 +33,7 @@ export const questionTypeSchema = Joi.string()
   .valid(
     QuestionTypeSubGroup.WrittenAnswerSubGroup,
     QuestionTypeSubGroup.DateSubGroup,
+    QuestionTypeSubGroup.LocationSubGroup,
     ComponentType.UkAddressField,
     ComponentType.TelephoneNumberField,
     ComponentType.FileUploadField,
@@ -60,7 +62,11 @@ export const questionTypeFullSchema = Joi.string()
     ComponentType.CheckboxesField,
     ComponentType.RadiosField,
     ComponentType.AutocompleteField,
-    ComponentType.SelectField
+    ComponentType.SelectField,
+    ComponentType.EastingNorthingField,
+    ComponentType.OsGridRefField,
+    ComponentType.NationalGridFieldNumberField,
+    ComponentType.LatLongField
   )
   .description('The specific component type to use for this question')
 
@@ -76,6 +82,8 @@ export const writtenAnswerSubSchema = Joi.string()
 export const dateSubSchema = Joi.string()
   .required()
   .valid(ComponentType.DatePartsField, ComponentType.MonthYearField)
+  .description('Subtype for date-related questions')
+
 export const listSubSchema = Joi.string()
   .required()
   .valid(
@@ -85,7 +93,17 @@ export const listSubSchema = Joi.string()
     ComponentType.AutocompleteField,
     ComponentType.SelectField
   )
-  .description('Subtype for date-related questions')
+  .description('Subtype for list-related questions')
+
+export const locationSubSchema = Joi.string()
+  .required()
+  .valid(
+    ComponentType.EastingNorthingField,
+    ComponentType.OsGridRefField,
+    ComponentType.NationalGridFieldNumberField,
+    ComponentType.LatLongField
+  )
+  .description('Subtype for location-related questions')
 
 export const nameSchema = Joi.string()
   .trim()
@@ -103,6 +121,14 @@ export const hintTextSchema = Joi.string()
   .allow('')
   .description('Optional guidance text displayed below the question')
 
+export const instructionTextSchema = Joi.string()
+  .trim()
+  .optional()
+  .allow('')
+  .description(
+    'Optional instruction text with markdown support to help users answer the question'
+  )
+
 export const questionOptionalSchema = Joi.string()
   .trim()
   .optional()
@@ -512,6 +538,7 @@ export const questionDetailsFullSchema = {
   fileTypesSchema,
   hintTextSchema,
   imageTypesSchema,
+  instructionTextSchema,
   jsEnabledSchema,
   listForQuestionSchema,
   listItemCountSchema,

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

@@ -57,7 +57,11 @@ const InputFieldComponentDictionary = {
   [ComponentType.CheckboxesField]: CheckboxQuestion,
   [ComponentType.SelectField]: SelectQuestion,
   [ComponentType.YesNoField]: YesNoQuestion,
-  [ComponentType.FileUploadField]: SupportingEvidenceQuestion
+  [ComponentType.FileUploadField]: SupportingEvidenceQuestion,
+  [ComponentType.EastingNorthingField]: ShortAnswerQuestion,
+  [ComponentType.OsGridRefField]: ShortAnswerQuestion,
+  [ComponentType.NationalGridFieldNumberField]: ShortAnswerQuestion,
+  [ComponentType.LatLongField]: ShortAnswerQuestion
 }
 
 /**

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

@@ -30,6 +30,11 @@ export interface FormEditor {
    */
   dateSub: string
 
+  /**
+   * The sub-type of location
+   */
+  locationSub: string
+
   /**
    * The sub-type of lists
    */
@@ -60,6 +65,16 @@ export interface FormEditor {
    */
   shortDescription: string
 
+  /**
+   * The value of checkbox to reveal instruction text field
+   */
+  giveInstructions: string
+
+  /**
+   * The instruction text for location components (optional)
+   */
+  instructionText: string
+
   /**
    * The value of checkbox to reveal heading and guidance section
    */
@@ -283,7 +298,12 @@ export interface FormEditor {
 
 export type FormEditorInputPage = Pick<
   FormEditor,
-  'pageType' | 'questionType' | 'writtenAnswerSub' | 'dateSub' | 'listSub'
+  | 'pageType'
+  | 'questionType'
+  | 'writtenAnswerSub'
+  | 'dateSub'
+  | 'locationSub'
+  | 'listSub'
 >
 
 export type FormEditorInputCheckAnswersSettings = Pick<
@@ -328,6 +348,8 @@ export type FormEditorInputQuestion = Pick<
   | 'listItemsData'
   | 'jsEnabled'
   | 'usePostcodeLookup'
+  | 'giveInstructions'
+  | 'instructionText'
 >
 
 export type FormEditorInputPageSettings = Pick<
@@ -522,6 +544,7 @@ export type GovukStringField = Omit<GovukField, 'value'> & { value: string }
 export interface FormEditorGovukField {
   question?: GovukField
   hintText?: GovukField
+  instructionText?: GovukField
   questionOptional?: GovukField
   shortDescription?: GovukField
   fileTypes?: GovukField

package/src/pages/helpers.ts

@@ -135,27 +135,6 @@ export function showRepeaterSettings(page: Page): boolean {
   return true
 }
 
-/**
- * High level check for whether file upload component should be omitted
- * @param { Page | undefined } page
- * @returns {boolean}
- */
-export function omitFileUploadComponent(page: Page | undefined): boolean {
-  if (page?.controller === ControllerType.Repeat) {
-    return true
-  }
-  if (!hasComponents(page)) {
-    return false
-  }
-  if (page.components.length > 1) {
-    return true
-  }
-  if (includesFileUploadField(page.components)) {
-    return true
-  }
-  return false
-}
-
 /**
  * Gets page title, or title of first question (if no page title set)
  * @param {Page} page

package/src/pages/index.ts

@@ -18,7 +18,6 @@ export {
   includesFileUploadField,
   isControllerName,
   isSummaryPage,
-  omitFileUploadComponent,
   showRepeaterSettings,
   summaryPageControllers
 } from '~/src/pages/helpers.js'