@defra/forms-model 3.0.663 → 3.0.665

package/dist/module/form/form-metadata/index.js

@@ -41,7 +41,7 @@ export const privacyNoticeUrlSchema = Joi.string().uri({
 }).trim().description('URL to the privacy notice for this form');
 export const termsAndConditionsAgreedSchema = Joi.boolean().description('Whether the data protection terms and conditions have been agreed to');
 export const notificationEmailAddressSchema = emailAddressNoUnicodeSchema.description('Email address to receive form submission notifications');
-export const offlineSchema = Joi.boolean().description('Whether the form has been taken offline; runtime renders an unavailable page when true');
+export const offlineSchema = Joi.boolean().optional().default(false).description('Whether the form has been taken offline and is unavailable to new sessions');
 export const authoredAtSchema = Joi.date().iso().required().description('ISO format timestamp of when an action occurred');
 export const authorIdSchema = Joi.string().trim().required().description('Unique identifier for the author');
 export const authorDisplayNameSchema = Joi.string().trim().required().description('Human-readable name of the author');
@@ -110,6 +110,7 @@ export const formVersionMetadataSchema = Joi.object().keys({
 export const formMetadataSchema = formMetadataInputSchema.append({
   id: idSchema,
   slug: slugSchema,
+  offline: offlineSchema,
   draft: formMetadataStateSchema.description('Metadata for the draft version'),
   live: formMetadataStateSchema.description('Metadata for the published version'),
   createdAt: authoredAtSchema.description('When the form was first created'),

package/dist/module/form/form-metadata/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","emailAddressNoUnicodeSchema","organisations","idSchema","string","hex","length","required","description","titleSchema","max","trim","slugSchema","pattern","name","organisationSchema","valid","teamNameSchema","teamEmailSchema","email","tlds","allow","phoneSchema","emailAddressSchema","emailResponseTimeSchema","emailSchema","object","keys","address","responseTime","onlineUrlSchema","uri","scheme","onlineTextSchema","onlineSchema","url","text","contactSchema","phone","online","submissionGuidanceSchema","privacyNoticeTypeSchema","privacyNoticeTextSchema","privacyNoticeUrlSchema","termsAndConditionsAgreedSchema","boolean","notificationEmailAddressSchema","offlineSchema","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","contact","submissionGuidance","privacyNoticeType","privacyNoticeText","when","is","then","otherwise","privacyNoticeUrl","termsAndConditionsAgreed","notificationEmail","offline","formMetadataInputSchema","formMetadataAuthorSchema","id","displayName","formMetadataStateSchema","createdAt","createdBy","updatedAt","updatedBy","formVersionMetadataSchema","versionNumber","number","integer","min","formMetadataSchema","append","slug","draft","live","versions","array","items","optional"],"sources":["../../../../src/form/form-metadata/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { emailAddressNoUnicodeSchema } from '~/src/form/form-editor/index.js'\nimport {\n  type FormMetadata,\n  type FormMetadataAuthor,\n  type FormMetadataContact,\n  type FormMetadataContactEmail,\n  type FormMetadataContactOnline,\n  type FormMetadataInput,\n  type FormMetadataState,\n  type FormVersionMetadata\n} from '~/src/form/form-metadata/types.js'\n\nexport const organisations = [\n  'Animal and Plant Health Agency – APHA',\n  'Centre for Environment, Fisheries and Aquaculture Science – Cefas',\n  'Defra',\n  'Environment Agency',\n  'Forestry Commission',\n  'Marine Management Organisation – MMO',\n  'Natural England',\n  'Rural Payments Agency – RPA',\n  'Veterinary Medicines Directorate – VMD'\n]\n\nexport const idSchema = Joi.string()\n  .hex()\n  .length(24)\n  .required()\n  .description(\n    'Unique identifier for the form, 24-character hexadecimal string'\n  )\n\nexport const titleSchema = Joi.string()\n  .max(250)\n  .trim()\n  .required()\n  .description('Title of the form, displayed to users')\n\nexport const slugSchema = Joi.string()\n  .pattern(/^[a-z0-9-]+$/, { name: 'letters, numbers and hyphens only' })\n  .required()\n  .description('URL-friendly identifier used in form paths')\n\nexport const organisationSchema = Joi.string()\n  .valid(...organisations)\n  .required()\n  .description('Defra organisation responsible for the form')\n\nexport const teamNameSchema = Joi.string()\n  .max(100)\n  .trim()\n  .required()\n  .description('Name of the team responsible for the form')\n\nexport const teamEmailSchema = emailAddressNoUnicodeSchema\n  .email({ tlds: { allow: ['uk'] } })\n  .trim()\n  .required()\n  .description('Contact email for the team responsible for the form')\n\nexport const phoneSchema = Joi.string()\n  .trim()\n  .description('Phone number for form-related inquiries')\n\nexport const emailAddressSchema = emailAddressNoUnicodeSchema\n  .required()\n  .description('Email address for form-related inquiries')\n\nexport const emailResponseTimeSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Expected response time for email inquiries')\n\nexport const emailSchema = Joi.object<FormMetadataContactEmail>()\n  .keys({\n    address: emailAddressSchema,\n    responseTime: emailResponseTimeSchema\n  })\n  .description('Email contact details including response expectations')\n\nexport const onlineUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n  .required()\n  .description('URL for online contact method')\n\nexport const onlineTextSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Descriptive text for the online contact link')\n\nexport const onlineSchema = Joi.object<FormMetadataContactOnline>()\n  .keys({\n    url: onlineUrlSchema,\n    text: onlineTextSchema\n  })\n  .description('Online contact details with URL and descriptive text')\n\nexport const contactSchema = Joi.object<FormMetadataContact>()\n  .keys({\n    phone: phoneSchema,\n    email: emailSchema,\n    online: onlineSchema\n  })\n  .description('Complete contact information for form-related inquiries')\n\nexport const submissionGuidanceSchema = Joi.string()\n  .trim()\n  .description('Guidance text shown to users when submitting the form')\n\nexport const privacyNoticeTypeSchema = Joi.string()\n  .valid('text', 'link')\n  .description('Type of privacy notice content')\n\nexport const privacyNoticeTextSchema = Joi.string()\n  .trim()\n  .description('URL to the privacy notice for this form')\n\nexport const privacyNoticeUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n  .description('URL to the privacy notice for this form')\n\nexport const termsAndConditionsAgreedSchema = Joi.boolean().description(\n  'Whether the data protection terms and conditions have been agreed to'\n)\n\nexport const notificationEmailAddressSchema =\n  emailAddressNoUnicodeSchema.description(\n    'Email address to receive form submission notifications'\n  )\n\nexport const offlineSchema = Joi.boolean().description(\n  'Whether the form has been taken offline; runtime renders an unavailable page when true'\n)\n\nexport const authoredAtSchema = Joi.date()\n  .iso()\n  .required()\n  .description('ISO format timestamp of when an action occurred')\n\nexport const authorIdSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Unique identifier for the author')\n\nexport const authorDisplayNameSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Human-readable name of the author')\n\nexport const formMetadataInputKeys = {\n  title: titleSchema,\n  organisation: organisationSchema,\n  teamName: teamNameSchema,\n  teamEmail: teamEmailSchema,\n  contact: contactSchema,\n  submissionGuidance: submissionGuidanceSchema,\n  privacyNoticeType: privacyNoticeTypeSchema,\n  privacyNoticeText: Joi.when('privacyNoticeType', {\n    is: 'text',\n    then: privacyNoticeTextSchema,\n    otherwise: privacyNoticeTextSchema.allow('')\n  }),\n  privacyNoticeUrl: Joi.when('privacyNoticeType', {\n    is: 'link',\n    then: privacyNoticeUrlSchema,\n    otherwise: privacyNoticeUrlSchema.allow('')\n  }),\n  termsAndConditionsAgreed: termsAndConditionsAgreedSchema,\n  notificationEmail: notificationEmailAddressSchema,\n  offline: offlineSchema\n}\n\n/**\n * Joi schema for `FormMetadataInput` interface\n * @see {@link FormMetadataInput}\n */\nexport const formMetadataInputSchema = Joi.object<FormMetadataInput>()\n  .keys(formMetadataInputKeys)\n  .required()\n  .description('Input data for creating or updating form metadata')\n\n/**\n * Joi schema for `FormMetadataAuthor` interface\n * @see {@link FormMetadataAuthor}\n */\nexport const formMetadataAuthorSchema = Joi.object<FormMetadataAuthor>()\n  .keys({\n    id: authorIdSchema,\n    displayName: authorDisplayNameSchema\n  })\n  .required()\n  .description('Information about the author of a form or form change')\n\n/**\n * Joi schema for `FormMetadataState` interface\n * @see {@link FormMetadataState}\n */\nexport const formMetadataStateSchema = Joi.object<FormMetadataState>()\n  .keys({\n    createdAt: authoredAtSchema.description(\n      'When this version was first created'\n    ),\n    createdBy: formMetadataAuthorSchema.description('Who created this version'),\n    updatedAt: authoredAtSchema.description(\n      'When this version was last updated'\n    ),\n    updatedBy: formMetadataAuthorSchema.description(\n      'Who last updated this version'\n    )\n  })\n  .description('Metadata about a specific version state (draft or live)')\n\n/**\n * Joi schema for `FormVersionMetadata` interface\n * @see {@link FormVersionMetadata}\n */\nexport const formVersionMetadataSchema = Joi.object<FormVersionMetadata>()\n  .keys({\n    versionNumber: Joi.number()\n      .integer()\n      .min(1)\n      .required()\n      .description('The version number'),\n    createdAt: authoredAtSchema.description('When this version was created')\n  })\n  .description('Metadata for a specific version of the form')\n\n/**\n * Joi schema for `FormMetadata` interface\n * @see {@link FormMetadata}\n */\nexport const formMetadataSchema = formMetadataInputSchema\n  .append<FormMetadata>({\n    id: idSchema,\n    slug: slugSchema,\n    draft: formMetadataStateSchema.description(\n      'Metadata for the draft version'\n    ),\n    live: formMetadataStateSchema.description(\n      'Metadata for the published version'\n    ),\n    createdAt: authoredAtSchema.description('When the form was first created'),\n    createdBy: formMetadataAuthorSchema.description('Who created the form'),\n    updatedAt: authoredAtSchema.description('When the form was last updated'),\n    updatedBy: formMetadataAuthorSchema.description(\n      'Who last updated the form'\n    ),\n    versions: Joi.array()\n      .items(formVersionMetadataSchema)\n      .optional()\n      .description('Version history for the form')\n  })\n  .description(\n    'Complete metadata for a form, including version information and authoring details'\n  )\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,2BAA2B;AAYpC,OAAO,MAAMC,aAAa,GAAG,CAC3B,uCAAuC,EACvC,mEAAmE,EACnE,OAAO,EACP,oBAAoB,EACpB,qBAAqB,EACrB,sCAAsC,EACtC,iBAAiB,EACjB,6BAA6B,EAC7B,wCAAwC,CACzC;AAED,OAAO,MAAMC,QAAQ,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CACjCC,GAAG,CAAC,CAAC,CACLC,MAAM,CAAC,EAAE,CAAC,CACVC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,iEACF,CAAC;AAEH,OAAO,MAAMC,WAAW,GAAGT,GAAG,CAACI,MAAM,CAAC,CAAC,CACpCM,GAAG,CAAC,GAAG,CAAC,CACRC,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;AAEvD,OAAO,MAAMI,UAAU,GAAGZ,GAAG,CAACI,MAAM,CAAC,CAAC,CACnCS,OAAO,CAAC,cAAc,EAAE;EAAEC,IAAI,EAAE;AAAoC,CAAC,CAAC,CACtEP,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMO,kBAAkB,GAAGf,GAAG,CAACI,MAAM,CAAC,CAAC,CAC3CY,KAAK,CAAC,GAAGd,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,6CAA6C,CAAC;AAE7D,OAAO,MAAMS,cAAc,GAAGjB,GAAG,CAACI,MAAM,CAAC,CAAC,CACvCM,GAAG,CAAC,GAAG,CAAC,CACRC,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,2CAA2C,CAAC;AAE3D,OAAO,MAAMU,eAAe,GAAGjB,2BAA2B,CACvDkB,KAAK,CAAC;EAAEC,IAAI,EAAE;IAAEC,KAAK,EAAE,CAAC,IAAI;EAAE;AAAE,CAAC,CAAC,CAClCV,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,qDAAqD,CAAC;AAErE,OAAO,MAAMc,WAAW,GAAGtB,GAAG,CAACI,MAAM,CAAC,CAAC,CACpCO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMe,kBAAkB,GAAGtB,2BAA2B,CAC1DM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0CAA0C,CAAC;AAE1D,OAAO,MAAMgB,uBAAuB,GAAGxB,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMiB,WAAW,GAAGzB,GAAG,CAAC0B,MAAM,CAA2B,CAAC,CAC9DC,IAAI,CAAC;EACJC,OAAO,EAAEL,kBAAkB;EAC3BM,YAAY,EAAEL;AAChB,CAAC,CAAC,CACDhB,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMsB,eAAe,GAAG9B,GAAG,CAACI,MAAM,CAAC,CAAC,CACxC2B,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDrB,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+BAA+B,CAAC;AAE/C,OAAO,MAAMyB,gBAAgB,GAAGjC,GAAG,CAACI,MAAM,CAAC,CAAC,CACzCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;AAE9D,OAAO,MAAM0B,YAAY,GAAGlC,GAAG,CAAC0B,MAAM,CAA4B,CAAC,CAChEC,IAAI,CAAC;EACJQ,GAAG,EAAEL,eAAe;EACpBM,IAAI,EAAEH;AACR,CAAC,CAAC,CACDzB,WAAW,CAAC,sDAAsD,CAAC;AAEtE,OAAO,MAAM6B,aAAa,GAAGrC,GAAG,CAAC0B,MAAM,CAAsB,CAAC,CAC3DC,IAAI,CAAC;EACJW,KAAK,EAAEhB,WAAW;EAClBH,KAAK,EAAEM,WAAW;EAClBc,MAAM,EAAEL;AACV,CAAC,CAAC,CACD1B,WAAW,CAAC,yDAAyD,CAAC;AAEzE,OAAO,MAAMgC,wBAAwB,GAAGxC,GAAG,CAACI,MAAM,CAAC,CAAC,CACjDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMiC,uBAAuB,GAAGzC,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDY,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CACrBR,WAAW,CAAC,gCAAgC,CAAC;AAEhD,OAAO,MAAMkC,uBAAuB,GAAG1C,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMmC,sBAAsB,GAAG3C,GAAG,CAACI,MAAM,CAAC,CAAC,CAC/C2B,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDrB,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMoC,8BAA8B,GAAG5C,GAAG,CAAC6C,OAAO,CAAC,CAAC,CAACrC,WAAW,CACrE,sEACF,CAAC;AAED,OAAO,MAAMsC,8BAA8B,GACzC7C,2BAA2B,CAACO,WAAW,CACrC,wDACF,CAAC;AAEH,OAAO,MAAMuC,aAAa,GAAG/C,GAAG,CAAC6C,OAAO,CAAC,CAAC,CAACrC,WAAW,CACpD,wFACF,CAAC;AAED,OAAO,MAAMwC,gBAAgB,GAAGhD,GAAG,CAACiD,IAAI,CAAC,CAAC,CACvCC,GAAG,CAAC,CAAC,CACL3C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;AAEjE,OAAO,MAAM2C,cAAc,GAAGnD,GAAG,CAACI,MAAM,CAAC,CAAC,CACvCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,kCAAkC,CAAC;AAElD,OAAO,MAAM4C,uBAAuB,GAAGpD,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mCAAmC,CAAC;AAEnD,OAAO,MAAM6C,qBAAqB,GAAG;EACnCC,KAAK,EAAE7C,WAAW;EAClB8C,YAAY,EAAExC,kBAAkB;EAChCyC,QAAQ,EAAEvC,cAAc;EACxBwC,SAAS,EAAEvC,eAAe;EAC1BwC,OAAO,EAAErB,aAAa;EACtBsB,kBAAkB,EAAEnB,wBAAwB;EAC5CoB,iBAAiB,EAAEnB,uBAAuB;EAC1CoB,iBAAiB,EAAE7D,GAAG,CAAC8D,IAAI,CAAC,mBAAmB,EAAE;IAC/CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAEtB,uBAAuB;IAC7BuB,SAAS,EAAEvB,uBAAuB,CAACrB,KAAK,CAAC,EAAE;EAC7C,CAAC,CAAC;EACF6C,gBAAgB,EAAElE,GAAG,CAAC8D,IAAI,CAAC,mBAAmB,EAAE;IAC9CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAErB,sBAAsB;IAC5BsB,SAAS,EAAEtB,sBAAsB,CAACtB,KAAK,CAAC,EAAE;EAC5C,CAAC,CAAC;EACF8C,wBAAwB,EAAEvB,8BAA8B;EACxDwB,iBAAiB,EAAEtB,8BAA8B;EACjDuB,OAAO,EAAEtB;AACX,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMuB,uBAAuB,GAAGtE,GAAG,CAAC0B,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC0B,qBAAqB,CAAC,CAC3B9C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;;AAEnE;AACA;AACA;AACA;AACA,OAAO,MAAM+D,wBAAwB,GAAGvE,GAAG,CAAC0B,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJ6C,EAAE,EAAErB,cAAc;EAClBsB,WAAW,EAAErB;AACf,CAAC,CAAC,CACD7C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;;AAEvE;AACA;AACA;AACA;AACA,OAAO,MAAMkE,uBAAuB,GAAG1E,GAAG,CAAC0B,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC;EACJgD,SAAS,EAAE3B,gBAAgB,CAACxC,WAAW,CACrC,qCACF,CAAC;EACDoE,SAAS,EAAEL,wBAAwB,CAAC/D,WAAW,CAAC,0BAA0B,CAAC;EAC3EqE,SAAS,EAAE7B,gBAAgB,CAACxC,WAAW,CACrC,oCACF,CAAC;EACDsE,SAAS,EAAEP,wBAAwB,CAAC/D,WAAW,CAC7C,+BACF;AACF,CAAC,CAAC,CACDA,WAAW,CAAC,yDAAyD,CAAC;;AAEzE;AACA;AACA;AACA;AACA,OAAO,MAAMuE,yBAAyB,GAAG/E,GAAG,CAAC0B,MAAM,CAAsB,CAAC,CACvEC,IAAI,CAAC;EACJqD,aAAa,EAAEhF,GAAG,CAACiF,MAAM,CAAC,CAAC,CACxBC,OAAO,CAAC,CAAC,CACTC,GAAG,CAAC,CAAC,CAAC,CACN5E,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oBAAoB,CAAC;EACpCmE,SAAS,EAAE3B,gBAAgB,CAACxC,WAAW,CAAC,+BAA+B;AACzE,CAAC,CAAC,CACDA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAM4E,kBAAkB,GAAGd,uBAAuB,CACtDe,MAAM,CAAe;EACpBb,EAAE,EAAErE,QAAQ;EACZmF,IAAI,EAAE1E,UAAU;EAChB2E,KAAK,EAAEb,uBAAuB,CAAClE,WAAW,CACxC,gCACF,CAAC;EACDgF,IAAI,EAAEd,uBAAuB,CAAClE,WAAW,CACvC,oCACF,CAAC;EACDmE,SAAS,EAAE3B,gBAAgB,CAACxC,WAAW,CAAC,iCAAiC,CAAC;EAC1EoE,SAAS,EAAEL,wBAAwB,CAAC/D,WAAW,CAAC,sBAAsB,CAAC;EACvEqE,SAAS,EAAE7B,gBAAgB,CAACxC,WAAW,CAAC,gCAAgC,CAAC;EACzEsE,SAAS,EAAEP,wBAAwB,CAAC/D,WAAW,CAC7C,2BACF,CAAC;EACDiF,QAAQ,EAAEzF,GAAG,CAAC0F,KAAK,CAAC,CAAC,CAClBC,KAAK,CAACZ,yBAAyB,CAAC,CAChCa,QAAQ,CAAC,CAAC,CACVpF,WAAW,CAAC,8BAA8B;AAC/C,CAAC,CAAC,CACDA,WAAW,CACV,mFACF,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","emailAddressNoUnicodeSchema","organisations","idSchema","string","hex","length","required","description","titleSchema","max","trim","slugSchema","pattern","name","organisationSchema","valid","teamNameSchema","teamEmailSchema","email","tlds","allow","phoneSchema","emailAddressSchema","emailResponseTimeSchema","emailSchema","object","keys","address","responseTime","onlineUrlSchema","uri","scheme","onlineTextSchema","onlineSchema","url","text","contactSchema","phone","online","submissionGuidanceSchema","privacyNoticeTypeSchema","privacyNoticeTextSchema","privacyNoticeUrlSchema","termsAndConditionsAgreedSchema","boolean","notificationEmailAddressSchema","offlineSchema","optional","default","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","contact","submissionGuidance","privacyNoticeType","privacyNoticeText","when","is","then","otherwise","privacyNoticeUrl","termsAndConditionsAgreed","notificationEmail","offline","formMetadataInputSchema","formMetadataAuthorSchema","id","displayName","formMetadataStateSchema","createdAt","createdBy","updatedAt","updatedBy","formVersionMetadataSchema","versionNumber","number","integer","min","formMetadataSchema","append","slug","draft","live","versions","array","items"],"sources":["../../../../src/form/form-metadata/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { emailAddressNoUnicodeSchema } from '~/src/form/form-editor/index.js'\nimport {\n  type FormMetadata,\n  type FormMetadataAuthor,\n  type FormMetadataContact,\n  type FormMetadataContactEmail,\n  type FormMetadataContactOnline,\n  type FormMetadataInput,\n  type FormMetadataState,\n  type FormVersionMetadata\n} from '~/src/form/form-metadata/types.js'\n\nexport const organisations = [\n  'Animal and Plant Health Agency – APHA',\n  'Centre for Environment, Fisheries and Aquaculture Science – Cefas',\n  'Defra',\n  'Environment Agency',\n  'Forestry Commission',\n  'Marine Management Organisation – MMO',\n  'Natural England',\n  'Rural Payments Agency – RPA',\n  'Veterinary Medicines Directorate – VMD'\n]\n\nexport const idSchema = Joi.string()\n  .hex()\n  .length(24)\n  .required()\n  .description(\n    'Unique identifier for the form, 24-character hexadecimal string'\n  )\n\nexport const titleSchema = Joi.string()\n  .max(250)\n  .trim()\n  .required()\n  .description('Title of the form, displayed to users')\n\nexport const slugSchema = Joi.string()\n  .pattern(/^[a-z0-9-]+$/, { name: 'letters, numbers and hyphens only' })\n  .required()\n  .description('URL-friendly identifier used in form paths')\n\nexport const organisationSchema = Joi.string()\n  .valid(...organisations)\n  .required()\n  .description('Defra organisation responsible for the form')\n\nexport const teamNameSchema = Joi.string()\n  .max(100)\n  .trim()\n  .required()\n  .description('Name of the team responsible for the form')\n\nexport const teamEmailSchema = emailAddressNoUnicodeSchema\n  .email({ tlds: { allow: ['uk'] } })\n  .trim()\n  .required()\n  .description('Contact email for the team responsible for the form')\n\nexport const phoneSchema = Joi.string()\n  .trim()\n  .description('Phone number for form-related inquiries')\n\nexport const emailAddressSchema = emailAddressNoUnicodeSchema\n  .required()\n  .description('Email address for form-related inquiries')\n\nexport const emailResponseTimeSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Expected response time for email inquiries')\n\nexport const emailSchema = Joi.object<FormMetadataContactEmail>()\n  .keys({\n    address: emailAddressSchema,\n    responseTime: emailResponseTimeSchema\n  })\n  .description('Email contact details including response expectations')\n\nexport const onlineUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n  .required()\n  .description('URL for online contact method')\n\nexport const onlineTextSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Descriptive text for the online contact link')\n\nexport const onlineSchema = Joi.object<FormMetadataContactOnline>()\n  .keys({\n    url: onlineUrlSchema,\n    text: onlineTextSchema\n  })\n  .description('Online contact details with URL and descriptive text')\n\nexport const contactSchema = Joi.object<FormMetadataContact>()\n  .keys({\n    phone: phoneSchema,\n    email: emailSchema,\n    online: onlineSchema\n  })\n  .description('Complete contact information for form-related inquiries')\n\nexport const submissionGuidanceSchema = Joi.string()\n  .trim()\n  .description('Guidance text shown to users when submitting the form')\n\nexport const privacyNoticeTypeSchema = Joi.string()\n  .valid('text', 'link')\n  .description('Type of privacy notice content')\n\nexport const privacyNoticeTextSchema = Joi.string()\n  .trim()\n  .description('URL to the privacy notice for this form')\n\nexport const privacyNoticeUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n  .description('URL to the privacy notice for this form')\n\nexport const termsAndConditionsAgreedSchema = Joi.boolean().description(\n  'Whether the data protection terms and conditions have been agreed to'\n)\n\nexport const notificationEmailAddressSchema =\n  emailAddressNoUnicodeSchema.description(\n    'Email address to receive form submission notifications'\n  )\n\nexport const offlineSchema = Joi.boolean()\n  .optional()\n  .default(false)\n  .description(\n    'Whether the form has been taken offline and is unavailable to new sessions'\n  )\n\nexport const authoredAtSchema = Joi.date()\n  .iso()\n  .required()\n  .description('ISO format timestamp of when an action occurred')\n\nexport const authorIdSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Unique identifier for the author')\n\nexport const authorDisplayNameSchema = Joi.string()\n  .trim()\n  .required()\n  .description('Human-readable name of the author')\n\nexport const formMetadataInputKeys = {\n  title: titleSchema,\n  organisation: organisationSchema,\n  teamName: teamNameSchema,\n  teamEmail: teamEmailSchema,\n  contact: contactSchema,\n  submissionGuidance: submissionGuidanceSchema,\n  privacyNoticeType: privacyNoticeTypeSchema,\n  privacyNoticeText: Joi.when('privacyNoticeType', {\n    is: 'text',\n    then: privacyNoticeTextSchema,\n    otherwise: privacyNoticeTextSchema.allow('')\n  }),\n  privacyNoticeUrl: Joi.when('privacyNoticeType', {\n    is: 'link',\n    then: privacyNoticeUrlSchema,\n    otherwise: privacyNoticeUrlSchema.allow('')\n  }),\n  termsAndConditionsAgreed: termsAndConditionsAgreedSchema,\n  notificationEmail: notificationEmailAddressSchema,\n  offline: offlineSchema\n}\n\n/**\n * Joi schema for `FormMetadataInput` interface\n * @see {@link FormMetadataInput}\n */\nexport const formMetadataInputSchema = Joi.object<FormMetadataInput>()\n  .keys(formMetadataInputKeys)\n  .required()\n  .description('Input data for creating or updating form metadata')\n\n/**\n * Joi schema for `FormMetadataAuthor` interface\n * @see {@link FormMetadataAuthor}\n */\nexport const formMetadataAuthorSchema = Joi.object<FormMetadataAuthor>()\n  .keys({\n    id: authorIdSchema,\n    displayName: authorDisplayNameSchema\n  })\n  .required()\n  .description('Information about the author of a form or form change')\n\n/**\n * Joi schema for `FormMetadataState` interface\n * @see {@link FormMetadataState}\n */\nexport const formMetadataStateSchema = Joi.object<FormMetadataState>()\n  .keys({\n    createdAt: authoredAtSchema.description(\n      'When this version was first created'\n    ),\n    createdBy: formMetadataAuthorSchema.description('Who created this version'),\n    updatedAt: authoredAtSchema.description(\n      'When this version was last updated'\n    ),\n    updatedBy: formMetadataAuthorSchema.description(\n      'Who last updated this version'\n    )\n  })\n  .description('Metadata about a specific version state (draft or live)')\n\n/**\n * Joi schema for `FormVersionMetadata` interface\n * @see {@link FormVersionMetadata}\n */\nexport const formVersionMetadataSchema = Joi.object<FormVersionMetadata>()\n  .keys({\n    versionNumber: Joi.number()\n      .integer()\n      .min(1)\n      .required()\n      .description('The version number'),\n    createdAt: authoredAtSchema.description('When this version was created')\n  })\n  .description('Metadata for a specific version of the form')\n\n/**\n * Joi schema for `FormMetadata` interface\n * @see {@link FormMetadata}\n */\nexport const formMetadataSchema = formMetadataInputSchema\n  .append<FormMetadata>({\n    id: idSchema,\n    slug: slugSchema,\n    offline: offlineSchema,\n    draft: formMetadataStateSchema.description(\n      'Metadata for the draft version'\n    ),\n    live: formMetadataStateSchema.description(\n      'Metadata for the published version'\n    ),\n    createdAt: authoredAtSchema.description('When the form was first created'),\n    createdBy: formMetadataAuthorSchema.description('Who created the form'),\n    updatedAt: authoredAtSchema.description('When the form was last updated'),\n    updatedBy: formMetadataAuthorSchema.description(\n      'Who last updated the form'\n    ),\n    versions: Joi.array()\n      .items(formVersionMetadataSchema)\n      .optional()\n      .description('Version history for the form')\n  })\n  .description(\n    'Complete metadata for a form, including version information and authoring details'\n  )\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,2BAA2B;AAYpC,OAAO,MAAMC,aAAa,GAAG,CAC3B,uCAAuC,EACvC,mEAAmE,EACnE,OAAO,EACP,oBAAoB,EACpB,qBAAqB,EACrB,sCAAsC,EACtC,iBAAiB,EACjB,6BAA6B,EAC7B,wCAAwC,CACzC;AAED,OAAO,MAAMC,QAAQ,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CACjCC,GAAG,CAAC,CAAC,CACLC,MAAM,CAAC,EAAE,CAAC,CACVC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,iEACF,CAAC;AAEH,OAAO,MAAMC,WAAW,GAAGT,GAAG,CAACI,MAAM,CAAC,CAAC,CACpCM,GAAG,CAAC,GAAG,CAAC,CACRC,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;AAEvD,OAAO,MAAMI,UAAU,GAAGZ,GAAG,CAACI,MAAM,CAAC,CAAC,CACnCS,OAAO,CAAC,cAAc,EAAE;EAAEC,IAAI,EAAE;AAAoC,CAAC,CAAC,CACtEP,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMO,kBAAkB,GAAGf,GAAG,CAACI,MAAM,CAAC,CAAC,CAC3CY,KAAK,CAAC,GAAGd,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,6CAA6C,CAAC;AAE7D,OAAO,MAAMS,cAAc,GAAGjB,GAAG,CAACI,MAAM,CAAC,CAAC,CACvCM,GAAG,CAAC,GAAG,CAAC,CACRC,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,2CAA2C,CAAC;AAE3D,OAAO,MAAMU,eAAe,GAAGjB,2BAA2B,CACvDkB,KAAK,CAAC;EAAEC,IAAI,EAAE;IAAEC,KAAK,EAAE,CAAC,IAAI;EAAE;AAAE,CAAC,CAAC,CAClCV,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,qDAAqD,CAAC;AAErE,OAAO,MAAMc,WAAW,GAAGtB,GAAG,CAACI,MAAM,CAAC,CAAC,CACpCO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMe,kBAAkB,GAAGtB,2BAA2B,CAC1DM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0CAA0C,CAAC;AAE1D,OAAO,MAAMgB,uBAAuB,GAAGxB,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMiB,WAAW,GAAGzB,GAAG,CAAC0B,MAAM,CAA2B,CAAC,CAC9DC,IAAI,CAAC;EACJC,OAAO,EAAEL,kBAAkB;EAC3BM,YAAY,EAAEL;AAChB,CAAC,CAAC,CACDhB,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMsB,eAAe,GAAG9B,GAAG,CAACI,MAAM,CAAC,CAAC,CACxC2B,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDrB,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+BAA+B,CAAC;AAE/C,OAAO,MAAMyB,gBAAgB,GAAGjC,GAAG,CAACI,MAAM,CAAC,CAAC,CACzCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;AAE9D,OAAO,MAAM0B,YAAY,GAAGlC,GAAG,CAAC0B,MAAM,CAA4B,CAAC,CAChEC,IAAI,CAAC;EACJQ,GAAG,EAAEL,eAAe;EACpBM,IAAI,EAAEH;AACR,CAAC,CAAC,CACDzB,WAAW,CAAC,sDAAsD,CAAC;AAEtE,OAAO,MAAM6B,aAAa,GAAGrC,GAAG,CAAC0B,MAAM,CAAsB,CAAC,CAC3DC,IAAI,CAAC;EACJW,KAAK,EAAEhB,WAAW;EAClBH,KAAK,EAAEM,WAAW;EAClBc,MAAM,EAAEL;AACV,CAAC,CAAC,CACD1B,WAAW,CAAC,yDAAyD,CAAC;AAEzE,OAAO,MAAMgC,wBAAwB,GAAGxC,GAAG,CAACI,MAAM,CAAC,CAAC,CACjDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMiC,uBAAuB,GAAGzC,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDY,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CACrBR,WAAW,CAAC,gCAAgC,CAAC;AAEhD,OAAO,MAAMkC,uBAAuB,GAAG1C,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMmC,sBAAsB,GAAG3C,GAAG,CAACI,MAAM,CAAC,CAAC,CAC/C2B,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDrB,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMoC,8BAA8B,GAAG5C,GAAG,CAAC6C,OAAO,CAAC,CAAC,CAACrC,WAAW,CACrE,sEACF,CAAC;AAED,OAAO,MAAMsC,8BAA8B,GACzC7C,2BAA2B,CAACO,WAAW,CACrC,wDACF,CAAC;AAEH,OAAO,MAAMuC,aAAa,GAAG/C,GAAG,CAAC6C,OAAO,CAAC,CAAC,CACvCG,QAAQ,CAAC,CAAC,CACVC,OAAO,CAAC,KAAK,CAAC,CACdzC,WAAW,CACV,4EACF,CAAC;AAEH,OAAO,MAAM0C,gBAAgB,GAAGlD,GAAG,CAACmD,IAAI,CAAC,CAAC,CACvCC,GAAG,CAAC,CAAC,CACL7C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;AAEjE,OAAO,MAAM6C,cAAc,GAAGrD,GAAG,CAACI,MAAM,CAAC,CAAC,CACvCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,kCAAkC,CAAC;AAElD,OAAO,MAAM8C,uBAAuB,GAAGtD,GAAG,CAACI,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mCAAmC,CAAC;AAEnD,OAAO,MAAM+C,qBAAqB,GAAG;EACnCC,KAAK,EAAE/C,WAAW;EAClBgD,YAAY,EAAE1C,kBAAkB;EAChC2C,QAAQ,EAAEzC,cAAc;EACxB0C,SAAS,EAAEzC,eAAe;EAC1B0C,OAAO,EAAEvB,aAAa;EACtBwB,kBAAkB,EAAErB,wBAAwB;EAC5CsB,iBAAiB,EAAErB,uBAAuB;EAC1CsB,iBAAiB,EAAE/D,GAAG,CAACgE,IAAI,CAAC,mBAAmB,EAAE;IAC/CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAExB,uBAAuB;IAC7ByB,SAAS,EAAEzB,uBAAuB,CAACrB,KAAK,CAAC,EAAE;EAC7C,CAAC,CAAC;EACF+C,gBAAgB,EAAEpE,GAAG,CAACgE,IAAI,CAAC,mBAAmB,EAAE;IAC9CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAEvB,sBAAsB;IAC5BwB,SAAS,EAAExB,sBAAsB,CAACtB,KAAK,CAAC,EAAE;EAC5C,CAAC,CAAC;EACFgD,wBAAwB,EAAEzB,8BAA8B;EACxD0B,iBAAiB,EAAExB,8BAA8B;EACjDyB,OAAO,EAAExB;AACX,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMyB,uBAAuB,GAAGxE,GAAG,CAAC0B,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC4B,qBAAqB,CAAC,CAC3BhD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;;AAEnE;AACA;AACA;AACA;AACA,OAAO,MAAMiE,wBAAwB,GAAGzE,GAAG,CAAC0B,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJ+C,EAAE,EAAErB,cAAc;EAClBsB,WAAW,EAAErB;AACf,CAAC,CAAC,CACD/C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;;AAEvE;AACA;AACA;AACA;AACA,OAAO,MAAMoE,uBAAuB,GAAG5E,GAAG,CAAC0B,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC;EACJkD,SAAS,EAAE3B,gBAAgB,CAAC1C,WAAW,CACrC,qCACF,CAAC;EACDsE,SAAS,EAAEL,wBAAwB,CAACjE,WAAW,CAAC,0BAA0B,CAAC;EAC3EuE,SAAS,EAAE7B,gBAAgB,CAAC1C,WAAW,CACrC,oCACF,CAAC;EACDwE,SAAS,EAAEP,wBAAwB,CAACjE,WAAW,CAC7C,+BACF;AACF,CAAC,CAAC,CACDA,WAAW,CAAC,yDAAyD,CAAC;;AAEzE;AACA;AACA;AACA;AACA,OAAO,MAAMyE,yBAAyB,GAAGjF,GAAG,CAAC0B,MAAM,CAAsB,CAAC,CACvEC,IAAI,CAAC;EACJuD,aAAa,EAAElF,GAAG,CAACmF,MAAM,CAAC,CAAC,CACxBC,OAAO,CAAC,CAAC,CACTC,GAAG,CAAC,CAAC,CAAC,CACN9E,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oBAAoB,CAAC;EACpCqE,SAAS,EAAE3B,gBAAgB,CAAC1C,WAAW,CAAC,+BAA+B;AACzE,CAAC,CAAC,CACDA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAM8E,kBAAkB,GAAGd,uBAAuB,CACtDe,MAAM,CAAe;EACpBb,EAAE,EAAEvE,QAAQ;EACZqF,IAAI,EAAE5E,UAAU;EAChB2D,OAAO,EAAExB,aAAa;EACtB0C,KAAK,EAAEb,uBAAuB,CAACpE,WAAW,CACxC,gCACF,CAAC;EACDkF,IAAI,EAAEd,uBAAuB,CAACpE,WAAW,CACvC,oCACF,CAAC;EACDqE,SAAS,EAAE3B,gBAAgB,CAAC1C,WAAW,CAAC,iCAAiC,CAAC;EAC1EsE,SAAS,EAAEL,wBAAwB,CAACjE,WAAW,CAAC,sBAAsB,CAAC;EACvEuE,SAAS,EAAE7B,gBAAgB,CAAC1C,WAAW,CAAC,gCAAgC,CAAC;EACzEwE,SAAS,EAAEP,wBAAwB,CAACjE,WAAW,CAC7C,2BACF,CAAC;EACDmF,QAAQ,EAAE3F,GAAG,CAAC4F,KAAK,CAAC,CAAC,CAClBC,KAAK,CAACZ,yBAAyB,CAAC,CAChCjC,QAAQ,CAAC,CAAC,CACVxC,WAAW,CAAC,8BAA8B;AAC/C,CAAC,CAAC,CACDA,WAAW,CACV,mFACF,CAAC","ignoreList":[]}

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/form/form-metadata/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAGrB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAMlB,CAAA;AAEH,eAAO,MAAM,WAAW,0BAI+B,CAAA;AAEvD,eAAO,MAAM,UAAU,0BAGqC,CAAA;AAE5D,eAAO,MAAM,kBAAkB,0BAG8B,CAAA;AAE7D,eAAO,MAAM,cAAc,0BAIgC,CAAA;AAE3D,eAAO,MAAM,eAAe,0BAIyC,CAAA;AAErE,eAAO,MAAM,WAAW,0BAEiC,CAAA;AAEzD,eAAO,MAAM,kBAAkB,0BAE2B,CAAA;AAE1D,eAAO,MAAM,uBAAuB,0BAGwB,CAAA;AAE5D,eAAO,MAAM,WAAW,4CAK+C,CAAA;AAEvE,eAAO,MAAM,eAAe,0BAMmB,CAAA;AAE/C,eAAO,MAAM,gBAAgB,0BAGiC,CAAA;AAE9D,eAAO,MAAM,YAAY,6CAK6C,CAAA;AAEtE,eAAO,MAAM,aAAa,uCAM+C,CAAA;AAEzE,eAAO,MAAM,wBAAwB,0BAEkC,CAAA;AAEvE,eAAO,MAAM,uBAAuB,0BAEY,CAAA;AAEhD,eAAO,MAAM,uBAAuB,0BAEqB,CAAA;AAEzD,eAAO,MAAM,sBAAsB,0BAKsB,CAAA;AAEzD,eAAO,MAAM,8BAA8B,4BAE1C,CAAA;AAED,eAAO,MAAM,8BAA8B,0BAGxC,CAAA;AAEH,eAAO,MAAM,aAAa,4BAEzB,CAAA;AAED,eAAO,MAAM,gBAAgB,sBAGoC,CAAA;AAEjE,eAAO,MAAM,cAAc,0BAGuB,CAAA;AAElD,eAAO,MAAM,uBAAuB,0BAGe,CAAA;AAEnD,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;CAqBjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAG+B,CAAA;AAEnE;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAMkC,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAaqC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,uCASuB,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAuB5B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAGrB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAMlB,CAAA;AAEH,eAAO,MAAM,WAAW,0BAI+B,CAAA;AAEvD,eAAO,MAAM,UAAU,0BAGqC,CAAA;AAE5D,eAAO,MAAM,kBAAkB,0BAG8B,CAAA;AAE7D,eAAO,MAAM,cAAc,0BAIgC,CAAA;AAE3D,eAAO,MAAM,eAAe,0BAIyC,CAAA;AAErE,eAAO,MAAM,WAAW,0BAEiC,CAAA;AAEzD,eAAO,MAAM,kBAAkB,0BAE2B,CAAA;AAE1D,eAAO,MAAM,uBAAuB,0BAGwB,CAAA;AAE5D,eAAO,MAAM,WAAW,4CAK+C,CAAA;AAEvE,eAAO,MAAM,eAAe,0BAMmB,CAAA;AAE/C,eAAO,MAAM,gBAAgB,0BAGiC,CAAA;AAE9D,eAAO,MAAM,YAAY,6CAK6C,CAAA;AAEtE,eAAO,MAAM,aAAa,uCAM+C,CAAA;AAEzE,eAAO,MAAM,wBAAwB,0BAEkC,CAAA;AAEvE,eAAO,MAAM,uBAAuB,0BAEY,CAAA;AAEhD,eAAO,MAAM,uBAAuB,0BAEqB,CAAA;AAEzD,eAAO,MAAM,sBAAsB,0BAKsB,CAAA;AAEzD,eAAO,MAAM,8BAA8B,4BAE1C,CAAA;AAED,eAAO,MAAM,8BAA8B,0BAGxC,CAAA;AAEH,eAAO,MAAM,aAAa,4BAKvB,CAAA;AAEH,eAAO,MAAM,gBAAgB,sBAGoC,CAAA;AAEjE,eAAO,MAAM,cAAc,0BAGuB,CAAA;AAElD,eAAO,MAAM,uBAAuB,0BAGe,CAAA;AAEnD,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;CAqBjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAG+B,CAAA;AAEnE;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAMkC,CAAA;AAEvE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAaqC,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,uCASuB,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAwB5B,CAAA"}

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.665",
   "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/schemas/form-metadata-input-schema.json

@@ -180,7 +180,8 @@
     },
     "offline": {
       "type": "boolean",
-      "description": "Whether the form has been taken offline; runtime renders an unavailable page when true",
+      "description": "Whether the form has been taken offline and is unavailable to new sessions",
+      "default": false,
       "title": "Offline"
     }
   },

package/schemas/form-metadata-schema.json

@@ -178,11 +178,6 @@
       "format": "email",
       "title": "Notification Email"
     },
-    "offline": {
-      "type": "boolean",
-      "description": "Whether the form has been taken offline; runtime renders an unavailable page when true",
-      "title": "Offline"
-    },
     "id": {
       "type": "string",
       "description": "Unique identifier for the form, 24-character hexadecimal string",
@@ -194,6 +189,12 @@
       "pattern": "^[a-z0-9-]+$",
       "title": "Slug"
     },
+    "offline": {
+      "type": "boolean",
+      "description": "Whether the form has been taken offline and is unavailable to new sessions",
+      "default": false,
+      "title": "Offline"
+    },
     "draft": {
       "type": "object",
       "description": "Metadata for the draft version",

package/src/form/form-metadata/index.ts

@@ -136,9 +136,12 @@ export const notificationEmailAddressSchema =
     'Email address to receive form submission notifications'
   )
 
-export const offlineSchema = Joi.boolean().description(
-  'Whether the form has been taken offline; runtime renders an unavailable page when true'
-)
+export const offlineSchema = Joi.boolean()
+  .optional()
+  .default(false)
+  .description(
+    'Whether the form has been taken offline and is unavailable to new sessions'
+  )
 
 export const authoredAtSchema = Joi.date()
   .iso()
@@ -241,6 +244,7 @@ export const formMetadataSchema = formMetadataInputSchema
   .append<FormMetadata>({
     id: idSchema,
     slug: slugSchema,
+    offline: offlineSchema,
     draft: formMetadataStateSchema.description(
       'Metadata for the draft version'
     ),

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,