@defra/forms-engine-plugin 1.0.4 → 1.0.6

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<FormRequest, 'app' | 'method' | 'params' | 'path' | 'query' | 'url'>\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  filters?: Record<string, FilterFunction>\n  keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string\n  sessionHydrator?: (\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<FormSubmissionState>\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n}\n"],"mappings":"AA6BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAkGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["UploadStatus","FileStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<FormRequest, 'app' | 'method' | 'params' | 'path' | 'query' | 'url'>\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  filters?: Record<string, FilterFunction>\n  keyGenerator?: (request: Request | FormRequest | FormRequestPayload) => string\n  sessionHydrator?: (\n    request: Request | FormRequest | FormRequestPayload\n  ) => Promise<FormSubmissionState>\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n"],"mappings":"AAgCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAkGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}

package/.server/server/plugins/engine/vision.js

@@ -28,7 +28,7 @@ export async function registerVision(server, pluginOptions) {
 
             // Applies custom filters and globals for nunjucks
             // that are required by the `forms-engine-plugin`
-            prepareNunjucksEnvironment(environment, pluginOptions.filters);
+            prepareNunjucksEnvironment(environment, pluginOptions);
             options.compileOptions.environment = environment;
             next();
           }

package/.server/server/plugins/engine/vision.js.map

@@ -1 +1 @@
-{"version":3,"file":"vision.js","names":["existsSync","dirname","join","fileURLToPath","vision","nunjucks","resolvePkg","VIEW_PATH","context","prepareNunjucksEnvironment","registerVision","server","pluginOptions","packageRoot","findPackageRoot","govukFrontendPath","sync","viewPathResolved","paths","register","plugin","options","engines","html","compile","path","compileOptions","template","environment","render","prepare","next","configure","filters","currentFileName","import","meta","url","currentDirectoryName","dir","Error"],"sources":["../../../../src/server/plugins/engine/vision.ts"],"sourcesContent":["import { existsSync } from 'fs'\nimport { dirname, join } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport { type Server } from '@hapi/hapi'\nimport vision from '@hapi/vision'\nimport nunjucks, { type Environment } from 'nunjucks'\nimport resolvePkg from 'resolve'\n\nimport {\n  VIEW_PATH,\n  context,\n  prepareNunjucksEnvironment\n} from '~/src/server/plugins/engine/index.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\n\nexport async function registerVision(\n  server: Server,\n  pluginOptions: PluginOptions\n) {\n  const packageRoot = findPackageRoot()\n  const govukFrontendPath = dirname(\n    resolvePkg.sync('govuk-frontend/package.json')\n  )\n\n  const viewPathResolved = join(packageRoot, VIEW_PATH)\n\n  const paths = [\n    ...pluginOptions.nunjucks.paths,\n    viewPathResolved,\n    join(govukFrontendPath, 'dist')\n  ]\n\n  await server.register({\n    plugin: vision,\n    options: {\n      engines: {\n        html: {\n          compile: (\n            path: string,\n            compileOptions: { environment: Environment }\n          ) => {\n            const template = nunjucks.compile(path, compileOptions.environment)\n\n            return (context: object | undefined) => {\n              return template.render(context)\n            }\n          },\n          prepare: (\n            options: EngineConfigurationObject,\n            next: (err?: Error) => void\n          ) => {\n            // Nunjucks also needs an additional path configuration\n            // to use the templates and macros from `govuk-frontend`\n            const environment = nunjucks.configure(paths)\n\n            // Applies custom filters and globals for nunjucks\n            // that are required by the `forms-engine-plugin`\n            prepareNunjucksEnvironment(environment, pluginOptions.filters)\n\n            options.compileOptions.environment = environment\n\n            next()\n          }\n        }\n      },\n      path: paths,\n      // Provides global context used with all templates\n      context\n    }\n  })\n}\n\ninterface CompileOptions {\n  environment: Environment\n}\n\nexport interface EngineConfigurationObject {\n  compileOptions: CompileOptions\n}\n\nexport function findPackageRoot() {\n  const currentFileName = fileURLToPath(import.meta.url)\n  const currentDirectoryName = dirname(currentFileName)\n\n  let dir = currentDirectoryName\n  while (dir !== '/') {\n    if (existsSync(join(dir, 'package.json'))) {\n      return dir\n    }\n    dir = dirname(dir)\n  }\n\n  throw new Error('package.json not found in parent directories')\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,IAAI;AAC/B,SAASC,OAAO,EAAEC,IAAI,QAAQ,MAAM;AACpC,SAASC,aAAa,QAAQ,KAAK;AAGnC,OAAOC,MAAM,MAAM,cAAc;AACjC,OAAOC,QAAQ,MAA4B,UAAU;AACrD,OAAOC,UAAU,MAAM,SAAS;AAEhC,SACEC,SAAS,EACTC,OAAO,EACPC,0BAA0B;AAI5B,OAAO,eAAeC,cAAcA,CAClCC,MAAc,EACdC,aAA4B,EAC5B;EACA,MAAMC,WAAW,GAAGC,eAAe,CAAC,CAAC;EACrC,MAAMC,iBAAiB,GAAGd,OAAO,CAC/BK,UAAU,CAACU,IAAI,CAAC,6BAA6B,CAC/C,CAAC;EAED,MAAMC,gBAAgB,GAAGf,IAAI,CAACW,WAAW,EAAEN,SAAS,CAAC;EAErD,MAAMW,KAAK,GAAG,CACZ,GAAGN,aAAa,CAACP,QAAQ,CAACa,KAAK,EAC/BD,gBAAgB,EAChBf,IAAI,CAACa,iBAAiB,EAAE,MAAM,CAAC,CAChC;EAED,MAAMJ,MAAM,CAACQ,QAAQ,CAAC;IACpBC,MAAM,EAAEhB,MAAM;IACdiB,OAAO,EAAE;MACPC,OAAO,EAAE;QACPC,IAAI,EAAE;UACJC,OAAO,EAAEA,CACPC,IAAY,EACZC,cAA4C,KACzC;YACH,MAAMC,QAAQ,GAAGtB,QAAQ,CAACmB,OAAO,CAACC,IAAI,EAAEC,cAAc,CAACE,WAAW,CAAC;YAEnE,OAAQpB,OAA2B,IAAK;cACtC,OAAOmB,QAAQ,CAACE,MAAM,CAACrB,OAAO,CAAC;YACjC,CAAC;UACH,CAAC;UACDsB,OAAO,EAAEA,CACPT,OAAkC,EAClCU,IAA2B,KACxB;YACH;YACA;YACA,MAAMH,WAAW,GAAGvB,QAAQ,CAAC2B,SAAS,CAACd,KAAK,CAAC;;YAE7C;YACA;YACAT,0BAA0B,CAACmB,WAAW,EAAEhB,aAAa,CAACqB,OAAO,CAAC;YAE9DZ,OAAO,CAACK,cAAc,CAACE,WAAW,GAAGA,WAAW;YAEhDG,IAAI,CAAC,CAAC;UACR;QACF;MACF,CAAC;MACDN,IAAI,EAAEP,KAAK;MACX;MACAV;IACF;EACF,CAAC,CAAC;AACJ;AAUA,OAAO,SAASM,eAAeA,CAAA,EAAG;EAChC,MAAMoB,eAAe,GAAG/B,aAAa,CAACgC,MAAM,CAACC,IAAI,CAACC,GAAG,CAAC;EACtD,MAAMC,oBAAoB,GAAGrC,OAAO,CAACiC,eAAe,CAAC;EAErD,IAAIK,GAAG,GAAGD,oBAAoB;EAC9B,OAAOC,GAAG,KAAK,GAAG,EAAE;IAClB,IAAIvC,UAAU,CAACE,IAAI,CAACqC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE;MACzC,OAAOA,GAAG;IACZ;IACAA,GAAG,GAAGtC,OAAO,CAACsC,GAAG,CAAC;EACpB;EAEA,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACjE","ignoreList":[]}
+{"version":3,"file":"vision.js","names":["existsSync","dirname","join","fileURLToPath","vision","nunjucks","resolvePkg","VIEW_PATH","context","prepareNunjucksEnvironment","registerVision","server","pluginOptions","packageRoot","findPackageRoot","govukFrontendPath","sync","viewPathResolved","paths","register","plugin","options","engines","html","compile","path","compileOptions","template","environment","render","prepare","next","configure","currentFileName","import","meta","url","currentDirectoryName","dir","Error"],"sources":["../../../../src/server/plugins/engine/vision.ts"],"sourcesContent":["import { existsSync } from 'fs'\nimport { dirname, join } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport { type Server } from '@hapi/hapi'\nimport vision from '@hapi/vision'\nimport nunjucks, { type Environment } from 'nunjucks'\nimport resolvePkg from 'resolve'\n\nimport {\n  VIEW_PATH,\n  context,\n  prepareNunjucksEnvironment\n} from '~/src/server/plugins/engine/index.js'\nimport { type PluginOptions } from '~/src/server/plugins/engine/types.js'\n\nexport async function registerVision(\n  server: Server,\n  pluginOptions: PluginOptions\n) {\n  const packageRoot = findPackageRoot()\n  const govukFrontendPath = dirname(\n    resolvePkg.sync('govuk-frontend/package.json')\n  )\n\n  const viewPathResolved = join(packageRoot, VIEW_PATH)\n\n  const paths = [\n    ...pluginOptions.nunjucks.paths,\n    viewPathResolved,\n    join(govukFrontendPath, 'dist')\n  ]\n\n  await server.register({\n    plugin: vision,\n    options: {\n      engines: {\n        html: {\n          compile: (\n            path: string,\n            compileOptions: { environment: Environment }\n          ) => {\n            const template = nunjucks.compile(path, compileOptions.environment)\n\n            return (context: object | undefined) => {\n              return template.render(context)\n            }\n          },\n          prepare: (\n            options: EngineConfigurationObject,\n            next: (err?: Error) => void\n          ) => {\n            // Nunjucks also needs an additional path configuration\n            // to use the templates and macros from `govuk-frontend`\n            const environment = nunjucks.configure(paths)\n\n            // Applies custom filters and globals for nunjucks\n            // that are required by the `forms-engine-plugin`\n            prepareNunjucksEnvironment(environment, pluginOptions)\n\n            options.compileOptions.environment = environment\n\n            next()\n          }\n        }\n      },\n      path: paths,\n      // Provides global context used with all templates\n      context\n    }\n  })\n}\n\ninterface CompileOptions {\n  environment: Environment\n}\n\nexport interface EngineConfigurationObject {\n  compileOptions: CompileOptions\n}\n\nexport function findPackageRoot() {\n  const currentFileName = fileURLToPath(import.meta.url)\n  const currentDirectoryName = dirname(currentFileName)\n\n  let dir = currentDirectoryName\n  while (dir !== '/') {\n    if (existsSync(join(dir, 'package.json'))) {\n      return dir\n    }\n    dir = dirname(dir)\n  }\n\n  throw new Error('package.json not found in parent directories')\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,IAAI;AAC/B,SAASC,OAAO,EAAEC,IAAI,QAAQ,MAAM;AACpC,SAASC,aAAa,QAAQ,KAAK;AAGnC,OAAOC,MAAM,MAAM,cAAc;AACjC,OAAOC,QAAQ,MAA4B,UAAU;AACrD,OAAOC,UAAU,MAAM,SAAS;AAEhC,SACEC,SAAS,EACTC,OAAO,EACPC,0BAA0B;AAI5B,OAAO,eAAeC,cAAcA,CAClCC,MAAc,EACdC,aAA4B,EAC5B;EACA,MAAMC,WAAW,GAAGC,eAAe,CAAC,CAAC;EACrC,MAAMC,iBAAiB,GAAGd,OAAO,CAC/BK,UAAU,CAACU,IAAI,CAAC,6BAA6B,CAC/C,CAAC;EAED,MAAMC,gBAAgB,GAAGf,IAAI,CAACW,WAAW,EAAEN,SAAS,CAAC;EAErD,MAAMW,KAAK,GAAG,CACZ,GAAGN,aAAa,CAACP,QAAQ,CAACa,KAAK,EAC/BD,gBAAgB,EAChBf,IAAI,CAACa,iBAAiB,EAAE,MAAM,CAAC,CAChC;EAED,MAAMJ,MAAM,CAACQ,QAAQ,CAAC;IACpBC,MAAM,EAAEhB,MAAM;IACdiB,OAAO,EAAE;MACPC,OAAO,EAAE;QACPC,IAAI,EAAE;UACJC,OAAO,EAAEA,CACPC,IAAY,EACZC,cAA4C,KACzC;YACH,MAAMC,QAAQ,GAAGtB,QAAQ,CAACmB,OAAO,CAACC,IAAI,EAAEC,cAAc,CAACE,WAAW,CAAC;YAEnE,OAAQpB,OAA2B,IAAK;cACtC,OAAOmB,QAAQ,CAACE,MAAM,CAACrB,OAAO,CAAC;YACjC,CAAC;UACH,CAAC;UACDsB,OAAO,EAAEA,CACPT,OAAkC,EAClCU,IAA2B,KACxB;YACH;YACA;YACA,MAAMH,WAAW,GAAGvB,QAAQ,CAAC2B,SAAS,CAACd,KAAK,CAAC;;YAE7C;YACA;YACAT,0BAA0B,CAACmB,WAAW,EAAEhB,aAAa,CAAC;YAEtDS,OAAO,CAACK,cAAc,CAACE,WAAW,GAAGA,WAAW;YAEhDG,IAAI,CAAC,CAAC;UACR;QACF;MACF,CAAC;MACDN,IAAI,EAAEP,KAAK;MACX;MACAV;IACF;EACF,CAAC,CAAC;AACJ;AAUA,OAAO,SAASM,eAAeA,CAAA,EAAG;EAChC,MAAMmB,eAAe,GAAG9B,aAAa,CAAC+B,MAAM,CAACC,IAAI,CAACC,GAAG,CAAC;EACtD,MAAMC,oBAAoB,GAAGpC,OAAO,CAACgC,eAAe,CAAC;EAErD,IAAIK,GAAG,GAAGD,oBAAoB;EAC9B,OAAOC,GAAG,KAAK,GAAG,EAAE;IAClB,IAAItC,UAAU,CAACE,IAAI,CAACoC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE;MACzC,OAAOA,GAAG;IACZ;IACAA,GAAG,GAAGrC,OAAO,CAACqC,GAAG,CAAC;EACpB;EAEA,MAAM,IAAIC,KAAK,CAAC,8CAA8C,CAAC;AACjE","ignoreList":[]}

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

@@ -1,4 +1,3 @@
-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";

package/.server/server/plugins/nunjucks/filters/index.js

@@ -1,4 +1,3 @@
-export { markdownToHtml as markdown } from '@defra/forms-model';
 export { highlight } from "./highlight.js";
 export { inspect } from "./inspect.js";
 export { evaluate } from "./evaluate.js";

package/.server/server/plugins/nunjucks/filters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["markdownToHtml","markdown","highlight","inspect","evaluate","answer","href","field","page"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { markdownToHtml as markdown } from '@defra/forms-model'\nexport { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\n"],"mappings":"AAAA,SAASA,cAAc,IAAIC,QAAQ,QAAQ,oBAAoB;AAC/D,SAASC,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI","ignoreList":[]}
+{"version":3,"file":"index.js","names":["highlight","inspect","evaluate","answer","href","field","page"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI","ignoreList":[]}

package/.server/server/schemas/index.d.ts

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type FormParams } from '~/src/server/plugins/engine/types.js';
+import { type FormPayloadParams } from '~/src/server/plugins/engine/types.js';
 import { FormAction, FormStatus } from '~/src/server/routes/types.js';
 export declare const stateSchema: Joi.StringSchema<FormStatus>;
 export declare const actionSchema: Joi.StringSchema<FormAction>;
@@ -7,4 +7,4 @@ export declare const pathSchema: Joi.StringSchema<string>;
 export declare const itemIdSchema: Joi.StringSchema<string>;
 export declare const crumbSchema: Joi.StringSchema<string>;
 export declare const confirmSchema: Joi.BooleanSchema<boolean>;
-export declare const paramsSchema: Joi.ObjectSchema<FormParams>;
+export declare const paramsSchema: Joi.ObjectSchema<FormPayloadParams>;

package/.server/server/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","Continue","Validate","Delete","AddAnother","Send","default","optional","pathSchema","itemIdSchema","uuid","crumbSchema","allow","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .valid(\n    FormAction.Continue,\n    FormAction.Validate,\n    FormAction.Delete,\n    FormAction.AddAnother,\n    FormAction.Send\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDC,KAAK,CACJJ,UAAU,CAACS,QAAQ,EACnBT,UAAU,CAACU,QAAQ,EACnBV,UAAU,CAACW,MAAM,EACjBX,UAAU,CAACY,UAAU,EACrBZ,UAAU,CAACa,IACb,CAAC,CACAC,OAAO,CAACd,UAAU,CAACU,QAAQ,CAAC,CAC5BK,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGjB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMU,YAAY,GAAGlB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACe,IAAI,CAAC,CAAC,CAACX,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMY,WAAW,GAAGpB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACY,QAAQ,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMC,aAAa,GAAGtB,GAAG,CAACuB,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAGzB,GAAG,CAAC0B,MAAM,CAAa,CAAC,CACjDC,IAAI,CAAC;EACJC,MAAM,EAAEnB,YAAY;EACpBoB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAEV,WAAW;EAClBW,MAAM,EAAEb,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDD,OAAO,CAAC,CAAC,CAAC,CAAC,CACXC,QAAQ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","FormAction","FormStatus","stateSchema","string","valid","Draft","Live","required","actionSchema","Continue","Validate","Delete","AddAnother","Send","default","optional","pathSchema","itemIdSchema","uuid","crumbSchema","allow","confirmSchema","boolean","empty","paramsSchema","object","keys","action","confirm","crumb","itemId"],"sources":["../../../src/server/schemas/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'\nimport { FormAction, FormStatus } from '~/src/server/routes/types.js'\n\nexport const stateSchema = Joi.string<FormStatus>()\n  .valid(FormStatus.Draft, FormStatus.Live)\n  .required()\n\nexport const actionSchema = Joi.string<FormAction>()\n  .valid(\n    FormAction.Continue,\n    FormAction.Validate,\n    FormAction.Delete,\n    FormAction.AddAnother,\n    FormAction.Send\n  )\n  .default(FormAction.Validate)\n  .optional()\n\nexport const pathSchema = Joi.string().required()\nexport const itemIdSchema = Joi.string().uuid().required()\nexport const crumbSchema = Joi.string().optional().allow('')\nexport const confirmSchema = Joi.boolean().empty(false)\n\nexport const paramsSchema = Joi.object<FormPayloadParams>()\n  .keys({\n    action: actionSchema,\n    confirm: confirmSchema,\n    crumb: crumbSchema,\n    itemId: itemIdSchema.optional()\n  })\n  .default({})\n  .optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAGrB,SAASC,UAAU,EAAEC,UAAU;AAE/B,OAAO,MAAMC,WAAW,GAAGH,GAAG,CAACI,MAAM,CAAa,CAAC,CAChDC,KAAK,CAACH,UAAU,CAACI,KAAK,EAAEJ,UAAU,CAACK,IAAI,CAAC,CACxCC,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,YAAY,GAAGT,GAAG,CAACI,MAAM,CAAa,CAAC,CACjDC,KAAK,CACJJ,UAAU,CAACS,QAAQ,EACnBT,UAAU,CAACU,QAAQ,EACnBV,UAAU,CAACW,MAAM,EACjBX,UAAU,CAACY,UAAU,EACrBZ,UAAU,CAACa,IACb,CAAC,CACAC,OAAO,CAACd,UAAU,CAACU,QAAQ,CAAC,CAC5BK,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMC,UAAU,GAAGjB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACI,QAAQ,CAAC,CAAC;AACjD,OAAO,MAAMU,YAAY,GAAGlB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACe,IAAI,CAAC,CAAC,CAACX,QAAQ,CAAC,CAAC;AAC1D,OAAO,MAAMY,WAAW,GAAGpB,GAAG,CAACI,MAAM,CAAC,CAAC,CAACY,QAAQ,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;AAC5D,OAAO,MAAMC,aAAa,GAAGtB,GAAG,CAACuB,OAAO,CAAC,CAAC,CAACC,KAAK,CAAC,KAAK,CAAC;AAEvD,OAAO,MAAMC,YAAY,GAAGzB,GAAG,CAAC0B,MAAM,CAAoB,CAAC,CACxDC,IAAI,CAAC;EACJC,MAAM,EAAEnB,YAAY;EACpBoB,OAAO,EAAEP,aAAa;EACtBQ,KAAK,EAAEV,WAAW;EAClBW,MAAM,EAAEb,YAAY,CAACF,QAAQ,CAAC;AAChC,CAAC,CAAC,CACDD,OAAO,CAAC,CAAC,CAAC,CAAC,CACXC,QAAQ,CAAC,CAAC","ignoreList":[]}

package/.server/server/types.d.ts

@@ -2,7 +2,7 @@ import { type FormDefinition, type FormMetadata, type SubmitPayload, type Submit
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js';
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js';
-import { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
+import { type OnRequestCallback, type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
 import { type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
 export interface FormsService {
     getFormMetadata: (slug: string) => Promise<FormMetadata>;
@@ -27,6 +27,7 @@ export interface RouteConfig {
     services?: Services;
     controllers?: Record<string, typeof PageController>;
     preparePageEventRequestOptions?: PreparePageEventRequestOptions;
+    onRequest?: OnRequestCallback;
 }
 export interface OutputService {
     submit: (request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload) => Promise<void>;

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n}\n\nexport interface OutputService {\n  submit: (\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type OnRequestCallback,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n}\n\nexport interface OutputService {\n  submit: (\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -63,7 +63,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.497",
+    "@defra/forms-model": "^3.0.505",
     "@defra/hapi-tracing": "^1.0.0",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
@@ -114,6 +114,7 @@
     "@babel/plugin-syntax-import-attributes": "^7.27.1",
     "@babel/preset-env": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
+    "@hapi/basic": "^7.0.2",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@types/atob": "^2.1.4",

package/src/server/forms/components.json

@@ -112,6 +112,14 @@
           "content": "Content",
           "options": {},
           "schema": {}
+        },
+        {
+          "type": "Markdown",
+          "name": "markdown",
+          "title": "Title",
+          "content": "### This is a H3 in markdown\n\n[An internal link](http://localhost:3009/fictional-page)\n\n[An external link](https://defra.gov.uk/fictional-page)",
+          "options": {},
+          "schema": {}
         }
       ]
     }

package/src/server/index.test.ts

@@ -1,8 +1,10 @@
 import { type Server } from '@hapi/hapi'
 import { StatusCodes } from 'http-status-codes'
+import { type Environment } from 'nunjucks'
 
 import { FORM_PREFIX } from '~/src/server/constants.js'
 import { createServer } from '~/src/server/index.js'
+import { prepareNunjucksEnvironment } from '~/src/server/plugins/engine/index.js'
 import {
   getFormDefinition,
   getFormMetadata
@@ -12,6 +14,7 @@ import { getUploadStatus } from '~/src/server/plugins/engine/services/uploadServ
 import {
   FileStatus,
   UploadStatus,
+  type PluginOptions,
   type UploadStatusResponse
 } from '~/src/server/plugins/engine/types.js'
 import { FormStatus } from '~/src/server/routes/types.js'
@@ -552,3 +555,73 @@ describe('Upload status route', () => {
     expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST)
   })
 })
+
+describe('prepareEnvironment', () => {
+  const mockEnv = {
+    addFilter: jest.fn(),
+    addGlobal: jest.fn()
+  } as unknown as Environment
+
+  const mockPluginOptions: PluginOptions = {
+    baseUrl: 'http://localhost',
+    nunjucks: {
+      baseLayoutPath: '',
+      paths: []
+    },
+    viewContext: undefined
+  }
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  const expectedBaseFilters = [
+    'highlight',
+    'inspect',
+    'evaluate',
+    'answer',
+    'href',
+    'field',
+    'page',
+    'markdown'
+  ]
+
+  test('registers base filters', () => {
+    prepareNunjucksEnvironment(mockEnv, mockPluginOptions)
+
+    expect(mockEnv.addFilter).toHaveBeenCalledTimes(expectedBaseFilters.length)
+    expectedBaseFilters.forEach((name) => {
+      expect(mockEnv.addFilter).toHaveBeenCalledWith(name, expect.any(Function))
+    })
+  })
+
+  test('registers additional filters', () => {
+    prepareNunjucksEnvironment(mockEnv, {
+      ...mockPluginOptions,
+      filters: {
+        customFilter: (value) => value
+      }
+    })
+
+    expect(mockEnv.addFilter).toHaveBeenCalledWith(
+      'customFilter',
+      expect.any(Function)
+    )
+  })
+
+  test('registers all globals', () => {
+    const expectedGlobals = [
+      'checkComponentTemplates',
+      'checkErrorTemplates',
+      'evaluate',
+      'govukRebrand'
+    ]
+
+    prepareNunjucksEnvironment(mockEnv, mockPluginOptions)
+
+    expect(mockEnv.addGlobal).toHaveBeenCalledTimes(expectedGlobals.length)
+    expectedGlobals.forEach((name) => {
+      expect(mockEnv.addGlobal).toHaveBeenCalledWith(name, expect.any(Function))
+    })
+  })
+})

package/src/server/plugins/engine/components/ComponentBase.ts

@@ -1,4 +1,4 @@
-import { isConditionalType, type ComponentDef } from '@defra/forms-model'
+import { isConditionalRevealType, type ComponentDef } from '@defra/forms-model'
 import joi, {
   type ArraySchema,
   type BooleanSchema,
@@ -76,7 +76,7 @@ export class ComponentBase {
       viewModel.classes = options.classes
     }
 
-    if ('condition' in options && isConditionalType(type)) {
+    if ('condition' in options && isConditionalRevealType(type)) {
       viewModel.condition = options.condition
     }
 

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

@@ -17,7 +17,8 @@ export const configureEnginePlugin = async ({
   formFilePath,
   services,
   controllers,
-  preparePageEventRequestOptions
+  preparePageEventRequestOptions,
+  onRequest
 }: RouteConfig = {}): Promise<{
   plugin: typeof plugin
   options: PluginOptions
@@ -54,7 +55,9 @@ export const configureEnginePlugin = async ({
         paths: [join(findPackageRoot(), 'src/server/devserver')] // custom layout to make it really clear this is not the same as the runner
       },
       viewContext: devtoolContext,
-      preparePageEventRequestOptions
+      preparePageEventRequestOptions,
+      onRequest,
+      baseUrl: 'http://localhost:3009' // always runs locally
     }
   }
 }

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

@@ -1,8 +1,9 @@
+import { markdownToHtml } from '@defra/forms-model'
 import { type Environment } from 'nunjucks'
 
 import { engine } from '~/src/server/plugins/engine/helpers.js'
 import { plugin } from '~/src/server/plugins/engine/plugin.js'
-import { type FilterFunction } from '~/src/server/plugins/engine/types.js'
+import { type PluginOptions } from '~/src/server/plugins/engine/types.js'
 import {
   checkComponentTemplates,
   checkErrorTemplates,
@@ -26,19 +27,23 @@ export const PLUGIN_PATH = 'node_modules/@defra/forms-engine-plugin'
 
 export const prepareNunjucksEnvironment = function (
   env: Environment,
-  additionalFilters?: Record<string, FilterFunction>
+  pluginOptions: PluginOptions
 ) {
   for (const [name, nunjucksFilter] of Object.entries(filters)) {
     env.addFilter(name, nunjucksFilter)
   }
 
+  env.addFilter('markdown', (text: string) =>
+    markdownToHtml(text, pluginOptions.baseUrl)
+  )
+
   for (const [name, nunjucksGlobal] of Object.entries(globals)) {
     env.addGlobal(name, nunjucksGlobal)
   }
 
   // Apply any additional filters to both the liquid and nunjucks engines
-  if (additionalFilters) {
-    for (const [name, filter] of Object.entries(additionalFilters)) {
+  if (pluginOptions.filters) {
+    for (const [name, filter] of Object.entries(pluginOptions.filters)) {
       env.addFilter(name, filter)
       engine.registerFilter(name, filter)
     }

package/src/server/plugins/engine/options.js

@@ -1,5 +1,9 @@
 import Joi from 'joi'
 
+import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+
+const logger = createLogger()
+
 const pluginRegistrationOptionsSchema = Joi.object({
   model: Joi.object().optional(),
   services: Joi.object().optional(),
@@ -12,7 +16,9 @@ const pluginRegistrationOptionsSchema = Joi.object({
     paths: Joi.array().items(Joi.string()).required()
   }).required(),
   viewContext: Joi.function().required(),
-  preparePageEventRequestOptions: Joi.function().optional()
+  preparePageEventRequestOptions: Joi.function().optional(),
+  onRequest: Joi.function().optional(),
+  baseUrl: Joi.string().uri().required()
 })
 
 /**
@@ -26,6 +32,9 @@ export function validatePluginOptions(options) {
   })
 
   if (result.error) {
+    logger.error(
+      `Missing required properties in plugin options: ${result.error.message}`
+    )
     throw new Error('Invalid plugin options', result.error)
   }
 

package/src/server/plugins/engine/options.test.js

@@ -9,7 +9,8 @@ describe('validatePluginOptions', () => {
       },
       viewContext: () => {
         return { hello: 'world' }
-      }
+      },
+      baseUrl: 'http://localhost:3009'
     }
 
     expect(validatePluginOptions(validOptions)).toEqual(validOptions)
@@ -19,6 +20,7 @@ describe('validatePluginOptions', () => {
    * tsc would usually check compliance with the type, but given a user might be using plain JS we still want a test
    */
   it('fails if a required attribute is missing', () => {
+    // viewContext is missing
     const invalidOptions = {
       nunjucks: {
         baseLayoutPath: 'dxt-devtool-baselayout.html',

package/src/server/plugins/engine/pageControllers/FileUploadPageController.test.ts

@@ -22,7 +22,7 @@ import {
   type FeaturedFormPageViewModel,
   type FormContext,
   type FormContextRequest,
-  type FormParams,
+  type FormPayloadParams,
   type FormSubmissionState,
   type UploadStatusFileResponse,
   type UploadStatusResponse
@@ -1063,7 +1063,7 @@ describe('FileUploadPageController', () => {
 
       jest
         .spyOn(controller, 'getFormParams')
-        .mockReturnValue({ confirm: false } as unknown as FormParams)
+        .mockReturnValue({ confirm: false } as unknown as FormPayloadParams)
 
       const proceedSpy = jest
         .spyOn(controller, 'proceed')

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

@@ -26,8 +26,8 @@ import {
   type FormContext,
   type FormContextRequest,
   type FormPageViewModel,
-  type FormParams,
   type FormPayload,
+  type FormPayloadParams,
   type FormState,
   type FormStateValue,
   type FormSubmissionState
@@ -268,7 +268,7 @@ export class QuestionPageController extends PageController {
   /**
    * Gets form params (from payload) for this page only
    */
-  getFormParams(request?: FormContextRequest): FormParams {
+  getFormParams(request?: FormContextRequest): FormPayloadParams {
     const { payload } = request ?? {}
 
     const result = paramsSchema.validate(payload, {
@@ -276,7 +276,7 @@ export class QuestionPageController extends PageController {
       stripUnknown: true
     })
 
-    return result.value as FormParams
+    return result.value as FormPayloadParams
   }
 
   getStateFromValidForm(

package/src/server/plugins/engine/routes/index.ts

@@ -88,7 +88,7 @@ export function makeLoadFormPreHandler(server: Server, options: PluginOptions) {
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- hapi types are wrong
   const prefix = server.realm.modifiers.route.prefix ?? ''
 
-  const { services = defaultServices, controllers } = options
+  const { services = defaultServices, controllers, onRequest } = options
 
   const { formsService } = services
 
@@ -166,6 +166,11 @@ export function makeLoadFormPreHandler(server: Server, options: PluginOptions) {
       server.app.models.set(key, item)
     }
 
+    // Call the onRequest callback if it has been supplied
+    if (onRequest) {
+      onRequest(request, params, item.model.def, metadata)
+    }
+
     // Assign the model to the request data
     // for use in the downstream handler
     request.app.model = item.model

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

@@ -1,6 +1,8 @@
 import {
   type ComponentDef,
   type Event,
+  type FormDefinition,
+  type FormMetadata,
   type Item,
   type List,
   type Page
@@ -21,6 +23,7 @@ import { type PageControllerClass } from '~/src/server/plugins/engine/pageContro
 import { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'
 import {
   type FormAction,
+  type FormParams,
   type FormRequest,
   type FormRequestPayload
 } from '~/src/server/routes/types.js'
@@ -72,7 +75,7 @@ export interface FormSubmissionError
   text: string // e.g: 'Date field must be a real date'
 }
 
-export interface FormParams {
+export interface FormPayloadParams {
   action?: FormAction
   confirm?: true
   crumb?: string
@@ -83,7 +86,7 @@ export interface FormParams {
  * Form POST for question pages
  * (after Joi has converted value types)
  */
-export type FormPayload = FormParams & Partial<Record<string, FormValue>>
+export type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>
 
 export type FormValue =
   | Item['value']
@@ -342,6 +345,13 @@ export type PreparePageEventRequestOptions = (
   context: FormContext
 ) => void
 
+export type OnRequestCallback = (
+  request: FormRequest | FormRequestPayload,
+  params: FormParams,
+  definition: FormDefinition,
+  metadata: FormMetadata
+) => void
+
 export interface PluginOptions {
   model?: FormModel
   services?: Services
@@ -359,4 +369,6 @@ export interface PluginOptions {
   }
   viewContext: PluginProperties['forms-engine-plugin']['viewContext']
   preparePageEventRequestOptions?: PreparePageEventRequestOptions
+  onRequest?: OnRequestCallback
+  baseUrl: string // base URL of the application, protocol and hostname e.g. "https://myapp.com"
 }

package/src/server/plugins/engine/vision.ts

@@ -56,7 +56,7 @@ export async function registerVision(
 
             // Applies custom filters and globals for nunjucks
             // that are required by the `forms-engine-plugin`
-            prepareNunjucksEnvironment(environment, pluginOptions.filters)
+            prepareNunjucksEnvironment(environment, pluginOptions)
 
             options.compileOptions.environment = environment
 

package/src/server/plugins/nunjucks/filters/index.js

@@ -1,4 +1,3 @@
-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'

package/src/server/schemas/index.ts

@@ -1,6 +1,6 @@
 import Joi from 'joi'
 
-import { type FormParams } from '~/src/server/plugins/engine/types.js'
+import { type FormPayloadParams } from '~/src/server/plugins/engine/types.js'
 import { FormAction, FormStatus } from '~/src/server/routes/types.js'
 
 export const stateSchema = Joi.string<FormStatus>()
@@ -23,7 +23,7 @@ export const itemIdSchema = Joi.string().uuid().required()
 export const crumbSchema = Joi.string().optional().allow('')
 export const confirmSchema = Joi.boolean().empty(false)
 
-export const paramsSchema = Joi.object<FormParams>()
+export const paramsSchema = Joi.object<FormPayloadParams>()
   .keys({
     action: actionSchema,
     confirm: confirmSchema,

package/src/server/types.ts

@@ -8,7 +8,10 @@ import {
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import { type DetailItem } from '~/src/server/plugins/engine/models/types.js'
 import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
-import { type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js'
+import {
+  type OnRequestCallback,
+  type PreparePageEventRequestOptions
+} from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequestPayload,
   type FormStatus
@@ -43,6 +46,7 @@ export interface RouteConfig {
   services?: Services
   controllers?: Record<string, typeof PageController>
   preparePageEventRequestOptions?: PreparePageEventRequestOptions
+  onRequest?: OnRequestCallback
 }
 
 export interface OutputService {