@defra/forms-model 3.0.544 → 3.0.546

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

@@ -1,5 +1,7 @@
 import Joi from 'joi';
-import { SubmissionEventMessageCategory, SubmissionEventMessageSchemaVersion, SubmissionEventMessageSource, SubmissionEventMessageType } from "./enums.js";
+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
  * @see {@link SubmitRecord}
@@ -31,10 +33,16 @@ 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()
+  },
   email: Joi.string().required(),
   security: {
-    question: Joi.string().required(),
+    question: Joi.string().valid(...Object.values(SecurityQuestionsEnum).map(value => value.toString())).required(),
     answer: Joi.string().required()
   },
   state: Joi.object().required()
@@ -44,8 +52,6 @@ export const submissionMessageSchema = Joi.object().keys({
   category: Joi.string().valid(...Object.values(SubmissionEventMessageCategory)).required().description('The message category - what does the entityId represent?'),
   source: Joi.string().valid(...Object.values(SubmissionEventMessageSource)).required().description('Source of the message - which service?'),
   type: Joi.string().valid(...Object.values(SubmissionEventMessageType)).description('Event type'),
-  entityId: Joi.string().required().description('The id of the entity the category relates to'),
-  traceId: Joi.string().optional().description('Trace id of the event - to link events across multiple services'),
   createdAt: Joi.date().required().description('The ISO timestamp where the action took place - should be the same as updated_at field in DB'),
   messageCreatedAt: Joi.date().required().description('ISO timestamp when the message was published'),
   data: saveAndExitMessageData

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","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","answer","state","submissionMessageSchema","schemaVersion","valid","Object","values","category","source","type","entityId","traceId","optional","createdAt","date","messageCreatedAt","data"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\n  SubmissionEventMessageCategory,\n  SubmissionEventMessageSchemaVersion,\n  SubmissionEventMessageSource,\n  SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n  type SaveAndExitMessageData,\n  type SubmissionMessage,\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().required(),\n      answer: Joi.string().required()\n    },\n    state: Joi.object().required()\n  }\n)\n\nexport const submissionMessageSchema = Joi.object<SubmissionMessage>().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  entityId: Joi.string()\n    .required()\n    .description('The id of the entity the category relates to'),\n  traceId: Joi.string()\n    .optional()\n    .description(\n      'Trace id of the event - to link events across multiple services'\n    ),\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,SACEC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAU5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGL,GAAG,CAACM,MAAM,CAAe;EAC7DC,IAAI,EAAEP,GAAG,CAACQ,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEX,GAAG,CAACQ,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEZ,GAAG,CAACQ,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,GAAGd,GAAG,CAACM,MAAM,CAAkB;EACnEC,IAAI,EAAEP,GAAG,CAACQ,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEX,GAAG,CAACQ,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEZ,GAAG,CAACe,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAAChB,GAAG,CAACe,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,GAAGjB,GAAG,CAACM,MAAM,CAAgB,CAAC,CAC/DY,IAAI,CAAC;EACJC,YAAY,EAAEnB,GAAG,CAACQ,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DU,SAAS,EAAEpB,GAAG,CAACQ,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEW,IAAI,EAAErB,GAAG,CAACe,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACX,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEY,SAAS,EAAEtB,GAAG,CAACe,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,GAAGvB,GAAG,CAACM,MAAM,CAAyB,CAAC,CAACY,IAAI,CAC7E;EACEM,MAAM,EAAExB,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BgB,KAAK,EAAEzB,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BiB,QAAQ,EAAE;IACRC,QAAQ,EAAE3B,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IACjCmB,MAAM,EAAE5B,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC;EACDoB,KAAK,EAAE7B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC;AAC/B,CACF,CAAC;AAED,OAAO,MAAMqB,uBAAuB,GAAG9B,GAAG,CAACM,MAAM,CAAoB,CAAC,CAACY,IAAI,CAAC;EAC1Ea,aAAa,EAAE/B,GAAG,CAACQ,MAAM,CAAC,CAAC,CACxBwB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAChC,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHyB,QAAQ,EAAEnC,GAAG,CAACQ,MAAM,CAAC,CAAC,CACnBwB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACjC,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1E0B,MAAM,EAAEpC,GAAG,CAACQ,MAAM,CAAC,CAAC,CACjBwB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC/B,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxD2B,IAAI,EAAErC,GAAG,CAACQ,MAAM,CAAC,CAAC,CACfwB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC9B,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5B4B,QAAQ,EAAEtC,GAAG,CAACQ,MAAM,CAAC,CAAC,CACnBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9D6B,OAAO,EAAEvC,GAAG,CAACQ,MAAM,CAAC,CAAC,CAClBgC,QAAQ,CAAC,CAAC,CACV9B,WAAW,CACV,iEACF,CAAC;EACH+B,SAAS,EAAEzC,GAAG,CAAC0C,IAAI,CAAC,CAAC,CAClBjC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHiC,gBAAgB,EAAE3C,GAAG,CAAC0C,IAAI,CAAC,CAAC,CACzBjC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DkC,IAAI,EAAErB;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","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    },\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;EACpC,CAAC;EACDwB,KAAK,EAAErC,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9ByB,QAAQ,EAAE;IACRC,QAAQ,EAAEvC,GAAG,CAACY,MAAM,CAAC,CAAC,CACnBoB,KAAK,CACJ,GAAGQ,MAAM,CAACC,MAAM,CAACrC,qBAAqB,CAAC,CAACsC,GAAG,CAAE1B,KAAK,IAChDA,KAAK,CAAC2B,QAAQ,CAAC,CACjB,CACF,CAAC,CACA9B,QAAQ,CAAC,CAAC;IACb+B,MAAM,EAAE5C,GAAG,CAACY,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC;EACDgC,KAAK,EAAE7C,GAAG,CAACU,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC;AAC/B,CACF,CAAC;AAED,OAAO,MAAMiC,uBAAuB,GAAG9C,GAAG,CAACU,MAAM,CAAqB,CAAC,CAACY,IAAI,CAAC;EAC3EyB,aAAa,EAAE/C,GAAG,CAACY,MAAM,CAAC,CAAC,CACxBoB,KAAK,CAAC,GAAGQ,MAAM,CAACC,MAAM,CAACnC,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHkC,QAAQ,EAAEhD,GAAG,CAACY,MAAM,CAAC,CAAC,CACnBoB,KAAK,CAAC,GAAGQ,MAAM,CAACC,MAAM,CAACpC,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1EmC,MAAM,EAAEjD,GAAG,CAACY,MAAM,CAAC,CAAC,CACjBoB,KAAK,CAAC,GAAGQ,MAAM,CAACC,MAAM,CAAClC,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxDoC,IAAI,EAAElD,GAAG,CAACY,MAAM,CAAC,CAAC,CACfoB,KAAK,CAAC,GAAGQ,MAAM,CAACC,MAAM,CAACjC,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BqC,SAAS,EAAEnD,GAAG,CAACoD,IAAI,CAAC,CAAC,CAClBvC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHuC,gBAAgB,EAAErD,GAAG,CAACoD,IAAI,CAAC,CAAC,CACzBvC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DwC,IAAI,EAAE3B;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 {\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: string\n    answer: string\n  }\n  state: object\n}\n\nexport type SubmissionMessageData = SaveAndExitMessageData\n\nexport interface SubmissionMessage {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  category: SubmissionEventMessageCategory\n  source: SubmissionEventMessageSource\n  type: SubmissionEventMessageType\n  entityId: string\n  traceId?: string\n  createdAt: Date\n  messageCreatedAt: Date\n  data: SubmissionMessageData\n}\n\nexport interface SaveAndExitMessage extends SubmissionMessage {\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\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  }\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

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type SaveAndExitMessageData, type SubmissionMessage, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
+import { type SaveAndExitMessage, type SaveAndExitMessageData, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
 /**
  * Joi schema for `SubmitRecord` interface
  * @see {@link SubmitRecord}
@@ -16,5 +16,5 @@ export declare const formSubmitRecordsetSchema: Joi.ObjectSchema<SubmitRecordset
  */
 export declare const formSubmitPayloadSchema: Joi.ObjectSchema<SubmitPayload>;
 export declare const saveAndExitMessageData: Joi.ObjectSchema<SaveAndExitMessageData>;
-export declare const submissionMessageSchema: Joi.ObjectSchema<SubmissionMessage>;
+export declare const submissionMessageSchema: Joi.ObjectSchema<SaveAndExitMessage>;
 //# sourceMappingURL=index.d.ts.map

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;AAQrB,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,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,0CAUlC,CAAA;AAED,eAAO,MAAM,uBAAuB,qCAmClC,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,0CAsBlC,CAAA;AAED,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}

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

@@ -1,4 +1,5 @@
-import { type SubmissionEventMessageCategory, type SubmissionEventMessageSchemaVersion, type SubmissionEventMessageSource, type SubmissionEventMessageType } from '../../form/form-submission/enums.js';
+import { type FormStatus } from '../../common/enums.js';
+import { type SecurityQuestionsEnum, type SubmissionEventMessageCategory, type SubmissionEventMessageSchemaVersion, type SubmissionEventMessageSource, type SubmissionEventMessageType } from '../../form/form-submission/enums.js';
 /**
  * Interface for an individual submit record
  * @see {@link formSubmitRecordSchema}
@@ -70,29 +71,28 @@ export interface SubmitResponsePayload {
     };
 }
 export interface SaveAndExitMessageData {
-    formId: string;
+    form: {
+        id: string;
+        slug: string;
+        title: string;
+        status: FormStatus;
+        isPreview: boolean;
+    };
     email: string;
     security: {
-        question: string;
+        question: SecurityQuestionsEnum;
         answer: string;
     };
     state: object;
 }
-export type SubmissionMessageData = SaveAndExitMessageData;
-export interface SubmissionMessage {
+export interface SaveAndExitMessage {
     schemaVersion: SubmissionEventMessageSchemaVersion;
-    category: SubmissionEventMessageCategory;
     source: SubmissionEventMessageSource;
-    type: SubmissionEventMessageType;
-    entityId: string;
-    traceId?: string;
     createdAt: Date;
     messageCreatedAt: Date;
-    data: SubmissionMessageData;
-}
-export interface SaveAndExitMessage extends SubmissionMessage {
     category: SubmissionEventMessageCategory.RUNNER;
     type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT;
+    data: SaveAndExitMessageData;
 }
 export type RunnerMessage = SaveAndExitMessage;
 export interface RunnerRecordBase {

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,EACL,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,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,CAAA;AAE1D,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,mCAAmC,CAAA;IAClD,QAAQ,EAAE,8BAA8B,CAAA;IACxC,MAAM,EAAE,4BAA4B,CAAA;IACpC,IAAI,EAAE,0BAA0B,CAAA;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,IAAI,EAAE,qBAAqB,CAAA;CAC5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;CACtD;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;KACnB,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.544",
+  "version": "3.0.546",
   "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,14 +1,17 @@
 import Joi from 'joi'
 
+import { FormStatus } from '~/src/common/enums.js'
+import { slugSchema, titleSchema } from '~/src/form/form-metadata/index.js'
 import {
+  SecurityQuestionsEnum,
   SubmissionEventMessageCategory,
   SubmissionEventMessageSchemaVersion,
   SubmissionEventMessageSource,
   SubmissionEventMessageType
 } from '~/src/form/form-submission/enums.js'
 import {
+  type SaveAndExitMessage,
   type SaveAndExitMessageData,
-  type SubmissionMessage,
   type SubmitPayload,
   type SubmitRecord,
   type SubmitRecordset
@@ -76,17 +79,29 @@ 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()
+    },
     email: Joi.string().required(),
     security: {
-      question: Joi.string().required(),
+      question: Joi.string()
+        .valid(
+          ...Object.values(SecurityQuestionsEnum).map((value) =>
+            value.toString()
+          )
+        )
+        .required(),
       answer: Joi.string().required()
     },
     state: Joi.object().required()
   }
 )
 
-export const submissionMessageSchema = Joi.object<SubmissionMessage>().keys({
+export const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({
   schemaVersion: Joi.string()
     .valid(...Object.values(SubmissionEventMessageSchemaVersion))
     .required()
@@ -104,14 +119,6 @@ export const submissionMessageSchema = Joi.object<SubmissionMessage>().keys({
   type: Joi.string()
     .valid(...Object.values(SubmissionEventMessageType))
     .description('Event type'),
-  entityId: Joi.string()
-    .required()
-    .description('The id of the entity the category relates to'),
-  traceId: Joi.string()
-    .optional()
-    .description(
-      'Trace id of the event - to link events across multiple services'
-    ),
   createdAt: Joi.date()
     .required()
     .description(

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

@@ -1,4 +1,6 @@
+import { type FormStatus } from '~/src/common/enums.js'
 import {
+  type SecurityQuestionsEnum,
   type SubmissionEventMessageCategory,
   type SubmissionEventMessageSchemaVersion,
   type SubmissionEventMessageSource,
@@ -92,32 +94,29 @@ export interface SubmitResponsePayload {
 }
 
 export interface SaveAndExitMessageData {
-  formId: string
+  form: {
+    id: string
+    slug: string
+    title: string
+    status: FormStatus
+    isPreview: boolean
+  }
   email: string
   security: {
-    question: string
+    question: SecurityQuestionsEnum
     answer: string
   }
   state: object
 }
 
-export type SubmissionMessageData = SaveAndExitMessageData
-
-export interface SubmissionMessage {
+export interface SaveAndExitMessage {
   schemaVersion: SubmissionEventMessageSchemaVersion
-  category: SubmissionEventMessageCategory
   source: SubmissionEventMessageSource
-  type: SubmissionEventMessageType
-  entityId: string
-  traceId?: string
   createdAt: Date
   messageCreatedAt: Date
-  data: SubmissionMessageData
-}
-
-export interface SaveAndExitMessage extends SubmissionMessage {
   category: SubmissionEventMessageCategory.RUNNER
   type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT
+  data: SaveAndExitMessageData
 }
 
 export type RunnerMessage = SaveAndExitMessage