@defra/forms-engine-plugin 0.0.1

package/.server/server/plugins/engine/helpers.js

@@ -0,0 +1,268 @@
+import { ControllerPath, Engine } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+import { format, parseISO } from 'date-fns';
+import { StatusCodes } from 'http-status-codes';
+import { Liquid } from 'liquidjs';
+import { createLogger } from "../../common/helpers/logging/logger.js";
+import { PREVIEW_PATH_PREFIX } from "../../constants.js";
+import { getAnswer } from "./components/helpers.js";
+import { FormAction, FormStatus } from "../../routes/types.js";
+const logger = createLogger();
+export const engine = new Liquid({
+  outputEscape: 'escape',
+  jsTruthy: true,
+  ownPropertyOnly: false
+});
+engine.registerFilter('evaluate', function (template) {
+  if (typeof template !== 'string') {
+    return template;
+  }
+  const globals = this.context.globals;
+  const evaluated = evaluateTemplate(template, globals.context);
+  return evaluated;
+});
+engine.registerFilter('page', function (path) {
+  if (typeof path !== 'string') {
+    return;
+  }
+  const globals = this.context.globals;
+  const pageDef = globals.pages.get(path);
+  return pageDef;
+});
+engine.registerFilter('href', function (path, query) {
+  if (typeof path !== 'string') {
+    return;
+  }
+  const globals = this.context.globals;
+  const page = globals.context.pageMap.get(path);
+  if (page === undefined) {
+    return;
+  }
+  return getPageHref(page, query);
+});
+engine.registerFilter('field', function (name) {
+  if (typeof name !== 'string') {
+    return;
+  }
+  const globals = this.context.globals;
+  const componentDef = globals.components.get(name);
+  return componentDef;
+});
+engine.registerFilter('answer', function (name) {
+  if (typeof name !== 'string') {
+    return;
+  }
+  const globals = this.context.globals;
+  const component = globals.context.componentMap.get(name);
+  if (!component?.isFormComponent) {
+    return;
+  }
+  const answer = getAnswer(component, globals.context.relevantState);
+  return answer;
+});
+export function proceed(request, h, nextUrl) {
+  const {
+    method,
+    payload,
+    query
+  } = request;
+  const {
+    returnUrl
+  } = query;
+  const isReturnAllowed = payload && 'action' in payload ? payload.action === FormAction.Continue || payload.action === FormAction.Validate : false;
+
+  // Redirect to return location (optional)
+  const response = isReturnAllowed && isPathRelative(returnUrl) ? h.redirect(returnUrl) : h.redirect(redirectPath(nextUrl));
+
+  // Redirect POST to GET to avoid resubmission
+  return method === 'post' ? response.code(StatusCodes.SEE_OTHER) : response.code(StatusCodes.MOVED_TEMPORARILY);
+}
+
+/**
+ * Encodes a URL, returning undefined if the process fails.
+ */
+export function encodeUrl(link) {
+  if (link) {
+    try {
+      return new URL(link).toString(); // escape the search params without breaking the ? and & reserved characters in rfc2368
+    } catch (err) {
+      logger.error(err, `Failed to encode ${link}`);
+      throw err;
+    }
+  }
+}
+
+/**
+ * Get page href
+ */
+
+/**
+ * Get page href by path
+ */
+
+export function getPageHref(page, pathOrQuery, queryOnly = {}) {
+  const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path;
+  const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly;
+  if (!isPathRelative(path)) {
+    throw Error(`Only relative URLs are allowed: ${path}`);
+  }
+
+  // Return path with page href as base
+  return redirectPath(page.getHref(path), query);
+}
+
+/**
+ * Get redirect path with optional query params
+ */
+export function redirectPath(nextUrl, query = {}) {
+  const isRelative = isPathRelative(nextUrl);
+
+  // Filter string query params only
+  const params = Object.entries(query).filter(query => typeof query[1] === 'string');
+
+  // Build URL with relative path support
+  const url = isRelative ? new URL(nextUrl, 'http://example.com') : new URL(nextUrl);
+
+  // Append query params
+  for (const [name, value] of params) {
+    url.searchParams.set(name, value);
+  }
+  if (isRelative) {
+    return `${url.pathname}${url.search}`;
+  }
+  return url.href;
+}
+export function isPathRelative(path) {
+  return (path ?? '').startsWith('/');
+}
+export function normalisePath(path = '') {
+  return path.trim() // Trim empty spaces
+  .replace(/^\//, '') // Remove leading slash
+  .replace(/\/$/, ''); // Remove trailing slash
+}
+export function getPage(model, request) {
+  const {
+    params
+  } = request;
+  const page = findPage(model, `/${params.path}`);
+  if (!page) {
+    throw Boom.notFound(`No page found for /${params.path}`);
+  }
+  return page;
+}
+export function findPage(model, path) {
+  const findPath = `/${normalisePath(path)}`;
+  return model?.pages.find(({
+    path
+  }) => path === findPath);
+}
+export function getStartPath(model) {
+  if (model?.engine === Engine.V2) {
+    const startPath = normalisePath(model.def.pages.at(0)?.path);
+    return startPath ? `/${startPath}` : ControllerPath.Start;
+  }
+  const startPath = normalisePath(model?.def.startPage);
+  return startPath ? `/${startPath}` : ControllerPath.Start;
+}
+export function checkFormStatus(path) {
+  const isPreview = path.toLowerCase().startsWith(PREVIEW_PATH_PREFIX);
+  let state;
+  if (isPreview) {
+    const previewState = path.split('/')[2];
+    for (const formState of Object.values(FormStatus)) {
+      if (previewState === formState.toString()) {
+        state = formState;
+        break;
+      }
+    }
+    if (!state) {
+      throw new Error(`Invalid form state: ${previewState}`);
+    }
+  }
+  return {
+    isPreview,
+    state: state ?? FormStatus.Live
+  };
+}
+export function checkEmailAddressForLiveFormSubmission(emailAddress, isPreview) {
+  if (!emailAddress && !isPreview) {
+    throw Boom.internal('An email address is required to complete the form submission');
+  }
+}
+
+/**
+ * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates
+ * @param [details] - provided by {@link Schema.validate}
+ */
+export function getErrors(details) {
+  if (!details?.length) {
+    return;
+  }
+  return details.map(getError);
+}
+export function getError(detail) {
+  const {
+    context,
+    message,
+    path
+  } = detail;
+  const name = context?.key ?? '';
+  const href = `#${name}`;
+  const text = message.replace(/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/, text => format(parseISO(text), 'd MMMM yyyy'));
+  return {
+    path,
+    href,
+    name,
+    text,
+    context
+  };
+}
+
+/**
+ * A small helper to safely generate a crumb token.
+ * Checks that the crumb plugin is available, that crumb
+ * is not disabled on the current route, and that cookies/state are present.
+ */
+export function safeGenerateCrumb(request) {
+  // no request or no .state
+  if (!request?.state) {
+    return undefined;
+  }
+
+  // crumb plugin or its generate method doesn’t exist
+  if (!request.server.plugins.crumb.generate) {
+    return undefined;
+  }
+
+  // crumb is explicitly disabled for this route
+  if (request.route.settings.plugins?.crumb === false) {
+    return undefined;
+  }
+  return request.server.plugins.crumb.generate(request);
+}
+
+/**
+ * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,
+ * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).
+ * @param depth - The current retry depth (1, 2, 3, …)
+ * @returns The calculated delay in milliseconds.
+ */
+export function getExponentialBackoffDelay(depth) {
+  const BASE_DELAY_MS = 2000; // 2 seconds initial delay
+  const CAP_DELAY_MS = 25000; // cap each delay to 25 seconds
+  const delay = BASE_DELAY_MS * 2 ** (depth - 1);
+  return Math.min(delay, CAP_DELAY_MS);
+}
+export function evaluateTemplate(template, context) {
+  const globals = {
+    context,
+    pages: context.pageDefMap,
+    components: context.componentDefMap
+  };
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  return engine.parseAndRenderSync(template, context.relevantState, {
+    globals
+  });
+}
+//# sourceMappingURL=helpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","names":["ControllerPath","Engine","Boom","format","parseISO","StatusCodes","Liquid","createLogger","PREVIEW_PATH_PREFIX","getAnswer","FormAction","FormStatus","logger","engine","outputEscape","jsTruthy","ownPropertyOnly","registerFilter","template","globals","context","evaluated","evaluateTemplate","path","pageDef","pages","get","query","page","pageMap","undefined","getPageHref","name","componentDef","components","component","componentMap","isFormComponent","answer","relevantState","proceed","request","h","nextUrl","method","payload","returnUrl","isReturnAllowed","action","Continue","Validate","response","isPathRelative","redirect","redirectPath","code","SEE_OTHER","MOVED_TEMPORARILY","encodeUrl","link","URL","toString","err","error","pathOrQuery","queryOnly","Error","getHref","isRelative","params","Object","entries","filter","url","value","searchParams","set","pathname","search","href","startsWith","normalisePath","trim","replace","getPage","model","findPage","notFound","findPath","find","getStartPath","V2","startPath","def","at","Start","startPage","checkFormStatus","isPreview","toLowerCase","state","previewState","split","formState","values","Live","checkEmailAddressForLiveFormSubmission","emailAddress","internal","getErrors","details","length","map","getError","detail","message","key","text","safeGenerateCrumb","server","plugins","crumb","generate","route","settings","getExponentialBackoffDelay","depth","BASE_DELAY_MS","CAP_DELAY_MS","delay","Math","min","pageDefMap","componentDefMap","parseAndRenderSync"],"sources":["../../../../src/server/plugins/engine/helpers.ts"],"sourcesContent":["import {\n  ControllerPath,\n  Engine,\n  type ComponentDef,\n  type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit } from '@hapi/hapi'\nimport { format, parseISO } from 'date-fns'\nimport { StatusCodes } from 'http-status-codes'\nimport { type Schema, type ValidationErrorItem } from 'joi'\nimport { Liquid } from 'liquidjs'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport {\n  getAnswer,\n  type Field\n} from '~/src/server/plugins/engine/components/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport {\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  FormAction,\n  FormStatus,\n  type FormQuery,\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\n\nconst logger = createLogger()\n\nexport const engine = new Liquid({\n  outputEscape: 'escape',\n  jsTruthy: true,\n  ownPropertyOnly: false\n})\n\nexport interface GlobalScope {\n  context: FormContext\n  pages: Map<string, Page>\n  components: Map<string, ComponentDef>\n}\n\nengine.registerFilter('evaluate', function (template?: string) {\n  if (typeof template !== 'string') {\n    return template\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const evaluated = evaluateTemplate(template, globals.context)\n\n  return evaluated\n})\n\nengine.registerFilter('page', function (path?: string) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const pageDef = globals.pages.get(path)\n\n  return pageDef\n})\n\nengine.registerFilter('href', function (path: string, query?: FormQuery) {\n  if (typeof path !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const page = globals.context.pageMap.get(path)\n\n  if (page === undefined) {\n    return\n  }\n\n  return getPageHref(page, query)\n})\n\nengine.registerFilter('field', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const componentDef = globals.components.get(name)\n\n  return componentDef\n})\n\nengine.registerFilter('answer', function (name: string) {\n  if (typeof name !== 'string') {\n    return\n  }\n\n  const globals = this.context.globals as GlobalScope\n  const component = globals.context.componentMap.get(name)\n\n  if (!component?.isFormComponent) {\n    return\n  }\n\n  const answer = getAnswer(component as Field, globals.context.relevantState)\n\n  return answer\n})\n\nexport function proceed(\n  request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,\n  h: Pick<ResponseToolkit, 'redirect' | 'view'>,\n  nextUrl: string\n) {\n  const { method, payload, query } = request\n  const { returnUrl } = query\n\n  const isReturnAllowed =\n    payload && 'action' in payload\n      ? payload.action === FormAction.Continue ||\n        payload.action === FormAction.Validate\n      : false\n\n  // Redirect to return location (optional)\n  const response =\n    isReturnAllowed && isPathRelative(returnUrl)\n      ? h.redirect(returnUrl)\n      : h.redirect(redirectPath(nextUrl))\n\n  // Redirect POST to GET to avoid resubmission\n  return method === 'post'\n    ? response.code(StatusCodes.SEE_OTHER)\n    : response.code(StatusCodes.MOVED_TEMPORARILY)\n}\n\n/**\n * Encodes a URL, returning undefined if the process fails.\n */\nexport function encodeUrl(link?: string) {\n  if (link) {\n    try {\n      return new URL(link).toString() // escape the search params without breaking the ? and & reserved characters in rfc2368\n    } catch (err) {\n      logger.error(err, `Failed to encode ${link}`)\n      throw err\n    }\n  }\n}\n\n/**\n * Get page href\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  query?: FormQuery\n): string\n\n/**\n * Get page href by path\n */\nexport function getPageHref(\n  page: PageControllerClass,\n  path: string,\n  query?: FormQuery\n): string\n\nexport function getPageHref(\n  page: PageControllerClass,\n  pathOrQuery?: string | FormQuery,\n  queryOnly: FormQuery = {}\n) {\n  const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path\n  const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly\n\n  if (!isPathRelative(path)) {\n    throw Error(`Only relative URLs are allowed: ${path}`)\n  }\n\n  // Return path with page href as base\n  return redirectPath(page.getHref(path), query)\n}\n\n/**\n * Get redirect path with optional query params\n */\nexport function redirectPath(nextUrl: string, query: FormQuery = {}) {\n  const isRelative = isPathRelative(nextUrl)\n\n  // Filter string query params only\n  const params = Object.entries(query).filter(\n    (query): query is [string, string] => typeof query[1] === 'string'\n  )\n\n  // Build URL with relative path support\n  const url = isRelative\n    ? new URL(nextUrl, 'http://example.com')\n    : new URL(nextUrl)\n\n  // Append query params\n  for (const [name, value] of params) {\n    url.searchParams.set(name, value)\n  }\n\n  if (isRelative) {\n    return `${url.pathname}${url.search}`\n  }\n\n  return url.href\n}\n\nexport function isPathRelative(path?: string) {\n  return (path ?? '').startsWith('/')\n}\n\nexport function normalisePath(path = '') {\n  return path\n    .trim() // Trim empty spaces\n    .replace(/^\\//, '') // Remove leading slash\n    .replace(/\\/$/, '') // Remove trailing slash\n}\n\nexport function getPage(\n  model: FormModel | undefined,\n  request: FormContextRequest\n) {\n  const { params } = request\n\n  const page = findPage(model, `/${params.path}`)\n\n  if (!page) {\n    throw Boom.notFound(`No page found for /${params.path}`)\n  }\n\n  return page\n}\n\nexport function findPage(model: FormModel | undefined, path?: string) {\n  const findPath = `/${normalisePath(path)}`\n  return model?.pages.find(({ path }) => path === findPath)\n}\n\nexport function getStartPath(model?: FormModel) {\n  if (model?.engine === Engine.V2) {\n    const startPath = normalisePath(model.def.pages.at(0)?.path)\n    return startPath ? `/${startPath}` : ControllerPath.Start\n  }\n\n  const startPath = normalisePath(model?.def.startPage)\n  return startPath ? `/${startPath}` : ControllerPath.Start\n}\n\nexport function checkFormStatus(path: string) {\n  const isPreview = path.toLowerCase().startsWith(PREVIEW_PATH_PREFIX)\n\n  let state: FormStatus | undefined\n\n  if (isPreview) {\n    const previewState = path.split('/')[2]\n\n    for (const formState of Object.values(FormStatus)) {\n      if (previewState === formState.toString()) {\n        state = formState\n        break\n      }\n    }\n\n    if (!state) {\n      throw new Error(`Invalid form state: ${previewState}`)\n    }\n  }\n\n  return {\n    isPreview,\n    state: state ?? FormStatus.Live\n  }\n}\n\nexport function checkEmailAddressForLiveFormSubmission(\n  emailAddress: string | undefined,\n  isPreview: boolean\n) {\n  if (!emailAddress && !isPreview) {\n    throw Boom.internal(\n      'An email address is required to complete the form submission'\n    )\n  }\n}\n\n/**\n * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n  details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n  if (!details?.length) {\n    return\n  }\n\n  return details.map(getError)\n}\n\nexport function getError(detail: ValidationErrorItem): FormSubmissionError {\n  const { context, message, path } = detail\n\n  const name = context?.key ?? ''\n  const href = `#${name}`\n\n  const text = message.replace(\n    /\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d:[0-5]\\d|Z)/,\n    (text) => format(parseISO(text), 'd MMMM yyyy')\n  )\n\n  return {\n    path,\n    href,\n    name,\n    text,\n    context\n  }\n}\n\n/**\n * A small helper to safely generate a crumb token.\n * Checks that the crumb plugin is available, that crumb\n * is not disabled on the current route, and that cookies/state are present.\n */\nexport function safeGenerateCrumb(\n  request: FormRequest | FormRequestPayload | null\n): string | undefined {\n  // no request or no .state\n  if (!request?.state) {\n    return undefined\n  }\n\n  // crumb plugin or its generate method doesn’t exist\n  if (!request.server.plugins.crumb.generate) {\n    return undefined\n  }\n\n  // crumb is explicitly disabled for this route\n  if (request.route.settings.plugins?.crumb === false) {\n    return undefined\n  }\n\n  return request.server.plugins.crumb.generate(request)\n}\n\n/**\n * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,\n * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).\n * @param depth - The current retry depth (1, 2, 3, …)\n * @returns The calculated delay in milliseconds.\n */\nexport function getExponentialBackoffDelay(depth: number): number {\n  const BASE_DELAY_MS = 2000 // 2 seconds initial delay\n  const CAP_DELAY_MS = 25000 // cap each delay to 25 seconds\n  const delay = BASE_DELAY_MS * 2 ** (depth - 1)\n  return Math.min(delay, CAP_DELAY_MS)\n}\nexport function evaluateTemplate(\n  template: string,\n  context: FormContext\n): string {\n  const globals: GlobalScope = {\n    context,\n    pages: context.pageDefMap,\n    components: context.componentDefMap\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n  return engine.parseAndRenderSync(template, context.relevantState, {\n    globals\n  })\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,QAGD,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAQ,UAAU;AAC3C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,YAAY;AACrB,SAASC,mBAAmB;AAC5B,SACEC,SAAS;AAUX,SACEC,UAAU,EACVC,UAAU;AAMZ,MAAMC,MAAM,GAAGL,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMM,MAAM,GAAG,IAAIP,MAAM,CAAC;EAC/BQ,YAAY,EAAE,QAAQ;EACtBC,QAAQ,EAAE,IAAI;EACdC,eAAe,EAAE;AACnB,CAAC,CAAC;AAQFH,MAAM,CAACI,cAAc,CAAC,UAAU,EAAE,UAAUC,QAAiB,EAAE;EAC7D,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;IAChC,OAAOA,QAAQ;EACjB;EAEA,MAAMC,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAME,SAAS,GAAGC,gBAAgB,CAACJ,QAAQ,EAAEC,OAAO,CAACC,OAAO,CAAC;EAE7D,OAAOC,SAAS;AAClB,CAAC,CAAC;AAEFR,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAa,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMK,OAAO,GAAGL,OAAO,CAACM,KAAK,CAACC,GAAG,CAACH,IAAI,CAAC;EAEvC,OAAOC,OAAO;AAChB,CAAC,CAAC;AAEFX,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAY,EAAEI,KAAiB,EAAE;EACvE,IAAI,OAAOJ,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMS,IAAI,GAAGT,OAAO,CAACC,OAAO,CAACS,OAAO,CAACH,GAAG,CAACH,IAAI,CAAC;EAE9C,IAAIK,IAAI,KAAKE,SAAS,EAAE;IACtB;EACF;EAEA,OAAOC,WAAW,CAACH,IAAI,EAAED,KAAK,CAAC;AACjC,CAAC,CAAC;AAEFd,MAAM,CAACI,cAAc,CAAC,OAAO,EAAE,UAAUe,IAAY,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMc,YAAY,GAAGd,OAAO,CAACe,UAAU,CAACR,GAAG,CAACM,IAAI,CAAC;EAEjD,OAAOC,YAAY;AACrB,CAAC,CAAC;AAEFpB,MAAM,CAACI,cAAc,CAAC,QAAQ,EAAE,UAAUe,IAAY,EAAE;EACtD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMgB,SAAS,GAAGhB,OAAO,CAACC,OAAO,CAACgB,YAAY,CAACV,GAAG,CAACM,IAAI,CAAC;EAExD,IAAI,CAACG,SAAS,EAAEE,eAAe,EAAE;IAC/B;EACF;EAEA,MAAMC,MAAM,GAAG7B,SAAS,CAAC0B,SAAS,EAAWhB,OAAO,CAACC,OAAO,CAACmB,aAAa,CAAC;EAE3E,OAAOD,MAAM;AACf,CAAC,CAAC;AAEF,OAAO,SAASE,OAAOA,CACrBC,OAAiE,EACjEC,CAA6C,EAC7CC,OAAe,EACf;EACA,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAElB;EAAM,CAAC,GAAGc,OAAO;EAC1C,MAAM;IAAEK;EAAU,CAAC,GAAGnB,KAAK;EAE3B,MAAMoB,eAAe,GACnBF,OAAO,IAAI,QAAQ,IAAIA,OAAO,GAC1BA,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACuC,QAAQ,IACtCJ,OAAO,CAACG,MAAM,KAAKtC,UAAU,CAACwC,QAAQ,GACtC,KAAK;;EAEX;EACA,MAAMC,QAAQ,GACZJ,eAAe,IAAIK,cAAc,CAACN,SAAS,CAAC,GACxCJ,CAAC,CAACW,QAAQ,CAACP,SAAS,CAAC,GACrBJ,CAAC,CAACW,QAAQ,CAACC,YAAY,CAACX,OAAO,CAAC,CAAC;;EAEvC;EACA,OAAOC,MAAM,KAAK,MAAM,GACpBO,QAAQ,CAACI,IAAI,CAAClD,WAAW,CAACmD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAAClD,WAAW,CAACoD,iBAAiB,CAAC;AAClD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,IAAa,EAAE;EACvC,IAAIA,IAAI,EAAE;IACR,IAAI;MACF,OAAO,IAAIC,GAAG,CAACD,IAAI,CAAC,CAACE,QAAQ,CAAC,CAAC,EAAC;IAClC,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZlD,MAAM,CAACmD,KAAK,CAACD,GAAG,EAAE,oBAAoBH,IAAI,EAAE,CAAC;MAC7C,MAAMG,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA,OAAO,SAAS/B,WAAWA,CACzBH,IAAyB,EACzBoC,WAAgC,EAChCC,SAAoB,GAAG,CAAC,CAAC,EACzB;EACA,MAAM1C,IAAI,GAAG,OAAOyC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGpC,IAAI,CAACL,IAAI;EACtE,MAAMI,KAAK,GAAG,OAAOqC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGC,SAAS;EAEvE,IAAI,CAACb,cAAc,CAAC7B,IAAI,CAAC,EAAE;IACzB,MAAM2C,KAAK,CAAC,mCAAmC3C,IAAI,EAAE,CAAC;EACxD;;EAEA;EACA,OAAO+B,YAAY,CAAC1B,IAAI,CAACuC,OAAO,CAAC5C,IAAI,CAAC,EAAEI,KAAK,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAAS2B,YAAYA,CAACX,OAAe,EAAEhB,KAAgB,GAAG,CAAC,CAAC,EAAE;EACnE,MAAMyC,UAAU,GAAGhB,cAAc,CAACT,OAAO,CAAC;;EAE1C;EACA,MAAM0B,MAAM,GAAGC,MAAM,CAACC,OAAO,CAAC5C,KAAK,CAAC,CAAC6C,MAAM,CACxC7C,KAAK,IAAgC,OAAOA,KAAK,CAAC,CAAC,CAAC,KAAK,QAC5D,CAAC;;EAED;EACA,MAAM8C,GAAG,GAAGL,UAAU,GAClB,IAAIR,GAAG,CAACjB,OAAO,EAAE,oBAAoB,CAAC,GACtC,IAAIiB,GAAG,CAACjB,OAAO,CAAC;;EAEpB;EACA,KAAK,MAAM,CAACX,IAAI,EAAE0C,KAAK,CAAC,IAAIL,MAAM,EAAE;IAClCI,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC5C,IAAI,EAAE0C,KAAK,CAAC;EACnC;EAEA,IAAIN,UAAU,EAAE;IACd,OAAO,GAAGK,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM,EAAE;EACvC;EAEA,OAAOL,GAAG,CAACM,IAAI;AACjB;AAEA,OAAO,SAAS3B,cAAcA,CAAC7B,IAAa,EAAE;EAC5C,OAAO,CAACA,IAAI,IAAI,EAAE,EAAEyD,UAAU,CAAC,GAAG,CAAC;AACrC;AAEA,OAAO,SAASC,aAAaA,CAAC1D,IAAI,GAAG,EAAE,EAAE;EACvC,OAAOA,IAAI,CACR2D,IAAI,CAAC,CAAC,CAAC;EAAA,CACPC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;EAAA,CACnBA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAC;AACxB;AAEA,OAAO,SAASC,OAAOA,CACrBC,KAA4B,EAC5B5C,OAA2B,EAC3B;EACA,MAAM;IAAE4B;EAAO,CAAC,GAAG5B,OAAO;EAE1B,MAAMb,IAAI,GAAG0D,QAAQ,CAACD,KAAK,EAAE,IAAIhB,MAAM,CAAC9C,IAAI,EAAE,CAAC;EAE/C,IAAI,CAACK,IAAI,EAAE;IACT,MAAM1B,IAAI,CAACqF,QAAQ,CAAC,sBAAsBlB,MAAM,CAAC9C,IAAI,EAAE,CAAC;EAC1D;EAEA,OAAOK,IAAI;AACb;AAEA,OAAO,SAAS0D,QAAQA,CAACD,KAA4B,EAAE9D,IAAa,EAAE;EACpE,MAAMiE,QAAQ,GAAG,IAAIP,aAAa,CAAC1D,IAAI,CAAC,EAAE;EAC1C,OAAO8D,KAAK,EAAE5D,KAAK,CAACgE,IAAI,CAAC,CAAC;IAAElE;EAAK,CAAC,KAAKA,IAAI,KAAKiE,QAAQ,CAAC;AAC3D;AAEA,OAAO,SAASE,YAAYA,CAACL,KAAiB,EAAE;EAC9C,IAAIA,KAAK,EAAExE,MAAM,KAAKZ,MAAM,CAAC0F,EAAE,EAAE;IAC/B,MAAMC,SAAS,GAAGX,aAAa,CAACI,KAAK,CAACQ,GAAG,CAACpE,KAAK,CAACqE,EAAE,CAAC,CAAC,CAAC,EAAEvE,IAAI,CAAC;IAC5D,OAAOqE,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAG5F,cAAc,CAAC+F,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGX,aAAa,CAACI,KAAK,EAAEQ,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAG5F,cAAc,CAAC+F,KAAK;AAC3D;AAEA,OAAO,SAASE,eAAeA,CAAC1E,IAAY,EAAE;EAC5C,MAAM2E,SAAS,GAAG3E,IAAI,CAAC4E,WAAW,CAAC,CAAC,CAACnB,UAAU,CAACxE,mBAAmB,CAAC;EAEpE,IAAI4F,KAA6B;EAEjC,IAAIF,SAAS,EAAE;IACb,MAAMG,YAAY,GAAG9E,IAAI,CAAC+E,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEvC,KAAK,MAAMC,SAAS,IAAIjC,MAAM,CAACkC,MAAM,CAAC7F,UAAU,CAAC,EAAE;MACjD,IAAI0F,YAAY,KAAKE,SAAS,CAAC1C,QAAQ,CAAC,CAAC,EAAE;QACzCuC,KAAK,GAAGG,SAAS;QACjB;MACF;IACF;IAEA,IAAI,CAACH,KAAK,EAAE;MACV,MAAM,IAAIlC,KAAK,CAAC,uBAAuBmC,YAAY,EAAE,CAAC;IACxD;EACF;EAEA,OAAO;IACLH,SAAS;IACTE,KAAK,EAAEA,KAAK,IAAIzF,UAAU,CAAC8F;EAC7B,CAAC;AACH;AAEA,OAAO,SAASC,sCAAsCA,CACpDC,YAAgC,EAChCT,SAAkB,EAClB;EACA,IAAI,CAACS,YAAY,IAAI,CAACT,SAAS,EAAE;IAC/B,MAAMhG,IAAI,CAAC0G,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAACC,QAAQ,CAAC;AAC9B;AAEA,OAAO,SAASA,QAAQA,CAACC,MAA2B,EAAuB;EACzE,MAAM;IAAE9F,OAAO;IAAE+F,OAAO;IAAE5F;EAAK,CAAC,GAAG2F,MAAM;EAEzC,MAAMlF,IAAI,GAAGZ,OAAO,EAAEgG,GAAG,IAAI,EAAE;EAC/B,MAAMrC,IAAI,GAAG,IAAI/C,IAAI,EAAE;EAEvB,MAAMqF,IAAI,GAAGF,OAAO,CAAChC,OAAO,CAC1B,0EAA0E,EACzEkC,IAAI,IAAKlH,MAAM,CAACC,QAAQ,CAACiH,IAAI,CAAC,EAAE,aAAa,CAChD,CAAC;EAED,OAAO;IACL9F,IAAI;IACJwD,IAAI;IACJ/C,IAAI;IACJqF,IAAI;IACJjG;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASkG,iBAAiBA,CAC/B7E,OAAgD,EAC5B;EACpB;EACA,IAAI,CAACA,OAAO,EAAE2D,KAAK,EAAE;IACnB,OAAOtE,SAAS;EAClB;;EAEA;EACA,IAAI,CAACW,OAAO,CAAC8E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,EAAE;IAC1C,OAAO5F,SAAS;EAClB;;EAEA;EACA,IAAIW,OAAO,CAACkF,KAAK,CAACC,QAAQ,CAACJ,OAAO,EAAEC,KAAK,KAAK,KAAK,EAAE;IACnD,OAAO3F,SAAS;EAClB;EAEA,OAAOW,OAAO,CAAC8E,MAAM,CAACC,OAAO,CAACC,KAAK,CAACC,QAAQ,CAACjF,OAAO,CAAC;AACvD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASoF,0BAA0BA,CAACC,KAAa,EAAU;EAChE,MAAMC,aAAa,GAAG,IAAI,EAAC;EAC3B,MAAMC,YAAY,GAAG,KAAK,EAAC;EAC3B,MAAMC,KAAK,GAAGF,aAAa,GAAG,CAAC,KAAKD,KAAK,GAAG,CAAC,CAAC;EAC9C,OAAOI,IAAI,CAACC,GAAG,CAACF,KAAK,EAAED,YAAY,CAAC;AACtC;AACA,OAAO,SAAS1G,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAACgH,UAAU;IACzBlG,UAAU,EAAEd,OAAO,CAACiH;EACtB,CAAC;;EAED;EACA,OAAOxH,MAAM,CAACyH,kBAAkB,CAACpH,QAAQ,EAAEE,OAAO,CAACmB,aAAa,EAAE;IAChEpB;EACF,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/plugins/engine/index.js

@@ -0,0 +1,6 @@
+import { plugin } from "./plugin.js";
+export { getPageHref } from "./helpers.js";
+export { configureEnginePlugin } from "./configureEnginePlugin.js";
+export { CacheService } from "../../services/index.js";
+export default plugin;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["plugin","getPageHref","configureEnginePlugin","CacheService"],"sources":["../../../../src/server/plugins/engine/index.ts"],"sourcesContent":["import { plugin } from '~/src/server/plugins/engine/plugin.js'\n\nexport { getPageHref } from '~/src/server/plugins/engine/helpers.js'\nexport { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js'\nexport { CacheService } from '~/src/server/services/index.js'\n\nexport default plugin\n"],"mappings":"AAAA,SAASA,MAAM;AAEf,SAASC,WAAW;AACpB,SAASC,qBAAqB;AAC9B,SAASC,YAAY;AAErB,eAAeH,MAAM","ignoreList":[]}

package/.server/server/plugins/engine/models/FormModel.js

@@ -0,0 +1,363 @@
+import { ComponentType, ConditionsModel, ControllerPath, ControllerType, Engine, formDefinitionSchema, hasComponents, hasRepeater } from '@defra/forms-model';
+import { add } from 'date-fns';
+import { Parser } from 'expr-eval';
+import joi from 'joi';
+import { findPage, getError, getPage } from "../helpers.js";
+import { createPage } from "../pageControllers/helpers.js";
+import { validationOptions as opts } from "../pageControllers/validationOptions.js";
+import * as defaultServices from "../services/index.js";
+import { FormAction } from "../../../routes/types.js";
+import { merge } from "../../../services/cacheService.js";
+export class FormModel {
+  /** The runtime engine that should be used */
+  engine;
+
+  /** the entire form JSON as an object */
+  def;
+  lists;
+  sections = [];
+  name;
+  values;
+  basePath;
+  conditions;
+  pages;
+  services;
+  controllers;
+  pageDefMap;
+  listDefMap;
+  componentDefMap;
+  pageMap;
+  componentMap;
+  constructor(def, options, services = defaultServices, controllers) {
+    const result = formDefinitionSchema.validate(def, {
+      abortEarly: false
+    });
+    if (result.error) {
+      throw result.error;
+    }
+
+    // Make a clone of the shallow copy returned
+    // by joi so as not to change the source data.
+    def = structuredClone(result.value);
+
+    // Add default lists
+    def.lists.push({
+      name: '__yesNo',
+      title: 'Yes/No',
+      type: 'boolean',
+      items: [{
+        text: 'Yes',
+        value: true
+      }, {
+        text: 'No',
+        value: false
+      }]
+    });
+    this.engine = def.engine;
+    this.def = def;
+    this.lists = def.lists;
+    this.sections = def.sections;
+    this.name = def.name ?? '';
+    this.values = result.value;
+    this.basePath = options.basePath;
+    this.conditions = {};
+    this.services = services;
+    this.controllers = controllers;
+    def.conditions.forEach(conditionDef => {
+      const condition = this.makeCondition(conditionDef);
+      this.conditions[condition.name] = condition;
+    });
+    this.pages = def.pages.map(pageDef => createPage(this, pageDef));
+    if (!def.pages.some(({
+      controller
+    }) =>
+    // Check for user-provided status page (optional)
+    controller === ControllerType.Status)) {
+      this.pages.push(createPage(this, {
+        title: 'Form submitted',
+        path: ControllerPath.Status,
+        controller: ControllerType.Status
+      }));
+    }
+    this.pageDefMap = new Map(def.pages.map(page => [page.path, page]));
+    this.listDefMap = new Map(def.lists.map(list => [list.name, list]));
+    this.componentDefMap = new Map(def.pages.filter(hasComponents).flatMap(page => page.components.map(component => [component.name, component])));
+    this.pageMap = new Map(this.pages.map(page => [page.path, page]));
+    this.componentMap = new Map(this.pages.flatMap(page => page.collection.components.map(component => [component.name, component])));
+  }
+
+  /**
+   * build the entire model schema from individual pages/sections
+   */
+  makeSchema() {
+    return this.makeFilteredSchema(this.pages);
+  }
+
+  /**
+   * build the entire model schema from individual pages/sections and filter out answers
+   * for pages which are no longer accessible due to an answer that has been changed
+   */
+  makeFilteredSchema(relevantPages) {
+    // Build the entire model schema
+    // from the individual pages/sections
+    let schema = joi.object().required();
+    relevantPages.forEach(page => {
+      schema = schema.concat(page.collection.stateSchema);
+    });
+    return schema;
+  }
+
+  /**
+   * Instantiates a Condition based on {@link ConditionWrapper}
+   * @param condition
+   */
+  makeCondition(condition) {
+    const parser = new Parser({
+      operators: {
+        logical: true
+      }
+    });
+    Object.assign(parser.functions, {
+      dateForComparison(timePeriod, timeUnit) {
+        return add(new Date(), {
+          [timeUnit]: timePeriod
+        }).toISOString();
+      }
+    });
+    const {
+      name,
+      displayName,
+      value
+    } = condition;
+    const expr = this.toConditionExpression(value, parser);
+    const fn = evaluationState => {
+      const ctx = this.toConditionContext(evaluationState, this.conditions);
+      try {
+        return expr.evaluate(ctx);
+      } catch {
+        return false;
+      }
+    };
+    return {
+      name,
+      displayName,
+      value,
+      expr,
+      fn
+    };
+  }
+  toConditionContext(evaluationState, conditions) {
+    const context = {
+      ...evaluationState
+    };
+    for (const key in conditions) {
+      Object.defineProperty(context, key, {
+        get() {
+          return conditions[key]?.fn(evaluationState);
+        }
+      });
+    }
+    return context;
+  }
+  toConditionExpression(value, parser) {
+    const conditions = ConditionsModel.from(value);
+    return parser.parse(conditions.toExpression());
+  }
+  getList(name) {
+    return this.lists.find(list => list.name === name);
+  }
+
+  /**
+   * Form context for the current page
+   */
+  getFormContext(request, state, errors) {
+    const {
+      query
+    } = request;
+    const page = getPage(this, request);
+
+    // Determine form paths
+    const currentPath = page.path;
+    const startPath = page.getStartPath();
+
+    // Preview URL direct access is allowed
+    const isForceAccess = 'force' in query;
+    let context = {
+      evaluationState: {},
+      relevantState: {},
+      relevantPages: [],
+      payload: page.getFormDataFromState(request, state),
+      state,
+      paths: [],
+      errors,
+      isForceAccess,
+      data: {},
+      pageDefMap: this.pageDefMap,
+      listDefMap: this.listDefMap,
+      componentDefMap: this.componentDefMap,
+      pageMap: this.pageMap,
+      componentMap: this.componentMap
+    };
+
+    // Validate current page
+    context = validateFormPayload(request, page, context);
+
+    // Find start page
+    let nextPage = findPage(this, startPath);
+    this.initialiseContext(context);
+
+    // Walk form pages from start
+    while (nextPage) {
+      // Add page to context
+      context.relevantPages.push(nextPage);
+      this.assignEvaluationState(context, nextPage);
+      this.assignRelevantState(context, nextPage);
+
+      // Stop at current page
+      if (nextPage.path === currentPath) {
+        break;
+      }
+
+      // Apply conditions to determine next page
+      nextPage = findPage(this, nextPage.getNextPath(context));
+    }
+
+    // Validate form state
+    context = validateFormState(request, page, context);
+
+    // Add paths for navigation
+    this.assignPaths(context);
+    return context;
+  }
+  initialiseContext(context) {
+    // For the V2 engine, we need to initialise `evaluationState` to null
+    // for all keys. This is because the current condition evaluation
+    // library (eval-expr) will throw if an expression uses a key that is undefined.
+    if (this.engine === Engine.V2) {
+      for (const page of this.pages) {
+        for (const key of page.keys) {
+          context.evaluationState[key] = null;
+        }
+      }
+    }
+  }
+  assignEvaluationState(context, page) {
+    const {
+      collection,
+      pageDef
+    } = page;
+    // Skip evaluation state for repeater pages
+
+    if (!hasRepeater(pageDef)) {
+      Object.assign(context.evaluationState, collection.getContextValueFromState(context.state));
+    }
+  }
+  assignRelevantState(context, page) {
+    // Copy relevant state by expected keys
+    for (const key of page.keys) {
+      if (typeof context.state[key] !== 'undefined') {
+        context.relevantState[key] = context.state[key];
+      }
+    }
+  }
+  assignPaths(context) {
+    for (const {
+      keys,
+      path
+    } of context.relevantPages) {
+      context.paths.push(path);
+
+      // Stop at page with errors
+      if (context.errors?.some(({
+        name,
+        path
+      }) => {
+        return keys.includes(name) || keys.some(key => path.includes(key));
+      })) {
+        break;
+      }
+    }
+  }
+}
+
+/**
+ * Validate current page only
+ */
+function validateFormPayload(request, page, context) {
+  const {
+    collection
+  } = page;
+  const {
+    payload,
+    state
+  } = context;
+  const {
+    action
+  } = page.getFormParams(request);
+
+  // Skip validation GET requests or other actions
+  if (!request.payload || action !== FormAction.Validate) {
+    return context;
+  }
+
+  // For checkbox fields missing in the payload (i.e. unchecked),
+  // explicitly set their value to undefined so that any previously
+  // stored value is cleared and required field validation is enforced.
+  const update = {
+    ...request.payload
+  };
+  collection.fields.forEach(field => {
+    if (field.type === ComponentType.CheckboxesField && !(field.name in update)) {
+      update[field.name] = undefined;
+    }
+  });
+  const {
+    value,
+    errors
+  } = collection.validate({
+    ...payload,
+    ...update
+  });
+
+  // Add sanitised payload (ready to save)
+  const formState = page.getStateFromValidForm(request, state, value);
+  return {
+    ...context,
+    payload: merge(payload, value),
+    state: merge(state, formState),
+    errors
+  };
+}
+
+/**
+ * Validate entire form state
+ */
+function validateFormState(request, page, context) {
+  const {
+    errors = [],
+    relevantPages,
+    relevantState
+  } = context;
+
+  // Exclude current page
+  const previousPages = relevantPages.filter(relevantPage => relevantPage !== page);
+
+  // Validate relevant state
+  const {
+    error
+  } = page.model.makeFilteredSchema(previousPages).validate(relevantState, {
+    ...opts,
+    stripUnknown: true
+  });
+
+  // Add relevant state errors
+  if (error) {
+    const errorsState = error.details.map(getError);
+    return {
+      ...context,
+      errors: errors.concat(errorsState)
+    };
+  }
+  return context;
+}
+//# sourceMappingURL=FormModel.js.map