@defra/forms-engine-plugin 0.1.19 → 0.1.21

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

@@ -0,0 +1,6 @@
+import { type RadiosFieldComponent } from '@defra/forms-model';
+import { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js';
+export declare class RadiosField extends SelectionControlField {
+    options: RadiosFieldComponent['options'];
+    constructor(def: RadiosFieldComponent, props: ConstructorParameters<typeof SelectionControlField>[1]);
+}

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

@@ -0,0 +1,55 @@
+import { type AutocompleteFieldComponent, type SelectFieldComponent } from '@defra/forms-model';
+import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js';
+import { type FormPayload, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+export declare class SelectField extends ListFormComponent {
+    options: SelectFieldComponent['options'] | AutocompleteFieldComponent['options'];
+    constructor(def: SelectFieldComponent | AutocompleteFieldComponent, props: ConstructorParameters<typeof ListFormComponent>[1]);
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        items: import("./types.js").ListItem[];
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        type?: string;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        fieldset?: {
+            attributes?: string | Record<string, string>;
+            legend?: import("./types.js").Label;
+        };
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("./types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+}

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

@@ -0,0 +1,60 @@
+import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js';
+import { type ListItem } from '~/src/server/plugins/engine/components/types.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+/**
+ * "Selection controls" are checkboxes and radios (and switches), as per Material UI nomenclature.
+ */
+export declare class SelectionControlField extends ListFormComponent {
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        fieldset: {
+            attributes?: string | Record<string, string>;
+            legend?: import("~/src/server/plugins/engine/components/types.js").Label;
+        };
+        items: ListItem[];
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        type?: string;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        suffix?: import("~/src/server/plugins/engine/components/types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("~/src/server/plugins/engine/components/types.js").Content | import("~/src/server/plugins/engine/components/types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+}

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

@@ -0,0 +1,62 @@
+import { type TelephoneNumberFieldComponent } from '@defra/forms-model';
+import { type StringSchema } from 'joi';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+export declare class TelephoneNumberField extends FormComponent {
+    options: TelephoneNumberFieldComponent['options'];
+    formSchema: StringSchema;
+    stateSchema: StringSchema;
+    constructor(def: TelephoneNumberFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        type: string;
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        fieldset?: {
+            attributes?: string | Record<string, string>;
+            legend?: import("./types.js").Label;
+        };
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        components?: import("./types.js").ComponentViewModel[];
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+}

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

@@ -0,0 +1,19 @@
+import { type EmailAddressFieldComponent, type TextFieldComponent } from '@defra/forms-model';
+import { type StringSchema } from 'joi';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type ErrorMessageTemplateList, type FormState, type FormStateValue, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+export declare class TextField extends FormComponent {
+    options: TextFieldComponent['options'] | EmailAddressFieldComponent['options'];
+    schema: TextFieldComponent['schema'];
+    formSchema: StringSchema;
+    stateSchema: StringSchema;
+    constructor(def: TextFieldComponent | EmailAddressFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): string | undefined;
+    getFormValue(value?: FormStateValue | FormState): string | undefined;
+    isValue(value?: FormStateValue | FormState): value is string;
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isText(value?: FormStateValue | FormState): value is string;
+}

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

@@ -0,0 +1,80 @@
+import { type UkAddressFieldComponent } from '@defra/forms-model';
+import { type ObjectSchema } from 'joi';
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
+import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js';
+import { type ErrorMessageTemplateList, type FormPayload, type FormState, type FormStateValue, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+export declare class UkAddressField extends FormComponent {
+    options: UkAddressFieldComponent['options'];
+    formSchema: ObjectSchema<FormPayload>;
+    stateSchema: ObjectSchema<FormState>;
+    collection: ComponentCollection;
+    constructor(def: UkAddressFieldComponent, props: ConstructorParameters<typeof FormComponent>[1]);
+    getFormValueFromState(state: FormSubmissionState): UkAddressState | undefined;
+    getDisplayStringFromState(state: FormSubmissionState): string;
+    getContextValueFromState(state: FormSubmissionState): string[] | null;
+    /**
+     * Returns one error per child field
+     */
+    getViewErrors(errors?: FormSubmissionError[]): FormSubmissionError[] | undefined;
+    getViewModel(payload: FormPayload, errors?: FormSubmissionError[]): {
+        fieldset: {
+            attributes?: string | Record<string, string>;
+            legend?: import("./types.js").Label;
+        };
+        components: import("./types.js").ComponentViewModel[];
+        label: {
+            text: string;
+        };
+        id: string;
+        name: string;
+        value: import("~/src/server/plugins/engine/types.js").FormValue;
+        type?: string;
+        hint?: {
+            id?: string;
+            text: string;
+        };
+        prefix?: import("./types.js").ComponentText;
+        suffix?: import("./types.js").ComponentText;
+        classes?: string;
+        condition?: string;
+        errors?: FormSubmissionError[];
+        errorMessage?: {
+            text: string;
+        };
+        summaryHtml?: string;
+        html?: string;
+        attributes: {
+            autocomplete?: string;
+            maxlength?: number;
+            multiple?: string;
+            accept?: string;
+            inputmode?: string;
+        };
+        content?: import("./types.js").Content | import("./types.js").Content[] | string;
+        maxlength?: number;
+        maxwords?: number;
+        rows?: number;
+        items?: import("./types.js").ListItem[] | import("./types.js").DateInputItem[];
+        formGroup?: {
+            classes?: string;
+            attributes?: string | Record<string, string>;
+        };
+        upload?: {
+            count: number;
+            summaryList: import("~/src/server/plugins/engine/types.js").SummaryList;
+        };
+    };
+    isState(value?: FormStateValue | FormState): value is UkAddressState;
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    static isUkAddress(value?: FormStateValue | FormState): value is UkAddressState;
+}
+export interface UkAddressState extends Record<string, string> {
+    addressLine1: string;
+    addressLine2: string;
+    town: string;
+    county: string;
+    postcode: string;
+}

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

@@ -0,0 +1,19 @@
+import { type YesNoFieldComponent } from '@defra/forms-model';
+import { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js';
+import { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js';
+/**
+ * @description
+ * YesNoField is a radiosField with predefined values.
+ */
+export declare class YesNoField extends SelectionControlField {
+    options: YesNoFieldComponent['options'];
+    constructor(def: YesNoFieldComponent, props: ConstructorParameters<typeof SelectionControlField>[1]);
+    /**
+     * For error preview page that shows all possible errors on a component
+     */
+    getAllPossibleErrors(): ErrorMessageTemplateList;
+    /**
+     * Static version of getAllPossibleErrors that doesn't require a component instance.
+     */
+    static getAllPossibleErrors(): ErrorMessageTemplateList;
+}

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

@@ -34,6 +34,13 @@ export class YesNoField extends SelectionControlField {
    * For error preview page that shows all possible errors on a component
    */
   getAllPossibleErrors() {
+    return YesNoField.getAllPossibleErrors();
+  }
+
+  /**
+   * Static version of getAllPossibleErrors that doesn't require a component instance.
+   */
+  static getAllPossibleErrors() {
     return {
       baseErrors: [{
         type: 'selectYesNoRequired',

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

@@ -1 +1 @@
-{"version":3,"file":"YesNoField.js","names":["SelectionControlField","addClassOptionIfNone","messageTemplate","convertToLanguageMessages","YesNoField","constructor","def","props","list","options","formSchema","required","optional","messages","selectYesNoRequired","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/YesNoField.ts"],"sourcesContent":["import { type YesNoFieldComponent } from '@defra/forms-model'\n\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n/**\n * @description\n * YesNoField is a radiosField with predefined values.\n */\nexport class YesNoField extends SelectionControlField {\n  declare options: YesNoFieldComponent['options']\n\n  constructor(\n    def: YesNoFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super({ ...def, list: '__yesNo' }, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    addClassOptionIfNone(options, 'govuk-radios--inline')\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    formSchema = formSchema.messages(\n      convertToLanguageMessages({\n        'any.required': messageTemplate.selectYesNoRequired\n      })\n    )\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'selectYesNoRequired',\n          template: messageTemplate.selectYesNoRequired\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,qBAAqB;AAC9B,SAASC,oBAAoB;AAC7B,SAASC,eAAe;AAExB,SAASC,yBAAyB;;AAElC;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,SAASJ,qBAAqB,CAAC;EAGpDK,WAAWA,CACTC,GAAwB,EACxBC,KAA6D,EAC7D;IACA,KAAK,CAAC;MAAE,GAAGD,GAAG;MAAEE,IAAI,EAAE;IAAU,CAAC,EAAED,KAAK,CAAC;IAEzC,MAAM;MAAEE;IAAQ,CAAC,GAAGH,GAAG;IACvB,IAAI;MAAEI;IAAW,CAAC,GAAG,IAAI;IAEzBT,oBAAoB,CAACQ,OAAO,EAAE,sBAAsB,CAAC;IAErD,IAAIA,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9BD,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC,CAAC;IACpC;IAEAF,UAAU,GAAGA,UAAU,CAACG,QAAQ,CAC9BV,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACY;IAClC,CAAC,CACH,CAAC;IAED,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;;EAEA;AACF;AACA;EACEM,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,qBAAqB;QAC3BC,QAAQ,EAAEhB,eAAe,CAACY;MAC5B,CAAC,CACF;MACDK,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}
+{"version":3,"file":"YesNoField.js","names":["SelectionControlField","addClassOptionIfNone","messageTemplate","convertToLanguageMessages","YesNoField","constructor","def","props","list","options","formSchema","required","optional","messages","selectYesNoRequired","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors"],"sources":["../../../../../src/server/plugins/engine/components/YesNoField.ts"],"sourcesContent":["import { type YesNoFieldComponent } from '@defra/forms-model'\n\nimport { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'\nimport { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\nimport { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'\nimport { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'\n\n/**\n * @description\n * YesNoField is a radiosField with predefined values.\n */\nexport class YesNoField extends SelectionControlField {\n  declare options: YesNoFieldComponent['options']\n\n  constructor(\n    def: YesNoFieldComponent,\n    props: ConstructorParameters<typeof SelectionControlField>[1]\n  ) {\n    super({ ...def, list: '__yesNo' }, props)\n\n    const { options } = def\n    let { formSchema } = this\n\n    addClassOptionIfNone(options, 'govuk-radios--inline')\n\n    if (options.required === false) {\n      formSchema = formSchema.optional()\n    }\n\n    formSchema = formSchema.messages(\n      convertToLanguageMessages({\n        'any.required': messageTemplate.selectYesNoRequired\n      })\n    )\n\n    this.formSchema = formSchema\n    this.options = options\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return YesNoField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'selectYesNoRequired',\n          template: messageTemplate.selectYesNoRequired\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n}\n"],"mappings":"AAEA,SAASA,qBAAqB;AAC9B,SAASC,oBAAoB;AAC7B,SAASC,eAAe;AAExB,SAASC,yBAAyB;;AAElC;AACA;AACA;AACA;AACA,OAAO,MAAMC,UAAU,SAASJ,qBAAqB,CAAC;EAGpDK,WAAWA,CACTC,GAAwB,EACxBC,KAA6D,EAC7D;IACA,KAAK,CAAC;MAAE,GAAGD,GAAG;MAAEE,IAAI,EAAE;IAAU,CAAC,EAAED,KAAK,CAAC;IAEzC,MAAM;MAAEE;IAAQ,CAAC,GAAGH,GAAG;IACvB,IAAI;MAAEI;IAAW,CAAC,GAAG,IAAI;IAEzBT,oBAAoB,CAACQ,OAAO,EAAE,sBAAsB,CAAC;IAErD,IAAIA,OAAO,CAACE,QAAQ,KAAK,KAAK,EAAE;MAC9BD,UAAU,GAAGA,UAAU,CAACE,QAAQ,CAAC,CAAC;IACpC;IAEAF,UAAU,GAAGA,UAAU,CAACG,QAAQ,CAC9BV,yBAAyB,CAAC;MACxB,cAAc,EAAED,eAAe,CAACY;IAClC,CAAC,CACH,CAAC;IAED,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACD,OAAO,GAAGA,OAAO;EACxB;;EAEA;AACF;AACA;EACEM,oBAAoBA,CAAA,EAA6B;IAC/C,OAAOX,UAAU,CAACW,oBAAoB,CAAC,CAAC;EAC1C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,qBAAqB;QAC3BC,QAAQ,EAAEhB,eAAe,CAACY;MAC5B,CAAC,CACF;MACDK,sBAAsB,EAAE;IAC1B,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -0,0 +1 @@
+export declare const optionalText = " (optional)";

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

@@ -0,0 +1,40 @@
+import { ComponentType, type ComponentDef } from '@defra/forms-model';
+import { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js';
+import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js';
+import * as Components from '~/src/server/plugins/engine/components/index.js';
+import { type FormState } from '~/src/server/plugins/engine/types.js';
+export type Component = InstanceType<(typeof Components)[keyof typeof Components]>;
+export type Field = InstanceType<typeof Components.AutocompleteField | typeof Components.RadiosField | typeof Components.YesNoField | typeof Components.CheckboxesField | typeof Components.DatePartsField | typeof Components.EmailAddressField | typeof Components.MonthYearField | typeof Components.MultilineTextField | typeof Components.NumberField | typeof Components.SelectField | typeof Components.TelephoneNumberField | typeof Components.TextField | typeof Components.UkAddressField | typeof Components.FileUploadField>;
+export type Guidance = InstanceType<typeof Components.Details | typeof Components.Html | typeof Components.Markdown | typeof Components.InsetText | typeof Components.List>;
+export type ListField = InstanceType<typeof Components.AutocompleteField | typeof Components.CheckboxesField | typeof Components.RadiosField | typeof Components.SelectField | typeof Components.YesNoField>;
+/**
+ * Filter known components with lists
+ */
+export declare function hasListFormField(field?: Partial<Component>): field is ListFormComponent;
+export declare function isListFieldType(type?: ComponentType): type is ListField['type'];
+/**
+ * Create field instance for each {@link ComponentDef} type
+ */
+export declare function createComponent(def: ComponentDef, options: ConstructorParameters<typeof ComponentBase>[1]): Component;
+/**
+ * Get formatted answer for a field
+ */
+export declare function getAnswer(field: Field, state: FormState, options?: {
+    format: 'data' | 'email' | 'summary';
+}): string;
+/**
+ * Get formatted answer for a field (Markdown only)
+ */
+export declare function getAnswerMarkdown(field: Field, state: FormState, options?: {
+    format: 'email' | 'summary';
+}): string;
+/**
+ * Prevent Markdown formatting
+ * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
+ */
+export declare function escapeMarkdown(answer: string): string;
+export declare const addClassOptionIfNone: (options: Extract<ComponentDef, {
+    options: {
+        classes?: string;
+    };
+}>["options"], className: string) => void;

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

@@ -0,0 +1,24 @@
+/**
+ * IMPORTANT: Exported Components must follow the naming convention implemented in {@link @defra/forms-model#ComponentType}
+ * In the Form JSON, components have a type property which is the name of the components, e.g. DatePartsField.
+ * Components are loaded in the ComponentsCollection constructor.
+ */
+export { AutocompleteField } from '~/src/server/plugins/engine/components/AutocompleteField.js';
+export { CheckboxesField } from '~/src/server/plugins/engine/components/CheckboxesField.js';
+export { DatePartsField } from '~/src/server/plugins/engine/components/DatePartsField.js';
+export { Details } from '~/src/server/plugins/engine/components/Details.js';
+export { EmailAddressField } from '~/src/server/plugins/engine/components/EmailAddressField.js';
+export { Html } from '~/src/server/plugins/engine/components/Html.js';
+export { InsetText } from '~/src/server/plugins/engine/components/InsetText.js';
+export { List } from '~/src/server/plugins/engine/components/List.js';
+export { Markdown } from '~/src/server/plugins/engine/components/Markdown.js';
+export { MultilineTextField } from '~/src/server/plugins/engine/components/MultilineTextField.js';
+export { NumberField } from '~/src/server/plugins/engine/components/NumberField.js';
+export { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.js';
+export { SelectField } from '~/src/server/plugins/engine/components/SelectField.js';
+export { TelephoneNumberField } from '~/src/server/plugins/engine/components/TelephoneNumberField.js';
+export { TextField } from '~/src/server/plugins/engine/components/TextField.js';
+export { UkAddressField } from '~/src/server/plugins/engine/components/UkAddressField.js';
+export { YesNoField } from '~/src/server/plugins/engine/components/YesNoField.js';
+export { MonthYearField } from '~/src/server/plugins/engine/components/MonthYearField.js';
+export { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js';

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

@@ -0,0 +1,100 @@
+import { type ComponentType, type Item } from '@defra/forms-model';
+import { type FormSubmissionError, type FormValue, type SummaryList } from '~/src/server/plugins/engine/types.js';
+export type ComponentText = {
+    classes?: string;
+    attributes?: string | Record<string, string>;
+} & ({
+    text: string;
+    html?: string;
+} | {
+    text?: string;
+    html: string;
+});
+export interface Label {
+    text: string;
+    classes?: string;
+    html?: string;
+    isPageHeading?: boolean;
+}
+export interface Content {
+    title?: string;
+    text: string;
+    condition?: string;
+}
+export interface BackLink {
+    text: string;
+    href: string;
+}
+export type ListItemLabel = Omit<Label, 'text' | 'isPageHeading'>;
+export interface ListItem {
+    text?: string;
+    value?: Item['value'];
+    hint?: {
+        id?: string;
+        text: string;
+    };
+    checked?: boolean;
+    selected?: boolean;
+    label?: ListItemLabel;
+    condition?: string;
+}
+export interface DateInputItem {
+    label?: Label;
+    type?: string;
+    id?: string;
+    name?: string;
+    value?: Item['value'];
+    classes?: string;
+    condition?: undefined;
+}
+export interface ViewModel extends Record<string, unknown> {
+    label?: Label;
+    type?: string;
+    id?: string;
+    name?: string;
+    value?: FormValue;
+    hint?: {
+        id?: string;
+        text: string;
+    };
+    prefix?: ComponentText;
+    suffix?: ComponentText;
+    classes?: string;
+    condition?: string;
+    errors?: FormSubmissionError[];
+    errorMessage?: {
+        text: string;
+    };
+    summaryHtml?: string;
+    html?: string;
+    attributes: {
+        autocomplete?: string;
+        maxlength?: number;
+        multiple?: string;
+        accept?: string;
+        inputmode?: string;
+    };
+    content?: Content | Content[] | string;
+    maxlength?: number;
+    maxwords?: number;
+    rows?: number;
+    items?: ListItem[] | DateInputItem[];
+    fieldset?: {
+        attributes?: string | Record<string, string>;
+        legend?: Label;
+    };
+    formGroup?: {
+        classes?: string;
+        attributes?: string | Record<string, string>;
+    };
+    components?: ComponentViewModel[];
+    upload?: {
+        count: number;
+        summaryList: SummaryList;
+    };
+}
+export interface ComponentViewModel {
+    type: ComponentType;
+    isFormComponent: boolean;
+    model: ViewModel;
+}

package/.server/server/plugins/engine/configureEnginePlugin.d.ts

@@ -0,0 +1,8 @@
+import { type FormDefinition } from '@defra/forms-model';
+import { plugin, type PluginOptions } from '~/src/server/plugins/engine/plugin.js';
+import { type RouteConfig } from '~/src/server/types.js';
+export declare const configureEnginePlugin: ({ formFileName, formFilePath, services, controllers }?: RouteConfig) => Promise<{
+    plugin: typeof plugin;
+    options: PluginOptions;
+}>;
+export declare function getForm(importPath: string): Promise<FormDefinition>;

package/.server/server/plugins/engine/helpers.d.ts

@@ -0,0 +1,74 @@
+import { type ComponentDef, type FormDefinition, type Page } from '@defra/forms-model';
+import { type ResponseToolkit, type Server } from '@hapi/hapi';
+import { type ValidationErrorItem } from 'joi';
+import { Liquid } from 'liquidjs';
+import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js';
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
+import { type FormContext, type FormContextRequest, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+import { FormStatus, type FormParams, type FormQuery, type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+export declare const engine: Liquid;
+export interface GlobalScope {
+    context: FormContext;
+    pages: Map<string, Page>;
+    components: Map<string, ComponentDef>;
+}
+export declare function proceed(request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>, h: Pick<ResponseToolkit, 'redirect' | 'view'>, nextUrl: string): import("@hapi/hapi").ResponseObject;
+/**
+ * Encodes a URL, returning undefined if the process fails.
+ */
+export declare function encodeUrl(link?: string): string | undefined;
+/**
+ * Get page href
+ */
+export declare function getPageHref(page: PageControllerClass, query?: FormQuery): string;
+/**
+ * Get page href by path
+ */
+export declare function getPageHref(page: PageControllerClass, path: string, query?: FormQuery): string;
+/**
+ * Get redirect path with optional query params
+ */
+export declare function redirectPath(nextUrl: string, query?: FormQuery): string;
+export declare function isPathRelative(path?: string): boolean;
+export declare function normalisePath(path?: string): string;
+export declare function getPage(model: FormModel | undefined, request: FormContextRequest): PageControllerClass;
+export declare function findPage(model: FormModel | undefined, path?: string): PageControllerClass | undefined;
+export declare function getStartPath(model?: FormModel): string;
+export declare function checkFormStatus(params?: FormParams): {
+    isPreview: boolean;
+    state: FormStatus;
+};
+export declare function checkEmailAddressForLiveFormSubmission(emailAddress: string | undefined, isPreview: boolean): void;
+/**
+ * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates
+ * @param [details] - provided by {@link Schema.validate}
+ */
+export declare function getErrors(details?: ValidationErrorItem[]): FormSubmissionError[] | undefined;
+export declare function getError(detail: ValidationErrorItem): FormSubmissionError;
+/**
+ * A small helper to safely generate a crumb token.
+ * Checks that the crumb plugin is available, that crumb
+ * is not disabled on the current route, and that cookies/state are present.
+ */
+export declare function safeGenerateCrumb(request: FormRequest | FormRequestPayload | null): string | undefined;
+/**
+ * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,
+ * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).
+ * @param depth - The current retry depth (1, 2, 3, …)
+ * @returns The calculated delay in milliseconds.
+ */
+export declare function getExponentialBackoffDelay(depth: number): number;
+export declare function evaluateTemplate(template: string, context: FormContext): string;
+export declare function getCacheService(server: Server): import("../../services/cacheService.js").CacheService;
+/**
+ * Handles logging and issuing a permanent redirect for legacy routes.
+ * @param h - The Hapi response toolkit.
+ * @param targetUrl - The URL to redirect to.
+ * @returns The Hapi response object configured for permanent redirect.
+ */
+export declare function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string): import("@hapi/hapi").ResponseObject;
+/**
+ * If the page doesn't have a title, set it from the title of the first form component
+ * @param def - the form definition
+ */
+export declare function setPageTitles(def: FormDefinition): void;

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

@@ -0,0 +1,10 @@
+import { type Environment } from 'nunjucks';
+import { plugin } from '~/src/server/plugins/engine/plugin.js';
+import { type FilterFunction } from '~/src/server/plugins/engine/types.js';
+export { getPageHref } from '~/src/server/plugins/engine/helpers.js';
+export { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js';
+export { context } from '~/src/server/plugins/nunjucks/context.js';
+export declare const VIEW_PATH = "src/server/plugins/engine/views";
+export declare const PLUGIN_PATH = "node_modules/@defra/forms-engine-plugin";
+export declare const prepareNunjucksEnvironment: (env: Environment, additionalFilters?: Record<string, FilterFunction>) => void;
+export default plugin;