@defra/forms-model 3.0.644 → 3.0.645

package/dist/module/form/form-metrics/enums.js

@@ -0,0 +1,7 @@
+export let FormMetricType = /*#__PURE__*/function (FormMetricType) {
+  FormMetricType["HeadlineMetric"] = "headline-metric";
+  FormMetricType["OverviewMetric"] = "overview-metric";
+  FormMetricType["TimelineMetric"] = "timeline-metric";
+  return FormMetricType;
+}({});
+//# sourceMappingURL=enums.js.map

package/dist/module/form/form-metrics/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","names":["FormMetricType"],"sources":["../../../../src/form/form-metrics/enums.ts"],"sourcesContent":["export enum FormMetricType {\n  HeadlineMetric = 'headline-metric',\n  OverviewMetric = 'overview-metric',\n  TimelineMetric = 'timeline-metric'\n}\n"],"mappings":"AAAA,WAAYA,cAAc,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}

package/dist/module/form/form-metrics/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/module/form/form-metrics/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-metrics/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport { type FormMetricType } from '~/src/form/form-metrics/enums.js'\n\nexport interface FormHeadlineDetail {\n  count: number\n  countSevenDaysAgo: number\n  countThirtyDaysAgo: number\n  countOneYearAgo: number\n}\n\nexport interface FormHeadlineMetric {\n  type: FormMetricType.HeadlineMetric\n  headlineCounts: Record<string, FormHeadlineDetail>\n  updatedAt: Date\n}\n\nexport interface FormOverviewMetric {\n  type: FormMetricType.OverviewMetric\n  formId: string\n  formStatus: FormStatus\n  summaryMetrics: Record<string, number | string | string[]>\n  featureCounts: Record<string, number>\n  submissionsCount: number\n  updatedAt: Date\n}\n\nexport interface FormTimelineMetric {\n  type: FormMetricType.TimelineMetric\n  formId: string\n  formStatus: FormStatus\n  metricName: string\n  metricValue: number\n  createdAt: Date\n}\n\nexport type FormMetric =\n  | FormHeadlineMetric\n  | FormOverviewMetric\n  | FormTimelineMetric\n"],"mappings":"","ignoreList":[]}

package/dist/module/index.js

@@ -10,6 +10,8 @@ export * from "./form/form-definition/index.js";
 export * from "./form/form-definition/types.js";
 export * from "./form/form-definition/helpers.js";
 export * from "./form/form-metadata/index.js";
+export * from "./form/form-metrics/enums.js";
+export * from "./form/form-metrics/types.js";
 export * from "./form/form-submission/index.js";
 export * from "./form/form-submission/enums.js";
 export * from "./form/utils/index.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-definition/helpers.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/form-submission/enums.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/dead-letter-queues.js'\nexport * from '~/src/manage/roles.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\nexport * from '~/src/form/form-audit/consolidation.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-definition/helpers.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-metrics/enums.js'\nexport * from '~/src/form/form-metrics/types.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/form-submission/enums.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/dead-letter-queues.js'\nexport * from '~/src/manage/roles.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\nexport * from '~/src/form/form-audit/consolidation.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/module/pages/helpers.js

@@ -86,6 +86,38 @@ export function onlyDeclarationComponents(components) {
 export function includesPaymentField(components) {
   return components.some(component => component.type === ComponentType.PaymentField);
 }
+
+/**
+ * Helper function to determine if a payment question already exists in the form
+ */
+export function hasPaymentQuestionInForm(definition) {
+  if (definition.pages.length === 0) {
+    return false;
+  }
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page) ? includesPaymentField(page.components) : false;
+    if (hasPayment) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Helper function to determine if a specific question type exists in the form
+ */
+export function hasSpecificQuestionTypeInForm(definition, componentType) {
+  if (definition.pages.length === 0) {
+    return false;
+  }
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page) ? page.components.some(component => component.type === componentType) : false;
+    if (hasPayment) {
+      return true;
+    }
+  }
+  return false;
+}
 const SHOW_REPEATER_CONTROLLERS = [ControllerType.Page, ControllerType.Repeat];
 export function showRepeaterSettings(page) {
   if (page.controller && !SHOW_REPEATER_CONTROLLERS.includes(page.controller)) {
@@ -143,11 +175,15 @@ export function isSummaryPage(page) {
  * @returns {FormDefinition}
  */
 export function replaceCustomControllers(definition) {
-  const standardControllers = new Set(Object.values(ControllerType).filter(x => x !== ControllerType.SummaryWithConfirmationEmail).map(x => x.toString()));
+  const standardControllers = new Set(Object.values(ControllerType).filter(x => x !== ControllerType.SummaryWithConfirmationEmail)
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
+  .map(x => x.toString()));
   return {
     ...definition,
     pages: definition.pages.map(page => {
-      if (!standardControllers.has((page.controller ?? ControllerType.Page).toString())) {
+      if (!standardControllers.has(
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
+      (page.controller ?? ControllerType.Page).toString())) {
         return /** @type {Page} */{
           ...page,
           controller: ControllerType.Page

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","SHOW_REPEATER_CONTROLLERS","showRepeaterSettings","getPageTitle","title","firstComp","getPageFromDefinition","definition","pageId","pages","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\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      .map((x) => x.toString())\n  )\n\n  return {\n    ...definition,\n    pages: definition.pages.map((page) => {\n      if (\n        !standardControllers.has(\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,MAAMC,yBAAyB,GAAG,CAAC7C,cAAc,CAACM,IAAI,EAAEN,cAAc,CAACuB,MAAM,CAAC;AAE9E,OAAO,SAASuB,oBAAoBA,CAAC3C,IAAU,EAAW;EACxD,IAAIA,IAAI,CAACE,UAAU,IAAI,CAACwC,yBAAyB,CAAClB,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,SAAS8B,YAAYA,CAAC5C,IAAU,EAAE;EACvC,IAAIA,IAAI,CAAC6C,KAAK,KAAK,EAAE,EAAE;IACrB,OAAO7C,IAAI,CAAC6C,KAAK;EACnB;EAEA,IAAI9B,yBAAyB,CAACf,IAAI,CAAC,EAAE;IACnC,MAAM8C,SAAS,GAAG9C,IAAI,CAACc,UAAU,CAACR,IAAI,CAACb,YAAY,CAAC;IACpD,IAAIqD,SAAS,EAAE;MACb,OAAOA,SAAS,CAACD,KAAK;IACxB;EACF;EACA,OAAO,oBAAoB;AAC7B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,qBAAqBA,CACnCC,UAA0B,EAC1BC,MAAc,EACI;EAClB,OAAOD,UAAU,CAACE,KAAK,CAAC5C,IAAI,CAAE6C,CAAC,IAAKA,CAAC,CAACC,EAAE,KAAKH,MAAM,CAAC;AACtD;AAEA,OAAO,MAAMI,sBAAsB,GAAG,CACpCxD,cAAc,CAACyD,OAAO,EACtBzD,cAAc,CAAC0D,4BAA4B,CAC5C;AAED,OAAO,SAASC,aAAaA,CAACxD,IAAsB,EAAE;EACpD,OAAOqD,sBAAsB,CAAC7B,QAAQ,CACpCxB,IAAI,EAAEE,UAAU,IAAIL,cAAc,CAACM,IACrC,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASsD,wBAAwBA,CAACT,UAA0B,EAAE;EACnE,MAAMU,mBAAmB,GAAG,IAAIC,GAAG,CACjCC,MAAM,CAACC,MAAM,CAAChE,cAAc,CAAC,CAC1BuC,MAAM,CAAEe,CAAC,IAAKA,CAAC,KAAKtD,cAAc,CAAC0D,4BAA4B,CAAC,CAChEjC,GAAG,CAAE6B,CAAC,IAAKA,CAAC,CAACW,QAAQ,CAAC,CAAC,CAC5B,CAAC;EAED,OAAO;IACL,GAAGd,UAAU;IACbE,KAAK,EAAEF,UAAU,CAACE,KAAK,CAAC5B,GAAG,CAAEtB,IAAI,IAAK;MACpC,IACE,CAAC0D,mBAAmB,CAACK,GAAG,CACtB,CAAC/D,IAAI,CAACE,UAAU,IAAIL,cAAc,CAACM,IAAI,EAAE2D,QAAQ,CAAC,CACpD,CAAC,EACD;QACA,OAAO,mBAAoB;UACzB,GAAG9D,IAAI;UACPE,UAAU,EAAEL,cAAc,CAACM;QAC7B,CAAC;MACH;MACA,OAAOH,IAAI;IACb,CAAC;EACH,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASgE,aAAaA,CAAChE,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,SAASwB,SAASA,CAACjE,IAAsB,EAAE;EAChD,OAAOwD,aAAa,CAACxD,IAAI,CAAC,IAAIgE,aAAa,CAAChE,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","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":[]}

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, hasRepeater, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from "./helpers.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 { 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","hasRepeater","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  hasRepeater,\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,WAAW,EACXC,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","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":[]}

package/dist/types/form/form-metrics/enums.d.ts

@@ -0,0 +1,6 @@
+export declare enum FormMetricType {
+    HeadlineMetric = "headline-metric",
+    OverviewMetric = "overview-metric",
+    TimelineMetric = "timeline-metric"
+}
+//# sourceMappingURL=enums.d.ts.map

package/dist/types/form/form-metrics/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;CACnC"}

package/dist/types/form/form-metrics/types.d.ts

@@ -0,0 +1,32 @@
+import { type FormStatus } from '../../common/enums.js';
+import { type FormMetricType } from '../../form/form-metrics/enums.js';
+export interface FormHeadlineDetail {
+    count: number;
+    countSevenDaysAgo: number;
+    countThirtyDaysAgo: number;
+    countOneYearAgo: number;
+}
+export interface FormHeadlineMetric {
+    type: FormMetricType.HeadlineMetric;
+    headlineCounts: Record<string, FormHeadlineDetail>;
+    updatedAt: Date;
+}
+export interface FormOverviewMetric {
+    type: FormMetricType.OverviewMetric;
+    formId: string;
+    formStatus: FormStatus;
+    summaryMetrics: Record<string, number | string | string[]>;
+    featureCounts: Record<string, number>;
+    submissionsCount: number;
+    updatedAt: Date;
+}
+export interface FormTimelineMetric {
+    type: FormMetricType.TimelineMetric;
+    formId: string;
+    formStatus: FormStatus;
+    metricName: string;
+    metricValue: number;
+    createdAt: Date;
+}
+export type FormMetric = FormHeadlineMetric | FormOverviewMetric | FormTimelineMetric;
+//# sourceMappingURL=types.d.ts.map

package/dist/types/form/form-metrics/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kCAAkC,CAAA;AAEtE,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IAClD,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1D,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,UAAU,GAClB,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAA"}

package/dist/types/index.d.ts

@@ -10,6 +10,8 @@ export * from './form/form-definition/index.js';
 export * from './form/form-definition/types.js';
 export * from './form/form-definition/helpers.js';
 export * from './form/form-metadata/index.js';
+export * from './form/form-metrics/enums.js';
+export * from './form/form-metrics/types.js';
 export * from './form/form-submission/index.js';
 export * from './form/form-submission/enums.js';
 export * from './form/utils/index.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,wCAAwC,CAAA;AAEtD,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,kCAAkC,CAAA;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,oCAAoC,CAAA;AAClD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,wCAAwC,CAAA;AAEtD,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}

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

@@ -1,3 +1,4 @@
+import { ComponentType } from '../components/enums.js';
 import { type ComponentDef } from '../components/types.js';
 import { type Link, type Page, type PageFileUpload, type PageQuestion, type PageRepeat } from '../form/form-definition/types.js';
 import { type FormDefinition } from '../index.js';
@@ -44,6 +45,14 @@ export declare function controllerNameFromPath(nameOrPath?: ControllerType | str
 export declare function includesFileUploadField(components: ComponentDef[]): boolean;
 export declare function onlyDeclarationComponents(components: ComponentDef[]): boolean;
 export declare function includesPaymentField(components: ComponentDef[]): boolean;
+/**
+ * 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 a specific question type exists in the form
+ */
+export declare function hasSpecificQuestionTypeInForm(definition: FormDefinition, componentType: ComponentType): boolean;
 export declare function showRepeaterSettings(page: Page): boolean;
 /**
  * Gets page title, or title of first question (if no page title set)

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/pages/helpers.ts"],"names":[],"mappings":"AAEA,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;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,GAsB5D,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,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, hasRepeater, includesFileUploadField, includesPaymentField, isControllerName, isEndPage, isPaymentPage, isSummaryPage, replaceCustomControllers, showRepeaterSettings, summaryPageControllers } from '../pages/helpers.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 { 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,WAAW,EACX,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,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.644",
+  "version": "3.0.645",
   "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/form/form-metrics/enums.ts

@@ -0,0 +1,5 @@
+export enum FormMetricType {
+  HeadlineMetric = 'headline-metric',
+  OverviewMetric = 'overview-metric',
+  TimelineMetric = 'timeline-metric'
+}

package/src/form/form-metrics/types.ts

@@ -0,0 +1,39 @@
+import { type FormStatus } from '~/src/common/enums.js'
+import { type FormMetricType } from '~/src/form/form-metrics/enums.js'
+
+export interface FormHeadlineDetail {
+  count: number
+  countSevenDaysAgo: number
+  countThirtyDaysAgo: number
+  countOneYearAgo: number
+}
+
+export interface FormHeadlineMetric {
+  type: FormMetricType.HeadlineMetric
+  headlineCounts: Record<string, FormHeadlineDetail>
+  updatedAt: Date
+}
+
+export interface FormOverviewMetric {
+  type: FormMetricType.OverviewMetric
+  formId: string
+  formStatus: FormStatus
+  summaryMetrics: Record<string, number | string | string[]>
+  featureCounts: Record<string, number>
+  submissionsCount: number
+  updatedAt: Date
+}
+
+export interface FormTimelineMetric {
+  type: FormMetricType.TimelineMetric
+  formId: string
+  formStatus: FormStatus
+  metricName: string
+  metricValue: number
+  createdAt: Date
+}
+
+export type FormMetric =
+  | FormHeadlineMetric
+  | FormOverviewMetric
+  | FormTimelineMetric

package/src/index.ts

@@ -10,6 +10,8 @@ export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-definition/types.js'
 export * from '~/src/form/form-definition/helpers.js'
 export * from '~/src/form/form-metadata/index.js'
+export * from '~/src/form/form-metrics/enums.js'
+export * from '~/src/form/form-metrics/types.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/form-submission/enums.js'
 export * from '~/src/form/utils/index.js'

package/src/pages/helpers.ts

@@ -135,6 +135,47 @@ export function includesPaymentField(components: ComponentDef[]): boolean {
   )
 }
 
+/**
+ * Helper function to determine if a payment question already exists in the form
+ */
+export function hasPaymentQuestionInForm(definition: FormDefinition) {
+  if (definition.pages.length === 0) {
+    return false
+  }
+
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page)
+      ? includesPaymentField(page.components)
+      : false
+    if (hasPayment) {
+      return true
+    }
+  }
+  return false
+}
+
+/**
+ * Helper function to determine if a specific question type exists in the form
+ */
+export function hasSpecificQuestionTypeInForm(
+  definition: FormDefinition,
+  componentType: ComponentType
+) {
+  if (definition.pages.length === 0) {
+    return false
+  }
+
+  for (const page of definition.pages) {
+    const hasPayment = hasComponents(page)
+      ? page.components.some((component) => component.type === componentType)
+      : false
+    if (hasPayment) {
+      return true
+    }
+  }
+  return false
+}
+
 const SHOW_REPEATER_CONTROLLERS = [ControllerType.Page, ControllerType.Repeat]
 
 export function showRepeaterSettings(page: Page): boolean {
@@ -207,6 +248,7 @@ export function replaceCustomControllers(definition: FormDefinition) {
   const standardControllers = new Set(
     Object.values(ControllerType)
       .filter((x) => x !== ControllerType.SummaryWithConfirmationEmail)
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
       .map((x) => x.toString())
   )
 
@@ -215,6 +257,7 @@ export function replaceCustomControllers(definition: FormDefinition) {
     pages: definition.pages.map((page) => {
       if (
         !standardControllers.has(
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-conversion
           (page.controller ?? ControllerType.Page).toString()
         )
       ) {

package/src/pages/index.ts

@@ -14,7 +14,9 @@ export {
   hasComponentsEvenIfNoNext,
   hasFormComponents,
   hasNext,
+  hasPaymentQuestionInForm,
   hasRepeater,
+  hasSpecificQuestionTypeInForm,
   includesFileUploadField,
   includesPaymentField,
   isControllerName,