@defra/forms-model 3.0.625 → 3.0.626

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

@@ -50,7 +50,7 @@ export const formMetadataInputKeys = {
   teamEmail: teamEmailSchema,
   contact: contactSchema,
   submissionGuidance: submissionGuidanceSchema,
-  privacyNoticeType: privacyNoticeTypeSchema.default('link'),
+  privacyNoticeType: privacyNoticeTypeSchema,
   privacyNoticeText: Joi.when('privacyNoticeType', {
     is: 'text',
     then: privacyNoticeTextSchema,

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","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","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","contact","submissionGuidance","privacyNoticeType","default","privacyNoticeText","when","is","then","otherwise","privacyNoticeUrl","termsAndConditionsAgreed","notificationEmail","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 {\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 = Joi.string()\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 = Joi.string()\n  .email()\n  .trim()\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 = Joi.string()\n  .email()\n  .trim()\n  .description('Email address to receive form submission notifications')\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.default('link'),\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}\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;AAarB,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,GAAGF,GAAG,CAACG,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,GAAGR,GAAG,CAACG,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,GAAGX,GAAG,CAACG,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,GAAGd,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3CY,KAAK,CAAC,GAAGd,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,6CAA6C,CAAC;AAE7D,OAAO,MAAMS,cAAc,GAAGhB,GAAG,CAACG,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,GAAG,CAACG,MAAM,CAAC,CAAC,CACxCe,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,GAAGrB,GAAG,CAACG,MAAM,CAAC,CAAC,CACpCO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMe,kBAAkB,GAAGtB,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3Ce,KAAK,CAAC,CAAC,CACPR,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0CAA0C,CAAC;AAE1D,OAAO,MAAMgB,uBAAuB,GAAGvB,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMiB,WAAW,GAAGxB,GAAG,CAACyB,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,GAAG7B,GAAG,CAACG,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,GAAGhC,GAAG,CAACG,MAAM,CAAC,CAAC,CACzCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;AAE9D,OAAO,MAAM0B,YAAY,GAAGjC,GAAG,CAACyB,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,GAAGpC,GAAG,CAACyB,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,GAAGvC,GAAG,CAACG,MAAM,CAAC,CAAC,CACjDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMiC,uBAAuB,GAAGxC,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDY,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CACrBR,WAAW,CAAC,gCAAgC,CAAC;AAEhD,OAAO,MAAMkC,uBAAuB,GAAGzC,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMmC,sBAAsB,GAAG1C,GAAG,CAACG,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,GAAG3C,GAAG,CAAC4C,OAAO,CAAC,CAAC,CAACrC,WAAW,CACrE,sEACF,CAAC;AAED,OAAO,MAAMsC,8BAA8B,GAAG7C,GAAG,CAACG,MAAM,CAAC,CAAC,CACvDe,KAAK,CAAC,CAAC,CACPR,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,wDAAwD,CAAC;AAExE,OAAO,MAAMuC,gBAAgB,GAAG9C,GAAG,CAAC+C,IAAI,CAAC,CAAC,CACvCC,GAAG,CAAC,CAAC,CACL1C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;AAEjE,OAAO,MAAM0C,cAAc,GAAGjD,GAAG,CAACG,MAAM,CAAC,CAAC,CACvCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,kCAAkC,CAAC;AAElD,OAAO,MAAM2C,uBAAuB,GAAGlD,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mCAAmC,CAAC;AAEnD,OAAO,MAAM4C,qBAAqB,GAAG;EACnCC,KAAK,EAAE5C,WAAW;EAClB6C,YAAY,EAAEvC,kBAAkB;EAChCwC,QAAQ,EAAEtC,cAAc;EACxBuC,SAAS,EAAEtC,eAAe;EAC1BuC,OAAO,EAAEpB,aAAa;EACtBqB,kBAAkB,EAAElB,wBAAwB;EAC5CmB,iBAAiB,EAAElB,uBAAuB,CAACmB,OAAO,CAAC,MAAM,CAAC;EAC1DC,iBAAiB,EAAE5D,GAAG,CAAC6D,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,EAAEjE,GAAG,CAAC6D,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;AACrB,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMuB,uBAAuB,GAAGpE,GAAG,CAACyB,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAACyB,qBAAqB,CAAC,CAC3B7C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;;AAEnE;AACA;AACA;AACA;AACA,OAAO,MAAM8D,wBAAwB,GAAGrE,GAAG,CAACyB,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJ4C,EAAE,EAAErB,cAAc;EAClBsB,WAAW,EAAErB;AACf,CAAC,CAAC,CACD5C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;;AAEvE;AACA;AACA;AACA;AACA,OAAO,MAAMiE,uBAAuB,GAAGxE,GAAG,CAACyB,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC;EACJ+C,SAAS,EAAE3B,gBAAgB,CAACvC,WAAW,CACrC,qCACF,CAAC;EACDmE,SAAS,EAAEL,wBAAwB,CAAC9D,WAAW,CAAC,0BAA0B,CAAC;EAC3EoE,SAAS,EAAE7B,gBAAgB,CAACvC,WAAW,CACrC,oCACF,CAAC;EACDqE,SAAS,EAAEP,wBAAwB,CAAC9D,WAAW,CAC7C,+BACF;AACF,CAAC,CAAC,CACDA,WAAW,CAAC,yDAAyD,CAAC;;AAEzE;AACA;AACA;AACA;AACA,OAAO,MAAMsE,yBAAyB,GAAG7E,GAAG,CAACyB,MAAM,CAAsB,CAAC,CACvEC,IAAI,CAAC;EACJoD,aAAa,EAAE9E,GAAG,CAAC+E,MAAM,CAAC,CAAC,CACxBC,OAAO,CAAC,CAAC,CACTC,GAAG,CAAC,CAAC,CAAC,CACN3E,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oBAAoB,CAAC;EACpCkE,SAAS,EAAE3B,gBAAgB,CAACvC,WAAW,CAAC,+BAA+B;AACzE,CAAC,CAAC,CACDA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAM2E,kBAAkB,GAAGd,uBAAuB,CACtDe,MAAM,CAAe;EACpBb,EAAE,EAAEpE,QAAQ;EACZkF,IAAI,EAAEzE,UAAU;EAChB0E,KAAK,EAAEb,uBAAuB,CAACjE,WAAW,CACxC,gCACF,CAAC;EACD+E,IAAI,EAAEd,uBAAuB,CAACjE,WAAW,CACvC,oCACF,CAAC;EACDkE,SAAS,EAAE3B,gBAAgB,CAACvC,WAAW,CAAC,iCAAiC,CAAC;EAC1EmE,SAAS,EAAEL,wBAAwB,CAAC9D,WAAW,CAAC,sBAAsB,CAAC;EACvEoE,SAAS,EAAE7B,gBAAgB,CAACvC,WAAW,CAAC,gCAAgC,CAAC;EACzEqE,SAAS,EAAEP,wBAAwB,CAAC9D,WAAW,CAC7C,2BACF,CAAC;EACDgF,QAAQ,EAAEvF,GAAG,CAACwF,KAAK,CAAC,CAAC,CAClBC,KAAK,CAACZ,yBAAyB,CAAC,CAChCa,QAAQ,CAAC,CAAC,CACVnF,WAAW,CAAC,8BAA8B;AAC/C,CAAC,CAAC,CACDA,WAAW,CACV,mFACF,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","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","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","contact","submissionGuidance","privacyNoticeType","privacyNoticeText","when","is","then","otherwise","privacyNoticeUrl","termsAndConditionsAgreed","notificationEmail","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 {\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 = Joi.string()\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 = Joi.string()\n  .email()\n  .trim()\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 = Joi.string()\n  .email()\n  .trim()\n  .description('Email address to receive form submission notifications')\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}\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;AAarB,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,GAAGF,GAAG,CAACG,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,GAAGR,GAAG,CAACG,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,GAAGX,GAAG,CAACG,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,GAAGd,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3CY,KAAK,CAAC,GAAGd,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,6CAA6C,CAAC;AAE7D,OAAO,MAAMS,cAAc,GAAGhB,GAAG,CAACG,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,GAAG,CAACG,MAAM,CAAC,CAAC,CACxCe,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,GAAGrB,GAAG,CAACG,MAAM,CAAC,CAAC,CACpCO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMe,kBAAkB,GAAGtB,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3Ce,KAAK,CAAC,CAAC,CACPR,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0CAA0C,CAAC;AAE1D,OAAO,MAAMgB,uBAAuB,GAAGvB,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,4CAA4C,CAAC;AAE5D,OAAO,MAAMiB,WAAW,GAAGxB,GAAG,CAACyB,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,GAAG7B,GAAG,CAACG,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,GAAGhC,GAAG,CAACG,MAAM,CAAC,CAAC,CACzCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;AAE9D,OAAO,MAAM0B,YAAY,GAAGjC,GAAG,CAACyB,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,GAAGpC,GAAG,CAACyB,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,GAAGvC,GAAG,CAACG,MAAM,CAAC,CAAC,CACjDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,uDAAuD,CAAC;AAEvE,OAAO,MAAMiC,uBAAuB,GAAGxC,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDY,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CACrBR,WAAW,CAAC,gCAAgC,CAAC;AAEhD,OAAO,MAAMkC,uBAAuB,GAAGzC,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,yCAAyC,CAAC;AAEzD,OAAO,MAAMmC,sBAAsB,GAAG1C,GAAG,CAACG,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,GAAG3C,GAAG,CAAC4C,OAAO,CAAC,CAAC,CAACrC,WAAW,CACrE,sEACF,CAAC;AAED,OAAO,MAAMsC,8BAA8B,GAAG7C,GAAG,CAACG,MAAM,CAAC,CAAC,CACvDe,KAAK,CAAC,CAAC,CACPR,IAAI,CAAC,CAAC,CACNH,WAAW,CAAC,wDAAwD,CAAC;AAExE,OAAO,MAAMuC,gBAAgB,GAAG9C,GAAG,CAAC+C,IAAI,CAAC,CAAC,CACvCC,GAAG,CAAC,CAAC,CACL1C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;AAEjE,OAAO,MAAM0C,cAAc,GAAGjD,GAAG,CAACG,MAAM,CAAC,CAAC,CACvCO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,kCAAkC,CAAC;AAElD,OAAO,MAAM2C,uBAAuB,GAAGlD,GAAG,CAACG,MAAM,CAAC,CAAC,CAChDO,IAAI,CAAC,CAAC,CACNJ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mCAAmC,CAAC;AAEnD,OAAO,MAAM4C,qBAAqB,GAAG;EACnCC,KAAK,EAAE5C,WAAW;EAClB6C,YAAY,EAAEvC,kBAAkB;EAChCwC,QAAQ,EAAEtC,cAAc;EACxBuC,SAAS,EAAEtC,eAAe;EAC1BuC,OAAO,EAAEpB,aAAa;EACtBqB,kBAAkB,EAAElB,wBAAwB;EAC5CmB,iBAAiB,EAAElB,uBAAuB;EAC1CmB,iBAAiB,EAAE3D,GAAG,CAAC4D,IAAI,CAAC,mBAAmB,EAAE;IAC/CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAErB,uBAAuB;IAC7BsB,SAAS,EAAEtB,uBAAuB,CAACrB,KAAK,CAAC,EAAE;EAC7C,CAAC,CAAC;EACF4C,gBAAgB,EAAEhE,GAAG,CAAC4D,IAAI,CAAC,mBAAmB,EAAE;IAC9CC,EAAE,EAAE,MAAM;IACVC,IAAI,EAAEpB,sBAAsB;IAC5BqB,SAAS,EAAErB,sBAAsB,CAACtB,KAAK,CAAC,EAAE;EAC5C,CAAC,CAAC;EACF6C,wBAAwB,EAAEtB,8BAA8B;EACxDuB,iBAAiB,EAAErB;AACrB,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMsB,uBAAuB,GAAGnE,GAAG,CAACyB,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAACyB,qBAAqB,CAAC,CAC3B7C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;;AAEnE;AACA;AACA;AACA;AACA,OAAO,MAAM6D,wBAAwB,GAAGpE,GAAG,CAACyB,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJ2C,EAAE,EAAEpB,cAAc;EAClBqB,WAAW,EAAEpB;AACf,CAAC,CAAC,CACD5C,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;;AAEvE;AACA;AACA;AACA;AACA,OAAO,MAAMgE,uBAAuB,GAAGvE,GAAG,CAACyB,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAAC;EACJ8C,SAAS,EAAE1B,gBAAgB,CAACvC,WAAW,CACrC,qCACF,CAAC;EACDkE,SAAS,EAAEL,wBAAwB,CAAC7D,WAAW,CAAC,0BAA0B,CAAC;EAC3EmE,SAAS,EAAE5B,gBAAgB,CAACvC,WAAW,CACrC,oCACF,CAAC;EACDoE,SAAS,EAAEP,wBAAwB,CAAC7D,WAAW,CAC7C,+BACF;AACF,CAAC,CAAC,CACDA,WAAW,CAAC,yDAAyD,CAAC;;AAEzE;AACA;AACA;AACA;AACA,OAAO,MAAMqE,yBAAyB,GAAG5E,GAAG,CAACyB,MAAM,CAAsB,CAAC,CACvEC,IAAI,CAAC;EACJmD,aAAa,EAAE7E,GAAG,CAAC8E,MAAM,CAAC,CAAC,CACxBC,OAAO,CAAC,CAAC,CACTC,GAAG,CAAC,CAAC,CAAC,CACN1E,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oBAAoB,CAAC;EACpCiE,SAAS,EAAE1B,gBAAgB,CAACvC,WAAW,CAAC,+BAA+B;AACzE,CAAC,CAAC,CACDA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAM0E,kBAAkB,GAAGd,uBAAuB,CACtDe,MAAM,CAAe;EACpBb,EAAE,EAAEnE,QAAQ;EACZiF,IAAI,EAAExE,UAAU;EAChByE,KAAK,EAAEb,uBAAuB,CAAChE,WAAW,CACxC,gCACF,CAAC;EACD8E,IAAI,EAAEd,uBAAuB,CAAChE,WAAW,CACvC,oCACF,CAAC;EACDiE,SAAS,EAAE1B,gBAAgB,CAACvC,WAAW,CAAC,iCAAiC,CAAC;EAC1EkE,SAAS,EAAEL,wBAAwB,CAAC7D,WAAW,CAAC,sBAAsB,CAAC;EACvEmE,SAAS,EAAE5B,gBAAgB,CAACvC,WAAW,CAAC,gCAAgC,CAAC;EACzEoE,SAAS,EAAEP,wBAAwB,CAAC7D,WAAW,CAC7C,2BACF,CAAC;EACD+E,QAAQ,EAAEtF,GAAG,CAACuF,KAAK,CAAC,CAAC,CAClBC,KAAK,CAACZ,yBAAyB,CAAC,CAChCa,QAAQ,CAAC,CAAC,CACVlF,WAAW,CAAC,8BAA8B;AAC/C,CAAC,CAAC,CACDA,WAAW,CACV,mFACF,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.625",
+  "version": "3.0.626",
   "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

@@ -103,7 +103,6 @@
     "privacyNoticeType": {
       "type": "string",
       "description": "Type of privacy notice content",
-      "default": "link",
       "enum": [
         "text",
         "link"

package/schemas/form-metadata-schema.json

@@ -103,7 +103,6 @@
     "privacyNoticeType": {
       "type": "string",
       "description": "Type of privacy notice content",
-      "default": "link",
       "enum": [
         "text",
         "link"

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

@@ -159,7 +159,7 @@ export const formMetadataInputKeys = {
   teamEmail: teamEmailSchema,
   contact: contactSchema,
   submissionGuidance: submissionGuidanceSchema,
-  privacyNoticeType: privacyNoticeTypeSchema.default('link'),
+  privacyNoticeType: privacyNoticeTypeSchema,
   privacyNoticeText: Joi.when('privacyNoticeType', {
     is: 'text',
     then: privacyNoticeTextSchema,