@defra/forms-model 3.0.580 → 3.0.582

package/dist/types/form/form-editor/preview/location-helpers.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Creates the standard location field model with common properties
+ * @param {QuestionBaseModel} baseModel - The base model from super._renderInput()
+ * @param {LocationElements} htmlElements - The HTML elements containing values
+ * @param {string | null} highlight - The currently highlighted element
+ * @param {string} instructionText - The instruction text to display
+ * @param {string} titleText - The title text including optional suffix
+ * @returns {LocationFieldModel}
+ */
+export function createLocationFieldModel(baseModel: QuestionBaseModel, htmlElements: LocationElements, highlight: string | null, instructionText: string, titleText: string): LocationFieldModel;
+/**
+ * Creates field classes with highlight if needed
+ * @param {string} fieldName - The name of the field
+ * @param {string | null} highlight - The currently highlighted element
+ * @returns {{classes: string}}
+ */
+export function createFieldClasses(fieldName: string, highlight: string | null): {
+    classes: string;
+};
+import type { QuestionBaseModel } from '../../../form/form-editor/preview/types.js';
+import type { LocationElements } from '../../../form/form-editor/preview/types.js';
+import type { LocationFieldModel } from '../../../form/form-editor/preview/types.js';
+//# sourceMappingURL=location-helpers.d.ts.map

package/dist/types/form/form-editor/preview/location-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location-helpers.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/location-helpers.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,oDAPW,iBAAiB,gBACjB,gBAAgB,aAChB,MAAM,GAAG,IAAI,mBACb,MAAM,aACN,MAAM,GACJ,kBAAkB,CAuB9B;AAED;;;;;GAKG;AACH,8CAJW,MAAM,aACN,MAAM,GAAG,IAAI,GACX;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAM7B;uCAG2E,yCAAyC;sCAAzC,yCAAyC;wCAAzC,yCAAyC"}

package/dist/types/form/form-editor/preview/location-question-base.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Base class for location question component preview elements with instruction text support
+ * @implements {QuestionElements}
+ */
+export class LocationQuestionComponentPreviewElements extends QuestionComponentElements implements QuestionElements {
+    /**
+     * @param {any} component - Component with options.instructionText
+     */
+    constructor(component: any);
+    _instructionText: any;
+    /**
+     * @protected
+     * @returns {LocationSettings}
+     */
+    protected _getValues(): LocationSettings;
+}
+/**
+ * Base class for location questions with instruction text support
+ */
+export class LocationQuestion extends Question {
+    /**
+     * @param {LocationElements} htmlElements
+     * @param {QuestionRenderer} questionRenderer
+     */
+    constructor(htmlElements: LocationElements, questionRenderer: QuestionRenderer);
+    /**
+     * @type {string}
+     * @protected
+     */
+    protected _instructionText: string;
+    /**
+     * @param {string} val
+     */
+    set instructionText(val: string);
+    get instructionText(): string;
+}
+import type { QuestionElements } from '../../../form/form-editor/preview/types.js';
+import { QuestionComponentElements } from '../../../form/form-editor/preview/question.js';
+import type { LocationSettings } from '../../../form/form-editor/preview/types.js';
+import { Question } from '../../../form/form-editor/preview/question.js';
+import type { LocationElements } from '../../../form/form-editor/preview/types.js';
+import type { QuestionRenderer } from '../../../form/form-editor/preview/types.js';
+//# sourceMappingURL=location-question-base.d.ts.map

package/dist/types/form/form-editor/preview/location-question-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location-question-base.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/location-question-base.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IACE;;OAEG;IACH,uBAFW,GAAG,EAKb;IADC,sBAA+D;IAGjE;;;OAGG;IACH,wBAFa,gBAAgB,CAO5B;CACF;AAED;;GAEG;AACH;IAOE;;;OAGG;IACH,0BAHW,gBAAgB,oBAChB,gBAAgB,EAK1B;IAbD;;;OAGG;IACH,4BAHU,MAAM,CAGK;IAerB;;OAEG;IACH,yBAFW,MAAM,EAKhB;IAVD,uBAKW,MAAM,CAHhB;CASF;sCAG0F,yCAAyC;0CA5D7H,4CAA4C;sCA4DwC,yCAAyC;yBA5D7H,4CAA4C;sCA4DwC,yCAAyC;sCAAzC,yCAAyC"}

package/dist/types/form/form-editor/preview/national-grid.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @implements {QuestionElements}
+ */
+export class NationalGridComponentPreviewElements extends LocationQuestionComponentPreviewElements implements QuestionElements {
+}
+export class NationalGridQuestion extends LocationQuestion {
+    /**
+     * @protected
+     * @returns {NationalGridModel}
+     */
+    protected _renderInput(): NationalGridModel;
+}
+import type { QuestionElements } from '../../../form/form-editor/preview/types.js';
+import { LocationQuestionComponentPreviewElements } from '../../../form/form-editor/preview/location-question-base.js';
+import { LocationQuestion } from '../../../form/form-editor/preview/location-question-base.js';
+import type { NationalGridModel } from '../../../form/form-editor/macros/types.js';
+//# sourceMappingURL=national-grid.d.ts.map

package/dist/types/form/form-editor/preview/national-grid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"national-grid.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/national-grid.js"],"names":[],"mappings":"AASA;;GAEG;AACH;CAAqG;AAErG;IAYE;;;OAGG;IACH,0BAFa,iBAAiB,CAoB7B;CACF;sCAG0F,yCAAyC;yDA9C7H,0DAA0D;iCAA1D,0DAA0D;uCA+C3B,wCAAwC"}

package/dist/types/form/form-editor/preview/os-grid-ref.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @implements {QuestionElements}
+ */
+export class OsGridRefComponentPreviewElements extends LocationQuestionComponentPreviewElements implements QuestionElements {
+}
+export class OsGridRefQuestion extends LocationQuestion {
+    /**
+     * @protected
+     * @returns {OsGridRefModel}
+     */
+    protected _renderInput(): OsGridRefModel;
+}
+import type { QuestionElements } from '../../../form/form-editor/preview/types.js';
+import { LocationQuestionComponentPreviewElements } from '../../../form/form-editor/preview/location-question-base.js';
+import { LocationQuestion } from '../../../form/form-editor/preview/location-question-base.js';
+import type { OsGridRefModel } from '../../../form/form-editor/macros/types.js';
+//# sourceMappingURL=os-grid-ref.d.ts.map

package/dist/types/form/form-editor/preview/os-grid-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"os-grid-ref.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/os-grid-ref.js"],"names":[],"mappings":"AASA;;GAEG;AACH;CAAkG;AAElG;IAYE;;;OAGG;IACH,0BAFa,cAAc,CAoB1B;CACF;sCAG0F,yCAAyC;yDA9C7H,0DAA0D;iCAA1D,0DAA0D;oCA+C9B,wCAAwC"}

package/dist/types/form/form-editor/preview/types.d.ts

@@ -32,8 +32,8 @@ export interface GovukFieldset {
     legend: DefaultComponent;
 }
 export type ListenerRow = [
-    HTMLInputElement | null,
-    (target: HTMLInputElement, e: Event) => void,
+    HTMLInputElement | HTMLTextAreaElement | null,
+    (target: HTMLInputElement | HTMLTextAreaElement, e: Event) => void,
     keyof HTMLElementEventMap
 ];
 export interface DomElementsBase {
@@ -67,6 +67,25 @@ export interface UkAddressElements extends DomElementsBase {
 export interface NumberElements extends DomElementsBase {
     readonly values: NumberSettings;
 }
+export interface LocationSettings extends BaseSettings {
+    instructionText: string;
+}
+export interface LocationElements extends DomElementsBase {
+    readonly values: LocationSettings;
+}
+export interface LocationFieldModel extends QuestionBaseModel {
+    userClasses: string;
+    fieldset: {
+        legend: {
+            text: string;
+            classes: string;
+        };
+    };
+    instructionText: string;
+    details: {
+        classes: string;
+    };
+}
 export interface RenderBase {
     render(questionTemplate: string, renderContext: RenderContext): void;
 }

package/dist/types/form/form-editor/preview/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACvB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,gDAAgD,CAAA;AAC1F,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iDAAiD,CAAA;AAC3F,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iDAAiD,CAAA;AAC3F,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,+CAA+C,CAAA;AACvF,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,gDAAgD,CAAA;AACzF,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,4CAA4C,CAAA;AAC1E,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,kDAAkD,CAAA;AAC7F,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,mDAAmD,CAAA;AAC/F,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,gDAAgD,CAAA;AACzF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAClE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wCAAwC,CAAA;AAC/E,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,WAAW,EAAE,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,gBAAgB,CAAA;CACzB;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,gBAAgB,GAAG,IAAI;IACvB,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE,KAAK,KAAK,IAAI;IAC5C,MAAM,mBAAmB;CAC1B,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;CAC9B;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,mBAAmB,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAA;CACrC;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;CACrE;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAAG,iBAAiB,CAAA;AAErE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,MAAM,CAAA;CAC1E;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC7E;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,GAAG,IAAI,CAAA;CACvE;AAED,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,YAAY,CAAA;AAEtD,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,WAAW,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,WAAW,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,GACnB,QAAQ,GACR,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/preview/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACvB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,gDAAgD,CAAA;AAC1F,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iDAAiD,CAAA;AAC3F,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,iDAAiD,CAAA;AAC3F,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,+CAA+C,CAAA;AACvF,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,gDAAgD,CAAA;AACzF,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,4CAA4C,CAAA;AAC1E,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,kDAAkD,CAAA;AAC7F,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,mDAAmD,CAAA;AAC/F,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,gDAAgD,CAAA;AACzF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8CAA8C,CAAA;AACrF,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAClE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wCAAwC,CAAA;AAC/E,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,WAAW,EAAE,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACpC;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,gBAAgB,CAAA;CACzB;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,gBAAgB,GAAG,mBAAmB,GAAG,IAAI;IAC7C,CAAC,MAAM,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,CAAC,EAAE,KAAK,KAAK,IAAI;IAClE,MAAM,mBAAmB;CAC1B,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;CAC9B;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,mBAAmB,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAA;CACrC;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;CAChC;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;CAClC;AAED,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE;QACR,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAA;YACZ,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;KACF,CAAA;IACD,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;CACrE;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAAG,iBAAiB,CAAA;AAErE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,MAAM,CAAA;CAC1E;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC7E;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,GAAG,IAAI,CAAA;CACvE;AAED,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,YAAY,CAAA;AAEtD,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,WAAW,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,WAAW,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,GACnB,QAAQ,GACR,qBAAqB,GACrB,sBAAsB,GACtB,mBAAmB,GACnB,iBAAiB,GACjB,oBAAoB,CAAA"}

package/package.json

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

package/src/__stubs__/components.ts

@@ -5,15 +5,19 @@ import {
   type DatePartsFieldComponent,
   type DeclarationFieldComponent,
   type DetailsComponent,
+  type EastingNorthingFieldComponent,
   type EmailAddressFieldComponent,
   type FileUploadFieldComponent,
   type HtmlComponent,
   type InsetTextComponent,
+  type LatLongFieldComponent,
   type ListComponent,
   type MarkdownComponent,
   type MonthYearFieldComponent,
   type MultilineTextFieldComponent,
+  type NationalGridFieldNumberFieldComponent,
   type NumberFieldComponent,
+  type OsGridRefFieldComponent,
   type RadiosFieldComponent,
   type SelectFieldComponent,
   type TelephoneNumberFieldComponent,
@@ -369,3 +373,61 @@ export function buildRadiosComponent(
     type: ComponentType.RadiosField
   }
 }
+
+export function buildEastingNorthingFieldComponent(
+  partialComponent: Partial<EastingNorthingFieldComponent> = {}
+): EastingNorthingFieldComponent {
+  return {
+    id: '1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p',
+    name: 'EastingNorthingField',
+    title: 'Easting and northing',
+    hint: 'For example, Easting: 248741, Northing: 63688',
+    options: {},
+    schema: {},
+    ...partialComponent,
+    type: ComponentType.EastingNorthingField
+  }
+}
+
+export function buildLatLongFieldComponent(
+  partialComponent: Partial<LatLongFieldComponent> = {}
+): LatLongFieldComponent {
+  return {
+    id: '2b3c4d5e-6f7g-8h9i-0j1k-2l3m4n5o6p7q',
+    name: 'LatLongField',
+    title: 'Latitude and longitude',
+    hint: 'For example, Latitude: 51.5074, Longitude: -0.1278',
+    options: {},
+    schema: {},
+    ...partialComponent,
+    type: ComponentType.LatLongField
+  }
+}
+
+export function buildNationalGridFieldNumberFieldComponent(
+  partialComponent: Partial<NationalGridFieldNumberFieldComponent> = {}
+): NationalGridFieldNumberFieldComponent {
+  return {
+    id: '3c4d5e6f-7g8h-9i0j-1k2l-3m4n5o6p7q8r',
+    name: 'NationalGridFieldNumberField',
+    title: 'National Grid field number',
+    hint: 'A National Grid field number is made up of 2 letters and 8 numbers, for example, SO04188589',
+    options: {},
+    ...partialComponent,
+    type: ComponentType.NationalGridFieldNumberField
+  }
+}
+
+export function buildOsGridRefFieldComponent(
+  partialComponent: Partial<OsGridRefFieldComponent> = {}
+): OsGridRefFieldComponent {
+  return {
+    id: '4d5e6f7g-8h9i-0j1k-2l3m-4n5o6p7q8r9s',
+    name: 'OsGridRefField',
+    title: 'Ordnance Survey (OS) grid reference',
+    hint: 'An OS grid reference number is made up of 2 letters followed by 6 numbers, for example, TQ123456',
+    options: {},
+    ...partialComponent,
+    type: ComponentType.OsGridRefField
+  }
+}

package/src/components/component-types.ts

@@ -163,7 +163,7 @@ export const ComponentTypes: readonly ComponentDef[] = Object.freeze([
     name: 'OsGridRefField',
     title: 'Ordnance Survey (OS) grid reference',
     type: ComponentType.OsGridRefField,
-    hint: 'An OS grid reference number is made up of 2 letters followed by 10 numbers, for example, SO7394301364',
+    hint: 'An OS grid reference number is made up of 2 letters followed by 6 numbers, for example, TQ123456',
     options: {}
   },
   {
@@ -179,5 +179,13 @@ export const ComponentTypes: readonly ComponentDef[] = Object.freeze([
     type: ComponentType.LatLongField,
     hint: 'For Great Britain, the latitude will be a number between 49.850 and 60.859. The longitude will be a number between -13.687 and 1.767',
     options: {}
+  },
+  {
+    name: 'HiddenField',
+    title: 'Hidden field',
+    type: ComponentType.HiddenField,
+    hint: '',
+    options: {},
+    schema: {}
   }
 ])

package/src/components/enums.ts

@@ -22,5 +22,6 @@ export enum ComponentType {
   EastingNorthingField = 'EastingNorthingField',
   OsGridRefField = 'OsGridRefField',
   NationalGridFieldNumberField = 'NationalGridFieldNumberField',
-  LatLongField = 'LatLongField'
+  LatLongField = 'LatLongField',
+  HiddenField = 'HiddenField'
 }

package/src/components/types.ts

@@ -230,6 +230,13 @@ export interface LatLongFieldComponent extends FormFieldBase {
   }
 }
 
+export interface HiddenFieldComponent extends FormFieldBase {
+  type: ComponentType.HiddenField
+  options: FormFieldBase['options'] & {
+    condition?: string
+  }
+}
+
 // Date Fields
 export interface DatePartsFieldComponent extends DateFieldBase {
   type: ComponentType.DatePartsField
@@ -341,6 +348,7 @@ export type InputFieldsComponentsDef =
   | OsGridRefFieldComponent
   | NationalGridFieldNumberFieldComponent
   | LatLongFieldComponent
+  | HiddenFieldComponent
 
 // Components that render content
 export type ContentComponentsDef =

package/src/conditions/condition-operators.ts

@@ -85,7 +85,8 @@ export const customOperators = {
   [ComponentType.EastingNorthingField]: defaultOperators,
   [ComponentType.OsGridRefField]: defaultOperators,
   [ComponentType.NationalGridFieldNumberField]: defaultOperators,
-  [ComponentType.LatLongField]: defaultOperators
+  [ComponentType.LatLongField]: defaultOperators,
+  [ComponentType.HiddenField]: undefined
 }
 
 export function getOperatorNames(fieldType?: ConditionalComponentType) {

package/src/form/form-definition/helpers.ts

@@ -1,5 +1,8 @@
+import { ComponentType } from '~/src/components/enums.js'
+import { type ComponentDef } from '~/src/components/types.js'
 import { type ConditionListItemRefValueDataV2 } from '~/src/conditions/types.js'
 import { type FormDefinition } from '~/src/form/form-definition/types.js'
+import { hasComponents } from '~/src/pages/helpers.js'
 
 /**
  * TypeGuard to check if something is a FormDefinition
@@ -39,3 +42,23 @@ export function isConditionListItemRefValueData(
     'itemId' in conditionValueData
   )
 }
+
+/**
+ * Returns an array of all hidden fields in a form
+ * @param definition - form definition
+ */
+export function getHiddenFields(definition: FormDefinition) {
+  if (definition.pages.length === 0) {
+    return []
+  }
+  const totalHiddenFields = [] as ComponentDef[]
+  for (const page of definition.pages) {
+    const hiddenFields = hasComponents(page)
+      ? page.components.filter(
+          (comp) => comp.type === ComponentType.HiddenField
+        )
+      : []
+    totalHiddenFields.push(...hiddenFields)
+  }
+  return totalHiddenFields
+}

package/src/form/form-editor/__stubs__/preview.js

@@ -213,6 +213,29 @@ export class DeclarationPreviewElements extends QuestionPreviewElements {
   }
 }
 
+/**
+ * @implements {LocationElements}
+ */
+export class LocationPreviewElements extends QuestionPreviewElements {
+  /**
+   * @param {BaseSettings & {instructionText?: string}} elements
+   */
+  constructor({ instructionText, ...elements }) {
+    super(elements)
+    this._instructionText = instructionText ?? ''
+  }
+
+  /**
+   * @returns {LocationSettings}
+   */
+  get values() {
+    return {
+      ...super.values,
+      instructionText: this._instructionText
+    }
+  }
+}
+
 /**
  * @implements {PageOverviewElements}
  */
@@ -429,5 +452,5 @@ export class NumberPreviewElements {
 /**
  * @import { ListElement } from  '~/src/form/form-editor/types.js'
  * @import { PagePreviewPanelMacro } from '~/src/form/form-editor/macros/types.js'
- * @import { BaseSettings, ListElements, NumberSettings, RenderContext, QuestionBaseModel, QuestionRenderer, AutocompleteElements, PageOverviewElements, PageRenderer, UkAddressElements, UkAddressSettings, DeclarationElements, DeclarationSettings } from  '~/src/form/form-editor/preview/types.js'
+ * @import { BaseSettings, ListElements, NumberSettings, RenderContext, QuestionBaseModel, QuestionRenderer, AutocompleteElements, PageOverviewElements, PageRenderer, UkAddressElements, UkAddressSettings, DeclarationElements, DeclarationSettings, LocationElements, LocationSettings } from  '~/src/form/form-editor/preview/types.js'
  */

package/src/form/form-editor/index.ts

@@ -100,6 +100,7 @@ export const listSubSchema = Joi.string()
 export const locationSubSchema = Joi.string()
   .required()
   .valid(
+    ComponentType.UkAddressField,
     ComponentType.EastingNorthingField,
     ComponentType.OsGridRefField,
     ComponentType.NationalGridFieldNumberField,

package/src/form/form-editor/macros/types.ts

@@ -67,6 +67,60 @@ export interface DeclarationModel extends QuestionBaseModel {
   }
 }
 
+export interface EastingNorthingModel extends QuestionBaseModel {
+  fieldset?: {
+    legend: {
+      text: string
+      classes: string
+    }
+  }
+  easting?: {
+    classes?: string
+  }
+  northing?: {
+    classes?: string
+  }
+  instructionText?: string
+  details?: {
+    classes?: string
+  }
+}
+
+export interface OsGridRefModel extends QuestionBaseModel {
+  inputClasses?: string
+  instructionText?: string
+  details?: {
+    classes?: string
+  }
+}
+
+export interface NationalGridModel extends QuestionBaseModel {
+  inputClasses?: string
+  instructionText?: string
+  details?: {
+    classes?: string
+  }
+}
+
+export interface LatLongModel extends QuestionBaseModel {
+  fieldset?: {
+    legend: {
+      text: string
+      classes: string
+    }
+  }
+  latitude?: {
+    classes?: string
+  }
+  longitude?: {
+    classes?: string
+  }
+  instructionText?: string
+  details?: {
+    classes?: string
+  }
+}
+
 export interface AppPreviewPanelMacro extends AppPreviewPanelTabsMacro {
   model: QuestionBaseModel
 }

package/src/form/form-editor/preview/easting-northing.js

@@ -0,0 +1,55 @@
+import { ComponentType } from '~/src/components/enums.js'
+import {
+  createFieldClasses,
+  createLocationFieldModel
+} from '~/src/form/form-editor/preview/location-helpers.js'
+import {
+  LocationQuestion,
+  LocationQuestionComponentPreviewElements
+} from '~/src/form/form-editor/preview/location-question-base.js'
+import { PreviewComponent } from '~/src/form/form-editor/preview/preview.js'
+
+/**
+ * @implements {QuestionElements}
+ */
+export class EastingNorthingComponentPreviewElements extends LocationQuestionComponentPreviewElements {}
+
+export class EastingNorthingQuestion extends LocationQuestion {
+  /**
+   * @type {ComponentType}
+   */
+  componentType = ComponentType.EastingNorthingField
+  /**
+   * @type {string}
+   * @protected
+   */
+  _questionTemplate = PreviewComponent.PATH + 'eastingnorthingfield.njk'
+  _fieldName = 'EastingNorthingField'
+
+  /**
+   * @protected
+   * @returns {EastingNorthingModel}
+   */
+  _renderInput() {
+    const baseModel = super._renderInput()
+    const locationModel = createLocationFieldModel(
+      baseModel,
+      /** @type {LocationElements} */ (this._htmlElements),
+      this._highlight,
+      this._instructionText,
+      this.titleText
+    )
+
+    return {
+      ...locationModel,
+      easting: createFieldClasses('easting', this._highlight),
+      northing: createFieldClasses('northing', this._highlight)
+    }
+  }
+}
+
+/**
+ * @import { LocationSettings, LocationElements, QuestionElements, QuestionRenderer } from '~/src/form/form-editor/preview/types.js'
+ * @import { EastingNorthingModel } from '~/src/form/form-editor/macros/types.js'
+ * @import { EastingNorthingFieldComponent } from '~/src/components/types.js'
+ */

package/src/form/form-editor/preview/helpers.js

@@ -14,7 +14,16 @@ import {
   DeclarationComponentPreviewElements,
   DeclarationQuestion
 } from '~/src/form/form-editor/preview/declaration.js'
+import {
+  EastingNorthingComponentPreviewElements,
+  EastingNorthingQuestion
+} from '~/src/form/form-editor/preview/easting-northing.js'
 import { EmailAddressQuestion } from '~/src/form/form-editor/preview/email-address.js'
+import { HiddenQuestion } from '~/src/form/form-editor/preview/hidden.js'
+import {
+  LatLongComponentPreviewElements,
+  LatLongQuestion
+} from '~/src/form/form-editor/preview/lat-long.js'
 import {
   ListComponentElements,
   ListQuestion,
@@ -23,10 +32,18 @@ import {
 import { LongAnswerQuestion } from '~/src/form/form-editor/preview/long-answer.js'
 import { Markdown } from '~/src/form/form-editor/preview/markdown.js'
 import { MonthYearQuestion } from '~/src/form/form-editor/preview/month-year.js'
+import {
+  NationalGridComponentPreviewElements,
+  NationalGridQuestion
+} from '~/src/form/form-editor/preview/national-grid.js'
 import {
   NumberComponentPreviewElements,
   NumberOnlyQuestion
 } from '~/src/form/form-editor/preview/number-only.js'
+import {
+  OsGridRefComponentPreviewElements,
+  OsGridRefQuestion
+} from '~/src/form/form-editor/preview/os-grid-ref.js'
 import { PhoneNumberQuestion } from '~/src/form/form-editor/preview/phone-number.js'
 import { QuestionComponentElements } from '~/src/form/form-editor/preview/question.js'
 import { RadioQuestion } from '~/src/form/form-editor/preview/radio.js'
@@ -63,10 +80,11 @@ const InputFieldComponentDictionary = {
   [ComponentType.YesNoField]: YesNoQuestion,
   [ComponentType.DeclarationField]: DeclarationQuestion,
   [ComponentType.FileUploadField]: SupportingEvidenceQuestion,
-  [ComponentType.EastingNorthingField]: ShortAnswerQuestion,
-  [ComponentType.OsGridRefField]: ShortAnswerQuestion,
-  [ComponentType.NationalGridFieldNumberField]: ShortAnswerQuestion,
-  [ComponentType.LatLongField]: ShortAnswerQuestion
+  [ComponentType.EastingNorthingField]: EastingNorthingQuestion,
+  [ComponentType.OsGridRefField]: OsGridRefQuestion,
+  [ComponentType.NationalGridFieldNumberField]: NationalGridQuestion,
+  [ComponentType.LatLongField]: LatLongQuestion,
+  [ComponentType.HiddenField]: HiddenQuestion
 }
 
 /**
@@ -102,6 +120,25 @@ const ComponentToPreviewQuestion = {
   [ComponentType.YesNoField]: (component, _definition) => {
     const componentCoerced = /** @type {YesNoFieldComponent} */ (component)
     return new QuestionComponentElements(componentCoerced)
+  },
+  [ComponentType.EastingNorthingField]: (component, _definition) => {
+    const componentCoerced = /** @type {EastingNorthingFieldComponent} */ (
+      component
+    )
+    return new EastingNorthingComponentPreviewElements(componentCoerced)
+  },
+  [ComponentType.OsGridRefField]: (component, _definition) => {
+    const componentCoerced = /** @type {OsGridRefFieldComponent} */ (component)
+    return new OsGridRefComponentPreviewElements(componentCoerced)
+  },
+  [ComponentType.NationalGridFieldNumberField]: (component, _definition) => {
+    const componentCoerced =
+      /** @type {NationalGridFieldNumberFieldComponent} */ (component)
+    return new NationalGridComponentPreviewElements(componentCoerced)
+  },
+  [ComponentType.LatLongField]: (component, _definition) => {
+    const componentCoerced = /** @type {LatLongFieldComponent} */ (component)
+    return new LatLongComponentPreviewElements(componentCoerced)
   }
 }
 
@@ -150,5 +187,5 @@ export function mapComponentToPreviewQuestion(questionRenderer, definition) {
  * @import { Question } from '~/src/form/form-editor/preview/question.js'
  * @import { PreviewComponent } from '~/src/form/form-editor/preview/preview.js'
  * @import { FormDefinition } from '~/src/form/form-definition/types.js'
- * @import { AutocompleteFieldComponent, ComponentDef, DeclarationFieldComponent, NumberFieldComponent, SelectFieldComponent, UkAddressFieldComponent, YesNoFieldComponent } from '~/src/components/types.js'
+ * @import { AutocompleteFieldComponent, ComponentDef, DeclarationFieldComponent, EastingNorthingFieldComponent, LatLongFieldComponent, NationalGridFieldNumberFieldComponent, NumberFieldComponent, OsGridRefFieldComponent, SelectFieldComponent, UkAddressFieldComponent, YesNoFieldComponent } from '~/src/components/types.js'
  */

package/src/form/form-editor/preview/hidden.js

@@ -0,0 +1,9 @@
+import { ComponentType } from '~/src/components/enums.js'
+import { Question } from '~/src/form/form-editor/preview/question.js'
+
+export class HiddenQuestion extends Question {
+  /**
+   * @type {ComponentType}
+   */
+  componentType = ComponentType.HiddenField
+}

package/src/form/form-editor/preview/index.js

@@ -3,12 +3,16 @@ export * from '~/src/form/form-editor/preview/checkbox.js'
 export * from '~/src/form/form-editor/preview/checkbox-sortable.js'
 export * from '~/src/form/form-editor/preview/date-input.js'
 export * from '~/src/form/form-editor/preview/declaration.js'
+export * from '~/src/form/form-editor/preview/easting-northing.js'
 export * from '~/src/form/form-editor/preview/email-address.js'
+export * from '~/src/form/form-editor/preview/lat-long.js'
 export * from '~/src/form/form-editor/preview/list.js'
 export * from '~/src/form/form-editor/preview/list-sortable.js'
 export * from '~/src/form/form-editor/preview/markdown.js'
 export * from '~/src/form/form-editor/preview/month-year.js'
+export * from '~/src/form/form-editor/preview/national-grid.js'
 export * from '~/src/form/form-editor/preview/number-only.js'
+export * from '~/src/form/form-editor/preview/os-grid-ref.js'
 export * from '~/src/form/form-editor/preview/phone-number.js'
 export * from '~/src/form/form-editor/preview/question.js'
 export * from '~/src/form/form-editor/preview/radio.js'
@@ -21,6 +25,7 @@ export * from '~/src/form/form-editor/preview/supporting-evidence.js'
 export * from '~/src/form/form-editor/preview/long-answer.js'
 export * from '~/src/form/form-editor/preview/uk-address.js'
 export * from '~/src/form/form-editor/preview/yes-no.js'
+export * from '~/src/form/form-editor/preview/hidden.js'
 export * from '~/src/form/form-editor/preview/controller/page-controller-base.js'
 export * from '~/src/form/form-editor/preview/controller/page-controller.js'
 export * from '~/src/form/form-editor/preview/controller/guidance-page-controller.js'