@defra/forms-model 3.0.693 → 3.0.694

package/dist/module/form/form-manager/errors.js

@@ -93,4 +93,36 @@ export function getErrors(validationError) {
     };
   }) ?? [];
 }
+
+/**
+ * Human-readable messages for each {@link FormDefinitionError} code, shared
+ * by services that surface definition-validation failures (designer editor
+ * flows, runner preview error pages).
+ */
+export const formErrorsToMessages = {
+  [FormDefinitionError.UniquePageId]: 'Each page must have a unique ID. Change the page ID to one that is not already used.',
+  [FormDefinitionError.UniquePagePath]: 'Each page must have a unique path. Change the page path to one that is not already used.',
+  [FormDefinitionError.UniquePageComponentId]: 'Each question on a page must have a unique ID. Change the question ID to one that is not already used.',
+  [FormDefinitionError.UniquePageComponentName]: 'Each question on a page must have a unique name. Change the question name to one that is not already used.',
+  [FormDefinitionError.UniqueSectionId]: 'Each section must have a unique ID. Change the section ID to one that is not already used.',
+  [FormDefinitionError.UniqueSectionName]: 'Each section must have a unique name. Change the section name to one that is not already used.',
+  [FormDefinitionError.UniqueSectionTitle]: 'Each section must have a unique title. Change the section title to one that is not already used.',
+  [FormDefinitionError.UniqueListId]: 'Each list must have a unique ID. Change the list ID to one that is not already used.',
+  [FormDefinitionError.UniqueListTitle]: 'Each list must have a unique title. Change the list title to one that is not already used.',
+  [FormDefinitionError.UniqueListName]: 'Each list must have a unique name. Change the list name to one that is not already used.',
+  [FormDefinitionError.UniqueConditionId]: 'Each condition must have a unique ID. Change the condition ID to one that is not already used.',
+  [FormDefinitionError.UniqueConditionDisplayName]: 'Each condition must have a unique display name. Change the display name to one that is not already used.',
+  [FormDefinitionError.UniqueListItemId]: 'Each item in a list must have a unique ID. Change the item ID to one that is not already used.',
+  [FormDefinitionError.UniqueListItemText]: 'Each item in a list must have unique text. Change the item text to one that is not already used.',
+  [FormDefinitionError.UniqueListItemValue]: 'Each item in a list must have a unique value. Change the item value to one that is not already used.',
+  [FormDefinitionError.RefPageCondition]: 'This page is referenced by a condition. Remove the condition before making changes to this page.',
+  [FormDefinitionError.RefConditionComponentId]: 'Remove the condition before deleting this page',
+  [FormDefinitionError.RefConditionListId]: 'A condition is using a list in this form. Remove the condition before making changes to the list.',
+  [FormDefinitionError.RefConditionItemId]: 'A condition is using an item in this list. Remove the condition before making changes to the item.',
+  [FormDefinitionError.RefConditionConditionId]: 'A condition is using another condition. Remove the reference before making changes.',
+  [FormDefinitionError.RefPageComponentList]: 'A question on this page is using a list. Remove the reference before making changes to the list.',
+  [FormDefinitionError.IncompatibleConditionComponentType]: 'You cannot change to this question type because this question is used in a condition. Remove the condition or select a different question type.',
+  [FormDefinitionError.IncompatibleQuestionRegex]: 'The regex expression is invalid',
+  [FormDefinitionError.Other]: 'There is a problem with the form definition. Check your changes and try again.'
+};
 //# sourceMappingURL=errors.js.map

package/dist/module/form/form-manager/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","names":["FormDefinitionError","FormDefinitionErrorType","formDefinitionErrors","checkErrors","formErrors","possibleErrors","Array","isArray","errors","forEach","err","local","errorType","formError","errorDetails","keyMatch","key","path","type","Unique","code","errorCode","Ref","Incompatible","Type","getErrors","validationError","details","map","detail","context","id","message","pos","dupePos","valueKey","value","label","incompatibleObject","reason","Other"],"sources":["../../../../src/form/form-manager/errors.ts"],"sourcesContent":["import type Joi from 'joi'\nimport { type ValidationError } from 'joi'\n\nimport {\n  FormDefinitionError,\n  FormDefinitionErrorType,\n  formDefinitionErrors,\n  type FormDefinitionErrorCause\n} from '~/src/form/form-manager/types.js'\n\n/**\n * Checks and applies an `errorType` and also an `errorCode` for known errors\n */\nexport const checkErrors = (\n  formErrors: FormDefinitionError | FormDefinitionError[]\n) => {\n  const possibleErrors = Array.isArray(formErrors) ? formErrors : [formErrors]\n\n  return function (errors: Joi.ErrorReport[]) {\n    errors.forEach((err) => {\n      if (err.local.errorType) {\n        return\n      }\n\n      for (const formError of possibleErrors) {\n        const errorDetails = formDefinitionErrors[formError]\n\n        // Joi's `context.key` will be the index for arrays\n        // in which case use the path, otherwise use the key\n        const keyMatch =\n          typeof err.local.key === 'number' ? err.local.path : err.local.key\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Unique &&\n          err.code === 'array.unique' &&\n          keyMatch === errorDetails.key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Unique\n          return\n        }\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Ref &&\n          err.code === 'any.only' &&\n          keyMatch === errorDetails.key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Ref\n          return\n        }\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Incompatible &&\n          err.code === 'custom.incompatible'\n          // Match any key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Incompatible\n          return\n        }\n\n        err.local.errorType = FormDefinitionErrorType.Type\n      }\n    })\n    return errors\n  }\n}\n\n/**\n * Get the custom errors from a form definition joi validation error\n */\nexport function getErrors(\n  validationError: ValidationError | undefined\n): FormDefinitionErrorCause[] {\n  return (\n    validationError?.details.map((detail) => {\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Unique &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Unique,\n          message: detail.message,\n          detail: {\n            path: detail.path,\n            pos: detail.context.pos,\n            dupePos: detail.context.dupePos\n          }\n        }\n      }\n\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Ref &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Ref,\n          message: detail.message,\n          detail: {\n            path: detail.path\n          }\n        }\n      }\n\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Incompatible &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Incompatible,\n          message: detail.message,\n          detail: {\n            path: detail.path,\n            key: detail.context.key,\n            valueKey: detail.context.valueKey,\n            value: detail.context.value,\n            label: detail.context.label,\n            incompatibleObject: detail.context.incompatibleObject,\n            reason: detail.context.reason\n          }\n        }\n      }\n\n      // Catch all others\n      return {\n        id: FormDefinitionError.Other,\n        type: FormDefinitionErrorType.Type,\n        message: detail.message,\n        detail: detail.context\n      }\n    }) ?? []\n  )\n}\n"],"mappings":"AAGA,SACEA,mBAAmB,EACnBC,uBAAuB,EACvBC,oBAAoB;;AAItB;AACA;AACA;AACA,OAAO,MAAMC,WAAW,GACtBC,UAAuD,IACpD;EACH,MAAMC,cAAc,GAAGC,KAAK,CAACC,OAAO,CAACH,UAAU,CAAC,GAAGA,UAAU,GAAG,CAACA,UAAU,CAAC;EAE5E,OAAO,UAAUI,MAAyB,EAAE;IAC1CA,MAAM,CAACC,OAAO,CAAEC,GAAG,IAAK;MACtB,IAAIA,GAAG,CAACC,KAAK,CAACC,SAAS,EAAE;QACvB;MACF;MAEA,KAAK,MAAMC,SAAS,IAAIR,cAAc,EAAE;QACtC,MAAMS,YAAY,GAAGZ,oBAAoB,CAACW,SAAS,CAAC;;QAEpD;QACA;QACA,MAAME,QAAQ,GACZ,OAAOL,GAAG,CAACC,KAAK,CAACK,GAAG,KAAK,QAAQ,GAAGN,GAAG,CAACC,KAAK,CAACM,IAAI,GAAGP,GAAG,CAACC,KAAK,CAACK,GAAG;QAEpE,IACEF,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACkB,MAAM,IACpDT,GAAG,CAACU,IAAI,KAAK,cAAc,IAC3BL,QAAQ,KAAKD,YAAY,CAACE,GAAG,EAC7B;UACAN,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACkB,MAAM;UACpD;QACF;QAEA,IACEL,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACqB,GAAG,IACjDZ,GAAG,CAACU,IAAI,KAAK,UAAU,IACvBL,QAAQ,KAAKD,YAAY,CAACE,GAAG,EAC7B;UACAN,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACqB,GAAG;UACjD;QACF;QAEA,IACER,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACsB,YAAY,IAC1Db,GAAG,CAACU,IAAI,KAAK;QACb;QAAA,EACA;UACAV,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACsB,YAAY;UAC1D;QACF;QAEAb,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACuB,IAAI;MACpD;IACF,CAAC,CAAC;IACF,OAAOhB,MAAM;EACf,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASiB,SAASA,CACvBC,eAA4C,EAChB;EAC5B,OACEA,eAAe,EAAEC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAK;IACvC,IACEA,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACkB,MAAM,IAC5DU,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACkB,MAAM;QACpCa,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ,IAAI;UACjBgB,GAAG,EAAEJ,MAAM,CAACC,OAAO,CAACG,GAAG;UACvBC,OAAO,EAAEL,MAAM,CAACC,OAAO,CAACI;QAC1B;MACF,CAAC;IACH;IAEA,IACEL,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACqB,GAAG,IACzDO,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACqB,GAAG;QACjCU,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ;QACf;MACF,CAAC;IACH;IAEA,IACEY,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACsB,YAAY,IAClEM,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACsB,YAAY;QAC1CS,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ,IAAI;UACjBD,GAAG,EAAEa,MAAM,CAACC,OAAO,CAACd,GAAG;UACvBmB,QAAQ,EAAEN,MAAM,CAACC,OAAO,CAACK,QAAQ;UACjCC,KAAK,EAAEP,MAAM,CAACC,OAAO,CAACM,KAAK;UAC3BC,KAAK,EAAER,MAAM,CAACC,OAAO,CAACO,KAAK;UAC3BC,kBAAkB,EAAET,MAAM,CAACC,OAAO,CAACQ,kBAAkB;UACrDC,MAAM,EAAEV,MAAM,CAACC,OAAO,CAACS;QACzB;MACF,CAAC;IACH;;IAEA;IACA,OAAO;MACLR,EAAE,EAAE/B,mBAAmB,CAACwC,KAAK;MAC7BtB,IAAI,EAAEjB,uBAAuB,CAACuB,IAAI;MAClCQ,OAAO,EAAEH,MAAM,CAACG,OAAO;MACvBH,MAAM,EAAEA,MAAM,CAACC;IACjB,CAAC;EACH,CAAC,CAAC,IAAI,EAAE;AAEZ","ignoreList":[]}
+{"version":3,"file":"errors.js","names":["FormDefinitionError","FormDefinitionErrorType","formDefinitionErrors","checkErrors","formErrors","possibleErrors","Array","isArray","errors","forEach","err","local","errorType","formError","errorDetails","keyMatch","key","path","type","Unique","code","errorCode","Ref","Incompatible","Type","getErrors","validationError","details","map","detail","context","id","message","pos","dupePos","valueKey","value","label","incompatibleObject","reason","Other","formErrorsToMessages","UniquePageId","UniquePagePath","UniquePageComponentId","UniquePageComponentName","UniqueSectionId","UniqueSectionName","UniqueSectionTitle","UniqueListId","UniqueListTitle","UniqueListName","UniqueConditionId","UniqueConditionDisplayName","UniqueListItemId","UniqueListItemText","UniqueListItemValue","RefPageCondition","RefConditionComponentId","RefConditionListId","RefConditionItemId","RefConditionConditionId","RefPageComponentList","IncompatibleConditionComponentType","IncompatibleQuestionRegex"],"sources":["../../../../src/form/form-manager/errors.ts"],"sourcesContent":["import type Joi from 'joi'\nimport { type ValidationError } from 'joi'\n\nimport {\n  FormDefinitionError,\n  FormDefinitionErrorType,\n  formDefinitionErrors,\n  type FormDefinitionErrorCause\n} from '~/src/form/form-manager/types.js'\n\n/**\n * Checks and applies an `errorType` and also an `errorCode` for known errors\n */\nexport const checkErrors = (\n  formErrors: FormDefinitionError | FormDefinitionError[]\n) => {\n  const possibleErrors = Array.isArray(formErrors) ? formErrors : [formErrors]\n\n  return function (errors: Joi.ErrorReport[]) {\n    errors.forEach((err) => {\n      if (err.local.errorType) {\n        return\n      }\n\n      for (const formError of possibleErrors) {\n        const errorDetails = formDefinitionErrors[formError]\n\n        // Joi's `context.key` will be the index for arrays\n        // in which case use the path, otherwise use the key\n        const keyMatch =\n          typeof err.local.key === 'number' ? err.local.path : err.local.key\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Unique &&\n          err.code === 'array.unique' &&\n          keyMatch === errorDetails.key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Unique\n          return\n        }\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Ref &&\n          err.code === 'any.only' &&\n          keyMatch === errorDetails.key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Ref\n          return\n        }\n\n        if (\n          errorDetails.type === FormDefinitionErrorType.Incompatible &&\n          err.code === 'custom.incompatible'\n          // Match any key\n        ) {\n          err.local.errorCode = formError\n          err.local.errorType = FormDefinitionErrorType.Incompatible\n          return\n        }\n\n        err.local.errorType = FormDefinitionErrorType.Type\n      }\n    })\n    return errors\n  }\n}\n\n/**\n * Get the custom errors from a form definition joi validation error\n */\nexport function getErrors(\n  validationError: ValidationError | undefined\n): FormDefinitionErrorCause[] {\n  return (\n    validationError?.details.map((detail) => {\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Unique &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Unique,\n          message: detail.message,\n          detail: {\n            path: detail.path,\n            pos: detail.context.pos,\n            dupePos: detail.context.dupePos\n          }\n        }\n      }\n\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Ref &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Ref,\n          message: detail.message,\n          detail: {\n            path: detail.path\n          }\n        }\n      }\n\n      if (\n        detail.context?.errorType === FormDefinitionErrorType.Incompatible &&\n        detail.context.errorCode\n      ) {\n        return {\n          id: /** @type {FormDefinitionError} */ detail.context.errorCode,\n          type: FormDefinitionErrorType.Incompatible,\n          message: detail.message,\n          detail: {\n            path: detail.path,\n            key: detail.context.key,\n            valueKey: detail.context.valueKey,\n            value: detail.context.value,\n            label: detail.context.label,\n            incompatibleObject: detail.context.incompatibleObject,\n            reason: detail.context.reason\n          }\n        }\n      }\n\n      // Catch all others\n      return {\n        id: FormDefinitionError.Other,\n        type: FormDefinitionErrorType.Type,\n        message: detail.message,\n        detail: detail.context\n      }\n    }) ?? []\n  )\n}\n\n/**\n * Human-readable messages for each {@link FormDefinitionError} code, shared\n * by services that surface definition-validation failures (designer editor\n * flows, runner preview error pages).\n */\nexport const formErrorsToMessages: Record<FormDefinitionError, string> = {\n  [FormDefinitionError.UniquePageId]:\n    'Each page must have a unique ID. Change the page ID to one that is not already used.',\n  [FormDefinitionError.UniquePagePath]:\n    'Each page must have a unique path. Change the page path to one that is not already used.',\n  [FormDefinitionError.UniquePageComponentId]:\n    'Each question on a page must have a unique ID. Change the question ID to one that is not already used.',\n  [FormDefinitionError.UniquePageComponentName]:\n    'Each question on a page must have a unique name. Change the question name to one that is not already used.',\n  [FormDefinitionError.UniqueSectionId]:\n    'Each section must have a unique ID. Change the section ID to one that is not already used.',\n  [FormDefinitionError.UniqueSectionName]:\n    'Each section must have a unique name. Change the section name to one that is not already used.',\n  [FormDefinitionError.UniqueSectionTitle]:\n    'Each section must have a unique title. Change the section title to one that is not already used.',\n  [FormDefinitionError.UniqueListId]:\n    'Each list must have a unique ID. Change the list ID to one that is not already used.',\n  [FormDefinitionError.UniqueListTitle]:\n    'Each list must have a unique title. Change the list title to one that is not already used.',\n  [FormDefinitionError.UniqueListName]:\n    'Each list must have a unique name. Change the list name to one that is not already used.',\n  [FormDefinitionError.UniqueConditionId]:\n    'Each condition must have a unique ID. Change the condition ID to one that is not already used.',\n  [FormDefinitionError.UniqueConditionDisplayName]:\n    'Each condition must have a unique display name. Change the display name to one that is not already used.',\n  [FormDefinitionError.UniqueListItemId]:\n    'Each item in a list must have a unique ID. Change the item ID to one that is not already used.',\n  [FormDefinitionError.UniqueListItemText]:\n    'Each item in a list must have unique text. Change the item text to one that is not already used.',\n  [FormDefinitionError.UniqueListItemValue]:\n    'Each item in a list must have a unique value. Change the item value to one that is not already used.',\n  [FormDefinitionError.RefPageCondition]:\n    'This page is referenced by a condition. Remove the condition before making changes to this page.',\n  [FormDefinitionError.RefConditionComponentId]:\n    'Remove the condition before deleting this page',\n  [FormDefinitionError.RefConditionListId]:\n    'A condition is using a list in this form. Remove the condition before making changes to the list.',\n  [FormDefinitionError.RefConditionItemId]:\n    'A condition is using an item in this list. Remove the condition before making changes to the item.',\n  [FormDefinitionError.RefConditionConditionId]:\n    'A condition is using another condition. Remove the reference before making changes.',\n  [FormDefinitionError.RefPageComponentList]:\n    'A question on this page is using a list. Remove the reference before making changes to the list.',\n  [FormDefinitionError.IncompatibleConditionComponentType]:\n    'You cannot change to this question type because this question is used in a condition. Remove the condition or select a different question type.',\n  [FormDefinitionError.IncompatibleQuestionRegex]:\n    'The regex expression is invalid',\n  [FormDefinitionError.Other]:\n    'There is a problem with the form definition. Check your changes and try again.'\n}\n"],"mappings":"AAGA,SACEA,mBAAmB,EACnBC,uBAAuB,EACvBC,oBAAoB;;AAItB;AACA;AACA;AACA,OAAO,MAAMC,WAAW,GACtBC,UAAuD,IACpD;EACH,MAAMC,cAAc,GAAGC,KAAK,CAACC,OAAO,CAACH,UAAU,CAAC,GAAGA,UAAU,GAAG,CAACA,UAAU,CAAC;EAE5E,OAAO,UAAUI,MAAyB,EAAE;IAC1CA,MAAM,CAACC,OAAO,CAAEC,GAAG,IAAK;MACtB,IAAIA,GAAG,CAACC,KAAK,CAACC,SAAS,EAAE;QACvB;MACF;MAEA,KAAK,MAAMC,SAAS,IAAIR,cAAc,EAAE;QACtC,MAAMS,YAAY,GAAGZ,oBAAoB,CAACW,SAAS,CAAC;;QAEpD;QACA;QACA,MAAME,QAAQ,GACZ,OAAOL,GAAG,CAACC,KAAK,CAACK,GAAG,KAAK,QAAQ,GAAGN,GAAG,CAACC,KAAK,CAACM,IAAI,GAAGP,GAAG,CAACC,KAAK,CAACK,GAAG;QAEpE,IACEF,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACkB,MAAM,IACpDT,GAAG,CAACU,IAAI,KAAK,cAAc,IAC3BL,QAAQ,KAAKD,YAAY,CAACE,GAAG,EAC7B;UACAN,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACkB,MAAM;UACpD;QACF;QAEA,IACEL,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACqB,GAAG,IACjDZ,GAAG,CAACU,IAAI,KAAK,UAAU,IACvBL,QAAQ,KAAKD,YAAY,CAACE,GAAG,EAC7B;UACAN,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACqB,GAAG;UACjD;QACF;QAEA,IACER,YAAY,CAACI,IAAI,KAAKjB,uBAAuB,CAACsB,YAAY,IAC1Db,GAAG,CAACU,IAAI,KAAK;QACb;QAAA,EACA;UACAV,GAAG,CAACC,KAAK,CAACU,SAAS,GAAGR,SAAS;UAC/BH,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACsB,YAAY;UAC1D;QACF;QAEAb,GAAG,CAACC,KAAK,CAACC,SAAS,GAAGX,uBAAuB,CAACuB,IAAI;MACpD;IACF,CAAC,CAAC;IACF,OAAOhB,MAAM;EACf,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASiB,SAASA,CACvBC,eAA4C,EAChB;EAC5B,OACEA,eAAe,EAAEC,OAAO,CAACC,GAAG,CAAEC,MAAM,IAAK;IACvC,IACEA,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACkB,MAAM,IAC5DU,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACkB,MAAM;QACpCa,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ,IAAI;UACjBgB,GAAG,EAAEJ,MAAM,CAACC,OAAO,CAACG,GAAG;UACvBC,OAAO,EAAEL,MAAM,CAACC,OAAO,CAACI;QAC1B;MACF,CAAC;IACH;IAEA,IACEL,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACqB,GAAG,IACzDO,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACqB,GAAG;QACjCU,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ;QACf;MACF,CAAC;IACH;IAEA,IACEY,MAAM,CAACC,OAAO,EAAElB,SAAS,KAAKX,uBAAuB,CAACsB,YAAY,IAClEM,MAAM,CAACC,OAAO,CAACT,SAAS,EACxB;MACA,OAAO;QACLU,EAAE,EAAE,kCAAmCF,MAAM,CAACC,OAAO,CAACT,SAAS;QAC/DH,IAAI,EAAEjB,uBAAuB,CAACsB,YAAY;QAC1CS,OAAO,EAAEH,MAAM,CAACG,OAAO;QACvBH,MAAM,EAAE;UACNZ,IAAI,EAAEY,MAAM,CAACZ,IAAI;UACjBD,GAAG,EAAEa,MAAM,CAACC,OAAO,CAACd,GAAG;UACvBmB,QAAQ,EAAEN,MAAM,CAACC,OAAO,CAACK,QAAQ;UACjCC,KAAK,EAAEP,MAAM,CAACC,OAAO,CAACM,KAAK;UAC3BC,KAAK,EAAER,MAAM,CAACC,OAAO,CAACO,KAAK;UAC3BC,kBAAkB,EAAET,MAAM,CAACC,OAAO,CAACQ,kBAAkB;UACrDC,MAAM,EAAEV,MAAM,CAACC,OAAO,CAACS;QACzB;MACF,CAAC;IACH;;IAEA;IACA,OAAO;MACLR,EAAE,EAAE/B,mBAAmB,CAACwC,KAAK;MAC7BtB,IAAI,EAAEjB,uBAAuB,CAACuB,IAAI;MAClCQ,OAAO,EAAEH,MAAM,CAACG,OAAO;MACvBH,MAAM,EAAEA,MAAM,CAACC;IACjB,CAAC;EACH,CAAC,CAAC,IAAI,EAAE;AAEZ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMW,oBAAyD,GAAG;EACvE,CAACzC,mBAAmB,CAAC0C,YAAY,GAC/B,sFAAsF;EACxF,CAAC1C,mBAAmB,CAAC2C,cAAc,GACjC,0FAA0F;EAC5F,CAAC3C,mBAAmB,CAAC4C,qBAAqB,GACxC,wGAAwG;EAC1G,CAAC5C,mBAAmB,CAAC6C,uBAAuB,GAC1C,4GAA4G;EAC9G,CAAC7C,mBAAmB,CAAC8C,eAAe,GAClC,4FAA4F;EAC9F,CAAC9C,mBAAmB,CAAC+C,iBAAiB,GACpC,gGAAgG;EAClG,CAAC/C,mBAAmB,CAACgD,kBAAkB,GACrC,kGAAkG;EACpG,CAAChD,mBAAmB,CAACiD,YAAY,GAC/B,sFAAsF;EACxF,CAACjD,mBAAmB,CAACkD,eAAe,GAClC,4FAA4F;EAC9F,CAAClD,mBAAmB,CAACmD,cAAc,GACjC,0FAA0F;EAC5F,CAACnD,mBAAmB,CAACoD,iBAAiB,GACpC,gGAAgG;EAClG,CAACpD,mBAAmB,CAACqD,0BAA0B,GAC7C,0GAA0G;EAC5G,CAACrD,mBAAmB,CAACsD,gBAAgB,GACnC,gGAAgG;EAClG,CAACtD,mBAAmB,CAACuD,kBAAkB,GACrC,kGAAkG;EACpG,CAACvD,mBAAmB,CAACwD,mBAAmB,GACtC,sGAAsG;EACxG,CAACxD,mBAAmB,CAACyD,gBAAgB,GACnC,kGAAkG;EACpG,CAACzD,mBAAmB,CAAC0D,uBAAuB,GAC1C,gDAAgD;EAClD,CAAC1D,mBAAmB,CAAC2D,kBAAkB,GACrC,mGAAmG;EACrG,CAAC3D,mBAAmB,CAAC4D,kBAAkB,GACrC,oGAAoG;EACtG,CAAC5D,mBAAmB,CAAC6D,uBAAuB,GAC1C,qFAAqF;EACvF,CAAC7D,mBAAmB,CAAC8D,oBAAoB,GACvC,kGAAkG;EACpG,CAAC9D,mBAAmB,CAAC+D,kCAAkC,GACrD,iJAAiJ;EACnJ,CAAC/D,mBAAmB,CAACgE,yBAAyB,GAC5C,iCAAiC;EACnC,CAAChE,mBAAmB,CAACwC,KAAK,GACxB;AACJ,CAAC","ignoreList":[]}

package/dist/types/form/form-manager/errors.d.ts

@@ -9,4 +9,10 @@ export declare const checkErrors: (formErrors: FormDefinitionError | FormDefinit
  * Get the custom errors from a form definition joi validation error
  */
 export declare function getErrors(validationError: ValidationError | undefined): FormDefinitionErrorCause[];
+/**
+ * Human-readable messages for each {@link FormDefinitionError} code, shared
+ * by services that surface definition-validation failures (designer editor
+ * flows, runner preview error pages).
+ */
+export declare const formErrorsToMessages: Record<FormDefinitionError, string>;
 //# sourceMappingURL=errors.d.ts.map

package/dist/types/form/form-manager/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/form/form-manager/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAA;AAC1B,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,KAAK,CAAA;AAE1C,OAAO,EACL,mBAAmB,EAGnB,KAAK,wBAAwB,EAC9B,MAAM,kCAAkC,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,WAAW,GACtB,YAAY,mBAAmB,GAAG,mBAAmB,EAAE,MAItC,QAAQ,GAAG,CAAC,WAAW,EAAE,sBAiD3C,CAAA;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,eAAe,EAAE,eAAe,GAAG,SAAS,GAC3C,wBAAwB,EAAE,CA8D5B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../src/form/form-manager/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAA;AAC1B,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,KAAK,CAAA;AAE1C,OAAO,EACL,mBAAmB,EAGnB,KAAK,wBAAwB,EAC9B,MAAM,kCAAkC,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,WAAW,GACtB,YAAY,mBAAmB,GAAG,mBAAmB,EAAE,MAItC,QAAQ,GAAG,CAAC,WAAW,EAAE,sBAiD3C,CAAA;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,eAAe,EAAE,eAAe,GAAG,SAAS,GAC3C,wBAAwB,EAAE,CA8D5B;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAiDpE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.693",
+  "version": "3.0.694",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

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

@@ -135,3 +135,59 @@ export function getErrors(
     }) ?? []
   )
 }
+
+/**
+ * Human-readable messages for each {@link FormDefinitionError} code, shared
+ * by services that surface definition-validation failures (designer editor
+ * flows, runner preview error pages).
+ */
+export const formErrorsToMessages: Record<FormDefinitionError, string> = {
+  [FormDefinitionError.UniquePageId]:
+    'Each page must have a unique ID. Change the page ID to one that is not already used.',
+  [FormDefinitionError.UniquePagePath]:
+    'Each page must have a unique path. Change the page path to one that is not already used.',
+  [FormDefinitionError.UniquePageComponentId]:
+    'Each question on a page must have a unique ID. Change the question ID to one that is not already used.',
+  [FormDefinitionError.UniquePageComponentName]:
+    'Each question on a page must have a unique name. Change the question name to one that is not already used.',
+  [FormDefinitionError.UniqueSectionId]:
+    'Each section must have a unique ID. Change the section ID to one that is not already used.',
+  [FormDefinitionError.UniqueSectionName]:
+    'Each section must have a unique name. Change the section name to one that is not already used.',
+  [FormDefinitionError.UniqueSectionTitle]:
+    'Each section must have a unique title. Change the section title to one that is not already used.',
+  [FormDefinitionError.UniqueListId]:
+    'Each list must have a unique ID. Change the list ID to one that is not already used.',
+  [FormDefinitionError.UniqueListTitle]:
+    'Each list must have a unique title. Change the list title to one that is not already used.',
+  [FormDefinitionError.UniqueListName]:
+    'Each list must have a unique name. Change the list name to one that is not already used.',
+  [FormDefinitionError.UniqueConditionId]:
+    'Each condition must have a unique ID. Change the condition ID to one that is not already used.',
+  [FormDefinitionError.UniqueConditionDisplayName]:
+    'Each condition must have a unique display name. Change the display name to one that is not already used.',
+  [FormDefinitionError.UniqueListItemId]:
+    'Each item in a list must have a unique ID. Change the item ID to one that is not already used.',
+  [FormDefinitionError.UniqueListItemText]:
+    'Each item in a list must have unique text. Change the item text to one that is not already used.',
+  [FormDefinitionError.UniqueListItemValue]:
+    'Each item in a list must have a unique value. Change the item value to one that is not already used.',
+  [FormDefinitionError.RefPageCondition]:
+    'This page is referenced by a condition. Remove the condition before making changes to this page.',
+  [FormDefinitionError.RefConditionComponentId]:
+    'Remove the condition before deleting this page',
+  [FormDefinitionError.RefConditionListId]:
+    'A condition is using a list in this form. Remove the condition before making changes to the list.',
+  [FormDefinitionError.RefConditionItemId]:
+    'A condition is using an item in this list. Remove the condition before making changes to the item.',
+  [FormDefinitionError.RefConditionConditionId]:
+    'A condition is using another condition. Remove the reference before making changes.',
+  [FormDefinitionError.RefPageComponentList]:
+    'A question on this page is using a list. Remove the reference before making changes to the list.',
+  [FormDefinitionError.IncompatibleConditionComponentType]:
+    'You cannot change to this question type because this question is used in a condition. Remove the condition or select a different question type.',
+  [FormDefinitionError.IncompatibleQuestionRegex]:
+    'The regex expression is invalid',
+  [FormDefinitionError.Other]:
+    'There is a problem with the form definition. Check your changes and try again.'
+}