@defra/forms-model 3.0.316 → 3.0.317

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

@@ -15,6 +15,26 @@ export const teamEmailSchema = Joi.string().email({
 export const privacyNoticeUrlSchema = Joi.string().uri({
   scheme: ['http', 'https']
 }).trim();
+export const phoneSchema = Joi.string().trim();
+export const emailAddressSchema = Joi.string().email().trim().required();
+export const emailResponseTimeSchema = Joi.string().trim().required();
+export const emailSchema = Joi.object().keys({
+  address: emailAddressSchema,
+  responseTime: emailResponseTimeSchema
+});
+export const onlineUrlSchema = Joi.string().uri({
+  scheme: ['http', 'https']
+}).trim().required();
+export const onlineTextSchema = Joi.string().trim().required();
+export const onlineSchema = Joi.object().keys({
+  url: onlineUrlSchema,
+  text: onlineTextSchema
+});
+export const contactSchema = Joi.object().keys({
+  phone: phoneSchema,
+  email: emailSchema,
+  online: onlineSchema
+});
 export const authoredAtSchema = Joi.date().iso().required();
 export const authorIdSchema = Joi.string().trim().required();
 export const authorDisplayNameSchema = Joi.string().trim().required();
@@ -23,7 +43,8 @@ export const formMetadataInputKeys = {
   organisation: organisationSchema,
   teamName: teamNameSchema,
   teamEmail: teamEmailSchema,
-  privacyNoticeUrl: privacyNoticeUrlSchema
+  privacyNoticeUrl: privacyNoticeUrlSchema,
+  contact: contactSchema
 };
 
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","organisations","idSchema","string","hex","length","required","titleSchema","max","trim","slugSchema","pattern","name","organisationSchema","valid","teamNameSchema","teamEmailSchema","email","tlds","allow","privacyNoticeUrlSchema","uri","scheme","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","privacyNoticeUrl","formMetadataInputSchema","object","keys","formMetadataAuthorSchema","id","displayName","formMetadataStateSchema","createdAt","createdBy","updatedAt","updatedBy","formMetadataSchema","append","slug","draft","live"],"sources":["../../../../src/form/form-metadata/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\n  type FormMetadata,\n  type FormMetadataInput,\n  type FormMetadataState,\n  type FormMetadataAuthor\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().hex().length(24).required()\nexport const titleSchema = Joi.string().max(250).trim().required()\nexport const slugSchema = Joi.string()\n  .pattern(/^[a-z0-9-]+$/, { name: 'letters, numbers and hyphens only' })\n  .required()\n\nexport const organisationSchema = Joi.string()\n  .valid(...organisations)\n  .required()\n\nexport const teamNameSchema = Joi.string().max(100).trim().required()\nexport const teamEmailSchema = Joi.string()\n  .email({ tlds: { allow: ['uk'] } })\n  .trim()\n  .required()\n\nexport const privacyNoticeUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n\nexport const authoredAtSchema = Joi.date().iso().required()\nexport const authorIdSchema = Joi.string().trim().required()\nexport const authorDisplayNameSchema = Joi.string().trim().required()\n\nexport const formMetadataInputKeys = {\n  title: titleSchema,\n  organisation: organisationSchema,\n  teamName: teamNameSchema,\n  teamEmail: teamEmailSchema,\n  privacyNoticeUrl: privacyNoticeUrlSchema\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\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\n/**\n * Joi schema for `FormMetadataState` interface\n * @see {@link FormMetadataState}\n */\nexport const formMetadataStateSchema = Joi.object<FormMetadataState>().keys({\n  createdAt: authoredAtSchema,\n  createdBy: formMetadataAuthorSchema,\n  updatedAt: authoredAtSchema,\n  updatedBy: formMetadataAuthorSchema\n})\n\n/**\n * Joi schema for `FormMetadata` interface\n * @see {@link FormMetadata}\n */\nexport const formMetadataSchema = formMetadataInputSchema.append<FormMetadata>({\n  id: idSchema,\n  slug: slugSchema,\n  draft: formMetadataStateSchema,\n  live: formMetadataStateSchema,\n  createdAt: authoredAtSchema,\n  createdBy: formMetadataAuthorSchema,\n  updatedAt: authoredAtSchema,\n  updatedBy: formMetadataAuthorSchema\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AASrB,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,CAACC,GAAG,CAAC,CAAC,CAACC,MAAM,CAAC,EAAE,CAAC,CAACC,QAAQ,CAAC,CAAC;AAChE,OAAO,MAAMC,WAAW,GAAGP,GAAG,CAACG,MAAM,CAAC,CAAC,CAACK,GAAG,CAAC,GAAG,CAAC,CAACC,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAClE,OAAO,MAAMI,UAAU,GAAGV,GAAG,CAACG,MAAM,CAAC,CAAC,CACnCQ,OAAO,CAAC,cAAc,EAAE;EAAEC,IAAI,EAAE;AAAoC,CAAC,CAAC,CACtEN,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMO,kBAAkB,GAAGb,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3CW,KAAK,CAAC,GAAGb,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMS,cAAc,GAAGf,GAAG,CAACG,MAAM,CAAC,CAAC,CAACK,GAAG,CAAC,GAAG,CAAC,CAACC,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AACrE,OAAO,MAAMU,eAAe,GAAGhB,GAAG,CAACG,MAAM,CAAC,CAAC,CACxCc,KAAK,CAAC;EAAEC,IAAI,EAAE;IAAEC,KAAK,EAAE,CAAC,IAAI;EAAE;AAAE,CAAC,CAAC,CAClCV,IAAI,CAAC,CAAC,CACNH,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMc,sBAAsB,GAAGpB,GAAG,CAACG,MAAM,CAAC,CAAC,CAC/CkB,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDb,IAAI,CAAC,CAAC;AAET,OAAO,MAAMc,gBAAgB,GAAGvB,GAAG,CAACwB,IAAI,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAACnB,QAAQ,CAAC,CAAC;AAC3D,OAAO,MAAMoB,cAAc,GAAG1B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAC5D,OAAO,MAAMqB,uBAAuB,GAAG3B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAErE,OAAO,MAAMsB,qBAAqB,GAAG;EACnCC,KAAK,EAAEtB,WAAW;EAClBuB,YAAY,EAAEjB,kBAAkB;EAChCkB,QAAQ,EAAEhB,cAAc;EACxBiB,SAAS,EAAEhB,eAAe;EAC1BiB,gBAAgB,EAAEb;AACpB,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMc,uBAAuB,GAAGlC,GAAG,CAACmC,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAACR,qBAAqB,CAAC,CAC3BtB,QAAQ,CAAC,CAAC;;AAEb;AACA;AACA;AACA;AACA,OAAO,MAAM+B,wBAAwB,GAAGrC,GAAG,CAACmC,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJE,EAAE,EAAEZ,cAAc;EAClBa,WAAW,EAAEZ;AACf,CAAC,CAAC,CACDrB,QAAQ,CAAC,CAAC;;AAEb;AACA;AACA;AACA;AACA,OAAO,MAAMkC,uBAAuB,GAAGxC,GAAG,CAACmC,MAAM,CAAoB,CAAC,CAACC,IAAI,CAAC;EAC1EK,SAAS,EAAElB,gBAAgB;EAC3BmB,SAAS,EAAEL,wBAAwB;EACnCM,SAAS,EAAEpB,gBAAgB;EAC3BqB,SAAS,EAAEP;AACb,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA,OAAO,MAAMQ,kBAAkB,GAAGX,uBAAuB,CAACY,MAAM,CAAe;EAC7ER,EAAE,EAAEpC,QAAQ;EACZ6C,IAAI,EAAErC,UAAU;EAChBsC,KAAK,EAAER,uBAAuB;EAC9BS,IAAI,EAAET,uBAAuB;EAC7BC,SAAS,EAAElB,gBAAgB;EAC3BmB,SAAS,EAAEL,wBAAwB;EACnCM,SAAS,EAAEpB,gBAAgB;EAC3BqB,SAAS,EAAEP;AACb,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","organisations","idSchema","string","hex","length","required","titleSchema","max","trim","slugSchema","pattern","name","organisationSchema","valid","teamNameSchema","teamEmailSchema","email","tlds","allow","privacyNoticeUrlSchema","uri","scheme","phoneSchema","emailAddressSchema","emailResponseTimeSchema","emailSchema","object","keys","address","responseTime","onlineUrlSchema","onlineTextSchema","onlineSchema","url","text","contactSchema","phone","online","authoredAtSchema","date","iso","authorIdSchema","authorDisplayNameSchema","formMetadataInputKeys","title","organisation","teamName","teamEmail","privacyNoticeUrl","contact","formMetadataInputSchema","formMetadataAuthorSchema","id","displayName","formMetadataStateSchema","createdAt","createdBy","updatedAt","updatedBy","formMetadataSchema","append","slug","draft","live"],"sources":["../../../../src/form/form-metadata/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\n  type FormMetadata,\n  type FormMetadataInput,\n  type FormMetadataState,\n  type FormMetadataAuthor,\n  type FormMetadataContact,\n  type FormMetadataContactOnline,\n  type FormMetadataContactEmail\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().hex().length(24).required()\nexport const titleSchema = Joi.string().max(250).trim().required()\nexport const slugSchema = Joi.string()\n  .pattern(/^[a-z0-9-]+$/, { name: 'letters, numbers and hyphens only' })\n  .required()\n\nexport const organisationSchema = Joi.string()\n  .valid(...organisations)\n  .required()\n\nexport const teamNameSchema = Joi.string().max(100).trim().required()\nexport const teamEmailSchema = Joi.string()\n  .email({ tlds: { allow: ['uk'] } })\n  .trim()\n  .required()\n\nexport const privacyNoticeUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n\nexport const phoneSchema = Joi.string().trim()\n\nexport const emailAddressSchema = Joi.string().email().trim().required()\nexport const emailResponseTimeSchema = Joi.string().trim().required()\nexport const emailSchema = Joi.object<FormMetadataContactEmail>().keys({\n  address: emailAddressSchema,\n  responseTime: emailResponseTimeSchema\n})\n\nexport const onlineUrlSchema = Joi.string()\n  .uri({\n    scheme: ['http', 'https']\n  })\n  .trim()\n  .required()\nexport const onlineTextSchema = Joi.string().trim().required()\nexport const onlineSchema = Joi.object<FormMetadataContactOnline>().keys({\n  url: onlineUrlSchema,\n  text: onlineTextSchema\n})\n\nexport const contactSchema = Joi.object<FormMetadataContact>().keys({\n  phone: phoneSchema,\n  email: emailSchema,\n  online: onlineSchema\n})\n\nexport const authoredAtSchema = Joi.date().iso().required()\nexport const authorIdSchema = Joi.string().trim().required()\nexport const authorDisplayNameSchema = Joi.string().trim().required()\n\nexport const formMetadataInputKeys = {\n  title: titleSchema,\n  organisation: organisationSchema,\n  teamName: teamNameSchema,\n  teamEmail: teamEmailSchema,\n  privacyNoticeUrl: privacyNoticeUrlSchema,\n  contact: contactSchema\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\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\n/**\n * Joi schema for `FormMetadataState` interface\n * @see {@link FormMetadataState}\n */\nexport const formMetadataStateSchema = Joi.object<FormMetadataState>().keys({\n  createdAt: authoredAtSchema,\n  createdBy: formMetadataAuthorSchema,\n  updatedAt: authoredAtSchema,\n  updatedBy: formMetadataAuthorSchema\n})\n\n/**\n * Joi schema for `FormMetadata` interface\n * @see {@link FormMetadata}\n */\nexport const formMetadataSchema = formMetadataInputSchema.append<FormMetadata>({\n  id: idSchema,\n  slug: slugSchema,\n  draft: formMetadataStateSchema,\n  live: formMetadataStateSchema,\n  createdAt: authoredAtSchema,\n  createdBy: formMetadataAuthorSchema,\n  updatedAt: authoredAtSchema,\n  updatedBy: formMetadataAuthorSchema\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAYrB,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,CAACC,GAAG,CAAC,CAAC,CAACC,MAAM,CAAC,EAAE,CAAC,CAACC,QAAQ,CAAC,CAAC;AAChE,OAAO,MAAMC,WAAW,GAAGP,GAAG,CAACG,MAAM,CAAC,CAAC,CAACK,GAAG,CAAC,GAAG,CAAC,CAACC,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAClE,OAAO,MAAMI,UAAU,GAAGV,GAAG,CAACG,MAAM,CAAC,CAAC,CACnCQ,OAAO,CAAC,cAAc,EAAE;EAAEC,IAAI,EAAE;AAAoC,CAAC,CAAC,CACtEN,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMO,kBAAkB,GAAGb,GAAG,CAACG,MAAM,CAAC,CAAC,CAC3CW,KAAK,CAAC,GAAGb,aAAa,CAAC,CACvBK,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMS,cAAc,GAAGf,GAAG,CAACG,MAAM,CAAC,CAAC,CAACK,GAAG,CAAC,GAAG,CAAC,CAACC,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AACrE,OAAO,MAAMU,eAAe,GAAGhB,GAAG,CAACG,MAAM,CAAC,CAAC,CACxCc,KAAK,CAAC;EAAEC,IAAI,EAAE;IAAEC,KAAK,EAAE,CAAC,IAAI;EAAE;AAAE,CAAC,CAAC,CAClCV,IAAI,CAAC,CAAC,CACNH,QAAQ,CAAC,CAAC;AAEb,OAAO,MAAMc,sBAAsB,GAAGpB,GAAG,CAACG,MAAM,CAAC,CAAC,CAC/CkB,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDb,IAAI,CAAC,CAAC;AAET,OAAO,MAAMc,WAAW,GAAGvB,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC;AAE9C,OAAO,MAAMe,kBAAkB,GAAGxB,GAAG,CAACG,MAAM,CAAC,CAAC,CAACc,KAAK,CAAC,CAAC,CAACR,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AACxE,OAAO,MAAMmB,uBAAuB,GAAGzB,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AACrE,OAAO,MAAMoB,WAAW,GAAG1B,GAAG,CAAC2B,MAAM,CAA2B,CAAC,CAACC,IAAI,CAAC;EACrEC,OAAO,EAAEL,kBAAkB;EAC3BM,YAAY,EAAEL;AAChB,CAAC,CAAC;AAEF,OAAO,MAAMM,eAAe,GAAG/B,GAAG,CAACG,MAAM,CAAC,CAAC,CACxCkB,GAAG,CAAC;EACHC,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO;AAC1B,CAAC,CAAC,CACDb,IAAI,CAAC,CAAC,CACNH,QAAQ,CAAC,CAAC;AACb,OAAO,MAAM0B,gBAAgB,GAAGhC,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAC9D,OAAO,MAAM2B,YAAY,GAAGjC,GAAG,CAAC2B,MAAM,CAA4B,CAAC,CAACC,IAAI,CAAC;EACvEM,GAAG,EAAEH,eAAe;EACpBI,IAAI,EAAEH;AACR,CAAC,CAAC;AAEF,OAAO,MAAMI,aAAa,GAAGpC,GAAG,CAAC2B,MAAM,CAAsB,CAAC,CAACC,IAAI,CAAC;EAClES,KAAK,EAAEd,WAAW;EAClBN,KAAK,EAAES,WAAW;EAClBY,MAAM,EAAEL;AACV,CAAC,CAAC;AAEF,OAAO,MAAMM,gBAAgB,GAAGvC,GAAG,CAACwC,IAAI,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAACnC,QAAQ,CAAC,CAAC;AAC3D,OAAO,MAAMoC,cAAc,GAAG1C,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAC5D,OAAO,MAAMqC,uBAAuB,GAAG3C,GAAG,CAACG,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;AAErE,OAAO,MAAMsC,qBAAqB,GAAG;EACnCC,KAAK,EAAEtC,WAAW;EAClBuC,YAAY,EAAEjC,kBAAkB;EAChCkC,QAAQ,EAAEhC,cAAc;EACxBiC,SAAS,EAAEhC,eAAe;EAC1BiC,gBAAgB,EAAE7B,sBAAsB;EACxC8B,OAAO,EAAEd;AACX,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMe,uBAAuB,GAAGnD,GAAG,CAAC2B,MAAM,CAAoB,CAAC,CACnEC,IAAI,CAACgB,qBAAqB,CAAC,CAC3BtC,QAAQ,CAAC,CAAC;;AAEb;AACA;AACA;AACA;AACA,OAAO,MAAM8C,wBAAwB,GAAGpD,GAAG,CAAC2B,MAAM,CAAqB,CAAC,CACrEC,IAAI,CAAC;EACJyB,EAAE,EAAEX,cAAc;EAClBY,WAAW,EAAEX;AACf,CAAC,CAAC,CACDrC,QAAQ,CAAC,CAAC;;AAEb;AACA;AACA;AACA;AACA,OAAO,MAAMiD,uBAAuB,GAAGvD,GAAG,CAAC2B,MAAM,CAAoB,CAAC,CAACC,IAAI,CAAC;EAC1E4B,SAAS,EAAEjB,gBAAgB;EAC3BkB,SAAS,EAAEL,wBAAwB;EACnCM,SAAS,EAAEnB,gBAAgB;EAC3BoB,SAAS,EAAEP;AACb,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA,OAAO,MAAMQ,kBAAkB,GAAGT,uBAAuB,CAACU,MAAM,CAAe;EAC7ER,EAAE,EAAEnD,QAAQ;EACZ4D,IAAI,EAAEpD,UAAU;EAChBqD,KAAK,EAAER,uBAAuB;EAC9BS,IAAI,EAAET,uBAAuB;EAC7BC,SAAS,EAAEjB,gBAAgB;EAC3BkB,SAAS,EAAEL,wBAAwB;EACnCM,SAAS,EAAEnB,gBAAgB;EAC3BoB,SAAS,EAAEP;AACb,CAAC,CAAC","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-metadata/types.ts"],"sourcesContent":["import { formMetadataSchema } from '~/src/form/form-metadata/index.js'\n\n/**\n * Interface for author (createdBy and updatedBy)\n */\nexport interface FormMetadataAuthor {\n  /**\n   * The ID of the user\n   */\n  id: string\n\n  /**\n   * The display name of the user\n   */\n  displayName: string\n}\n\n/**\n * Interface for metadata state (draft & live)\n */\nexport interface FormMetadataState {\n  /**\n   * The date the form state was created\n   */\n  createdAt: Date\n\n  /**\n   * The author who created the state\n   */\n  createdBy: FormMetadataAuthor\n\n  /**\n   * The date the form state was last updated\n   */\n  updatedAt: Date\n\n  /**\n   * The author who last updated the state\n   */\n  updatedBy: FormMetadataAuthor\n}\n\n/**\n * Interface for `formMetadataSchema` Joi schema\n * @see {@link formMetadataSchema}\n */\nexport interface FormMetadata {\n  /**\n   * The id of the form\n   */\n  id: string\n\n  /**\n   * The human-readable slug id of the form\n   */\n  slug: string\n\n  /**\n   * The human-readable title of the form\n   */\n  title: string\n\n  /**\n   * The organisation this form belongs to\n   */\n  organisation: string\n\n  /**\n   * The name of the team who own this form\n   */\n  teamName: string\n\n  /**\n   * The email of the team who own this form\n   */\n  teamEmail: string\n\n  /**\n   * The url of the privacy notice\n   */\n  privacyNoticeUrl?: string\n\n  /**\n   * The draft state of the form\n   */\n  draft?: FormMetadataState\n\n  /**\n   * The live state of the form\n   */\n  live?: FormMetadataState\n\n  /**\n   * The author who created the form\n   */\n  createdBy: FormMetadataState['createdBy']\n\n  /**\n   * The date the form was created\n   */\n  createdAt: FormMetadataState['createdAt']\n\n  /**\n   * The author who last updated the form\n   */\n  updatedBy: FormMetadataState['updatedBy']\n\n  /**\n   * The date the form was last updated\n   */\n  updatedAt: FormMetadataState['updatedAt']\n}\n\nexport type FormByIdInput = Pick<FormMetadata, 'id'>\nexport type FormBySlugInput = Pick<FormMetadata, 'slug'>\nexport type FormMetadataDocument = Omit<FormMetadata, 'id'>\nexport type FormMetadataInput = Pick<\n  FormMetadata,\n  'title' | 'organisation' | 'teamName' | 'teamEmail' | 'privacyNoticeUrl'\n>\n\nexport interface FormResponse {\n  id: FormMetadata['id']\n  slug: FormMetadata['slug']\n  status: string\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-metadata/types.ts"],"sourcesContent":["import { formMetadataSchema } from '~/src/form/form-metadata/index.js'\n\n/**\n * Interface for author (createdBy and updatedBy)\n */\nexport interface FormMetadataAuthor {\n  /**\n   * The ID of the user\n   */\n  id: string\n\n  /**\n   * The display name of the user\n   */\n  displayName: string\n}\n\n/**\n * Interface for metadata state (draft & live)\n */\nexport interface FormMetadataState {\n  /**\n   * The date the form state was created\n   */\n  createdAt: Date\n\n  /**\n   * The author who created the state\n   */\n  createdBy: FormMetadataAuthor\n\n  /**\n   * The date the form state was last updated\n   */\n  updatedAt: Date\n\n  /**\n   * The author who last updated the state\n   */\n  updatedBy: FormMetadataAuthor\n}\n\n/**\n * Interface for email contact details\n */\nexport interface FormMetadataContactEmail {\n  /**\n   * The email address details for support\n   */\n  address: string\n\n  /**\n   * How long it takes to receive a support response\n   */\n  responseTime: string\n}\n\n/**\n * Interface for online contact details\n */\nexport interface FormMetadataContactOnline {\n  /**\n   * The url of the online contact link\n   */\n  url: string\n\n  /**\n   * The text of the online contact link\n   */\n  text: string\n}\n\n/**\n * Interface for contact details (phone, email and online)\n */\nexport interface FormMetadataContact {\n  /**\n   * The phone details for support\n   */\n  phone?: string\n\n  /**\n   * The email details for support\n   */\n  email?: FormMetadataContactEmail\n\n  /**\n   * The online details for support\n   */\n  online?: FormMetadataContactOnline\n}\n\n/**\n * Interface for `formMetadataSchema` Joi schema\n * @see {@link formMetadataSchema}\n */\nexport interface FormMetadata {\n  /**\n   * The id of the form\n   */\n  id: string\n\n  /**\n   * The human-readable slug id of the form\n   */\n  slug: string\n\n  /**\n   * The human-readable title of the form\n   */\n  title: string\n\n  /**\n   * The organisation this form belongs to\n   */\n  organisation: string\n\n  /**\n   * The name of the team who own this form\n   */\n  teamName: string\n\n  /**\n   * The email of the team who own this form\n   */\n  teamEmail: string\n\n  /**\n   * The url of the privacy notice\n   */\n  privacyNoticeUrl?: string\n\n  /**\n   * The contact details of the form\n   */\n  contact?: FormMetadataContact\n\n  /**\n   * The draft state of the form\n   */\n  draft?: FormMetadataState\n\n  /**\n   * The live state of the form\n   */\n  live?: FormMetadataState\n\n  /**\n   * The author who created the form\n   */\n  createdBy: FormMetadataState['createdBy']\n\n  /**\n   * The date the form was created\n   */\n  createdAt: FormMetadataState['createdAt']\n\n  /**\n   * The author who last updated the form\n   */\n  updatedBy: FormMetadataState['updatedBy']\n\n  /**\n   * The date the form was last updated\n   */\n  updatedAt: FormMetadataState['updatedAt']\n}\n\nexport type FormByIdInput = Pick<FormMetadata, 'id'>\nexport type FormBySlugInput = Pick<FormMetadata, 'slug'>\nexport type FormMetadataDocument = Omit<FormMetadata, 'id'>\nexport type FormMetadataInput = Pick<\n  FormMetadata,\n  | 'title'\n  | 'organisation'\n  | 'teamName'\n  | 'teamEmail'\n  | 'privacyNoticeUrl'\n  | 'contact'\n>\n\nexport interface FormResponse {\n  id: FormMetadata['id']\n  slug: FormMetadata['slug']\n  status: string\n}\n"],"mappings":"","ignoreList":[]}

package/dist/types/form/form-metadata/index.d.ts

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type FormMetadata, type FormMetadataInput, type FormMetadataState, type FormMetadataAuthor } from '../../form/form-metadata/types.js';
+import { type FormMetadata, type FormMetadataInput, type FormMetadataState, type FormMetadataAuthor, type FormMetadataContact, type FormMetadataContactOnline, type FormMetadataContactEmail } from '../../form/form-metadata/types.js';
 export declare const organisations: string[];
 export declare const idSchema: Joi.StringSchema<string>;
 export declare const titleSchema: Joi.StringSchema<string>;
@@ -8,6 +8,14 @@ export declare const organisationSchema: Joi.StringSchema<string>;
 export declare const teamNameSchema: Joi.StringSchema<string>;
 export declare const teamEmailSchema: Joi.StringSchema<string>;
 export declare const privacyNoticeUrlSchema: Joi.StringSchema<string>;
+export declare const phoneSchema: Joi.StringSchema<string>;
+export declare const emailAddressSchema: Joi.StringSchema<string>;
+export declare const emailResponseTimeSchema: Joi.StringSchema<string>;
+export declare const emailSchema: Joi.ObjectSchema<FormMetadataContactEmail>;
+export declare const onlineUrlSchema: Joi.StringSchema<string>;
+export declare const onlineTextSchema: Joi.StringSchema<string>;
+export declare const onlineSchema: Joi.ObjectSchema<FormMetadataContactOnline>;
+export declare const contactSchema: Joi.ObjectSchema<FormMetadataContact>;
 export declare const authoredAtSchema: Joi.DateSchema<Date>;
 export declare const authorIdSchema: Joi.StringSchema<string>;
 export declare const authorDisplayNameSchema: Joi.StringSchema<string>;
@@ -17,6 +25,7 @@ export declare const formMetadataInputKeys: {
     teamName: Joi.StringSchema<string>;
     teamEmail: Joi.StringSchema<string>;
     privacyNoticeUrl: Joi.StringSchema<string>;
+    contact: Joi.ObjectSchema<FormMetadataContact>;
 };
 /**
  * Joi schema for `FormMetadataInput` interface

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;AAErB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACxB,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAA2C,CAAA;AAChE,eAAO,MAAM,WAAW,0BAA0C,CAAA;AAClE,eAAO,MAAM,UAAU,0BAEV,CAAA;AAEb,eAAO,MAAM,kBAAkB,0BAElB,CAAA;AAEb,eAAO,MAAM,cAAc,0BAA0C,CAAA;AACrE,eAAO,MAAM,eAAe,0BAGf,CAAA;AAEb,eAAO,MAAM,sBAAsB,0BAI1B,CAAA;AAET,eAAO,MAAM,gBAAgB,sBAA8B,CAAA;AAC3D,eAAO,MAAM,cAAc,0BAAiC,CAAA;AAC5D,eAAO,MAAM,uBAAuB,0BAAiC,CAAA;AAErE,eAAO,MAAM,qBAAqB;;;;;;CAMjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAEvB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAKxB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAKlC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAS7B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC9B,MAAM,mCAAmC,CAAA;AAE1C,eAAO,MAAM,aAAa,UAUzB,CAAA;AAED,eAAO,MAAM,QAAQ,0BAA2C,CAAA;AAChE,eAAO,MAAM,WAAW,0BAA0C,CAAA;AAClE,eAAO,MAAM,UAAU,0BAEV,CAAA;AAEb,eAAO,MAAM,kBAAkB,0BAElB,CAAA;AAEb,eAAO,MAAM,cAAc,0BAA0C,CAAA;AACrE,eAAO,MAAM,eAAe,0BAGf,CAAA;AAEb,eAAO,MAAM,sBAAsB,0BAI1B,CAAA;AAET,eAAO,MAAM,WAAW,0BAAsB,CAAA;AAE9C,eAAO,MAAM,kBAAkB,0BAAyC,CAAA;AACxE,eAAO,MAAM,uBAAuB,0BAAiC,CAAA;AACrE,eAAO,MAAM,WAAW,4CAGtB,CAAA;AAEF,eAAO,MAAM,eAAe,0BAKf,CAAA;AACb,eAAO,MAAM,gBAAgB,0BAAiC,CAAA;AAC9D,eAAO,MAAM,YAAY,6CAGvB,CAAA;AAEF,eAAO,MAAM,aAAa,uCAIxB,CAAA;AAEF,eAAO,MAAM,gBAAgB,sBAA8B,CAAA;AAC3D,eAAO,MAAM,cAAc,0BAAiC,CAAA;AAC5D,eAAO,MAAM,uBAAuB,0BAAiC,CAAA;AAErE,eAAO,MAAM,qBAAqB;;;;;;;CAOjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAEvB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sCAKxB,CAAA;AAEb;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qCAKlC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,gCAS7B,CAAA"}

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

@@ -32,6 +32,49 @@ export interface FormMetadataState {
      */
     updatedBy: FormMetadataAuthor;
 }
+/**
+ * Interface for email contact details
+ */
+export interface FormMetadataContactEmail {
+    /**
+     * The email address details for support
+     */
+    address: string;
+    /**
+     * How long it takes to receive a support response
+     */
+    responseTime: string;
+}
+/**
+ * Interface for online contact details
+ */
+export interface FormMetadataContactOnline {
+    /**
+     * The url of the online contact link
+     */
+    url: string;
+    /**
+     * The text of the online contact link
+     */
+    text: string;
+}
+/**
+ * Interface for contact details (phone, email and online)
+ */
+export interface FormMetadataContact {
+    /**
+     * The phone details for support
+     */
+    phone?: string;
+    /**
+     * The email details for support
+     */
+    email?: FormMetadataContactEmail;
+    /**
+     * The online details for support
+     */
+    online?: FormMetadataContactOnline;
+}
 /**
  * Interface for `formMetadataSchema` Joi schema
  * @see {@link formMetadataSchema}
@@ -65,6 +108,10 @@ export interface FormMetadata {
      * The url of the privacy notice
      */
     privacyNoticeUrl?: string;
+    /**
+     * The contact details of the form
+     */
+    contact?: FormMetadataContact;
     /**
      * The draft state of the form
      */
@@ -93,7 +140,7 @@ export interface FormMetadata {
 export type FormByIdInput = Pick<FormMetadata, 'id'>;
 export type FormBySlugInput = Pick<FormMetadata, 'slug'>;
 export type FormMetadataDocument = Omit<FormMetadata, 'id'>;
-export type FormMetadataInput = Pick<FormMetadata, 'title' | 'organisation' | 'teamName' | 'teamEmail' | 'privacyNoticeUrl'>;
+export type FormMetadataInput = Pick<FormMetadata, 'title' | 'organisation' | 'teamName' | 'teamEmail' | 'privacyNoticeUrl' | 'contact'>;
 export interface FormResponse {
     id: FormMetadata['id'];
     slug: FormMetadata['slug'];

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/types.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,IAAI,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAA;IAE7B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAA;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;CAC1C;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;AACpD,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;AACxD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;AAC3D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,YAAY,EACZ,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,kBAAkB,CACzE,CAAA;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAA;IACtB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metadata/types.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,IAAI,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAA;IAE7B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAA;IAEf;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,CAAA;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,yBAAyB,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;CAC1C;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;AACpD,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;AACxD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;AAC3D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,YAAY,EACV,OAAO,GACP,cAAc,GACd,UAAU,GACV,WAAW,GACX,kBAAkB,GAClB,SAAS,CACZ,CAAA;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAA;IACtB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.316",
+  "version": "3.0.317",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

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

@@ -4,7 +4,10 @@ import {
   type FormMetadata,
   type FormMetadataInput,
   type FormMetadataState,
-  type FormMetadataAuthor
+  type FormMetadataAuthor,
+  type FormMetadataContact,
+  type FormMetadataContactOnline,
+  type FormMetadataContactEmail
 } from '~/src/form/form-metadata/types.js'
 
 export const organisations = [
@@ -41,6 +44,33 @@ export const privacyNoticeUrlSchema = Joi.string()
   })
   .trim()
 
+export const phoneSchema = Joi.string().trim()
+
+export const emailAddressSchema = Joi.string().email().trim().required()
+export const emailResponseTimeSchema = Joi.string().trim().required()
+export const emailSchema = Joi.object<FormMetadataContactEmail>().keys({
+  address: emailAddressSchema,
+  responseTime: emailResponseTimeSchema
+})
+
+export const onlineUrlSchema = Joi.string()
+  .uri({
+    scheme: ['http', 'https']
+  })
+  .trim()
+  .required()
+export const onlineTextSchema = Joi.string().trim().required()
+export const onlineSchema = Joi.object<FormMetadataContactOnline>().keys({
+  url: onlineUrlSchema,
+  text: onlineTextSchema
+})
+
+export const contactSchema = Joi.object<FormMetadataContact>().keys({
+  phone: phoneSchema,
+  email: emailSchema,
+  online: onlineSchema
+})
+
 export const authoredAtSchema = Joi.date().iso().required()
 export const authorIdSchema = Joi.string().trim().required()
 export const authorDisplayNameSchema = Joi.string().trim().required()
@@ -50,7 +80,8 @@ export const formMetadataInputKeys = {
   organisation: organisationSchema,
   teamName: teamNameSchema,
   teamEmail: teamEmailSchema,
-  privacyNoticeUrl: privacyNoticeUrlSchema
+  privacyNoticeUrl: privacyNoticeUrlSchema,
+  contact: contactSchema
 }
 
 /**

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

@@ -40,6 +40,56 @@ export interface FormMetadataState {
   updatedBy: FormMetadataAuthor
 }
 
+/**
+ * Interface for email contact details
+ */
+export interface FormMetadataContactEmail {
+  /**
+   * The email address details for support
+   */
+  address: string
+
+  /**
+   * How long it takes to receive a support response
+   */
+  responseTime: string
+}
+
+/**
+ * Interface for online contact details
+ */
+export interface FormMetadataContactOnline {
+  /**
+   * The url of the online contact link
+   */
+  url: string
+
+  /**
+   * The text of the online contact link
+   */
+  text: string
+}
+
+/**
+ * Interface for contact details (phone, email and online)
+ */
+export interface FormMetadataContact {
+  /**
+   * The phone details for support
+   */
+  phone?: string
+
+  /**
+   * The email details for support
+   */
+  email?: FormMetadataContactEmail
+
+  /**
+   * The online details for support
+   */
+  online?: FormMetadataContactOnline
+}
+
 /**
  * Interface for `formMetadataSchema` Joi schema
  * @see {@link formMetadataSchema}
@@ -80,6 +130,11 @@ export interface FormMetadata {
    */
   privacyNoticeUrl?: string
 
+  /**
+   * The contact details of the form
+   */
+  contact?: FormMetadataContact
+
   /**
    * The draft state of the form
    */
@@ -116,7 +171,12 @@ export type FormBySlugInput = Pick<FormMetadata, 'slug'>
 export type FormMetadataDocument = Omit<FormMetadata, 'id'>
 export type FormMetadataInput = Pick<
   FormMetadata,
-  'title' | 'organisation' | 'teamName' | 'teamEmail' | 'privacyNoticeUrl'
+  | 'title'
+  | 'organisation'
+  | 'teamName'
+  | 'teamEmail'
+  | 'privacyNoticeUrl'
+  | 'contact'
 >
 
 export interface FormResponse {