@defra/forms-model 3.0.506 → 3.0.507

package/dist/module/form/form-editor/macros/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/form/form-editor/macros/types.ts"],"sourcesContent":["import { type ComponentType } from '~/src/components/enums.js'\nimport {\n  type DateItem,\n  type GovukField,\n  type ListItemReadonly\n} from '~/src/form/form-editor/types.js'\nimport { type DefaultComponent, type GovukFieldset } from '~/src/index.js'\n\nexport interface AppPreviewErrorPanelMacroErrorTemplate {\n  advancedSettingsErrors: []\n  baseErrors: { template: unknown; type: string }[]\n}\n\nexport interface AppPreviewErrorPanelMacro {\n  errorTemplates: AppPreviewErrorPanelMacroErrorTemplate\n  fieldDetails: {\n    extraFields: GovukField[]\n    basePageFields: GovukField[]\n  }\n  questionType: ComponentType\n}\n\nexport interface AppPreviewPanelTabsMacro {\n  questionType: ComponentType\n  previewPageUrl: string\n  previewErrorsUrl: string\n  errorTemplates: AppPreviewErrorPanelMacroErrorTemplate\n  extraFields: GovukField[]\n  basePageFields: GovukField[]\n}\n\nexport interface SelectAfterInput {\n  afterInput: { html: string }\n}\nexport interface RadioAndCheckboxAfterInputs {\n  afterInputs: { html: string }\n}\n\n// GDS components - Select uses afterInput, while Radio uses afterInputs\nexport type FormGroupAfterInput = SelectAfterInput | RadioAndCheckboxAfterInputs\n\nexport interface QuestionBaseModel {\n  id?: string\n  name?: string\n  content?: string\n  attributes?: Record<string, string>\n  label?: DefaultComponent\n  hint?: DefaultComponent\n  fieldset?: GovukFieldset\n  readonly items?: ListItemReadonly[] | DateItem[]\n  text?: string\n  formGroup?: FormGroupAfterInput\n  type?: 'text' | 'number' | 'boolean'\n  classes?: string\n}\n\nexport interface AppPreviewPanelMacro extends AppPreviewPanelTabsMacro {\n  model: QuestionBaseModel\n}\n\nexport interface PagePreviewComponent {\n  model: QuestionBaseModel\n  questionType: ComponentType\n}\n\nexport interface PagePreviewPanelMacro {\n  readonly pageTitle: {\n    text: string\n    classes: string\n  }\n  readonly guidance: {\n    text: string\n    classes: string\n  }\n  readonly components: PagePreviewComponent[]\n  readonly sectionTitle?: {\n    text: string\n    classes: string\n  }\n  readonly repeaterButton?: {\n    text: string\n    classes: string\n  }\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/form/form-editor/macros/types.ts"],"sourcesContent":["import { type ComponentType } from '~/src/components/enums.js'\nimport {\n  type DateItem,\n  type GovukField,\n  type ListItemReadonly\n} from '~/src/form/form-editor/types.js'\nimport { type DefaultComponent, type GovukFieldset } from '~/src/index.js'\n\nexport interface AppPreviewErrorPanelMacroErrorTemplate {\n  advancedSettingsErrors: []\n  baseErrors: { template: unknown; type: string }[]\n}\n\nexport interface AppPreviewErrorPanelMacro {\n  errorTemplates: AppPreviewErrorPanelMacroErrorTemplate\n  fieldDetails: {\n    extraFields: GovukField[]\n    basePageFields: GovukField[]\n  }\n  questionType: ComponentType\n}\n\nexport interface AppPreviewPanelTabsMacro {\n  questionType: ComponentType\n  previewPageUrl: string\n  previewErrorsUrl: string\n  errorTemplates: AppPreviewErrorPanelMacroErrorTemplate\n  extraFields: GovukField[]\n  basePageFields: GovukField[]\n}\n\nexport interface SelectAfterInput {\n  afterInput: { html: string }\n}\nexport interface RadioAndCheckboxAfterInputs {\n  afterInputs: { html: string }\n}\n\n// GDS components - Select uses afterInput, while Radio uses afterInputs\nexport type FormGroupAfterInput = SelectAfterInput | RadioAndCheckboxAfterInputs\n\nexport interface QuestionBaseModel {\n  id?: string\n  name?: string\n  content?: string\n  attributes?: Record<string, string>\n  label?: DefaultComponent\n  hint?: DefaultComponent\n  fieldset?: GovukFieldset\n  readonly items?: ListItemReadonly[] | DateItem[]\n  text?: string\n  formGroup?: FormGroupAfterInput\n  type?: 'text' | 'number' | 'boolean'\n  classes?: string\n}\n\nexport interface AppPreviewPanelMacro extends AppPreviewPanelTabsMacro {\n  model: QuestionBaseModel\n}\n\nexport interface PagePreviewComponent {\n  model: QuestionBaseModel\n  questionType: ComponentType\n}\n\nexport interface PagePreviewPanelMacro {\n  readonly pageTitle: {\n    text: string\n    classes: string\n  }\n  readonly guidance: {\n    text: string\n    classes: string\n  }\n  readonly components: PagePreviewComponent[]\n  readonly sectionTitle?: {\n    text: string\n    classes: string\n  }\n  readonly repeaterButton?: {\n    text: string\n    classes: string\n  }\n}\n\nexport interface SummaryRowActionItem {\n  href: string\n  text: string\n  visuallyHiddenText: string\n}\n\nexport interface SummaryRow {\n  key: { text: string }\n  value: { text: string }\n  actions: {\n    items: SummaryRowActionItem[]\n  }\n}\n"],"mappings":"","ignoreList":[]}

package/dist/module/form/form-editor/preview/controller/summary-page-controller.js

@@ -0,0 +1,151 @@
+import { hasFormField } from "../../../../components/helpers.js";
+import { HIGHLIGHT_CLASS } from "../constants.js";
+import { PreviewPageControllerBase } from "./page-controller-base.js";
+import { hasComponents } from "../../../../pages/helpers.js";
+const EXAMPLE_TEXT = 'Answer goes here';
+export class SummaryPageController extends PreviewPageControllerBase {
+  /**
+   * @type {string}
+   * @protected
+   */
+  _pageTemplate = PreviewPageControllerBase.PATH + 'summary-controller.njk';
+  /**
+   * @type {Markdown}
+   * @protected
+   */
+  _guidanceComponent = PreviewPageControllerBase.createGuidanceComponent(false);
+  /**
+   * @type {FormComponentsDef[]}
+   * @private
+   */
+  _componentDefs = [];
+  /**
+   * @type {boolean}
+   * @private
+   */
+  _makeDeclaration = false;
+  /**
+   * @param {SummaryPageElements} elements
+   * @param {FormDefinition} formDefinition
+   * @param {PageRenderer} renderer
+   */
+  constructor(elements, formDefinition, renderer) {
+    super(elements, renderer);
+    this._componentDefs = formDefinition.pages.flatMap(page => {
+      if (hasComponents(page)) {
+        return page.components.filter(hasFormField);
+      }
+      return [];
+    });
+    this._makeDeclaration = elements.declaration;
+    this._guidanceComponent.content = elements.guidance;
+  }
+
+  /**
+   * @returns {{ rows: SummaryRow[] }}
+   */
+  get componentRows() {
+    const rows = this._componentDefs.map(component => {
+      const summaryRowHeading = component.shortDescription ?? '';
+      return {
+        key: {
+          text: summaryRowHeading
+        },
+        value: {
+          text: EXAMPLE_TEXT
+        },
+        actions: {
+          items: [{
+            href: '#',
+            text: 'Change',
+            visuallyHiddenText: summaryRowHeading
+          }]
+        }
+      };
+    });
+    return {
+      rows
+    };
+  }
+
+  /**
+   * @returns {{ text: string; classes: string }}
+   */
+  get pageTitle() {
+    return {
+      text: 'Check your answers before sending your form',
+      classes: ''
+    };
+  }
+  get guidance() {
+    if (!this._makeDeclaration) {
+      return {
+        classes: '',
+        text: ''
+      };
+    }
+    const guidanceHighlighted = this._highlighted === 'guidance';
+    const classes = guidanceHighlighted ? HIGHLIGHT_CLASS : '';
+    let text = this._guidanceText.length ? this._guidanceText : '';
+    if (!text.length && guidanceHighlighted) {
+      text = 'Declaration text';
+    }
+    return {
+      text,
+      classes
+    };
+  }
+
+  /**
+   * @param {string} declarationText
+   */
+  set declarationText(declarationText) {
+    this.guidanceText = declarationText;
+  }
+  get declarationText() {
+    return this.guidanceText;
+  }
+  get declaration() {
+    return this.guidance;
+  }
+  setMakeDeclaration() {
+    this._makeDeclaration = true;
+    this.render();
+  }
+  unsetMakeDeclaration() {
+    this._makeDeclaration = false;
+    this.render();
+  }
+  get makeDeclaration() {
+    return this._makeDeclaration;
+  }
+  highlightDeclaration() {
+    this.highlightGuidance();
+  }
+  unhighlightDeclaration() {
+    this.clearHighlight();
+  }
+
+  /**
+   * @returns {Markdown[]}
+   * @protected
+   */
+  _getGuidanceComponents() {
+    if (!this._makeDeclaration) {
+      return [];
+    }
+    return super._getGuidanceComponents();
+  }
+  get buttonText() {
+    return this.makeDeclaration ? 'Accept and send' : 'Send';
+  }
+}
+
+/**
+ * @import { ComponentDef, ContentComponentsDef, ListComponent, FormComponentsDef } from '~/src/components/types.js'
+ * @import { FormDefinition } from '~/src/form/form-definition/types.js'
+ * @import { PageRenderer, PagePreviewBaseElements, SummaryPageElements } from '~/src/form/form-editor/preview/types.js'
+ * @import { SummaryRowActionItem, SummaryRow } from '~/src/form/form-editor/macros/types.js'
+ * @import { Markdown } from '~/src/form/form-editor/preview/markdown.js'
+ */
+//# sourceMappingURL=summary-page-controller.js.map

package/dist/module/form/form-editor/preview/controller/summary-page-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary-page-controller.js","names":["hasFormField","HIGHLIGHT_CLASS","PreviewPageControllerBase","hasComponents","EXAMPLE_TEXT","SummaryPageController","_pageTemplate","PATH","_guidanceComponent","createGuidanceComponent","_componentDefs","_makeDeclaration","constructor","elements","formDefinition","renderer","pages","flatMap","page","components","filter","declaration","content","guidance","componentRows","rows","map","component","summaryRowHeading","shortDescription","key","text","value","actions","items","href","visuallyHiddenText","pageTitle","classes","guidanceHighlighted","_highlighted","_guidanceText","length","declarationText","guidanceText","setMakeDeclaration","render","unsetMakeDeclaration","makeDeclaration","highlightDeclaration","highlightGuidance","unhighlightDeclaration","clearHighlight","_getGuidanceComponents","buttonText"],"sources":["../../../../../../src/form/form-editor/preview/controller/summary-page-controller.js"],"sourcesContent":["import { hasFormField } from '~/src/components/helpers.js'\nimport { HIGHLIGHT_CLASS } from '~/src/form/form-editor/preview/constants.js'\nimport { PreviewPageControllerBase } from '~/src/form/form-editor/preview/controller/page-controller-base.js'\nimport { hasComponents } from '~/src/pages/helpers.js'\n\nconst EXAMPLE_TEXT = 'Answer goes here'\n\nexport class SummaryPageController extends PreviewPageControllerBase {\n  /**\n   * @type {string}\n   * @protected\n   */\n  _pageTemplate = PreviewPageControllerBase.PATH + 'summary-controller.njk'\n  /**\n   * @type {Markdown}\n   * @protected\n   */\n  _guidanceComponent = PreviewPageControllerBase.createGuidanceComponent(false)\n  /**\n   * @type {FormComponentsDef[]}\n   * @private\n   */\n  _componentDefs = []\n  /**\n   * @type {boolean}\n   * @private\n   */\n  _makeDeclaration = false\n  /**\n   * @param {SummaryPageElements} elements\n   * @param {FormDefinition} formDefinition\n   * @param {PageRenderer} renderer\n   */\n  constructor(elements, formDefinition, renderer) {\n    super(elements, renderer)\n    this._componentDefs = formDefinition.pages.flatMap((page) => {\n      if (hasComponents(page)) {\n        return page.components.filter(hasFormField)\n      }\n      return []\n    })\n    this._makeDeclaration = elements.declaration\n\n    this._guidanceComponent.content = elements.guidance\n  }\n\n  /**\n   * @returns {{ rows: SummaryRow[] }}\n   */\n  get componentRows() {\n    const rows = this._componentDefs.map((component) => {\n      const summaryRowHeading = component.shortDescription ?? ''\n      return {\n        key: { text: summaryRowHeading },\n        value: { text: EXAMPLE_TEXT },\n        actions: {\n          items: [\n            { href: '#', text: 'Change', visuallyHiddenText: summaryRowHeading }\n          ]\n        }\n      }\n    })\n    return {\n      rows\n    }\n  }\n\n  /**\n   * @returns {{ text: string; classes: string }}\n   */\n  get pageTitle() {\n    return {\n      text: 'Check your answers before sending your form',\n      classes: ''\n    }\n  }\n\n  get guidance() {\n    if (!this._makeDeclaration) {\n      return {\n        classes: '',\n        text: ''\n      }\n    }\n    const guidanceHighlighted = this._highlighted === 'guidance'\n    const classes = guidanceHighlighted ? HIGHLIGHT_CLASS : ''\n    let text = this._guidanceText.length ? this._guidanceText : ''\n\n    if (!text.length && guidanceHighlighted) {\n      text = 'Declaration text'\n    }\n    return {\n      text,\n      classes\n    }\n  }\n\n  /**\n   * @param {string} declarationText\n   */\n  set declarationText(declarationText) {\n    this.guidanceText = declarationText\n  }\n\n  get declarationText() {\n    return this.guidanceText\n  }\n\n  get declaration() {\n    return this.guidance\n  }\n\n  setMakeDeclaration() {\n    this._makeDeclaration = true\n    this.render()\n  }\n\n  unsetMakeDeclaration() {\n    this._makeDeclaration = false\n    this.render()\n  }\n\n  get makeDeclaration() {\n    return this._makeDeclaration\n  }\n\n  highlightDeclaration() {\n    this.highlightGuidance()\n  }\n\n  unhighlightDeclaration() {\n    this.clearHighlight()\n  }\n\n  /**\n   * @returns {Markdown[]}\n   * @protected\n   */\n  _getGuidanceComponents() {\n    if (!this._makeDeclaration) {\n      return []\n    }\n    return super._getGuidanceComponents()\n  }\n\n  get buttonText() {\n    return this.makeDeclaration ? 'Accept and send' : 'Send'\n  }\n}\n\n/**\n * @import { ComponentDef, ContentComponentsDef, ListComponent, FormComponentsDef } from '~/src/components/types.js'\n * @import { FormDefinition } from '~/src/form/form-definition/types.js'\n * @import { PageRenderer, PagePreviewBaseElements, SummaryPageElements } from '~/src/form/form-editor/preview/types.js'\n * @import { SummaryRowActionItem, SummaryRow } from '~/src/form/form-editor/macros/types.js'\n * @import { Markdown } from '~/src/form/form-editor/preview/markdown.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY;AACrB,SAASC,eAAe;AACxB,SAASC,yBAAyB;AAClC,SAASC,aAAa;AAEtB,MAAMC,YAAY,GAAG,kBAAkB;AAEvC,OAAO,MAAMC,qBAAqB,SAASH,yBAAyB,CAAC;EACnE;AACF;AACA;AACA;EACEI,aAAa,GAAGJ,yBAAyB,CAACK,IAAI,GAAG,wBAAwB;EACzE;AACF;AACA;AACA;EACEC,kBAAkB,GAAGN,yBAAyB,CAACO,uBAAuB,CAAC,KAAK,CAAC;EAC7E;AACF;AACA;AACA;EACEC,cAAc,GAAG,EAAE;EACnB;AACF;AACA;AACA;EACEC,gBAAgB,GAAG,KAAK;EACxB;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,QAAQ,EAAEC,cAAc,EAAEC,QAAQ,EAAE;IAC9C,KAAK,CAACF,QAAQ,EAAEE,QAAQ,CAAC;IACzB,IAAI,CAACL,cAAc,GAAGI,cAAc,CAACE,KAAK,CAACC,OAAO,CAAEC,IAAI,IAAK;MAC3D,IAAIf,aAAa,CAACe,IAAI,CAAC,EAAE;QACvB,OAAOA,IAAI,CAACC,UAAU,CAACC,MAAM,CAACpB,YAAY,CAAC;MAC7C;MACA,OAAO,EAAE;IACX,CAAC,CAAC;IACF,IAAI,CAACW,gBAAgB,GAAGE,QAAQ,CAACQ,WAAW;IAE5C,IAAI,CAACb,kBAAkB,CAACc,OAAO,GAAGT,QAAQ,CAACU,QAAQ;EACrD;;EAEA;AACF;AACA;EACE,IAAIC,aAAaA,CAAA,EAAG;IAClB,MAAMC,IAAI,GAAG,IAAI,CAACf,cAAc,CAACgB,GAAG,CAAEC,SAAS,IAAK;MAClD,MAAMC,iBAAiB,GAAGD,SAAS,CAACE,gBAAgB,IAAI,EAAE;MAC1D,OAAO;QACLC,GAAG,EAAE;UAAEC,IAAI,EAAEH;QAAkB,CAAC;QAChCI,KAAK,EAAE;UAAED,IAAI,EAAE3B;QAAa,CAAC;QAC7B6B,OAAO,EAAE;UACPC,KAAK,EAAE,CACL;YAAEC,IAAI,EAAE,GAAG;YAAEJ,IAAI,EAAE,QAAQ;YAAEK,kBAAkB,EAAER;UAAkB,CAAC;QAExE;MACF,CAAC;IACH,CAAC,CAAC;IACF,OAAO;MACLH;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE,IAAIY,SAASA,CAAA,EAAG;IACd,OAAO;MACLN,IAAI,EAAE,6CAA6C;MACnDO,OAAO,EAAE;IACX,CAAC;EACH;EAEA,IAAIf,QAAQA,CAAA,EAAG;IACb,IAAI,CAAC,IAAI,CAACZ,gBAAgB,EAAE;MAC1B,OAAO;QACL2B,OAAO,EAAE,EAAE;QACXP,IAAI,EAAE;MACR,CAAC;IACH;IACA,MAAMQ,mBAAmB,GAAG,IAAI,CAACC,YAAY,KAAK,UAAU;IAC5D,MAAMF,OAAO,GAAGC,mBAAmB,GAAGtC,eAAe,GAAG,EAAE;IAC1D,IAAI8B,IAAI,GAAG,IAAI,CAACU,aAAa,CAACC,MAAM,GAAG,IAAI,CAACD,aAAa,GAAG,EAAE;IAE9D,IAAI,CAACV,IAAI,CAACW,MAAM,IAAIH,mBAAmB,EAAE;MACvCR,IAAI,GAAG,kBAAkB;IAC3B;IACA,OAAO;MACLA,IAAI;MACJO;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACE,IAAIK,eAAeA,CAACA,eAAe,EAAE;IACnC,IAAI,CAACC,YAAY,GAAGD,eAAe;EACrC;EAEA,IAAIA,eAAeA,CAAA,EAAG;IACpB,OAAO,IAAI,CAACC,YAAY;EAC1B;EAEA,IAAIvB,WAAWA,CAAA,EAAG;IAChB,OAAO,IAAI,CAACE,QAAQ;EACtB;EAEAsB,kBAAkBA,CAAA,EAAG;IACnB,IAAI,CAAClC,gBAAgB,GAAG,IAAI;IAC5B,IAAI,CAACmC,MAAM,CAAC,CAAC;EACf;EAEAC,oBAAoBA,CAAA,EAAG;IACrB,IAAI,CAACpC,gBAAgB,GAAG,KAAK;IAC7B,IAAI,CAACmC,MAAM,CAAC,CAAC;EACf;EAEA,IAAIE,eAAeA,CAAA,EAAG;IACpB,OAAO,IAAI,CAACrC,gBAAgB;EAC9B;EAEAsC,oBAAoBA,CAAA,EAAG;IACrB,IAAI,CAACC,iBAAiB,CAAC,CAAC;EAC1B;EAEAC,sBAAsBA,CAAA,EAAG;IACvB,IAAI,CAACC,cAAc,CAAC,CAAC;EACvB;;EAEA;AACF;AACA;AACA;EACEC,sBAAsBA,CAAA,EAAG;IACvB,IAAI,CAAC,IAAI,CAAC1C,gBAAgB,EAAE;MAC1B,OAAO,EAAE;IACX;IACA,OAAO,KAAK,CAAC0C,sBAAsB,CAAC,CAAC;EACvC;EAEA,IAAIC,UAAUA,CAAA,EAAG;IACf,OAAO,IAAI,CAACN,eAAe,GAAG,iBAAiB,GAAG,MAAM;EAC1D;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/module/form/form-editor/preview/index.js

@@ -22,5 +22,6 @@ export * from "./uk-address.js";
 export * from "./yes-no.js";
 export * from "./controller/page-controller.js";
 export * from "./controller/guidance-page-controller.js";
+export * from "./controller/summary-page-controller.js";
 export * from "./controller/page-controller-base.js";
 //# sourceMappingURL=index.js.map

package/dist/module/form/form-editor/preview/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../../../src/form/form-editor/preview/index.js"],"sourcesContent":["export * from '~/src/form/form-editor/preview/autocomplete.js'\nexport * from '~/src/form/form-editor/preview/checkbox.js'\nexport * from '~/src/form/form-editor/preview/checkbox-sortable.js'\nexport * from '~/src/form/form-editor/preview/date-input.js'\nexport * from '~/src/form/form-editor/preview/email-address.js'\nexport * from '~/src/form/form-editor/preview/list.js'\nexport * from '~/src/form/form-editor/preview/list-sortable.js'\nexport * from '~/src/form/form-editor/preview/markdown.js'\nexport * from '~/src/form/form-editor/preview/month-year.js'\nexport * from '~/src/form/form-editor/preview/number-only.js'\nexport * from '~/src/form/form-editor/preview/phone-number.js'\nexport * from '~/src/form/form-editor/preview/question.js'\nexport * from '~/src/form/form-editor/preview/radio.js'\nexport * from '~/src/form/form-editor/preview/radio-sortable.js'\nexport * from '~/src/form/form-editor/preview/select-sortable.js'\nexport * from '~/src/form/form-editor/preview/short-answer.js'\nexport * from '~/src/form/form-editor/preview/select.js'\nexport * from '~/src/form/form-editor/preview/select-sortable.js'\nexport * from '~/src/form/form-editor/preview/supporting-evidence.js'\nexport * from '~/src/form/form-editor/preview/long-answer.js'\nexport * from '~/src/form/form-editor/preview/uk-address.js'\nexport * from '~/src/form/form-editor/preview/yes-no.js'\nexport * from '~/src/form/form-editor/preview/controller/page-controller.js'\nexport * from '~/src/form/form-editor/preview/controller/guidance-page-controller.js'\nexport * from '~/src/form/form-editor/preview/controller/page-controller-base.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../../../../src/form/form-editor/preview/index.js"],"sourcesContent":["export * from '~/src/form/form-editor/preview/autocomplete.js'\nexport * from '~/src/form/form-editor/preview/checkbox.js'\nexport * from '~/src/form/form-editor/preview/checkbox-sortable.js'\nexport * from '~/src/form/form-editor/preview/date-input.js'\nexport * from '~/src/form/form-editor/preview/email-address.js'\nexport * from '~/src/form/form-editor/preview/list.js'\nexport * from '~/src/form/form-editor/preview/list-sortable.js'\nexport * from '~/src/form/form-editor/preview/markdown.js'\nexport * from '~/src/form/form-editor/preview/month-year.js'\nexport * from '~/src/form/form-editor/preview/number-only.js'\nexport * from '~/src/form/form-editor/preview/phone-number.js'\nexport * from '~/src/form/form-editor/preview/question.js'\nexport * from '~/src/form/form-editor/preview/radio.js'\nexport * from '~/src/form/form-editor/preview/radio-sortable.js'\nexport * from '~/src/form/form-editor/preview/select-sortable.js'\nexport * from '~/src/form/form-editor/preview/short-answer.js'\nexport * from '~/src/form/form-editor/preview/select.js'\nexport * from '~/src/form/form-editor/preview/select-sortable.js'\nexport * from '~/src/form/form-editor/preview/supporting-evidence.js'\nexport * from '~/src/form/form-editor/preview/long-answer.js'\nexport * from '~/src/form/form-editor/preview/uk-address.js'\nexport * from '~/src/form/form-editor/preview/yes-no.js'\nexport * from '~/src/form/form-editor/preview/controller/page-controller.js'\nexport * from '~/src/form/form-editor/preview/controller/guidance-page-controller.js'\nexport * from '~/src/form/form-editor/preview/controller/summary-page-controller.js'\nexport * from '~/src/form/form-editor/preview/controller/page-controller-base.js'\n"],"mappings":"AAAA;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","ignoreList":[]}

package/dist/module/form/form-editor/preview/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/form/form-editor/preview/types.ts"],"sourcesContent":["import {\n  type PagePreviewPanelMacro,\n  type QuestionBaseModel\n} from '~/src/form/form-editor/macros/types.js'\nimport { type AutocompleteQuestion } from '~/src/form/form-editor/preview/autocomplete.js'\nimport { type DateInputQuestion } from '~/src/form/form-editor/preview/date-input.js'\nimport { type EmailAddressQuestion } from '~/src/form/form-editor/preview/email-address.js'\nimport { type ListSortableQuestion } from '~/src/form/form-editor/preview/list-sortable.js'\nimport { type LongAnswerQuestion } from '~/src/form/form-editor/preview/long-answer.js'\nimport { type PhoneNumberQuestion } from '~/src/form/form-editor/preview/phone-number.js'\nimport { type Question } from '~/src/form/form-editor/preview/question.js'\nimport { type RadioSortableQuestion } from '~/src/form/form-editor/preview/radio-sortable.js'\nimport { type SelectSortableQuestion } from '~/src/form/form-editor/preview/select-sortable.js'\nimport { type ShortAnswerQuestion } from '~/src/form/form-editor/preview/short-answer.js'\nimport { type UkAddressQuestion } from '~/src/form/form-editor/preview/uk-address.js'\nimport { type ListElement } from '~/src/form/form-editor/types.js'\nexport { type QuestionBaseModel } from '~/src/form/form-editor/macros/types.js'\nexport interface BaseSettings {\n  question: string\n  hintText: string\n  optional: boolean\n  shortDesc: string\n  items: ListElement[]\n  content: string\n  attributes?: Record<string, string>\n}\n\nexport interface DefaultComponent {\n  id?: string\n  text: string\n  classes: string\n}\n\nexport interface GovukFieldset {\n  legend: DefaultComponent\n}\n\nexport type ListenerRow = [\n  HTMLInputElement | null,\n  (target: HTMLInputElement, e: Event) => void,\n  keyof HTMLElementEventMap\n]\n\nexport interface DomElementsBase {\n  readonly values?: BaseSettings\n  autocompleteOptions?: string\n  setPreviewHTML(value: string): void\n  setPreviewDOM(element: HTMLElement): void\n}\n\nexport interface QuestionElements extends DomElementsBase {\n  readonly values: BaseSettings\n}\n\nexport interface AutocompleteElements extends QuestionElements {\n  autocompleteOptions: string\n}\n\nexport interface RenderBase {\n  render(questionTemplate: string, renderContext: RenderContext): void\n}\n\nexport interface QuestionRenderContext {\n  model: QuestionBaseModel\n}\n\nexport interface PageRenderContext {\n  params: PagePreviewPanelMacro\n}\n\nexport type RenderContext = QuestionRenderContext | PageRenderContext\n\nexport interface HTMLBuilder {\n  buildHTML(questionTemplate: string, renderContext: RenderContext): string\n}\n\nexport interface QuestionRenderer {\n  render(questionTemplate: string, questionBaseModel: QuestionBaseModel): void\n}\n\nexport interface PageRenderer {\n  render(pageTemplate: string, pagePreview: PagePreviewPanelMacro): void\n}\n\nexport type Renderer = QuestionRenderer | PageRenderer\n\nexport interface ListElements extends QuestionElements {\n  afterInputsHTML: string\n}\n\nexport interface PagePreviewBaseElements {\n  heading: string\n  guidance: string\n}\n\nexport interface PageOverviewElements extends PagePreviewBaseElements {\n  addHeading: boolean\n  repeatQuestion: string | undefined\n  hasRepeater: boolean\n}\n\nexport type PreviewQuestion =\n  | DateInputQuestion\n  | EmailAddressQuestion\n  | ListSortableQuestion\n  | LongAnswerQuestion\n  | PhoneNumberQuestion\n  | Question\n  | RadioSortableQuestion\n  | SelectSortableQuestion\n  | ShortAnswerQuestion\n  | UkAddressQuestion\n  | AutocompleteQuestion\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../../src/form/form-editor/preview/types.ts"],"sourcesContent":["import {\n  type PagePreviewPanelMacro,\n  type QuestionBaseModel\n} from '~/src/form/form-editor/macros/types.js'\nimport { type AutocompleteQuestion } from '~/src/form/form-editor/preview/autocomplete.js'\nimport { type DateInputQuestion } from '~/src/form/form-editor/preview/date-input.js'\nimport { type EmailAddressQuestion } from '~/src/form/form-editor/preview/email-address.js'\nimport { type ListSortableQuestion } from '~/src/form/form-editor/preview/list-sortable.js'\nimport { type LongAnswerQuestion } from '~/src/form/form-editor/preview/long-answer.js'\nimport { type PhoneNumberQuestion } from '~/src/form/form-editor/preview/phone-number.js'\nimport { type Question } from '~/src/form/form-editor/preview/question.js'\nimport { type RadioSortableQuestion } from '~/src/form/form-editor/preview/radio-sortable.js'\nimport { type SelectSortableQuestion } from '~/src/form/form-editor/preview/select-sortable.js'\nimport { type ShortAnswerQuestion } from '~/src/form/form-editor/preview/short-answer.js'\nimport { type UkAddressQuestion } from '~/src/form/form-editor/preview/uk-address.js'\nimport { type ListElement } from '~/src/form/form-editor/types.js'\nexport { type QuestionBaseModel } from '~/src/form/form-editor/macros/types.js'\nexport interface BaseSettings {\n  question: string\n  hintText: string\n  optional: boolean\n  shortDesc: string\n  items: ListElement[]\n  content: string\n  attributes?: Record<string, string>\n}\n\nexport interface DefaultComponent {\n  id?: string\n  text: string\n  classes: string\n}\n\nexport interface GovukFieldset {\n  legend: DefaultComponent\n}\n\nexport type ListenerRow = [\n  HTMLInputElement | null,\n  (target: HTMLInputElement, e: Event) => void,\n  keyof HTMLElementEventMap\n]\n\nexport interface DomElementsBase {\n  readonly values?: BaseSettings\n  autocompleteOptions?: string\n  setPreviewHTML(value: string): void\n  setPreviewDOM(element: HTMLElement): void\n}\n\nexport interface QuestionElements extends DomElementsBase {\n  readonly values: BaseSettings\n}\n\nexport interface AutocompleteElements extends QuestionElements {\n  autocompleteOptions: string\n}\n\nexport interface RenderBase {\n  render(questionTemplate: string, renderContext: RenderContext): void\n}\n\nexport interface QuestionRenderContext {\n  model: QuestionBaseModel\n}\n\nexport interface PageRenderContext {\n  params: PagePreviewPanelMacro\n}\n\nexport type RenderContext = QuestionRenderContext | PageRenderContext\n\nexport interface HTMLBuilder {\n  buildHTML(questionTemplate: string, renderContext: RenderContext): string\n}\n\nexport interface QuestionRenderer {\n  render(questionTemplate: string, questionBaseModel: QuestionBaseModel): void\n}\n\nexport interface PageRenderer {\n  render(pageTemplate: string, pagePreview: PagePreviewPanelMacro): void\n}\n\nexport type Renderer = QuestionRenderer | PageRenderer\n\nexport interface ListElements extends QuestionElements {\n  afterInputsHTML: string\n}\n\nexport interface PagePreviewBaseElements {\n  heading: string\n  guidance: string\n}\n\nexport interface PageOverviewElements extends PagePreviewBaseElements {\n  addHeading: boolean\n  repeatQuestion: string | undefined\n  hasRepeater: boolean\n}\n\nexport interface SummaryPageElements extends PagePreviewBaseElements {\n  declaration: boolean\n}\n\nexport type PreviewQuestion =\n  | DateInputQuestion\n  | EmailAddressQuestion\n  | ListSortableQuestion\n  | LongAnswerQuestion\n  | PhoneNumberQuestion\n  | Question\n  | RadioSortableQuestion\n  | SelectSortableQuestion\n  | ShortAnswerQuestion\n  | UkAddressQuestion\n  | AutocompleteQuestion\n"],"mappings":"","ignoreList":[]}

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

@@ -75,4 +75,20 @@ export interface PagePreviewPanelMacro {
         classes: string;
     };
 }
+export interface SummaryRowActionItem {
+    href: string;
+    text: string;
+    visuallyHiddenText: string;
+}
+export interface SummaryRow {
+    key: {
+        text: string;
+    };
+    value: {
+        text: string;
+    };
+    actions: {
+        items: SummaryRowActionItem[];
+    };
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/macros/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,gBAAgB,EACtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE1E,MAAM,WAAW,sCAAsC;IACrD,sBAAsB,EAAE,EAAE,CAAA;IAC1B,UAAU,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAClD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,sCAAsC,CAAA;IACtD,YAAY,EAAE;QACZ,WAAW,EAAE,UAAU,EAAE,CAAA;QACzB,cAAc,EAAE,UAAU,EAAE,CAAA;KAC7B,CAAA;IACD,YAAY,EAAE,aAAa,CAAA;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC,YAAY,EAAE,aAAa,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,EAAE,sCAAsC,CAAA;IACtD,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,cAAc,EAAE,UAAU,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAC7B;AACD,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAC9B;AAGD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,2BAA2B,CAAA;AAEhF,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,GAAG,QAAQ,EAAE,CAAA;IAChD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,wBAAwB;IACpE,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,iBAAiB,CAAA;IACxB,YAAY,EAAE,aAAa,CAAA;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,EAAE;QAClB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,UAAU,EAAE,oBAAoB,EAAE,CAAA;IAC3C,QAAQ,CAAC,YAAY,CAAC,EAAE;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,cAAc,CAAC,EAAE;QACxB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/form/form-editor/macros/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,gBAAgB,EACtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE1E,MAAM,WAAW,sCAAsC;IACrD,sBAAsB,EAAE,EAAE,CAAA;IAC1B,UAAU,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAClD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,sCAAsC,CAAA;IACtD,YAAY,EAAE;QACZ,WAAW,EAAE,UAAU,EAAE,CAAA;QACzB,cAAc,EAAE,UAAU,EAAE,CAAA;KAC7B,CAAA;IACD,YAAY,EAAE,aAAa,CAAA;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC,YAAY,EAAE,aAAa,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;IACxB,cAAc,EAAE,sCAAsC,CAAA;IACtD,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,cAAc,EAAE,UAAU,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAC7B;AACD,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAC9B;AAGD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,2BAA2B,CAAA;AAEhF,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,GAAG,QAAQ,EAAE,CAAA;IAChD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,wBAAwB;IACpE,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,iBAAiB,CAAA;IACxB,YAAY,EAAE,aAAa,CAAA;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,SAAS,EAAE;QAClB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,UAAU,EAAE,oBAAoB,EAAE,CAAA;IAC3C,QAAQ,CAAC,YAAY,CAAC,EAAE;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,QAAQ,CAAC,cAAc,CAAC,EAAE;QACxB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,OAAO,EAAE;QACP,KAAK,EAAE,oBAAoB,EAAE,CAAA;KAC9B,CAAA;CACF"}

package/dist/types/form/form-editor/preview/controller/summary-page-controller.d.ts

@@ -0,0 +1,45 @@
+export class SummaryPageController extends PreviewPageControllerBase {
+    /**
+     * @param {SummaryPageElements} elements
+     * @param {FormDefinition} formDefinition
+     * @param {PageRenderer} renderer
+     */
+    constructor(elements: SummaryPageElements, formDefinition: FormDefinition, renderer: PageRenderer);
+    /**
+     * @type {FormComponentsDef[]}
+     * @private
+     */
+    private _componentDefs;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private _makeDeclaration;
+    /**
+     * @returns {{ rows: SummaryRow[] }}
+     */
+    get componentRows(): {
+        rows: SummaryRow[];
+    };
+    /**
+     * @param {string} declarationText
+     */
+    set declarationText(declarationText: string);
+    get declarationText(): string;
+    get declaration(): {
+        classes: string;
+        text: string;
+    };
+    setMakeDeclaration(): void;
+    unsetMakeDeclaration(): void;
+    get makeDeclaration(): boolean;
+    highlightDeclaration(): void;
+    unhighlightDeclaration(): void;
+    get buttonText(): "Accept and send" | "Send";
+}
+import { PreviewPageControllerBase } from '../../../../form/form-editor/preview/controller/page-controller-base.js';
+import type { SummaryRow } from '../../../../form/form-editor/macros/types.js';
+import type { SummaryPageElements } from '../../../../form/form-editor/preview/types.js';
+import type { FormDefinition } from '../../../../form/form-definition/types.js';
+import type { PageRenderer } from '../../../../form/form-editor/preview/types.js';
+//# sourceMappingURL=summary-page-controller.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"summary-page-controller.d.ts","sourceRoot":"","sources":["../../../../../../src/form/form-editor/preview/controller/summary-page-controller.js"],"names":[],"mappings":"AAOA;IAqBE;;;;OAIG;IACH,sBAJW,mBAAmB,kBACnB,cAAc,YACd,YAAY,EAatB;IA1BD;;;OAGG;IACH,uBAAmB;IACnB;;;OAGG;IACH,yBAAwB;IAmBxB;;OAEG;IACH,qBAFa;QAAE,IAAI,EAAE,UAAU,EAAE,CAAA;KAAE,CAkBlC;IAgCD;;OAEG;IACH,qCAFW,MAAM,EAIhB;IAED,uBANW,MAAM,CAQhB;IAED;;;MAEC;IAED,2BAGC;IAED,6BAGC;IAED,+BAEC;IAED,6BAEC;IAED,+BAEC;IAaD,6CAEC;CACF;0CAlJyC,mEAAmE;gCAwJxD,wCAAwC;yCADd,yCAAyC;oCADrF,qCAAqC;kCACO,yCAAyC"}

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

@@ -22,5 +22,6 @@ export * from "../../../form/form-editor/preview/uk-address.js";
 export * from "../../../form/form-editor/preview/yes-no.js";
 export * from "../../../form/form-editor/preview/controller/page-controller.js";
 export * from "../../../form/form-editor/preview/controller/guidance-page-controller.js";
+export * from "../../../form/form-editor/preview/controller/summary-page-controller.js";
 export * from "../../../form/form-editor/preview/controller/page-controller-base.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -78,5 +78,8 @@ export interface PageOverviewElements extends PagePreviewBaseElements {
     repeatQuestion: string | undefined;
     hasRepeater: boolean;
 }
+export interface SummaryPageElements extends PagePreviewBaseElements {
+    declaration: boolean;
+}
 export type PreviewQuestion = DateInputQuestion | EmailAddressQuestion | ListSortableQuestion | LongAnswerQuestion | PhoneNumberQuestion | Question | RadioSortableQuestion | SelectSortableQuestion | ShortAnswerQuestion | UkAddressQuestion | AutocompleteQuestion;
 //# sourceMappingURL=types.d.ts.map

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,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;CAChB;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,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,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,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;CAChB;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,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.506",
+  "version": "3.0.507",
   "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/form/form-editor/macros/types.ts

@@ -82,3 +82,17 @@ export interface PagePreviewPanelMacro {
     classes: string
   }
 }
+
+export interface SummaryRowActionItem {
+  href: string
+  text: string
+  visuallyHiddenText: string
+}
+
+export interface SummaryRow {
+  key: { text: string }
+  value: { text: string }
+  actions: {
+    items: SummaryRowActionItem[]
+  }
+}

package/src/form/form-editor/preview/controller/summary-page-controller.js

@@ -0,0 +1,157 @@
+import { hasFormField } from '~/src/components/helpers.js'
+import { HIGHLIGHT_CLASS } from '~/src/form/form-editor/preview/constants.js'
+import { PreviewPageControllerBase } from '~/src/form/form-editor/preview/controller/page-controller-base.js'
+import { hasComponents } from '~/src/pages/helpers.js'
+
+const EXAMPLE_TEXT = 'Answer goes here'
+
+export class SummaryPageController extends PreviewPageControllerBase {
+  /**
+   * @type {string}
+   * @protected
+   */
+  _pageTemplate = PreviewPageControllerBase.PATH + 'summary-controller.njk'
+  /**
+   * @type {Markdown}
+   * @protected
+   */
+  _guidanceComponent = PreviewPageControllerBase.createGuidanceComponent(false)
+  /**
+   * @type {FormComponentsDef[]}
+   * @private
+   */
+  _componentDefs = []
+  /**
+   * @type {boolean}
+   * @private
+   */
+  _makeDeclaration = false
+  /**
+   * @param {SummaryPageElements} elements
+   * @param {FormDefinition} formDefinition
+   * @param {PageRenderer} renderer
+   */
+  constructor(elements, formDefinition, renderer) {
+    super(elements, renderer)
+    this._componentDefs = formDefinition.pages.flatMap((page) => {
+      if (hasComponents(page)) {
+        return page.components.filter(hasFormField)
+      }
+      return []
+    })
+    this._makeDeclaration = elements.declaration
+
+    this._guidanceComponent.content = elements.guidance
+  }
+
+  /**
+   * @returns {{ rows: SummaryRow[] }}
+   */
+  get componentRows() {
+    const rows = this._componentDefs.map((component) => {
+      const summaryRowHeading = component.shortDescription ?? ''
+      return {
+        key: { text: summaryRowHeading },
+        value: { text: EXAMPLE_TEXT },
+        actions: {
+          items: [
+            { href: '#', text: 'Change', visuallyHiddenText: summaryRowHeading }
+          ]
+        }
+      }
+    })
+    return {
+      rows
+    }
+  }
+
+  /**
+   * @returns {{ text: string; classes: string }}
+   */
+  get pageTitle() {
+    return {
+      text: 'Check your answers before sending your form',
+      classes: ''
+    }
+  }
+
+  get guidance() {
+    if (!this._makeDeclaration) {
+      return {
+        classes: '',
+        text: ''
+      }
+    }
+    const guidanceHighlighted = this._highlighted === 'guidance'
+    const classes = guidanceHighlighted ? HIGHLIGHT_CLASS : ''
+    let text = this._guidanceText.length ? this._guidanceText : ''
+
+    if (!text.length && guidanceHighlighted) {
+      text = 'Declaration text'
+    }
+    return {
+      text,
+      classes
+    }
+  }
+
+  /**
+   * @param {string} declarationText
+   */
+  set declarationText(declarationText) {
+    this.guidanceText = declarationText
+  }
+
+  get declarationText() {
+    return this.guidanceText
+  }
+
+  get declaration() {
+    return this.guidance
+  }
+
+  setMakeDeclaration() {
+    this._makeDeclaration = true
+    this.render()
+  }
+
+  unsetMakeDeclaration() {
+    this._makeDeclaration = false
+    this.render()
+  }
+
+  get makeDeclaration() {
+    return this._makeDeclaration
+  }
+
+  highlightDeclaration() {
+    this.highlightGuidance()
+  }
+
+  unhighlightDeclaration() {
+    this.clearHighlight()
+  }
+
+  /**
+   * @returns {Markdown[]}
+   * @protected
+   */
+  _getGuidanceComponents() {
+    if (!this._makeDeclaration) {
+      return []
+    }
+    return super._getGuidanceComponents()
+  }
+
+  get buttonText() {
+    return this.makeDeclaration ? 'Accept and send' : 'Send'
+  }
+}
+
+/**
+ * @import { ComponentDef, ContentComponentsDef, ListComponent, FormComponentsDef } from '~/src/components/types.js'
+ * @import { FormDefinition } from '~/src/form/form-definition/types.js'
+ * @import { PageRenderer, PagePreviewBaseElements, SummaryPageElements } from '~/src/form/form-editor/preview/types.js'
+ * @import { SummaryRowActionItem, SummaryRow } from '~/src/form/form-editor/macros/types.js'
+ * @import { Markdown } from '~/src/form/form-editor/preview/markdown.js'
+ */

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

@@ -22,4 +22,5 @@ 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/controller/page-controller.js'
 export * from '~/src/form/form-editor/preview/controller/guidance-page-controller.js'
+export * from '~/src/form/form-editor/preview/controller/summary-page-controller.js'
 export * from '~/src/form/form-editor/preview/controller/page-controller-base.js'

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

@@ -99,6 +99,10 @@ export interface PageOverviewElements extends PagePreviewBaseElements {
   hasRepeater: boolean
 }
 
+export interface SummaryPageElements extends PagePreviewBaseElements {
+  declaration: boolean
+}
+
 export type PreviewQuestion =
   | DateInputQuestion
   | EmailAddressQuestion