@defra/forms-model 3.0.493 → 3.0.495

package/src/form/form-manager/errors.ts

@@ -0,0 +1,107 @@
+import type Joi from 'joi'
+import { type ValidationError } from 'joi'
+
+import {
+  FormDefinitionError,
+  FormDefinitionErrorType,
+  formDefinitionErrors,
+  type FormDefinitionErrorCause
+} from '~/src/form/form-manager/types.js'
+
+/**
+ * Checks and applies an `errorType` and also an `errorCode` for known errors
+ */
+export const checkErrors = (
+  formErrors: FormDefinitionError | FormDefinitionError[]
+) => {
+  const possibleErrors = Array.isArray(formErrors) ? formErrors : [formErrors]
+
+  return function (errors: Joi.ErrorReport[]) {
+    errors.forEach((err) => {
+      if (err.local.errorType) {
+        return
+      }
+
+      for (const formError of possibleErrors) {
+        const errorDetails = formDefinitionErrors[formError]
+
+        // Joi's `context.key` will be the index for arrays
+        // in which case use the path, otherwise use the key
+        const keyMatch =
+          typeof err.local.key === 'number' ? err.local.path : err.local.key
+
+        if (
+          errorDetails.type === FormDefinitionErrorType.Unique &&
+          err.code === 'array.unique' &&
+          keyMatch === errorDetails.key
+        ) {
+          err.local.errorCode = formError
+          err.local.errorType = FormDefinitionErrorType.Unique
+          return
+        }
+
+        if (
+          errorDetails.type === FormDefinitionErrorType.Ref &&
+          err.code === 'any.only' &&
+          keyMatch === errorDetails.key
+        ) {
+          err.local.errorCode = formError
+          err.local.errorType = FormDefinitionErrorType.Ref
+          return
+        }
+
+        err.local.errorType = FormDefinitionErrorType.Type
+      }
+    })
+    return errors
+  }
+}
+
+/**
+ * Get the custom errors from a form definition joi validation error
+ */
+export function getErrors(
+  validationError: ValidationError | undefined
+): FormDefinitionErrorCause[] {
+  return (
+    validationError?.details.map((detail) => {
+      if (
+        detail.context?.errorType === FormDefinitionErrorType.Unique &&
+        detail.context.errorCode
+      ) {
+        return {
+          id: /** @type {FormDefinitionError} */ detail.context.errorCode,
+          type: FormDefinitionErrorType.Unique,
+          message: detail.message,
+          detail: {
+            path: detail.path,
+            pos: detail.context.pos,
+            dupePos: detail.context.dupePos
+          }
+        }
+      }
+
+      if (
+        detail.context?.errorType === FormDefinitionErrorType.Ref &&
+        detail.context.errorCode
+      ) {
+        return {
+          id: /** @type {FormDefinitionError} */ detail.context.errorCode,
+          type: FormDefinitionErrorType.Ref,
+          message: detail.message,
+          detail: {
+            path: detail.path
+          }
+        }
+      }
+
+      // Catch all others
+      return {
+        id: FormDefinitionError.Other,
+        type: FormDefinitionErrorType.Type,
+        message: detail.message,
+        detail: detail.context
+      }
+    }) ?? []
+  )
+}

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

@@ -23,8 +23,8 @@ export enum FormDefinitionErrorType {
 
 // Enum for errors that can exist in a form definition
 export enum FormDefinitionError {
-  UniquePagePath = 'unique_page_path',
   UniquePageId = 'unique_page_id',
+  UniquePagePath = 'unique_page_path',
   UniquePageComponentId = 'unique_page_component_id',
   UniquePageComponentName = 'unique_page_component_name',
   UniqueSectionName = 'unique_section_name',
@@ -46,11 +46,7 @@ export enum FormDefinitionError {
   Other = 'other'
 }
 
-export const N = Symbol('AnyNumber')
-
-export type ErrorMatchPath = (string | typeof N)[]
 export interface ErrorMatchValue {
-  path: ErrorMatchPath
   key: string
   type: FormDefinitionErrorType
 }
@@ -60,107 +56,86 @@ export type FormDefinitionErrors = Record<FormDefinitionError, ErrorMatchValue>
 // The errors that can exist in the form definition
 export const formDefinitionErrors: FormDefinitionErrors = {
   [FormDefinitionError.UniquePagePath]: {
-    path: ['pages', N],
     key: 'path',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniquePageId]: {
-    path: ['pages', N],
     key: 'id',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniquePageComponentId]: {
-    path: ['pages', N, 'components', N],
     key: 'id',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniquePageComponentName]: {
-    path: ['pages', N, 'components', N],
     key: 'name',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueSectionName]: {
-    path: ['sections', N],
     key: 'name',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueSectionTitle]: {
-    path: ['sections', N],
     key: 'title',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListId]: {
-    path: ['lists', N],
     key: 'id',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListTitle]: {
-    path: ['lists', N],
     key: 'title',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListName]: {
-    path: ['lists', N],
     key: 'name',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueConditionDisplayName]: {
-    path: ['conditions', N],
     key: 'displayName',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueConditionId]: {
-    path: ['conditions', N],
     key: 'id',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListItemId]: {
-    path: ['lists', N, 'items', N],
     key: 'id',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListItemText]: {
-    path: ['lists', N, 'items', N],
     key: 'text',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.UniqueListItemValue]: {
-    path: ['lists', N, 'items', N],
     key: 'value',
     type: FormDefinitionErrorType.Unique
   },
   [FormDefinitionError.RefPageCondition]: {
-    path: ['pages', N, 'condition'],
     key: 'condition',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.RefConditionComponentId]: {
-    path: ['conditions', N, 'items', N, 'componentId'],
     key: 'componentId',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.RefConditionListId]: {
-    path: ['conditions', N, 'items', N, 'value', 'listId'],
     key: 'listId',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.RefConditionItemId]: {
-    path: ['conditions', N, 'items', N, 'value', 'itemId'],
     key: 'itemId',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.RefConditionConditionId]: {
-    path: ['conditions', N, 'items', N, 'conditionId'],
     key: 'conditionId',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.RefPageComponentList]: {
-    path: ['pages', N, 'components', N, 'list'],
     key: 'list',
     type: FormDefinitionErrorType.Ref
   },
   [FormDefinitionError.Other]: {
-    path: [],
     key: '',
     type: FormDefinitionErrorType.Type
   }

package/src/pages/helpers.ts

@@ -6,7 +6,7 @@ import {
   type PageQuestion,
   type PageRepeat
 } from '~/src/form/form-definition/types.js'
-import { ComponentType } from '~/src/index.js'
+import { ComponentType, hasFormField } from '~/src/index.js'
 import {
   ControllerNames,
   ControllerTypes
@@ -153,3 +153,22 @@ export function omitFileUploadComponent(page: Page | undefined): boolean {
   }
   return false
 }
+
+/**
+ * Gets page title, or title of first question (if no page title set)
+ * @param {Page} page
+ * @returns {string}
+ */
+export function getPageTitle(page: Page) {
+  if (page.title !== '') {
+    return page.title
+  }
+
+  if (hasComponentsEvenIfNoNext(page)) {
+    const firstComp = page.components.find(hasFormField)
+    if (firstComp) {
+      return firstComp.title
+    }
+  }
+  return 'Page title unknown'
+}

package/src/pages/index.ts

@@ -8,6 +8,7 @@ export { PageTypes } from '~/src/pages/page-types.js'
 export {
   controllerNameFromPath,
   getPageDefaults,
+  getPageTitle,
   hasComponents,
   hasComponentsEvenIfNoNext,
   hasFormComponents,