@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/.server/server/services/cacheService.d.ts

@@ -1,5 +1,5 @@
 import { type Server } from '@hapi/hapi';
-import { type AnyFormRequest, type AnyRequest, type FormConfirmationState, type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '~/src/server/plugins/engine/types.js';
+import { type AnyFormRequest, type CacheRequest, type FormConfirmationState, type FormPayload, type FormState, type FormSubmissionError, type FormSubmissionState } from '../../server/plugins/engine/types.js';
 export declare enum ADDITIONAL_IDENTIFIER {
     Confirmation = ":confirmation"
 }
@@ -16,11 +16,11 @@ export declare class CacheService {
         server: Server;
         cacheName?: string;
     });
-    getState(request: AnyRequest): Promise<FormSubmissionState>;
-    setState(request: AnyFormRequest, state: FormSubmissionState): Promise<FormSubmissionState>;
-    getConfirmationState(request: AnyFormRequest): Promise<FormConfirmationState>;
-    setConfirmationState(request: AnyFormRequest, confirmationState: FormConfirmationState): Promise<void>;
-    clearState(request: AnyFormRequest): Promise<void>;
+    getState(request: CacheRequest): Promise<FormSubmissionState>;
+    setState(request: CacheRequest, state: FormSubmissionState): Promise<FormSubmissionState>;
+    getConfirmationState(request: CacheRequest): Promise<FormConfirmationState>;
+    setConfirmationState(request: CacheRequest, confirmationState: FormConfirmationState): Promise<void>;
+    clearState(request: CacheRequest): Promise<void>;
     getFlash(request: AnyFormRequest): {
         errors: FormSubmissionError[];
     } | undefined;
@@ -50,14 +50,14 @@ export declare class CacheService {
      * ```
      * @returns The updated state after removal
      */
-    resetComponentStates(request: AnyFormRequest, componentNames: string[]): Promise<FormSubmissionState>;
+    resetComponentStates(request: CacheRequest, componentNames: string[]): Promise<FormSubmissionState>;
     /**
      * The key used to store user session data against.
      * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`
      * @param request - hapi request object
      * @param additionalIdentifier - appended to the id
      */
-    Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER): {
+    Key(request: CacheRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER): {
         segment: string;
         id: string;
     };

package/.server/server/services/cacheService.js

@@ -104,11 +104,8 @@ export class CacheService {
     if (!request.yar.id) {
       throw new Error('No session ID found');
     }
-
-    // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
-    const state = request.params.state || '';
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
-    const slug = request.params.slug || '';
+    const state = request.params.state ?? '';
+    const slug = request.params.slug ?? '';
     const key = `${request.yar.id}:${state}:${slug}:`;
     return {
       segment: partition,

package/.server/server/services/cacheService.js.map

@@ -1 +1 @@
-{"version":3,"file":"cacheService.js","names":["Hoek","unset","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","logger","constructor","server","cacheName","log","segment","getState","request","key","Key","cached","get","setState","state","ttl","set","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","resetComponentStates","componentNames","componentName","additionalIdentifier","Error","params","slug","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\nimport unset from 'lodash/unset.js'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type AnyFormRequest,\n  type AnyRequest,\n  type FormConfirmationState,\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  logger: Server['logger']\n\n  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(request: AnyRequest): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n    const cached = await this.cache.get(key)\n\n    return cached ?? {}\n  }\n\n  async setState(request: AnyFormRequest, state: FormSubmissionState) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: AnyFormRequest\n  ): Promise<FormConfirmationState> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: AnyFormRequest,\n    confirmationState: FormConfirmationState\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: AnyFormRequest) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: AnyFormRequest\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0)\n    }\n  }\n\n  setFlash(\n    request: AnyFormRequest,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  /**\n   * Resets (removes) component states from the form state by their keys.\n   * Supports both flat keys and nested paths.\n   * @param request - The Hapi request object\n   * @param componentNames - Array of state keys to remove. Uses lodash's unset syntax. Can be:\n   * - Flat keys: `'componentName'` for top-level state\n   * - Nested paths: `\"upload['/my-page']\"` or `'upload./my-page'` for nested state\n   * @example\n   * ```typescript\n   * // Remove a flat component state\n   * await cacheService.resetComponentStates(request, ['emailAddress'])\n   *\n   * // Remove nested upload state for a specific page\n   * await cacheService.resetComponentStates(request, [\"upload['/file-upload-page']\"])\n   *\n   * // Remove multiple states at once\n   * await cacheService.resetComponentStates(request, [\n   *   'componentName',\n   *   \"upload['/my-page']\"\n   * ])\n   * ```\n   * @returns The updated state after removal\n   */\n  async resetComponentStates(\n    request: AnyFormRequest,\n    componentNames: string[]\n  ) {\n    const state = await this.getState(request)\n\n    for (const componentName of componentNames) {\n      unset(state, componentName)\n    }\n\n    return this.setState(request, state)\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(request: AnyRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style\n    const state = (request.params.state as string) || ''\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    const slug = (request.params.slug as string) || ''\n    const key = `${request.yar.id}:${state}:${slug}:`\n\n    return {\n      segment: partition,\n      id: `${key}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAClC,OAAOC,KAAK,MAAM,iBAAiB;AAEnC,SAASC,MAAM;AAYf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,MAAM;EAENC,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAAkD,CAAC,EAAE;IACzE,IAAI,CAACA,SAAS,EAAE;MACdD,MAAM,CAACE,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IAEA,IAAI,CAACL,KAAK,GAAGG,MAAM,CAACH,KAAK,CAAC;MAAEA,KAAK,EAAEI,SAAS;MAAEE,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACL,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMM,QAAQA,CAACC,OAAmB,EAAgC;IAChE,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMG,MAAM,GAAG,MAAM,IAAI,CAACX,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAExC,OAAOE,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAME,QAAQA,CAACL,OAAuB,EAAEM,KAA0B,EAAE;IAClE,MAAML,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMO,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEK,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACR,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMS,oBAAoBA,CACxBT,OAAuB,EACS;IAChC,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOU,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBZ,OAAuB,EACvBa,iBAAwC,EACxC;IACA,MAAMZ,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMH,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEY,iBAAiB,EAAEN,GAAG,CAAC;EACpD;EAEA,MAAMO,UAAUA,CAACd,OAAuB,EAAE;IACxC,IAAIA,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACxB,KAAK,CAACyB,IAAI,CAAC,IAAI,CAACf,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAkB,QAAQA,CACNlB,OAAuB,EACwB;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMmB,QAAQ,GAAGnB,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACNzB,OAAuB,EACvB0B,OAA0C,EAC1C;IACA,MAAMzB,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,EAAEU,OAAO,CAAC;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,oBAAoBA,CACxB3B,OAAuB,EACvB4B,cAAwB,EACxB;IACA,MAAMtB,KAAK,GAAG,MAAM,IAAI,CAACP,QAAQ,CAACC,OAAO,CAAC;IAE1C,KAAK,MAAM6B,aAAa,IAAID,cAAc,EAAE;MAC1CzC,KAAK,CAACmB,KAAK,EAAEuB,aAAa,CAAC;IAC7B;IAEA,OAAO,IAAI,CAACxB,QAAQ,CAACL,OAAO,EAAEM,KAAK,CAAC;EACtC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEJ,GAAGA,CAACF,OAAmB,EAAE8B,oBAA4C,EAAE;IACrE,IAAI,CAAC9B,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIe,KAAK,CAAC,qBAAqB,CAAC;IACxC;;IAEA;IACA,MAAMzB,KAAK,GAAIN,OAAO,CAACgC,MAAM,CAAC1B,KAAK,IAAe,EAAE;IACpD;IACA,MAAM2B,IAAI,GAAIjC,OAAO,CAACgC,MAAM,CAACC,IAAI,IAAe,EAAE;IAClD,MAAMhC,GAAG,GAAG,GAAGD,OAAO,CAACe,GAAG,CAACC,EAAE,IAAIV,KAAK,IAAI2B,IAAI,GAAG;IAEjD,OAAO;MACLnC,OAAO,EAAET,SAAS;MAClB2B,EAAE,EAAE,GAAGf,GAAG,GAAG6B,oBAAoB,IAAI,EAAE;IACzC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,KAAKA,CACnB5B,KAAgB,EAChB6B,MAAc,EACH;EACX,OAAOjD,IAAI,CAACgD,KAAK,CAAC5B,KAAK,EAAE6B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"cacheService.js","names":["Hoek","unset","config","partition","ADDITIONAL_IDENTIFIER","CacheService","cache","logger","constructor","server","cacheName","log","segment","getState","request","key","Key","cached","get","setState","state","ttl","set","getConfirmationState","Confirmation","value","setConfirmationState","confirmationState","clearState","yar","id","drop","getFlash","messages","flash","Array","isArray","length","at","setFlash","message","resetComponentStates","componentNames","componentName","additionalIdentifier","Error","params","slug","merge","update","mergeArrays"],"sources":["../../../src/server/services/cacheService.ts"],"sourcesContent":["import { type Server } from '@hapi/hapi'\nimport * as Hoek from '@hapi/hoek'\nimport unset from 'lodash/unset.js'\n\nimport { config } from '~/src/config/index.js'\nimport { type createServer } from '~/src/server/index.js'\nimport {\n  type AnyFormRequest,\n  type CacheRequest,\n  type FormConfirmationState,\n  type FormPayload,\n  type FormState,\n  type FormSubmissionError,\n  type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\n\nconst partition = 'cache'\n\nexport enum ADDITIONAL_IDENTIFIER {\n  Confirmation = ':confirmation'\n}\n\nexport class CacheService {\n  /**\n   * This service is responsible for getting, storing or deleting a user's session data in the cache. This service has been registered by {@link createServer}\n   */\n  cache\n  logger: Server['logger']\n\n  constructor({ server, cacheName }: { server: Server; cacheName?: string }) {\n    if (!cacheName) {\n      server.log(\n        'warn',\n        'You are using the default hapi cache. Please provide a cache name in plugin registration options.'\n      )\n    }\n\n    this.cache = server.cache({ cache: cacheName, segment: 'formSubmission' })\n    this.logger = server.logger\n  }\n\n  async getState(request: CacheRequest): Promise<FormSubmissionState> {\n    const key = this.Key(request)\n    const cached = await this.cache.get(key)\n\n    return cached ?? {}\n  }\n\n  async setState(request: CacheRequest, state: FormSubmissionState) {\n    const key = this.Key(request)\n    const ttl = config.get('sessionTimeout')\n\n    await this.cache.set(key, state, ttl)\n\n    return this.getState(request)\n  }\n\n  async getConfirmationState(\n    request: CacheRequest\n  ): Promise<FormConfirmationState> {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const value = await this.cache.get(key)\n\n    return value ?? {}\n  }\n\n  async setConfirmationState(\n    request: CacheRequest,\n    confirmationState: FormConfirmationState\n  ) {\n    const key = this.Key(request, ADDITIONAL_IDENTIFIER.Confirmation)\n    const ttl = config.get('confirmationSessionTimeout')\n\n    return this.cache.set(key, confirmationState, ttl)\n  }\n\n  async clearState(request: CacheRequest) {\n    if (request.yar.id) {\n      await this.cache.drop(this.Key(request))\n    }\n  }\n\n  getFlash(\n    request: AnyFormRequest\n  ): { errors: FormSubmissionError[] } | undefined {\n    const key = this.Key(request)\n    const messages = request.yar.flash(key.id)\n\n    if (Array.isArray(messages) && messages.length) {\n      return messages.at(0)\n    }\n  }\n\n  setFlash(\n    request: AnyFormRequest,\n    message: { errors: FormSubmissionError[] }\n  ) {\n    const key = this.Key(request)\n\n    request.yar.flash(key.id, message)\n  }\n\n  /**\n   * Resets (removes) component states from the form state by their keys.\n   * Supports both flat keys and nested paths.\n   * @param request - The Hapi request object\n   * @param componentNames - Array of state keys to remove. Uses lodash's unset syntax. Can be:\n   * - Flat keys: `'componentName'` for top-level state\n   * - Nested paths: `\"upload['/my-page']\"` or `'upload./my-page'` for nested state\n   * @example\n   * ```typescript\n   * // Remove a flat component state\n   * await cacheService.resetComponentStates(request, ['emailAddress'])\n   *\n   * // Remove nested upload state for a specific page\n   * await cacheService.resetComponentStates(request, [\"upload['/file-upload-page']\"])\n   *\n   * // Remove multiple states at once\n   * await cacheService.resetComponentStates(request, [\n   *   'componentName',\n   *   \"upload['/my-page']\"\n   * ])\n   * ```\n   * @returns The updated state after removal\n   */\n  async resetComponentStates(request: CacheRequest, componentNames: string[]) {\n    const state = await this.getState(request)\n\n    for (const componentName of componentNames) {\n      unset(state, componentName)\n    }\n\n    return this.setState(request, state)\n  }\n\n  /**\n   * The key used to store user session data against.\n   * If there are multiple forms on the same runner instance, for example `form-a` and `form-a-feedback` this will prevent CacheService from clearing data from `form-a` if a user gave feedback before they finished `form-a`\n   * @param request - hapi request object\n   * @param additionalIdentifier - appended to the id\n   */\n  Key(request: CacheRequest, additionalIdentifier?: ADDITIONAL_IDENTIFIER) {\n    if (!request.yar.id) {\n      throw new Error('No session ID found')\n    }\n\n    const state = request.params.state ?? ''\n    const slug = request.params.slug ?? ''\n    const key = `${request.yar.id}:${state}:${slug}:`\n\n    return {\n      segment: partition,\n      id: `${key}${additionalIdentifier ?? ''}`\n    }\n  }\n}\n\n/**\n * State merge helper\n * 1. Merges objects (form fields)\n * 2. Overwrites arrays\n */\nexport function merge<StateType extends FormState | FormPayload>(\n  state: StateType,\n  update: object\n): StateType {\n  return Hoek.merge(state, update, {\n    mergeArrays: false\n  })\n}\n"],"mappings":"AACA,OAAO,KAAKA,IAAI,MAAM,YAAY;AAClC,OAAOC,KAAK,MAAM,iBAAiB;AAEnC,SAASC,MAAM;AAYf,MAAMC,SAAS,GAAG,OAAO;AAEzB,WAAYC,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAIjC,OAAO,MAAMC,YAAY,CAAC;EACxB;AACF;AACA;EACEC,KAAK;EACLC,MAAM;EAENC,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAAkD,CAAC,EAAE;IACzE,IAAI,CAACA,SAAS,EAAE;MACdD,MAAM,CAACE,GAAG,CACR,MAAM,EACN,mGACF,CAAC;IACH;IAEA,IAAI,CAACL,KAAK,GAAGG,MAAM,CAACH,KAAK,CAAC;MAAEA,KAAK,EAAEI,SAAS;MAAEE,OAAO,EAAE;IAAiB,CAAC,CAAC;IAC1E,IAAI,CAACL,MAAM,GAAGE,MAAM,CAACF,MAAM;EAC7B;EAEA,MAAMM,QAAQA,CAACC,OAAqB,EAAgC;IAClE,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMG,MAAM,GAAG,MAAM,IAAI,CAACX,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAExC,OAAOE,MAAM,IAAI,CAAC,CAAC;EACrB;EAEA,MAAME,QAAQA,CAACL,OAAqB,EAAEM,KAA0B,EAAE;IAChE,MAAML,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMO,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,gBAAgB,CAAC;IAExC,MAAM,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEK,KAAK,EAAEC,GAAG,CAAC;IAErC,OAAO,IAAI,CAACR,QAAQ,CAACC,OAAO,CAAC;EAC/B;EAEA,MAAMS,oBAAoBA,CACxBT,OAAqB,EACW;IAChC,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMC,KAAK,GAAG,MAAM,IAAI,CAACnB,KAAK,CAACY,GAAG,CAACH,GAAG,CAAC;IAEvC,OAAOU,KAAK,IAAI,CAAC,CAAC;EACpB;EAEA,MAAMC,oBAAoBA,CACxBZ,OAAqB,EACrBa,iBAAwC,EACxC;IACA,MAAMZ,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,EAAEV,qBAAqB,CAACoB,YAAY,CAAC;IACjE,MAAMH,GAAG,GAAGnB,MAAM,CAACgB,GAAG,CAAC,4BAA4B,CAAC;IAEpD,OAAO,IAAI,CAACZ,KAAK,CAACgB,GAAG,CAACP,GAAG,EAAEY,iBAAiB,EAAEN,GAAG,CAAC;EACpD;EAEA,MAAMO,UAAUA,CAACd,OAAqB,EAAE;IACtC,IAAIA,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MAClB,MAAM,IAAI,CAACxB,KAAK,CAACyB,IAAI,CAAC,IAAI,CAACf,GAAG,CAACF,OAAO,CAAC,CAAC;IAC1C;EACF;EAEAkB,QAAQA,CACNlB,OAAuB,EACwB;IAC/C,MAAMC,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAC7B,MAAMmB,QAAQ,GAAGnB,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,CAAC;IAE1C,IAAIK,KAAK,CAACC,OAAO,CAACH,QAAQ,CAAC,IAAIA,QAAQ,CAACI,MAAM,EAAE;MAC9C,OAAOJ,QAAQ,CAACK,EAAE,CAAC,CAAC,CAAC;IACvB;EACF;EAEAC,QAAQA,CACNzB,OAAuB,EACvB0B,OAA0C,EAC1C;IACA,MAAMzB,GAAG,GAAG,IAAI,CAACC,GAAG,CAACF,OAAO,CAAC;IAE7BA,OAAO,CAACe,GAAG,CAACK,KAAK,CAACnB,GAAG,CAACe,EAAE,EAAEU,OAAO,CAAC;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,oBAAoBA,CAAC3B,OAAqB,EAAE4B,cAAwB,EAAE;IAC1E,MAAMtB,KAAK,GAAG,MAAM,IAAI,CAACP,QAAQ,CAACC,OAAO,CAAC;IAE1C,KAAK,MAAM6B,aAAa,IAAID,cAAc,EAAE;MAC1CzC,KAAK,CAACmB,KAAK,EAAEuB,aAAa,CAAC;IAC7B;IAEA,OAAO,IAAI,CAACxB,QAAQ,CAACL,OAAO,EAAEM,KAAK,CAAC;EACtC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEJ,GAAGA,CAACF,OAAqB,EAAE8B,oBAA4C,EAAE;IACvE,IAAI,CAAC9B,OAAO,CAACe,GAAG,CAACC,EAAE,EAAE;MACnB,MAAM,IAAIe,KAAK,CAAC,qBAAqB,CAAC;IACxC;IAEA,MAAMzB,KAAK,GAAGN,OAAO,CAACgC,MAAM,CAAC1B,KAAK,IAAI,EAAE;IACxC,MAAM2B,IAAI,GAAGjC,OAAO,CAACgC,MAAM,CAACC,IAAI,IAAI,EAAE;IACtC,MAAMhC,GAAG,GAAG,GAAGD,OAAO,CAACe,GAAG,CAACC,EAAE,IAAIV,KAAK,IAAI2B,IAAI,GAAG;IAEjD,OAAO;MACLnC,OAAO,EAAET,SAAS;MAClB2B,EAAE,EAAE,GAAGf,GAAG,GAAG6B,oBAAoB,IAAI,EAAE;IACzC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,KAAKA,CACnB5B,KAAgB,EAChB6B,MAAc,EACH;EACX,OAAOjD,IAAI,CAACgD,KAAK,CAAC5B,KAAK,EAAE6B,MAAM,EAAE;IAC/BC,WAAW,EAAE;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/services/httpService.test.js

@@ -499,6 +499,6 @@ describe('HTTP service', () => {
 
 /**
  * @import { IncomingMessage } from 'node:http'
- * @import { RequestOptions } from '~/src/server/services/httpService.js'
+ * @import { RequestOptions } from '../../server/services/httpService.js'
  */
 //# sourceMappingURL=httpService.test.js.map

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

@@ -1 +1 @@
-export { CacheService } from '~/src/server/services/cacheService.js';
+export { CacheService } from '../../server/services/cacheService.js';

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

@@ -1,12 +1,12 @@
 import { type FormDefinition, type FormMetadata, type SubmitPayload, type SubmitResponsePayload } from '@defra/forms-model';
 import { type Server } from '@hapi/hapi';
-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 FormContext, type OnRequestCallback, type PluginOptions, type PreparePageEventRequestOptions } from '~/src/server/plugins/engine/types.js';
-import { type PaymentService } from '~/src/server/plugins/payment/service.js';
-import { type FormRequestPayload, type FormStatus } from '~/src/server/routes/types.js';
-import { type CacheService } from '~/src/server/services/cacheService.js';
+import { type FormModel } from '../server/plugins/engine/models/index.js';
+import { type DetailItem } from '../server/plugins/engine/models/types.js';
+import { type PageController } from '../server/plugins/engine/pageControllers/PageController.js';
+import { type FormContext, type OnRequestCallback, type PluginOptions, type PreparePageEventRequestOptions } from '../server/plugins/engine/types.js';
+import { type PaymentService } from '../server/plugins/payment/service.js';
+import { type FormRequestPayload, type FormStatus } from '../server/routes/types.js';
+import { type CacheService } from '../server/services/cacheService.js';
 export interface FormsService {
     getFormMetadata: (slug: string) => Promise<FormMetadata>;
     getFormMetadataById: (id: string) => Promise<FormMetadata>;

package/.server/server/utils/file-form-service.d.ts

@@ -47,9 +47,9 @@ export class FileFormService {
     getFormDefinition(id: string): FormDefinition;
     /**
      * Returns a FormsService compliant interface
-     * @returns {import('~/src/server/types.js').FormsService}
+     * @returns {import('../../server/types.js').FormsService}
      */
-    toFormsService(): import("~/src/server/types.js").FormsService;
+    toFormsService(): import("../../server/types.js").FormsService;
     #private;
 }
 import type { FormMetadata } from '@defra/forms-model';

package/.server/server/utils/file-form-service.js

@@ -117,7 +117,7 @@ export class FileFormService {
 
   /**
    * Returns a FormsService compliant interface
-   * @returns {import('~/src/server/types.js').FormsService}
+   * @returns {import('../../server/types.js').FormsService}
    */
   toFormsService() {
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.7.2",
+  "version": "4.8.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -35,10 +35,11 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "rm -rf ./.server && npm run build:server && npm run build:client && npm run build:types",
+    "build": "rm -rf ./.server ./.src && npm run build:server && npm run build:client && npm run build:types && npm run build:src",
     "build:client": "NODE_ENV=${NODE_ENV:-production} webpack",
     "build:server": "babel --delete-dir-on-start --extensions \".js\",\".ts\" --ignore \"**/*.test.ts\" --copy-files --no-copy-ignored --source-maps --out-dir ./.server ./src",
-    "build:types": "tsc -p tsconfig.build.json",
+    "build:src": "node scripts/resolve-tilde-imports.js",
+    "build:types": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.alias.json",
     "dev": "concurrently \"npm run client:watch\" \"npm run server:watch:dev\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "format": "npm run format:check -- --write",
@@ -50,10 +51,12 @@
     "docs:clear": "docusaurus clear",
     "generate-schema-docs": "node scripts/generate-schema-docs.js",
     "postinstall": "npm run setup:husky",
+    "postpack": "mv src .src && mv .src.bak src",
+    "prepack": "mv src .src.bak && mv .src src",
     "lint": "npm run lint:editorconfig && npm run lint:js && npm run lint:types",
     "lint:editorconfig": "editorconfig-checker",
     "lint:fix": "npm run lint:js -- --fix",
-    "lint:js": "eslint --cache --cache-location .cache/eslint --cache-strategy content --color .",
+    "lint:js": "node --max-old-space-size=8192 ./node_modules/.bin/eslint --cache --cache-location .cache/eslint --cache-strategy content --color .",
     "lint:scss": "stylelint --cache --cache-location .cache/stylelint --cache-strategy content --color --ignore-path .gitignore --max-warnings 0 \"**/*.scss\"",
     "lint:types": "tsc --noEmit",
     "test": "jest --color --coverage --verbose",
@@ -209,6 +212,7 @@
     "stylelint": "^16.25.0",
     "stylelint-config-gds": "^2.0.0",
     "terser-webpack-plugin": "^5.3.14",
+    "tsc-alias": "^1.8.16",
     "tsx": "^4.20.6",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.56.1",

package/src/client/javascripts/application.js

@@ -1,3 +1,3 @@
-import { initAll } from '~/src/client/javascripts/shared.js'
+import { initAll } from './shared.js'
 
 initAll()

package/src/client/javascripts/geospatial-map.js

@@ -6,7 +6,7 @@ import {
   defaultConfig,
   getCentroidGridRef,
   getCoordinateGridRef
-} from '~/src/client/javascripts/map.js'
+} from './map.js'
 
 const helpPanelConfig = {
   showLabel: true,
@@ -934,11 +934,11 @@ function onListElKeydownFactory() {
 }
 
 /**
- * @import { MapsEnvironmentConfig, InteractiveMap } from '~/src/client/javascripts/map.js'
+ * @import { MapsEnvironmentConfig, InteractiveMap } from './map.js'
  */
 
 /**
- * @import { Geometry, FeatureCollection, Feature, Coordinates } from '~/src/server/plugins/engine/types.js'
+ * @import { Geometry, FeatureCollection, Feature, Coordinates } from '../../server/plugins/engine/types.js'
  */
 
 /**
@@ -1062,5 +1062,5 @@ function onListElKeydownFactory() {
  */
 
 /**
- * @import { MapLibreMap } from '~/src/client/javascripts/map.js'
+ * @import { MapLibreMap } from './map.js'
  */

package/src/client/javascripts/location-map.js

@@ -7,7 +7,7 @@ import {
   latLongToEastingNorthing,
   latLongToOsGridRef,
   osGridRefToLatLong
-} from '~/src/client/javascripts/map.js'
+} from './map.js'
 
 const LOCATION_FIELD_SELECTOR = 'input.govuk-input'
 
@@ -474,5 +474,5 @@ export function processLocation(config, location, index) {
 }
 
 /**
- * @import { InteractiveMap, InteractiveMapInitConfig, MapCenter, MapLibreMap, MapsEnvironmentConfig } from '~/src/client/javascripts/map.js'
+ * @import { InteractiveMap, InteractiveMapInitConfig, MapCenter, MapLibreMap, MapsEnvironmentConfig } from './map.js'
  */

package/src/client/javascripts/map.js

@@ -2,8 +2,8 @@ import { centroid } from '@turf/centroid'
 // @ts-expect-error - no types
 import OsGridRef, { LatLon } from 'geodesy/osgridref.js'
 
-import { processGeospatial } from '~/src/client/javascripts/geospatial-map.js'
-import { processLocation } from '~/src/client/javascripts/location-map.js'
+import { processGeospatial } from './geospatial-map.js'
+import { processLocation } from './location-map.js'
 
 // Center of UK
 const DEFAULT_LAT = 53.825564
@@ -13,7 +13,8 @@ const COMPANY_SYMBOL_CODE = 169
 const defaultData = {
   VTS_OUTDOOR_URL: '/api/maps/vts/OS_VTS_3857_Outdoor.json',
   VTS_DARK_URL: '/api/maps/vts/OS_VTS_3857_Dark.json',
-  VTS_BLACK_AND_WHITE_URL: '/api/maps/vts/OS_VTS_3857_Black_and_White.json'
+  VTS_BLACK_AND_WHITE_URL: '/api/maps/vts/OS_VTS_3857_Black_and_White.json',
+  VTS_AERIAL_URL: '/api/maps/vts/esri-aerial.json'
 }
 
 /**
@@ -317,6 +318,13 @@ export function createMap(mapId, initConfig, mapsConfig) {
             logo: `${assetPath}/interactive-map/assets/images/os-logo-black.svg`,
             logoAltText,
             attribution: `Contains OS data ${String.fromCodePoint(COMPANY_SYMBOL_CODE)} Crown copyright and database rights ${new Date().getFullYear()}`
+          },
+          {
+            id: 'aerial',
+            label: 'Aerial',
+            url: data.VTS_AERIAL_URL,
+            thumbnail: `${assetPath}/interactive-map/assets/images/aerial-map-thumb.jpg`,
+            attribution: `Tiles ${String.fromCodePoint(COMPANY_SYMBOL_CODE)} Esri — Source: Esri, Maxar, Earthstar Geographics, and the GIS User Community ${new Date().getFullYear()}`
           }
         ]
       }),
@@ -388,6 +396,7 @@ export function centerMap(map, mapProvider, center) {
  * @property {string} VTS_OUTDOOR_URL - the outdoor tile URL
  * @property {string} VTS_DARK_URL - the dark tile URL
  * @property {string} VTS_BLACK_AND_WHITE_URL - the black and white tile URL
+ * @property {string} VTS_AERIAL_URL - the aerial tile URL
  */
 
 /**
@@ -398,5 +407,5 @@ export function centerMap(map, mapProvider, center) {
  */
 
 /**
- * @import { Feature } from '~/src/server/plugins/engine/types.js'
+ * @import { Feature } from '../../server/plugins/engine/types.js'
  */

package/src/client/javascripts/shared.js

@@ -1,10 +1,10 @@
-import { initAllAutocomplete as initAllAutocompleteImp } from '~/src/client/javascripts/autocomplete.js'
-import { initFileUpload as initFileUploadImp } from '~/src/client/javascripts/file-upload.js'
-import { initAllGovuk as initAllGovukImp } from '~/src/client/javascripts/govuk.js'
-import { initPreviewCloseLink as initPreviewCloseLinkImp } from '~/src/client/javascripts/preview-close-link.js'
-export { initMaps } from '~/src/client/javascripts/map.js'
-export * as map from '~/src/client/javascripts/map.js'
-export * as geospatialMap from '~/src/client/javascripts/geospatial-map.js'
+import { initAllAutocomplete as initAllAutocompleteImp } from './autocomplete.js'
+import { initFileUpload as initFileUploadImp } from './file-upload.js'
+import { initAllGovuk as initAllGovukImp } from './govuk.js'
+import { initPreviewCloseLink as initPreviewCloseLinkImp } from './preview-close-link.js'
+export { initMaps } from './map.js'
+export * as map from './map.js'
+export * as geospatialMap from './geospatial-map.js'
 
 export const initAllGovuk = initAllGovukImp
 export const initAllAutocomplete = initAllAutocompleteImp

package/src/index.ts

@@ -1,8 +1,8 @@
 import { getErrorMessage } from '@defra/forms-model'
 
-import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
-import { createServer } from '~/src/server/index.js'
+import { config } from './config/index.js'
+import { createLogger } from './server/common/helpers/logging/logger.js'
+import { createServer } from './server/index.js'
 
 const logger = createLogger()
 

package/src/server/common/helpers/logging/logger-options.ts

@@ -3,7 +3,7 @@ import { ecsFormat } from '@elastic/ecs-pino-format'
 import { type Options } from 'hapi-pino'
 import { type LoggerOptions, type TransportSingleOptions } from 'pino'
 
-import { config } from '~/src/config/index.js'
+import { config } from '../../../../config/index.js'
 
 const logConfig = config.get('log')
 const serviceName = config.get('serviceName')

package/src/server/common/helpers/logging/logger.ts

@@ -1,6 +1,6 @@
 import { pino } from 'pino'
 
-import { loggerOptions } from '~/src/server/common/helpers/logging/logger-options.js'
+import { loggerOptions } from './logger-options.js'
 
 export function createLogger() {
   return pino(loggerOptions)

package/src/server/common/helpers/logging/request-logger.ts

@@ -1,7 +1,7 @@
 import { type ServerRegisterPluginObject } from '@hapi/hapi'
 import hapiPino, { type Options } from 'hapi-pino'
 
-import { loggerOptions } from '~/src/server/common/helpers/logging/logger-options.js'
+import { loggerOptions } from './logger-options.js'
 
 export const requestLogger = {
   plugin: hapiPino,

package/src/server/common/helpers/logging/request-tracing.js

@@ -1,6 +1,6 @@
 import { tracing } from '@defra/hapi-tracing'
 
-import { config } from '~/src/config/index.js'
+import { config } from '../../../../config/index.js'
 
 // Explicitly declare the expected type
 

package/src/server/common/helpers/redis-client.js

@@ -1,8 +1,8 @@
 import { getErrorMessage } from '@defra/forms-model'
 import { Cluster, Redis } from 'ioredis'
 
-import { config } from '~/src/config/index.js'
-import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
+import { config } from '../../../config/index.js'
+import { createLogger } from './logging/logger.js'
 
 /**
  * Setup Redis and provide a redis client

package/src/server/index.ts

@@ -11,19 +11,19 @@ import Wreck from '@hapi/wreck'
 import blipp from 'blipp'
 import { ProxyAgent } from 'proxy-agent'
 
-import { config } from '~/src/config/index.js'
-import { requestLogger } from '~/src/server/common/helpers/logging/request-logger.js'
-import { requestTracing } from '~/src/server/common/helpers/logging/request-tracing.js'
-import { buildRedisClient } from '~/src/server/common/helpers/redis-client.js'
-import { configureCrumbPlugin } from '~/src/server/plugins/crumb.js'
-import { configureEnginePlugin } from '~/src/server/plugins/engine/configureEnginePlugin.js'
-import pluginErrorPages from '~/src/server/plugins/errorPages.js'
-import { plugin as pluginViews } from '~/src/server/plugins/nunjucks/index.js'
-import pluginPulse from '~/src/server/plugins/pulse.js'
-import pluginSession from '~/src/server/plugins/session.js'
-import { dummyApiRoutes, publicRoutes } from '~/src/server/routes/index.js'
-import { prepareSecureContext } from '~/src/server/secure-context.js'
-import { type RouteConfig } from '~/src/server/types.js'
+import { config } from '../config/index.js'
+import { requestLogger } from './common/helpers/logging/request-logger.js'
+import { requestTracing } from './common/helpers/logging/request-tracing.js'
+import { buildRedisClient } from './common/helpers/redis-client.js'
+import { configureCrumbPlugin } from './plugins/crumb.js'
+import { configureEnginePlugin } from './plugins/engine/configureEnginePlugin.js'
+import pluginErrorPages from './plugins/errorPages.js'
+import { plugin as pluginViews } from './plugins/nunjucks/index.js'
+import pluginPulse from './plugins/pulse.js'
+import pluginSession from './plugins/session.js'
+import { dummyApiRoutes, publicRoutes } from './routes/index.js'
+import { prepareSecureContext } from './secure-context.js'
+import { type RouteConfig } from './types.js'
 
 const proxyAgent = new ProxyAgent()
 

package/src/server/plugins/crumb.ts

@@ -1,8 +1,8 @@
 import crumb, { type RegisterOptions } from '@hapi/crumb'
 import { type ServerRegisterPluginObject } from '@hapi/hapi'
 
-import { config } from '~/src/config/index.js'
-import { type RouteConfig } from '~/src/server/types.js'
+import { config } from '../../config/index.js'
+import { type RouteConfig } from '../types.js'
 
 export const configureCrumbPlugin = (
   routeConfig?: RouteConfig

package/src/server/plugins/engine/beta/form-context.ts

@@ -2,24 +2,24 @@ import Boom from '@hapi/boom'
 import { type Request, type Server } from '@hapi/hapi'
 import { isEqual } from 'date-fns'
 
-import { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'
+import { PREVIEW_PATH_PREFIX } from '../../../constants.js'
 import {
   checkEmailAddressForLiveFormSubmission,
   getCacheService
-} from '~/src/server/plugins/engine/helpers.js'
-import { FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'
-import { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'
-import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
+} from '../helpers.js'
+import { FormModel } from '../models/index.js'
+import { type PageController } from '../pageControllers/PageController.js'
+import { TerminalPageController } from '../pageControllers/index.js'
+import * as defaultServices from '../services/index.js'
 import {
   type AnyRequest,
   type FormContext,
   type FormContextRequest,
   type FormSubmissionError,
   type FormSubmissionState
-} from '~/src/server/plugins/engine/types.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import { type Services } from '~/src/server/types.js'
+} from '../types.js'
+import { FormStatus } from '../../../routes/types.js'
+import { type Services } from '../../../types.js'
 
 type JourneyState = FormStatus | 'preview'
 

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

@@ -1,11 +1,11 @@
 import { type AutocompleteFieldComponent } from '@defra/forms-model'
 
-import { SelectField } from '~/src/server/plugins/engine/components/SelectField.js'
-import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
+import { SelectField } from './SelectField.js'
+import { messageTemplate } from '../pageControllers/validationOptions.js'
 import {
   type FormPayload,
   type FormSubmissionError
-} from '~/src/server/plugins/engine/types.js'
+} from '../types.js'
 
 export class AutocompleteField extends SelectField {
   declare options: AutocompleteFieldComponent['options']

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

@@ -1,17 +1,17 @@
 import { type CheckboxesFieldComponent, type Item } from '@defra/forms-model'
 import joi, { type ArraySchema } from 'joi'
 
-import { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'
-import { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/QuestionPageController.js'
-import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
+import { isFormValue } from './FormComponent.js'
+import { SelectionControlField } from './SelectionControlField.js'
+import { type FormModel } from '../models/FormModel.js'
+import { type QuestionPageController } from '../pageControllers/QuestionPageController.js'
+import { messageTemplate } from '../pageControllers/validationOptions.js'
 import {
   type ErrorMessageTemplateList,
   type FormState,
   type FormStateValue,
   type FormSubmissionState
-} from '~/src/server/plugins/engine/types.js'
+} from '../types.js'
 
 export class CheckboxesField extends SelectionControlField {
   declare options: CheckboxesFieldComponent['options']
@@ -26,8 +26,7 @@ export class CheckboxesField extends SelectionControlField {
     super(def, props)
 
     const { listType: type } = this
-    const { options } = def
-    const schema = 'schema' in def ? def.schema : {}
+    const { options, schema } = def
 
     let formSchema =
       type === 'string' ? joi.array<string>() : joi.array<number>()

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

@@ -8,11 +8,11 @@ import joi, {
   type StringSchema
 } from 'joi'
 
-import { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'
-import { type ViewModel } from '~/src/server/plugins/engine/components/types.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
+import { type ComponentCollection } from './ComponentCollection.js'
+import { type Component } from './helpers/components.js'
+import { type ViewModel } from './types.js'
+import { type FormModel } from '../models/index.js'
+import { type PageControllerClass } from '../pageControllers/helpers/pages.js'
 
 export class ComponentBase {
   id?: string

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

@@ -9,26 +9,26 @@ import {
   FormComponent,
   isFormState,
   isFormValue
-} from '~/src/server/plugins/engine/components/FormComponent.js'
+} from './FormComponent.js'
 import {
   createComponent,
   type Component,
   type Field,
   type Guidance
-} from '~/src/server/plugins/engine/components/helpers/components.js'
-import { type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js'
-import { getErrors } from '~/src/server/plugins/engine/helpers.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
-import { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
+} from './helpers/components.js'
+import { type ComponentViewModel } from './types.js'
+import { getErrors } from '../helpers.js'
+import { type FormModel } from '../models/index.js'
+import { type PageControllerClass } from '../pageControllers/helpers/pages.js'
+import { validationOptions as opts } from '../pageControllers/validationOptions.js'
 import {
   type FormPayload,
   type FormState,
   type FormSubmissionError,
   type FormSubmissionState,
   type FormValidationResult
-} from '~/src/server/plugins/engine/types.js'
-import { type FormQuery } from '~/src/server/routes/types.js'
+} from '../types.js'
+import { type FormQuery } from '../../../routes/types.js'
 
 export class ComponentCollection {
   page?: PageControllerClass