@defra/forms-model 3.0.545 → 3.0.547

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

@@ -1,5 +1,6 @@
 import Joi from 'joi';
 import { FormStatus } from "../../common/enums.js";
+import { slugSchema, titleSchema } from "../form-metadata/index.js";
 import { SecurityQuestionsEnum, SubmissionEventMessageCategory, SubmissionEventMessageSchemaVersion, SubmissionEventMessageSource, SubmissionEventMessageType } from "./enums.js";
 /**
  * Joi schema for `SubmitRecord` interface
@@ -32,16 +33,19 @@ export const formSubmitPayloadSchema = Joi.object().keys({
   repeaters: Joi.array().items(formSubmitRecordsetSchema).required().description('Repeatable section values from the form')
 }).required().description('Complete form submission payload structure with all form data');
 export const saveAndExitMessageData = Joi.object().keys({
-  formId: Joi.string().required(),
+  form: {
+    id: Joi.string().required(),
+    slug: slugSchema,
+    title: titleSchema,
+    status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
+    isPreview: Joi.boolean().required(),
+    baseUrl: Joi.string().required()
+  },
   email: Joi.string().required(),
   security: {
     question: Joi.string().valid(...Object.values(SecurityQuestionsEnum).map(value => value.toString())).required(),
     answer: Joi.string().required()
   },
-  formStatus: {
-    status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
-    isPreview: Joi.boolean().required()
-  },
   state: Joi.object().required()
 });
 export const submissionMessageSchema = Joi.object().keys({

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","FormStatus","SecurityQuestionsEnum","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters","saveAndExitMessageData","formId","email","security","question","valid","Object","values","map","toString","answer","formStatus","status","Draft","Live","isPreview","boolean","state","submissionMessageSchema","schemaVersion","category","source","type","createdAt","date","messageCreatedAt","data"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { FormStatus } from '~/src/common/enums.js'\nimport {\n  SecurityQuestionsEnum,\n  SubmissionEventMessageCategory,\n  SubmissionEventMessageSchemaVersion,\n  SubmissionEventMessageSource,\n  SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  type SaveAndExitMessage,\n  type SaveAndExitMessageData,\n  type SubmitPayload,\n  type SubmitRecord,\n  type SubmitRecordset\n} from '~/src/form/form-submission/types.js'\n\n/**\n * Joi schema for `SubmitRecord` interface\n * @see {@link SubmitRecord}\n */\nexport const formSubmitRecordSchema = Joi.object<SubmitRecord>({\n  name: Joi.string()\n    .required()\n    .description('Field identifier matching the component name'),\n  title: Joi.string()\n    .required()\n    .description('Human-readable label for the field'),\n  value: Joi.string()\n    .required()\n    .allow('')\n    .description('User-submitted value for the field, may be empty')\n}).description('Individual field value in a form submission')\n\n/**\n * Joi schema for `SubmitRecordset` interface\n * @see {@link SubmitRecordset}\n */\nexport const formSubmitRecordsetSchema = Joi.object<SubmitRecordset>({\n  name: Joi.string()\n    .required()\n    .description('Identifier for the repeatable section'),\n  title: Joi.string()\n    .required()\n    .description('Human-readable title for the repeatable section'),\n  value: Joi.array<SubmitRecord[]>()\n    .items(Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required())\n    .required()\n    .description(\n      'Array of record arrays, each representing a repeated instance'\n    )\n}).description('Collection of repeated field values from a repeatable section')\n\n/**\n * Joi schema for `SubmitPayload` interface\n * @see {@link SubmitPayload}\n */\nexport const formSubmitPayloadSchema = Joi.object<SubmitPayload>()\n  .keys({\n    retrievalKey: Joi.string()\n      .required()\n      .description('Unique key to retrieve this submission later'),\n    sessionId: Joi.string()\n      .required()\n      .description('User session identifier for tracking and security'),\n    main: Joi.array<SubmitRecord>()\n      .items(formSubmitRecordSchema)\n      .required()\n      .description('Main (non-repeating) field values from the form'),\n    repeaters: Joi.array<SubmitRecordset>()\n      .items(formSubmitRecordsetSchema)\n      .required()\n      .description('Repeatable section values from the form')\n  })\n  .required()\n  .description('Complete form submission payload structure with all form data')\n\nexport const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(\n  {\n    formId: Joi.string().required(),\n    email: Joi.string().required(),\n    security: {\n      question: Joi.string()\n        .valid(\n          ...Object.values(SecurityQuestionsEnum).map((value) =>\n            value.toString()\n          )\n        )\n        .required(),\n      answer: Joi.string().required()\n    },\n    formStatus: {\n      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n      isPreview: Joi.boolean().required()\n    },\n    state: Joi.object().required()\n  }\n)\n\nexport const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({\n  schemaVersion: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageSchemaVersion))\n    .required()\n    .description(\n      'The version of the SubmissionMessage - bumped with breaking changes'\n    ),\n  category: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageCategory))\n    .required()\n    .description('The message category - what does the entityId represent?'),\n  source: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageSource))\n    .required()\n    .description('Source of the message - which service?'),\n  type: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageType))\n    .description('Event type'),\n  createdAt: Joi.date()\n    .required()\n    .description(\n      'The ISO timestamp where the action took place - should be the same as updated_at field in DB'\n    ),\n  messageCreatedAt: Joi.date()\n    .required()\n    .description('ISO timestamp when the message was published'),\n  data: saveAndExitMessageData\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AACnB,SACEC,qBAAqB,EACrBC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAU5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGP,GAAG,CAACQ,MAAM,CAAe;EAC7DC,IAAI,EAAET,GAAG,CAACU,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEb,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEd,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVI,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,kDAAkD;AACnE,CAAC,CAAC,CAACA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAMI,yBAAyB,GAAGhB,GAAG,CAACQ,MAAM,CAAkB;EACnEC,IAAI,EAAET,GAAG,CAACU,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEb,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEd,GAAG,CAACiB,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAAClB,GAAG,CAACiB,KAAK,CAAe,CAAC,CAACC,KAAK,CAACX,sBAAsB,CAAC,CAACI,QAAQ,CAAC,CAAC,CAAC,CACzEA,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,+DACF;AACJ,CAAC,CAAC,CAACA,WAAW,CAAC,+DAA+D,CAAC;;AAE/E;AACA;AACA;AACA;AACA,OAAO,MAAMO,uBAAuB,GAAGnB,GAAG,CAACQ,MAAM,CAAgB,CAAC,CAC/DY,IAAI,CAAC;EACJC,YAAY,EAAErB,GAAG,CAACU,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DU,SAAS,EAAEtB,GAAG,CAACU,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEW,IAAI,EAAEvB,GAAG,CAACiB,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACX,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEY,SAAS,EAAExB,GAAG,CAACiB,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCL,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,yCAAyC;AAC1D,CAAC,CAAC,CACDD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+DAA+D,CAAC;AAE/E,OAAO,MAAMa,sBAAsB,GAAGzB,GAAG,CAACQ,MAAM,CAAyB,CAAC,CAACY,IAAI,CAC7E;EACEM,MAAM,EAAE1B,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BgB,KAAK,EAAE3B,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BiB,QAAQ,EAAE;IACRC,QAAQ,EAAE7B,GAAG,CAACU,MAAM,CAAC,CAAC,CACnBoB,KAAK,CACJ,GAAGC,MAAM,CAACC,MAAM,CAAC9B,qBAAqB,CAAC,CAAC+B,GAAG,CAAEnB,KAAK,IAChDA,KAAK,CAACoB,QAAQ,CAAC,CACjB,CACF,CAAC,CACAvB,QAAQ,CAAC,CAAC;IACbwB,MAAM,EAAEnC,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC;EACDyB,UAAU,EAAE;IACVC,MAAM,EAAErC,GAAG,CAACU,MAAM,CAAC,CAAC,CAACoB,KAAK,CAAC7B,UAAU,CAACqC,KAAK,EAAErC,UAAU,CAACsC,IAAI,CAAC,CAAC5B,QAAQ,CAAC,CAAC;IACxE6B,SAAS,EAAExC,GAAG,CAACyC,OAAO,CAAC,CAAC,CAAC9B,QAAQ,CAAC;EACpC,CAAC;EACD+B,KAAK,EAAE1C,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC;AAC/B,CACF,CAAC;AAED,OAAO,MAAMgC,uBAAuB,GAAG3C,GAAG,CAACQ,MAAM,CAAqB,CAAC,CAACY,IAAI,CAAC;EAC3EwB,aAAa,EAAE5C,GAAG,CAACU,MAAM,CAAC,CAAC,CACxBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC5B,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHiC,QAAQ,EAAE7C,GAAG,CAACU,MAAM,CAAC,CAAC,CACnBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC7B,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1EkC,MAAM,EAAE9C,GAAG,CAACU,MAAM,CAAC,CAAC,CACjBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC3B,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxDmC,IAAI,EAAE/C,GAAG,CAACU,MAAM,CAAC,CAAC,CACfoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC1B,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BoC,SAAS,EAAEhD,GAAG,CAACiD,IAAI,CAAC,CAAC,CAClBtC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHsC,gBAAgB,EAAElD,GAAG,CAACiD,IAAI,CAAC,CAAC,CACzBtC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DuC,IAAI,EAAE1B;AACR,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","FormStatus","slugSchema","titleSchema","SecurityQuestionsEnum","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters","saveAndExitMessageData","form","id","slug","status","valid","Draft","Live","isPreview","boolean","baseUrl","email","security","question","Object","values","map","toString","answer","state","submissionMessageSchema","schemaVersion","category","source","type","createdAt","date","messageCreatedAt","data"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { FormStatus } from '~/src/common/enums.js'\nimport { slugSchema, titleSchema } from '~/src/form/form-metadata/index.js'\nimport {\n  SecurityQuestionsEnum,\n  SubmissionEventMessageCategory,\n  SubmissionEventMessageSchemaVersion,\n  SubmissionEventMessageSource,\n  SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  type SaveAndExitMessage,\n  type SaveAndExitMessageData,\n  type SubmitPayload,\n  type SubmitRecord,\n  type SubmitRecordset\n} from '~/src/form/form-submission/types.js'\n\n/**\n * Joi schema for `SubmitRecord` interface\n * @see {@link SubmitRecord}\n */\nexport const formSubmitRecordSchema = Joi.object<SubmitRecord>({\n  name: Joi.string()\n    .required()\n    .description('Field identifier matching the component name'),\n  title: Joi.string()\n    .required()\n    .description('Human-readable label for the field'),\n  value: Joi.string()\n    .required()\n    .allow('')\n    .description('User-submitted value for the field, may be empty')\n}).description('Individual field value in a form submission')\n\n/**\n * Joi schema for `SubmitRecordset` interface\n * @see {@link SubmitRecordset}\n */\nexport const formSubmitRecordsetSchema = Joi.object<SubmitRecordset>({\n  name: Joi.string()\n    .required()\n    .description('Identifier for the repeatable section'),\n  title: Joi.string()\n    .required()\n    .description('Human-readable title for the repeatable section'),\n  value: Joi.array<SubmitRecord[]>()\n    .items(Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required())\n    .required()\n    .description(\n      'Array of record arrays, each representing a repeated instance'\n    )\n}).description('Collection of repeated field values from a repeatable section')\n\n/**\n * Joi schema for `SubmitPayload` interface\n * @see {@link SubmitPayload}\n */\nexport const formSubmitPayloadSchema = Joi.object<SubmitPayload>()\n  .keys({\n    retrievalKey: Joi.string()\n      .required()\n      .description('Unique key to retrieve this submission later'),\n    sessionId: Joi.string()\n      .required()\n      .description('User session identifier for tracking and security'),\n    main: Joi.array<SubmitRecord>()\n      .items(formSubmitRecordSchema)\n      .required()\n      .description('Main (non-repeating) field values from the form'),\n    repeaters: Joi.array<SubmitRecordset>()\n      .items(formSubmitRecordsetSchema)\n      .required()\n      .description('Repeatable section values from the form')\n  })\n  .required()\n  .description('Complete form submission payload structure with all form data')\n\nexport const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(\n  {\n    form: {\n      id: Joi.string().required(),\n      slug: slugSchema,\n      title: titleSchema,\n      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n      isPreview: Joi.boolean().required(),\n      baseUrl: Joi.string().required()\n    },\n    email: Joi.string().required(),\n    security: {\n      question: Joi.string()\n        .valid(\n          ...Object.values(SecurityQuestionsEnum).map((value) =>\n            value.toString()\n          )\n        )\n        .required(),\n      answer: Joi.string().required()\n    },\n    state: Joi.object().required()\n  }\n)\n\nexport const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({\n  schemaVersion: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageSchemaVersion))\n    .required()\n    .description(\n      'The version of the SubmissionMessage - bumped with breaking changes'\n    ),\n  category: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageCategory))\n    .required()\n    .description('The message category - what does the entityId represent?'),\n  source: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageSource))\n    .required()\n    .description('Source of the message - which service?'),\n  type: Joi.string()\n    .valid(...Object.values(SubmissionEventMessageType))\n    .description('Event type'),\n  createdAt: Joi.date()\n    .required()\n    .description(\n      'The ISO timestamp where the action took place - should be the same as updated_at field in DB'\n    ),\n  messageCreatedAt: Joi.date()\n    .required()\n    .description('ISO timestamp when the message was published'),\n  data: saveAndExitMessageData\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AACnB,SAASC,UAAU,EAAEC,WAAW;AAChC,SACEC,qBAAqB,EACrBC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAU5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGT,GAAG,CAACU,MAAM,CAAe;EAC7DC,IAAI,EAAEX,GAAG,CAACY,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEf,GAAG,CAACY,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEhB,GAAG,CAACY,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVI,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,kDAAkD;AACnE,CAAC,CAAC,CAACA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAMI,yBAAyB,GAAGlB,GAAG,CAACU,MAAM,CAAkB;EACnEC,IAAI,EAAEX,GAAG,CAACY,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEf,GAAG,CAACY,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEhB,GAAG,CAACmB,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAACpB,GAAG,CAACmB,KAAK,CAAe,CAAC,CAACC,KAAK,CAACX,sBAAsB,CAAC,CAACI,QAAQ,CAAC,CAAC,CAAC,CACzEA,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,+DACF;AACJ,CAAC,CAAC,CAACA,WAAW,CAAC,+DAA+D,CAAC;;AAE/E;AACA;AACA;AACA;AACA,OAAO,MAAMO,uBAAuB,GAAGrB,GAAG,CAACU,MAAM,CAAgB,CAAC,CAC/DY,IAAI,CAAC;EACJC,YAAY,EAAEvB,GAAG,CAACY,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DU,SAAS,EAAExB,GAAG,CAACY,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEW,IAAI,EAAEzB,GAAG,CAACmB,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACX,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEY,SAAS,EAAE1B,GAAG,CAACmB,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCL,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,yCAAyC;AAC1D,CAAC,CAAC,CACDD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+DAA+D,CAAC;AAE/E,OAAO,MAAMa,sBAAsB,GAAG3B,GAAG,CAACU,MAAM,CAAyB,CAAC,CAACY,IAAI,CAC7E;EACEM,IAAI,EAAE;IACJC,EAAE,EAAE7B,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC3BiB,IAAI,EAAE5B,UAAU;IAChBa,KAAK,EAAEZ,WAAW;IAClB4B,MAAM,EAAE/B,GAAG,CAACY,MAAM,CAAC,CAAC,CAACoB,KAAK,CAAC/B,UAAU,CAACgC,KAAK,EAAEhC,UAAU,CAACiC,IAAI,CAAC,CAACrB,QAAQ,CAAC,CAAC;IACxEsB,SAAS,EAAEnC,GAAG,CAACoC,OAAO,CAAC,CAAC,CAACvB,QAAQ,CAAC,CAAC;IACnCwB,OAAO,EAAErC,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EACjC,CAAC;EACDyB,KAAK,EAAEtC,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9B0B,QAAQ,EAAE;IACRC,QAAQ,EAAExC,GAAG,CAACY,MAAM,CAAC,CAAC,CACnBoB,KAAK,CACJ,GAAGS,MAAM,CAACC,MAAM,CAACtC,qBAAqB,CAAC,CAACuC,GAAG,CAAE3B,KAAK,IAChDA,KAAK,CAAC4B,QAAQ,CAAC,CACjB,CACF,CAAC,CACA/B,QAAQ,CAAC,CAAC;IACbgC,MAAM,EAAE7C,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC;EACDiC,KAAK,EAAE9C,GAAG,CAACU,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC;AAC/B,CACF,CAAC;AAED,OAAO,MAAMkC,uBAAuB,GAAG/C,GAAG,CAACU,MAAM,CAAqB,CAAC,CAACY,IAAI,CAAC;EAC3E0B,aAAa,EAAEhD,GAAG,CAACY,MAAM,CAAC,CAAC,CACxBoB,KAAK,CAAC,GAAGS,MAAM,CAACC,MAAM,CAACpC,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHmC,QAAQ,EAAEjD,GAAG,CAACY,MAAM,CAAC,CAAC,CACnBoB,KAAK,CAAC,GAAGS,MAAM,CAACC,MAAM,CAACrC,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1EoC,MAAM,EAAElD,GAAG,CAACY,MAAM,CAAC,CAAC,CACjBoB,KAAK,CAAC,GAAGS,MAAM,CAACC,MAAM,CAACnC,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxDqC,IAAI,EAAEnD,GAAG,CAACY,MAAM,CAAC,CAAC,CACfoB,KAAK,CAAC,GAAGS,MAAM,CAACC,MAAM,CAAClC,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BsC,SAAS,EAAEpD,GAAG,CAACqD,IAAI,CAAC,CAAC,CAClBxC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHwC,gBAAgB,EAAEtD,GAAG,CAACqD,IAAI,CAAC,CAAC,CACzBxC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DyC,IAAI,EAAE5B;AACR,CAAC,CAAC","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n  type SecurityQuestionsEnum,\n  type SubmissionEventMessageCategory,\n  type SubmissionEventMessageSchemaVersion,\n  type SubmissionEventMessageSource,\n  type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  formSubmitPayloadSchema,\n  formSubmitRecordSchema,\n  formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n  /**\n   * The field name\n   */\n  name: string\n\n  /**\n   * The field title\n   */\n  title: string\n\n  /**\n   * The field display value\n   */\n  value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n  /**\n   * The name of the recordset\n   */\n  name: string\n\n  /**\n   * The title of the recordset\n   */\n  title: string\n\n  /**\n   * The record items\n   */\n  value: SubmitRecord[][]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n  /**\n   * The retrieval key for files created in the submission\n   */\n  retrievalKey: string\n\n  /**\n   * The id of the user session\n   */\n  sessionId: string\n\n  /**\n   * The main form anwsers\n   */\n  main: SubmitRecord[]\n\n  /**\n   * The repeaters form answers\n   */\n  repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n  message: string\n  result: {\n    files: {\n      main: string\n      repeaters: Record<string, string>\n    }\n  }\n}\n\nexport interface SaveAndExitMessageData {\n  formId: string\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  formStatus: {\n    status: FormStatus\n    isPreview: boolean\n  }\n  state: object\n}\n\nexport interface SaveAndExitMessage {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n  data: SaveAndExitMessageData\n}\n\nexport type RunnerMessage = SaveAndExitMessage\n\nexport interface RunnerRecordBase {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface RunnerRecordInputMeta extends RunnerRecordBase {\n  id: string\n}\n\nexport type RunnerRecordInput = RunnerMessage & RunnerRecordBase\n\nexport type RunnerRecord = RunnerMessage & RunnerRecordInputMeta\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n  type SecurityQuestionsEnum,\n  type SubmissionEventMessageCategory,\n  type SubmissionEventMessageSchemaVersion,\n  type SubmissionEventMessageSource,\n  type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  formSubmitPayloadSchema,\n  formSubmitRecordSchema,\n  formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n  /**\n   * The field name\n   */\n  name: string\n\n  /**\n   * The field title\n   */\n  title: string\n\n  /**\n   * The field display value\n   */\n  value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n  /**\n   * The name of the recordset\n   */\n  name: string\n\n  /**\n   * The title of the recordset\n   */\n  title: string\n\n  /**\n   * The record items\n   */\n  value: SubmitRecord[][]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n  /**\n   * The retrieval key for files created in the submission\n   */\n  retrievalKey: string\n\n  /**\n   * The id of the user session\n   */\n  sessionId: string\n\n  /**\n   * The main form anwsers\n   */\n  main: SubmitRecord[]\n\n  /**\n   * The repeaters form answers\n   */\n  repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n  message: string\n  result: {\n    files: {\n      main: string\n      repeaters: Record<string, string>\n    }\n  }\n}\n\nexport interface SaveAndExitMessageData {\n  form: {\n    id: string\n    slug: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  security: {\n    question: SecurityQuestionsEnum\n    answer: string\n  }\n  state: object\n}\n\nexport interface SaveAndExitMessage {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n  data: SaveAndExitMessageData\n}\n\nexport type RunnerMessage = SaveAndExitMessage\n\nexport interface RunnerRecordBase {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface RunnerRecordInputMeta extends RunnerRecordBase {\n  id: string\n}\n\nexport type RunnerRecordInput = RunnerMessage & RunnerRecordBase\n\nexport type RunnerRecord = RunnerMessage & RunnerRecordInputMeta\n"],"mappings":"","ignoreList":[]}

package/dist/types/form/form-submission/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAUrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAW0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAayC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCAkB2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAoBlC,CAAA;AAED,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAWrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAW0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAayC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCAkB2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAuBlC,CAAA;AAED,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}

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

@@ -71,16 +71,19 @@ export interface SubmitResponsePayload {
     };
 }
 export interface SaveAndExitMessageData {
-    formId: string;
+    form: {
+        id: string;
+        slug: string;
+        title: string;
+        status: FormStatus;
+        isPreview: boolean;
+        baseUrl: string;
+    };
     email: string;
     security: {
         question: SecurityQuestionsEnum;
         answer: string;
     };
-    formStatus: {
-        status: FormStatus;
-        isPreview: boolean;
-    };
     state: object;
 }
 export interface SaveAndExitMessage {

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,UAAU,EAAE;QACV,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,mCAAmC,CAAA;IAClD,MAAM,EAAE,4BAA4B,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;IACrD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,qBAAqB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,mCAAmC,CAAA;IAClD,MAAM,EAAE,4BAA4B,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;IACrD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,qBAAqB,CAAA"}

package/package.json

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

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

@@ -1,6 +1,7 @@
 import Joi from 'joi'
 
 import { FormStatus } from '~/src/common/enums.js'
+import { slugSchema, titleSchema } from '~/src/form/form-metadata/index.js'
 import {
   SecurityQuestionsEnum,
   SubmissionEventMessageCategory,
@@ -78,7 +79,14 @@ export const formSubmitPayloadSchema = Joi.object<SubmitPayload>()
 
 export const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(
   {
-    formId: Joi.string().required(),
+    form: {
+      id: Joi.string().required(),
+      slug: slugSchema,
+      title: titleSchema,
+      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
+      isPreview: Joi.boolean().required(),
+      baseUrl: Joi.string().required()
+    },
     email: Joi.string().required(),
     security: {
       question: Joi.string()
@@ -90,10 +98,6 @@ export const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(
         .required(),
       answer: Joi.string().required()
     },
-    formStatus: {
-      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
-      isPreview: Joi.boolean().required()
-    },
     state: Joi.object().required()
   }
 )

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

@@ -94,16 +94,19 @@ export interface SubmitResponsePayload {
 }
 
 export interface SaveAndExitMessageData {
-  formId: string
+  form: {
+    id: string
+    slug: string
+    title: string
+    status: FormStatus
+    isPreview: boolean
+    baseUrl: string
+  }
   email: string
   security: {
     question: SecurityQuestionsEnum
     answer: string
   }
-  formStatus: {
-    status: FormStatus
-    isPreview: boolean
-  }
   state: object
 }