@defra/forms-model 3.0.663 → 3.0.664

package/dist/module/pages/helpers.js

@@ -103,6 +103,22 @@ export function hasPaymentQuestionInForm(definition) {
   return false;
 }
 
+/**
+ * Helper function to determine if the form uses postcode lookup
+ */
+export function hasPostcodeLookupInForm(definition) {
+  if (definition.pages.length === 0) {
+    return false;
+  }
+  for (const page of definition.pages) {
+    const addressField = hasComponents(page) ? page.components.find(component => component.type === ComponentType.UkAddressField) : undefined;
+    if (addressField?.options.usePostcodeLookup) {
+      return true;
+    }
+  }
+  return false;
+}
+
 /**
  * Helper function to determine if a specific question type exists in the form
  */
@@ -111,8 +127,8 @@ export function hasSpecificQuestionTypeInForm(definition, componentType) {
     return false;
   }
   for (const page of definition.pages) {
-    const hasPayment = hasComponents(page) ? page.components.some(component => component.type === componentType) : false;
-    if (hasPayment) {
+    const hasSpecificComponent = hasComponents(page) ? page.components.some(component => component.type === componentType) : false;
+    if (hasSpecificComponent) {
       return true;
     }
   }

package/dist/module/pages/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","names":["ComponentType","hasFormField","isFormType","ControllerNames","ControllerTypes","ControllerType","PageTypes","getPageDefaults","page","nameOrPath","controller","Page","controllerNameFromPath","defaults","find","pageType","Error","structuredClone","hasComponents","hasNext","Array","isArray","components","hasComponentsEvenIfNoNext","undefined","hasFormComponents","Start","hasRepeater","Repeat","isControllerName","map","String","includes","Terminal","FileUpload","options","path","name","includesFileUploadField","some","component","type","FileUploadField","onlyDeclarationComponents","filter","comp","every","DeclarationField","includesPaymentField","PaymentField","hasPaymentQuestionInForm","definition","pages","length","hasPayment","hasSpecificQuestionTypeInForm","componentType","SHOW_REPEATER_CONTROLLERS","showRepeaterSettings","getPageTitle","title","firstComp","getPageFromDefinition","pageId","x","id","summaryPageControllers","Summary","SummaryWithConfirmationEmail","isSummaryPage","replaceCustomControllers","standardControllers","Set","Object","values","toString","has","isPaymentPage","isEndPage"],"sources":["../../../src/pages/helpers.ts"],"sourcesContent":["import { ComponentType } from '~/src/components/enums.js'\nimport { hasFormField, isFormType } from '~/src/components/helpers.js'\nimport { type ComponentDef } from '~/src/components/types.js'\nimport {\n  type Link,\n  type Page,\n  type PageFileUpload,\n  type PageQuestion,\n  type PageRepeat\n} from '~/src/form/form-definition/types.js'\nimport { type FormDefinition } from '~/src/index.js'\nimport {\n  ControllerNames,\n  ControllerTypes\n} from '~/src/pages/controller-types.js'\nimport { ControllerType } from '~/src/pages/enums.js'\nimport { PageTypes } from '~/src/pages/page-types.js'\n\n/**\n * Return component defaults by type\n */\nexport function getPageDefaults<PageType extends Page>(\n  page?: Pick<PageType, 'controller'>\n) {\n  const nameOrPath = page?.controller ?? ControllerType.Page\n  const controller = controllerNameFromPath(nameOrPath)\n\n  const defaults = PageTypes.find(\n    (pageType) => pageType.controller === controller\n  )\n\n  if (!defaults) {\n    throw new Error(`Defaults not found for page type '${nameOrPath}'`)\n  }\n\n  return structuredClone(defaults) as PageType\n}\n\n/**\n * Check page has components\n */\nexport function hasComponents(\n  page?: Partial<Page>\n): page is Extract<Page, { components: ComponentDef[] }> {\n  return hasNext(page) && Array.isArray(page.components)\n}\n\n/**\n * Check if the page has components (the page can be any page type e.g. SummaryPage)\n */\nexport function hasComponentsEvenIfNoNext(\n  page?: Partial<Page>\n): page is Extract<Page, { components: ComponentDef[] }> {\n  return (\n    page !== undefined && 'components' in page && Array.isArray(page.components)\n  )\n}\n\n/**\n * Check page has form components\n */\nexport function hasFormComponents(\n  page?: Partial<Page>\n): page is PageQuestion | PageFileUpload {\n  const controller = controllerNameFromPath(page?.controller)\n  return hasComponents(page) && controller !== ControllerType.Start\n}\n\n/**\n * Check page has repeater\n */\nexport function hasRepeater(page?: Partial<Page>): page is PageRepeat {\n  return controllerNameFromPath(page?.controller) === ControllerType.Repeat\n}\n\n/**\n * Check for known page controller names\n */\nexport function isControllerName(\n  nameOrPath?: ControllerType | string\n): nameOrPath is ControllerType {\n  return !!nameOrPath && ControllerNames.map(String).includes(nameOrPath)\n}\n\n/**\n * Check page has next link\n */\nexport function hasNext(\n  page?: Partial<Page>\n): page is Extract<Page, { next: Link[] }> {\n  if (!page || !('next' in page)) {\n    return false\n  }\n\n  const controller = controllerNameFromPath(page.controller)\n\n  return (\n    !controller ||\n    controller === ControllerType.Start ||\n    controller === ControllerType.Page ||\n    controller === ControllerType.Terminal ||\n    controller === ControllerType.FileUpload ||\n    controller === ControllerType.Repeat\n  )\n}\n\n/**\n * Check and optionally replace legacy path with controller name\n * @param {string} [nameOrPath] - Controller name or legacy controller path\n */\nexport function controllerNameFromPath(nameOrPath?: ControllerType | string) {\n  if (isControllerName(nameOrPath)) {\n    return nameOrPath\n  }\n\n  const options = ControllerTypes.find(({ path }) => path === nameOrPath)\n  return options?.name\n}\n\nexport function includesFileUploadField(components: ComponentDef[]): boolean {\n  return components.some(\n    (component) => component.type === ComponentType.FileUploadField\n  )\n}\n\nexport function onlyDeclarationComponents(components: ComponentDef[]): boolean {\n  return components\n    .filter((comp) => isFormType(comp.type))\n    .every((component) => component.type === ComponentType.DeclarationField)\n}\n\nexport function includesPaymentField(components: ComponentDef[]): boolean {\n  return components.some(\n    (component) => component.type === ComponentType.PaymentField\n  )\n}\n\n/**\n * Helper function to determine if a payment question already exists in the form\n */\nexport function hasPaymentQuestionInForm(definition: FormDefinition) {\n  if (definition.pages.length === 0) {\n    return false\n  }\n\n  for (const page of definition.pages) {\n    const hasPayment = hasComponents(page)\n      ? includesPaymentField(page.components)\n      : false\n    if (hasPayment) {\n      return true\n    }\n  }\n  return false\n}\n\n/**\n * Helper function to determine if a specific question type exists in the form\n */\nexport function hasSpecificQuestionTypeInForm(\n  definition: FormDefinition,\n  componentType: ComponentType\n) {\n  if (definition.pages.length === 0) {\n    return false\n  }\n\n  for (const page of definition.pages) {\n    const hasPayment = hasComponents(page)\n      ? page.components.some((component) => component.type === componentType)\n      : false\n    if (hasPayment) {\n      return true\n    }\n  }\n  return false\n}\n\nconst SHOW_REPEATER_CONTROLLERS = [ControllerType.Page, ControllerType.Repeat]\n\nexport function showRepeaterSettings(page: Page): boolean {\n  if (page.controller && !SHOW_REPEATER_CONTROLLERS.includes(page.controller)) {\n    return false\n  }\n  if (hasComponents(page)) {\n    if (includesFileUploadField(page.components)) {\n      return false\n    }\n    if (onlyDeclarationComponents(page.components)) {\n      return false\n    }\n    if (includesPaymentField(page.components)) {\n      return false\n    }\n  }\n  return true\n}\n\n/**\n * Gets page title, or title of first question (if no page title set)\n * @param {Page} page\n * @returns {string}\n */\nexport function getPageTitle(page: Page) {\n  if (page.title !== '') {\n    return page.title\n  }\n\n  if (hasComponentsEvenIfNoNext(page)) {\n    const firstComp = page.components.find(hasFormField)\n    if (firstComp) {\n      return firstComp.title\n    }\n  }\n  return 'Page title unknown'\n}\n\n/**\n *\n * @param {FormDefinition} definition\n * @param {string} pageId\n * @returns { Page | undefined }\n */\nexport function getPageFromDefinition(\n  definition: FormDefinition,\n  pageId: string\n): Page | undefined {\n  return definition.pages.find((x) => x.id === pageId)\n}\n\nexport const summaryPageControllers = [\n  ControllerType.Summary,\n  ControllerType.SummaryWithConfirmationEmail\n]\n\nexport function isSummaryPage(page: Page | undefined) {\n  return summaryPageControllers.includes(\n    page?.controller ?? ControllerType.Page\n  )\n}\n\n/**\n * Revert any custom controllers to their parent/base class since engine-plugin has no knowledge of them\n * @param {FormDefinition} definition\n * @returns {FormDefinition}\n */\nexport function replaceCustomControllers(definition: FormDefinition) {\n  const standardControllers = new Set(\n    Object.values(ControllerType)\n      .filter((x) => x !== ControllerType.SummaryWithConfirmationEmail)\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion\n      .map((x) => x.toString())\n  )\n\n  return {\n    ...definition,\n    pages: definition.pages.map((page) => {\n      if (\n        !standardControllers.has(\n          // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion\n          (page.controller ?? ControllerType.Page).toString()\n        )\n      ) {\n        return /** @type {Page} */ {\n          ...page,\n          controller: ControllerType.Page\n        }\n      }\n      return page\n    })\n  } as FormDefinition\n}\n\n/**\n * Helper function to determine if the current page contains a payment question\n * @param page - the page of the form\n * @returns {boolean}\n */\nexport function isPaymentPage(page: Page | undefined) {\n  if (hasComponentsEvenIfNoNext(page)) {\n    return page.components.some(\n      (comp) => comp.type === ComponentType.PaymentField\n    )\n  }\n  return false\n}\n\n/**\n * Helper function to determine if the current page is an end page i.e. summary page or payment page\n * @param page - the page of the form\n * @returns {boolean}\n */\nexport function isEndPage(page: Page | undefined) {\n  return isSummaryPage(page) || isPaymentPage(page)\n}\n"],"mappings":"AAAA,SAASA,aAAa;AACtB,SAASC,YAAY,EAAEC,UAAU;AAUjC,SACEC,eAAe,EACfC,eAAe;AAEjB,SAASC,cAAc;AACvB,SAASC,SAAS;;AAElB;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,IAAmC,EACnC;EACA,MAAMC,UAAU,GAAGD,IAAI,EAAEE,UAAU,IAAIL,cAAc,CAACM,IAAI;EAC1D,MAAMD,UAAU,GAAGE,sBAAsB,CAACH,UAAU,CAAC;EAErD,MAAMI,QAAQ,GAAGP,SAAS,CAACQ,IAAI,CAC5BC,QAAQ,IAAKA,QAAQ,CAACL,UAAU,KAAKA,UACxC,CAAC;EAED,IAAI,CAACG,QAAQ,EAAE;IACb,MAAM,IAAIG,KAAK,CAAC,qCAAqCP,UAAU,GAAG,CAAC;EACrE;EAEA,OAAOQ,eAAe,CAACJ,QAAQ,CAAC;AAClC;;AAEA;AACA;AACA;AACA,OAAO,SAASK,aAAaA,CAC3BV,IAAoB,EACmC;EACvD,OAAOW,OAAO,CAACX,IAAI,CAAC,IAAIY,KAAK,CAACC,OAAO,CAACb,IAAI,CAACc,UAAU,CAAC;AACxD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,yBAAyBA,CACvCf,IAAoB,EACmC;EACvD,OACEA,IAAI,KAAKgB,SAAS,IAAI,YAAY,IAAIhB,IAAI,IAAIY,KAAK,CAACC,OAAO,CAACb,IAAI,CAACc,UAAU,CAAC;AAEhF;;AAEA;AACA;AACA;AACA,OAAO,SAASG,iBAAiBA,CAC/BjB,IAAoB,EACmB;EACvC,MAAME,UAAU,GAAGE,sBAAsB,CAACJ,IAAI,EAAEE,UAAU,CAAC;EAC3D,OAAOQ,aAAa,CAACV,IAAI,CAAC,IAAIE,UAAU,KAAKL,cAAc,CAACqB,KAAK;AACnE;;AAEA;AACA;AACA;AACA,OAAO,SAASC,WAAWA,CAACnB,IAAoB,EAAsB;EACpE,OAAOI,sBAAsB,CAACJ,IAAI,EAAEE,UAAU,CAAC,KAAKL,cAAc,CAACuB,MAAM;AAC3E;;AAEA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BpB,UAAoC,EACN;EAC9B,OAAO,CAAC,CAACA,UAAU,IAAIN,eAAe,CAAC2B,GAAG,CAACC,MAAM,CAAC,CAACC,QAAQ,CAACvB,UAAU,CAAC;AACzE;;AAEA;AACA;AACA;AACA,OAAO,SAASU,OAAOA,CACrBX,IAAoB,EACqB;EACzC,IAAI,CAACA,IAAI,IAAI,EAAE,MAAM,IAAIA,IAAI,CAAC,EAAE;IAC9B,OAAO,KAAK;EACd;EAEA,MAAME,UAAU,GAAGE,sBAAsB,CAACJ,IAAI,CAACE,UAAU,CAAC;EAE1D,OACE,CAACA,UAAU,IACXA,UAAU,KAAKL,cAAc,CAACqB,KAAK,IACnChB,UAAU,KAAKL,cAAc,CAACM,IAAI,IAClCD,UAAU,KAAKL,cAAc,CAAC4B,QAAQ,IACtCvB,UAAU,KAAKL,cAAc,CAAC6B,UAAU,IACxCxB,UAAU,KAAKL,cAAc,CAACuB,MAAM;AAExC;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAAShB,sBAAsBA,CAACH,UAAoC,EAAE;EAC3E,IAAIoB,gBAAgB,CAACpB,UAAU,CAAC,EAAE;IAChC,OAAOA,UAAU;EACnB;EAEA,MAAM0B,OAAO,GAAG/B,eAAe,CAACU,IAAI,CAAC,CAAC;IAAEsB;EAAK,CAAC,KAAKA,IAAI,KAAK3B,UAAU,CAAC;EACvE,OAAO0B,OAAO,EAAEE,IAAI;AACtB;AAEA,OAAO,SAASC,uBAAuBA,CAAChB,UAA0B,EAAW;EAC3E,OAAOA,UAAU,CAACiB,IAAI,CACnBC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAAC0C,eAClD,CAAC;AACH;AAEA,OAAO,SAASC,yBAAyBA,CAACrB,UAA0B,EAAW;EAC7E,OAAOA,UAAU,CACdsB,MAAM,CAAEC,IAAI,IAAK3C,UAAU,CAAC2C,IAAI,CAACJ,IAAI,CAAC,CAAC,CACvCK,KAAK,CAAEN,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAAC+C,gBAAgB,CAAC;AAC5E;AAEA,OAAO,SAASC,oBAAoBA,CAAC1B,UAA0B,EAAW;EACxE,OAAOA,UAAU,CAACiB,IAAI,CACnBC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAACiD,YAClD,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CAACC,UAA0B,EAAE;EACnE,IAAIA,UAAU,CAACC,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;IACjC,OAAO,KAAK;EACd;EAEA,KAAK,MAAM7C,IAAI,IAAI2C,UAAU,CAACC,KAAK,EAAE;IACnC,MAAME,UAAU,GAAGpC,aAAa,CAACV,IAAI,CAAC,GAClCwC,oBAAoB,CAACxC,IAAI,CAACc,UAAU,CAAC,GACrC,KAAK;IACT,IAAIgC,UAAU,EAAE;MACd,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA,OAAO,SAASC,6BAA6BA,CAC3CJ,UAA0B,EAC1BK,aAA4B,EAC5B;EACA,IAAIL,UAAU,CAACC,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;IACjC,OAAO,KAAK;EACd;EAEA,KAAK,MAAM7C,IAAI,IAAI2C,UAAU,CAACC,KAAK,EAAE;IACnC,MAAME,UAAU,GAAGpC,aAAa,CAACV,IAAI,CAAC,GAClCA,IAAI,CAACc,UAAU,CAACiB,IAAI,CAAEC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKe,aAAa,CAAC,GACrE,KAAK;IACT,IAAIF,UAAU,EAAE;MACd,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd;AAEA,MAAMG,yBAAyB,GAAG,CAACpD,cAAc,CAACM,IAAI,EAAEN,cAAc,CAACuB,MAAM,CAAC;AAE9E,OAAO,SAAS8B,oBAAoBA,CAAClD,IAAU,EAAW;EACxD,IAAIA,IAAI,CAACE,UAAU,IAAI,CAAC+C,yBAAyB,CAACzB,QAAQ,CAACxB,IAAI,CAACE,UAAU,CAAC,EAAE;IAC3E,OAAO,KAAK;EACd;EACA,IAAIQ,aAAa,CAACV,IAAI,CAAC,EAAE;IACvB,IAAI8B,uBAAuB,CAAC9B,IAAI,CAACc,UAAU,CAAC,EAAE;MAC5C,OAAO,KAAK;IACd;IACA,IAAIqB,yBAAyB,CAACnC,IAAI,CAACc,UAAU,CAAC,EAAE;MAC9C,OAAO,KAAK;IACd;IACA,IAAI0B,oBAAoB,CAACxC,IAAI,CAACc,UAAU,CAAC,EAAE;MACzC,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASqC,YAAYA,CAACnD,IAAU,EAAE;EACvC,IAAIA,IAAI,CAACoD,KAAK,KAAK,EAAE,EAAE;IACrB,OAAOpD,IAAI,CAACoD,KAAK;EACnB;EAEA,IAAIrC,yBAAyB,CAACf,IAAI,CAAC,EAAE;IACnC,MAAMqD,SAAS,GAAGrD,IAAI,CAACc,UAAU,CAACR,IAAI,CAACb,YAAY,CAAC;IACpD,IAAI4D,SAAS,EAAE;MACb,OAAOA,SAAS,CAACD,KAAK;IACxB;EACF;EACA,OAAO,oBAAoB;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,qBAAqBA,CACnCX,UAA0B,EAC1BY,MAAc,EACI;EAClB,OAAOZ,UAAU,CAACC,KAAK,CAACtC,IAAI,CAAEkD,CAAC,IAAKA,CAAC,CAACC,EAAE,KAAKF,MAAM,CAAC;AACtD;AAEA,OAAO,MAAMG,sBAAsB,GAAG,CACpC7D,cAAc,CAAC8D,OAAO,EACtB9D,cAAc,CAAC+D,4BAA4B,CAC5C;AAED,OAAO,SAASC,aAAaA,CAAC7D,IAAsB,EAAE;EACpD,OAAO0D,sBAAsB,CAAClC,QAAQ,CACpCxB,IAAI,EAAEE,UAAU,IAAIL,cAAc,CAACM,IACrC,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS2D,wBAAwBA,CAACnB,UAA0B,EAAE;EACnE,MAAMoB,mBAAmB,GAAG,IAAIC,GAAG,CACjCC,MAAM,CAACC,MAAM,CAACrE,cAAc,CAAC,CAC1BuC,MAAM,CAAEoB,CAAC,IAAKA,CAAC,KAAK3D,cAAc,CAAC+D,4BAA4B;EAChE;EAAA,CACCtC,GAAG,CAAEkC,CAAC,IAAKA,CAAC,CAACW,QAAQ,CAAC,CAAC,CAC5B,CAAC;EAED,OAAO;IACL,GAAGxB,UAAU;IACbC,KAAK,EAAED,UAAU,CAACC,KAAK,CAACtB,GAAG,CAAEtB,IAAI,IAAK;MACpC,IACE,CAAC+D,mBAAmB,CAACK,GAAG;MACtB;MACA,CAACpE,IAAI,CAACE,UAAU,IAAIL,cAAc,CAACM,IAAI,EAAEgE,QAAQ,CAAC,CACpD,CAAC,EACD;QACA,OAAO,mBAAoB;UACzB,GAAGnE,IAAI;UACPE,UAAU,EAAEL,cAAc,CAACM;QAC7B,CAAC;MACH;MACA,OAAOH,IAAI;IACb,CAAC;EACH,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASqE,aAAaA,CAACrE,IAAsB,EAAE;EACpD,IAAIe,yBAAyB,CAACf,IAAI,CAAC,EAAE;IACnC,OAAOA,IAAI,CAACc,UAAU,CAACiB,IAAI,CACxBM,IAAI,IAAKA,IAAI,CAACJ,IAAI,KAAKzC,aAAa,CAACiD,YACxC,CAAC;EACH;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS6B,SAASA,CAACtE,IAAsB,EAAE;EAChD,OAAO6D,aAAa,CAAC7D,IAAI,CAAC,IAAIqE,aAAa,CAACrE,IAAI,CAAC;AACnD","ignoreList":[]}
+{"version":3,"file":"helpers.js","names":["ComponentType","hasFormField","isFormType","ControllerNames","ControllerTypes","ControllerType","PageTypes","getPageDefaults","page","nameOrPath","controller","Page","controllerNameFromPath","defaults","find","pageType","Error","structuredClone","hasComponents","hasNext","Array","isArray","components","hasComponentsEvenIfNoNext","undefined","hasFormComponents","Start","hasRepeater","Repeat","isControllerName","map","String","includes","Terminal","FileUpload","options","path","name","includesFileUploadField","some","component","type","FileUploadField","onlyDeclarationComponents","filter","comp","every","DeclarationField","includesPaymentField","PaymentField","hasPaymentQuestionInForm","definition","pages","length","hasPayment","hasPostcodeLookupInForm","addressField","UkAddressField","usePostcodeLookup","hasSpecificQuestionTypeInForm","componentType","hasSpecificComponent","SHOW_REPEATER_CONTROLLERS","showRepeaterSettings","getPageTitle","title","firstComp","getPageFromDefinition","pageId","x","id","summaryPageControllers","Summary","SummaryWithConfirmationEmail","isSummaryPage","replaceCustomControllers","standardControllers","Set","Object","values","toString","has","isPaymentPage","isEndPage"],"sources":["../../../src/pages/helpers.ts"],"sourcesContent":["import { ComponentType } from '~/src/components/enums.js'\nimport { hasFormField, isFormType } from '~/src/components/helpers.js'\nimport { type ComponentDef } from '~/src/components/types.js'\nimport {\n  type Link,\n  type Page,\n  type PageFileUpload,\n  type PageQuestion,\n  type PageRepeat\n} from '~/src/form/form-definition/types.js'\nimport { type FormDefinition } from '~/src/index.js'\nimport {\n  ControllerNames,\n  ControllerTypes\n} from '~/src/pages/controller-types.js'\nimport { ControllerType } from '~/src/pages/enums.js'\nimport { PageTypes } from '~/src/pages/page-types.js'\n\n/**\n * Return component defaults by type\n */\nexport function getPageDefaults<PageType extends Page>(\n  page?: Pick<PageType, 'controller'>\n) {\n  const nameOrPath = page?.controller ?? ControllerType.Page\n  const controller = controllerNameFromPath(nameOrPath)\n\n  const defaults = PageTypes.find(\n    (pageType) => pageType.controller === controller\n  )\n\n  if (!defaults) {\n    throw new Error(`Defaults not found for page type '${nameOrPath}'`)\n  }\n\n  return structuredClone(defaults) as PageType\n}\n\n/**\n * Check page has components\n */\nexport function hasComponents(\n  page?: Partial<Page>\n): page is Extract<Page, { components: ComponentDef[] }> {\n  return hasNext(page) && Array.isArray(page.components)\n}\n\n/**\n * Check if the page has components (the page can be any page type e.g. SummaryPage)\n */\nexport function hasComponentsEvenIfNoNext(\n  page?: Partial<Page>\n): page is Extract<Page, { components: ComponentDef[] }> {\n  return (\n    page !== undefined && 'components' in page && Array.isArray(page.components)\n  )\n}\n\n/**\n * Check page has form components\n */\nexport function hasFormComponents(\n  page?: Partial<Page>\n): page is PageQuestion | PageFileUpload {\n  const controller = controllerNameFromPath(page?.controller)\n  return hasComponents(page) && controller !== ControllerType.Start\n}\n\n/**\n * Check page has repeater\n */\nexport function hasRepeater(page?: Partial<Page>): page is PageRepeat {\n  return controllerNameFromPath(page?.controller) === ControllerType.Repeat\n}\n\n/**\n * Check for known page controller names\n */\nexport function isControllerName(\n  nameOrPath?: ControllerType | string\n): nameOrPath is ControllerType {\n  return !!nameOrPath && ControllerNames.map(String).includes(nameOrPath)\n}\n\n/**\n * Check page has next link\n */\nexport function hasNext(\n  page?: Partial<Page>\n): page is Extract<Page, { next: Link[] }> {\n  if (!page || !('next' in page)) {\n    return false\n  }\n\n  const controller = controllerNameFromPath(page.controller)\n\n  return (\n    !controller ||\n    controller === ControllerType.Start ||\n    controller === ControllerType.Page ||\n    controller === ControllerType.Terminal ||\n    controller === ControllerType.FileUpload ||\n    controller === ControllerType.Repeat\n  )\n}\n\n/**\n * Check and optionally replace legacy path with controller name\n * @param {string} [nameOrPath] - Controller name or legacy controller path\n */\nexport function controllerNameFromPath(nameOrPath?: ControllerType | string) {\n  if (isControllerName(nameOrPath)) {\n    return nameOrPath\n  }\n\n  const options = ControllerTypes.find(({ path }) => path === nameOrPath)\n  return options?.name\n}\n\nexport function includesFileUploadField(components: ComponentDef[]): boolean {\n  return components.some(\n    (component) => component.type === ComponentType.FileUploadField\n  )\n}\n\nexport function onlyDeclarationComponents(components: ComponentDef[]): boolean {\n  return components\n    .filter((comp) => isFormType(comp.type))\n    .every((component) => component.type === ComponentType.DeclarationField)\n}\n\nexport function includesPaymentField(components: ComponentDef[]): boolean {\n  return components.some(\n    (component) => component.type === ComponentType.PaymentField\n  )\n}\n\n/**\n * Helper function to determine if a payment question already exists in the form\n */\nexport function hasPaymentQuestionInForm(definition: FormDefinition) {\n  if (definition.pages.length === 0) {\n    return false\n  }\n\n  for (const page of definition.pages) {\n    const hasPayment = hasComponents(page)\n      ? includesPaymentField(page.components)\n      : false\n    if (hasPayment) {\n      return true\n    }\n  }\n  return false\n}\n\n/**\n * Helper function to determine if the form uses postcode lookup\n */\nexport function hasPostcodeLookupInForm(definition: FormDefinition) {\n  if (definition.pages.length === 0) {\n    return false\n  }\n\n  for (const page of definition.pages) {\n    const addressField = hasComponents(page)\n      ? page.components.find(\n          (component) => component.type === ComponentType.UkAddressField\n        )\n      : undefined\n    if (addressField?.options.usePostcodeLookup) {\n      return true\n    }\n  }\n  return false\n}\n\n/**\n * Helper function to determine if a specific question type exists in the form\n */\nexport function hasSpecificQuestionTypeInForm(\n  definition: FormDefinition,\n  componentType: ComponentType\n) {\n  if (definition.pages.length === 0) {\n    return false\n  }\n\n  for (const page of definition.pages) {\n    const hasSpecificComponent = hasComponents(page)\n      ? page.components.some((component) => component.type === componentType)\n      : false\n    if (hasSpecificComponent) {\n      return true\n    }\n  }\n  return false\n}\n\nconst SHOW_REPEATER_CONTROLLERS = [ControllerType.Page, ControllerType.Repeat]\n\nexport function showRepeaterSettings(page: Page): boolean {\n  if (page.controller && !SHOW_REPEATER_CONTROLLERS.includes(page.controller)) {\n    return false\n  }\n  if (hasComponents(page)) {\n    if (includesFileUploadField(page.components)) {\n      return false\n    }\n    if (onlyDeclarationComponents(page.components)) {\n      return false\n    }\n    if (includesPaymentField(page.components)) {\n      return false\n    }\n  }\n  return true\n}\n\n/**\n * Gets page title, or title of first question (if no page title set)\n * @param {Page} page\n * @returns {string}\n */\nexport function getPageTitle(page: Page) {\n  if (page.title !== '') {\n    return page.title\n  }\n\n  if (hasComponentsEvenIfNoNext(page)) {\n    const firstComp = page.components.find(hasFormField)\n    if (firstComp) {\n      return firstComp.title\n    }\n  }\n  return 'Page title unknown'\n}\n\n/**\n *\n * @param {FormDefinition} definition\n * @param {string} pageId\n * @returns { Page | undefined }\n */\nexport function getPageFromDefinition(\n  definition: FormDefinition,\n  pageId: string\n): Page | undefined {\n  return definition.pages.find((x) => x.id === pageId)\n}\n\nexport const summaryPageControllers = [\n  ControllerType.Summary,\n  ControllerType.SummaryWithConfirmationEmail\n]\n\nexport function isSummaryPage(page: Page | undefined) {\n  return summaryPageControllers.includes(\n    page?.controller ?? ControllerType.Page\n  )\n}\n\n/**\n * Revert any custom controllers to their parent/base class since engine-plugin has no knowledge of them\n * @param {FormDefinition} definition\n * @returns {FormDefinition}\n */\nexport function replaceCustomControllers(definition: FormDefinition) {\n  const standardControllers = new Set(\n    Object.values(ControllerType)\n      .filter((x) => x !== ControllerType.SummaryWithConfirmationEmail)\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion\n      .map((x) => x.toString())\n  )\n\n  return {\n    ...definition,\n    pages: definition.pages.map((page) => {\n      if (\n        !standardControllers.has(\n          // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion\n          (page.controller ?? ControllerType.Page).toString()\n        )\n      ) {\n        return /** @type {Page} */ {\n          ...page,\n          controller: ControllerType.Page\n        }\n      }\n      return page\n    })\n  } as FormDefinition\n}\n\n/**\n * Helper function to determine if the current page contains a payment question\n * @param page - the page of the form\n * @returns {boolean}\n */\nexport function isPaymentPage(page: Page | undefined) {\n  if (hasComponentsEvenIfNoNext(page)) {\n    return page.components.some(\n      (comp) => comp.type === ComponentType.PaymentField\n    )\n  }\n  return false\n}\n\n/**\n * Helper function to determine if the current page is an end page i.e. summary page or payment page\n * @param page - the page of the form\n * @returns {boolean}\n */\nexport function isEndPage(page: Page | undefined) {\n  return isSummaryPage(page) || isPaymentPage(page)\n}\n"],"mappings":"AAAA,SAASA,aAAa;AACtB,SAASC,YAAY,EAAEC,UAAU;AAUjC,SACEC,eAAe,EACfC,eAAe;AAEjB,SAASC,cAAc;AACvB,SAASC,SAAS;;AAElB;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAC7BC,IAAmC,EACnC;EACA,MAAMC,UAAU,GAAGD,IAAI,EAAEE,UAAU,IAAIL,cAAc,CAACM,IAAI;EAC1D,MAAMD,UAAU,GAAGE,sBAAsB,CAACH,UAAU,CAAC;EAErD,MAAMI,QAAQ,GAAGP,SAAS,CAACQ,IAAI,CAC5BC,QAAQ,IAAKA,QAAQ,CAACL,UAAU,KAAKA,UACxC,CAAC;EAED,IAAI,CAACG,QAAQ,EAAE;IACb,MAAM,IAAIG,KAAK,CAAC,qCAAqCP,UAAU,GAAG,CAAC;EACrE;EAEA,OAAOQ,eAAe,CAACJ,QAAQ,CAAC;AAClC;;AAEA;AACA;AACA;AACA,OAAO,SAASK,aAAaA,CAC3BV,IAAoB,EACmC;EACvD,OAAOW,OAAO,CAACX,IAAI,CAAC,IAAIY,KAAK,CAACC,OAAO,CAACb,IAAI,CAACc,UAAU,CAAC;AACxD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,yBAAyBA,CACvCf,IAAoB,EACmC;EACvD,OACEA,IAAI,KAAKgB,SAAS,IAAI,YAAY,IAAIhB,IAAI,IAAIY,KAAK,CAACC,OAAO,CAACb,IAAI,CAACc,UAAU,CAAC;AAEhF;;AAEA;AACA;AACA;AACA,OAAO,SAASG,iBAAiBA,CAC/BjB,IAAoB,EACmB;EACvC,MAAME,UAAU,GAAGE,sBAAsB,CAACJ,IAAI,EAAEE,UAAU,CAAC;EAC3D,OAAOQ,aAAa,CAACV,IAAI,CAAC,IAAIE,UAAU,KAAKL,cAAc,CAACqB,KAAK;AACnE;;AAEA;AACA;AACA;AACA,OAAO,SAASC,WAAWA,CAACnB,IAAoB,EAAsB;EACpE,OAAOI,sBAAsB,CAACJ,IAAI,EAAEE,UAAU,CAAC,KAAKL,cAAc,CAACuB,MAAM;AAC3E;;AAEA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BpB,UAAoC,EACN;EAC9B,OAAO,CAAC,CAACA,UAAU,IAAIN,eAAe,CAAC2B,GAAG,CAACC,MAAM,CAAC,CAACC,QAAQ,CAACvB,UAAU,CAAC;AACzE;;AAEA;AACA;AACA;AACA,OAAO,SAASU,OAAOA,CACrBX,IAAoB,EACqB;EACzC,IAAI,CAACA,IAAI,IAAI,EAAE,MAAM,IAAIA,IAAI,CAAC,EAAE;IAC9B,OAAO,KAAK;EACd;EAEA,MAAME,UAAU,GAAGE,sBAAsB,CAACJ,IAAI,CAACE,UAAU,CAAC;EAE1D,OACE,CAACA,UAAU,IACXA,UAAU,KAAKL,cAAc,CAACqB,KAAK,IACnChB,UAAU,KAAKL,cAAc,CAACM,IAAI,IAClCD,UAAU,KAAKL,cAAc,CAAC4B,QAAQ,IACtCvB,UAAU,KAAKL,cAAc,CAAC6B,UAAU,IACxCxB,UAAU,KAAKL,cAAc,CAACuB,MAAM;AAExC;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAAShB,sBAAsBA,CAACH,UAAoC,EAAE;EAC3E,IAAIoB,gBAAgB,CAACpB,UAAU,CAAC,EAAE;IAChC,OAAOA,UAAU;EACnB;EAEA,MAAM0B,OAAO,GAAG/B,eAAe,CAACU,IAAI,CAAC,CAAC;IAAEsB;EAAK,CAAC,KAAKA,IAAI,KAAK3B,UAAU,CAAC;EACvE,OAAO0B,OAAO,EAAEE,IAAI;AACtB;AAEA,OAAO,SAASC,uBAAuBA,CAAChB,UAA0B,EAAW;EAC3E,OAAOA,UAAU,CAACiB,IAAI,CACnBC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAAC0C,eAClD,CAAC;AACH;AAEA,OAAO,SAASC,yBAAyBA,CAACrB,UAA0B,EAAW;EAC7E,OAAOA,UAAU,CACdsB,MAAM,CAAEC,IAAI,IAAK3C,UAAU,CAAC2C,IAAI,CAACJ,IAAI,CAAC,CAAC,CACvCK,KAAK,CAAEN,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAAC+C,gBAAgB,CAAC;AAC5E;AAEA,OAAO,SAASC,oBAAoBA,CAAC1B,UAA0B,EAAW;EACxE,OAAOA,UAAU,CAACiB,IAAI,CACnBC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAACiD,YAClD,CAAC;AACH;;AAEA;AACA;AACA;AACA,OAAO,SAASC,wBAAwBA,CAACC,UAA0B,EAAE;EACnE,IAAIA,UAAU,CAACC,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;IACjC,OAAO,KAAK;EACd;EAEA,KAAK,MAAM7C,IAAI,IAAI2C,UAAU,CAACC,KAAK,EAAE;IACnC,MAAME,UAAU,GAAGpC,aAAa,CAACV,IAAI,CAAC,GAClCwC,oBAAoB,CAACxC,IAAI,CAACc,UAAU,CAAC,GACrC,KAAK;IACT,IAAIgC,UAAU,EAAE;MACd,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAACJ,UAA0B,EAAE;EAClE,IAAIA,UAAU,CAACC,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;IACjC,OAAO,KAAK;EACd;EAEA,KAAK,MAAM7C,IAAI,IAAI2C,UAAU,CAACC,KAAK,EAAE;IACnC,MAAMI,YAAY,GAAGtC,aAAa,CAACV,IAAI,CAAC,GACpCA,IAAI,CAACc,UAAU,CAACR,IAAI,CACjB0B,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKzC,aAAa,CAACyD,cAClD,CAAC,GACDjC,SAAS;IACb,IAAIgC,YAAY,EAAErB,OAAO,CAACuB,iBAAiB,EAAE;MAC3C,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA,OAAO,SAASC,6BAA6BA,CAC3CR,UAA0B,EAC1BS,aAA4B,EAC5B;EACA,IAAIT,UAAU,CAACC,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;IACjC,OAAO,KAAK;EACd;EAEA,KAAK,MAAM7C,IAAI,IAAI2C,UAAU,CAACC,KAAK,EAAE;IACnC,MAAMS,oBAAoB,GAAG3C,aAAa,CAACV,IAAI,CAAC,GAC5CA,IAAI,CAACc,UAAU,CAACiB,IAAI,CAAEC,SAAS,IAAKA,SAAS,CAACC,IAAI,KAAKmB,aAAa,CAAC,GACrE,KAAK;IACT,IAAIC,oBAAoB,EAAE;MACxB,OAAO,IAAI;IACb;EACF;EACA,OAAO,KAAK;AACd;AAEA,MAAMC,yBAAyB,GAAG,CAACzD,cAAc,CAACM,IAAI,EAAEN,cAAc,CAACuB,MAAM,CAAC;AAE9E,OAAO,SAASmC,oBAAoBA,CAACvD,IAAU,EAAW;EACxD,IAAIA,IAAI,CAACE,UAAU,IAAI,CAACoD,yBAAyB,CAAC9B,QAAQ,CAACxB,IAAI,CAACE,UAAU,CAAC,EAAE;IAC3E,OAAO,KAAK;EACd;EACA,IAAIQ,aAAa,CAACV,IAAI,CAAC,EAAE;IACvB,IAAI8B,uBAAuB,CAAC9B,IAAI,CAACc,UAAU,CAAC,EAAE;MAC5C,OAAO,KAAK;IACd;IACA,IAAIqB,yBAAyB,CAACnC,IAAI,CAACc,UAAU,CAAC,EAAE;MAC9C,OAAO,KAAK;IACd;IACA,IAAI0B,oBAAoB,CAACxC,IAAI,CAACc,UAAU,CAAC,EAAE;MACzC,OAAO,KAAK;IACd;EACF;EACA,OAAO,IAAI;AACb;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS0C,YAAYA,CAACxD,IAAU,EAAE;EACvC,IAAIA,IAAI,CAACyD,KAAK,KAAK,EAAE,EAAE;IACrB,OAAOzD,IAAI,CAACyD,KAAK;EACnB;EAEA,IAAI1C,yBAAyB,CAACf,IAAI,CAAC,EAAE;IACnC,MAAM0D,SAAS,GAAG1D,IAAI,CAACc,UAAU,CAACR,IAAI,CAACb,YAAY,CAAC;IACpD,IAAIiE,SAAS,EAAE;MACb,OAAOA,SAAS,CAACD,KAAK;IACxB;EACF;EACA,OAAO,oBAAoB;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,qBAAqBA,CACnChB,UAA0B,EAC1BiB,MAAc,EACI;EAClB,OAAOjB,UAAU,CAACC,KAAK,CAACtC,IAAI,CAAEuD,CAAC,IAAKA,CAAC,CAACC,EAAE,KAAKF,MAAM,CAAC;AACtD;AAEA,OAAO,MAAMG,sBAAsB,GAAG,CACpClE,cAAc,CAACmE,OAAO,EACtBnE,cAAc,CAACoE,4BAA4B,CAC5C;AAED,OAAO,SAASC,aAAaA,CAAClE,IAAsB,EAAE;EACpD,OAAO+D,sBAAsB,CAACvC,QAAQ,CACpCxB,IAAI,EAAEE,UAAU,IAAIL,cAAc,CAACM,IACrC,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASgE,wBAAwBA,CAACxB,UAA0B,EAAE;EACnE,MAAMyB,mBAAmB,GAAG,IAAIC,GAAG,CACjCC,MAAM,CAACC,MAAM,CAAC1E,cAAc,CAAC,CAC1BuC,MAAM,CAAEyB,CAAC,IAAKA,CAAC,KAAKhE,cAAc,CAACoE,4BAA4B;EAChE;EAAA,CACC3C,GAAG,CAAEuC,CAAC,IAAKA,CAAC,CAACW,QAAQ,CAAC,CAAC,CAC5B,CAAC;EAED,OAAO;IACL,GAAG7B,UAAU;IACbC,KAAK,EAAED,UAAU,CAACC,KAAK,CAACtB,GAAG,CAAEtB,IAAI,IAAK;MACpC,IACE,CAACoE,mBAAmB,CAACK,GAAG;MACtB;MACA,CAACzE,IAAI,CAACE,UAAU,IAAIL,cAAc,CAACM,IAAI,EAAEqE,QAAQ,CAAC,CACpD,CAAC,EACD;QACA,OAAO,mBAAoB;UACzB,GAAGxE,IAAI;UACPE,UAAU,EAAEL,cAAc,CAACM;QAC7B,CAAC;MACH;MACA,OAAOH,IAAI;IACb,CAAC;EACH,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS0E,aAAaA,CAAC1E,IAAsB,EAAE;EACpD,IAAIe,yBAAyB,CAACf,IAAI,CAAC,EAAE;IACnC,OAAOA,IAAI,CAACc,UAAU,CAACiB,IAAI,CACxBM,IAAI,IAAKA,IAAI,CAACJ,IAAI,KAAKzC,aAAa,CAACiD,YACxC,CAAC;EACH;EACA,OAAO,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASkC,SAASA,CAAC3E,IAAsB,EAAE;EAChD,OAAOkE,aAAa,CAAClE,IAAI,CAAC,IAAI0E,aAAa,CAAC1E,IAAI,CAAC;AACnD","ignoreList":[]}

package/dist/module/pages/index.js

@@ -1,5 +1,5 @@
 export { ControllerNames, ControllerTypes } from "./controller-types.js";
 export { PageTypes } from "./page-types.js";
-export { controllerNameFromPath, getPageDefaults, getPageFromDefinition, getPageTitle, hasComponents, hasComponentsEvenIfNoNext, hasFormComponents, hasNext, hasPaymentQuestionInForm, hasRepeater, hasSpecificQuestionTypeInForm, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from "./helpers.js";
+export { controllerNameFromPath, getPageDefaults, getPageFromDefinition, getPageTitle, hasComponents, hasComponentsEvenIfNoNext, hasFormComponents, hasNext, hasPaymentQuestionInForm, hasPostcodeLookupInForm, hasRepeater, hasSpecificQuestionTypeInForm, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from "./helpers.js";
 export { ControllerPath, ControllerType } from "./enums.js";
 //# sourceMappingURL=index.js.map

package/dist/module/pages/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["ControllerNames","ControllerTypes","PageTypes","controllerNameFromPath","getPageDefaults","getPageFromDefinition","getPageTitle","hasComponents","hasComponentsEvenIfNoNext","hasFormComponents","hasNext","hasPaymentQuestionInForm","hasRepeater","hasSpecificQuestionTypeInForm","includesFileUploadField","includesPaymentField","isControllerName","isEndPage","isPaymentPage","isSummaryPage","replaceCustomControllers","showRepeaterSettings","summaryPageControllers","ControllerPath","ControllerType"],"sources":["../../../src/pages/index.ts"],"sourcesContent":["export {\n  ControllerNames,\n  ControllerTypes\n} from '~/src/pages/controller-types.js'\n\nexport { PageTypes } from '~/src/pages/page-types.js'\n\nexport {\n  controllerNameFromPath,\n  getPageDefaults,\n  getPageFromDefinition,\n  getPageTitle,\n  hasComponents,\n  hasComponentsEvenIfNoNext,\n  hasFormComponents,\n  hasNext,\n  hasPaymentQuestionInForm,\n  hasRepeater,\n  hasSpecificQuestionTypeInForm,\n  includesFileUploadField,\n  includesPaymentField,\n  isControllerName,\n  isEndPage,\n  isPaymentPage,\n  isSummaryPage,\n  replaceCustomControllers,\n  showRepeaterSettings,\n  summaryPageControllers\n} from '~/src/pages/helpers.js'\n\nexport { ControllerPath, ControllerType } from '~/src/pages/enums.js'\n"],"mappings":"AAAA,SACEA,eAAe,EACfC,eAAe;AAGjB,SAASC,SAAS;AAElB,SACEC,sBAAsB,EACtBC,eAAe,EACfC,qBAAqB,EACrBC,YAAY,EACZC,aAAa,EACbC,yBAAyB,EACzBC,iBAAiB,EACjBC,OAAO,EACPC,wBAAwB,EACxBC,WAAW,EACXC,6BAA6B,EAC7BC,uBAAuB,EACvBC,oBAAoB,EACpBC,gBAAgB,EAChBC,SAAS,EACTC,aAAa,EACbC,aAAa,EACbC,wBAAwB,EACxBC,oBAAoB,EACpBC,sBAAsB;AAGxB,SAASC,cAAc,EAAEC,cAAc","ignoreList":[]}
+{"version":3,"file":"index.js","names":["ControllerNames","ControllerTypes","PageTypes","controllerNameFromPath","getPageDefaults","getPageFromDefinition","getPageTitle","hasComponents","hasComponentsEvenIfNoNext","hasFormComponents","hasNext","hasPaymentQuestionInForm","hasPostcodeLookupInForm","hasRepeater","hasSpecificQuestionTypeInForm","includesFileUploadField","includesPaymentField","isControllerName","isEndPage","isPaymentPage","isSummaryPage","replaceCustomControllers","showRepeaterSettings","summaryPageControllers","ControllerPath","ControllerType"],"sources":["../../../src/pages/index.ts"],"sourcesContent":["export {\n  ControllerNames,\n  ControllerTypes\n} from '~/src/pages/controller-types.js'\n\nexport { PageTypes } from '~/src/pages/page-types.js'\n\nexport {\n  controllerNameFromPath,\n  getPageDefaults,\n  getPageFromDefinition,\n  getPageTitle,\n  hasComponents,\n  hasComponentsEvenIfNoNext,\n  hasFormComponents,\n  hasNext,\n  hasPaymentQuestionInForm,\n  hasPostcodeLookupInForm,\n  hasRepeater,\n  hasSpecificQuestionTypeInForm,\n  includesFileUploadField,\n  includesPaymentField,\n  isControllerName,\n  isEndPage,\n  isPaymentPage,\n  isSummaryPage,\n  replaceCustomControllers,\n  showRepeaterSettings,\n  summaryPageControllers\n} from '~/src/pages/helpers.js'\n\nexport { ControllerPath, ControllerType } from '~/src/pages/enums.js'\n"],"mappings":"AAAA,SACEA,eAAe,EACfC,eAAe;AAGjB,SAASC,SAAS;AAElB,SACEC,sBAAsB,EACtBC,eAAe,EACfC,qBAAqB,EACrBC,YAAY,EACZC,aAAa,EACbC,yBAAyB,EACzBC,iBAAiB,EACjBC,OAAO,EACPC,wBAAwB,EACxBC,uBAAuB,EACvBC,WAAW,EACXC,6BAA6B,EAC7BC,uBAAuB,EACvBC,oBAAoB,EACpBC,gBAAgB,EAChBC,SAAS,EACTC,aAAa,EACbC,aAAa,EACbC,wBAAwB,EACxBC,oBAAoB,EACpBC,sBAAsB;AAGxB,SAASC,cAAc,EAAEC,cAAc","ignoreList":[]}

package/dist/types/pages/helpers.d.ts

@@ -49,6 +49,10 @@ export declare function includesPaymentField(components: ComponentDef[]): boolea
  * Helper function to determine if a payment question already exists in the form
  */
 export declare function hasPaymentQuestionInForm(definition: FormDefinition): boolean;
+/**
+ * Helper function to determine if the form uses postcode lookup
+ */
+export declare function hasPostcodeLookupInForm(definition: FormDefinition): boolean;
 /**
  * Helper function to determine if a specific question type exists in the form
  */

package/dist/types/pages/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/pages/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EACL,KAAK,IAAI,EACT,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,UAAU,EAChB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAKpD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAGrD;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,SAAS,IAAI,EACnD,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,GAaC,QAAQ,CAC7C;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,YAAY,EAAE,CAAA;CAAE,CAAC,CAEvD;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,YAAY,EAAE,CAAA;CAAE,CAAC,CAIvD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,YAAY,GAAG,cAAc,CAGvC;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,UAAU,CAEpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,CAAC,EAAE,cAAc,GAAG,MAAM,GACnC,UAAU,IAAI,cAAc,CAE9B;AAED;;GAEG;AACH,wBAAgB,OAAO,CACrB,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC,CAezC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,MAAM,8BAO1E;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAI3E;AAED,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAI7E;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAIxE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,cAAc,WAclE;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,cAAc,EAC1B,aAAa,EAAE,aAAa,WAe7B;AAID,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAgBxD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,UAYtC;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,MAAM,GACb,IAAI,GAAG,SAAS,CAElB;AAED,eAAO,MAAM,sBAAsB,kBAGlC,CAAA;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAInD;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,cAAc,GAwB5D,cAAc,CACpB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAOnD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAE/C"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/pages/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EACL,KAAK,IAAI,EACT,KAAK,IAAI,EACT,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,UAAU,EAChB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAKpD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAGrD;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,SAAS,IAAI,EACnD,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,GAaC,QAAQ,CAC7C;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,YAAY,EAAE,CAAA;CAAE,CAAC,CAEvD;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,YAAY,EAAE,CAAA;CAAE,CAAC,CAIvD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,YAAY,GAAG,cAAc,CAGvC;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,UAAU,CAEpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,CAAC,EAAE,cAAc,GAAG,MAAM,GACnC,UAAU,IAAI,cAAc,CAE9B;AAED;;GAEG;AACH,wBAAgB,OAAO,CACrB,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACnB,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC,CAezC;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,CAAC,EAAE,cAAc,GAAG,MAAM,8BAO1E;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAI3E;AAED,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAI7E;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAIxE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,cAAc,WAclE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,cAAc,WAgBjE;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,cAAc,EAC1B,aAAa,EAAE,aAAa,WAe7B;AAID,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAgBxD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,UAYtC;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,MAAM,GACb,IAAI,GAAG,SAAS,CAElB;AAED,eAAO,MAAM,sBAAsB,kBAGlC,CAAA;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAInD;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,cAAc,GAwB5D,cAAc,CACpB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAOnD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,WAE/C"}

package/dist/types/pages/index.d.ts

@@ -1,5 +1,5 @@
 export { ControllerNames, ControllerTypes } from '../pages/controller-types.js';
 export { PageTypes } from '../pages/page-types.js';
-export { controllerNameFromPath, getPageDefaults, getPageFromDefinition, getPageTitle, hasComponents, hasComponentsEvenIfNoNext, hasFormComponents, hasNext, hasPaymentQuestionInForm, hasRepeater, hasSpecificQuestionTypeInForm, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from '../pages/helpers.js';
+export { controllerNameFromPath, getPageDefaults, getPageFromDefinition, getPageTitle, hasComponents, hasComponentsEvenIfNoNext, hasFormComponents, hasNext, hasPaymentQuestionInForm, hasPostcodeLookupInForm, hasRepeater, hasSpecificQuestionTypeInForm, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from '../pages/helpers.js';
 export { ControllerPath, ControllerType } from '../pages/enums.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/pages/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,EAChB,MAAM,iCAAiC,CAAA;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAErD,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,yBAAyB,EACzB,iBAAiB,EACjB,OAAO,EACP,wBAAwB,EACxB,WAAW,EACX,6BAA6B,EAC7B,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,EAChB,MAAM,iCAAiC,CAAA;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAErD,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,yBAAyB,EACzB,iBAAiB,EACjB,OAAO,EACP,wBAAwB,EACxB,uBAAuB,EACvB,WAAW,EACX,6BAA6B,EAC7B,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.663",
+  "version": "3.0.664",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

package/src/pages/helpers.ts

@@ -154,6 +154,27 @@ export function hasPaymentQuestionInForm(definition: FormDefinition) {
   return false
 }
 
+/**
+ * Helper function to determine if the form uses postcode lookup
+ */
+export function hasPostcodeLookupInForm(definition: FormDefinition) {
+  if (definition.pages.length === 0) {
+    return false
+  }
+
+  for (const page of definition.pages) {
+    const addressField = hasComponents(page)
+      ? page.components.find(
+          (component) => component.type === ComponentType.UkAddressField
+        )
+      : undefined
+    if (addressField?.options.usePostcodeLookup) {
+      return true
+    }
+  }
+  return false
+}
+
 /**
  * Helper function to determine if a specific question type exists in the form
  */
@@ -166,10 +187,10 @@ export function hasSpecificQuestionTypeInForm(
   }
 
   for (const page of definition.pages) {
-    const hasPayment = hasComponents(page)
+    const hasSpecificComponent = hasComponents(page)
       ? page.components.some((component) => component.type === componentType)
       : false
-    if (hasPayment) {
+    if (hasSpecificComponent) {
       return true
     }
   }

package/src/pages/index.ts

@@ -15,6 +15,7 @@ export {
   hasFormComponents,
   hasNext,
   hasPaymentQuestionInForm,
+  hasPostcodeLookupInForm,
   hasRepeater,
   hasSpecificQuestionTypeInForm,
   includesFileUploadField,