@defra/forms-engine-plugin 0.0.4 → 0.0.6

package/src/server/plugins/engine/pageControllers/validationOptions.ts

@@ -0,0 +1,89 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064
+
+import joi, { type LanguageMessages, type ValidationOptions } from 'joi'
+import lowerFirst from 'lodash/lowerFirst.js'
+
+const opts = {
+  functions: {
+    lowerFirst
+  }
+}
+
+/**
+ * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax
+ */
+export const messageTemplate = {
+  // @ts-expect-error - joi.expression options type issue
+  required: joi.expression('Enter {{lowerFirst(#label)}}', opts),
+  // @ts-expect-error - joi.expression options type issue
+  selectRequired: joi.expression('Select {{lowerFirst(#label)}}', opts),
+  max: '{{#label}} must be {{#limit}} characters or less',
+  min: '{{#label}} must be {{#limit}} characters or more',
+  // @ts-expect-error - joi.expression options type issue
+  pattern: joi.expression('Enter a valid {{lowerFirst(#label)}}', opts),
+  format: joi.expression(
+    'Enter {{lowerFirst(#label)}} in the correct format',
+    // @ts-expect-error - joi.expression options type issue
+    opts
+  ),
+  number: '{{#label}} must be a number',
+  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',
+  numberInteger: '{{#label}} must be a whole number',
+  numberMin: '{{#label}} must be {{#limit}} or higher',
+  numberMax: '{{#label}} must be {{#limit}} or lower',
+  maxWords: '{{#label}} must be {{#limit}} words or fewer',
+
+  // Nested fields use component title
+
+  // @ts-expect-error - joi.expression options type issue
+  objectRequired: joi.expression('Enter {{#label}}', opts),
+  objectMissing: joi.expression(
+    '{{#title}} must include a {{lowerFirst(#label)}}',
+    // @ts-expect-error - joi.expression options type issue
+    opts
+  ),
+  dateFormat: '{{#title}} must be a real date',
+  dateMin: '{{#title}} must be the same as or after {{#limit}}',
+  dateMax: '{{#title}} must be the same as or before {{#limit}}'
+}
+
+export const messages: LanguageMessages = {
+  'string.base': messageTemplate.required,
+  'string.min': messageTemplate.min,
+  'string.empty': messageTemplate.required,
+  'string.max': messageTemplate.max,
+  'string.email': messageTemplate.format,
+  'string.pattern.base': messageTemplate.pattern,
+  'string.maxWords': messageTemplate.maxWords,
+
+  'number.base': messageTemplate.number,
+  'number.precision': messageTemplate.numberPrecision,
+  'number.integer': messageTemplate.numberInteger,
+  'number.unsafe': messageTemplate.format,
+  'number.min': messageTemplate.numberMin,
+  'number.max': messageTemplate.numberMax,
+
+  'object.required': messageTemplate.objectRequired,
+  'object.and': messageTemplate.objectMissing,
+
+  'any.only': messageTemplate.selectRequired,
+  'any.required': messageTemplate.selectRequired,
+  'any.empty': messageTemplate.required,
+
+  'date.base': messageTemplate.dateFormat,
+  'date.format': messageTemplate.dateFormat,
+  'date.min': messageTemplate.dateMin,
+  'date.max': messageTemplate.dateMax
+}
+
+export const validationOptions: ValidationOptions = {
+  abortEarly: false,
+  messages,
+  errors: {
+    wrap: {
+      array: false,
+      label: false
+    }
+  }
+}