@defra/forms-engine-plugin 4.3.0 → 4.4.0

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

@@ -0,0 +1,71 @@
+import Bourne from '@hapi/bourne';
+import JoiBase from 'joi';
+const Joi = JoiBase.extend({
+  type: 'array',
+  base: JoiBase.array(),
+  messages: {
+    'object.invalidjson': '{{#label}} must be a valid json array string'
+  },
+  coerce: {
+    from: 'string',
+    method(value, helpers) {
+      if (typeof value === 'string') {
+        if (value.trim() === '') {
+          return {
+            value: undefined
+          };
+        }
+        try {
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+          return {
+            value: Bourne.parse(value)
+          };
+        } catch {
+          const result = {
+            value,
+            errors: [helpers.error('object.invalidjson')]
+          };
+          return result;
+        }
+      } else {
+        return {
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+          value
+        };
+      }
+    }
+  }
+});
+const coordinatesSchema = Joi.array().items(Joi.number().required(), Joi.number().required()).required();
+const featurePropertiesSchema = Joi.object().keys({
+  description: Joi.string().required(),
+  coordinateGridReference: Joi.string().required(),
+  centroidGridReference: Joi.string().required()
+}).required();
+const featureGeometrySchema = Joi.object().keys({
+  type: Joi.string().valid('Point', 'LineString', 'Polygon').required(),
+  coordinates: Joi.array().when('type', {
+    switch: [{
+      is: 'Point',
+      then: coordinatesSchema
+    }, {
+      is: 'LineString',
+      then: Joi.array().items(coordinatesSchema).min(2)
+    }, {
+      is: 'Polygon',
+      then: Joi.array().items(Joi.array().items(coordinatesSchema).min(3))
+    }]
+  }).required()
+});
+const featureSchema = Joi.object().keys({
+  id: Joi.string().required(),
+  type: Joi.string().valid('Feature').required(),
+  properties: featurePropertiesSchema,
+  geometry: featureGeometrySchema
+});
+export const geospatialSchema = Joi.array().items(featureSchema).unique('id').required();
+
+/**
+ * @import { CustomHelpers } from 'joi'
+ */
+//# sourceMappingURL=geospatial.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"geospatial.js","names":["Bourne","JoiBase","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"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.ts"],"sourcesContent":["import Bourne from '@hapi/bourne'\nimport JoiBase from 'joi'\n\nimport {\n  type Coordinates,\n  type Feature,\n  type FeatureProperties,\n  type Geometry\n} from '~/src/server/plugins/engine/types.js'\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\nexport const geospatialSchema = Joi.array<Feature[]>()\n  .items(featureSchema)\n  .unique('id')\n  .required()\n\n/**\n * @import { CustomHelpers } from 'joi'\n */\n"],"mappings":"AAAA,OAAOA,MAAM,MAAM,cAAc;AACjC,OAAOC,OAAO,MAAM,KAAK;AASzB,MAAMC,GAAG,GAAGD,OAAO,CAACE,MAAM,CAAC;EACzBC,IAAI,EAAE,OAAO;EACbC,IAAI,EAAEJ,OAAO,CAACK,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,EAAEX,MAAM,CAACe,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,OAAO,MAAMY,gBAAgB,GAAGxC,GAAG,CAACI,KAAK,CAAY,CAAC,CACnDc,KAAK,CAACkB,aAAa,CAAC,CACpBK,MAAM,CAAC,IAAI,CAAC,CACZrB,QAAQ,CAAC,CAAC;;AAEb;AACA;AACA","ignoreList":[]}

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

@@ -0,0 +1,42 @@
+import { validState } from "./__stubs__/geospatial.js";
+import { geospatialSchema } from "./geospatial.js";
+describe('Geospatial validation helpers', () => {
+  test('it should not have errors for valid geojson object', () => {
+    const result = geospatialSchema.validate(validState);
+    expect(result.error).toBeUndefined();
+    expect(result.value).toBeDefined();
+    expect(result.value).toHaveLength(4);
+  });
+  test('it should not have errors for valid geojson string', () => {
+    const result = geospatialSchema.validate(JSON.stringify(validState));
+    expect(result.error).toBeUndefined();
+    expect(result.value).toBeDefined();
+    expect(result.value).toHaveLength(4);
+  });
+  test('it should have errors for invalid json string', () => {
+    const result = geospatialSchema.validate('{');
+    expect(result.error).toBeDefined();
+    expect(result.value).toBe('{');
+  });
+  test('it should have errors for invalid geojson string', () => {
+    const result = geospatialSchema.validate('[');
+    expect(result.error).toBeDefined();
+    expect(result.value).toBe('[');
+  });
+  test('it should validate an empty array', () => {
+    const result = geospatialSchema.validate('[]');
+    expect(result.error).toBeUndefined();
+    expect(result.value).toEqual([]);
+  });
+  test('it should not validate an empty object', () => {
+    const result = geospatialSchema.validate('{}');
+    expect(result.error).toBeDefined();
+    expect(result.value).toBeUndefined();
+  });
+  test('it should validate an empty string', () => {
+    const result = geospatialSchema.validate('');
+    expect(result.error).toBeDefined();
+    expect(result.value).toBeUndefined();
+  });
+});
+//# sourceMappingURL=geospatial.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"geospatial.test.js","names":["validState","geospatialSchema","describe","test","result","validate","expect","error","toBeUndefined","value","toBeDefined","toHaveLength","JSON","stringify","toBe","toEqual"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/geospatial.test.js"],"sourcesContent":["import { validState } from '~/src/server/plugins/engine/components/helpers/__stubs__/geospatial.js'\nimport { geospatialSchema } from '~/src/server/plugins/engine/components/helpers/geospatial.js'\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"],"mappings":"AAAA,SAASA,UAAU;AACnB,SAASC,gBAAgB;AAEzBC,QAAQ,CAAC,+BAA+B,EAAE,MAAM;EAC9CC,IAAI,CAAC,oDAAoD,EAAE,MAAM;IAC/D,MAAMC,MAAM,GAAGH,gBAAgB,CAACI,QAAQ,CAACL,UAAU,CAAC;IAEpDM,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,CAACb,UAAU,CAAC,CAAC;IAEpEM,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;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/engine/components/index.d.ts

@@ -29,3 +29,4 @@ export { NationalGridFieldNumberField } from '~/src/server/plugins/engine/compon
 export { LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js';
 export { HiddenField } from '~/src/server/plugins/engine/components/HiddenField.js';
 export { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js';
+export { GeospatialField } from '~/src/server/plugins/engine/components/GeospatialField.js';

package/.server/server/plugins/engine/components/index.js

@@ -30,4 +30,5 @@ export { NationalGridFieldNumberField } from "./NationalGridFieldNumberField.js"
 export { LatLongField } from "./LatLongField.js";
 export { HiddenField } from "./HiddenField.js";
 export { PaymentField } from "./PaymentField.js";
+export { GeospatialField } from "./GeospatialField.js";
 //# sourceMappingURL=index.js.map

package/.server/server/plugins/engine/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["AutocompleteField","CheckboxesField","DatePartsField","DeclarationField","Details","EmailAddressField","FileUploadField","Html","InsetText","List","Markdown","MonthYearField","MultilineTextField","NumberField","RadiosField","SelectField","TelephoneNumberField","TextField","UkAddressField","YesNoField","EastingNorthingField","OsGridRefField","NationalGridFieldNumberField","LatLongField","HiddenField","PaymentField"],"sources":["../../../../../src/server/plugins/engine/components/index.ts"],"sourcesContent":["/**\n * IMPORTANT: Exported Components must follow the naming convention implemented in {@link @defra/forms-model#ComponentType}\n * In the Form JSON, components have a type property which is the name of the components, e.g. DatePartsField.\n * Components are loaded in the ComponentsCollection constructor.\n */\n\nexport { AutocompleteField } from '~/src/server/plugins/engine/components/AutocompleteField.js'\nexport { CheckboxesField } from '~/src/server/plugins/engine/components/CheckboxesField.js'\nexport { DatePartsField } from '~/src/server/plugins/engine/components/DatePartsField.js'\nexport { DeclarationField } from '~/src/server/plugins/engine/components/DeclarationField.js'\nexport { Details } from '~/src/server/plugins/engine/components/Details.js'\nexport { EmailAddressField } from '~/src/server/plugins/engine/components/EmailAddressField.js'\nexport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nexport { Html } from '~/src/server/plugins/engine/components/Html.js'\nexport { InsetText } from '~/src/server/plugins/engine/components/InsetText.js'\nexport { List } from '~/src/server/plugins/engine/components/List.js'\nexport { Markdown } from '~/src/server/plugins/engine/components/Markdown.js'\nexport { MonthYearField } from '~/src/server/plugins/engine/components/MonthYearField.js'\nexport { MultilineTextField } from '~/src/server/plugins/engine/components/MultilineTextField.js'\nexport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nexport { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.js'\nexport { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'\nexport { TelephoneNumberField } from '~/src/server/plugins/engine/components/TelephoneNumberField.js'\nexport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nexport { UkAddressField } from '~/src/server/plugins/engine/components/UkAddressField.js'\nexport { YesNoField } from '~/src/server/plugins/engine/components/YesNoField.js'\nexport { EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'\nexport { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'\nexport { NationalGridFieldNumberField } from '~/src/server/plugins/engine/components/NationalGridFieldNumberField.js'\nexport { LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'\nexport { HiddenField } from '~/src/server/plugins/engine/components/HiddenField.js'\nexport { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB;AAC1B,SAASC,eAAe;AACxB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,OAAO;AAChB,SAASC,iBAAiB;AAC1B,SAASC,eAAe;AACxB,SAASC,IAAI;AACb,SAASC,SAAS;AAClB,SAASC,IAAI;AACb,SAASC,QAAQ;AACjB,SAASC,cAAc;AACvB,SAASC,kBAAkB;AAC3B,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,oBAAoB;AAC7B,SAASC,SAAS;AAClB,SAASC,cAAc;AACvB,SAASC,UAAU;AACnB,SAASC,oBAAoB;AAC7B,SAASC,cAAc;AACvB,SAASC,4BAA4B;AACrC,SAASC,YAAY;AACrB,SAASC,WAAW;AACpB,SAASC,YAAY","ignoreList":[]}
+{"version":3,"file":"index.js","names":["AutocompleteField","CheckboxesField","DatePartsField","DeclarationField","Details","EmailAddressField","FileUploadField","Html","InsetText","List","Markdown","MonthYearField","MultilineTextField","NumberField","RadiosField","SelectField","TelephoneNumberField","TextField","UkAddressField","YesNoField","EastingNorthingField","OsGridRefField","NationalGridFieldNumberField","LatLongField","HiddenField","PaymentField","GeospatialField"],"sources":["../../../../../src/server/plugins/engine/components/index.ts"],"sourcesContent":["/**\n * IMPORTANT: Exported Components must follow the naming convention implemented in {@link @defra/forms-model#ComponentType}\n * In the Form JSON, components have a type property which is the name of the components, e.g. DatePartsField.\n * Components are loaded in the ComponentsCollection constructor.\n */\n\nexport { AutocompleteField } from '~/src/server/plugins/engine/components/AutocompleteField.js'\nexport { CheckboxesField } from '~/src/server/plugins/engine/components/CheckboxesField.js'\nexport { DatePartsField } from '~/src/server/plugins/engine/components/DatePartsField.js'\nexport { DeclarationField } from '~/src/server/plugins/engine/components/DeclarationField.js'\nexport { Details } from '~/src/server/plugins/engine/components/Details.js'\nexport { EmailAddressField } from '~/src/server/plugins/engine/components/EmailAddressField.js'\nexport { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'\nexport { Html } from '~/src/server/plugins/engine/components/Html.js'\nexport { InsetText } from '~/src/server/plugins/engine/components/InsetText.js'\nexport { List } from '~/src/server/plugins/engine/components/List.js'\nexport { Markdown } from '~/src/server/plugins/engine/components/Markdown.js'\nexport { MonthYearField } from '~/src/server/plugins/engine/components/MonthYearField.js'\nexport { MultilineTextField } from '~/src/server/plugins/engine/components/MultilineTextField.js'\nexport { NumberField } from '~/src/server/plugins/engine/components/NumberField.js'\nexport { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.js'\nexport { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'\nexport { TelephoneNumberField } from '~/src/server/plugins/engine/components/TelephoneNumberField.js'\nexport { TextField } from '~/src/server/plugins/engine/components/TextField.js'\nexport { UkAddressField } from '~/src/server/plugins/engine/components/UkAddressField.js'\nexport { YesNoField } from '~/src/server/plugins/engine/components/YesNoField.js'\nexport { EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'\nexport { OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'\nexport { NationalGridFieldNumberField } from '~/src/server/plugins/engine/components/NationalGridFieldNumberField.js'\nexport { LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'\nexport { HiddenField } from '~/src/server/plugins/engine/components/HiddenField.js'\nexport { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'\nexport { GeospatialField } from '~/src/server/plugins/engine/components/GeospatialField.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB;AAC1B,SAASC,eAAe;AACxB,SAASC,cAAc;AACvB,SAASC,gBAAgB;AACzB,SAASC,OAAO;AAChB,SAASC,iBAAiB;AAC1B,SAASC,eAAe;AACxB,SAASC,IAAI;AACb,SAASC,SAAS;AAClB,SAASC,IAAI;AACb,SAASC,QAAQ;AACjB,SAASC,cAAc;AACvB,SAASC,kBAAkB;AAC3B,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,WAAW;AACpB,SAASC,oBAAoB;AAC7B,SAASC,SAAS;AAClB,SAASC,cAAc;AACvB,SAASC,UAAU;AACnB,SAASC,oBAAoB;AAC7B,SAASC,cAAc;AACvB,SAASC,4BAA4B;AACrC,SAASC,YAAY;AACrB,SAASC,WAAW;AACpB,SAASC,YAAY;AACrB,SAASC,eAAe","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/PageController.d.ts

@@ -14,6 +14,7 @@ export declare class PageController {
     name?: string;
     model: FormModel;
     pageDef: Page;
+    id?: string;
     title: string;
     section?: Section;
     condition?: ExecutableCondition;

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

@@ -9,6 +9,7 @@ export class PageController {
   name;
   model;
   pageDef;
+  id;
   title;
   section;
   condition;
@@ -24,6 +25,7 @@ export class PageController {
     this.name = def.name;
     this.model = model;
     this.pageDef = pageDef;
+    this.id = pageDef.id;
     this.title = pageDef.title;
     this.events = pageDef.events;
 

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

@@ -1 +1 @@
-{"version":3,"file":"PageController.js","names":["ControllerPath","Boom","getSaveAndExitHelpers","getStartPath","normalisePath","PageController","def","name","model","pageDef","title","section","condition","events","collection","viewName","allowSaveAndExit","constructor","getSection","conditions","view","path","href","getHref","keys","getRouteOptions","postRouteOptions","viewModel","showTitle","pageTitle","sectionTitle","hideTitle","page","isStartPage","serviceUrl","feedbackLink","phaseTag","options","disableUserFeedback","undefined","formId","phaseBanner","phase","basePath","relativeTargetPath","startsWith","substring","finalPath","replace","getSummaryPath","Summary","valueOf","getStatusPath","Status","makeGetRouteHandler","request","context","h","makePostRouteHandler","badRequest","getStateKeys","_component","shouldShowSaveAndExit","server"],"sources":["../../../../../src/server/plugins/engine/pageControllers/PageController.ts"],"sourcesContent":["import {\n  ControllerPath,\n  type Events,\n  type FormDefinition,\n  type Page,\n  type Section\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type Lifecycle, type RouteOptions, type Server } from '@hapi/hapi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { type FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  getSaveAndExitHelpers,\n  getStartPath,\n  normalisePath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type PageViewModelBase\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport class PageController {\n  /**\n   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.\n   */\n  def: FormDefinition\n  name?: string\n  model: FormModel\n  pageDef: Page\n  title: string\n  section?: Section\n  condition?: ExecutableCondition\n  events?: Events\n  collection?: ComponentCollection\n  viewName = 'index'\n  allowSaveAndExit = false\n\n  constructor(model: FormModel, pageDef: Page) {\n    const { def } = model\n\n    this.def = def\n    this.name = def.name\n    this.model = model\n    this.pageDef = pageDef\n    this.title = pageDef.title\n    this.events = pageDef.events\n\n    // Resolve section\n    if (pageDef.section) {\n      this.section = model.getSection(pageDef.section)\n    }\n\n    // Resolve condition\n    if (pageDef.condition) {\n      this.condition = model.conditions[pageDef.condition]\n    }\n\n    // Override view name\n    if (pageDef.view) {\n      this.viewName = pageDef.view\n    }\n  }\n\n  get path() {\n    return this.pageDef.path\n  }\n\n  get href() {\n    const { path } = this\n    return this.getHref(`/${normalisePath(path)}`)\n  }\n\n  get keys() {\n    return this.collection?.keys ?? []\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {}\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {}\n  }\n\n  get viewModel(): PageViewModelBase {\n    const { name, section, title } = this\n\n    const showTitle = true\n    const pageTitle = title\n    const sectionTitle = section?.hideTitle !== true ? section?.title : ''\n\n    return {\n      name,\n      page: this,\n      pageTitle,\n      sectionTitle,\n      showTitle,\n      isStartPage: false,\n      serviceUrl: this.getHref('/'),\n      feedbackLink: this.feedbackLink,\n      phaseTag: this.phaseTag\n    }\n  }\n\n  get feedbackLink() {\n    return this.def.options?.disableUserFeedback\n      ? undefined\n      : `/form/feedback?formId=${this.model.formId}`\n  }\n\n  get phaseTag() {\n    const { def } = this\n    return def.phaseBanner?.phase\n  }\n\n  getHref(path: string): string {\n    const basePath = this.model.basePath\n\n    if (path === '/') {\n      return `/${basePath}`\n    }\n\n    // if ever the path is not prefixed with a slash, add it\n    const relativeTargetPath = path.startsWith('/') ? path.substring(1) : path\n    let finalPath = `/${basePath}`\n    if (relativeTargetPath) {\n      finalPath += `/${relativeTargetPath}`\n    }\n    finalPath = finalPath.replace(/\\/{2,}/g, '/')\n\n    return finalPath\n  }\n\n  getStartPath() {\n    return getStartPath(this.model)\n  }\n\n  getSummaryPath() {\n    return ControllerPath.Summary.valueOf()\n  }\n\n  getStatusPath() {\n    return ControllerPath.Status.valueOf()\n  }\n\n  makeGetRouteHandler(): (\n    request: FormRequest,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {\n    return (request, context, h) => {\n      const { viewModel, viewName } = this\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  makePostRouteHandler(): (\n    request: FormRequestPayload,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {\n    throw Boom.badRequest('Unsupported POST route handler for this page')\n  }\n\n  /**\n   * Get supplementary state keys for clearing component state.\n   *\n   * This method returns page controller-level state keys only. The core component's\n   * state key (the component's name) is managed separately by the framework and should\n   * NOT be included in the returned array.\n   *\n   * Returns an empty array by default. Override in subclasses to provide\n   * page-specific supplementary state keys (e.g., upload state, cached data).\n   * @param _component - The component to get supplementary state keys for (optional)\n   * @returns Array of supplementary state keys to clear (excluding the component name itself)\n   */\n  getStateKeys(_component?: FormComponent): string[] {\n    return []\n  }\n\n  shouldShowSaveAndExit(server: Server): boolean {\n    return getSaveAndExitHelpers(server) !== undefined && this.allowSaveAndExit\n  }\n}\n"],"mappings":"AAAA,SACEA,cAAc,QAKT,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAK7B,SACEC,qBAAqB,EACrBC,YAAY,EACZC,aAAa;AAgBf,OAAO,MAAMC,cAAc,CAAC;EAC1B;AACF;AACA;EACEC,GAAG;EACHC,IAAI;EACJC,KAAK;EACLC,OAAO;EACPC,KAAK;EACLC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC,QAAQ,GAAG,OAAO;EAClBC,gBAAgB,GAAG,KAAK;EAExBC,WAAWA,CAACT,KAAgB,EAAEC,OAAa,EAAE;IAC3C,MAAM;MAAEH;IAAI,CAAC,GAAGE,KAAK;IAErB,IAAI,CAACF,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,IAAI,GAAGD,GAAG,CAACC,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,KAAK,GAAGD,OAAO,CAACC,KAAK;IAC1B,IAAI,CAACG,MAAM,GAAGJ,OAAO,CAACI,MAAM;;IAE5B;IACA,IAAIJ,OAAO,CAACE,OAAO,EAAE;MACnB,IAAI,CAACA,OAAO,GAAGH,KAAK,CAACU,UAAU,CAACT,OAAO,CAACE,OAAO,CAAC;IAClD;;IAEA;IACA,IAAIF,OAAO,CAACG,SAAS,EAAE;MACrB,IAAI,CAACA,SAAS,GAAGJ,KAAK,CAACW,UAAU,CAACV,OAAO,CAACG,SAAS,CAAC;IACtD;;IAEA;IACA,IAAIH,OAAO,CAACW,IAAI,EAAE;MAChB,IAAI,CAACL,QAAQ,GAAGN,OAAO,CAACW,IAAI;IAC9B;EACF;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACZ,OAAO,CAACY,IAAI;EAC1B;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,MAAM;MAAED;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACE,OAAO,CAAC,IAAInB,aAAa,CAACiB,IAAI,CAAC,EAAE,CAAC;EAChD;EAEA,IAAIG,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACV,UAAU,EAAEU,IAAI,IAAI,EAAE;EACpC;;EAEA;AACF;AACA;EACE,IAAIC,eAAeA,CAAA,EAAkC;IACnD,OAAO,CAAC,CAAC;EACX;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO,CAAC,CAAC;EACX;EAEA,IAAIC,SAASA,CAAA,EAAsB;IACjC,MAAM;MAAEpB,IAAI;MAAEI,OAAO;MAAED;IAAM,CAAC,GAAG,IAAI;IAErC,MAAMkB,SAAS,GAAG,IAAI;IACtB,MAAMC,SAAS,GAAGnB,KAAK;IACvB,MAAMoB,YAAY,GAAGnB,OAAO,EAAEoB,SAAS,KAAK,IAAI,GAAGpB,OAAO,EAAED,KAAK,GAAG,EAAE;IAEtE,OAAO;MACLH,IAAI;MACJyB,IAAI,EAAE,IAAI;MACVH,SAAS;MACTC,YAAY;MACZF,SAAS;MACTK,WAAW,EAAE,KAAK;MAClBC,UAAU,EAAE,IAAI,CAACX,OAAO,CAAC,GAAG,CAAC;MAC7BY,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,QAAQ,EAAE,IAAI,CAACA;IACjB,CAAC;EACH;EAEA,IAAID,YAAYA,CAAA,EAAG;IACjB,OAAO,IAAI,CAAC7B,GAAG,CAAC+B,OAAO,EAAEC,mBAAmB,GACxCC,SAAS,GACT,yBAAyB,IAAI,CAAC/B,KAAK,CAACgC,MAAM,EAAE;EAClD;EAEA,IAAIJ,QAAQA,CAAA,EAAG;IACb,MAAM;MAAE9B;IAAI,CAAC,GAAG,IAAI;IACpB,OAAOA,GAAG,CAACmC,WAAW,EAAEC,KAAK;EAC/B;EAEAnB,OAAOA,CAACF,IAAY,EAAU;IAC5B,MAAMsB,QAAQ,GAAG,IAAI,CAACnC,KAAK,CAACmC,QAAQ;IAEpC,IAAItB,IAAI,KAAK,GAAG,EAAE;MAChB,OAAO,IAAIsB,QAAQ,EAAE;IACvB;;IAEA;IACA,MAAMC,kBAAkB,GAAGvB,IAAI,CAACwB,UAAU,CAAC,GAAG,CAAC,GAAGxB,IAAI,CAACyB,SAAS,CAAC,CAAC,CAAC,GAAGzB,IAAI;IAC1E,IAAI0B,SAAS,GAAG,IAAIJ,QAAQ,EAAE;IAC9B,IAAIC,kBAAkB,EAAE;MACtBG,SAAS,IAAI,IAAIH,kBAAkB,EAAE;IACvC;IACAG,SAAS,GAAGA,SAAS,CAACC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;IAE7C,OAAOD,SAAS;EAClB;EAEA5C,YAAYA,CAAA,EAAG;IACb,OAAOA,YAAY,CAAC,IAAI,CAACK,KAAK,CAAC;EACjC;EAEAyC,cAAcA,CAAA,EAAG;IACf,OAAOjD,cAAc,CAACkD,OAAO,CAACC,OAAO,CAAC,CAAC;EACzC;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAOpD,cAAc,CAACqD,MAAM,CAACF,OAAO,CAAC,CAAC;EACxC;EAEAG,mBAAmBA,CAAA,EAIgC;IACjD,OAAO,CAACC,OAAO,EAAEC,OAAO,EAAEC,CAAC,KAAK;MAC9B,MAAM;QAAE9B,SAAS;QAAEZ;MAAS,CAAC,GAAG,IAAI;MACpC,OAAO0C,CAAC,CAACrC,IAAI,CAACL,QAAQ,EAAEY,SAAS,CAAC;IACpC,CAAC;EACH;EAEA+B,oBAAoBA,CAAA,EAIsC;IACxD,MAAMzD,IAAI,CAAC0D,UAAU,CAAC,8CAA8C,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAACC,UAA0B,EAAY;IACjD,OAAO,EAAE;EACX;EAEAC,qBAAqBA,CAACC,MAAc,EAAW;IAC7C,OAAO7D,qBAAqB,CAAC6D,MAAM,CAAC,KAAKxB,SAAS,IAAI,IAAI,CAACvB,gBAAgB;EAC7E;AACF","ignoreList":[]}
+{"version":3,"file":"PageController.js","names":["ControllerPath","Boom","getSaveAndExitHelpers","getStartPath","normalisePath","PageController","def","name","model","pageDef","id","title","section","condition","events","collection","viewName","allowSaveAndExit","constructor","getSection","conditions","view","path","href","getHref","keys","getRouteOptions","postRouteOptions","viewModel","showTitle","pageTitle","sectionTitle","hideTitle","page","isStartPage","serviceUrl","feedbackLink","phaseTag","options","disableUserFeedback","undefined","formId","phaseBanner","phase","basePath","relativeTargetPath","startsWith","substring","finalPath","replace","getSummaryPath","Summary","valueOf","getStatusPath","Status","makeGetRouteHandler","request","context","h","makePostRouteHandler","badRequest","getStateKeys","_component","shouldShowSaveAndExit","server"],"sources":["../../../../../src/server/plugins/engine/pageControllers/PageController.ts"],"sourcesContent":["import {\n  ControllerPath,\n  type Events,\n  type FormDefinition,\n  type Page,\n  type Section\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type Lifecycle, type RouteOptions, type Server } from '@hapi/hapi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport { type FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport {\n  getSaveAndExitHelpers,\n  getStartPath,\n  normalisePath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type PageViewModelBase\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs,\n  type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport class PageController {\n  /**\n   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.\n   */\n  def: FormDefinition\n  name?: string\n  model: FormModel\n  pageDef: Page\n  id?: string\n  title: string\n  section?: Section\n  condition?: ExecutableCondition\n  events?: Events\n  collection?: ComponentCollection\n  viewName = 'index'\n  allowSaveAndExit = false\n\n  constructor(model: FormModel, pageDef: Page) {\n    const { def } = model\n\n    this.def = def\n    this.name = def.name\n    this.model = model\n    this.pageDef = pageDef\n    this.id = pageDef.id\n    this.title = pageDef.title\n    this.events = pageDef.events\n\n    // Resolve section\n    if (pageDef.section) {\n      this.section = model.getSection(pageDef.section)\n    }\n\n    // Resolve condition\n    if (pageDef.condition) {\n      this.condition = model.conditions[pageDef.condition]\n    }\n\n    // Override view name\n    if (pageDef.view) {\n      this.viewName = pageDef.view\n    }\n  }\n\n  get path() {\n    return this.pageDef.path\n  }\n\n  get href() {\n    const { path } = this\n    return this.getHref(`/${normalisePath(path)}`)\n  }\n\n  get keys() {\n    return this.collection?.keys ?? []\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {}\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {}\n  }\n\n  get viewModel(): PageViewModelBase {\n    const { name, section, title } = this\n\n    const showTitle = true\n    const pageTitle = title\n    const sectionTitle = section?.hideTitle !== true ? section?.title : ''\n\n    return {\n      name,\n      page: this,\n      pageTitle,\n      sectionTitle,\n      showTitle,\n      isStartPage: false,\n      serviceUrl: this.getHref('/'),\n      feedbackLink: this.feedbackLink,\n      phaseTag: this.phaseTag\n    }\n  }\n\n  get feedbackLink() {\n    return this.def.options?.disableUserFeedback\n      ? undefined\n      : `/form/feedback?formId=${this.model.formId}`\n  }\n\n  get phaseTag() {\n    const { def } = this\n    return def.phaseBanner?.phase\n  }\n\n  getHref(path: string): string {\n    const basePath = this.model.basePath\n\n    if (path === '/') {\n      return `/${basePath}`\n    }\n\n    // if ever the path is not prefixed with a slash, add it\n    const relativeTargetPath = path.startsWith('/') ? path.substring(1) : path\n    let finalPath = `/${basePath}`\n    if (relativeTargetPath) {\n      finalPath += `/${relativeTargetPath}`\n    }\n    finalPath = finalPath.replace(/\\/{2,}/g, '/')\n\n    return finalPath\n  }\n\n  getStartPath() {\n    return getStartPath(this.model)\n  }\n\n  getSummaryPath() {\n    return ControllerPath.Summary.valueOf()\n  }\n\n  getStatusPath() {\n    return ControllerPath.Status.valueOf()\n  }\n\n  makeGetRouteHandler(): (\n    request: FormRequest,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {\n    return (request, context, h) => {\n      const { viewModel, viewName } = this\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  makePostRouteHandler(): (\n    request: FormRequestPayload,\n    context: FormContext,\n    h: FormResponseToolkit\n  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {\n    throw Boom.badRequest('Unsupported POST route handler for this page')\n  }\n\n  /**\n   * Get supplementary state keys for clearing component state.\n   *\n   * This method returns page controller-level state keys only. The core component's\n   * state key (the component's name) is managed separately by the framework and should\n   * NOT be included in the returned array.\n   *\n   * Returns an empty array by default. Override in subclasses to provide\n   * page-specific supplementary state keys (e.g., upload state, cached data).\n   * @param _component - The component to get supplementary state keys for (optional)\n   * @returns Array of supplementary state keys to clear (excluding the component name itself)\n   */\n  getStateKeys(_component?: FormComponent): string[] {\n    return []\n  }\n\n  shouldShowSaveAndExit(server: Server): boolean {\n    return getSaveAndExitHelpers(server) !== undefined && this.allowSaveAndExit\n  }\n}\n"],"mappings":"AAAA,SACEA,cAAc,QAKT,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAK7B,SACEC,qBAAqB,EACrBC,YAAY,EACZC,aAAa;AAgBf,OAAO,MAAMC,cAAc,CAAC;EAC1B;AACF;AACA;EACEC,GAAG;EACHC,IAAI;EACJC,KAAK;EACLC,OAAO;EACPC,EAAE;EACFC,KAAK;EACLC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC,QAAQ,GAAG,OAAO;EAClBC,gBAAgB,GAAG,KAAK;EAExBC,WAAWA,CAACV,KAAgB,EAAEC,OAAa,EAAE;IAC3C,MAAM;MAAEH;IAAI,CAAC,GAAGE,KAAK;IAErB,IAAI,CAACF,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,IAAI,GAAGD,GAAG,CAACC,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,EAAE,GAAGD,OAAO,CAACC,EAAE;IACpB,IAAI,CAACC,KAAK,GAAGF,OAAO,CAACE,KAAK;IAC1B,IAAI,CAACG,MAAM,GAAGL,OAAO,CAACK,MAAM;;IAE5B;IACA,IAAIL,OAAO,CAACG,OAAO,EAAE;MACnB,IAAI,CAACA,OAAO,GAAGJ,KAAK,CAACW,UAAU,CAACV,OAAO,CAACG,OAAO,CAAC;IAClD;;IAEA;IACA,IAAIH,OAAO,CAACI,SAAS,EAAE;MACrB,IAAI,CAACA,SAAS,GAAGL,KAAK,CAACY,UAAU,CAACX,OAAO,CAACI,SAAS,CAAC;IACtD;;IAEA;IACA,IAAIJ,OAAO,CAACY,IAAI,EAAE;MAChB,IAAI,CAACL,QAAQ,GAAGP,OAAO,CAACY,IAAI;IAC9B;EACF;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACb,OAAO,CAACa,IAAI;EAC1B;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,MAAM;MAAED;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACE,OAAO,CAAC,IAAIpB,aAAa,CAACkB,IAAI,CAAC,EAAE,CAAC;EAChD;EAEA,IAAIG,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACV,UAAU,EAAEU,IAAI,IAAI,EAAE;EACpC;;EAEA;AACF;AACA;EACE,IAAIC,eAAeA,CAAA,EAAkC;IACnD,OAAO,CAAC,CAAC;EACX;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO,CAAC,CAAC;EACX;EAEA,IAAIC,SAASA,CAAA,EAAsB;IACjC,MAAM;MAAErB,IAAI;MAAEK,OAAO;MAAED;IAAM,CAAC,GAAG,IAAI;IAErC,MAAMkB,SAAS,GAAG,IAAI;IACtB,MAAMC,SAAS,GAAGnB,KAAK;IACvB,MAAMoB,YAAY,GAAGnB,OAAO,EAAEoB,SAAS,KAAK,IAAI,GAAGpB,OAAO,EAAED,KAAK,GAAG,EAAE;IAEtE,OAAO;MACLJ,IAAI;MACJ0B,IAAI,EAAE,IAAI;MACVH,SAAS;MACTC,YAAY;MACZF,SAAS;MACTK,WAAW,EAAE,KAAK;MAClBC,UAAU,EAAE,IAAI,CAACX,OAAO,CAAC,GAAG,CAAC;MAC7BY,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,QAAQ,EAAE,IAAI,CAACA;IACjB,CAAC;EACH;EAEA,IAAID,YAAYA,CAAA,EAAG;IACjB,OAAO,IAAI,CAAC9B,GAAG,CAACgC,OAAO,EAAEC,mBAAmB,GACxCC,SAAS,GACT,yBAAyB,IAAI,CAAChC,KAAK,CAACiC,MAAM,EAAE;EAClD;EAEA,IAAIJ,QAAQA,CAAA,EAAG;IACb,MAAM;MAAE/B;IAAI,CAAC,GAAG,IAAI;IACpB,OAAOA,GAAG,CAACoC,WAAW,EAAEC,KAAK;EAC/B;EAEAnB,OAAOA,CAACF,IAAY,EAAU;IAC5B,MAAMsB,QAAQ,GAAG,IAAI,CAACpC,KAAK,CAACoC,QAAQ;IAEpC,IAAItB,IAAI,KAAK,GAAG,EAAE;MAChB,OAAO,IAAIsB,QAAQ,EAAE;IACvB;;IAEA;IACA,MAAMC,kBAAkB,GAAGvB,IAAI,CAACwB,UAAU,CAAC,GAAG,CAAC,GAAGxB,IAAI,CAACyB,SAAS,CAAC,CAAC,CAAC,GAAGzB,IAAI;IAC1E,IAAI0B,SAAS,GAAG,IAAIJ,QAAQ,EAAE;IAC9B,IAAIC,kBAAkB,EAAE;MACtBG,SAAS,IAAI,IAAIH,kBAAkB,EAAE;IACvC;IACAG,SAAS,GAAGA,SAAS,CAACC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;IAE7C,OAAOD,SAAS;EAClB;EAEA7C,YAAYA,CAAA,EAAG;IACb,OAAOA,YAAY,CAAC,IAAI,CAACK,KAAK,CAAC;EACjC;EAEA0C,cAAcA,CAAA,EAAG;IACf,OAAOlD,cAAc,CAACmD,OAAO,CAACC,OAAO,CAAC,CAAC;EACzC;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAOrD,cAAc,CAACsD,MAAM,CAACF,OAAO,CAAC,CAAC;EACxC;EAEAG,mBAAmBA,CAAA,EAIgC;IACjD,OAAO,CAACC,OAAO,EAAEC,OAAO,EAAEC,CAAC,KAAK;MAC9B,MAAM;QAAE9B,SAAS;QAAEZ;MAAS,CAAC,GAAG,IAAI;MACpC,OAAO0C,CAAC,CAACrC,IAAI,CAACL,QAAQ,EAAEY,SAAS,CAAC;IACpC,CAAC;EACH;EAEA+B,oBAAoBA,CAAA,EAIsC;IACxD,MAAM1D,IAAI,CAAC2D,UAAU,CAAC,8CAA8C,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAACC,UAA0B,EAAY;IACjD,OAAO,EAAE;EACX;EAEAC,qBAAqBA,CAACC,MAAc,EAAW;IAC7C,OAAO9D,qBAAqB,CAAC8D,MAAM,CAAC,KAAKxB,SAAS,IAAI,IAAI,CAACvB,gBAAgB;EAC7E;AACF","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/helpers/submission.js

@@ -1,3 +1,4 @@
+import { GeospatialField } from "../../components/GeospatialField.js";
 import { PaymentField } from "../../components/PaymentField.js";
 import { getAnswer } from "../../components/helpers/components.js";
 import { formatCurrency, formatPaymentDate } from "../../../payment/helper.js";
@@ -12,6 +13,14 @@ export function buildMainRecords(items) {
   for (const item of fieldItems) {
     if (item.field instanceof PaymentField) {
       records.push(...buildPaymentRecords(item));
+    } else if (item.field instanceof GeospatialField) {
+      // Stringify of GeoJSON is done here rather than inside `getContextValueFromState`
+      // so we don't incur the overhead of JSON.stringify on every request when building context
+      records.push({
+        name: item.name,
+        title: item.label,
+        value: JSON.stringify(item.field.getFormValueFromState(item.state))
+      });
     } else {
       records.push({
         name: item.name,
@@ -68,7 +77,10 @@ export function buildRepeaterRecords(items) {
     value: item.subItems.map(detailItems => detailItems.map(subItem => ({
       name: subItem.name,
       title: subItem.label,
-      value: getAnswer(subItem.field, subItem.state, {
+      value:
+      // Stringify of GeoJSON is done here rather than inside `getContextValueFromState`
+      // so we don't incur the overhead of JSON.stringify on every request when building context
+      subItem.field instanceof GeospatialField ? JSON.stringify(subItem.field.getFormValueFromState(subItem.state)) : getAnswer(subItem.field, subItem.state, {
         format: 'data'
       })
     })))

package/.server/server/plugins/engine/pageControllers/helpers/submission.js.map

@@ -1 +1 @@
-{"version":3,"file":"submission.js","names":["PaymentField","getAnswer","formatCurrency","formatPaymentDate","buildMainRecords","items","fieldItems","filter","item","records","field","push","buildPaymentRecords","name","title","label","value","state","format","paymentState","getPaymentStateFromState","description","amount","reference","preAuth","createdAt","buildRepeaterRecords","map","subItems","detailItems","subItem"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/submission.ts"],"sourcesContent":["import { type SubmitPayload } from '@defra/forms-model'\n\nimport { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type DetailItem,\n  type DetailItemField\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  formatCurrency,\n  formatPaymentDate\n} from '~/src/server/plugins/payment/helper.js'\n\nexport interface SubmitRecord {\n  name: string\n  title: string\n  value: string\n}\n\n/**\n * Builds the main submission records from field items.\n * Regular fields are converted to single records, while PaymentField\n * components are expanded into four separate records.\n */\nexport function buildMainRecords(items: DetailItem[]): SubmitRecord[] {\n  const fieldItems = items.filter(\n    (item): item is DetailItemField => 'field' in item\n  )\n\n  const records: SubmitRecord[] = []\n\n  for (const item of fieldItems) {\n    if (item.field instanceof PaymentField) {\n      records.push(...buildPaymentRecords(item))\n    } else {\n      records.push({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })\n    }\n  }\n\n  return records\n}\n\n/**\n * Expands a PaymentField into four submission records:\n * - Payment description\n * - Payment amount (formatted with currency symbol)\n * - Payment reference\n * - Payment date (formatted date/time)\n *\n * Returns an empty array if no payment state exists.\n */\nexport function buildPaymentRecords(item: DetailItemField): SubmitRecord[] {\n  const paymentState = (item.field as PaymentField).getPaymentStateFromState(\n    item.state\n  )\n\n  if (!paymentState) {\n    return []\n  }\n\n  return [\n    {\n      name: `${item.name}_paymentDescription`,\n      title: 'Payment description',\n      value: paymentState.description\n    },\n    {\n      name: `${item.name}_paymentAmount`,\n      title: 'Payment amount',\n      value: formatCurrency(paymentState.amount)\n    },\n    {\n      name: `${item.name}_paymentReference`,\n      title: 'Payment reference',\n      value: paymentState.reference\n    },\n    {\n      name: `${item.name}_paymentDate`,\n      title: 'Payment date',\n      value: paymentState.preAuth?.createdAt\n        ? formatPaymentDate(paymentState.preAuth.createdAt)\n        : ''\n    }\n  ]\n}\n\n/**\n * Builds the repeater submission records from repeater items.\n */\nexport function buildRepeaterRecords(\n  items: DetailItem[]\n): SubmitPayload['repeaters'] {\n  return items\n    .filter((item) => 'subItems' in item)\n    .map((item) => ({\n      name: item.name,\n      title: item.label,\n      value: item.subItems.map((detailItems) =>\n        detailItems.map((subItem) => ({\n          name: subItem.name,\n          title: subItem.label,\n          value: getAnswer(subItem.field, subItem.state, { format: 'data' })\n        }))\n      )\n    }))\n}\n"],"mappings":"AAEA,SAASA,YAAY;AACrB,SAASC,SAAS;AAKlB,SACEC,cAAc,EACdC,iBAAiB;AASnB;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACC,KAAmB,EAAkB;EACpE,MAAMC,UAAU,GAAGD,KAAK,CAACE,MAAM,CAC5BC,IAAI,IAA8B,OAAO,IAAIA,IAChD,CAAC;EAED,MAAMC,OAAuB,GAAG,EAAE;EAElC,KAAK,MAAMD,IAAI,IAAIF,UAAU,EAAE;IAC7B,IAAIE,IAAI,CAACE,KAAK,YAAYV,YAAY,EAAE;MACtCS,OAAO,CAACE,IAAI,CAAC,GAAGC,mBAAmB,CAACJ,IAAI,CAAC,CAAC;IAC5C,CAAC,MAAM;MACLC,OAAO,CAACE,IAAI,CAAC;QACXE,IAAI,EAAEL,IAAI,CAACK,IAAI;QACfC,KAAK,EAAEN,IAAI,CAACO,KAAK;QACjBC,KAAK,EAAEf,SAAS,CAACO,IAAI,CAACE,KAAK,EAAEF,IAAI,CAACS,KAAK,EAAE;UAAEC,MAAM,EAAE;QAAO,CAAC;MAC7D,CAAC,CAAC;IACJ;EACF;EAEA,OAAOT,OAAO;AAChB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,mBAAmBA,CAACJ,IAAqB,EAAkB;EACzE,MAAMW,YAAY,GAAIX,IAAI,CAACE,KAAK,CAAkBU,wBAAwB,CACxEZ,IAAI,CAACS,KACP,CAAC;EAED,IAAI,CAACE,YAAY,EAAE;IACjB,OAAO,EAAE;EACX;EAEA,OAAO,CACL;IACEN,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,qBAAqB;IACvCC,KAAK,EAAE,qBAAqB;IAC5BE,KAAK,EAAEG,YAAY,CAACE;EACtB,CAAC,EACD;IACER,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,gBAAgB;IAClCC,KAAK,EAAE,gBAAgB;IACvBE,KAAK,EAAEd,cAAc,CAACiB,YAAY,CAACG,MAAM;EAC3C,CAAC,EACD;IACET,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,mBAAmB;IACrCC,KAAK,EAAE,mBAAmB;IAC1BE,KAAK,EAAEG,YAAY,CAACI;EACtB,CAAC,EACD;IACEV,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,cAAc;IAChCC,KAAK,EAAE,cAAc;IACrBE,KAAK,EAAEG,YAAY,CAACK,OAAO,EAAEC,SAAS,GAClCtB,iBAAiB,CAACgB,YAAY,CAACK,OAAO,CAACC,SAAS,CAAC,GACjD;EACN,CAAC,CACF;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAClCrB,KAAmB,EACS;EAC5B,OAAOA,KAAK,CACTE,MAAM,CAAEC,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCmB,GAAG,CAAEnB,IAAI,KAAM;IACdK,IAAI,EAAEL,IAAI,CAACK,IAAI;IACfC,KAAK,EAAEN,IAAI,CAACO,KAAK;IACjBC,KAAK,EAAER,IAAI,CAACoB,QAAQ,CAACD,GAAG,CAAEE,WAAW,IACnCA,WAAW,CAACF,GAAG,CAAEG,OAAO,KAAM;MAC5BjB,IAAI,EAAEiB,OAAO,CAACjB,IAAI;MAClBC,KAAK,EAAEgB,OAAO,CAACf,KAAK;MACpBC,KAAK,EAAEf,SAAS,CAAC6B,OAAO,CAACpB,KAAK,EAAEoB,OAAO,CAACb,KAAK,EAAE;QAAEC,MAAM,EAAE;MAAO,CAAC;IACnE,CAAC,CAAC,CACJ;EACF,CAAC,CAAC,CAAC;AACP","ignoreList":[]}
+{"version":3,"file":"submission.js","names":["GeospatialField","PaymentField","getAnswer","formatCurrency","formatPaymentDate","buildMainRecords","items","fieldItems","filter","item","records","field","push","buildPaymentRecords","name","title","label","value","JSON","stringify","getFormValueFromState","state","format","paymentState","getPaymentStateFromState","description","amount","reference","preAuth","createdAt","buildRepeaterRecords","map","subItems","detailItems","subItem"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/submission.ts"],"sourcesContent":["import { type SubmitPayload } from '@defra/forms-model'\n\nimport { GeospatialField } from '~/src/server/plugins/engine/components/GeospatialField.js'\nimport { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'\nimport { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type DetailItem,\n  type DetailItemField\n} from '~/src/server/plugins/engine/models/types.js'\nimport {\n  formatCurrency,\n  formatPaymentDate\n} from '~/src/server/plugins/payment/helper.js'\n\nexport interface SubmitRecord {\n  name: string\n  title: string\n  value: string\n}\n\n/**\n * Builds the main submission records from field items.\n * Regular fields are converted to single records, while PaymentField\n * components are expanded into four separate records.\n */\nexport function buildMainRecords(items: DetailItem[]): SubmitRecord[] {\n  const fieldItems = items.filter(\n    (item): item is DetailItemField => 'field' in item\n  )\n\n  const records: SubmitRecord[] = []\n\n  for (const item of fieldItems) {\n    if (item.field instanceof PaymentField) {\n      records.push(...buildPaymentRecords(item))\n    } else if (item.field instanceof GeospatialField) {\n      // Stringify of GeoJSON is done here rather than inside `getContextValueFromState`\n      // so we don't incur the overhead of JSON.stringify on every request when building context\n      records.push({\n        name: item.name,\n        title: item.label,\n        value: JSON.stringify(item.field.getFormValueFromState(item.state))\n      })\n    } else {\n      records.push({\n        name: item.name,\n        title: item.label,\n        value: getAnswer(item.field, item.state, { format: 'data' })\n      })\n    }\n  }\n\n  return records\n}\n\n/**\n * Expands a PaymentField into four submission records:\n * - Payment description\n * - Payment amount (formatted with currency symbol)\n * - Payment reference\n * - Payment date (formatted date/time)\n *\n * Returns an empty array if no payment state exists.\n */\nexport function buildPaymentRecords(item: DetailItemField): SubmitRecord[] {\n  const paymentState = (item.field as PaymentField).getPaymentStateFromState(\n    item.state\n  )\n\n  if (!paymentState) {\n    return []\n  }\n\n  return [\n    {\n      name: `${item.name}_paymentDescription`,\n      title: 'Payment description',\n      value: paymentState.description\n    },\n    {\n      name: `${item.name}_paymentAmount`,\n      title: 'Payment amount',\n      value: formatCurrency(paymentState.amount)\n    },\n    {\n      name: `${item.name}_paymentReference`,\n      title: 'Payment reference',\n      value: paymentState.reference\n    },\n    {\n      name: `${item.name}_paymentDate`,\n      title: 'Payment date',\n      value: paymentState.preAuth?.createdAt\n        ? formatPaymentDate(paymentState.preAuth.createdAt)\n        : ''\n    }\n  ]\n}\n\n/**\n * Builds the repeater submission records from repeater items.\n */\nexport function buildRepeaterRecords(\n  items: DetailItem[]\n): SubmitPayload['repeaters'] {\n  return items\n    .filter((item) => 'subItems' in item)\n    .map((item) => ({\n      name: item.name,\n      title: item.label,\n      value: item.subItems.map((detailItems) =>\n        detailItems.map((subItem) => ({\n          name: subItem.name,\n          title: subItem.label,\n          value:\n            // Stringify of GeoJSON is done here rather than inside `getContextValueFromState`\n            // so we don't incur the overhead of JSON.stringify on every request when building context\n            subItem.field instanceof GeospatialField\n              ? JSON.stringify(\n                  subItem.field.getFormValueFromState(subItem.state)\n                )\n              : getAnswer(subItem.field, subItem.state, { format: 'data' })\n        }))\n      )\n    }))\n}\n"],"mappings":"AAEA,SAASA,eAAe;AACxB,SAASC,YAAY;AACrB,SAASC,SAAS;AAKlB,SACEC,cAAc,EACdC,iBAAiB;AASnB;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACC,KAAmB,EAAkB;EACpE,MAAMC,UAAU,GAAGD,KAAK,CAACE,MAAM,CAC5BC,IAAI,IAA8B,OAAO,IAAIA,IAChD,CAAC;EAED,MAAMC,OAAuB,GAAG,EAAE;EAElC,KAAK,MAAMD,IAAI,IAAIF,UAAU,EAAE;IAC7B,IAAIE,IAAI,CAACE,KAAK,YAAYV,YAAY,EAAE;MACtCS,OAAO,CAACE,IAAI,CAAC,GAAGC,mBAAmB,CAACJ,IAAI,CAAC,CAAC;IAC5C,CAAC,MAAM,IAAIA,IAAI,CAACE,KAAK,YAAYX,eAAe,EAAE;MAChD;MACA;MACAU,OAAO,CAACE,IAAI,CAAC;QACXE,IAAI,EAAEL,IAAI,CAACK,IAAI;QACfC,KAAK,EAAEN,IAAI,CAACO,KAAK;QACjBC,KAAK,EAAEC,IAAI,CAACC,SAAS,CAACV,IAAI,CAACE,KAAK,CAACS,qBAAqB,CAACX,IAAI,CAACY,KAAK,CAAC;MACpE,CAAC,CAAC;IACJ,CAAC,MAAM;MACLX,OAAO,CAACE,IAAI,CAAC;QACXE,IAAI,EAAEL,IAAI,CAACK,IAAI;QACfC,KAAK,EAAEN,IAAI,CAACO,KAAK;QACjBC,KAAK,EAAEf,SAAS,CAACO,IAAI,CAACE,KAAK,EAAEF,IAAI,CAACY,KAAK,EAAE;UAAEC,MAAM,EAAE;QAAO,CAAC;MAC7D,CAAC,CAAC;IACJ;EACF;EAEA,OAAOZ,OAAO;AAChB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASG,mBAAmBA,CAACJ,IAAqB,EAAkB;EACzE,MAAMc,YAAY,GAAId,IAAI,CAACE,KAAK,CAAkBa,wBAAwB,CACxEf,IAAI,CAACY,KACP,CAAC;EAED,IAAI,CAACE,YAAY,EAAE;IACjB,OAAO,EAAE;EACX;EAEA,OAAO,CACL;IACET,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,qBAAqB;IACvCC,KAAK,EAAE,qBAAqB;IAC5BE,KAAK,EAAEM,YAAY,CAACE;EACtB,CAAC,EACD;IACEX,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,gBAAgB;IAClCC,KAAK,EAAE,gBAAgB;IACvBE,KAAK,EAAEd,cAAc,CAACoB,YAAY,CAACG,MAAM;EAC3C,CAAC,EACD;IACEZ,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,mBAAmB;IACrCC,KAAK,EAAE,mBAAmB;IAC1BE,KAAK,EAAEM,YAAY,CAACI;EACtB,CAAC,EACD;IACEb,IAAI,EAAE,GAAGL,IAAI,CAACK,IAAI,cAAc;IAChCC,KAAK,EAAE,cAAc;IACrBE,KAAK,EAAEM,YAAY,CAACK,OAAO,EAAEC,SAAS,GAClCzB,iBAAiB,CAACmB,YAAY,CAACK,OAAO,CAACC,SAAS,CAAC,GACjD;EACN,CAAC,CACF;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAClCxB,KAAmB,EACS;EAC5B,OAAOA,KAAK,CACTE,MAAM,CAAEC,IAAI,IAAK,UAAU,IAAIA,IAAI,CAAC,CACpCsB,GAAG,CAAEtB,IAAI,KAAM;IACdK,IAAI,EAAEL,IAAI,CAACK,IAAI;IACfC,KAAK,EAAEN,IAAI,CAACO,KAAK;IACjBC,KAAK,EAAER,IAAI,CAACuB,QAAQ,CAACD,GAAG,CAAEE,WAAW,IACnCA,WAAW,CAACF,GAAG,CAAEG,OAAO,KAAM;MAC5BpB,IAAI,EAAEoB,OAAO,CAACpB,IAAI;MAClBC,KAAK,EAAEmB,OAAO,CAAClB,KAAK;MACpBC,KAAK;MACH;MACA;MACAiB,OAAO,CAACvB,KAAK,YAAYX,eAAe,GACpCkB,IAAI,CAACC,SAAS,CACZe,OAAO,CAACvB,KAAK,CAACS,qBAAqB,CAACc,OAAO,CAACb,KAAK,CACnD,CAAC,GACDnB,SAAS,CAACgC,OAAO,CAACvB,KAAK,EAAEuB,OAAO,CAACb,KAAK,EAAE;QAAEC,MAAM,EAAE;MAAO,CAAC;IAClE,CAAC,CAAC,CACJ;EACF,CAAC,CAAC,CAAC;AACP","ignoreList":[]}

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

@@ -57,7 +57,8 @@ export const messages = {
   'date.base': messageTemplate.dateFormat,
   'date.format': messageTemplate.dateFormat,
   'date.min': messageTemplate.dateMin,
-  'date.max': messageTemplate.dateMax
+  'date.max': messageTemplate.dateMax,
+  'object.invalidjson': messageTemplate.format
 };
 export const messagesPre = messages;
 export const validationOptions = {

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","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","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  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}\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.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\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,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,EAAEtB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEqB,aAAa,EAAEvB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBsB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEtB,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,qBAAqB,EAAEV,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACgB,QAAQ;EAE3C,aAAa,EAAEhB,eAAe,CAACW,MAAM;EACrC,kBAAkB,EAAEX,eAAe,CAACY,eAAe;EACnD,gBAAgB,EAAEZ,eAAe,CAACa,aAAa;EAC/C,eAAe,EAAEb,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACc,SAAS;EACvC,YAAY,EAAEd,eAAe,CAACe,SAAS;EAEvC,iBAAiB,EAAEf,eAAe,CAACiB,cAAc;EACjD,YAAY,EAAEjB,eAAe,CAACkB,aAAa;EAE3C,UAAU,EAAElB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACmB,UAAU;EACvC,aAAa,EAAEnB,eAAe,CAACmB,UAAU;EACzC,UAAU,EAAEnB,eAAe,CAACoB,OAAO;EACnC,UAAU,EAAEpB,eAAe,CAACqB;AAC9B,CAAC;AAED,OAAO,MAAME,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","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","objectRequired","objectMissing","dateFormat","dateMin","dateMax","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  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}\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.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,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,EAAEtB,GAAG,CAACO,UAAU,CAAC,kBAAkB,EAAEL,IAAI,CAAkB;EACzEqB,aAAa,EAAEvB,GAAG,CAACO,UAAU,CAC3B,kDAAkD,EAClDL,IACF,CAAkB;EAClBsB,UAAU,EAAE,gCAAgC;EAC5CC,OAAO,EAAE,oDAAoD;EAC7DC,OAAO,EAAE;AACX,CAAC;AAED,OAAO,MAAMC,QAA6B,GAAG;EAC3C,aAAa,EAAEtB,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,qBAAqB,EAAEV,eAAe,CAACS,OAAO;EAC9C,iBAAiB,EAAET,eAAe,CAACgB,QAAQ;EAE3C,aAAa,EAAEhB,eAAe,CAACW,MAAM;EACrC,kBAAkB,EAAEX,eAAe,CAACY,eAAe;EACnD,gBAAgB,EAAEZ,eAAe,CAACa,aAAa;EAC/C,eAAe,EAAEb,eAAe,CAACU,MAAM;EACvC,YAAY,EAAEV,eAAe,CAACc,SAAS;EACvC,YAAY,EAAEd,eAAe,CAACe,SAAS;EAEvC,iBAAiB,EAAEf,eAAe,CAACiB,cAAc;EACjD,YAAY,EAAEjB,eAAe,CAACkB,aAAa;EAE3C,UAAU,EAAElB,eAAe,CAACI,cAAc;EAC1C,cAAc,EAAEJ,eAAe,CAACI,cAAc;EAC9C,WAAW,EAAEJ,eAAe,CAACG,QAAQ;EAErC,WAAW,EAAEH,eAAe,CAACmB,UAAU;EACvC,aAAa,EAAEnB,eAAe,CAACmB,UAAU;EACzC,UAAU,EAAEnB,eAAe,CAACoB,OAAO;EACnC,UAAU,EAAEpB,eAAe,CAACqB,OAAO;EAEnC,oBAAoB,EAAErB,eAAe,CAACU;AACxC,CAAC;AAED,OAAO,MAAMa,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/types.d.ts

@@ -75,7 +75,7 @@ export interface FormPayloadParams {
  * (after Joi has converted value types)
  */
 export type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>;
-export type FormValue = Item['value'] | Item['value'][] | UploadState | RepeatListState | undefined;
+export type FormValue = Item['value'] | Item['value'][] | UploadState | RepeatListState | GeospatialState | undefined;
 export type FormState = Partial<Record<string, FormStateValue>>;
 export type FormStateValue = Exclude<FormValue, undefined> | null;
 export interface FormValidationResult<ValueType extends FormPayload | FormSubmissionState> {
@@ -196,6 +196,67 @@ export interface RepeatItemState extends FormPayload {
     itemId: string;
 }
 export type RepeatListState = RepeatItemState[];
+/**
+ * A longitude/latitude coordinate pair in WGS84 format
+ * Format: [longitude, latitude]
+ */
+export type Coordinates = [longitude: number, latitude: number];
+/**
+ * GeoJSON Point geometry
+ */
+export interface PointGeometry {
+    type: 'Point';
+    coordinates: Coordinates;
+}
+/**
+ * GeoJSON LineString geometry
+ */
+export interface LineStringGeometry {
+    type: 'LineString';
+    coordinates: Coordinates[];
+}
+/**
+ * GeoJSON Polygon geometry
+ */
+export interface PolygonGeometry {
+    type: 'Polygon';
+    coordinates: Coordinates[][];
+}
+/**
+ * Supported geometry types
+ */
+export type Geometry = PointGeometry | LineStringGeometry | PolygonGeometry;
+/**
+ * Feature metadata
+ */
+export interface FeatureProperties {
+    /**
+     * Human-readable description of the feature
+     */
+    description: string;
+    /**
+     * The OS grid reference of the first coordinate of the feature
+     */
+    coordinateGridReference?: string;
+    /**
+     * The OS grid reference of the centroid of the feature
+     */
+    centroidGridReference?: string;
+}
+/**
+ * A single GeoJSON Feature
+ */
+export interface Feature {
+    id: string;
+    type: 'Feature';
+    properties: FeatureProperties;
+    geometry: Geometry;
+}
+/**
+ * A GeoJSON FeatureCollection
+ */
+export type FeatureCollection = Feature[];
+export type GeospatialState = FeatureCollection;
 export interface CheckAnswers {
     title?: ComponentText;
     summaryList: SummaryList;
@@ -360,7 +421,7 @@ export type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {
 export type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {
     field: PaymentField;
 };
-export type RichFormValue = FormValue | FormPayload | DatePartsState | MonthYearState | UkAddressState | EastingNorthingState | LatLongState;
+export type RichFormValue = FormValue | FormPayload | DatePartsState | MonthYearState | UkAddressState | EastingNorthingState | LatLongState | GeospatialState;
 export interface FormAdapterSubmissionMessageData {
     main: Record<string, RichFormValue | null>;
     repeaters: Record<string, Record<string, RichFormValue>[]>;

package/.server/server/plugins/engine/types.js

@@ -40,6 +40,39 @@
 
 export { FileStatus, UploadStatus } from "./types/enums.js";
 
+/**
+ * A longitude/latitude coordinate pair in WGS84 format
+ * Format: [longitude, latitude]
+ */
+
+/**
+ * GeoJSON Point geometry
+ */
+
+/**
+ * GeoJSON LineString geometry
+ */
+
+/**
+ * GeoJSON Polygon geometry
+ */
+
+/**
+ * Supported geometry types
+ */
+
+/**
+ * Feature metadata
+ */
+
+/**
+ * A single GeoJSON Feature
+ */
+
+/**
+ * A GeoJSON FeatureCollection
+ */
+
 /**
  * A detail item specifically for files
  */

package/.server/server/plugins/engine/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormVersionMetadata,\n  type Item,\n  type List,\n  type Page,\n  type PaymentFieldComponent,\n  type UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type ResponseObject\n} from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type FileUploadField,\n  type PaymentField\n} from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type EastingNorthingState,\n  type LatLongState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormResponseToolkit,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport type AnyFormRequest = FormRequest | FormRequestPayload\nexport type AnyRequest = Request | AnyFormRequest\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormConfirmationState {\n  confirmed?: true\n  formId?: string\n  referenceNumber?: string\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n  submittedVersionNumber?: number\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndExit: boolean\n  showSubmitButton?: boolean\n  showPaymentExpiredNotification?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n  allowSaveAndExit: boolean\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: AnyFormRequest,\n  h: FormResponseToolkit,\n  context: FormContext\n) =>\n  | ResponseObject\n  | FormResponseToolkit['continue']\n  | Promise<ResponseObject | FormResponseToolkit['continue']>\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\n\nexport interface ExternalArgs {\n  component: ComponentDef\n  controller: QuestionPageController\n  sourceUrl: string\n  actionArgs?: Record<string, string>\n  isLive: boolean\n  isPreview: boolean\n}\n\nexport interface PostcodeLookupExternalArgs extends ExternalArgs {\n  component: UkAddressFieldComponent\n  actionArgs: { step: string }\n}\n\nexport interface PaymentExternalArgs extends ExternalArgs {\n  component: PaymentFieldComponent\n}\n\nexport interface ExternalStateAppendage {\n  component: string\n  data: FormStateValue | FormState\n}\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cache?: CacheService | string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndExit?: SaveAndExitHandler\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n  versionMetadata?: FormVersionMetadata\n  custom?: Record<string, unknown>\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterPayment {\n  paymentId: string\n  reference: string\n  amount: number\n  description: string\n  createdAt: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\n/**\n * A detail item specifically for payments\n */\nexport type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {\n  field: PaymentField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n  | EastingNorthingState\n  | LatLongState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue | null>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n  payment?: FormAdapterPayment\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AA0DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAyBA;AACA;AACA;AACA;;AAsGA,SACEA,UAAU,EACVC,YAAY;;AAoQd;AACA;AACA;;AAKA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormVersionMetadata,\n  type Item,\n  type List,\n  type Page,\n  type PaymentFieldComponent,\n  type UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type ResponseObject\n} from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type FileUploadField,\n  type PaymentField\n} from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type EastingNorthingState,\n  type LatLongState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormResponseToolkit,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport type AnyFormRequest = FormRequest | FormRequestPayload\nexport type AnyRequest = Request | AnyFormRequest\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError extends Pick<\n  ValidationErrorItem,\n  'context' | 'path'\n> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormConfirmationState {\n  confirmed?: true\n  formId?: string\n  referenceNumber?: string\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | GeospatialState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n  submittedVersionNumber?: number\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\n/**\n * A longitude/latitude coordinate pair in WGS84 format\n * Format: [longitude, latitude]\n */\nexport type Coordinates = [longitude: number, latitude: number]\n\n/**\n * GeoJSON Point geometry\n */\nexport interface PointGeometry {\n  type: 'Point'\n  coordinates: Coordinates\n}\n\n/**\n * GeoJSON LineString geometry\n */\nexport interface LineStringGeometry {\n  type: 'LineString'\n  coordinates: Coordinates[]\n}\n\n/**\n * GeoJSON Polygon geometry\n */\nexport interface PolygonGeometry {\n  type: 'Polygon'\n  coordinates: Coordinates[][]\n}\n\n/**\n * Supported geometry types\n */\nexport type Geometry = PointGeometry | LineStringGeometry | PolygonGeometry\n\n/**\n * Feature metadata\n */\nexport interface FeatureProperties {\n  /**\n   * Human-readable description of the feature\n   */\n  description: string\n  /**\n   * The OS grid reference of the first coordinate of the feature\n   */\n  coordinateGridReference?: string\n  /**\n   * The OS grid reference of the centroid of the feature\n   */\n  centroidGridReference?: string\n}\n\n/**\n * A single GeoJSON Feature\n */\nexport interface Feature {\n  id: string\n  type: 'Feature'\n  properties: FeatureProperties\n  geometry: Geometry\n}\n\n/**\n * A GeoJSON FeatureCollection\n */\nexport type FeatureCollection = Feature[]\n\nexport type GeospatialState = FeatureCollection\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndExit: boolean\n  showSubmitButton?: boolean\n  showPaymentExpiredNotification?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n  allowSaveAndExit: boolean\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: AnyFormRequest,\n  h: FormResponseToolkit,\n  context: FormContext\n) =>\n  | ResponseObject\n  | FormResponseToolkit['continue']\n  | Promise<ResponseObject | FormResponseToolkit['continue']>\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\n\nexport interface ExternalArgs {\n  component: ComponentDef\n  controller: QuestionPageController\n  sourceUrl: string\n  actionArgs?: Record<string, string>\n  isLive: boolean\n  isPreview: boolean\n}\n\nexport interface PostcodeLookupExternalArgs extends ExternalArgs {\n  component: UkAddressFieldComponent\n  actionArgs: { step: string }\n}\n\nexport interface PaymentExternalArgs extends ExternalArgs {\n  component: PaymentFieldComponent\n}\n\nexport interface ExternalStateAppendage {\n  component: string\n  data: FormStateValue | FormState\n}\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cache?: CacheService | string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndExit?: SaveAndExitHandler\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n  versionMetadata?: FormVersionMetadata\n  custom?: Record<string, unknown>\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterPayment {\n  paymentId: string\n  reference: string\n  amount: number\n  description: string\n  createdAt: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\n/**\n * A detail item specifically for payments\n */\nexport type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {\n  field: PaymentField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n  | EastingNorthingState\n  | LatLongState\n  | GeospatialState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue | null>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n  payment?: FormAdapterPayment\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AA0DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AA2BA;AACA;AACA;AACA;;AAuGA,SACEA,UAAU,EACVC,YAAY;;AAgEd;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAGA;AACA;AACA;;AAgBA;AACA;AACA;;AAQA;AACA;AACA;;AAyMA;AACA;AACA;;AAKA;AACA;AACA","ignoreList":[]}

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

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