@defra/forms-model 3.0.686 → 3.0.688

package/src/form/form-editor/translations/translations-overview.js

@@ -0,0 +1,137 @@
+import { lookupTranslation } from '~/src/form/form-editor/translations/translations-config.js'
+
+const formNameKey = 'form.title'
+const contactEmailAddressKey = 'form.contact.email.address'
+const contactEmailResponseKey = 'form.contact.email.responseTime'
+const contactOnlineUrlKey = 'form.contact.online.url'
+const contactOnlineTextKey = 'form.contact.online.text'
+const contactPhoneKey = 'form.contact.phone'
+const submissionGuidanceKey = 'form.submissionGuidance'
+const privacyNoticeUrlKey = 'form.privacyNoticeUrl'
+const privacyNoticeTextKey = 'form.privacyNoticeText'
+
+/**
+ * Determine a field value, either from the user-entered payload (validation) or from a translation lookup
+ * @param {string} key
+ * @param {Record<string, string>} translations
+ * @param {ValidationFailure<any>} [validation]
+ * @returns { string | undefined }
+ */
+function getTranslation(key, translations, validation) {
+  return validation?.formValues[key] ?? lookupTranslation(key, translations)
+}
+
+/**
+ * Build all translation rows in the form overview section (metatdata values).
+ * @param {FormMetadata} metadata
+ * @param {FormDefinition} definition
+ * @param {Record<string, string>} translations
+ * @param {ValidationFailure<any>} [validation]
+ * @returns {TranslationRow[]}
+ */
+export function buildOverviewSection(
+  metadata,
+  definition,
+  translations,
+  validation
+) {
+  /** @type {TranslationRow[]} */
+  const rows = []
+
+  rows.push(
+    {
+      name: formNameKey,
+      englishContent: definition.name,
+      welshContent: getTranslation(formNameKey, translations, validation),
+      label: 'Welsh form name'
+    },
+    {
+      name: contactEmailAddressKey,
+      englishContent: metadata.contact?.email?.address ?? 'Not set',
+      welshContent: getTranslation(
+        contactEmailAddressKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh support email address'
+    },
+    {
+      name: contactEmailResponseKey,
+      englishContent: metadata.contact?.email?.responseTime ?? '--',
+      welshContent: getTranslation(
+        contactEmailResponseKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh response time message'
+    },
+    {
+      name: contactOnlineUrlKey,
+      englishContent: metadata.contact?.online?.url ?? 'Not set',
+      welshContent: getTranslation(
+        contactOnlineUrlKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh contact link URL'
+    },
+    {
+      name: contactOnlineTextKey,
+      englishContent: metadata.contact?.online?.text ?? '--',
+      welshContent: getTranslation(
+        contactOnlineTextKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh text for the contact link'
+    },
+    {
+      name: contactPhoneKey,
+      englishContent: metadata.contact?.phone ?? 'Not set',
+      welshContent: getTranslation(contactPhoneKey, translations, validation),
+      label: 'Welsh phone number and opening times'
+    },
+    {
+      name: submissionGuidanceKey,
+      englishContent: metadata.submissionGuidance ?? 'Not set',
+      welshContent: getTranslation(
+        submissionGuidanceKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh information about what happens next'
+    }
+  )
+
+  if (metadata.privacyNoticeType === 'link') {
+    rows.push({
+      name: privacyNoticeUrlKey,
+      englishContent: metadata.privacyNoticeUrl ?? 'Not set',
+      welshContent: getTranslation(
+        privacyNoticeUrlKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh privacy notice URL'
+    })
+  } else {
+    rows.push({
+      name: privacyNoticeTextKey,
+      englishContent: metadata.privacyNoticeText ?? 'Not set',
+      welshContent: getTranslation(
+        privacyNoticeTextKey,
+        translations,
+        validation
+      ),
+      label: 'Welsh privacy notice text'
+    })
+  }
+
+  return /** @type {TranslationRow[]} */ (rows)
+}
+
+/**
+ * @import { FormMetadata } from '~/src/form/form-metadata/types.js'
+ * @import { FormDefinition } from '~/src/form/form-definition/types.js'
+ * @import { TranslationRow, ValidationFailure} from '~/src/form/form-editor/translations/translations-config.js'
+ */

package/src/form/form-editor/translations/translations.js

@@ -0,0 +1,297 @@
+import { ComponentType } from '~/src/components/enums.js'
+import { isListType, isTypeWithInstructions } from '~/src/components/helpers.js'
+import {
+  IGNORE_FIELDS,
+  TranslationRowTypes,
+  drillDown,
+  keyConfig,
+  lookupTranslation
+} from '~/src/form/form-editor/translations/translations-config.js'
+import { buildOverviewSection } from '~/src/form/form-editor/translations/translations-overview.js'
+import { getListFromComponent } from '~/src/form/utils/list.js'
+import { getPageNum, getQuestionNum } from '~/src/form/utils/numbering.js'
+import { ControllerType } from '~/src/pages/enums.js'
+import { hasComponents } from '~/src/pages/helpers.js'
+
+/**
+ * Create a translation row for a single entity field.
+ * @param {ComponentDef | Page | Item} entity - The source entity that contains the English content.
+ * @param {string} keyType - The translation row type to build.
+ * @param {{ pageNum: number, questionNum?: number, itemNum?: number, translations: Record<string, string>, validation?: ValidationFailure<any> }} options - The row context including numbering and translation values.
+ * @returns {TranslationRow} The populated translation row for the entity field.
+ */
+function createRow(
+  entity,
+  keyType,
+  { pageNum, questionNum, itemNum, translations, validation }
+) {
+  const keyProperties = keyConfig[keyType]
+
+  const innerEnglishContent = drillDown(
+    keyType,
+    entity,
+    keyProperties.jsonSuffix
+  )
+
+  const keyName = `${keyProperties.jsonPrefix}.${entity.id}.${keyProperties.jsonSuffix}`
+
+  return {
+    name: keyName,
+    type: keyType,
+    pageNum,
+    questionNum,
+    itemNum,
+    englishContent: innerEnglishContent,
+    welshContent:
+      validation?.formValues[keyName] ??
+      lookupTranslation(keyName, translations),
+    label: keyProperties.getLabel(pageNum, questionNum, itemNum)
+  }
+}
+
+const allowedControllerTypesSet = new Set([
+  ControllerType.Page,
+  ControllerType.Repeat,
+  ControllerType.Start,
+  ControllerType.FileUpload,
+  ControllerType.Terminal
+])
+
+/**
+ * Build the translation rows for a single page.
+ * @param {Page} page - The page definition to inspect for translatable content.
+ * @param {number} pageNum - The page number used in the generated labels.
+ * @param {Record<string, string>} translations - Existing Welsh translations keyed by translation name.
+ * @param {ValidationFailure<any>} [validation] - Optional validation context for posted form values.
+ * @returns {TranslationRow[]} The translation rows generated for the page.
+ */
+function buildPage(page, pageNum, translations, validation) {
+  if (page.controller && !allowedControllerTypesSet.has(page.controller)) {
+    return []
+  }
+
+  const translationRows = []
+  if (page.title) {
+    const keyProperties = keyConfig[TranslationRowTypes.PageHeading]
+
+    const keyName = `${keyProperties.jsonPrefix}.${page.id}.${keyProperties.jsonSuffix}`
+
+    translationRows.push({
+      name: keyName,
+      type: TranslationRowTypes.PageHeading,
+      pageNum,
+      englishContent: page.title,
+      welshContent:
+        validation?.formValues[keyName] ??
+        lookupTranslation(keyName, translations),
+      label: keyProperties.getLabel(pageNum)
+    })
+  }
+
+  const guidance =
+    hasComponents(page) && page.components[0].type === ComponentType.Markdown
+      ? page.components[0]
+      : undefined
+  if (guidance) {
+    const keyProperties = keyConfig[TranslationRowTypes.PageGuidance]
+    const keyName = `${keyProperties.jsonPrefix}.${guidance.id}.${keyProperties.jsonSuffix}`
+
+    translationRows.push({
+      name: keyName,
+      type: TranslationRowTypes.PageGuidance,
+      pageNum,
+      englishContent: guidance.content,
+      welshContent:
+        validation?.formValues[keyName] ??
+        lookupTranslation(keyName, translations),
+      label: keyProperties.getLabel(pageNum)
+    })
+  }
+
+  if (page.controller === ControllerType.Repeat) {
+    const keyProperties = keyConfig[TranslationRowTypes.RepeatTitle]
+    const keyName = `${keyProperties.jsonPrefix}.${page.id}.${keyProperties.jsonSuffix}`
+
+    translationRows.push({
+      name: keyName,
+      type: TranslationRowTypes.RepeatTitle,
+      pageNum,
+      englishContent: page.repeat.options.title,
+      welshContent:
+        validation?.formValues[keyName] ??
+        lookupTranslation(keyName, translations),
+      label: keyProperties.getLabel(pageNum)
+    })
+  }
+
+  return translationRows
+}
+
+/**
+ * Build the translation rows for a single component.
+ * @param {FormDefinition} definition - The overall form definition used to resolve list-based content.
+ * @param {ComponentDef} component - The component to inspect for translatable fields.
+ * @param {number} pageNum - The page number used in the generated labels.
+ * @param {number} questionNum - The question number used in the generated labels.
+ * @param {Record<string, string>} translations - Existing Welsh translations keyed by translation name.
+ * @param {ValidationFailure<any>} [validation] - Optional validation context for posted form values.
+ * @returns {TranslationRow[]} The translation rows generated for the component.
+ */
+function buildComponent(
+  definition,
+  component,
+  pageNum,
+  questionNum,
+  translations,
+  validation
+) {
+  if (IGNORE_FIELDS.includes(component.type)) {
+    return []
+  }
+
+  const rows = []
+
+  const options = { pageNum, questionNum, translations, validation }
+
+  const typed = /** @type {InputFieldsComponentsDef} */ (component)
+  if (typed.title && component.type !== ComponentType.PaymentField) {
+    rows.push(createRow(component, TranslationRowTypes.QuestionText, options))
+  }
+  if (typed.hint) {
+    rows.push(createRow(component, TranslationRowTypes.QuestionHint, options))
+  }
+
+  if (component.type !== ComponentType.PaymentField) {
+    rows.push(
+      createRow(component, TranslationRowTypes.ShortDescription, options)
+    )
+  } else {
+    rows.push(
+      createRow(component, TranslationRowTypes.PaymentDescription, options)
+    )
+  }
+
+  if (component.type === ComponentType.DeclarationField) {
+    rows.push(
+      createRow(component, TranslationRowTypes.DeclarationBody, options)
+    )
+  }
+
+  if (component.type === ComponentType.PaymentField) {
+    rows.push(
+      createRow(component, TranslationRowTypes.PaymentDescription, options)
+    )
+  }
+
+  if (typed.options.instructionText && isTypeWithInstructions(component.type)) {
+    rows.push(
+      createRow(component, TranslationRowTypes.InstructionText, options)
+    )
+  }
+
+  if (isListType(component.type)) {
+    addSelectionOptions(rows, component, definition, options)
+  }
+  return rows
+}
+
+/**
+ * Add translation rows for the select item options of a list-based component.
+ * @param {any[]} rows - The accumulator for translation rows.
+ * @param {ComponentDef} component - The list-based component to inspect.
+ * @param {FormDefinition} definition - The form definition that contains the option list data.
+ * @param {{ pageNum: number, questionNum?: number, translations: Record<string, string>, validation?: ValidationFailure<any> }} options - The row context including numbering and translation values.
+ */
+function addSelectionOptions(rows, component, definition, options) {
+  // Temporary workaround - ignore for Yes/No and use defaults in the plugin,
+  // until we create a solution that allows users to override the Yes/No options
+  if (component.type === ComponentType.YesNoField) {
+    return
+  }
+
+  const list = getListFromComponent(component, definition)
+  if (list?.items.length) {
+    let itemNum = 0
+    for (const item of list.items) {
+      itemNum++
+      const listOptions = {
+        ...options,
+        itemNum
+      }
+      if (item.hint) {
+        rows.push(
+          createRow(item, TranslationRowTypes.ListItemText, listOptions),
+          createRow(item, TranslationRowTypes.ListItemHint, listOptions)
+        )
+      } else {
+        rows.push(
+          createRow(item, TranslationRowTypes.ListItemText, listOptions)
+        )
+      }
+    }
+  }
+}
+
+/**
+ * Build the overview and form translation rows for a form definition.
+ * @param {FormMetadata} metadata - The form metadata used to build the overview section.
+ * @param {FormDefinition} definition - The form definition containing pages and components.
+ * @param {ValidationFailure<any>} [validation] - Optional validation context for posted form values.
+ * @returns {{ overviewRows: TranslationRow[], formRows: TranslationRow[] }} The generated overview and form translation rows.
+ */
+export function buildTranslationDataRows(metadata, definition, validation) {
+  const translationsJSON = /** @type {Record<string, string>} */ (
+    // @ts-expect-error - dynamic language definition
+    definition.metadata?.translations?.cy
+  )
+
+  const overviewRows = buildOverviewSection(
+    metadata,
+    definition,
+    translationsJSON,
+    validation
+  )
+
+  const formRows = []
+  for (const page of definition.pages) {
+    const pageId = /** @type {string} */ (page.id)
+    const pageNum = getPageNum(definition, pageId)
+    const components = hasComponents(page) ? page.components : []
+    if (components.length === 0) {
+      continue
+    }
+
+    formRows.push(...buildPage(page, pageNum, translationsJSON, validation))
+
+    for (const component of components) {
+      if (component.type === ComponentType.Markdown) {
+        continue
+      }
+      const questionId = /** @type {string} */ (component.id)
+      const questionNum = getQuestionNum(definition, pageId, questionId)
+
+      formRows.push(
+        ...buildComponent(
+          definition,
+          component,
+          pageNum,
+          questionNum,
+          translationsJSON,
+          validation
+        )
+      )
+    }
+  }
+
+  return {
+    overviewRows,
+    formRows
+  }
+}
+
+/**
+ * @import { ComponentDef, InputFieldsComponentsDef } from '~/src/components/types.js'
+ * @import { FormMetadata } from '~/src/form/form-metadata/types.js'
+ * @import { FormDefinition, Item, Page } from '~/src/form/form-definition/types.js'
+ * @import { TranslationRow, ValidationFailure } from '~/src/form/form-editor/translations/translations-config.js'
+ */

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

@@ -423,6 +423,11 @@ export interface FormEditor {
    */
   geometryTypes?: GeospatialFieldGeometryTypesEnum[]
 
+  /**
+   * The layers to include for map-based geospatial questions
+   */
+  mapLayers?: string[]
+
   /**
    * The format restriction for telephone number questions
    */
@@ -519,6 +524,7 @@ export type FormEditorInputQuestion = Pick<
   | 'minFeatures'
   | 'maxFeatures'
   | 'telephoneNumberFormat'
+  | 'mapLayers'
 >
 
 export type FormEditorInputPageSettings = Pick<

package/src/form/utils/list.ts

@@ -1,4 +1,10 @@
-import { type ListComponentsDef } from '~/src/components/types.js'
+import { ComponentType } from '~/src/components/enums.js'
+import { hasListField } from '~/src/components/helpers.js'
+import {
+  type ComponentDef,
+  type ListComponentsDef
+} from '~/src/components/types.js'
+import { getYesNoList } from '~/src/components/yes-no-helper.js'
 import {
   type FormDefinition,
   type List
@@ -23,3 +29,30 @@ export function findDefinitionListFromComponent(
 
   return list
 }
+
+/**
+ * Finds the list in the component, if it exists. Handles a Yes/No list which doesn't link to the list in the normal way
+ * @param { ComponentDef | undefined } component
+ * @param {FormDefinition} definition
+ * @returns { List | undefined }
+ */
+export function getListFromComponent(
+  component: ComponentDef | undefined,
+  definition: FormDefinition
+) {
+  if (!component) {
+    return undefined
+  }
+
+  if (component.type === ComponentType.YesNoField) {
+    return getYesNoList()
+  }
+
+  const listId = hasListField(component) ? component.list : undefined
+
+  if (listId) {
+    return definition.lists.find((list) => list.id === listId)
+  }
+
+  return undefined
+}

package/src/form/utils/numbering.js

@@ -0,0 +1,47 @@
+import { isFormType } from '~/src/components/helpers.js'
+import {
+  getPageFromDefinition,
+  hasComponents,
+  isSummaryPage
+} from '~/src/pages/helpers.js'
+
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ */
+export function getPageNum(definition, pageId) {
+  if (pageId === 'new') {
+    return definition.pages.filter((x) => !isSummaryPage(x)).length + 1
+  }
+  const pageIdx = definition.pages.findIndex((x) => x.id === pageId)
+  return pageIdx + 1
+}
+
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ */
+export function getQuestionsOnPage(definition, pageId) {
+  const page = getPageFromDefinition(definition, pageId)
+  return hasComponents(page) ? page.components : []
+}
+
+/**
+ * @param {FormDefinition} definition
+ * @param {string} pageId
+ * @param {string} questionId
+ */
+export function getQuestionNum(definition, pageId, questionId) {
+  const questions = getQuestionsOnPage(definition, pageId).filter(
+    (q) => isFormType(q.type) // Exclude non-form components such as Markdown
+  )
+  if (questionId === 'new') {
+    return questions.length + 1
+  }
+  const questionIdx = questions.findIndex((x) => x.id === questionId)
+  return questionIdx === -1 ? questions.length + 1 : questionIdx + 1
+}
+
+/**
+ * @import { FormDefinition } from '~/src/form/form-definition/types.js'
+ */

package/src/index.ts

@@ -19,6 +19,8 @@ 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-editor/translations/translations-config.js'
+export * from '~/src/form/form-editor/translations/translations.js'
 export * from '~/src/form/form-manager/types.js'
 export * from '~/src/form/form-manager/errors.js'
 export * from '~/src/manage/dead-letter-queues.js'