@defra/forms-engine-plugin 4.0.10 → 4.0.11

package/.server/server/plugins/engine/pageControllers/helpers/pages.d.ts

@@ -1,7 +1,6 @@
-import { ControllerType, type Page } from '@defra/forms-model';
+import { type Page } from '@defra/forms-model';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js';
-export declare function isPageController(controllerName?: string | ControllerType): controllerName is keyof typeof PageControllers;
 export type PageControllerClass = InstanceType<PageControllerType>;
 export type PageControllerType = (typeof PageControllers)[keyof typeof PageControllers];
 /**

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

@@ -1,12 +1,5 @@
-import { ControllerType, controllerNameFromPath, isControllerName } from '@defra/forms-model';
+import { ControllerType, controllerNameFromPath } from '@defra/forms-model';
 import * as PageControllers from "../index.js";
-export function isPageController(controllerName) {
-  // Handle SummaryWithConfirmationEmail as it uses SummaryPageController
-  if (controllerName === ControllerType.SummaryWithConfirmationEmail) {
-    return true;
-  }
-  return isControllerName(controllerName) && controllerName in PageControllers;
-}
 /**
  * Creates page instance for each {@link Page} type
  */
@@ -34,9 +27,6 @@ export function createPage(model, pageDef) {
     case ControllerType.Summary:
       controller = new PageControllers.SummaryPageController(model, pageDef);
       break;
-    case ControllerType.SummaryWithConfirmationEmail:
-      controller = new PageControllers.SummaryPageController(model, pageDef);
-      break;
     case ControllerType.Status:
       controller = new PageControllers.StatusPageController(model, pageDef);
       break;

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

@@ -1 +1 @@
-{"version":3,"file":"pages.js","names":["ControllerType","controllerNameFromPath","isControllerName","PageControllers","isPageController","controllerName","SummaryWithConfirmationEmail","createPage","model","pageDef","controller","QuestionPageController","Start","StartPageController","Page","Terminal","TerminalPageController","Summary","SummaryPageController","Status","StatusPageController","FileUpload","FileUploadPageController","Repeat","RepeatPageController","controllers","Ctrl","Error"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/pages.ts"],"sourcesContent":["import {\n  ControllerType,\n  controllerNameFromPath,\n  isControllerName,\n  type Page\n} from '@defra/forms-model'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js'\n\nexport function isPageController(\n  controllerName?: string | ControllerType\n): controllerName is keyof typeof PageControllers {\n  // Handle SummaryWithConfirmationEmail as it uses SummaryPageController\n  if (controllerName === ControllerType.SummaryWithConfirmationEmail) {\n    return true\n  }\n  return isControllerName(controllerName) && controllerName in PageControllers\n}\n\nexport type PageControllerClass = InstanceType<PageControllerType>\nexport type PageControllerType =\n  (typeof PageControllers)[keyof typeof PageControllers]\n\n/**\n * Creates page instance for each {@link Page} type\n */\nexport function createPage(model: FormModel, pageDef: Page) {\n  const controllerName = controllerNameFromPath(pageDef.controller)\n\n  if (!pageDef.controller) {\n    return new PageControllers.QuestionPageController(model, pageDef)\n  }\n\n  // Patch legacy controllers\n  if (controllerName && pageDef.controller !== controllerName) {\n    pageDef.controller = controllerName\n  }\n\n  let controller: PageControllerClass | undefined\n\n  switch (pageDef.controller) {\n    case ControllerType.Start:\n      controller = new PageControllers.StartPageController(model, pageDef)\n      break\n\n    case ControllerType.Page:\n      controller = new PageControllers.QuestionPageController(model, pageDef)\n      break\n\n    case ControllerType.Terminal:\n      controller = new PageControllers.TerminalPageController(model, pageDef)\n      break\n\n    case ControllerType.Summary:\n      controller = new PageControllers.SummaryPageController(model, pageDef)\n      break\n\n    case ControllerType.SummaryWithConfirmationEmail:\n      controller = new PageControllers.SummaryPageController(model, pageDef)\n      break\n\n    case ControllerType.Status:\n      controller = new PageControllers.StatusPageController(model, pageDef)\n      break\n\n    case ControllerType.FileUpload:\n      controller = new PageControllers.FileUploadPageController(model, pageDef)\n      break\n\n    case ControllerType.Repeat:\n      controller = new PageControllers.RepeatPageController(model, pageDef)\n      break\n  }\n\n  if (typeof controller === 'undefined') {\n    if (model.controllers?.[pageDef.controller]) {\n      const Ctrl = model.controllers[pageDef.controller]\n      controller = new Ctrl(model, pageDef) as unknown as PageControllerClass // type assertion needed because TS can't verify custom controller structure\n    }\n  }\n\n  if (typeof controller === 'undefined') {\n    throw new Error(`Page controller ${pageDef.controller} does not exist`)\n  }\n\n  return controller\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,sBAAsB,EACtBC,gBAAgB,QAEX,oBAAoB;AAG3B,OAAO,KAAKC,eAAe;AAE3B,OAAO,SAASC,gBAAgBA,CAC9BC,cAAwC,EACQ;EAChD;EACA,IAAIA,cAAc,KAAKL,cAAc,CAACM,4BAA4B,EAAE;IAClE,OAAO,IAAI;EACb;EACA,OAAOJ,gBAAgB,CAACG,cAAc,CAAC,IAAIA,cAAc,IAAIF,eAAe;AAC9E;AAMA;AACA;AACA;AACA,OAAO,SAASI,UAAUA,CAACC,KAAgB,EAAEC,OAAa,EAAE;EAC1D,MAAMJ,cAAc,GAAGJ,sBAAsB,CAACQ,OAAO,CAACC,UAAU,CAAC;EAEjE,IAAI,CAACD,OAAO,CAACC,UAAU,EAAE;IACvB,OAAO,IAAIP,eAAe,CAACQ,sBAAsB,CAACH,KAAK,EAAEC,OAAO,CAAC;EACnE;;EAEA;EACA,IAAIJ,cAAc,IAAII,OAAO,CAACC,UAAU,KAAKL,cAAc,EAAE;IAC3DI,OAAO,CAACC,UAAU,GAAGL,cAAc;EACrC;EAEA,IAAIK,UAA2C;EAE/C,QAAQD,OAAO,CAACC,UAAU;IACxB,KAAKV,cAAc,CAACY,KAAK;MACvBF,UAAU,GAAG,IAAIP,eAAe,CAACU,mBAAmB,CAACL,KAAK,EAAEC,OAAO,CAAC;MACpE;IAEF,KAAKT,cAAc,CAACc,IAAI;MACtBJ,UAAU,GAAG,IAAIP,eAAe,CAACQ,sBAAsB,CAACH,KAAK,EAAEC,OAAO,CAAC;MACvE;IAEF,KAAKT,cAAc,CAACe,QAAQ;MAC1BL,UAAU,GAAG,IAAIP,eAAe,CAACa,sBAAsB,CAACR,KAAK,EAAEC,OAAO,CAAC;MACvE;IAEF,KAAKT,cAAc,CAACiB,OAAO;MACzBP,UAAU,GAAG,IAAIP,eAAe,CAACe,qBAAqB,CAACV,KAAK,EAAEC,OAAO,CAAC;MACtE;IAEF,KAAKT,cAAc,CAACM,4BAA4B;MAC9CI,UAAU,GAAG,IAAIP,eAAe,CAACe,qBAAqB,CAACV,KAAK,EAAEC,OAAO,CAAC;MACtE;IAEF,KAAKT,cAAc,CAACmB,MAAM;MACxBT,UAAU,GAAG,IAAIP,eAAe,CAACiB,oBAAoB,CAACZ,KAAK,EAAEC,OAAO,CAAC;MACrE;IAEF,KAAKT,cAAc,CAACqB,UAAU;MAC5BX,UAAU,GAAG,IAAIP,eAAe,CAACmB,wBAAwB,CAACd,KAAK,EAAEC,OAAO,CAAC;MACzE;IAEF,KAAKT,cAAc,CAACuB,MAAM;MACxBb,UAAU,GAAG,IAAIP,eAAe,CAACqB,oBAAoB,CAAChB,KAAK,EAAEC,OAAO,CAAC;MACrE;EACJ;EAEA,IAAI,OAAOC,UAAU,KAAK,WAAW,EAAE;IACrC,IAAIF,KAAK,CAACiB,WAAW,GAAGhB,OAAO,CAACC,UAAU,CAAC,EAAE;MAC3C,MAAMgB,IAAI,GAAGlB,KAAK,CAACiB,WAAW,CAAChB,OAAO,CAACC,UAAU,CAAC;MAClDA,UAAU,GAAG,IAAIgB,IAAI,CAAClB,KAAK,EAAEC,OAAO,CAAmC,EAAC;IAC1E;EACF;EAEA,IAAI,OAAOC,UAAU,KAAK,WAAW,EAAE;IACrC,MAAM,IAAIiB,KAAK,CAAC,mBAAmBlB,OAAO,CAACC,UAAU,iBAAiB,CAAC;EACzE;EAEA,OAAOA,UAAU;AACnB","ignoreList":[]}
+{"version":3,"file":"pages.js","names":["ControllerType","controllerNameFromPath","PageControllers","createPage","model","pageDef","controllerName","controller","QuestionPageController","Start","StartPageController","Page","Terminal","TerminalPageController","Summary","SummaryPageController","Status","StatusPageController","FileUpload","FileUploadPageController","Repeat","RepeatPageController","controllers","Ctrl","Error"],"sources":["../../../../../../src/server/plugins/engine/pageControllers/helpers/pages.ts"],"sourcesContent":["import {\n  ControllerType,\n  controllerNameFromPath,\n  type Page\n} from '@defra/forms-model'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js'\n\nexport type PageControllerClass = InstanceType<PageControllerType>\nexport type PageControllerType =\n  (typeof PageControllers)[keyof typeof PageControllers]\n\n/**\n * Creates page instance for each {@link Page} type\n */\nexport function createPage(model: FormModel, pageDef: Page) {\n  const controllerName = controllerNameFromPath(pageDef.controller)\n\n  if (!pageDef.controller) {\n    return new PageControllers.QuestionPageController(model, pageDef)\n  }\n\n  // Patch legacy controllers\n  if (controllerName && pageDef.controller !== controllerName) {\n    pageDef.controller = controllerName\n  }\n\n  let controller: PageControllerClass | undefined\n\n  switch (pageDef.controller) {\n    case ControllerType.Start:\n      controller = new PageControllers.StartPageController(model, pageDef)\n      break\n\n    case ControllerType.Page:\n      controller = new PageControllers.QuestionPageController(model, pageDef)\n      break\n\n    case ControllerType.Terminal:\n      controller = new PageControllers.TerminalPageController(model, pageDef)\n      break\n\n    case ControllerType.Summary:\n      controller = new PageControllers.SummaryPageController(model, pageDef)\n      break\n\n    case ControllerType.Status:\n      controller = new PageControllers.StatusPageController(model, pageDef)\n      break\n\n    case ControllerType.FileUpload:\n      controller = new PageControllers.FileUploadPageController(model, pageDef)\n      break\n\n    case ControllerType.Repeat:\n      controller = new PageControllers.RepeatPageController(model, pageDef)\n      break\n  }\n\n  if (typeof controller === 'undefined') {\n    if (model.controllers?.[pageDef.controller]) {\n      const Ctrl = model.controllers[pageDef.controller]\n      controller = new Ctrl(model, pageDef) as unknown as PageControllerClass // type assertion needed because TS can't verify custom controller structure\n    }\n  }\n\n  if (typeof controller === 'undefined') {\n    throw new Error(`Page controller ${pageDef.controller} does not exist`)\n  }\n\n  return controller\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,sBAAsB,QAEjB,oBAAoB;AAG3B,OAAO,KAAKC,eAAe;AAM3B;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACC,KAAgB,EAAEC,OAAa,EAAE;EAC1D,MAAMC,cAAc,GAAGL,sBAAsB,CAACI,OAAO,CAACE,UAAU,CAAC;EAEjE,IAAI,CAACF,OAAO,CAACE,UAAU,EAAE;IACvB,OAAO,IAAIL,eAAe,CAACM,sBAAsB,CAACJ,KAAK,EAAEC,OAAO,CAAC;EACnE;;EAEA;EACA,IAAIC,cAAc,IAAID,OAAO,CAACE,UAAU,KAAKD,cAAc,EAAE;IAC3DD,OAAO,CAACE,UAAU,GAAGD,cAAc;EACrC;EAEA,IAAIC,UAA2C;EAE/C,QAAQF,OAAO,CAACE,UAAU;IACxB,KAAKP,cAAc,CAACS,KAAK;MACvBF,UAAU,GAAG,IAAIL,eAAe,CAACQ,mBAAmB,CAACN,KAAK,EAAEC,OAAO,CAAC;MACpE;IAEF,KAAKL,cAAc,CAACW,IAAI;MACtBJ,UAAU,GAAG,IAAIL,eAAe,CAACM,sBAAsB,CAACJ,KAAK,EAAEC,OAAO,CAAC;MACvE;IAEF,KAAKL,cAAc,CAACY,QAAQ;MAC1BL,UAAU,GAAG,IAAIL,eAAe,CAACW,sBAAsB,CAACT,KAAK,EAAEC,OAAO,CAAC;MACvE;IAEF,KAAKL,cAAc,CAACc,OAAO;MACzBP,UAAU,GAAG,IAAIL,eAAe,CAACa,qBAAqB,CAACX,KAAK,EAAEC,OAAO,CAAC;MACtE;IAEF,KAAKL,cAAc,CAACgB,MAAM;MACxBT,UAAU,GAAG,IAAIL,eAAe,CAACe,oBAAoB,CAACb,KAAK,EAAEC,OAAO,CAAC;MACrE;IAEF,KAAKL,cAAc,CAACkB,UAAU;MAC5BX,UAAU,GAAG,IAAIL,eAAe,CAACiB,wBAAwB,CAACf,KAAK,EAAEC,OAAO,CAAC;MACzE;IAEF,KAAKL,cAAc,CAACoB,MAAM;MACxBb,UAAU,GAAG,IAAIL,eAAe,CAACmB,oBAAoB,CAACjB,KAAK,EAAEC,OAAO,CAAC;MACrE;EACJ;EAEA,IAAI,OAAOE,UAAU,KAAK,WAAW,EAAE;IACrC,IAAIH,KAAK,CAACkB,WAAW,GAAGjB,OAAO,CAACE,UAAU,CAAC,EAAE;MAC3C,MAAMgB,IAAI,GAAGnB,KAAK,CAACkB,WAAW,CAACjB,OAAO,CAACE,UAAU,CAAC;MAClDA,UAAU,GAAG,IAAIgB,IAAI,CAACnB,KAAK,EAAEC,OAAO,CAAmC,EAAC;IAC1E;EACF;EAEA,IAAI,OAAOE,UAAU,KAAK,WAAW,EAAE;IACrC,MAAM,IAAIiB,KAAK,CAAC,mBAAmBnB,OAAO,CAACE,UAAU,iBAAiB,CAAC;EACzE;EAEA,OAAOA,UAAU;AACnB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.10",
+  "version": "4.0.11",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

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

@@ -11,7 +11,6 @@ import { PageController } from '~/src/server/plugins/engine/pageControllers/Page
 import { getProxyUrlForLocalDevelopment } from '~/src/server/plugins/engine/pageControllers/helpers/index.js'
 import {
   createPage,
-  isPageController,
   type PageControllerType
 } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
@@ -26,7 +25,10 @@ import {
 import definition from '~/test/form/definitions/blank.js'
 
 describe('Page controller helpers', () => {
-  const examples = PageTypes.map((pageType) => {
+  const examples = PageTypes.filter(
+    (pageType) =>
+      pageType.controller !== ControllerType.SummaryWithConfirmationEmail
+  ).map((pageType) => {
     const pageDef = structuredClone(pageType)
 
     let controller: PageControllerType | undefined
@@ -67,10 +69,6 @@ describe('Page controller helpers', () => {
         controller = SummaryPageController
         break
 
-      case ControllerType.SummaryWithConfirmationEmail:
-        controller = SummaryPageController
-        break
-
       case ControllerType.Status:
         controller = StatusPageController
         break
@@ -155,24 +153,6 @@ describe('Page controller helpers', () => {
     })
   })
 
-  describe('Helper: isPageController', () => {
-    it.each([...examples])(
-      "allows valid page controller '$pageDef.controller'",
-      ({ pageDef }) => {
-        expect(isPageController(pageDef.controller)).toBe(true)
-      }
-    )
-
-    it.each([
-      { name: './pages/unknown.js' },
-      { name: 'UnknownPageController' },
-      { name: undefined },
-      { name: '' }
-    ])("rejects invalid page controller '$name'", ({ name }) => {
-      expect(isPageController(name)).toBe(false)
-    })
-  })
-
   describe('Helper: getProxyUrlForLocalDevelopment', () => {
     it('returns null if uploadUrl is undefined', () => {
       expect(getProxyUrlForLocalDevelopment(undefined)).toBeNull()

package/src/server/plugins/engine/pageControllers/helpers/pages.ts

@@ -1,23 +1,12 @@
 import {
   ControllerType,
   controllerNameFromPath,
-  isControllerName,
   type Page
 } from '@defra/forms-model'
 
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
 import * as PageControllers from '~/src/server/plugins/engine/pageControllers/index.js'
 
-export function isPageController(
-  controllerName?: string | ControllerType
-): controllerName is keyof typeof PageControllers {
-  // Handle SummaryWithConfirmationEmail as it uses SummaryPageController
-  if (controllerName === ControllerType.SummaryWithConfirmationEmail) {
-    return true
-  }
-  return isControllerName(controllerName) && controllerName in PageControllers
-}
-
 export type PageControllerClass = InstanceType<PageControllerType>
 export type PageControllerType =
   (typeof PageControllers)[keyof typeof PageControllers]
@@ -56,10 +45,6 @@ export function createPage(model: FormModel, pageDef: Page) {
       controller = new PageControllers.SummaryPageController(model, pageDef)
       break
 
-    case ControllerType.SummaryWithConfirmationEmail:
-      controller = new PageControllers.SummaryPageController(model, pageDef)
-      break
-
     case ControllerType.Status:
       controller = new PageControllers.StatusPageController(model, pageDef)
       break