@defra/forms-engine-plugin 0.1.18 → 0.1.20

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

@@ -0,0 +1,16 @@
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _slug - the slug of the form
+ * @returns {Promise<FormMetadata>}
+ */
+export function getFormMetadata(_slug: string): Promise<FormMetadata>;
+/**
+ * Dummy function to get form metadata.
+ * @param {string} _id - the id of the form
+ * @param {FormStatus} _state - the state of the form
+ * @returns {Promise<FormDefinition | undefined>}
+ */
+export function getFormDefinition(_id: string, _state: FormStatus): Promise<FormDefinition | undefined>;
+import type { FormMetadata } from '@defra/forms-model';
+import type { FormStatus } from '@defra/forms-model';
+import type { FormDefinition } from '@defra/forms-model';

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

@@ -0,0 +1,3 @@
+export * as formsService from "~/src/server/plugins/engine/services/formsService.js";
+export * as formSubmissionService from "~/src/server/plugins/engine/services/formSubmissionService.js";
+export * as outputService from "~/src/server/plugins/engine/services/notifyService.js";

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

@@ -0,0 +1 @@
+export function formsService(): Promise<import("../../../types.js").FormsService>;

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

@@ -0,0 +1,5 @@
+import { type SubmitResponsePayload } from '@defra/forms-model';
+import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
+import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
+import { type FormRequestPayload } from '~/src/server/routes/types.js';
+export declare function submit(request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload): Promise<void>;

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

@@ -0,0 +1,14 @@
+/**
+ * Initiates a CDP file upload
+ * @param {string} path - the path of the page in the form
+ * @param {string} retrievalKey - the retrieval key for the files
+ * @param {string} [mimeTypesCsv] - the csv string of accepted mimeTypes
+ */
+export function initiateUpload(path: string, retrievalKey: string, mimeTypesCsv?: string): Promise<UploadInitiateResponse | undefined>;
+/**
+ * Get the status of a CDP file upload
+ * @param {string} uploadId - the ID of the upload
+ */
+export function getUploadStatus(uploadId: string): Promise<UploadStatusResponse | undefined>;
+import type { UploadInitiateResponse } from '~/src/server/plugins/engine/types.js';
+import type { UploadStatusResponse } from '~/src/server/plugins/engine/types.js';

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

@@ -0,0 +1,256 @@
+import { type ComponentDef, type Item, type List, type Page } from '@defra/forms-model';
+import { type JoiExpression, type ValidationErrorItem } from 'joi';
+import { type Component } from '~/src/server/plugins/engine/components/helpers.js';
+import { type BackLink, type ComponentText, type ComponentViewModel } from '~/src/server/plugins/engine/components/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 ViewContext } from '~/src/server/plugins/nunjucks/types.js';
+import { type FormAction, type FormRequest } from '~/src/server/routes/types.js';
+/**
+ * Form submission state stores the following in Redis:
+ * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`
+ *   a) . e.g:
+ * ```ts
+ *     {
+ *       _C9PRHmsgt: 'Ben',
+ *       WfLk9McjzX: 'Music',
+ *       IK7jkUFCBL: 'Royal Academy of Music'
+ *     }
+ * ```
+ *
+ *   b)
+ * ```ts
+ *   {
+ *         checkBeforeYouStart: { ukPassport: true },
+ *         applicantDetails: {
+ *           numberOfApplicants: 1,
+ *           phoneNumber: '77777777',
+ *           emailAddress: 'aaa@aaa.com'
+ *         },
+ *         applicantOneDetails: {
+ *           firstName: 'a',
+ *           middleName: 'a',
+ *           lastName: 'a',
+ *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }
+ *         }
+ *     }
+ * ```
+ */
+/**
+ * Form submission state
+ */
+export type FormSubmissionState = {
+    upload?: Record<string, TempFileState>;
+} & FormState;
+export interface FormSubmissionError extends Pick<ValidationErrorItem, 'context' | 'path'> {
+    href: string;
+    name: string;
+    text: string;
+}
+export interface FormParams {
+    action?: FormAction;
+    confirm?: true;
+    crumb?: string;
+    itemId?: string;
+}
+/**
+ * Form POST for question pages
+ * (after Joi has converted value types)
+ */
+export type FormPayload = FormParams & Partial<Record<string, FormValue>>;
+export type FormValue = Item['value'] | Item['value'][] | UploadState | RepeatListState | undefined;
+export type FormState = Partial<Record<string, FormStateValue>>;
+export type FormStateValue = Exclude<FormValue, undefined> | null;
+export interface FormValidationResult<ValueType extends FormPayload | FormSubmissionState> {
+    value: ValueType;
+    errors: FormSubmissionError[] | undefined;
+}
+export interface FormContext {
+    /**
+     * Evaluation form state only (filtered by visited paths),
+     * with values formatted for condition evaluation using
+     * {@link FormComponent.getContextValueFromState}
+     */
+    evaluationState: FormState;
+    /**
+     * Relevant form state only (filtered by visited paths)
+     */
+    relevantState: FormState;
+    /**
+     * Relevant pages only (filtered by visited paths)
+     */
+    relevantPages: PageControllerClass[];
+    /**
+     * Form submission payload (single page)
+     */
+    payload: FormPayload;
+    /**
+     * Form submission state (entire form)
+     */
+    state: FormSubmissionState;
+    /**
+     * Validation errors (entire form)
+     */
+    errors?: FormSubmissionError[];
+    /**
+     * Visited paths evaluated from form state
+     */
+    paths: string[];
+    /**
+     * Preview URL direct access is allowed
+     */
+    isForceAccess: boolean;
+    /**
+     * Miscellaneous extra data from event responses
+     */
+    data: object;
+    pageDefMap: Map<string, Page>;
+    listDefMap: Map<string, List>;
+    componentDefMap: Map<string, ComponentDef>;
+    pageMap: Map<string, PageControllerClass>;
+    componentMap: Map<string, Component>;
+    referenceNumber: string;
+}
+export type FormContextRequest = ({
+    method: 'get';
+    payload?: undefined;
+} | {
+    method: 'post';
+    payload: FormPayload;
+} | {
+    method: FormRequest['method'];
+    payload?: object | undefined;
+}) & Pick<FormRequest, 'app' | 'method' | 'params' | 'path' | 'query' | 'url'>;
+export interface UploadInitiateResponse {
+    uploadId: string;
+    uploadUrl: string;
+    statusUrl: string;
+}
+export declare enum UploadStatus {
+    initiated = "initiated",
+    pending = "pending",
+    ready = "ready"
+}
+export declare enum FileStatus {
+    complete = "complete",
+    rejected = "rejected",
+    pending = "pending"
+}
+export type UploadState = FileState[];
+export type FileUpload = {
+    fileId: string;
+    filename: string;
+    contentLength: number;
+} & ({
+    fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending;
+    errorMessage?: string;
+} | {
+    fileStatus: FileStatus.complete;
+    errorMessage?: undefined;
+});
+export interface FileUploadMetadata {
+    retrievalKey: string;
+}
+export type UploadStatusResponse = {
+    uploadStatus: UploadStatus.initiated;
+    metadata: FileUploadMetadata;
+    form: {
+        file?: undefined;
+    };
+} | {
+    uploadStatus: UploadStatus.pending | UploadStatus.ready;
+    metadata: FileUploadMetadata;
+    form: {
+        file: FileUpload;
+    };
+    numberOfRejectedFiles?: number;
+} | {
+    uploadStatus: UploadStatus.ready;
+    metadata: FileUploadMetadata;
+    form: {
+        file: FileUpload;
+    };
+    numberOfRejectedFiles: 0;
+};
+export type UploadStatusFileResponse = Exclude<UploadStatusResponse, {
+    uploadStatus: UploadStatus.initiated;
+}>;
+export interface FileState {
+    uploadId: string;
+    status: UploadStatusFileResponse;
+}
+export interface TempFileState {
+    upload?: UploadInitiateResponse;
+    files: UploadState;
+}
+export interface RepeatItemState extends FormPayload {
+    itemId: string;
+}
+export type RepeatListState = RepeatItemState[];
+export interface CheckAnswers {
+    title?: ComponentText;
+    summaryList: SummaryList;
+}
+export interface SummaryList {
+    classes?: string;
+    rows: SummaryListRow[];
+}
+export interface SummaryListRow {
+    key: ComponentText;
+    value: ComponentText;
+    actions?: {
+        items: SummaryListAction[];
+    };
+}
+export type SummaryListAction = ComponentText & {
+    href: string;
+    visuallyHiddenText: string;
+};
+export interface PageViewModelBase extends Partial<ViewContext> {
+    page: PageController;
+    name?: string;
+    pageTitle: string;
+    sectionTitle?: string;
+    showTitle: boolean;
+    isStartPage: boolean;
+    backLink?: BackLink;
+    feedbackLink?: string;
+    serviceUrl: string;
+    phaseTag?: string;
+}
+export interface ItemDeletePageViewModel extends PageViewModelBase {
+    context: FormContext;
+    itemTitle: string;
+    confirmation?: ComponentText;
+    buttonConfirm: ComponentText;
+    buttonCancel: ComponentText;
+}
+export interface FormPageViewModel extends PageViewModelBase {
+    components: ComponentViewModel[];
+    context: FormContext;
+    errors?: FormSubmissionError[];
+    hasMissingNotificationEmail?: boolean;
+}
+export interface RepeaterSummaryPageViewModel extends PageViewModelBase {
+    context: FormContext;
+    errors?: FormSubmissionError[];
+    checkAnswers: CheckAnswers[];
+    repeatTitle: string;
+}
+export interface FeaturedFormPageViewModel extends FormPageViewModel {
+    formAction?: string;
+    formComponent: ComponentViewModel;
+    componentsBefore: ComponentViewModel[];
+    uploadId: string | undefined;
+    proxyUrl: string | null;
+}
+export type PageViewModel = PageViewModelBase | ItemDeletePageViewModel | FormPageViewModel | RepeaterSummaryPageViewModel | FeaturedFormPageViewModel;
+export type FilterFunction = (value: unknown) => unknown;
+export interface ErrorMessageTemplate {
+    type: string;
+    template: JoiExpression;
+}
+export interface ErrorMessageTemplateList {
+    baseErrors: ErrorMessageTemplate[];
+    advancedSettingsErrors: ErrorMessageTemplate[];
+}

package/.server/server/plugins/errorPages.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    plugin: {
+        name: string;
+        register(server: import("@hapi/hapi").Server<import("@hapi/hapi").ServerApplicationState>): void;
+    };
+};
+export default _default;

package/.server/server/plugins/nunjucks/context.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @param {FormRequest | FormRequestPayload | null} request
+ */
+export function context(request: FormRequest | FormRequestPayload | null): Promise<ViewContext>;
+/**
+ * Returns the context for the devtool. Consumers won't have access to this.
+ * @param {FormRequest | FormRequestPayload | null} _request
+ * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}
+ */
+export function devtoolContext(_request: FormRequest | FormRequestPayload | null): Record<string, unknown> & {
+    assetPath: string;
+    getDxtAssetPath: (asset: string) => string;
+};
+import type { FormRequest } from '~/src/server/routes/types.js';
+import type { FormRequestPayload } from '~/src/server/routes/types.js';
+import type { ViewContext } from '~/src/server/plugins/nunjucks/types.js';

package/.server/server/plugins/nunjucks/context.js

@@ -2,7 +2,6 @@ import { readFileSync } from 'node:fs';
 import { basename, join } from 'node:path';
 import Boom from '@hapi/boom';
 import { StatusCodes } from 'http-status-codes';
-import pkg from "../../../../package.json" with { type: 'json' };
 import { config } from "../../../config/index.js";
 import { createLogger } from "../../common/helpers/logging/logger.js";
 import { checkFormStatus, encodeUrl, safeGenerateCrumb } from "../engine/helpers.js";
@@ -44,15 +43,6 @@ export async function context(request) {
     // take consumers props first so we can override it
     ...consumerViewContext,
     baseLayoutPath: pluginStorage.baseLayoutPath,
-    appVersion: pkg.version,
-    config: {
-      cdpEnvironment: config.get('cdpEnvironment'),
-      designerUrl: config.get('designerUrl'),
-      feedbackLink: encodeUrl(config.get('feedbackLink')),
-      phaseTag: config.get('phaseTag'),
-      serviceName: config.get('serviceName'),
-      serviceVersion: config.get('serviceVersion')
-    },
     crumb: safeGenerateCrumb(request),
     currentPath: `${request.path}${request.url.search}`,
     previewMode: isPreviewMode ? formState : undefined,
@@ -77,6 +67,14 @@ export function devtoolContext(_request) {
     }
   }
   return {
+    config: {
+      cdpEnvironment: config.get('cdpEnvironment'),
+      designerUrl: config.get('designerUrl'),
+      feedbackLink: encodeUrl(config.get('feedbackLink')),
+      phaseTag: config.get('phaseTag'),
+      serviceName: config.get('serviceName'),
+      serviceVersion: config.get('serviceVersion')
+    },
     assetPath: '/assets',
     getDxtAssetPath: (asset = '') => {
       return `/${webpackManifest?.[asset] ?? asset}`;

package/.server/server/plugins/nunjucks/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","pkg","type","config","createLogger","checkFormStatus","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","params","response","isPreview","isPreviewMode","state","formState","isResponseOK","isBoom","statusCode","OK","pluginStorage","server","plugins","consumerViewContext","Error","baseLayoutPath","viewContext","ctx","appVersion","version","cdpEnvironment","get","designerUrl","feedbackLink","phaseTag","serviceName","serviceVersion","crumb","currentPath","path","url","search","previewMode","undefined","slug","devtoolContext","_request","manifestPath","JSON","parse","error","assetPath","getDxtAssetPath","asset"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport pkg from '~/package.json' with { type: 'json' }\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  checkFormStatus,\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {FormRequest | FormRequestPayload | null} request\n */\nexport async function context(request) {\n  const { params, response } = request ?? {}\n\n  const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  const pluginStorage = request?.server.plugins['forms-engine-plugin']\n  let consumerViewContext = {}\n\n  if (!pluginStorage) {\n    throw Error('context called before plugin registered')\n  }\n\n  if (!pluginStorage.baseLayoutPath) {\n    throw Error('Missing baseLayoutPath in plugin.options.nunjucks')\n  }\n\n  if (typeof pluginStorage.viewContext === 'function') {\n    consumerViewContext = await pluginStorage.viewContext(request)\n  }\n\n  /** @type {ViewContext} */\n  const ctx = {\n    // take consumers props first so we can override it\n    ...consumerViewContext,\n    baseLayoutPath: pluginStorage.baseLayoutPath,\n    appVersion: pkg.version,\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    crumb: safeGenerateCrumb(request),\n    currentPath: `${request.path}${request.url.search}`,\n    previewMode: isPreviewMode ? formState : undefined,\n    slug: isResponseOK ? params?.slug : undefined\n  }\n\n  return ctx\n}\n\n/**\n * Returns the context for the devtool. Consumers won't have access to this.\n * @param {FormRequest | FormRequestPayload | null} _request\n * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}\n */\nexport function devtoolContext(_request) {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.error(`Webpack ${basename(manifestPath)} not found`)\n    }\n  }\n\n  return {\n    assetPath: '/assets',\n    getDxtAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n}\n\n/**\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,OAAOC,GAAG,wCAA8BC,IAAI,EAAE,MAAM;AACpD,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SACEC,eAAe,EACfC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,eAAeC,OAAOA,CAACC,OAAO,EAAE;EACrC,MAAM;IAAEC,MAAM;IAAEC;EAAS,CAAC,GAAGF,OAAO,IAAI,CAAC,CAAC;EAE1C,MAAM;IAAEG,SAAS,EAAEC,aAAa;IAAEC,KAAK,EAAEC;EAAU,CAAC,GAAGZ,eAAe,CAACO,MAAM,CAAC;;EAE9E;EACA;EACA,MAAMM,YAAY,GAChB,CAACnB,IAAI,CAACoB,MAAM,CAACN,QAAQ,CAAC,IAAIA,QAAQ,EAAEO,UAAU,KAAKpB,WAAW,CAACqB,EAAE;EAEnE,MAAMC,aAAa,GAAGX,OAAO,EAAEY,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;EACpE,IAAIC,mBAAmB,GAAG,CAAC,CAAC;EAE5B,IAAI,CAACH,aAAa,EAAE;IAClB,MAAMI,KAAK,CAAC,yCAAyC,CAAC;EACxD;EAEA,IAAI,CAACJ,aAAa,CAACK,cAAc,EAAE;IACjC,MAAMD,KAAK,CAAC,mDAAmD,CAAC;EAClE;EAEA,IAAI,OAAOJ,aAAa,CAACM,WAAW,KAAK,UAAU,EAAE;IACnDH,mBAAmB,GAAG,MAAMH,aAAa,CAACM,WAAW,CAACjB,OAAO,CAAC;EAChE;;EAEA;EACA,MAAMkB,GAAG,GAAG;IACV;IACA,GAAGJ,mBAAmB;IACtBE,cAAc,EAAEL,aAAa,CAACK,cAAc;IAC5CG,UAAU,EAAE7B,GAAG,CAAC8B,OAAO;IACvB5B,MAAM,EAAE;MACN6B,cAAc,EAAE7B,MAAM,CAAC8B,GAAG,CAAC,gBAAgB,CAAC;MAC5CC,WAAW,EAAE/B,MAAM,CAAC8B,GAAG,CAAC,aAAa,CAAC;MACtCE,YAAY,EAAE7B,SAAS,CAACH,MAAM,CAAC8B,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDG,QAAQ,EAAEjC,MAAM,CAAC8B,GAAG,CAAC,UAAU,CAAC;MAChCI,WAAW,EAAElC,MAAM,CAAC8B,GAAG,CAAC,aAAa,CAAC;MACtCK,cAAc,EAAEnC,MAAM,CAAC8B,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACDM,KAAK,EAAEhC,iBAAiB,CAACI,OAAO,CAAC;IACjC6B,WAAW,EAAE,GAAG7B,OAAO,CAAC8B,IAAI,GAAG9B,OAAO,CAAC+B,GAAG,CAACC,MAAM,EAAE;IACnDC,WAAW,EAAE7B,aAAa,GAAGE,SAAS,GAAG4B,SAAS;IAClDC,IAAI,EAAE5B,YAAY,GAAGN,MAAM,EAAEkC,IAAI,GAAGD;EACtC,CAAC;EAED,OAAOhB,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASkB,cAAcA,CAACC,QAAQ,EAAE;EACvC,MAAMC,YAAY,GAAGnD,IAAI,CAACK,MAAM,CAAC8B,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAACxB,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGyC,IAAI,CAACC,KAAK,CAACvD,YAAY,CAACqD,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNzC,MAAM,CAAC4C,KAAK,CAAC,WAAWvD,QAAQ,CAACoD,YAAY,CAAC,YAAY,CAAC;IAC7D;EACF;EAEA,OAAO;IACLI,SAAS,EAAE,SAAS;IACpBC,eAAe,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC/B,OAAO,IAAI9C,eAAe,GAAG8C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"context.js","names":["readFileSync","basename","join","Boom","StatusCodes","config","createLogger","checkFormStatus","encodeUrl","safeGenerateCrumb","logger","webpackManifest","context","request","params","response","isPreview","isPreviewMode","state","formState","isResponseOK","isBoom","statusCode","OK","pluginStorage","server","plugins","consumerViewContext","Error","baseLayoutPath","viewContext","ctx","crumb","currentPath","path","url","search","previewMode","undefined","slug","devtoolContext","_request","manifestPath","get","JSON","parse","error","cdpEnvironment","designerUrl","feedbackLink","phaseTag","serviceName","serviceVersion","assetPath","getDxtAssetPath","asset"],"sources":["../../../../src/server/plugins/nunjucks/context.js"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { basename, join } from 'node:path'\n\nimport Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\n\nimport { config } from '~/src/config/index.js'\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  checkFormStatus,\n  encodeUrl,\n  safeGenerateCrumb\n} from '~/src/server/plugins/engine/helpers.js'\n\nconst logger = createLogger()\n\n/** @type {Record<string, string> | undefined} */\nlet webpackManifest\n\n/**\n * @param {FormRequest | FormRequestPayload | null} request\n */\nexport async function context(request) {\n  const { params, response } = request ?? {}\n\n  const { isPreview: isPreviewMode, state: formState } = checkFormStatus(params)\n\n  // Only add the slug in to the context if the response is OK.\n  // Footer meta links are not rendered when the slug is missing.\n  const isResponseOK =\n    !Boom.isBoom(response) && response?.statusCode === StatusCodes.OK\n\n  const pluginStorage = request?.server.plugins['forms-engine-plugin']\n\n  let consumerViewContext = {}\n\n  if (!pluginStorage) {\n    throw Error('context called before plugin registered')\n  }\n\n  if (!pluginStorage.baseLayoutPath) {\n    throw Error('Missing baseLayoutPath in plugin.options.nunjucks')\n  }\n\n  if (typeof pluginStorage.viewContext === 'function') {\n    consumerViewContext = await pluginStorage.viewContext(request)\n  }\n\n  /** @type {ViewContext} */\n  const ctx = {\n    // take consumers props first so we can override it\n    ...consumerViewContext,\n    baseLayoutPath: pluginStorage.baseLayoutPath,\n    crumb: safeGenerateCrumb(request),\n    currentPath: `${request.path}${request.url.search}`,\n    previewMode: isPreviewMode ? formState : undefined,\n    slug: isResponseOK ? params?.slug : undefined\n  }\n\n  return ctx\n}\n\n/**\n * Returns the context for the devtool. Consumers won't have access to this.\n * @param {FormRequest | FormRequestPayload | null} _request\n * @returns {Record<string, unknown> & { assetPath: string, getDxtAssetPath: (asset: string) => string }}\n */\nexport function devtoolContext(_request) {\n  const manifestPath = join(config.get('publicDir'), 'assets-manifest.json')\n\n  if (!webpackManifest) {\n    try {\n      // eslint-disable-next-line -- Allow JSON type 'any'\n      webpackManifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))\n    } catch {\n      logger.error(`Webpack ${basename(manifestPath)} not found`)\n    }\n  }\n\n  return {\n    config: {\n      cdpEnvironment: config.get('cdpEnvironment'),\n      designerUrl: config.get('designerUrl'),\n      feedbackLink: encodeUrl(config.get('feedbackLink')),\n      phaseTag: config.get('phaseTag'),\n      serviceName: config.get('serviceName'),\n      serviceVersion: config.get('serviceVersion')\n    },\n    assetPath: '/assets',\n    getDxtAssetPath: (asset = '') => {\n      return `/${webpackManifest?.[asset] ?? asset}`\n    }\n  }\n}\n\n/**\n * @import { ViewContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { FormRequest, FormRequestPayload } from '~/src/server/routes/types.js'\n */\n"],"mappings":"AAAA,SAASA,YAAY,QAAQ,SAAS;AACtC,SAASC,QAAQ,EAAEC,IAAI,QAAQ,WAAW;AAE1C,OAAOC,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM;AACf,SAASC,YAAY;AACrB,SACEC,eAAe,EACfC,SAAS,EACTC,iBAAiB;AAGnB,MAAMC,MAAM,GAAGJ,YAAY,CAAC,CAAC;;AAE7B;AACA,IAAIK,eAAe;;AAEnB;AACA;AACA;AACA,OAAO,eAAeC,OAAOA,CAACC,OAAO,EAAE;EACrC,MAAM;IAAEC,MAAM;IAAEC;EAAS,CAAC,GAAGF,OAAO,IAAI,CAAC,CAAC;EAE1C,MAAM;IAAEG,SAAS,EAAEC,aAAa;IAAEC,KAAK,EAAEC;EAAU,CAAC,GAAGZ,eAAe,CAACO,MAAM,CAAC;;EAE9E;EACA;EACA,MAAMM,YAAY,GAChB,CAACjB,IAAI,CAACkB,MAAM,CAACN,QAAQ,CAAC,IAAIA,QAAQ,EAAEO,UAAU,KAAKlB,WAAW,CAACmB,EAAE;EAEnE,MAAMC,aAAa,GAAGX,OAAO,EAAEY,MAAM,CAACC,OAAO,CAAC,qBAAqB,CAAC;EAEpE,IAAIC,mBAAmB,GAAG,CAAC,CAAC;EAE5B,IAAI,CAACH,aAAa,EAAE;IAClB,MAAMI,KAAK,CAAC,yCAAyC,CAAC;EACxD;EAEA,IAAI,CAACJ,aAAa,CAACK,cAAc,EAAE;IACjC,MAAMD,KAAK,CAAC,mDAAmD,CAAC;EAClE;EAEA,IAAI,OAAOJ,aAAa,CAACM,WAAW,KAAK,UAAU,EAAE;IACnDH,mBAAmB,GAAG,MAAMH,aAAa,CAACM,WAAW,CAACjB,OAAO,CAAC;EAChE;;EAEA;EACA,MAAMkB,GAAG,GAAG;IACV;IACA,GAAGJ,mBAAmB;IACtBE,cAAc,EAAEL,aAAa,CAACK,cAAc;IAC5CG,KAAK,EAAEvB,iBAAiB,CAACI,OAAO,CAAC;IACjCoB,WAAW,EAAE,GAAGpB,OAAO,CAACqB,IAAI,GAAGrB,OAAO,CAACsB,GAAG,CAACC,MAAM,EAAE;IACnDC,WAAW,EAAEpB,aAAa,GAAGE,SAAS,GAAGmB,SAAS;IAClDC,IAAI,EAAEnB,YAAY,GAAGN,MAAM,EAAEyB,IAAI,GAAGD;EACtC,CAAC;EAED,OAAOP,GAAG;AACZ;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASS,cAAcA,CAACC,QAAQ,EAAE;EACvC,MAAMC,YAAY,GAAGxC,IAAI,CAACG,MAAM,CAACsC,GAAG,CAAC,WAAW,CAAC,EAAE,sBAAsB,CAAC;EAE1E,IAAI,CAAChC,eAAe,EAAE;IACpB,IAAI;MACF;MACAA,eAAe,GAAGiC,IAAI,CAACC,KAAK,CAAC7C,YAAY,CAAC0C,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,MAAM;MACNhC,MAAM,CAACoC,KAAK,CAAC,WAAW7C,QAAQ,CAACyC,YAAY,CAAC,YAAY,CAAC;IAC7D;EACF;EAEA,OAAO;IACLrC,MAAM,EAAE;MACN0C,cAAc,EAAE1C,MAAM,CAACsC,GAAG,CAAC,gBAAgB,CAAC;MAC5CK,WAAW,EAAE3C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCM,YAAY,EAAEzC,SAAS,CAACH,MAAM,CAACsC,GAAG,CAAC,cAAc,CAAC,CAAC;MACnDO,QAAQ,EAAE7C,MAAM,CAACsC,GAAG,CAAC,UAAU,CAAC;MAChCQ,WAAW,EAAE9C,MAAM,CAACsC,GAAG,CAAC,aAAa,CAAC;MACtCS,cAAc,EAAE/C,MAAM,CAACsC,GAAG,CAAC,gBAAgB;IAC7C,CAAC;IACDU,SAAS,EAAE,SAAS;IACpBC,eAAe,EAAEA,CAACC,KAAK,GAAG,EAAE,KAAK;MAC/B,OAAO,IAAI5C,eAAe,GAAG4C,KAAK,CAAC,IAAIA,KAAK,EAAE;IAChD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/nunjucks/environment.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @this {NunjucksContext}
+ * @param {FormSubmissionError[]} errors
+ */
+export function checkErrorTemplates(this: NunjucksContext, errors: FormSubmissionError[]): FormSubmissionError[];
+/**
+ * @this {NunjucksContext}
+ * @param {ComponentViewModel} component
+ */
+export function checkComponentTemplates(this: NunjucksContext, component: ComponentViewModel): ComponentViewModel;
+/**
+ * @this {NunjucksContext}
+ * @param {string} template
+ */
+export function evaluate(this: NunjucksContext, template: string): string;
+export const paths: string[];
+export const environment: nunjucks.Environment;
+import type { FormSubmissionError } from '~/src/server/plugins/engine/types.js';
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';
+import type { ComponentViewModel } from '~/src/server/plugins/engine/components/types.js';
+import nunjucks from 'nunjucks';

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

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the answer for a component
+ * @this {NunjucksContext}
+ * @param {string} name - The name of the component to check
+ */
+export function answer(this: NunjucksContext, name: string): string | undefined;
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

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

@@ -0,0 +1,8 @@
+/**
+ * Nunjucks filter to evaluate a liquid template.
+ * Currently just used in `src/server/views/layout.html#LN37` for the pageTitle
+ * @this {NunjucksContext}
+ * @param {string} template
+ */
+export function evaluate(this: NunjucksContext, template: string): string;
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

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

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the answer for a component
+ * @this {NunjucksContext}
+ * @param {string} name - The name of the component
+ */
+export function field(this: NunjucksContext, name: string): import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/TextField.js").TextField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | undefined;
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

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

@@ -0,0 +1,7 @@
+/**
+ * Format code with syntax highlighting
+ * @param {string} code - Code in plain text
+ * @param {string} [language] - Code programming language
+ * @returns {string} Code with syntax highlighting
+ */
+export function highlight(code: string, language?: string): string;

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

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the answer for a component
+ * @this {NunjucksContext}
+ * @param {string} path - The name of the component
+ */
+export function href(this: NunjucksContext, path: string): string | undefined;
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

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

@@ -0,0 +1,8 @@
+export { markdownToHtml as markdown } from "@defra/forms-model";
+export { highlight } from "~/src/server/plugins/nunjucks/filters/highlight.js";
+export { inspect } from "~/src/server/plugins/nunjucks/filters/inspect.js";
+export { evaluate } from "~/src/server/plugins/nunjucks/filters/evaluate.js";
+export { answer } from "~/src/server/plugins/nunjucks/filters/answer.js";
+export { href } from "~/src/server/plugins/nunjucks/filters/href.js";
+export { field } from "~/src/server/plugins/nunjucks/filters/field.js";
+export { page } from "~/src/server/plugins/nunjucks/filters/page.js";

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

@@ -0,0 +1,6 @@
+/**
+ * Format JavaScript objects as strings
+ * @param {unknown} object - JavaScript object to format
+ * @returns {string} Formatted string
+ */
+export function inspect(object: unknown): string;

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

@@ -0,0 +1,7 @@
+/**
+ * Nunjucks filter to get the page for a given path
+ * @this {NunjucksContext}
+ * @param {string} path - The path of the page
+ */
+export function page(this: NunjucksContext, path: string): import("../../engine/pageControllers/QuestionPageController.js").QuestionPageController | import("../../engine/pageControllers/StartPageController.js").StartPageController | import("../../engine/pageControllers/RepeatPageController.js").RepeatPageController | undefined;
+import type { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js';

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

@@ -0,0 +1,3 @@
+export * as render from "~/src/server/plugins/nunjucks/render.js";
+export { environment } from "~/src/server/plugins/nunjucks/environment.js";
+export { plugin } from "~/src/server/plugins/nunjucks/plugin.js";

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

@@ -0,0 +1,6 @@
+/**
+ * @type {ServerRegisterPluginObject<ServerViewsConfiguration>}
+ */
+export const plugin: ServerRegisterPluginObject<vision.ServerViewsConfiguration>;
+import vision from '@hapi/vision';
+import type { ServerRegisterPluginObject } from '@hapi/hapi';

package/.server/server/plugins/nunjucks/render.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Render Nunjucks macro
+ * @param {string} macroName
+ * @param {string} macroPath
+ * @param {RenderOptions & MacroOptions} [options]
+ */
+export function macro(macroName: string, macroPath: string, options?: RenderOptions & MacroOptions): string;
+/**
+ * Render Nunjucks code
+ * @param {string} viewString - Nunjucks string to render
+ * @param {RenderOptions} [options]
+ */
+export function string(viewString: string, options?: RenderOptions): string;
+/**
+ * Render Nunjucks view
+ * @param {string} viewPath
+ * @param {RenderOptions} [options]
+ */
+export function view(viewPath: string, options?: RenderOptions): string;
+import type { RenderOptions } from '~/src/server/plugins/nunjucks/types.js';
+import type { MacroOptions } from '~/src/server/plugins/nunjucks/types.js';

package/.server/server/plugins/nunjucks/types.d.ts

@@ -0,0 +1,56 @@
+export type MacroOptions = {
+    /**
+     * - Nunjucks call block content
+     */
+    callBlock?: string | undefined;
+    /**
+     * - Nunjucks macro params
+     */
+    params?: object | undefined;
+};
+export type RenderOptions = {
+    /**
+     * - Nunjucks render context
+     */
+    context?: object | undefined;
+};
+/**
+ * - Nunjucks view context
+ */
+export type ViewContext = {
+    /**
+     * - 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;
+    /**
+     * - the current form context
+     */
+    context?: FormContext | undefined;
+};
+export type NunjucksContext = {
+    /**
+     * - the current nunjucks view context
+     */
+    ctx: ViewContext;
+};
+import type { FormContext } from '~/src/server/plugins/engine/types.js';

package/.server/server/plugins/nunjucks/types.js

@@ -11,20 +11,13 @@
 
 /**
  * @typedef {object} ViewContext - Nunjucks view context
- * @property {string} appVersion - Application version
  * @property {string} [baseLayoutPath] - Base layout path
- * @property {Partial<Config>} config - Application config properties
  * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token
  * @property {string} [cspNonce] - Content Security Policy (CSP) nonce
  * @property {string} [currentPath] - Current path
  * @property {string} [previewMode] - Preview mode
  * @property {string} [slug] - Form slug
  * @property {FormContext} [context] - the current form context
- * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context
- */
-
-/**
- * @typedef {ReturnType<typeof config['getProperties']>} Config - Application config properties
  */
 
 /**

package/.server/server/plugins/nunjucks/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/nunjucks/types.js"],"sourcesContent":["/**\n * @typedef {object} MacroOptions\n * @property {string} [callBlock] - Nunjucks call block content\n * @property {object} [params] - Nunjucks macro params\n */\n\n/**\n * @typedef {object} RenderOptions\n * @property {object} [context] - Nunjucks render context\n */\n\n/**\n * @typedef {object} ViewContext - Nunjucks view context\n * @property {string} appVersion - Application version\n * @property {string} [baseLayoutPath] - Base layout path\n * @property {Partial<Config>} config - Application config properties\n * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token\n * @property {string} [cspNonce] - Content Security Policy (CSP) nonce\n * @property {string} [currentPath] - Current path\n * @property {string} [previewMode] - Preview mode\n * @property {string} [slug] - Form slug\n * @property {FormContext} [context] - the current form context\n * @property {PluginOptions['viewContext']} [injectedViewContext] - the current form context\n */\n\n/**\n * @typedef {ReturnType<typeof config['getProperties']>} Config - Application config properties\n */\n\n/**\n * @typedef NunjucksContext\n * @property {ViewContext} ctx - the current nunjucks view context\n */\n\n/**\n * @import { config } from '~/src/config/index.js'\n * @import { FormContext } from '~/src/server/plugins/engine/types.js'\n * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/nunjucks/types.js"],"sourcesContent":["/**\n * @typedef {object} MacroOptions\n * @property {string} [callBlock] - Nunjucks call block content\n * @property {object} [params] - Nunjucks macro params\n */\n\n/**\n * @typedef {object} RenderOptions\n * @property {object} [context] - Nunjucks render context\n */\n\n/**\n * @typedef {object} ViewContext - Nunjucks view context\n * @property {string} [baseLayoutPath] - Base layout path\n * @property {string} [crumb] - Cross-Site Request Forgery (CSRF) token\n * @property {string} [cspNonce] - Content Security Policy (CSP) nonce\n * @property {string} [currentPath] - Current path\n * @property {string} [previewMode] - Preview mode\n * @property {string} [slug] - Form slug\n * @property {FormContext} [context] - the current form context\n */\n\n/**\n * @typedef NunjucksContext\n * @property {ViewContext} ctx - the current nunjucks view context\n */\n\n/**\n * @import { config } from '~/src/config/index.js'\n * @import { FormContext } from '~/src/server/plugins/engine/types.js'\n * @import { PluginOptions } from '~/src/server/plugins/engine/plugin.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/pulse.d.ts

@@ -0,0 +1,11 @@
+declare const _default: {
+    plugin: {
+        plugin: import("@hapi/hapi").Plugin<{
+            timeout: number;
+        }>;
+    };
+    options: {
+        timeout: number;
+    };
+};
+export default _default;