@defra/forms-engine-plugin 0.1.19 → 0.1.21

package/.server/server/plugins/engine/models/FormModel.d.ts

@@ -0,0 +1,59 @@
+import { Engine, type ComponentDef, type ConditionWrapper, type ConditionsModelData, type FormDefinition, type List, type Page } from '@defra/forms-model';
+import { Parser, type Value } from 'expr-eval';
+import joi from 'joi';
+import { type Component } from '~/src/server/plugins/engine/components/helpers.js';
+import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js';
+import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
+import { type FormContext, type FormContextRequest, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+import { type Services } from '~/src/server/types.js';
+export declare class FormModel {
+    /** The runtime engine that should be used */
+    engine?: Engine;
+    /** the entire form JSON as an object */
+    def: FormDefinition;
+    lists: FormDefinition['lists'];
+    sections: FormDefinition['sections'];
+    name: string;
+    values: FormDefinition;
+    basePath: string;
+    conditions: Partial<Record<string, ExecutableCondition>>;
+    pages: PageControllerClass[];
+    services: Services;
+    controllers?: Record<string, typeof PageController>;
+    pageDefMap: Map<string, Page>;
+    listDefMap: Map<string, List>;
+    componentDefMap: Map<string, ComponentDef>;
+    pageMap: Map<string, PageControllerClass>;
+    componentMap: Map<string, Component>;
+    constructor(def: typeof this.def, options: {
+        basePath: string;
+    }, services?: Services, controllers?: Record<string, typeof PageController>);
+    /**
+     * build the entire model schema from individual pages/sections
+     */
+    makeSchema(): joi.ObjectSchema<FormSubmissionState>;
+    /**
+     * build the entire model schema from individual pages/sections and filter out answers
+     * for pages which are no longer accessible due to an answer that has been changed
+     */
+    makeFilteredSchema(relevantPages: PageControllerClass[]): joi.ObjectSchema<FormSubmissionState>;
+    /**
+     * Instantiates a Condition based on {@link ConditionWrapper}
+     * @param condition
+     */
+    makeCondition(condition: ConditionWrapper): ExecutableCondition;
+    toConditionContext(evaluationState: FormState, conditions: Partial<Record<string, ExecutableCondition>>): Extract<Value, Record<string, Value>>;
+    toConditionExpression(value: ConditionsModelData, parser: Parser): import("expr-eval").Expression;
+    getList(name: string): List | undefined;
+    /**
+     * Form context for the current page
+     */
+    getFormContext(request: FormContextRequest, state: FormState, errors?: FormSubmissionError[]): FormContext;
+    private initialiseContext;
+    private assignEvaluationState;
+    private assignRelevantState;
+    private pageStateIsInvalid;
+    private fieldStateIsInvalid;
+    private assignPaths;
+}

package/.server/server/plugins/engine/models/RepeatingSummaryViewModel.d.ts

@@ -0,0 +1 @@
+export {};

package/.server/server/plugins/engine/models/Section.d.ts

@@ -0,0 +1 @@
+export {};

package/.server/server/plugins/engine/models/SummaryViewModel.d.ts

@@ -0,0 +1,25 @@
+import { type BackLink, type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js';
+import { type Detail } from '~/src/server/plugins/engine/models/types.js';
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
+import { type CheckAnswers, type FormContext, type FormContextRequest, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+export declare class SummaryViewModel {
+    /**
+     * Responsible for parsing state values to the govuk-frontend summary list template
+     */
+    page: PageControllerClass;
+    pageTitle: string;
+    declaration?: string;
+    details: Detail[];
+    checkAnswers: CheckAnswers[];
+    context: FormContext;
+    name: string | undefined;
+    backLink?: BackLink;
+    feedbackLink?: string;
+    phaseTag?: string;
+    errors?: FormSubmissionError[];
+    serviceUrl: string;
+    hasMissingNotificationEmail?: boolean;
+    components?: ComponentViewModel[];
+    constructor(request: FormContextRequest, page: PageControllerClass, context: FormContext);
+    private summaryDetails;
+}

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

@@ -0,0 +1,2 @@
+export { FormModel } from '~/src/server/plugins/engine/models/FormModel.js';
+export { SummaryViewModel } from '~/src/server/plugins/engine/models/SummaryViewModel.js';

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

@@ -0,0 +1,87 @@
+import { type ConditionWrapper, type Section } from '@defra/forms-model';
+import { type Expression } from 'expr-eval';
+import { type Field } from '~/src/server/plugins/engine/components/helpers.js';
+import { type RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js';
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js';
+import { type FormState, type FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+export type ExecutableCondition = ConditionWrapper & {
+    expr: Expression;
+    fn: (evaluationState: FormState) => boolean;
+};
+/**
+ * Used to render a row on a Summary List (check your answers)
+ */
+export interface DetailItemBase {
+    /**
+     * Name of the component defined in the JSON
+     * @see {@link FormComponentsDef.name}
+     */
+    name: string;
+    /**
+     * Field label, used for change link visually hidden text
+     * @see {@link FormComponentsDef.title}
+     */
+    label: string;
+    /**
+     * Field change link
+     */
+    href: string;
+    /**
+     * Form submission state (or repeat state for sub items)
+     */
+    state: FormState;
+    /**
+     * Field submission state error, used to flag unanswered questions
+     * Shown as 'Complete all unanswered questions before submitting the form'
+     */
+    error?: FormSubmissionError;
+}
+export interface DetailItemField extends DetailItemBase {
+    /**
+     * Field page controller instance
+     */
+    page: Exclude<PageControllerClass, RepeatPageController>;
+    /**
+     * Check answers summary list key
+     * For example, 'Date of birth'
+     */
+    title: string;
+    /**
+     * Check answers summary list value, formatted by {@link getAnswer}
+     * For example, date fields formatted as '25 December 2022'
+     */
+    value: string;
+    /**
+     * Field component instance
+     */
+    field: Field;
+}
+export interface DetailItemRepeat extends DetailItemBase {
+    /**
+     * Repeat page controller instance
+     */
+    page: RepeatPageController;
+    /**
+     * Check answers summary list key
+     * For example, 'Pizza' or 'Pizza added'
+     */
+    title: string;
+    /**
+     * Check answers summary list value
+     * For example, 'You added 2 Pizzas'
+     */
+    value: string;
+    /**
+     * Repeater field detail items
+     */
+    subItems: DetailItemField[][];
+}
+export type DetailItem = DetailItemField | DetailItemRepeat;
+/**
+ * Used to render a row on a Summary List (check your answers)
+ */
+export interface Detail {
+    name?: Section['name'];
+    title?: Section['title'];
+    items: DetailItem[];
+}

package/.server/server/plugins/engine/outputFormatters/human/v1.d.ts

@@ -0,0 +1,5 @@
+import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+export declare function format(items: DetailItem[], model: FormModel, submitResponse: SubmitResponsePayload, formStatus: ReturnType<typeof checkFormStatus>): string;

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

@@ -0,0 +1,7 @@
+import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+type Formatter = (items: DetailItem[], model: FormModel, submitResponse: SubmitResponsePayload, formStatus: ReturnType<typeof checkFormStatus>) => string;
+export declare function getFormatter(audience: string, version: string): Formatter;
+export {};

package/.server/server/plugins/engine/outputFormatters/machine/v1.d.ts

@@ -0,0 +1,5 @@
+import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+export declare function format(items: DetailItem[], model: FormModel, _submitResponse: SubmitResponsePayload, _formStatus: ReturnType<typeof checkFormStatus>): string;

package/.server/server/plugins/engine/outputFormatters/machine/v2.d.ts

@@ -0,0 +1,5 @@
+import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+export declare function format(items: DetailItem[], model: FormModel, _submitResponse: SubmitResponsePayload, _formStatus: ReturnType<typeof checkFormStatus>): string;

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

@@ -0,0 +1,61 @@
+import { type PageFileUpload } from '@defra/forms-model';
+import { type ResponseToolkit } from '@hapi/hapi';
+import { type ValidationErrorItem } from 'joi';
+import { type FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FeaturedFormPageViewModel, type FormContext, type FormContextRequest, type FormSubmissionError, type FormSubmissionState, type UploadInitiateResponse, type UploadStatusFileResponse } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+export declare function prepareStatus(status: UploadStatusFileResponse): UploadStatusFileResponse;
+export declare class FileUploadPageController extends QuestionPageController {
+    pageDef: PageFileUpload;
+    fileUpload: FileUploadField;
+    fileDeleteViewName: string;
+    constructor(model: FormModel, pageDef: PageFileUpload);
+    getFormDataFromState(request: FormContextRequest | undefined, state: FormSubmissionState): import("~/src/server/plugins/engine/types.js").FormPayload;
+    getState(request: FormRequest | FormRequestPayload): Promise<FormSubmissionState>;
+    /**
+     * Get the uploaded files from state.
+     */
+    getFilesFromState(state: FormSubmissionState): import("~/src/server/plugins/engine/types.js").UploadState;
+    /**
+     * Get the initiated upload from state.
+     */
+    getUploadFromState(state: FormSubmissionState): UploadInitiateResponse | undefined;
+    makeGetItemDeleteRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
+    makePostItemDeleteRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    getErrors(details?: ValidationErrorItem[]): FormSubmissionError[] | undefined;
+    getViewModel(request: FormContextRequest, context: FormContext): FeaturedFormPageViewModel;
+    /**
+     * Refreshes the CDP upload and files in the
+     * state and checks for any removed files.
+     *
+     * If an upload exists and hasn't been consumed
+     * it gets re-used, otherwise we initiate a new one.
+     * @param request - the hapi request
+     * @param state - the form state
+     */
+    private refreshUpload;
+    /**
+     * If an upload exists and hasn't been consumed
+     * it gets re-used, otherwise a new one is initiated.
+     * @param request - the hapi request
+     * @param state - the form state
+     * @param depth - the number of retries so far
+     */
+    private checkUploadStatus;
+    /**
+     * Checks the payload for a file getting removed
+     * and removes it from the upload files if found
+     * @param request - the hapi request
+     * @param state - the form state
+     * @returns updated state if any files have been removed
+     */
+    private checkRemovedFiles;
+    /**
+     * Initiates a CDP file upload and stores in the upload state
+     * @param request - the hapi request
+     * @param state - the form state
+     */
+    private initiateAndStoreNewUpload;
+}

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

@@ -0,0 +1,43 @@
+import { type Events, type FormDefinition, type Page, type Section } from '@defra/forms-model';
+import { type Lifecycle, type ResponseToolkit, type RouteOptions } from '@hapi/hapi';
+import { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js';
+import { type FormContext, type PageViewModelBase } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+export declare class PageController {
+    /**
+     * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.
+     */
+    def: FormDefinition;
+    name?: string;
+    model: FormModel;
+    pageDef: Page;
+    title: string;
+    section?: Section;
+    condition?: ExecutableCondition;
+    events?: Events;
+    collection?: ComponentCollection;
+    viewName: string;
+    constructor(model: FormModel, pageDef: Page);
+    get path(): string;
+    get href(): string;
+    get keys(): string[];
+    /**
+     * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+     */
+    get getRouteOptions(): RouteOptions<FormRequestRefs>;
+    /**
+     * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+     */
+    get postRouteOptions(): RouteOptions<FormRequestPayloadRefs>;
+    get viewModel(): PageViewModelBase;
+    get feedbackLink(): string | undefined;
+    get phaseTag(): "beta" | "alpha" | undefined;
+    getHref(path: string): string;
+    getStartPath(): string;
+    getSummaryPath(): string;
+    getStatusPath(): string;
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, 'redirect' | 'view'>) => ReturnType<Lifecycle.Method<FormRequestRefs>>;
+    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, 'redirect' | 'view'>) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>>;
+}

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

@@ -0,0 +1,58 @@
+import { type Link, type Page } from '@defra/forms-model';
+import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi';
+import { type ValidationErrorItem } from 'joi';
+import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js';
+import { type BackLink } from '~/src/server/plugins/engine/components/types.js';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
+import { type FormContext, type FormContextRequest, type FormPageViewModel, type FormParams, type FormPayload, type FormState, type FormStateValue, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs, type FormRequestRefs } from '~/src/server/routes/types.js';
+export declare class QuestionPageController extends PageController {
+    collection: ComponentCollection;
+    errorSummaryTitle: string;
+    constructor(model: FormModel, pageDef: Page);
+    get next(): Link[];
+    get allowContinue(): boolean;
+    getItemId(request?: FormContextRequest): string | undefined;
+    /**
+     * Used for mapping form payloads and errors to govuk-frontend's template api, so a page can be rendered
+     * @param request - the hapi request
+     * @param context - the form context
+     */
+    getViewModel(request: FormContextRequest, context: FormContext): FormPageViewModel;
+    getRelevantPath(request: FormRequest | FormRequestPayload, context: FormContext): string;
+    /**
+     * Apply conditions to evaluation state to determine next page path
+     */
+    getNextPath(context: FormContext): string | undefined;
+    /**
+     * Gets the form payload (from state) for this page only
+     */
+    getFormDataFromState(request: FormContextRequest | undefined, state: FormSubmissionState): FormPayload;
+    /**
+     * Gets form params (from payload) for this page only
+     */
+    getFormParams(request?: FormContextRequest): FormParams;
+    getStateFromValidForm(request: FormContextRequest, state: FormSubmissionState, payload: FormPayload): FormState;
+    getErrors(details?: ValidationErrorItem[]): import("~/src/server/plugins/engine/types.js").FormSubmissionError[] | undefined;
+    getState(request: FormRequest | FormRequestPayload): Promise<FormSubmissionState>;
+    setState(request: FormRequest | FormRequestPayload, state: FormSubmissionState): Promise<FormSubmissionState>;
+    mergeState(request: FormRequest | FormRequestPayload, state: FormSubmissionState, update: object): Promise<FormSubmissionState>;
+    filterConditionalComponents(viewModel: FormPageViewModel, model: FormModel, evaluationState: Partial<Record<string, FormStateValue>>): import("~/src/server/plugins/engine/components/types.js").ComponentViewModel[];
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    hasMissingNotificationEmail(request: FormRequest, context: FormContext): Promise<boolean>;
+    /**
+     * Get the back link for a given progress.
+     */
+    protected getBackLink(request: FormContextRequest, context: FormContext): BackLink | undefined;
+    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    proceed(request: FormContextRequest, h: Pick<ResponseToolkit, 'redirect' | 'view'>, nextPath?: string): import("@hapi/hapi").ResponseObject;
+    /**
+     * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+     */
+    get getRouteOptions(): RouteOptions<FormRequestRefs>;
+    /**
+     * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+     */
+    get postRouteOptions(): RouteOptions<FormRequestPayloadRefs>;
+}

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

@@ -0,0 +1,35 @@
+import { type PageRepeat, type Repeat } from '@defra/forms-model';
+import { type ResponseToolkit } from '@hapi/hapi';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FormContext, type FormContextRequest, type FormPageViewModel, type FormPayload, type FormSubmissionState, type RepeatItemState, type RepeatListState, type RepeaterSummaryPageViewModel } from '~/src/server/plugins/engine/types.js';
+import { FormAction, type FormRequest, type FormRequestPayload } from '~/src/server/routes/types.js';
+export declare class RepeatPageController extends QuestionPageController {
+    pageDef: PageRepeat;
+    listSummaryViewName: string;
+    listDeleteViewName: string;
+    repeat: Repeat;
+    constructor(model: FormModel, pageDef: PageRepeat);
+    get keys(): string[];
+    getFormParams(request?: FormContextRequest): import("~/src/server/plugins/engine/types.js").FormParams;
+    getFormDataFromState(request: FormContextRequest | undefined, state: FormSubmissionState): {
+        action?: FormAction;
+        confirm?: true;
+        crumb?: string;
+        itemId?: string;
+    };
+    getStateFromValidForm(request: FormContextRequest, state: FormSubmissionState, payload: FormPayload): {
+        [x: string]: RepeatItemState[];
+    };
+    proceed(request: FormContextRequest, h: Pick<ResponseToolkit, 'redirect' | 'view'>): import("@hapi/hapi").ResponseObject;
+    getItemFromList(list: RepeatListState, itemId?: string): RepeatItemState | undefined;
+    getListFromState(state: FormSubmissionState): RepeatListState;
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    makeGetListSummaryRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
+    makePostListSummaryRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
+    makeGetItemDeleteRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => import("@hapi/hapi").ResponseObject;
+    makePostItemDeleteRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    getViewModel(request: FormContextRequest, context: FormContext): FormPageViewModel;
+    getListSummaryViewModel(request: FormContextRequest, context: FormContext, list: RepeatListState): RepeaterSummaryPageViewModel;
+    getSummaryPath(request?: FormContextRequest): string;
+}

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

@@ -0,0 +1,50 @@
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FormContext } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest } from '~/src/server/routes/types.js';
+export declare class StartPageController extends QuestionPageController {
+    /**
+     * The controller which is used when Page["controller"] is defined as "./pages/start.js"
+     * This page should not be used in production. This page is helpful for prototyping start pages within the app,
+     * but start pages should really live on gov.uk (whitehall publisher) so a user can be properly signposted.
+     */
+    getViewModel(request: FormRequest, context: FormContext): {
+        isStartPage: boolean;
+        components: import("../components/types.js").ComponentViewModel[];
+        context: FormContext;
+        errors?: import("~/src/server/plugins/engine/types.js").FormSubmissionError[];
+        hasMissingNotificationEmail?: boolean;
+        page: import("./PageController.js").PageController;
+        name?: string;
+        pageTitle: string;
+        sectionTitle?: string;
+        showTitle: boolean;
+        backLink?: import("../components/types.js").BackLink;
+        feedbackLink?: string;
+        serviceUrl: string;
+        phaseTag?: string;
+        /**
+         * - Base layout path
+         */
+        baseLayoutPath?: string | undefined;
+        /**
+         * - Cross-Site Request Forgery (CSRF) token
+         */
+        crumb?: string | undefined;
+        /**
+         * - Content Security Policy (CSP) nonce
+         */
+        cspNonce?: string | undefined;
+        /**
+         * - Current path
+         */
+        currentPath?: string | undefined;
+        /**
+         * - Preview mode
+         */
+        previewMode?: string | undefined;
+        /**
+         * - Form slug
+         */
+        slug?: string | undefined;
+    };
+}

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

@@ -0,0 +1,12 @@
+import { type PageStatus } from '@defra/forms-model';
+import { type ResponseToolkit } from '@hapi/hapi';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FormContext } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest } from '~/src/server/routes/types.js';
+export declare class StatusPageController extends QuestionPageController {
+    pageDef: PageStatus;
+    constructor(model: FormModel, pageDef: PageStatus);
+    getRelevantPath(): string;
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+}

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

@@ -0,0 +1,26 @@
+import { type Page } from '@defra/forms-model';
+import { type ResponseToolkit, type RouteOptions } from '@hapi/hapi';
+import { SummaryViewModel, type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type Detail, type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FormContext, type FormContextRequest } from '~/src/server/plugins/engine/types.js';
+import { type FormRequest, type FormRequestPayload, type FormRequestPayloadRefs } from '~/src/server/routes/types.js';
+export declare class SummaryPageController extends QuestionPageController {
+    pageDef: Page;
+    /**
+     * The controller which is used when Page["controller"] is defined as "./pages/summary.js"
+     */
+    constructor(model: FormModel, pageDef: Page);
+    getSummaryViewModel(request: FormContextRequest, context: FormContext): SummaryViewModel;
+    /**
+     * Returns an async function. This is called in plugin.ts when there is a GET request at `/{id}/{path*}`,
+     */
+    makeGetRouteHandler(): (request: FormRequest, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    /**
+     * Returns an async function. This is called in plugin.ts when there is a POST request at `/{id}/{path*}`.
+     * If a form is incomplete, a user will be redirected to the start page.
+     */
+    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, "redirect" | "view">) => Promise<import("@hapi/hapi").ResponseObject>;
+    get postRouteOptions(): RouteOptions<FormRequestPayloadRefs>;
+}
+export declare function getFormSubmissionData(context: FormContext, details: Detail[]): DetailItem[];

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

@@ -0,0 +1,9 @@
+import { type PageTerminal } from '@defra/forms-model';
+import { type ResponseObject, type ResponseToolkit } from '@hapi/hapi';
+import { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+import { type FormContext } from '~/src/server/plugins/engine/types.js';
+import { type FormRequestPayload } from '~/src/server/routes/types.js';
+export declare class TerminalPageController extends QuestionPageController {
+    pageDef: PageTerminal;
+    makePostRouteHandler(): (request: FormRequestPayload, context: FormContext, h: Pick<ResponseToolkit, 'redirect' | 'view'>) => Promise<ResponseObject>;
+}

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

@@ -0,0 +1,19 @@
+import { ControllerType, type Page } from '@defra/forms-model';
+import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js';
+import * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js';
+export declare function isPageController(controllerName?: string | ControllerType): controllerName is keyof typeof PageControllers;
+export type PageControllerClass = InstanceType<PageControllerType>;
+export type PageControllerType = (typeof PageControllers)[keyof typeof PageControllers];
+/**
+ * Creates page instance for each {@link Page} type
+ */
+export declare function createPage(model: FormModel, pageDef: Page): PageControllerClass;
+/**
+ * In local development environments, we sometimes need to rewrite the
+ * CDP upload URL to work with CSP/CORS restrictions.
+ * This helper function rewrites localhost URLs to use the sslip.io proxy
+ * This is only used when running locally with a development proxy.
+ * In non-local environments, this function returns null
+ * @param uploadUrl - The original upload URL from CDP
+ */
+export declare function getProxyUrlForLocalDevelopment(uploadUrl?: string): string | null;

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

@@ -0,0 +1,8 @@
+export { StartPageController } from '~/src/server/plugins/engine/pageControllers/StartPageController.js';
+export { QuestionPageController, // Export alongside alias
+QuestionPageController as PageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js';
+export { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/TerminalPageController.js';
+export { SummaryPageController } from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js';
+export { StatusPageController } from '~/src/server/plugins/engine/pageControllers/StatusPageController.js';
+export { FileUploadPageController } from '~/src/server/plugins/engine/pageControllers/FileUploadPageController.js';
+export { RepeatPageController } from '~/src/server/plugins/engine/pageControllers/RepeatPageController.js';

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

@@ -0,0 +1,8 @@
+import { type JoiExpression, type LanguageMessages, type LanguageMessagesExt, type ValidationOptions } from 'joi';
+/**
+ * see @link https://joi.dev/api/?v=17.4.2#template-syntax for template syntax
+ */
+export declare const messageTemplate: Record<string, JoiExpression>;
+export declare const messages: LanguageMessagesExt;
+export declare const messagesPre: LanguageMessages;
+export declare const validationOptions: ValidationOptions;

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

@@ -0,0 +1,33 @@
+import { type PluginProperties, type Server } from '@hapi/hapi';
+import { type Environment } from 'nunjucks';
+import { FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
+import { type FilterFunction } from '~/src/server/plugins/engine/types.js';
+import { type Services } from '~/src/server/types.js';
+export declare function findPackageRoot(): string;
+export interface PluginOptions {
+    model?: FormModel;
+    services?: Services;
+    controllers?: Record<string, typeof PageController>;
+    cacheName?: string;
+    filters?: Record<string, FilterFunction>;
+    pluginPath?: string;
+    nunjucks: {
+        baseLayoutPath: string;
+        paths: string[];
+    };
+    viewContext: PluginProperties['forms-engine-plugin']['viewContext'];
+}
+export declare const plugin: {
+    name: string;
+    dependencies: string[];
+    multiple: true;
+    register(server: Server, options: PluginOptions): Promise<void>;
+};
+interface CompileOptions {
+    environment: Environment;
+}
+export interface EngineConfigurationObject {
+    compileOptions: CompileOptions;
+}
+export {};

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

@@ -0,0 +1,5 @@
+/**
+ * Generates a reference number in the format of `XXX-XXX-XXX`, or `PREFIX-XXX-XXX` if a prefix is provided.
+ * Provides no guarantee on uniqueness.
+ */
+export declare function generateUniqueReference(prefix?: string): string;

package/.server/server/plugins/engine/services/formSubmissionService.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Persist files by extending the time-to-live to 30 days
+ * @param {{fileId: string, initiatedRetrievalKey: string}[]} files - batch of files to persist
+ * @param {string} persistedRetrievalKey - final retrieval key when submitting
+ */
+export function persistFiles(files: {
+    fileId: string;
+    initiatedRetrievalKey: string;
+}[], persistedRetrievalKey: string): Promise<{
+    res: import("http").IncomingMessage;
+    error: object | Error;
+    payload?: undefined;
+} | {
+    res: import("http").IncomingMessage;
+    payload: object;
+    error?: undefined;
+}>;
+/**
+ * Submit form
+ * @param {SubmitPayload} data - submission data
+ */
+export function submit(data: SubmitPayload): Promise<SubmitResponsePayload | undefined>;
+import type { SubmitPayload } from '@defra/forms-model';
+import type { SubmitResponsePayload } from '@defra/forms-model';