@defra/forms-engine-plugin 0.0.1

package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js

@@ -0,0 +1,401 @@
+import { ComponentType } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+import { wait } from '@hapi/hoek';
+import { tempItemSchema } from "../components/FileUploadField.js";
+import { getError, getExponentialBackoffDelay } from "../helpers.js";
+import { QuestionPageController } from "./QuestionPageController.js";
+import { getProxyUrlForLocalDevelopment } from "./helpers.js";
+import { getUploadStatus, initiateUpload } from "../services/uploadService.js";
+import { FileStatus, UploadStatus } from "../types.js";
+const MAX_UPLOADS = 25;
+const CDP_UPLOAD_TIMEOUT_MS = 60000; // 1 minute
+
+export function prepareStatus(status) {
+  const file = status.form.file;
+  const isPending = file.fileStatus === FileStatus.pending;
+  if (!file.errorMessage && isPending) {
+    file.errorMessage = 'The selected file has not fully uploaded';
+  }
+  return status;
+}
+function prepareFileState(fileState) {
+  prepareStatus(fileState.status);
+  return fileState;
+}
+export class FileUploadPageController extends QuestionPageController {
+  fileUpload;
+  fileDeleteViewName = 'item-delete';
+  constructor(model, pageDef) {
+    super(model, pageDef);
+    const {
+      collection
+    } = this;
+
+    // Get the file upload fields from the collection
+    const fileUploads = collection.fields.filter(field => field.type === ComponentType.FileUploadField);
+    const fileUpload = fileUploads.at(0);
+
+    // Assert we have exactly 1 file upload component
+    if (!fileUpload || fileUploads.length > 1) {
+      throw Boom.badImplementation(`Expected 1 FileUploadFieldComponent in FileUploadPageController '${pageDef.path}'`);
+    }
+
+    // Assert the file upload component is the first form component
+    if (collection.fields.indexOf(fileUpload) !== 0) {
+      throw Boom.badImplementation(`Expected '${fileUpload.name}' to be the first form component in FileUploadPageController '${pageDef.path}'`);
+    }
+
+    // Assign the file upload component to the controller
+    this.fileUpload = fileUpload;
+    this.viewName = 'file-upload';
+  }
+  getFormDataFromState(request, state) {
+    const {
+      fileUpload
+    } = this;
+    const payload = super.getFormDataFromState(request, state);
+    const files = this.getFilesFromState(state);
+
+    // Append the files to the payload
+    payload[fileUpload.name] = files.length ? files : undefined;
+    return payload;
+  }
+  async getState(request) {
+    const {
+      fileUpload
+    } = this;
+
+    // Get the actual state
+    const state = await super.getState(request);
+    const files = this.getFilesFromState(state);
+
+    // Overwrite the files with those in the upload state
+    state[fileUpload.name] = files;
+    return this.refreshUpload(request, state);
+  }
+
+  /**
+   * Get the uploaded files from state.
+   */
+  getFilesFromState(state) {
+    const {
+      path
+    } = this;
+    const uploadState = state.upload?.[path];
+    return uploadState?.files ?? [];
+  }
+
+  /**
+   * Get the initiated upload from state.
+   */
+  getUploadFromState(state) {
+    const {
+      path
+    } = this;
+    const uploadState = state.upload?.[path];
+    return uploadState?.upload;
+  }
+  makeGetItemDeleteRouteHandler() {
+    return (request, context, h) => {
+      const {
+        viewModel
+      } = this;
+      const {
+        params
+      } = request;
+      const {
+        state
+      } = context;
+      const files = this.getFilesFromState(state);
+      const fileToRemove = files.find(({
+        uploadId
+      }) => uploadId === params.itemId);
+      if (!fileToRemove) {
+        throw Boom.notFound('File to delete not found');
+      }
+      const {
+        filename
+      } = fileToRemove.status.form.file;
+      return h.view(this.fileDeleteViewName, {
+        ...viewModel,
+        context,
+        backLink: this.getBackLink(request, context),
+        pageTitle: `Are you sure you want to remove this file?`,
+        itemTitle: filename,
+        confirmation: {
+          text: 'You cannot recover removed files.'
+        },
+        buttonConfirm: {
+          text: 'Remove file'
+        },
+        buttonCancel: {
+          text: 'Cancel'
+        }
+      });
+    };
+  }
+  makePostItemDeleteRouteHandler() {
+    return async (request, context, h) => {
+      const {
+        path
+      } = this;
+      const {
+        state
+      } = context;
+      const {
+        confirm
+      } = this.getFormParams(request);
+
+      // Check for any removed files in the POST payload
+      if (confirm) {
+        await this.checkRemovedFiles(request, state);
+        return this.proceed(request, h, path);
+      }
+      return this.proceed(request, h);
+    };
+  }
+  getErrors(details) {
+    const {
+      fileUpload
+    } = this;
+    if (details) {
+      const errors = [];
+      details.forEach(error => {
+        const isUploadError = error.path[0] === fileUpload.name;
+        const isUploadRootError = isUploadError && error.path.length === 1;
+        if (!isUploadError || isUploadRootError) {
+          // The error is for the root of the upload or another
+          // field on the page so defer to the getError helper
+          errors.push(getError(error));
+        } else {
+          const {
+            context,
+            path,
+            type
+          } = error;
+          if (type === 'object.unknown' && path.at(-1) === 'errorMessage') {
+            const value = context?.value;
+            if (value) {
+              const name = fileUpload.name;
+              const text = typeof value === 'string' ? value : 'Unknown error';
+              const href = `#${name}`;
+              errors.push({
+                path,
+                href,
+                name,
+                text
+              });
+            }
+          }
+        }
+      });
+      return errors;
+    }
+  }
+  getViewModel(request, context) {
+    const {
+      fileUpload
+    } = this;
+    const {
+      state
+    } = context;
+    const upload = this.getUploadFromState(state);
+    const viewModel = super.getViewModel(request, context);
+    const {
+      components
+    } = viewModel;
+
+    // Featured form component
+    const [formComponent] = components.filter(({
+      model
+    }) => model.id === fileUpload.name);
+    const index = components.indexOf(formComponent);
+    const proxyUrl = getProxyUrlForLocalDevelopment(upload?.uploadUrl);
+    return {
+      ...viewModel,
+      formAction: upload?.uploadUrl,
+      uploadId: upload?.uploadId,
+      formComponent,
+      // Split out components before/after
+      componentsBefore: components.slice(0, index),
+      components: components.slice(index),
+      proxyUrl
+    };
+  }
+
+  /**
+   * Refreshes the CDP upload and files in the
+   * state and checks for any removed files.
+   *
+   * If an upload exists and hasn't been consumed
+   * it gets re-used, otherwise we initiate a new one.
+   * @param request - the hapi request
+   * @param state - the form state
+   */
+  async refreshUpload(request, state) {
+    state = await this.checkUploadStatus(request, state);
+    return state;
+  }
+
+  /**
+   * If an upload exists and hasn't been consumed
+   * it gets re-used, otherwise a new one is initiated.
+   * @param request - the hapi request
+   * @param state - the form state
+   * @param depth - the number of retries so far
+   */
+  async checkUploadStatus(request, state, depth = 1) {
+    const upload = this.getUploadFromState(state);
+    const files = this.getFilesFromState(state);
+
+    // If no upload exists, initiate a new one.
+    if (!upload?.uploadId) {
+      return this.initiateAndStoreNewUpload(request, state);
+    }
+    const uploadId = upload.uploadId;
+    const statusResponse = await getUploadStatus(uploadId);
+    if (!statusResponse) {
+      throw Boom.badRequest(`Unexpected empty response from getUploadStatus for ${uploadId}`);
+    }
+
+    // Re-use the upload if it is still in the "initiated" state.
+    if (statusResponse.uploadStatus === UploadStatus.initiated) {
+      return state;
+    }
+    if (statusResponse.uploadStatus === UploadStatus.pending) {
+      // Using exponential backoff delays:
+      // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)
+      // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.
+      if (depth >= 5) {
+        request.logger.error(`Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`);
+        await this.initiateAndStoreNewUpload(request, state);
+        throw Boom.gatewayTimeout(`Timed out waiting for ${uploadId} after cumulative retries exceeding ${((CDP_UPLOAD_TIMEOUT_MS - 5000) / 1000).toFixed(0)} seconds`);
+      }
+      const delay = getExponentialBackoffDelay(depth);
+      request.logger.info(`Waiting ${delay / 1000} seconds for ${uploadId} to complete (depth: ${depth})`);
+      await wait(delay);
+      return this.checkUploadStatus(request, state, depth + 1);
+    }
+
+    // Only add to files state if the file validates.
+    // This secures against html tampering of the file input
+    // by adding a 'multiple' attribute or it being
+    // changed to a simple text field or similar.
+    const validationResult = tempItemSchema.validate({
+      uploadId,
+      status: statusResponse
+    }, {
+      stripUnknown: true
+    });
+    const error = validationResult.error;
+    const fileState = validationResult.value;
+    if (error) {
+      return this.initiateAndStoreNewUpload(request, state);
+    }
+    const file = fileState.status.form.file;
+    if (file.fileStatus === FileStatus.complete) {
+      files.unshift(prepareFileState(fileState));
+      await this.mergeState(request, state, {
+        upload: {
+          [this.path]: {
+            files,
+            upload
+          }
+        }
+      });
+    } else {
+      // Flash the error message.
+      const {
+        fileUpload
+      } = this;
+      const {
+        cacheService
+      } = request.services([]);
+      const name = fileUpload.name;
+      const text = file.errorMessage ?? 'Unknown error';
+      const errors = [{
+        path: [name],
+        href: `#${name}`,
+        name,
+        text
+      }];
+      cacheService.setFlash(request, {
+        errors
+      });
+    }
+    return this.initiateAndStoreNewUpload(request, state);
+  }
+
+  /**
+   * Checks the payload for a file getting removed
+   * and removes it from the upload files if found
+   * @param request - the hapi request
+   * @param state - the form state
+   * @returns updated state if any files have been removed
+   */
+  async checkRemovedFiles(request, state) {
+    const {
+      path
+    } = this;
+    const {
+      params
+    } = request;
+    const upload = this.getUploadFromState(state);
+    const files = this.getFilesFromState(state);
+    const filesUpdated = files.filter(({
+      uploadId
+    }) => uploadId !== params.itemId);
+    if (filesUpdated.length === files.length) {
+      return;
+    }
+    await this.mergeState(request, state, {
+      upload: {
+        [path]: {
+          files: filesUpdated,
+          upload
+        }
+      }
+    });
+  }
+
+  /**
+   * Initiates a CDP file upload and stores in the upload state
+   * @param request - the hapi request
+   * @param state - the form state
+   */
+  async initiateAndStoreNewUpload(request, state) {
+    const {
+      fileUpload,
+      href,
+      path
+    } = this;
+    const {
+      options,
+      schema
+    } = fileUpload;
+    const files = this.getFilesFromState(state);
+
+    // Reset the upload in state
+    let upload;
+
+    // Don't initiate anymore after minimum of `schema.max` or MAX_UPLOADS
+    const max = Math.min(schema.max ?? MAX_UPLOADS, MAX_UPLOADS);
+    if (files.length < max) {
+      const outputEmail = this.model.def.outputEmail ?? 'defraforms@defra.gov.uk';
+      const newUpload = await initiateUpload(href, outputEmail, options.accept);
+      if (newUpload === undefined) {
+        throw Boom.badRequest('Unexpected empty response from initiateUpload');
+      }
+      upload = newUpload;
+    }
+    return this.mergeState(request, state, {
+      upload: {
+        [path]: {
+          files,
+          upload
+        }
+      }
+    });
+  }
+}
+//# sourceMappingURL=FileUploadPageController.js.map

package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileUploadPageController.js","names":["ComponentType","Boom","wait","tempItemSchema","getError","getExponentialBackoffDelay","QuestionPageController","getProxyUrlForLocalDevelopment","getUploadStatus","initiateUpload","FileStatus","UploadStatus","MAX_UPLOADS","CDP_UPLOAD_TIMEOUT_MS","prepareStatus","status","file","form","isPending","fileStatus","pending","errorMessage","prepareFileState","fileState","FileUploadPageController","fileUpload","fileDeleteViewName","constructor","model","pageDef","collection","fileUploads","fields","filter","field","type","FileUploadField","at","length","badImplementation","path","indexOf","name","viewName","getFormDataFromState","request","state","payload","files","getFilesFromState","undefined","getState","refreshUpload","uploadState","upload","getUploadFromState","makeGetItemDeleteRouteHandler","context","h","viewModel","params","fileToRemove","find","uploadId","itemId","notFound","filename","view","backLink","getBackLink","pageTitle","itemTitle","confirmation","text","buttonConfirm","buttonCancel","makePostItemDeleteRouteHandler","confirm","getFormParams","checkRemovedFiles","proceed","getErrors","details","errors","forEach","error","isUploadError","isUploadRootError","push","value","href","getViewModel","components","formComponent","id","index","proxyUrl","uploadUrl","formAction","componentsBefore","slice","checkUploadStatus","depth","initiateAndStoreNewUpload","statusResponse","badRequest","uploadStatus","initiated","logger","gatewayTimeout","toFixed","delay","info","validationResult","validate","stripUnknown","complete","unshift","mergeState","cacheService","services","setFlash","filesUpdated","options","schema","max","Math","min","outputEmail","def","newUpload","accept"],"sources":["../../../../../src/server/plugins/engine/pageControllers/FileUploadPageController.ts"],"sourcesContent":["import { ComponentType, type PageFileUpload } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit } from '@hapi/hapi'\nimport { wait } from '@hapi/hoek'\nimport { type ValidationErrorItem } from 'joi'\n\nimport {\n  tempItemSchema,\n  type FileUploadField\n} from '~/src/server/plugins/engine/components/FileUploadField.js'\nimport {\n  getError,\n  getExponentialBackoffDelay\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'\nimport { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport {\n  getUploadStatus,\n  initiateUpload\n} from '~/src/server/plugins/engine/services/uploadService.js'\nimport {\n  FileStatus,\n  UploadStatus,\n  type FeaturedFormPageViewModel,\n  type FileState,\n  type FormContext,\n  type FormContextRequest,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type ItemDeletePageViewModel,\n  type UploadInitiateResponse,\n  type UploadStatusFileResponse\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload\n} from '~/src/server/routes/types.js'\n\nconst MAX_UPLOADS = 25\nconst CDP_UPLOAD_TIMEOUT_MS = 60000 // 1 minute\n\nexport function prepareStatus(status: UploadStatusFileResponse) {\n  const file = status.form.file\n  const isPending = file.fileStatus === FileStatus.pending\n\n  if (!file.errorMessage && isPending) {\n    file.errorMessage = 'The selected file has not fully uploaded'\n  }\n\n  return status\n}\n\nfunction prepareFileState(fileState: FileState) {\n  prepareStatus(fileState.status)\n\n  return fileState\n}\n\nexport class FileUploadPageController extends QuestionPageController {\n  declare pageDef: PageFileUpload\n\n  fileUpload: FileUploadField\n  fileDeleteViewName = 'item-delete'\n\n  constructor(model: FormModel, pageDef: PageFileUpload) {\n    super(model, pageDef)\n\n    const { collection } = this\n\n    // Get the file upload fields from the collection\n    const fileUploads = collection.fields.filter(\n      (field): field is FileUploadField =>\n        field.type === ComponentType.FileUploadField\n    )\n\n    const fileUpload = fileUploads.at(0)\n\n    // Assert we have exactly 1 file upload component\n    if (!fileUpload || fileUploads.length > 1) {\n      throw Boom.badImplementation(\n        `Expected 1 FileUploadFieldComponent in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assert the file upload component is the first form component\n    if (collection.fields.indexOf(fileUpload) !== 0) {\n      throw Boom.badImplementation(\n        `Expected '${fileUpload.name}' to be the first form component in FileUploadPageController '${pageDef.path}'`\n      )\n    }\n\n    // Assign the file upload component to the controller\n    this.fileUpload = fileUpload\n    this.viewName = 'file-upload'\n  }\n\n  getFormDataFromState(\n    request: FormContextRequest | undefined,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload } = this\n\n    const payload = super.getFormDataFromState(request, state)\n    const files = this.getFilesFromState(state)\n\n    // Append the files to the payload\n    payload[fileUpload.name] = files.length ? files : undefined\n\n    return payload\n  }\n\n  async getState(request: FormRequest | FormRequestPayload) {\n    const { fileUpload } = this\n\n    // Get the actual state\n    const state = await super.getState(request)\n    const files = this.getFilesFromState(state)\n\n    // Overwrite the files with those in the upload state\n    state[fileUpload.name] = files\n\n    return this.refreshUpload(request, state)\n  }\n\n  /**\n   * Get the uploaded files from state.\n   */\n  getFilesFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.files ?? []\n  }\n\n  /**\n   * Get the initiated upload from state.\n   */\n  getUploadFromState(state: FormSubmissionState) {\n    const { path } = this\n\n    const uploadState = state.upload?.[path]\n    return uploadState?.upload\n  }\n\n  makeGetItemDeleteRouteHandler() {\n    return (\n      request: FormRequest,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { viewModel } = this\n      const { params } = request\n      const { state } = context\n\n      const files = this.getFilesFromState(state)\n\n      const fileToRemove = files.find(\n        ({ uploadId }) => uploadId === params.itemId\n      )\n\n      if (!fileToRemove) {\n        throw Boom.notFound('File to delete not found')\n      }\n\n      const { filename } = fileToRemove.status.form.file\n\n      return h.view(this.fileDeleteViewName, {\n        ...viewModel,\n        context,\n        backLink: this.getBackLink(request, context),\n        pageTitle: `Are you sure you want to remove this file?`,\n        itemTitle: filename,\n        confirmation: { text: 'You cannot recover removed files.' },\n        buttonConfirm: { text: 'Remove file' },\n        buttonCancel: { text: 'Cancel' }\n      } satisfies ItemDeletePageViewModel)\n    }\n  }\n\n  makePostItemDeleteRouteHandler() {\n    return async (\n      request: FormRequestPayload,\n      context: FormContext,\n      h: Pick<ResponseToolkit, 'redirect' | 'view'>\n    ) => {\n      const { path } = this\n      const { state } = context\n\n      const { confirm } = this.getFormParams(request)\n\n      // Check for any removed files in the POST payload\n      if (confirm) {\n        await this.checkRemovedFiles(request, state)\n        return this.proceed(request, h, path)\n      }\n\n      return this.proceed(request, h)\n    }\n  }\n\n  getErrors(details?: ValidationErrorItem[]) {\n    const { fileUpload } = this\n\n    if (details) {\n      const errors: FormSubmissionError[] = []\n\n      details.forEach((error) => {\n        const isUploadError = error.path[0] === fileUpload.name\n        const isUploadRootError = isUploadError && error.path.length === 1\n\n        if (!isUploadError || isUploadRootError) {\n          // The error is for the root of the upload or another\n          // field on the page so defer to the getError helper\n          errors.push(getError(error))\n        } else {\n          const { context, path, type } = error\n\n          if (type === 'object.unknown' && path.at(-1) === 'errorMessage') {\n            const value = context?.value as string | undefined\n\n            if (value) {\n              const name = fileUpload.name\n              const text = typeof value === 'string' ? value : 'Unknown error'\n              const href = `#${name}`\n\n              errors.push({ path, href, name, text })\n            }\n          }\n        }\n      })\n\n      return errors\n    }\n  }\n\n  getViewModel(\n    request: FormContextRequest,\n    context: FormContext\n  ): FeaturedFormPageViewModel {\n    const { fileUpload } = this\n    const { state } = context\n\n    const upload = this.getUploadFromState(state)\n\n    const viewModel = super.getViewModel(request, context)\n    const { components } = viewModel\n\n    // Featured form component\n    const [formComponent] = components.filter(\n      ({ model }) => model.id === fileUpload.name\n    )\n\n    const index = components.indexOf(formComponent)\n\n    const proxyUrl = getProxyUrlForLocalDevelopment(upload?.uploadUrl)\n\n    return {\n      ...viewModel,\n      formAction: upload?.uploadUrl,\n      uploadId: upload?.uploadId,\n      formComponent,\n\n      // Split out components before/after\n      componentsBefore: components.slice(0, index),\n      components: components.slice(index),\n      proxyUrl\n    }\n  }\n\n  /**\n   * Refreshes the CDP upload and files in the\n   * state and checks for any removed files.\n   *\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise we initiate a new one.\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async refreshUpload(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    state = await this.checkUploadStatus(request, state)\n\n    return state\n  }\n\n  /**\n   * If an upload exists and hasn't been consumed\n   * it gets re-used, otherwise a new one is initiated.\n   * @param request - the hapi request\n   * @param state - the form state\n   * @param depth - the number of retries so far\n   */\n  private async checkUploadStatus(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState,\n    depth = 1\n  ): Promise<FormSubmissionState> {\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    // If no upload exists, initiate a new one.\n    if (!upload?.uploadId) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const uploadId = upload.uploadId\n    const statusResponse = await getUploadStatus(uploadId)\n    if (!statusResponse) {\n      throw Boom.badRequest(\n        `Unexpected empty response from getUploadStatus for ${uploadId}`\n      )\n    }\n\n    // Re-use the upload if it is still in the \"initiated\" state.\n    if (statusResponse.uploadStatus === UploadStatus.initiated) {\n      return state\n    }\n\n    if (statusResponse.uploadStatus === UploadStatus.pending) {\n      // Using exponential backoff delays:\n      // Depth 1: 2000ms, Depth 2: 4000ms, Depth 3: 8000ms, Depth 4: 16000ms, Depth 5+: 30000ms (capped)\n      // A depth of 5 (or more) implies cumulative delays roughly reaching 55 seconds.\n      if (depth >= 5) {\n        request.logger.error(\n          `Exceeded cumulative retry delay for ${uploadId} (depth: ${depth}). Re-initiating a new upload.`\n        )\n        await this.initiateAndStoreNewUpload(request, state)\n        throw Boom.gatewayTimeout(\n          `Timed out waiting for ${uploadId} after cumulative retries exceeding ${((CDP_UPLOAD_TIMEOUT_MS - 5000) / 1000).toFixed(0)} seconds`\n        )\n      }\n      const delay = getExponentialBackoffDelay(depth)\n      request.logger.info(\n        `Waiting ${delay / 1000} seconds for ${uploadId} to complete (depth: ${depth})`\n      )\n      await wait(delay)\n      return this.checkUploadStatus(request, state, depth + 1)\n    }\n\n    // Only add to files state if the file validates.\n    // This secures against html tampering of the file input\n    // by adding a 'multiple' attribute or it being\n    // changed to a simple text field or similar.\n    const validationResult = tempItemSchema.validate(\n      { uploadId, status: statusResponse },\n      { stripUnknown: true }\n    )\n    const error = validationResult.error\n    const fileState = validationResult.value as FileState\n\n    if (error) {\n      return this.initiateAndStoreNewUpload(request, state)\n    }\n\n    const file = fileState.status.form.file\n    if (file.fileStatus === FileStatus.complete) {\n      files.unshift(prepareFileState(fileState))\n      await this.mergeState(request, state, {\n        upload: { [this.path]: { files, upload } }\n      })\n    } else {\n      // Flash the error message.\n      const { fileUpload } = this\n      const { cacheService } = request.services([])\n      const name = fileUpload.name\n      const text = file.errorMessage ?? 'Unknown error'\n      const errors: FormSubmissionError[] = [\n        { path: [name], href: `#${name}`, name, text }\n      ]\n      cacheService.setFlash(request, { errors })\n    }\n\n    return this.initiateAndStoreNewUpload(request, state)\n  }\n\n  /**\n   * Checks the payload for a file getting removed\n   * and removes it from the upload files if found\n   * @param request - the hapi request\n   * @param state - the form state\n   * @returns updated state if any files have been removed\n   */\n  private async checkRemovedFiles(\n    request: FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { path } = this\n    const { params } = request\n\n    const upload = this.getUploadFromState(state)\n    const files = this.getFilesFromState(state)\n\n    const filesUpdated = files.filter(\n      ({ uploadId }) => uploadId !== params.itemId\n    )\n\n    if (filesUpdated.length === files.length) {\n      return\n    }\n\n    await this.mergeState(request, state, {\n      upload: { [path]: { files: filesUpdated, upload } }\n    })\n  }\n\n  /**\n   * Initiates a CDP file upload and stores in the upload state\n   * @param request - the hapi request\n   * @param state - the form state\n   */\n  private async initiateAndStoreNewUpload(\n    request: FormRequest | FormRequestPayload,\n    state: FormSubmissionState\n  ) {\n    const { fileUpload, href, path } = this\n    const { options, schema } = fileUpload\n\n    const files = this.getFilesFromState(state)\n\n    // Reset the upload in state\n    let upload: UploadInitiateResponse | undefined\n\n    // Don't initiate anymore after minimum of `schema.max` or MAX_UPLOADS\n    const max = Math.min(schema.max ?? MAX_UPLOADS, MAX_UPLOADS)\n\n    if (files.length < max) {\n      const outputEmail =\n        this.model.def.outputEmail ?? 'defraforms@defra.gov.uk'\n\n      const newUpload = await initiateUpload(href, outputEmail, options.accept)\n\n      if (newUpload === undefined) {\n        throw Boom.badRequest('Unexpected empty response from initiateUpload')\n      }\n\n      upload = newUpload\n    }\n\n    return this.mergeState(request, state, {\n      upload: { [path]: { files, upload } }\n    })\n  }\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA6B,oBAAoB;AACvE,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,IAAI,QAAQ,YAAY;AAGjC,SACEC,cAAc;AAGhB,SACEC,QAAQ,EACRC,0BAA0B;AAG5B,SAASC,sBAAsB;AAC/B,SAASC,8BAA8B;AACvC,SACEC,eAAe,EACfC,cAAc;AAEhB,SACEC,UAAU,EACVC,YAAY;AAgBd,MAAMC,WAAW,GAAG,EAAE;AACtB,MAAMC,qBAAqB,GAAG,KAAK,EAAC;;AAEpC,OAAO,SAASC,aAAaA,CAACC,MAAgC,EAAE;EAC9D,MAAMC,IAAI,GAAGD,MAAM,CAACE,IAAI,CAACD,IAAI;EAC7B,MAAME,SAAS,GAAGF,IAAI,CAACG,UAAU,KAAKT,UAAU,CAACU,OAAO;EAExD,IAAI,CAACJ,IAAI,CAACK,YAAY,IAAIH,SAAS,EAAE;IACnCF,IAAI,CAACK,YAAY,GAAG,0CAA0C;EAChE;EAEA,OAAON,MAAM;AACf;AAEA,SAASO,gBAAgBA,CAACC,SAAoB,EAAE;EAC9CT,aAAa,CAACS,SAAS,CAACR,MAAM,CAAC;EAE/B,OAAOQ,SAAS;AAClB;AAEA,OAAO,MAAMC,wBAAwB,SAASlB,sBAAsB,CAAC;EAGnEmB,UAAU;EACVC,kBAAkB,GAAG,aAAa;EAElCC,WAAWA,CAACC,KAAgB,EAAEC,OAAuB,EAAE;IACrD,KAAK,CAACD,KAAK,EAAEC,OAAO,CAAC;IAErB,MAAM;MAAEC;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMC,WAAW,GAAGD,UAAU,CAACE,MAAM,CAACC,MAAM,CACzCC,KAAK,IACJA,KAAK,CAACC,IAAI,KAAKnC,aAAa,CAACoC,eACjC,CAAC;IAED,MAAMX,UAAU,GAAGM,WAAW,CAACM,EAAE,CAAC,CAAC,CAAC;;IAEpC;IACA,IAAI,CAACZ,UAAU,IAAIM,WAAW,CAACO,MAAM,GAAG,CAAC,EAAE;MACzC,MAAMrC,IAAI,CAACsC,iBAAiB,CAC1B,oEAAoEV,OAAO,CAACW,IAAI,GAClF,CAAC;IACH;;IAEA;IACA,IAAIV,UAAU,CAACE,MAAM,CAACS,OAAO,CAAChB,UAAU,CAAC,KAAK,CAAC,EAAE;MAC/C,MAAMxB,IAAI,CAACsC,iBAAiB,CAC1B,aAAad,UAAU,CAACiB,IAAI,iEAAiEb,OAAO,CAACW,IAAI,GAC3G,CAAC;IACH;;IAEA;IACA,IAAI,CAACf,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACkB,QAAQ,GAAG,aAAa;EAC/B;EAEAC,oBAAoBA,CAClBC,OAAuC,EACvCC,KAA0B,EAC1B;IACA,MAAM;MAAErB;IAAW,CAAC,GAAG,IAAI;IAE3B,MAAMsB,OAAO,GAAG,KAAK,CAACH,oBAAoB,CAACC,OAAO,EAAEC,KAAK,CAAC;IAC1D,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAC,OAAO,CAACtB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK,CAACV,MAAM,GAAGU,KAAK,GAAGE,SAAS;IAE3D,OAAOH,OAAO;EAChB;EAEA,MAAMI,QAAQA,CAACN,OAAyC,EAAE;IACxD,MAAM;MAAEpB;IAAW,CAAC,GAAG,IAAI;;IAE3B;IACA,MAAMqB,KAAK,GAAG,MAAM,KAAK,CAACK,QAAQ,CAACN,OAAO,CAAC;IAC3C,MAAMG,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACAA,KAAK,CAACrB,UAAU,CAACiB,IAAI,CAAC,GAAGM,KAAK;IAE9B,OAAO,IAAI,CAACI,aAAa,CAACP,OAAO,EAAEC,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACEG,iBAAiBA,CAACH,KAA0B,EAAE;IAC5C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEL,KAAK,IAAI,EAAE;EACjC;;EAEA;AACF;AACA;EACEO,kBAAkBA,CAACT,KAA0B,EAAE;IAC7C,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IAErB,MAAMa,WAAW,GAAGP,KAAK,CAACQ,MAAM,GAAGd,IAAI,CAAC;IACxC,OAAOa,WAAW,EAAEC,MAAM;EAC5B;EAEAE,6BAA6BA,CAAA,EAAG;IAC9B,OAAO,CACLX,OAAoB,EACpBY,OAAoB,EACpBC,CAA6C,KAC1C;MACH,MAAM;QAAEC;MAAU,CAAC,GAAG,IAAI;MAC1B,MAAM;QAAEC;MAAO,CAAC,GAAGf,OAAO;MAC1B,MAAM;QAAEC;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAMT,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;MAE3C,MAAMe,YAAY,GAAGb,KAAK,CAACc,IAAI,CAC7B,CAAC;QAAEC;MAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;MAED,IAAI,CAACH,YAAY,EAAE;QACjB,MAAM5D,IAAI,CAACgE,QAAQ,CAAC,0BAA0B,CAAC;MACjD;MAEA,MAAM;QAAEC;MAAS,CAAC,GAAGL,YAAY,CAAC9C,MAAM,CAACE,IAAI,CAACD,IAAI;MAElD,OAAO0C,CAAC,CAACS,IAAI,CAAC,IAAI,CAACzC,kBAAkB,EAAE;QACrC,GAAGiC,SAAS;QACZF,OAAO;QACPW,QAAQ,EAAE,IAAI,CAACC,WAAW,CAACxB,OAAO,EAAEY,OAAO,CAAC;QAC5Ca,SAAS,EAAE,4CAA4C;QACvDC,SAAS,EAAEL,QAAQ;QACnBM,YAAY,EAAE;UAAEC,IAAI,EAAE;QAAoC,CAAC;QAC3DC,aAAa,EAAE;UAAED,IAAI,EAAE;QAAc,CAAC;QACtCE,YAAY,EAAE;UAAEF,IAAI,EAAE;QAAS;MACjC,CAAmC,CAAC;IACtC,CAAC;EACH;EAEAG,8BAA8BA,CAAA,EAAG;IAC/B,OAAO,OACL/B,OAA2B,EAC3BY,OAAoB,EACpBC,CAA6C,KAC1C;MACH,MAAM;QAAElB;MAAK,CAAC,GAAG,IAAI;MACrB,MAAM;QAAEM;MAAM,CAAC,GAAGW,OAAO;MAEzB,MAAM;QAAEoB;MAAQ,CAAC,GAAG,IAAI,CAACC,aAAa,CAACjC,OAAO,CAAC;;MAE/C;MACA,IAAIgC,OAAO,EAAE;QACX,MAAM,IAAI,CAACE,iBAAiB,CAAClC,OAAO,EAAEC,KAAK,CAAC;QAC5C,OAAO,IAAI,CAACkC,OAAO,CAACnC,OAAO,EAAEa,CAAC,EAAElB,IAAI,CAAC;MACvC;MAEA,OAAO,IAAI,CAACwC,OAAO,CAACnC,OAAO,EAAEa,CAAC,CAAC;IACjC,CAAC;EACH;EAEAuB,SAASA,CAACC,OAA+B,EAAE;IACzC,MAAM;MAAEzD;IAAW,CAAC,GAAG,IAAI;IAE3B,IAAIyD,OAAO,EAAE;MACX,MAAMC,MAA6B,GAAG,EAAE;MAExCD,OAAO,CAACE,OAAO,CAAEC,KAAK,IAAK;QACzB,MAAMC,aAAa,GAAGD,KAAK,CAAC7C,IAAI,CAAC,CAAC,CAAC,KAAKf,UAAU,CAACiB,IAAI;QACvD,MAAM6C,iBAAiB,GAAGD,aAAa,IAAID,KAAK,CAAC7C,IAAI,CAACF,MAAM,KAAK,CAAC;QAElE,IAAI,CAACgD,aAAa,IAAIC,iBAAiB,EAAE;UACvC;UACA;UACAJ,MAAM,CAACK,IAAI,CAACpF,QAAQ,CAACiF,KAAK,CAAC,CAAC;QAC9B,CAAC,MAAM;UACL,MAAM;YAAE5B,OAAO;YAAEjB,IAAI;YAAEL;UAAK,CAAC,GAAGkD,KAAK;UAErC,IAAIlD,IAAI,KAAK,gBAAgB,IAAIK,IAAI,CAACH,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE;YAC/D,MAAMoD,KAAK,GAAGhC,OAAO,EAAEgC,KAA2B;YAElD,IAAIA,KAAK,EAAE;cACT,MAAM/C,IAAI,GAAGjB,UAAU,CAACiB,IAAI;cAC5B,MAAM+B,IAAI,GAAG,OAAOgB,KAAK,KAAK,QAAQ,GAAGA,KAAK,GAAG,eAAe;cAChE,MAAMC,IAAI,GAAG,IAAIhD,IAAI,EAAE;cAEvByC,MAAM,CAACK,IAAI,CAAC;gBAAEhD,IAAI;gBAAEkD,IAAI;gBAAEhD,IAAI;gBAAE+B;cAAK,CAAC,CAAC;YACzC;UACF;QACF;MACF,CAAC,CAAC;MAEF,OAAOU,MAAM;IACf;EACF;EAEAQ,YAAYA,CACV9C,OAA2B,EAC3BY,OAAoB,EACO;IAC3B,MAAM;MAAEhC;IAAW,CAAC,GAAG,IAAI;IAC3B,MAAM;MAAEqB;IAAM,CAAC,GAAGW,OAAO;IAEzB,MAAMH,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAE7C,MAAMa,SAAS,GAAG,KAAK,CAACgC,YAAY,CAAC9C,OAAO,EAAEY,OAAO,CAAC;IACtD,MAAM;MAAEmC;IAAW,CAAC,GAAGjC,SAAS;;IAEhC;IACA,MAAM,CAACkC,aAAa,CAAC,GAAGD,UAAU,CAAC3D,MAAM,CACvC,CAAC;MAAEL;IAAM,CAAC,KAAKA,KAAK,CAACkE,EAAE,KAAKrE,UAAU,CAACiB,IACzC,CAAC;IAED,MAAMqD,KAAK,GAAGH,UAAU,CAACnD,OAAO,CAACoD,aAAa,CAAC;IAE/C,MAAMG,QAAQ,GAAGzF,8BAA8B,CAAC+C,MAAM,EAAE2C,SAAS,CAAC;IAElE,OAAO;MACL,GAAGtC,SAAS;MACZuC,UAAU,EAAE5C,MAAM,EAAE2C,SAAS;MAC7BlC,QAAQ,EAAET,MAAM,EAAES,QAAQ;MAC1B8B,aAAa;MAEb;MACAM,gBAAgB,EAAEP,UAAU,CAACQ,KAAK,CAAC,CAAC,EAAEL,KAAK,CAAC;MAC5CH,UAAU,EAAEA,UAAU,CAACQ,KAAK,CAACL,KAAK,CAAC;MACnCC;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAc5C,aAAaA,CACzBP,OAAyC,EACzCC,KAA0B,EAC1B;IACAA,KAAK,GAAG,MAAM,IAAI,CAACuD,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,CAAC;IAEpD,OAAOA,KAAK;EACd;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAcuD,iBAAiBA,CAC7BxD,OAAyC,EACzCC,KAA0B,EAC1BwD,KAAK,GAAG,CAAC,EACqB;IAC9B,MAAMhD,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAI,CAACQ,MAAM,EAAES,QAAQ,EAAE;MACrB,OAAO,IAAI,CAACwC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAMiB,QAAQ,GAAGT,MAAM,CAACS,QAAQ;IAChC,MAAMyC,cAAc,GAAG,MAAMhG,eAAe,CAACuD,QAAQ,CAAC;IACtD,IAAI,CAACyC,cAAc,EAAE;MACnB,MAAMvG,IAAI,CAACwG,UAAU,CACnB,sDAAsD1C,QAAQ,EAChE,CAAC;IACH;;IAEA;IACA,IAAIyC,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACgG,SAAS,EAAE;MAC1D,OAAO7D,KAAK;IACd;IAEA,IAAI0D,cAAc,CAACE,YAAY,KAAK/F,YAAY,CAACS,OAAO,EAAE;MACxD;MACA;MACA;MACA,IAAIkF,KAAK,IAAI,CAAC,EAAE;QACdzD,OAAO,CAAC+D,MAAM,CAACvB,KAAK,CAClB,uCAAuCtB,QAAQ,YAAYuC,KAAK,gCAClE,CAAC;QACD,MAAM,IAAI,CAACC,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;QACpD,MAAM7C,IAAI,CAAC4G,cAAc,CACvB,yBAAyB9C,QAAQ,uCAAuC,CAAC,CAAClD,qBAAqB,GAAG,IAAI,IAAI,IAAI,EAAEiG,OAAO,CAAC,CAAC,CAAC,UAC5H,CAAC;MACH;MACA,MAAMC,KAAK,GAAG1G,0BAA0B,CAACiG,KAAK,CAAC;MAC/CzD,OAAO,CAAC+D,MAAM,CAACI,IAAI,CACjB,WAAWD,KAAK,GAAG,IAAI,gBAAgBhD,QAAQ,wBAAwBuC,KAAK,GAC9E,CAAC;MACD,MAAMpG,IAAI,CAAC6G,KAAK,CAAC;MACjB,OAAO,IAAI,CAACV,iBAAiB,CAACxD,OAAO,EAAEC,KAAK,EAAEwD,KAAK,GAAG,CAAC,CAAC;IAC1D;;IAEA;IACA;IACA;IACA;IACA,MAAMW,gBAAgB,GAAG9G,cAAc,CAAC+G,QAAQ,CAC9C;MAAEnD,QAAQ;MAAEhD,MAAM,EAAEyF;IAAe,CAAC,EACpC;MAAEW,YAAY,EAAE;IAAK,CACvB,CAAC;IACD,MAAM9B,KAAK,GAAG4B,gBAAgB,CAAC5B,KAAK;IACpC,MAAM9D,SAAS,GAAG0F,gBAAgB,CAACxB,KAAkB;IAErD,IAAIJ,KAAK,EAAE;MACT,OAAO,IAAI,CAACkB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;IACvD;IAEA,MAAM9B,IAAI,GAAGO,SAAS,CAACR,MAAM,CAACE,IAAI,CAACD,IAAI;IACvC,IAAIA,IAAI,CAACG,UAAU,KAAKT,UAAU,CAAC0G,QAAQ,EAAE;MAC3CpE,KAAK,CAACqE,OAAO,CAAC/F,gBAAgB,CAACC,SAAS,CAAC,CAAC;MAC1C,MAAM,IAAI,CAAC+F,UAAU,CAACzE,OAAO,EAAEC,KAAK,EAAE;QACpCQ,MAAM,EAAE;UAAE,CAAC,IAAI,CAACd,IAAI,GAAG;YAAEQ,KAAK;YAAEM;UAAO;QAAE;MAC3C,CAAC,CAAC;IACJ,CAAC,MAAM;MACL;MACA,MAAM;QAAE7B;MAAW,CAAC,GAAG,IAAI;MAC3B,MAAM;QAAE8F;MAAa,CAAC,GAAG1E,OAAO,CAAC2E,QAAQ,CAAC,EAAE,CAAC;MAC7C,MAAM9E,IAAI,GAAGjB,UAAU,CAACiB,IAAI;MAC5B,MAAM+B,IAAI,GAAGzD,IAAI,CAACK,YAAY,IAAI,eAAe;MACjD,MAAM8D,MAA6B,GAAG,CACpC;QAAE3C,IAAI,EAAE,CAACE,IAAI,CAAC;QAAEgD,IAAI,EAAE,IAAIhD,IAAI,EAAE;QAAEA,IAAI;QAAE+B;MAAK,CAAC,CAC/C;MACD8C,YAAY,CAACE,QAAQ,CAAC5E,OAAO,EAAE;QAAEsC;MAAO,CAAC,CAAC;IAC5C;IAEA,OAAO,IAAI,CAACoB,yBAAyB,CAAC1D,OAAO,EAAEC,KAAK,CAAC;EACvD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAciC,iBAAiBA,CAC7BlC,OAA2B,EAC3BC,KAA0B,EAC1B;IACA,MAAM;MAAEN;IAAK,CAAC,GAAG,IAAI;IACrB,MAAM;MAAEoB;IAAO,CAAC,GAAGf,OAAO;IAE1B,MAAMS,MAAM,GAAG,IAAI,CAACC,kBAAkB,CAACT,KAAK,CAAC;IAC7C,MAAME,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;IAE3C,MAAM4E,YAAY,GAAG1E,KAAK,CAACf,MAAM,CAC/B,CAAC;MAAE8B;IAAS,CAAC,KAAKA,QAAQ,KAAKH,MAAM,CAACI,MACxC,CAAC;IAED,IAAI0D,YAAY,CAACpF,MAAM,KAAKU,KAAK,CAACV,MAAM,EAAE;MACxC;IACF;IAEA,MAAM,IAAI,CAACgF,UAAU,CAACzE,OAAO,EAAEC,KAAK,EAAE;MACpCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK,EAAE0E,YAAY;UAAEpE;QAAO;MAAE;IACpD,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAciD,yBAAyBA,CACrC1D,OAAyC,EACzCC,KAA0B,EAC1B;IACA,MAAM;MAAErB,UAAU;MAAEiE,IAAI;MAAElD;IAAK,CAAC,GAAG,IAAI;IACvC,MAAM;MAAEmF,OAAO;MAAEC;IAAO,CAAC,GAAGnG,UAAU;IAEtC,MAAMuB,KAAK,GAAG,IAAI,CAACC,iBAAiB,CAACH,KAAK,CAAC;;IAE3C;IACA,IAAIQ,MAA0C;;IAE9C;IACA,MAAMuE,GAAG,GAAGC,IAAI,CAACC,GAAG,CAACH,MAAM,CAACC,GAAG,IAAIjH,WAAW,EAAEA,WAAW,CAAC;IAE5D,IAAIoC,KAAK,CAACV,MAAM,GAAGuF,GAAG,EAAE;MACtB,MAAMG,WAAW,GACf,IAAI,CAACpG,KAAK,CAACqG,GAAG,CAACD,WAAW,IAAI,yBAAyB;MAEzD,MAAME,SAAS,GAAG,MAAMzH,cAAc,CAACiF,IAAI,EAAEsC,WAAW,EAAEL,OAAO,CAACQ,MAAM,CAAC;MAEzE,IAAID,SAAS,KAAKhF,SAAS,EAAE;QAC3B,MAAMjD,IAAI,CAACwG,UAAU,CAAC,+CAA+C,CAAC;MACxE;MAEAnD,MAAM,GAAG4E,SAAS;IACpB;IAEA,OAAO,IAAI,CAACZ,UAAU,CAACzE,OAAO,EAAEC,KAAK,EAAE;MACrCQ,MAAM,EAAE;QAAE,CAACd,IAAI,GAAG;UAAEQ,KAAK;UAAEM;QAAO;MAAE;IACtC,CAAC,CAAC;EACJ;AACF","ignoreList":[]}

package/.server/server/plugins/engine/pageControllers/PageController.js

@@ -0,0 +1,133 @@
+import { ControllerPath } from '@defra/forms-model';
+import Boom from '@hapi/boom';
+import { encodeUrl, getStartPath, normalisePath } from "../helpers.js";
+export class PageController {
+  /**
+   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.
+   */
+  def;
+  name;
+  model;
+  pageDef;
+  title;
+  section;
+  condition;
+  events;
+  collection;
+  viewName = 'index';
+  constructor(model, pageDef) {
+    const {
+      def
+    } = model;
+    this.def = def;
+    this.name = def.name;
+    this.model = model;
+    this.pageDef = pageDef;
+    this.title = pageDef.title;
+    this.events = pageDef.events;
+
+    // Resolve section
+    this.section = model.sections.find(section => section.name === pageDef.section);
+
+    // Resolve condition
+    if (pageDef.condition) {
+      this.condition = model.conditions[pageDef.condition];
+    }
+
+    // Override view name
+    if (pageDef.view) {
+      this.viewName = pageDef.view;
+    }
+  }
+  get path() {
+    return this.pageDef.path;
+  }
+  get href() {
+    const {
+      path
+    } = this;
+    return this.getHref(`/${normalisePath(path)}`);
+  }
+  get keys() {
+    return this.collection?.keys ?? [];
+  }
+
+  /**
+   * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+   */
+  get getRouteOptions() {
+    return {};
+  }
+
+  /**
+   * {@link https://hapi.dev/api/?v=20.1.2#route-options}
+   */
+  get postRouteOptions() {
+    return {};
+  }
+  get viewModel() {
+    const {
+      name,
+      section,
+      title
+    } = this;
+    const showTitle = true;
+    const pageTitle = title;
+    const sectionTitle = section?.hideTitle !== true ? section?.title : '';
+    return {
+      name,
+      page: this,
+      pageTitle,
+      sectionTitle,
+      showTitle,
+      isStartPage: false,
+      serviceUrl: this.getHref('/'),
+      feedbackLink: this.feedbackLink,
+      phaseTag: this.phaseTag
+    };
+  }
+  get feedbackLink() {
+    const {
+      def
+    } = this;
+
+    // setting the feedbackLink to undefined here for feedback forms prevents the feedback link from being shown
+    const feedbackLink = def.feedback?.emailAddress ? `mailto:${def.feedback.emailAddress}` : def.feedback?.url;
+    return encodeUrl(feedbackLink);
+  }
+  get phaseTag() {
+    const {
+      def
+    } = this;
+    return def.phaseBanner?.phase;
+  }
+  getHref(path) {
+    const {
+      model
+    } = this;
+    return path === '/' ? `/${model.basePath}` // Strip trailing slash
+    : `/${model.basePath}${path}`;
+  }
+  getStartPath() {
+    return getStartPath(this.model);
+  }
+  getSummaryPath() {
+    return ControllerPath.Summary.valueOf();
+  }
+  getStatusPath() {
+    return ControllerPath.Status.valueOf();
+  }
+  makeGetRouteHandler() {
+    return (request, context, h) => {
+      const {
+        viewModel,
+        viewName
+      } = this;
+      return h.view(viewName, viewModel);
+    };
+  }
+  makePostRouteHandler() {
+    throw Boom.badRequest('Unsupported POST route handler for this page');
+  }
+}
+//# sourceMappingURL=PageController.js.map

package/.server/server/plugins/engine/pageControllers/PageController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageController.js","names":["ControllerPath","Boom","encodeUrl","getStartPath","normalisePath","PageController","def","name","model","pageDef","title","section","condition","events","collection","viewName","constructor","sections","find","conditions","view","path","href","getHref","keys","getRouteOptions","postRouteOptions","viewModel","showTitle","pageTitle","sectionTitle","hideTitle","page","isStartPage","serviceUrl","feedbackLink","phaseTag","feedback","emailAddress","url","phaseBanner","phase","basePath","getSummaryPath","Summary","valueOf","getStatusPath","Status","makeGetRouteHandler","request","context","h","makePostRouteHandler","badRequest"],"sources":["../../../../../src/server/plugins/engine/pageControllers/PageController.ts"],"sourcesContent":["import {\n  ControllerPath,\n  type Events,\n  type FormDefinition,\n  type Page,\n  type Section\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport {\n  type Lifecycle,\n  type ResponseToolkit,\n  type RouteOptions\n} from '@hapi/hapi'\n\nimport { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'\nimport {\n  encodeUrl,\n  getStartPath,\n  normalisePath\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type ExecutableCondition } from '~/src/server/plugins/engine/models/types.js'\nimport {\n  type FormContext,\n  type PageViewModelBase\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequest,\n  type FormRequestPayload,\n  type FormRequestPayloadRefs,\n  type FormRequestRefs\n} from '~/src/server/routes/types.js'\n\nexport class PageController {\n  /**\n   * The base class for all page controllers. Page controllers are responsible for generating the get and post route handlers when a user navigates to `/{id}/{path*}`.\n   */\n  def: FormDefinition\n  name?: string\n  model: FormModel\n  pageDef: Page\n  title: string\n  section?: Section\n  condition?: ExecutableCondition\n  events?: Events\n  collection?: ComponentCollection\n  viewName = 'index'\n\n  constructor(model: FormModel, pageDef: Page) {\n    const { def } = model\n\n    this.def = def\n    this.name = def.name\n    this.model = model\n    this.pageDef = pageDef\n    this.title = pageDef.title\n    this.events = pageDef.events\n\n    // Resolve section\n    this.section = model.sections.find(\n      (section) => section.name === pageDef.section\n    )\n\n    // Resolve condition\n    if (pageDef.condition) {\n      this.condition = model.conditions[pageDef.condition]\n    }\n\n    // Override view name\n    if (pageDef.view) {\n      this.viewName = pageDef.view\n    }\n  }\n\n  get path() {\n    return this.pageDef.path\n  }\n\n  get href() {\n    const { path } = this\n    return this.getHref(`/${normalisePath(path)}`)\n  }\n\n  get keys() {\n    return this.collection?.keys ?? []\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get getRouteOptions(): RouteOptions<FormRequestRefs> {\n    return {}\n  }\n\n  /**\n   * {@link https://hapi.dev/api/?v=20.1.2#route-options}\n   */\n  get postRouteOptions(): RouteOptions<FormRequestPayloadRefs> {\n    return {}\n  }\n\n  get viewModel(): PageViewModelBase {\n    const { name, section, title } = this\n\n    const showTitle = true\n    const pageTitle = title\n    const sectionTitle = section?.hideTitle !== true ? section?.title : ''\n\n    return {\n      name,\n      page: this,\n      pageTitle,\n      sectionTitle,\n      showTitle,\n      isStartPage: false,\n      serviceUrl: this.getHref('/'),\n      feedbackLink: this.feedbackLink,\n      phaseTag: this.phaseTag\n    }\n  }\n\n  get feedbackLink() {\n    const { def } = this\n\n    // setting the feedbackLink to undefined here for feedback forms prevents the feedback link from being shown\n    const feedbackLink = def.feedback?.emailAddress\n      ? `mailto:${def.feedback.emailAddress}`\n      : def.feedback?.url\n\n    return encodeUrl(feedbackLink)\n  }\n\n  get phaseTag() {\n    const { def } = this\n    return def.phaseBanner?.phase\n  }\n\n  getHref(path: string) {\n    const { model } = this\n\n    return path === '/'\n      ? `/${model.basePath}` // Strip trailing slash\n      : `/${model.basePath}${path}`\n  }\n\n  getStartPath() {\n    return getStartPath(this.model)\n  }\n\n  getSummaryPath() {\n    return ControllerPath.Summary.valueOf()\n  }\n\n  getStatusPath() {\n    return ControllerPath.Status.valueOf()\n  }\n\n  makeGetRouteHandler(): (\n    request: FormRequest,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) => ReturnType<Lifecycle.Method<FormRequestRefs>> {\n    return (request, context, h) => {\n      const { viewModel, viewName } = this\n      return h.view(viewName, viewModel)\n    }\n  }\n\n  makePostRouteHandler(): (\n    request: FormRequestPayload,\n    context: FormContext,\n    h: Pick<ResponseToolkit, 'redirect' | 'view'>\n  ) => ReturnType<Lifecycle.Method<FormRequestPayloadRefs>> {\n    throw Boom.badRequest('Unsupported POST route handler for this page')\n  }\n}\n"],"mappings":"AAAA,SACEA,cAAc,QAKT,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAQ7B,SACEC,SAAS,EACTC,YAAY,EACZC,aAAa;AAef,OAAO,MAAMC,cAAc,CAAC;EAC1B;AACF;AACA;EACEC,GAAG;EACHC,IAAI;EACJC,KAAK;EACLC,OAAO;EACPC,KAAK;EACLC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,UAAU;EACVC,QAAQ,GAAG,OAAO;EAElBC,WAAWA,CAACR,KAAgB,EAAEC,OAAa,EAAE;IAC3C,MAAM;MAAEH;IAAI,CAAC,GAAGE,KAAK;IAErB,IAAI,CAACF,GAAG,GAAGA,GAAG;IACd,IAAI,CAACC,IAAI,GAAGD,GAAG,CAACC,IAAI;IACpB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACC,KAAK,GAAGD,OAAO,CAACC,KAAK;IAC1B,IAAI,CAACG,MAAM,GAAGJ,OAAO,CAACI,MAAM;;IAE5B;IACA,IAAI,CAACF,OAAO,GAAGH,KAAK,CAACS,QAAQ,CAACC,IAAI,CAC/BP,OAAO,IAAKA,OAAO,CAACJ,IAAI,KAAKE,OAAO,CAACE,OACxC,CAAC;;IAED;IACA,IAAIF,OAAO,CAACG,SAAS,EAAE;MACrB,IAAI,CAACA,SAAS,GAAGJ,KAAK,CAACW,UAAU,CAACV,OAAO,CAACG,SAAS,CAAC;IACtD;;IAEA;IACA,IAAIH,OAAO,CAACW,IAAI,EAAE;MAChB,IAAI,CAACL,QAAQ,GAAGN,OAAO,CAACW,IAAI;IAC9B;EACF;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACZ,OAAO,CAACY,IAAI;EAC1B;EAEA,IAAIC,IAAIA,CAAA,EAAG;IACT,MAAM;MAAED;IAAK,CAAC,GAAG,IAAI;IACrB,OAAO,IAAI,CAACE,OAAO,CAAC,IAAInB,aAAa,CAACiB,IAAI,CAAC,EAAE,CAAC;EAChD;EAEA,IAAIG,IAAIA,CAAA,EAAG;IACT,OAAO,IAAI,CAACV,UAAU,EAAEU,IAAI,IAAI,EAAE;EACpC;;EAEA;AACF;AACA;EACE,IAAIC,eAAeA,CAAA,EAAkC;IACnD,OAAO,CAAC,CAAC;EACX;;EAEA;AACF;AACA;EACE,IAAIC,gBAAgBA,CAAA,EAAyC;IAC3D,OAAO,CAAC,CAAC;EACX;EAEA,IAAIC,SAASA,CAAA,EAAsB;IACjC,MAAM;MAAEpB,IAAI;MAAEI,OAAO;MAAED;IAAM,CAAC,GAAG,IAAI;IAErC,MAAMkB,SAAS,GAAG,IAAI;IACtB,MAAMC,SAAS,GAAGnB,KAAK;IACvB,MAAMoB,YAAY,GAAGnB,OAAO,EAAEoB,SAAS,KAAK,IAAI,GAAGpB,OAAO,EAAED,KAAK,GAAG,EAAE;IAEtE,OAAO;MACLH,IAAI;MACJyB,IAAI,EAAE,IAAI;MACVH,SAAS;MACTC,YAAY;MACZF,SAAS;MACTK,WAAW,EAAE,KAAK;MAClBC,UAAU,EAAE,IAAI,CAACX,OAAO,CAAC,GAAG,CAAC;MAC7BY,YAAY,EAAE,IAAI,CAACA,YAAY;MAC/BC,QAAQ,EAAE,IAAI,CAACA;IACjB,CAAC;EACH;EAEA,IAAID,YAAYA,CAAA,EAAG;IACjB,MAAM;MAAE7B;IAAI,CAAC,GAAG,IAAI;;IAEpB;IACA,MAAM6B,YAAY,GAAG7B,GAAG,CAAC+B,QAAQ,EAAEC,YAAY,GAC3C,UAAUhC,GAAG,CAAC+B,QAAQ,CAACC,YAAY,EAAE,GACrChC,GAAG,CAAC+B,QAAQ,EAAEE,GAAG;IAErB,OAAOrC,SAAS,CAACiC,YAAY,CAAC;EAChC;EAEA,IAAIC,QAAQA,CAAA,EAAG;IACb,MAAM;MAAE9B;IAAI,CAAC,GAAG,IAAI;IACpB,OAAOA,GAAG,CAACkC,WAAW,EAAEC,KAAK;EAC/B;EAEAlB,OAAOA,CAACF,IAAY,EAAE;IACpB,MAAM;MAAEb;IAAM,CAAC,GAAG,IAAI;IAEtB,OAAOa,IAAI,KAAK,GAAG,GACf,IAAIb,KAAK,CAACkC,QAAQ,EAAE,CAAC;IAAA,EACrB,IAAIlC,KAAK,CAACkC,QAAQ,GAAGrB,IAAI,EAAE;EACjC;EAEAlB,YAAYA,CAAA,EAAG;IACb,OAAOA,YAAY,CAAC,IAAI,CAACK,KAAK,CAAC;EACjC;EAEAmC,cAAcA,CAAA,EAAG;IACf,OAAO3C,cAAc,CAAC4C,OAAO,CAACC,OAAO,CAAC,CAAC;EACzC;EAEAC,aAAaA,CAAA,EAAG;IACd,OAAO9C,cAAc,CAAC+C,MAAM,CAACF,OAAO,CAAC,CAAC;EACxC;EAEAG,mBAAmBA,CAAA,EAIgC;IACjD,OAAO,CAACC,OAAO,EAAEC,OAAO,EAAEC,CAAC,KAAK;MAC9B,MAAM;QAAExB,SAAS;QAAEZ;MAAS,CAAC,GAAG,IAAI;MACpC,OAAOoC,CAAC,CAAC/B,IAAI,CAACL,QAAQ,EAAEY,SAAS,CAAC;IACpC,CAAC;EACH;EAEAyB,oBAAoBA,CAAA,EAIsC;IACxD,MAAMnD,IAAI,CAACoD,UAAU,CAAC,8CAA8C,CAAC;EACvE;AACF","ignoreList":[]}