@defra/forms-engine-plugin 4.13.0 → 4.14.1

package/.server/server/plugins/engine/components/helpers/geospatial.js

@@ -19,7 +19,8 @@ const Joi = JoiBase.extend({
     from: 'string',
     method(value, helpers) {
       if (typeof value === 'string') {
-        if (value.trim() === '') {
+        const trimmed = value.trim();
+        if (trimmed === '' || trimmed === '[]') {
           return {
             value: undefined
           };
@@ -72,10 +73,36 @@ const featureSchema = Joi.object().keys({
   properties: featurePropertiesSchema,
   geometry: featureGeometrySchema
 });
-const geospatialSchema = Joi.array().items(featureSchema).unique('id').required();
-export function getGeospatialSchema(country) {
+function applySchemaConstraints(schema, def) {
+  const {
+    options,
+    schema: constraints
+  } = def;
+  const isOptional = options.required === false;
+  if (typeof constraints?.length === 'number') {
+    schema = schema.length(constraints.length);
+  } else {
+    if (typeof constraints?.min === 'number') {
+      schema = schema.min(constraints.min);
+    } else if (!isOptional) {
+      schema = schema.min(1);
+    }
+    schema = schema.max(typeof constraints?.max === 'number' ? constraints.max : 50);
+  }
+  if (isOptional) {
+    schema = schema.optional();
+  } else {
+    schema = schema.required();
+  }
+  return schema;
+}
+export function getGeospatialSchema(def) {
+  const {
+    options = {}
+  } = def;
+  const country = options.countries?.at(0);
   if (!country) {
-    return geospatialSchema;
+    return applySchemaConstraints(Joi.array().items(featureSchema).unique('id'), def);
   }
   const validateCountryBounds = (value, helpers) => {
     const countryFeature = countries.features.find(feature => feature.id === country);
@@ -93,7 +120,7 @@ export function getGeospatialSchema(country) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return value;
   };
-  return Joi.array().items(featureSchema.custom(validateCountryBounds)).unique('id').required();
+  return applySchemaConstraints(Joi.array().items(featureSchema.custom(validateCountryBounds)).unique('id'), def);
 }
 
 /**

package/.server/server/plugins/engine/components/helpers/geospatial.js.map

@@ -1 +1 @@
-{"version":3,"file":"geospatial.js","names":["GeospatialFieldOptionsCountryEnum","Bourne","booleanWithin","JoiBase","countries","countriesDesc","England","NorthernIreland","Scotland","Wales","Joi","extend","type","base","array","messages","coerce","from","method","value","helpers","trim","undefined","parse","result","errors","error","coordinatesSchema","items","number","required","featurePropertiesSchema","object","keys","description","string","coordinateGridReference","centroidGridReference","featureGeometrySchema","valid","coordinates","when","switch","is","then","min","featureSchema","id","properties","geometry","geospatialSchema","unique","getGeospatialSchema","country","validateCountryBounds","countryFeature","features","find","feature","custom"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.ts"],"sourcesContent":["import {\n  GeospatialFieldOptionsCountryEnum,\n  type GeospatialFieldOptionsCountry\n} from '@defra/forms-model'\nimport Bourne from '@hapi/bourne'\nimport { booleanWithin } from '@turf/boolean-within'\nimport JoiBase, { type CustomValidator } from 'joi'\n\nimport {\n  type Coordinates,\n  type Feature,\n  type FeatureProperties,\n  type Geometry\n} from '~/src/server/plugins/engine/types.js'\nimport { countries } from '~/src/server/plugins/map/routes/index.js'\n\nconst countriesDesc: Record<GeospatialFieldOptionsCountryEnum, string> = {\n  [GeospatialFieldOptionsCountryEnum.England]: 'England',\n  [GeospatialFieldOptionsCountryEnum.NorthernIreland]: 'Northern Ireland',\n  [GeospatialFieldOptionsCountryEnum.Scotland]: 'Scotland',\n  [GeospatialFieldOptionsCountryEnum.Wales]: 'Wales'\n}\n\nconst Joi = JoiBase.extend({\n  type: 'array',\n  base: JoiBase.array(),\n  messages: {\n    'object.invalidjson': '{{#label}} must be a valid json array string'\n  },\n  coerce: {\n    from: 'string',\n    method(value, helpers) {\n      if (typeof value === 'string') {\n        if (value.trim() === '') {\n          return {\n            value: undefined\n          }\n        }\n\n        try {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          return { value: Bourne.parse(value) }\n        } catch {\n          const result = {\n            value,\n            errors: [helpers.error('object.invalidjson')]\n          }\n\n          return result\n        }\n      } else {\n        return {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          value\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n\nconst coordinatesSchema = Joi.array<Coordinates[]>()\n  .items(Joi.number().required(), Joi.number().required())\n  .required()\n\nconst featurePropertiesSchema = Joi.object<FeatureProperties>()\n  .keys({\n    description: Joi.string().required(),\n    coordinateGridReference: Joi.string().required(),\n    centroidGridReference: Joi.string().required()\n  })\n  .required()\n\nconst featureGeometrySchema = Joi.object<Geometry>().keys({\n  type: Joi.string().valid('Point', 'LineString', 'Polygon').required(),\n  coordinates: Joi.array()\n    .when('type', {\n      switch: [\n        { is: 'Point', then: coordinatesSchema },\n        {\n          is: 'LineString',\n          then: Joi.array().items(coordinatesSchema).min(2)\n        },\n        {\n          is: 'Polygon',\n          then: Joi.array().items(Joi.array().items(coordinatesSchema).min(3))\n        }\n      ]\n    })\n    .required()\n})\n\nconst featureSchema = Joi.object<Feature>().keys({\n  id: Joi.string().required(),\n  type: Joi.string().valid('Feature').required(),\n  properties: featurePropertiesSchema,\n  geometry: featureGeometrySchema\n})\n\nconst geospatialSchema = Joi.array<Feature[]>()\n  .items(featureSchema)\n  .unique('id')\n  .required()\n\nexport function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {\n  if (!country) {\n    return geospatialSchema\n  }\n\n  const validateCountryBounds: CustomValidator = (value, helpers) => {\n    const countryFeature = countries.features.find(\n      (feature) => feature.id === country\n    )\n\n    if (!countryFeature) {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return value\n    }\n\n    const result = booleanWithin(value as Geometry | Feature, countryFeature)\n\n    if (!result) {\n      return helpers.error('any.custom', {\n        country: countriesDesc[country as GeospatialFieldOptionsCountryEnum]\n      })\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value\n  }\n\n  return Joi.array<Feature[]>()\n    .items(featureSchema.custom(validateCountryBounds))\n    .unique('id')\n    .required()\n}\n\n/**\n * @import { CustomHelpers } from 'joi'\n */\n"],"mappings":"AAAA,SACEA,iCAAiC,QAE5B,oBAAoB;AAC3B,OAAOC,MAAM,MAAM,cAAc;AACjC,SAASC,aAAa,QAAQ,sBAAsB;AACpD,OAAOC,OAAO,MAAgC,KAAK;AAQnD,SAASC,SAAS;AAElB,MAAMC,aAAgE,GAAG;EACvE,CAACL,iCAAiC,CAACM,OAAO,GAAG,SAAS;EACtD,CAACN,iCAAiC,CAACO,eAAe,GAAG,kBAAkB;EACvE,CAACP,iCAAiC,CAACQ,QAAQ,GAAG,UAAU;EACxD,CAACR,iCAAiC,CAACS,KAAK,GAAG;AAC7C,CAAC;AAED,MAAMC,GAAG,GAAGP,OAAO,CAACQ,MAAM,CAAC;EACzBC,IAAI,EAAE,OAAO;EACbC,IAAI,EAAEV,OAAO,CAACW,KAAK,CAAC,CAAC;EACrBC,QAAQ,EAAE;IACR,oBAAoB,EAAE;EACxB,CAAC;EACDC,MAAM,EAAE;IACNC,IAAI,EAAE,QAAQ;IACdC,MAAMA,CAACC,KAAK,EAAEC,OAAO,EAAE;MACrB,IAAI,OAAOD,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAIA,KAAK,CAACE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;UACvB,OAAO;YACLF,KAAK,EAAEG;UACT,CAAC;QACH;QAEA,IAAI;UACF;UACA,OAAO;YAAEH,KAAK,EAAElB,MAAM,CAACsB,KAAK,CAACJ,KAAK;UAAE,CAAC;QACvC,CAAC,CAAC,MAAM;UACN,MAAMK,MAAM,GAAG;YACbL,KAAK;YACLM,MAAM,EAAE,CAACL,OAAO,CAACM,KAAK,CAAC,oBAAoB,CAAC;UAC9C,CAAC;UAED,OAAOF,MAAM;QACf;MACF,CAAC,MAAM;QACL,OAAO;UACL;UACAL;QACF,CAAC;MACH;IACF;EACF;AACF,CAAC,CAAiB;AAElB,MAAMQ,iBAAiB,GAAGjB,GAAG,CAACI,KAAK,CAAgB,CAAC,CACjDc,KAAK,CAAClB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,EAAEpB,GAAG,CAACmB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAAC,CACvDA,QAAQ,CAAC,CAAC;AAEb,MAAMC,uBAAuB,GAAGrB,GAAG,CAACsB,MAAM,CAAoB,CAAC,CAC5DC,IAAI,CAAC;EACJC,WAAW,EAAExB,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACpCM,uBAAuB,EAAE1B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAChDO,qBAAqB,EAAE3B,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC;AAC/C,CAAC,CAAC,CACDA,QAAQ,CAAC,CAAC;AAEb,MAAMQ,qBAAqB,GAAG5B,GAAG,CAACsB,MAAM,CAAW,CAAC,CAACC,IAAI,CAAC;EACxDrB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EACrEU,WAAW,EAAE9B,GAAG,CAACI,KAAK,CAAC,CAAC,CACrB2B,IAAI,CAAC,MAAM,EAAE;IACZC,MAAM,EAAE,CACN;MAAEC,EAAE,EAAE,OAAO;MAAEC,IAAI,EAAEjB;IAAkB,CAAC,EACxC;MACEgB,EAAE,EAAE,YAAY;MAChBC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC;IAClD,CAAC,EACD;MACEF,EAAE,EAAE,SAAS;MACbC,IAAI,EAAElC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAAClB,GAAG,CAACI,KAAK,CAAC,CAAC,CAACc,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;EAEL,CAAC,CAAC,CACDf,QAAQ,CAAC;AACd,CAAC,CAAC;AAEF,MAAMgB,aAAa,GAAGpC,GAAG,CAACsB,MAAM,CAAU,CAAC,CAACC,IAAI,CAAC;EAC/Cc,EAAE,EAAErC,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAC3BlB,IAAI,EAAEF,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EAC9CkB,UAAU,EAAEjB,uBAAuB;EACnCkB,QAAQ,EAAEX;AACZ,CAAC,CAAC;AAEF,MAAMY,gBAAgB,GAAGxC,GAAG,CAACI,KAAK,CAAY,CAAC,CAC5Cc,KAAK,CAACkB,aAAa,CAAC,CACpBK,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AAEb,OAAO,SAASsB,mBAAmBA,CAACC,OAAuC,EAAE;EAC3E,IAAI,CAACA,OAAO,EAAE;IACZ,OAAOH,gBAAgB;EACzB;EAEA,MAAMI,qBAAsC,GAAGA,CAACnC,KAAK,EAAEC,OAAO,KAAK;IACjE,MAAMmC,cAAc,GAAGnD,SAAS,CAACoD,QAAQ,CAACC,IAAI,CAC3CC,OAAO,IAAKA,OAAO,CAACX,EAAE,KAAKM,OAC9B,CAAC;IAED,IAAI,CAACE,cAAc,EAAE;MACnB;MACA,OAAOpC,KAAK;IACd;IAEA,MAAMK,MAAM,GAAGtB,aAAa,CAACiB,KAAK,EAAwBoC,cAAc,CAAC;IAEzE,IAAI,CAAC/B,MAAM,EAAE;MACX,OAAOJ,OAAO,CAACM,KAAK,CAAC,YAAY,EAAE;QACjC2B,OAAO,EAAEhD,aAAa,CAACgD,OAAO;MAChC,CAAC,CAAC;IACJ;;IAEA;IACA,OAAOlC,KAAK;EACd,CAAC;EAED,OAAOT,GAAG,CAACI,KAAK,CAAY,CAAC,CAC1Bc,KAAK,CAACkB,aAAa,CAACa,MAAM,CAACL,qBAAqB,CAAC,CAAC,CAClDH,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;AACf;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"geospatial.js","names":["GeospatialFieldOptionsCountryEnum","Bourne","booleanWithin","JoiBase","countries","countriesDesc","England","NorthernIreland","Scotland","Wales","Joi","extend","type","base","array","messages","coerce","from","method","value","helpers","trimmed","trim","undefined","parse","result","errors","error","coordinatesSchema","items","number","required","featurePropertiesSchema","object","keys","description","string","coordinateGridReference","centroidGridReference","featureGeometrySchema","valid","coordinates","when","switch","is","then","min","featureSchema","id","properties","geometry","applySchemaConstraints","schema","def","options","constraints","isOptional","length","max","optional","getGeospatialSchema","country","at","unique","validateCountryBounds","countryFeature","features","find","feature","custom"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.ts"],"sourcesContent":["import {\n  GeospatialFieldOptionsCountryEnum,\n  type GeospatialFieldComponent,\n  type GeospatialFieldOptionsCountry\n} from '@defra/forms-model'\nimport Bourne from '@hapi/bourne'\nimport { booleanWithin } from '@turf/boolean-within'\nimport JoiBase, { type CustomValidator } from 'joi'\n\nimport {\n  type Coordinates,\n  type Feature,\n  type FeatureProperties,\n  type Geometry\n} from '~/src/server/plugins/engine/types.js'\nimport { countries } from '~/src/server/plugins/map/routes/index.js'\n\nconst countriesDesc: Record<GeospatialFieldOptionsCountryEnum, string> = {\n  [GeospatialFieldOptionsCountryEnum.England]: 'England',\n  [GeospatialFieldOptionsCountryEnum.NorthernIreland]: 'Northern Ireland',\n  [GeospatialFieldOptionsCountryEnum.Scotland]: 'Scotland',\n  [GeospatialFieldOptionsCountryEnum.Wales]: 'Wales'\n}\n\nconst Joi = JoiBase.extend({\n  type: 'array',\n  base: JoiBase.array(),\n  messages: {\n    'object.invalidjson': '{{#label}} must be a valid json array string'\n  },\n  coerce: {\n    from: 'string',\n    method(value, helpers) {\n      if (typeof value === 'string') {\n        const trimmed = value.trim()\n        if (trimmed === '' || trimmed === '[]') {\n          return {\n            value: undefined\n          }\n        }\n\n        try {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          return { value: Bourne.parse(value) }\n        } catch {\n          const result = {\n            value,\n            errors: [helpers.error('object.invalidjson')]\n          }\n\n          return result\n        }\n      } else {\n        return {\n          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n          value\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n\nconst coordinatesSchema = Joi.array<Coordinates[]>()\n  .items(Joi.number().required(), Joi.number().required())\n  .required()\n\nconst featurePropertiesSchema = Joi.object<FeatureProperties>()\n  .keys({\n    description: Joi.string().required(),\n    coordinateGridReference: Joi.string().required(),\n    centroidGridReference: Joi.string().required()\n  })\n  .required()\n\nconst featureGeometrySchema = Joi.object<Geometry>().keys({\n  type: Joi.string().valid('Point', 'LineString', 'Polygon').required(),\n  coordinates: Joi.array()\n    .when('type', {\n      switch: [\n        { is: 'Point', then: coordinatesSchema },\n        {\n          is: 'LineString',\n          then: Joi.array().items(coordinatesSchema).min(2)\n        },\n        {\n          is: 'Polygon',\n          then: Joi.array().items(Joi.array().items(coordinatesSchema).min(3))\n        }\n      ]\n    })\n    .required()\n})\n\nconst featureSchema = Joi.object<Feature>().keys({\n  id: Joi.string().required(),\n  type: Joi.string().valid('Feature').required(),\n  properties: featurePropertiesSchema,\n  geometry: featureGeometrySchema\n})\n\nfunction applySchemaConstraints(\n  schema: JoiBase.ArraySchema<Feature[]>,\n  def: GeospatialFieldComponent\n) {\n  const { options, schema: constraints } = def\n  const isOptional = options.required === false\n\n  if (typeof constraints?.length === 'number') {\n    schema = schema.length(constraints.length)\n  } else {\n    if (typeof constraints?.min === 'number') {\n      schema = schema.min(constraints.min)\n    } else if (!isOptional) {\n      schema = schema.min(1)\n    }\n\n    schema = schema.max(\n      typeof constraints?.max === 'number' ? constraints.max : 50\n    )\n  }\n\n  if (isOptional) {\n    schema = schema.optional()\n  } else {\n    schema = schema.required()\n  }\n\n  return schema\n}\n\nexport function getGeospatialSchema(\n  def: GeospatialFieldComponent\n): JoiBase.ArraySchema<Feature[]> {\n  const { options = {} } = def\n  const country: GeospatialFieldOptionsCountry | undefined =\n    options.countries?.at(0)\n\n  if (!country) {\n    return applySchemaConstraints(\n      Joi.array<Feature[]>().items(featureSchema).unique('id'),\n      def\n    )\n  }\n\n  const validateCountryBounds: CustomValidator = (value, helpers) => {\n    const countryFeature = countries.features.find(\n      (feature) => feature.id === country\n    )\n\n    if (!countryFeature) {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return value\n    }\n\n    const result = booleanWithin(value as Geometry | Feature, countryFeature)\n\n    if (!result) {\n      return helpers.error('any.custom', {\n        country: countriesDesc[country as GeospatialFieldOptionsCountryEnum]\n      })\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n    return value\n  }\n\n  return applySchemaConstraints(\n    Joi.array<Feature[]>()\n      .items(featureSchema.custom(validateCountryBounds))\n      .unique('id'),\n    def\n  )\n}\n\n/**\n * @import { CustomHelpers } from 'joi'\n */\n"],"mappings":"AAAA,SACEA,iCAAiC,QAG5B,oBAAoB;AAC3B,OAAOC,MAAM,MAAM,cAAc;AACjC,SAASC,aAAa,QAAQ,sBAAsB;AACpD,OAAOC,OAAO,MAAgC,KAAK;AAQnD,SAASC,SAAS;AAElB,MAAMC,aAAgE,GAAG;EACvE,CAACL,iCAAiC,CAACM,OAAO,GAAG,SAAS;EACtD,CAACN,iCAAiC,CAACO,eAAe,GAAG,kBAAkB;EACvE,CAACP,iCAAiC,CAACQ,QAAQ,GAAG,UAAU;EACxD,CAACR,iCAAiC,CAACS,KAAK,GAAG;AAC7C,CAAC;AAED,MAAMC,GAAG,GAAGP,OAAO,CAACQ,MAAM,CAAC;EACzBC,IAAI,EAAE,OAAO;EACbC,IAAI,EAAEV,OAAO,CAACW,KAAK,CAAC,CAAC;EACrBC,QAAQ,EAAE;IACR,oBAAoB,EAAE;EACxB,CAAC;EACDC,MAAM,EAAE;IACNC,IAAI,EAAE,QAAQ;IACdC,MAAMA,CAACC,KAAK,EAAEC,OAAO,EAAE;MACrB,IAAI,OAAOD,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAME,OAAO,GAAGF,KAAK,CAACG,IAAI,CAAC,CAAC;QAC5B,IAAID,OAAO,KAAK,EAAE,IAAIA,OAAO,KAAK,IAAI,EAAE;UACtC,OAAO;YACLF,KAAK,EAAEI;UACT,CAAC;QACH;QAEA,IAAI;UACF;UACA,OAAO;YAAEJ,KAAK,EAAElB,MAAM,CAACuB,KAAK,CAACL,KAAK;UAAE,CAAC;QACvC,CAAC,CAAC,MAAM;UACN,MAAMM,MAAM,GAAG;YACbN,KAAK;YACLO,MAAM,EAAE,CAACN,OAAO,CAACO,KAAK,CAAC,oBAAoB,CAAC;UAC9C,CAAC;UAED,OAAOF,MAAM;QACf;MACF,CAAC,MAAM;QACL,OAAO;UACL;UACAN;QACF,CAAC;MACH;IACF;EACF;AACF,CAAC,CAAiB;AAElB,MAAMS,iBAAiB,GAAGlB,GAAG,CAACI,KAAK,CAAgB,CAAC,CACjDe,KAAK,CAACnB,GAAG,CAACoB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,EAAErB,GAAG,CAACoB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAAC,CACvDA,QAAQ,CAAC,CAAC;AAEb,MAAMC,uBAAuB,GAAGtB,GAAG,CAACuB,MAAM,CAAoB,CAAC,CAC5DC,IAAI,CAAC;EACJC,WAAW,EAAEzB,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EACpCM,uBAAuB,EAAE3B,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAChDO,qBAAqB,EAAE5B,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC;AAC/C,CAAC,CAAC,CACDA,QAAQ,CAAC,CAAC;AAEb,MAAMQ,qBAAqB,GAAG7B,GAAG,CAACuB,MAAM,CAAW,CAAC,CAACC,IAAI,CAAC;EACxDtB,IAAI,EAAEF,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EACrEU,WAAW,EAAE/B,GAAG,CAACI,KAAK,CAAC,CAAC,CACrB4B,IAAI,CAAC,MAAM,EAAE;IACZC,MAAM,EAAE,CACN;MAAEC,EAAE,EAAE,OAAO;MAAEC,IAAI,EAAEjB;IAAkB,CAAC,EACxC;MACEgB,EAAE,EAAE,YAAY;MAChBC,IAAI,EAAEnC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACe,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC;IAClD,CAAC,EACD;MACEF,EAAE,EAAE,SAAS;MACbC,IAAI,EAAEnC,GAAG,CAACI,KAAK,CAAC,CAAC,CAACe,KAAK,CAACnB,GAAG,CAACI,KAAK,CAAC,CAAC,CAACe,KAAK,CAACD,iBAAiB,CAAC,CAACkB,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;EAEL,CAAC,CAAC,CACDf,QAAQ,CAAC;AACd,CAAC,CAAC;AAEF,MAAMgB,aAAa,GAAGrC,GAAG,CAACuB,MAAM,CAAU,CAAC,CAACC,IAAI,CAAC;EAC/Cc,EAAE,EAAEtC,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;EAC3BnB,IAAI,EAAEF,GAAG,CAAC0B,MAAM,CAAC,CAAC,CAACI,KAAK,CAAC,SAAS,CAAC,CAACT,QAAQ,CAAC,CAAC;EAC9CkB,UAAU,EAAEjB,uBAAuB;EACnCkB,QAAQ,EAAEX;AACZ,CAAC,CAAC;AAEF,SAASY,sBAAsBA,CAC7BC,MAAsC,EACtCC,GAA6B,EAC7B;EACA,MAAM;IAAEC,OAAO;IAAEF,MAAM,EAAEG;EAAY,CAAC,GAAGF,GAAG;EAC5C,MAAMG,UAAU,GAAGF,OAAO,CAACvB,QAAQ,KAAK,KAAK;EAE7C,IAAI,OAAOwB,WAAW,EAAEE,MAAM,KAAK,QAAQ,EAAE;IAC3CL,MAAM,GAAGA,MAAM,CAACK,MAAM,CAACF,WAAW,CAACE,MAAM,CAAC;EAC5C,CAAC,MAAM;IACL,IAAI,OAAOF,WAAW,EAAET,GAAG,KAAK,QAAQ,EAAE;MACxCM,MAAM,GAAGA,MAAM,CAACN,GAAG,CAACS,WAAW,CAACT,GAAG,CAAC;IACtC,CAAC,MAAM,IAAI,CAACU,UAAU,EAAE;MACtBJ,MAAM,GAAGA,MAAM,CAACN,GAAG,CAAC,CAAC,CAAC;IACxB;IAEAM,MAAM,GAAGA,MAAM,CAACM,GAAG,CACjB,OAAOH,WAAW,EAAEG,GAAG,KAAK,QAAQ,GAAGH,WAAW,CAACG,GAAG,GAAG,EAC3D,CAAC;EACH;EAEA,IAAIF,UAAU,EAAE;IACdJ,MAAM,GAAGA,MAAM,CAACO,QAAQ,CAAC,CAAC;EAC5B,CAAC,MAAM;IACLP,MAAM,GAAGA,MAAM,CAACrB,QAAQ,CAAC,CAAC;EAC5B;EAEA,OAAOqB,MAAM;AACf;AAEA,OAAO,SAASQ,mBAAmBA,CACjCP,GAA6B,EACG;EAChC,MAAM;IAAEC,OAAO,GAAG,CAAC;EAAE,CAAC,GAAGD,GAAG;EAC5B,MAAMQ,OAAkD,GACtDP,OAAO,CAAClD,SAAS,EAAE0D,EAAE,CAAC,CAAC,CAAC;EAE1B,IAAI,CAACD,OAAO,EAAE;IACZ,OAAOV,sBAAsB,CAC3BzC,GAAG,CAACI,KAAK,CAAY,CAAC,CAACe,KAAK,CAACkB,aAAa,CAAC,CAACgB,MAAM,CAAC,IAAI,CAAC,EACxDV,GACF,CAAC;EACH;EAEA,MAAMW,qBAAsC,GAAGA,CAAC7C,KAAK,EAAEC,OAAO,KAAK;IACjE,MAAM6C,cAAc,GAAG7D,SAAS,CAAC8D,QAAQ,CAACC,IAAI,CAC3CC,OAAO,IAAKA,OAAO,CAACpB,EAAE,KAAKa,OAC9B,CAAC;IAED,IAAI,CAACI,cAAc,EAAE;MACnB;MACA,OAAO9C,KAAK;IACd;IAEA,MAAMM,MAAM,GAAGvB,aAAa,CAACiB,KAAK,EAAwB8C,cAAc,CAAC;IAEzE,IAAI,CAACxC,MAAM,EAAE;MACX,OAAOL,OAAO,CAACO,KAAK,CAAC,YAAY,EAAE;QACjCkC,OAAO,EAAExD,aAAa,CAACwD,OAAO;MAChC,CAAC,CAAC;IACJ;;IAEA;IACA,OAAO1C,KAAK;EACd,CAAC;EAED,OAAOgC,sBAAsB,CAC3BzC,GAAG,CAACI,KAAK,CAAY,CAAC,CACnBe,KAAK,CAACkB,aAAa,CAACsB,MAAM,CAACL,qBAAqB,CAAC,CAAC,CAClDD,MAAM,CAAC,IAAI,CAAC,EACfV,GACF,CAAC;AACH;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/components/helpers/geospatial.test.js

@@ -1,7 +1,17 @@
-import { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model';
+import { ComponentType, GeospatialFieldOptionsCountryEnum } from '@defra/forms-model';
 import { validState } from "./__stubs__/geospatial.js";
 import { getGeospatialSchema } from "./geospatial.js";
-const geospatialSchema = getGeospatialSchema();
+
+/**
+ * @type {import('@defra/forms-model').GeospatialFieldComponent}
+ */
+const geospatialComponent = {
+  name: 'geospatial',
+  title: 'Geospatial',
+  type: ComponentType.GeospatialField,
+  options: {}
+};
+const geospatialSchema = getGeospatialSchema(geospatialComponent);
 describe('Geospatial validation helpers', () => {
   test('it should not have errors for valid geojson object', () => {
     const result = geospatialSchema.validate(validState);
@@ -27,8 +37,19 @@ describe('Geospatial validation helpers', () => {
   });
   test('it should validate an empty array', () => {
     const result = geospatialSchema.validate('[]');
+    expect(result.error).toBeDefined();
+    expect(result.value).toBeUndefined();
+  });
+  test('it should validate an empty array when optional', () => {
+    const schema = getGeospatialSchema({
+      ...geospatialComponent,
+      options: {
+        required: false
+      }
+    });
+    const result = schema.validate('[]');
     expect(result.error).toBeUndefined();
-    expect(result.value).toEqual([]);
+    expect(result.value).toBeUndefined();
   });
   test('it should not validate an empty object', () => {
     const result = geospatialSchema.validate('{}');
@@ -41,21 +62,31 @@ describe('Geospatial validation helpers', () => {
     expect(result.value).toBeUndefined();
   });
   test('it should be valid inside country bounds', () => {
-    const schema = getGeospatialSchema(GeospatialFieldOptionsCountryEnum.England);
+    const schema = getGeospatialSchema({
+      ...geospatialComponent,
+      options: {
+        countries: [GeospatialFieldOptionsCountryEnum.England]
+      }
+    });
     expect(schema.validate(validState).error).toBeUndefined();
     expect(schema.validate(validState.slice(1)).error).toBeUndefined();
     expect(schema.validate(validState.slice(2)).error).toBeUndefined();
     expect(schema.validate(validState.slice(3)).error).toBeUndefined();
   });
   test('it should be invalid outside country bounds', () => {
-    const schema = getGeospatialSchema(GeospatialFieldOptionsCountryEnum.Scotland);
+    const schema = getGeospatialSchema({
+      ...geospatialComponent,
+      options: {
+        countries: [GeospatialFieldOptionsCountryEnum.Scotland]
+      }
+    });
     expect(schema.validate(validState).error).toBeDefined();
     expect(schema.validate(validState.slice(1)).error).toBeDefined();
     expect(schema.validate(validState.slice(2)).error).toBeDefined();
     expect(schema.validate(validState.slice(3)).error).toBeDefined();
   });
   test('it should be valid with no country bounds', () => {
-    const schema = getGeospatialSchema();
+    const schema = getGeospatialSchema(geospatialComponent);
     expect(schema.validate(validState).error).toBeUndefined();
   });
 });

package/.server/server/plugins/engine/components/helpers/geospatial.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"geospatial.test.js","names":["GeospatialFieldOptionsCountryEnum","validState","getGeospatialSchema","geospatialSchema","describe","test","result","validate","expect","error","toBeUndefined","value","toBeDefined","toHaveLength","JSON","stringify","toBe","toEqual","schema","England","slice","Scotland"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.test.js"],"sourcesContent":["import { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model'\n\nimport { validState } from '~/src/server/plugins/engine/components/helpers/__stubs__/geospatial.js'\nimport { getGeospatialSchema } from '~/src/server/plugins/engine/components/helpers/geospatial.js'\n\nconst geospatialSchema = getGeospatialSchema()\n\ndescribe('Geospatial validation helpers', () => {\n  test('it should not have errors for valid geojson object', () => {\n    const result = geospatialSchema.validate(validState)\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toBeDefined()\n    expect(result.value).toHaveLength(4)\n  })\n\n  test('it should not have errors for valid geojson string', () => {\n    const result = geospatialSchema.validate(JSON.stringify(validState))\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toBeDefined()\n    expect(result.value).toHaveLength(4)\n  })\n\n  test('it should have errors for invalid json string', () => {\n    const result = geospatialSchema.validate('{')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBe('{')\n  })\n\n  test('it should have errors for invalid geojson string', () => {\n    const result = geospatialSchema.validate('[')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBe('[')\n  })\n\n  test('it should validate an empty array', () => {\n    const result = geospatialSchema.validate('[]')\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toEqual([])\n  })\n\n  test('it should not validate an empty object', () => {\n    const result = geospatialSchema.validate('{}')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should validate an empty string', () => {\n    const result = geospatialSchema.validate('')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should be valid inside country bounds', () => {\n    const schema = getGeospatialSchema(\n      GeospatialFieldOptionsCountryEnum.England\n    )\n\n    expect(schema.validate(validState).error).toBeUndefined()\n    expect(schema.validate(validState.slice(1)).error).toBeUndefined()\n    expect(schema.validate(validState.slice(2)).error).toBeUndefined()\n    expect(schema.validate(validState.slice(3)).error).toBeUndefined()\n  })\n\n  test('it should be invalid outside country bounds', () => {\n    const schema = getGeospatialSchema(\n      GeospatialFieldOptionsCountryEnum.Scotland\n    )\n\n    expect(schema.validate(validState).error).toBeDefined()\n    expect(schema.validate(validState.slice(1)).error).toBeDefined()\n    expect(schema.validate(validState.slice(2)).error).toBeDefined()\n    expect(schema.validate(validState.slice(3)).error).toBeDefined()\n  })\n\n  test('it should be valid with no country bounds', () => {\n    const schema = getGeospatialSchema()\n\n    expect(schema.validate(validState).error).toBeUndefined()\n  })\n})\n"],"mappings":"AAAA,SAASA,iCAAiC,QAAQ,oBAAoB;AAEtE,SAASC,UAAU;AACnB,SAASC,mBAAmB;AAE5B,MAAMC,gBAAgB,GAAGD,mBAAmB,CAAC,CAAC;AAE9CE,QAAQ,CAAC,+BAA+B,EAAE,MAAM;EAC9CC,IAAI,CAAC,oDAAoD,EAAE,MAAM;IAC/D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAACN,UAAU,CAAC;IAEpDO,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACE,YAAY,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFR,IAAI,CAAC,oDAAoD,EAAE,MAAM;IAC/D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAACO,IAAI,CAACC,SAAS,CAACd,UAAU,CAAC,CAAC;IAEpEO,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACE,YAAY,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFR,IAAI,CAAC,+CAA+C,EAAE,MAAM;IAC1D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,GAAG,CAAC;IAE7CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACK,IAAI,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC;EAEFX,IAAI,CAAC,kDAAkD,EAAE,MAAM;IAC7D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,GAAG,CAAC;IAE7CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACK,IAAI,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC;EAEFX,IAAI,CAAC,mCAAmC,EAAE,MAAM;IAC9C,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,IAAI,CAAC;IAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACM,OAAO,CAAC,EAAE,CAAC;EAClC,CAAC,CAAC;EAEFZ,IAAI,CAAC,wCAAwC,EAAE,MAAM;IACnD,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,IAAI,CAAC;IAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,oCAAoC,EAAE,MAAM;IAC/C,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,EAAE,CAAC;IAE5CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,0CAA0C,EAAE,MAAM;IACrD,MAAMa,MAAM,GAAGhB,mBAAmB,CAChCF,iCAAiC,CAACmB,OACpC,CAAC;IAEDX,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAAC,CAACQ,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACzDF,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IAClEF,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IAClEF,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;EACpE,CAAC,CAAC;EAEFL,IAAI,CAAC,6CAA6C,EAAE,MAAM;IACxD,MAAMa,MAAM,GAAGhB,mBAAmB,CAChCF,iCAAiC,CAACqB,QACpC,CAAC;IAEDb,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAAC,CAACQ,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IACvDJ,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAChEJ,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAChEJ,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAACmB,KAAK,CAAC,CAAC,CAAC,CAAC,CAACX,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;EAClE,CAAC,CAAC;EAEFP,IAAI,CAAC,2CAA2C,EAAE,MAAM;IACtD,MAAMa,MAAM,GAAGhB,mBAAmB,CAAC,CAAC;IAEpCM,MAAM,CAACU,MAAM,CAACX,QAAQ,CAACN,UAAU,CAAC,CAACQ,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;EAC3D,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"geospatial.test.js","names":["ComponentType","GeospatialFieldOptionsCountryEnum","validState","getGeospatialSchema","geospatialComponent","name","title","type","GeospatialField","options","geospatialSchema","describe","test","result","validate","expect","error","toBeUndefined","value","toBeDefined","toHaveLength","JSON","stringify","toBe","schema","required","countries","England","slice","Scotland"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.test.js"],"sourcesContent":["import {\n  ComponentType,\n  GeospatialFieldOptionsCountryEnum\n} from '@defra/forms-model'\n\nimport { validState } from '~/src/server/plugins/engine/components/helpers/__stubs__/geospatial.js'\nimport { getGeospatialSchema } from '~/src/server/plugins/engine/components/helpers/geospatial.js'\n\n/**\n * @type {import('@defra/forms-model').GeospatialFieldComponent}\n */\nconst geospatialComponent = {\n  name: 'geospatial',\n  title: 'Geospatial',\n  type: ComponentType.GeospatialField,\n  options: {}\n}\n\nconst geospatialSchema = getGeospatialSchema(geospatialComponent)\n\ndescribe('Geospatial validation helpers', () => {\n  test('it should not have errors for valid geojson object', () => {\n    const result = geospatialSchema.validate(validState)\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toBeDefined()\n    expect(result.value).toHaveLength(4)\n  })\n\n  test('it should not have errors for valid geojson string', () => {\n    const result = geospatialSchema.validate(JSON.stringify(validState))\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toBeDefined()\n    expect(result.value).toHaveLength(4)\n  })\n\n  test('it should have errors for invalid json string', () => {\n    const result = geospatialSchema.validate('{')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBe('{')\n  })\n\n  test('it should have errors for invalid geojson string', () => {\n    const result = geospatialSchema.validate('[')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBe('[')\n  })\n\n  test('it should validate an empty array', () => {\n    const result = geospatialSchema.validate('[]')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should validate an empty array when optional', () => {\n    const schema = getGeospatialSchema({\n      ...geospatialComponent,\n      options: { required: false }\n    })\n    const result = schema.validate('[]')\n\n    expect(result.error).toBeUndefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should not validate an empty object', () => {\n    const result = geospatialSchema.validate('{}')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should validate an empty string', () => {\n    const result = geospatialSchema.validate('')\n\n    expect(result.error).toBeDefined()\n    expect(result.value).toBeUndefined()\n  })\n\n  test('it should be valid inside country bounds', () => {\n    const schema = getGeospatialSchema({\n      ...geospatialComponent,\n      options: { countries: [GeospatialFieldOptionsCountryEnum.England] }\n    })\n\n    expect(schema.validate(validState).error).toBeUndefined()\n    expect(schema.validate(validState.slice(1)).error).toBeUndefined()\n    expect(schema.validate(validState.slice(2)).error).toBeUndefined()\n    expect(schema.validate(validState.slice(3)).error).toBeUndefined()\n  })\n\n  test('it should be invalid outside country bounds', () => {\n    const schema = getGeospatialSchema({\n      ...geospatialComponent,\n      options: { countries: [GeospatialFieldOptionsCountryEnum.Scotland] }\n    })\n\n    expect(schema.validate(validState).error).toBeDefined()\n    expect(schema.validate(validState.slice(1)).error).toBeDefined()\n    expect(schema.validate(validState.slice(2)).error).toBeDefined()\n    expect(schema.validate(validState.slice(3)).error).toBeDefined()\n  })\n\n  test('it should be valid with no country bounds', () => {\n    const schema = getGeospatialSchema(geospatialComponent)\n\n    expect(schema.validate(validState).error).toBeUndefined()\n  })\n})\n"],"mappings":"AAAA,SACEA,aAAa,EACbC,iCAAiC,QAC5B,oBAAoB;AAE3B,SAASC,UAAU;AACnB,SAASC,mBAAmB;;AAE5B;AACA;AACA;AACA,MAAMC,mBAAmB,GAAG;EAC1BC,IAAI,EAAE,YAAY;EAClBC,KAAK,EAAE,YAAY;EACnBC,IAAI,EAAEP,aAAa,CAACQ,eAAe;EACnCC,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAMC,gBAAgB,GAAGP,mBAAmB,CAACC,mBAAmB,CAAC;AAEjEO,QAAQ,CAAC,+BAA+B,EAAE,MAAM;EAC9CC,IAAI,CAAC,oDAAoD,EAAE,MAAM;IAC/D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAACZ,UAAU,CAAC;IAEpDa,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACE,YAAY,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFR,IAAI,CAAC,oDAAoD,EAAE,MAAM;IAC/D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAACO,IAAI,CAACC,SAAS,CAACpB,UAAU,CAAC,CAAC;IAEpEa,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACE,YAAY,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFR,IAAI,CAAC,+CAA+C,EAAE,MAAM;IAC1D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,GAAG,CAAC;IAE7CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACK,IAAI,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC;EAEFX,IAAI,CAAC,kDAAkD,EAAE,MAAM;IAC7D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,GAAG,CAAC;IAE7CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACK,IAAI,CAAC,GAAG,CAAC;EAChC,CAAC,CAAC;EAEFX,IAAI,CAAC,mCAAmC,EAAE,MAAM;IAC9C,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,IAAI,CAAC;IAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,iDAAiD,EAAE,MAAM;IAC5D,MAAMY,MAAM,GAAGrB,mBAAmB,CAAC;MACjC,GAAGC,mBAAmB;MACtBK,OAAO,EAAE;QAAEgB,QAAQ,EAAE;MAAM;IAC7B,CAAC,CAAC;IACF,MAAMZ,MAAM,GAAGW,MAAM,CAACV,QAAQ,CAAC,IAAI,CAAC;IAEpCC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,wCAAwC,EAAE,MAAM;IACnD,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,IAAI,CAAC;IAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,oCAAoC,EAAE,MAAM;IAC/C,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAAC,EAAE,CAAC;IAE5CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAClCJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACD,aAAa,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFL,IAAI,CAAC,0CAA0C,EAAE,MAAM;IACrD,MAAMY,MAAM,GAAGrB,mBAAmB,CAAC;MACjC,GAAGC,mBAAmB;MACtBK,OAAO,EAAE;QAAEiB,SAAS,EAAE,CAACzB,iCAAiC,CAAC0B,OAAO;MAAE;IACpE,CAAC,CAAC;IAEFZ,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC,CAACc,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IACzDF,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IAClEF,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;IAClEF,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;EACpE,CAAC,CAAC;EAEFL,IAAI,CAAC,6CAA6C,EAAE,MAAM;IACxD,MAAMY,MAAM,GAAGrB,mBAAmB,CAAC;MACjC,GAAGC,mBAAmB;MACtBK,OAAO,EAAE;QAAEiB,SAAS,EAAE,CAACzB,iCAAiC,CAAC4B,QAAQ;MAAE;IACrE,CAAC,CAAC;IAEFd,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC,CAACc,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IACvDJ,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAChEJ,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;IAChEJ,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC0B,KAAK,CAAC,CAAC,CAAC,CAAC,CAACZ,KAAK,CAAC,CAACG,WAAW,CAAC,CAAC;EAClE,CAAC,CAAC;EAEFP,IAAI,CAAC,2CAA2C,EAAE,MAAM;IACtD,MAAMY,MAAM,GAAGrB,mBAAmB,CAACC,mBAAmB,CAAC;IAEvDW,MAAM,CAACS,MAAM,CAACV,QAAQ,CAACZ,UAAU,CAAC,CAACc,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;EAC3D,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/validationOptions.js

@@ -37,7 +37,10 @@ export const messageTemplate = {
   dateMax: '{{#title}} must be the same as or before {{#limit}}',
   arrayMin: 'Select at least {{#limit}} options from the list',
   arrayMax: 'Only {{#limit}} can be selected from the list',
-  arrayLength: 'Select only {{#limit}} options from the list'
+  arrayLength: 'Select only {{#limit}} options from the list',
+  featuresMin: 'Define at least {{#limit}} features',
+  featuresMax: 'Only {{#limit}} features can be defined',
+  featuresLength: 'Define exactly {{#limit}} features'
 };
 export const messages = {
   'string.base': messageTemplate.required,

package/.server/server/plugins/engine/pageControllers/validationOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationOptions.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","unicode","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","arrayMin","arrayMax","arrayLength","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  unicode: '{{#label}} includes invalid characters, for example, long dashes',\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}',\n  arrayMin: 'Select at least {{#limit}} options from the list',\n  arrayMax: 'Only {{#limit}} can be selected from the list',\n  arrayLength: 'Select only {{#limit}} options from the list'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.unicode': messageTemplate.unicode,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax,\n\n  'object.invalidjson': messageTemplate.format\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AAEZ,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMI,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEN,GAAG,CAACO,UAAU,CACjC,uFAAuF,EACvFL,IACF,CAAkB;EAClBM,QAAQ,EAAER,GAAG,CAACO,UAAU,CACtB,8BAA8B,EAC9BL,IACF,CAAkB;EAClBO,cAAc,EAAET,GAAG,CAACO,UAAU,CAC5B,+BAA+B,EAC/BL,IACF,CAAkB;EAClBQ,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEd,GAAG,CAACO,UAAU,CACrB,sCAAsC,EACtCL,IACF,CAAkB;EAClBa,MAAM,EAAEf,GAAG,CAACO,UAAU,CACpB,oDAAoD,EACpDL,IACF,CAAkB;EAClBc,OAAO,EAAE,kEAAkE;EAC3EC,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAEvB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEsB,aAAa,EAAExB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBuB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE,qDAAqD;EAC9DC,QAAQ,EAAE,kDAAkD;EAC5DC,QAAQ,EAAE,+CAA+C;EACzDC,WAAW,EAAE;AACf,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAE1B,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,gBAAgB,EAAEV,eAAe,CAACW,OAAO;EACzC,qBAAqB,EAAEX,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACiB,QAAQ;EAE3C,aAAa,EAAEjB,eAAe,CAACY,MAAM;EACrC,kBAAkB,EAAEZ,eAAe,CAACa,eAAe;EACnD,gBAAgB,EAAEb,eAAe,CAACc,aAAa;EAC/C,eAAe,EAAEd,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACe,SAAS;EACvC,YAAY,EAAEf,eAAe,CAACgB,SAAS;EAEvC,iBAAiB,EAAEhB,eAAe,CAACkB,cAAc;EACjD,YAAY,EAAElB,eAAe,CAACmB,aAAa;EAE3C,UAAU,EAAEnB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACoB,UAAU;EACvC,aAAa,EAAEpB,eAAe,CAACoB,UAAU;EACzC,UAAU,EAAEpB,eAAe,CAACqB,OAAO;EACnC,UAAU,EAAErB,eAAe,CAACsB,OAAO;EAEnC,oBAAoB,EAAEtB,eAAe,CAACU;AACxC,CAAC;AAED,OAAO,MAAMiB,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"validationOptions.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","messageTemplate","declarationRequired","expression","required","selectRequired","selectYesNoRequired","max","min","minMax","pattern","format","unicode","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","arrayMin","arrayMax","arrayLength","featuresMin","featuresMax","featuresLength","messages","messagesPre","validationOptions","abortEarly","errors","wrap","array","label"],"sources":["../../../../../src/server/plugins/engine/pageControllers/validationOptions.ts"],"sourcesContent":["// Declaration above is needed for: https://github.com/hapijs/joi/issues/3064\n\nimport joi, {\n  type JoiExpression,\n  type LanguageMessages,\n  type LanguageMessagesExt,\n  type ReferenceOptions,\n  type ValidationOptions\n} from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n  functions: {\n    lowerFirst: lowerFirstPreserveProperNouns\n  }\n} as ReferenceOptions\n\n/**\n * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax\n */\nexport const messageTemplate: Record<string, JoiExpression> = {\n  declarationRequired: joi.expression(\n    'You must confirm you understand and agree with the {{lowerFirst(#label)}} to continue',\n    opts\n  ) as JoiExpression,\n  required: joi.expression(\n    'Enter {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectRequired: joi.expression(\n    'Select {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  selectYesNoRequired: '{{#label}} - select yes or no',\n  max: '{{#label}} must be {{#limit}} characters or less',\n  min: '{{#label}} must be {{#limit}} characters or more',\n  minMax: '{{#label}} must be between {{#min}} and {{#max}} characters',\n  pattern: joi.expression(\n    'Enter a valid {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  format: joi.expression(\n    'Enter {{lowerFirst(#label)}} in the correct format',\n    opts\n  ) as JoiExpression,\n  unicode: '{{#label}} includes invalid characters, for example, long dashes',\n  number: '{{#label}} must be a number',\n  numberPrecision: '{{#label}} must have {{#limit}} or fewer decimal places',\n  numberInteger: '{{#label}} must be a whole number',\n  numberMin: '{{#label}} must be {{#limit}} or higher',\n  numberMax: '{{#label}} must be {{#limit}} or lower',\n  maxWords: '{{#label}} must be {{#limit}} words or fewer',\n\n  // Nested fields use component title\n\n  objectRequired: joi.expression('Enter {{#label}}', opts) as JoiExpression,\n  objectMissing: joi.expression(\n    '{{#title}} must include a {{lowerFirst(#label)}}',\n    opts\n  ) as JoiExpression,\n  dateFormat: '{{#title}} must be a real date',\n  dateMin: '{{#title}} must be the same as or after {{#limit}}',\n  dateMax: '{{#title}} must be the same as or before {{#limit}}',\n  arrayMin: 'Select at least {{#limit}} options from the list',\n  arrayMax: 'Only {{#limit}} can be selected from the list',\n  arrayLength: 'Select only {{#limit}} options from the list',\n  featuresMin: 'Define at least {{#limit}} features',\n  featuresMax: 'Only {{#limit}} features can be defined',\n  featuresLength: 'Define exactly {{#limit}} features'\n}\n\nexport const messages: LanguageMessagesExt = {\n  'string.base': messageTemplate.required,\n  'string.min': messageTemplate.min,\n  'string.empty': messageTemplate.required,\n  'string.max': messageTemplate.max,\n  'string.email': messageTemplate.format,\n  'string.unicode': messageTemplate.unicode,\n  'string.pattern.base': messageTemplate.pattern,\n  'string.maxWords': messageTemplate.maxWords,\n\n  'number.base': messageTemplate.number,\n  'number.precision': messageTemplate.numberPrecision,\n  'number.integer': messageTemplate.numberInteger,\n  'number.unsafe': messageTemplate.format,\n  'number.min': messageTemplate.numberMin,\n  'number.max': messageTemplate.numberMax,\n\n  'object.required': messageTemplate.objectRequired,\n  'object.and': messageTemplate.objectMissing,\n\n  'any.only': messageTemplate.selectRequired,\n  'any.required': messageTemplate.selectRequired,\n  'any.empty': messageTemplate.required,\n\n  'date.base': messageTemplate.dateFormat,\n  'date.format': messageTemplate.dateFormat,\n  'date.min': messageTemplate.dateMin,\n  'date.max': messageTemplate.dateMax,\n\n  'object.invalidjson': messageTemplate.format\n}\n\nexport const messagesPre: LanguageMessages =\n  messages as unknown as LanguageMessages\n\nexport const validationOptions: ValidationOptions = {\n  abortEarly: false,\n  messages: messagesPre,\n  errors: {\n    wrap: {\n      array: false,\n      label: false\n    }\n  }\n}\n"],"mappings":"AAAA;;AAEA,OAAOA,GAAG,MAMH,KAAK;AAEZ,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA,OAAO,MAAMI,eAA8C,GAAG;EAC5DC,mBAAmB,EAAEN,GAAG,CAACO,UAAU,CACjC,uFAAuF,EACvFL,IACF,CAAkB;EAClBM,QAAQ,EAAER,GAAG,CAACO,UAAU,CACtB,8BAA8B,EAC9BL,IACF,CAAkB;EAClBO,cAAc,EAAET,GAAG,CAACO,UAAU,CAC5B,+BAA+B,EAC/BL,IACF,CAAkB;EAClBQ,mBAAmB,EAAE,+BAA+B;EACpDC,GAAG,EAAE,kDAAkD;EACvDC,GAAG,EAAE,kDAAkD;EACvDC,MAAM,EAAE,6DAA6D;EACrEC,OAAO,EAAEd,GAAG,CAACO,UAAU,CACrB,sCAAsC,EACtCL,IACF,CAAkB;EAClBa,MAAM,EAAEf,GAAG,CAACO,UAAU,CACpB,oDAAoD,EACpDL,IACF,CAAkB;EAClBc,OAAO,EAAE,kEAAkE;EAC3EC,MAAM,EAAE,6BAA6B;EACrCC,eAAe,EAAE,yDAAyD;EAC1EC,aAAa,EAAE,mCAAmC;EAClDC,SAAS,EAAE,yCAAyC;EACpDC,SAAS,EAAE,wCAAwC;EACnDC,QAAQ,EAAE,8CAA8C;EAExD;;EAEAC,cAAc,EAAEvB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEsB,aAAa,EAAExB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBuB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE,qDAAqD;EAC9DC,QAAQ,EAAE,kDAAkD;EAC5DC,QAAQ,EAAE,+CAA+C;EACzDC,WAAW,EAAE,8CAA8C;EAC3DC,WAAW,EAAE,qCAAqC;EAClDC,WAAW,EAAE,yCAAyC;EACtDC,cAAc,EAAE;AAClB,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAE7B,eAAe,CAACG,QAAQ;EACvC,YAAY,EAAEH,eAAe,CAACO,GAAG;EACjC,cAAc,EAAEP,eAAe,CAACG,QAAQ;EACxC,YAAY,EAAEH,eAAe,CAACM,GAAG;EACjC,cAAc,EAAEN,eAAe,CAACU,MAAM;EACtC,gBAAgB,EAAEV,eAAe,CAACW,OAAO;EACzC,qBAAqB,EAAEX,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACiB,QAAQ;EAE3C,aAAa,EAAEjB,eAAe,CAACY,MAAM;EACrC,kBAAkB,EAAEZ,eAAe,CAACa,eAAe;EACnD,gBAAgB,EAAEb,eAAe,CAACc,aAAa;EAC/C,eAAe,EAAEd,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACe,SAAS;EACvC,YAAY,EAAEf,eAAe,CAACgB,SAAS;EAEvC,iBAAiB,EAAEhB,eAAe,CAACkB,cAAc;EACjD,YAAY,EAAElB,eAAe,CAACmB,aAAa;EAE3C,UAAU,EAAEnB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACoB,UAAU;EACvC,aAAa,EAAEpB,eAAe,CAACoB,UAAU;EACzC,UAAU,EAAEpB,eAAe,CAACqB,OAAO;EACnC,UAAU,EAAErB,eAAe,CAACsB,OAAO;EAEnC,oBAAoB,EAAEtB,eAAe,CAACU;AACxC,CAAC;AAED,OAAO,MAAMoB,WAA6B,GACxCD,QAAuC;AAEzC,OAAO,MAAME,iBAAoC,GAAG;EAClDC,UAAU,EAAE,KAAK;EACjBH,QAAQ,EAAEC,WAAW;EACrBG,MAAM,EAAE;IACNC,IAAI,EAAE;MACJC,KAAK,EAAE,KAAK;MACZC,KAAK,EAAE;IACT;EACF;AACF,CAAC","ignoreList":[]}

package/.server/server/plugins/engine/views/components/geospatialfield.html

@@ -1,7 +1,7 @@
 {% from "govuk/components/textarea/macro.njk" import govukTextarea %}
 
 {% macro GeospatialField(component) %}
-  <div class="app-geospatial-field" data-country="{{component.model.country}}">
+  <div class="app-geospatial-field" data-country="{{component.model.country}}" data-geometryTypes="{{component.model.geometryTypes}}">
     {{ govukTextarea(component.model) }}
   </div>
 {% endmacro %}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.13.0",
+  "version": "4.14.1",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -87,7 +87,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.663",
+    "@defra/forms-model": "^3.0.668",
     "@defra/hapi-tracing": "^1.29.0",
     "@defra/interactive-map": "^0.0.22-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",

package/src/client/javascripts/geospatial-map.js

@@ -7,6 +7,7 @@ import {
   getCentroidGridRef,
   getCoordinateGridRef
 } from './map.js'
+import { formatDelimtedList } from './utils.js'
 
 const helpPanelConfig = {
   showLabel: true,
@@ -28,8 +29,63 @@ const helpPanelConfig = {
     open: true,
     dismissible: true,
     modal: false
-  },
-  html: '<p class="govuk-body-s govuk-!-margin-bottom-2">You can add points, shapes or lines to the map.</p><ul class="govuk-list govuk-list--number govuk-body-s"><li>Search for a county, place or postcode</li><li>Use the + and - icons to zoom in and out</li><li>Double‑click, or select \'Done\', when you have finished drawing a line or shape</li><li>Give the location a name</li></ul>'
+  }
+}
+
+/**
+ * @param {boolean} allowLine
+ * @param {boolean} allowShape
+ */
+function getLineOrShapeText(allowLine, allowShape) {
+  if (allowLine && allowShape) {
+    return 'a line or shape'
+  }
+  if (allowLine) {
+    return 'a line'
+  }
+  if (allowShape) {
+    return 'a shape'
+  }
+  return ''
+}
+
+/**
+ * @param {boolean} allowPoint
+ * @param {boolean} allowLine
+ * @param {boolean} allowShape
+ */
+function getAllowedTypesPhrase(allowPoint, allowLine, allowShape) {
+  const items = []
+
+  if (allowPoint) {
+    items.push('points')
+  }
+  if (allowLine) {
+    items.push('lines')
+  }
+  if (allowShape) {
+    items.push('shapes')
+  }
+
+  return formatDelimtedList(items, ',', 'or')
+}
+
+/**
+ * @param {boolean} allowPoint
+ * @param {boolean} allowLine
+ * @param {boolean} allowShape
+ */
+export function getHelpPanelHtml(allowPoint, allowLine, allowShape) {
+  const lineOrShapeText = getLineOrShapeText(allowLine, allowShape)
+  const doneExtra = lineOrShapeText
+    ? `<li>Double‑click, or select 'Done', when you have finished drawing ${lineOrShapeText}</li>`
+    : ''
+  const allowedTypesText = getAllowedTypesPhrase(
+    allowPoint,
+    allowLine,
+    allowShape
+  )
+  return `<p class="govuk-body-s govuk-!-margin-bottom-2">You can add ${allowedTypesText} to the map.</p><ul class="govuk-list govuk-list--number govuk-body-s"><li>Search for a county, place or postcode</li><li>Use the + and - icons to zoom in and out</li>${doneExtra}<li>Give the location a name</li></ul>`
 }
 
 const lineFeatureProperties = {
@@ -157,7 +213,18 @@ export function processGeospatial(config, geospatial, index) {
   const { map, interactPlugin } = createMap(mapId, initConfig, config)
   const featuresManager = getFeaturesManager(geojson)
   const activeFeatureManager = getActiveFeatureManager()
-  const uiManager = getUIManager(geojson, map, mapId, listEl, geospatialInput)
+  const geometryTypes = geospatial.dataset.geometrytypes
+  const options = {
+    geometryTypes
+  }
+  const uiManager = getUIManager(
+    geojson,
+    map,
+    mapId,
+    listEl,
+    geospatialInput,
+    options
+  )
 
   /**
    * @type {Context}
@@ -492,16 +559,41 @@ function getValueRenderer(geojson, geospatialInput) {
  * @param {string} mapId - the ID of the map
  * @param {HTMLDivElement} listEl - where to render the feature list
  * @param {HTMLTextAreaElement} geospatialInput - the geospatial textarea
+ * @param { UIManagerOptions | undefined } options - extra options such as allowable geometry types
  */
-function getUIManager(geojson, map, mapId, listEl, geospatialInput) {
+export function getUIManager(
+  geojson,
+  map,
+  mapId,
+  listEl,
+  geospatialInput,
+  options
+) {
+  /**
+   * Get a CSV list of geometry types the user can create
+   * @returns {string[]}
+   */
+  function getAllowableGeometryTypes() {
+    return options?.geometryTypes
+      ? options.geometryTypes.split(',')
+      : ['point', 'line', 'shape']
+  }
+
   /**
    * Toggle the hidden state of the action buttons
    * @type {ToggleActionButtons}
    */
   function toggleActionButtons(hidden) {
-    map.toggleButtonState('btnAddPoint', 'hidden', hidden)
-    map.toggleButtonState('btnAddPolygon', 'hidden', hidden)
-    map.toggleButtonState('btnAddLine', 'hidden', hidden)
+    const types = getAllowableGeometryTypes()
+    if (types.includes('point')) {
+      map.toggleButtonState('btnAddPoint', 'hidden', hidden)
+    }
+    if (types.includes('shape')) {
+      map.toggleButtonState('btnAddPolygon', 'hidden', hidden)
+    }
+    if (types.includes('line')) {
+      map.toggleButtonState('btnAddLine', 'hidden', hidden)
+    }
   }
 
   /**
@@ -528,7 +620,8 @@ function getUIManager(geojson, map, mapId, listEl, geospatialInput) {
     renderValue,
     listEl,
     toggleActionButtons,
-    focusDescriptionInput
+    focusDescriptionInput,
+    getAllowableGeometryTypes
   }
 }
 
@@ -572,7 +665,8 @@ function createContainers(geospatialInput, index) {
 function onMapReadyFactory(context) {
   const { map, activeFeatureManager, uiManager, interactPlugin, drawPlugin } =
     context
-  const { toggleActionButtons, renderList } = uiManager
+  const { toggleActionButtons, renderList, getAllowableGeometryTypes } =
+    uiManager
   const { resetActiveFeature } = activeFeatureManager
 
   /**
@@ -581,53 +675,67 @@ function onMapReadyFactory(context) {
    * @param {MapLibreMap} e.map - the map provider instance
    */
   return function onMapReady(e) {
+    const types = getAllowableGeometryTypes()
+    const allowPoint = types.includes('point')
+    const allowLine = types.includes('line')
+    const allowShape = types.includes('shape')
+
     // Add info panel
-    map.addPanel('info', helpPanelConfig)
-
-    map.addButton('btnAddPoint', {
-      variant: 'tertiary',
-      label: 'Add point',
-      iconSvgContent: POINT_SVG,
-      onClick: () => {
-        resetActiveFeature()
-        toggleActionButtons(true)
-        renderList(true)
-        interactPlugin.enable()
-      },
-      mobile: { slot: 'actions' },
-      tablet: { slot: 'actions' },
-      desktop: { slot: 'actions' }
+    map.addPanel('info', {
+      ...helpPanelConfig,
+      html: getHelpPanelHtml(allowPoint, allowLine, allowShape)
     })
 
-    map.addButton('btnAddPolygon', {
-      variant: 'tertiary',
-      label: 'Add shape',
-      iconSvgContent: POLYGON_SVG,
-      onClick: () => {
-        resetActiveFeature()
-        toggleActionButtons(true)
-        renderList(true)
-        drawPlugin.newPolygon(generateID(), polygonFeatureProperties)
-      },
-      mobile: { slot: 'actions' },
-      tablet: { slot: 'actions' },
-      desktop: { slot: 'actions' }
-    })
+    if (allowPoint) {
+      map.addButton('btnAddPoint', {
+        variant: 'tertiary',
+        label: 'Add point',
+        iconSvgContent: POINT_SVG,
+        onClick: () => {
+          resetActiveFeature()
+          toggleActionButtons(true)
+          renderList(true)
+          interactPlugin.enable()
+        },
+        mobile: { slot: 'actions' },
+        tablet: { slot: 'actions' },
+        desktop: { slot: 'actions' }
+      })
+    }
 
-    map.addButton('btnAddLine', {
-      variant: 'tertiary',
-      label: 'Add line',
-      iconSvgContent: LINE_SVG,
-      onClick: () => {
-        resetActiveFeature()
-        toggleActionButtons(true)
-        renderList(true)
-        drawPlugin.newLine(generateID(), lineFeatureProperties)
-      },
-      mobile: { slot: 'actions' },
-      tablet: { slot: 'actions' },
-      desktop: { slot: 'actions' }
-    })
+    if (allowShape) {
+      map.addButton('btnAddPolygon', {
+        variant: 'tertiary',
+        label: 'Add shape',
+        iconSvgContent: POLYGON_SVG,
+        onClick: () => {
+          resetActiveFeature()
+          toggleActionButtons(true)
+          renderList(true)
+          drawPlugin.newPolygon(generateID(), polygonFeatureProperties)
+        },
+        mobile: { slot: 'actions' },
+        tablet: { slot: 'actions' },
+        desktop: { slot: 'actions' }
+      })
+    }
+
+    if (allowLine) {
+      map.addButton('btnAddLine', {
+        variant: 'tertiary',
+        label: 'Add line',
+        iconSvgContent: LINE_SVG,
+        onClick: () => {
+          resetActiveFeature()
+          toggleActionButtons(true)
+          renderList(true)
+          drawPlugin.newLine(generateID(), lineFeatureProperties)
+        },
+        mobile: { slot: 'actions' },
+        tablet: { slot: 'actions' },
+        desktop: { slot: 'actions' }
+      })
+    }
 
     // Set the map provider on the context
     context.mapProvider = e.map
@@ -1055,6 +1163,12 @@ function onListElKeydownFactory() {
  * @returns {void}
  */
 
+/**
+ * Returns the list of geometry types a user can create
+ * @callback GetAllowableGeometryTypes
+ * @returns {string[]}
+ */
+
 /**
  * Set focus to the last description input
  * @callback FocusDescriptionInput
@@ -1084,6 +1198,7 @@ function onListElKeydownFactory() {
  * @property {HTMLDivElement} listEl - the summary list of features
  * @property {ToggleActionButtons} toggleActionButtons - function that toggles the action buttons
  * @property {FocusDescriptionInput} focusDescriptionInput - function that sets focus to a description input element
+ * @property {GetAllowableGeometryTypes} getAllowableGeometryTypes - function that returns the array of geometry types a user can create
  */
 
 /**
@@ -1098,5 +1213,5 @@ function onListElKeydownFactory() {
  */
 
 /**
- * @import { MapLibreMap } from './map.js'
+ * @import { MapLibreMap, UIManagerOptions } from './map.js'
  */

package/src/client/javascripts/map.js

@@ -395,6 +395,11 @@ export function centerMap(map, mapProvider, center) {
  * @property {TileData} data - the tile data config
  */
 
+/**
+ * @typedef {object} UIManagerOptions
+ * @property {string} [geometryTypes] - the CSV list of geometry types that a user can create
+ */
+
 /**
  * @import { Feature } from '../../server/plugins/engine/types.js'
  */

package/src/client/javascripts/utils.js

@@ -0,0 +1,23 @@
+/**
+ * Builds a text representation of a list in the form 'a, b, c, d or e'
+ * @param {string[]} items
+ * @param {string} separator
+ * @param {string} lastSpearator
+ */
+export function formatDelimtedList(items, separator, lastSpearator) {
+  if (items.length === 0) {
+    return ''
+  }
+
+  if (items.length === 1) {
+    return items[0]
+  }
+
+  if (items.length === 2) {
+    return `${items[0]} ${lastSpearator} ${items[1]}`
+  }
+
+  const last = items.pop()
+  const separatorAndSpace = `${separator} `
+  return `${items.join(separatorAndSpace)} ${lastSpearator} ${last}`
+}