@defra/forms-engine-plugin 4.0.6 → 4.0.8

package/.server/server/plugins/nunjucks/filters/merge.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the page for a given path
+ * @param {Record<string, any>} targetDictionary - Object to extend
+ * @param {Record<string, any> | string} sourceDictionary - Object to merge into target
+ * @returns {Record<string, any>}
+ */
+export function merge(targetDictionary: Record<string, any>, sourceDictionary: Record<string, any> | string): Record<string, any>;

package/.server/server/plugins/nunjucks/filters/merge.js

@@ -0,0 +1,16 @@
+/**
+ * Nunjucks filter to get the page for a given path
+ * @param {Record<string, any>} targetDictionary - Object to extend
+ * @param {Record<string, any> | string} sourceDictionary - Object to merge into target
+ * @returns {Record<string, any>}
+ */
+export function merge(targetDictionary, sourceDictionary) {
+  if (typeof sourceDictionary !== 'object') {
+    return targetDictionary;
+  }
+  return {
+    ...targetDictionary,
+    ...sourceDictionary
+  };
+}
+//# sourceMappingURL=merge.js.map

package/.server/server/plugins/nunjucks/filters/merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.js","names":["merge","targetDictionary","sourceDictionary"],"sources":["../../../../../src/server/plugins/nunjucks/filters/merge.js"],"sourcesContent":["/**\n * Nunjucks filter to get the page for a given path\n * @param {Record<string, any>} targetDictionary - Object to extend\n * @param {Record<string, any> | string} sourceDictionary - Object to merge into target\n * @returns {Record<string, any>}\n */\nexport function merge(targetDictionary, sourceDictionary) {\n  if (typeof sourceDictionary !== 'object') {\n    return targetDictionary\n  }\n\n  return {\n    ...targetDictionary,\n    ...sourceDictionary\n  }\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,KAAKA,CAACC,gBAAgB,EAAEC,gBAAgB,EAAE;EACxD,IAAI,OAAOA,gBAAgB,KAAK,QAAQ,EAAE;IACxC,OAAOD,gBAAgB;EACzB;EAEA,OAAO;IACL,GAAGA,gBAAgB;IACnB,GAAGC;EACL,CAAC;AACH","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/merge.test.js

@@ -0,0 +1,19 @@
+import { merge } from "./merge.js";
+describe('merge', () => {
+  const propertyToMerge = {
+    lorem: 'ipsum'
+  };
+  it('should return the target if source is not an object', () => {
+    expect(merge(propertyToMerge, 'dolar')).toBe(propertyToMerge);
+  });
+  it('should merge the properties if they are valid', () => {
+    expect(merge({
+      lorem: 'dolar',
+      dolar: 'sit'
+    }, propertyToMerge)).toEqual({
+      lorem: 'ipsum',
+      dolar: 'sit'
+    });
+  });
+});
+//# sourceMappingURL=merge.test.js.map

package/.server/server/plugins/nunjucks/filters/merge.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.test.js","names":["merge","describe","propertyToMerge","lorem","it","expect","toBe","dolar","toEqual"],"sources":["../../../../../src/server/plugins/nunjucks/filters/merge.test.js"],"sourcesContent":["import { merge } from '~/src/server/plugins/nunjucks/filters/merge.js'\n\ndescribe('merge', () => {\n  const propertyToMerge = { lorem: 'ipsum' }\n  it('should return the target if source is not an object', () => {\n    expect(merge(propertyToMerge, 'dolar')).toBe(propertyToMerge)\n  })\n\n  it('should merge the properties if they are valid', () => {\n    expect(merge({ lorem: 'dolar', dolar: 'sit' }, propertyToMerge)).toEqual({\n      lorem: 'ipsum',\n      dolar: 'sit'\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,KAAK;AAEdC,QAAQ,CAAC,OAAO,EAAE,MAAM;EACtB,MAAMC,eAAe,GAAG;IAAEC,KAAK,EAAE;EAAQ,CAAC;EAC1CC,EAAE,CAAC,qDAAqD,EAAE,MAAM;IAC9DC,MAAM,CAACL,KAAK,CAACE,eAAe,EAAE,OAAO,CAAC,CAAC,CAACI,IAAI,CAACJ,eAAe,CAAC;EAC/D,CAAC,CAAC;EAEFE,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxDC,MAAM,CAACL,KAAK,CAAC;MAAEG,KAAK,EAAE,OAAO;MAAEI,KAAK,EAAE;IAAM,CAAC,EAAEL,eAAe,CAAC,CAAC,CAACM,OAAO,CAAC;MACvEL,KAAK,EAAE,OAAO;MACdI,KAAK,EAAE;IACT,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.6",
+  "version": "4.0.8",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -27,7 +27,7 @@
     "./components": "./.server/server/plugins/engine/components/index.js",
     "./services/*": "./.server/server/plugins/engine/services/*",
     "./engine/*": "./.server/server/plugins/engine/*",
-    "./helpers.js": "./.server/server/plugins/engine/components/helpers.js",
+    "./helpers.js": "./.server/server/plugins/engine/components/helpers/index.js",
     "./schema.js": "./.server/server/schemas/index.js",
     "./templates/*": "./.server/server/plugins/engine/views/*",
     "./cache-service.js": "./.server/server/services/cacheService.js",
@@ -70,7 +70,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.560",
+    "@defra/forms-model": "^3.0.574",
     "@defra/hapi-tracing": "^1.26.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",

package/src/client/stylesheets/_location-input.scss

@@ -0,0 +1,60 @@
+@use "govuk-frontend" as *;
+
+.app-location-input {
+  @include govuk-clearfix;
+  font-size: 0; // removes whitespace caused by inline-block
+  margin-bottom: govuk-spacing(6);
+
+  &:has(.govuk-input--error) {
+    border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+    padding-left: govuk-spacing(3);
+    margin-top: 0;
+  }
+}
+
+.govuk-hint:has(+ .app-location-input .govuk-input--error) {
+  border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+  padding-left: govuk-spacing(3);
+  margin-bottom: 0;
+}
+
+.govuk-fieldset:has(.app-location-input .govuk-input--error) {
+  .govuk-fieldset__legend {
+    border-left: $govuk-border-width-form-group-error solid $govuk-error-colour;
+    padding-left: govuk-spacing(3);
+    margin-bottom: 0;
+  }
+
+  .govuk-fieldset__legend + .govuk-hint {
+    margin-top: 0;
+  }
+}
+
+.app-location-input__item {
+  display: inline-block;
+  margin-right: govuk-spacing(4);
+  margin-bottom: govuk-spacing(4);
+
+  &:last-child {
+    margin-right: 0;
+  }
+
+  @include govuk-media-query($from: tablet) {
+    margin-bottom: 0;
+  }
+
+  .govuk-form-group {
+    margin-bottom: 0;
+    display: inline-block;
+    width: auto;
+  }
+
+  .govuk-label {
+    display: block;
+  }
+
+  .govuk-input {
+    margin-bottom: 0;
+    width: auto;
+  }
+}

package/src/client/stylesheets/application.scss

@@ -2,6 +2,7 @@
 @use "shared";
 @use "code";
 @use "tag-env";
+@use "location-input";
 
 //  An example of some user-supplied styling
 //  Not great practice but it illustrates the point

package/src/client/stylesheets/shared.scss

@@ -2,6 +2,7 @@
 @use "pkg:accessible-autocomplete";
 @use "prose";
 @use "summary-list";
+@use "location-input";
 
 // Use default GDS Transport font for autocomplete
 .autocomplete__hint,

package/src/server/forms/components.json

@@ -120,6 +120,13 @@
           "content": "### This is a H3 in markdown\n\n[An internal link](http://localhost:3009/fictional-page)\n\n[An external link](https://defra.gov.uk/fictional-page)",
           "options": {},
           "schema": {}
+        },
+        {
+          "type": "DeclarationField",
+          "name": "declaration",
+          "title": "Declaration",
+          "content": "By submitting this form, I agree to:\n\n- Provide accurate and complete information\n- Comply with all applicable regulations\n- Accept responsibility for any false statements",
+          "hint": "Please read and confirm the following terms"
         }
       ]
     },

package/src/server/forms/page-events.yaml

@@ -59,7 +59,7 @@ pages:
     next: []
     id: da0fbdb4-a2de-4650-be16-9ba552af135f
   - id: 449a45f6-4541-4a46-91bd-8b8931b07b50
-    title: Summary
+    title: ''
     path: '/summary'
     controller: SummaryPageController
     events:

package/src/server/forms/register-as-a-unicorn-breeder.yaml

@@ -163,6 +163,34 @@ pages:
     next:
       - path: '/how-many-members-of-staff-will-look-after-the-unicorns'
     components:
+      - name: dfGYuk
+        options: {}
+        schema: {}
+        type: EastingNorthingField
+        title: Easting and northing
+        hint:
+          This is an Easting and Northing component
+      - name: seTThb
+        options: {}
+        schema: {}
+        type: LatLongField
+        title: Latitute and longitude
+        hint:
+          This is an Latitute and Longitude component
+      - name: bhjloS
+        options: {}
+        schema: {}
+        type: NationalGridFieldNumberField
+        title: National grid field number
+        hint:
+          This is an National Grid Field Number component
+      - name: dfQQws
+        options: {}
+        schema: {}
+        type: OsGridRefField
+        title: Ordnance survey grid reference
+        hint:
+          This is an Ordnance survey Grid Reference component
       - name: bClCvo
         options: {}
         schema: {}
@@ -191,7 +219,7 @@ pages:
     controller: FileUploadPageController
     section: Regnsa
     next:
-      - path: '/how-many-unicorns-do-you-expect-to-breed-each-year'
+      - path: '/declaration'
     components:
       - name: dLzALM
         title: Documents
@@ -202,6 +230,17 @@ pages:
         schema:
           min: 1
           max: 3
+  - title: Declaration
+    path: '/declaration'
+    section: section
+    components:
+      - name: diLmal
+        title: Declaration
+        type: DeclarationField
+        content: 'Fill in this field'
+        options: {}
+    next:
+      - path: '/summary'
 conditions:
   - displayName: Address is different
     name: IrVmYz

package/src/server/index.test.ts

@@ -585,6 +585,7 @@ describe('prepareEnvironment', () => {
     'href',
     'field',
     'page',
+    'merge',
     'markdown'
   ]
 

package/src/server/plugins/engine/components/ComponentBase.ts

@@ -22,7 +22,7 @@ export class ComponentBase {
   type: ComponentDef['type']
   name: ComponentDef['name']
   title: ComponentDef['title']
-  schema?: Extract<ComponentDef, { schema: object }>['schema']
+  schema?: Extract<ComponentDef, { schema?: object }>['schema']
   options?: Extract<ComponentDef, { options: object }>['options']
 
   isFormComponent = false
@@ -90,6 +90,7 @@ export type ComponentSchema =
   | ArraySchema<boolean>
   | ArraySchema<object>
   | BooleanSchema<string>
+  | BooleanSchema
   | DateSchema
   | NumberSchema<string>
   | NumberSchema

package/src/server/plugins/engine/components/ComponentCollection.ts

@@ -256,6 +256,7 @@ export class ComponentCollection {
    */
   validate(value: FormPayload = {}): FormValidationResult<FormPayload> {
     const result = this.formSchema.validate(value, opts)
+
     const details = result.error?.details
 
     return {