@defra/forms-model 3.0.541 → 3.0.543

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

@@ -0,0 +1,23 @@
+export let SecurityQuestionsEnum = /*#__PURE__*/function (SecurityQuestionsEnum) {
+  SecurityQuestionsEnum["MemorablePlace"] = "memorable-place";
+  SecurityQuestionsEnum["CharacterName"] = "character-name";
+  SecurityQuestionsEnum["AudioRecommendation"] = "audio-recommendation";
+  return SecurityQuestionsEnum;
+}({});
+export let SubmissionEventMessageSchemaVersion = /*#__PURE__*/function (SubmissionEventMessageSchemaVersion) {
+  SubmissionEventMessageSchemaVersion[SubmissionEventMessageSchemaVersion["V1"] = 1] = "V1";
+  return SubmissionEventMessageSchemaVersion;
+}({});
+export let SubmissionEventMessageCategory = /*#__PURE__*/function (SubmissionEventMessageCategory) {
+  SubmissionEventMessageCategory["RUNNER"] = "RUNNER";
+  return SubmissionEventMessageCategory;
+}({});
+export let SubmissionEventMessageSource = /*#__PURE__*/function (SubmissionEventMessageSource) {
+  SubmissionEventMessageSource["FORMS_RUNNER"] = "FORMS_RUNNER";
+  return SubmissionEventMessageSource;
+}({});
+export let SubmissionEventMessageType = /*#__PURE__*/function (SubmissionEventMessageType) {
+  SubmissionEventMessageType["RUNNER_SAVE_AND_EXIT"] = "RUNNER_SAVE_AND_EXIT";
+  return SubmissionEventMessageType;
+}({});
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","names":["SecurityQuestionsEnum","SubmissionEventMessageSchemaVersion","SubmissionEventMessageCategory","SubmissionEventMessageSource","SubmissionEventMessageType"],"sources":["../../../../src/form/form-submission/enums.ts"],"sourcesContent":["export enum SecurityQuestionsEnum {\n  MemorablePlace = 'memorable-place',\n  CharacterName = 'character-name',\n  AudioRecommendation = 'audio-recommendation'\n}\n\nexport enum SubmissionEventMessageSchemaVersion {\n  V1 = 1\n}\n\nexport enum SubmissionEventMessageCategory {\n  RUNNER = 'RUNNER'\n}\n\nexport enum SubmissionEventMessageSource {\n  FORMS_RUNNER = 'FORMS_RUNNER'\n}\n\nexport enum SubmissionEventMessageType {\n  RUNNER_SAVE_AND_EXIT = 'RUNNER_SAVE_AND_EXIT'\n}\n"],"mappings":"AAAA,WAAYA,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAMjC,WAAYC,mCAAmC,0BAAnCA,mCAAmC;EAAnCA,mCAAmC,CAAnCA,mCAAmC;EAAA,OAAnCA,mCAAmC;AAAA;AAI/C,WAAYC,8BAA8B,0BAA9BA,8BAA8B;EAA9BA,8BAA8B;EAAA,OAA9BA,8BAA8B;AAAA;AAI1C,WAAYC,4BAA4B,0BAA5BA,4BAA4B;EAA5BA,4BAA4B;EAAA,OAA5BA,4BAA4B;AAAA;AAIxC,WAAYC,0BAA0B,0BAA1BA,0BAA0B;EAA1BA,0BAA0B;EAAA,OAA1BA,0BAA0B;AAAA","ignoreList":[]}

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

@@ -1,4 +1,5 @@
 import Joi from 'joi';
+import { SubmissionEventMessageCategory, SubmissionEventMessageSchemaVersion, SubmissionEventMessageSource, SubmissionEventMessageType } from "./enums.js";
 /**
  * Joi schema for `SubmitRecord` interface
  * @see {@link SubmitRecord}
@@ -29,4 +30,24 @@ export const formSubmitPayloadSchema = Joi.object().keys({
   main: Joi.array().items(formSubmitRecordSchema).required().description('Main (non-repeating) field values from the form'),
   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(),
+  email: Joi.string().required(),
+  security: {
+    question: Joi.string().required(),
+    answer: Joi.string().required()
+  },
+  state: Joi.object().required()
+});
+export const submissionMessageSchema = Joi.object().keys({
+  schemaVersion: Joi.string().valid(...Object.values(SubmissionEventMessageSchemaVersion)).required().description('The version of the SubmissionMessage - bumped with breaking changes'),
+  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
+});
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\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"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAQrB;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGD,GAAG,CAACE,MAAM,CAAe;EAC7DC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEP,GAAG,CAACI,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAER,GAAG,CAACI,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,GAAGV,GAAG,CAACE,MAAM,CAAkB;EACnEC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEP,GAAG,CAACI,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAER,GAAG,CAACW,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAACZ,GAAG,CAACW,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,GAAGb,GAAG,CAACE,MAAM,CAAgB,CAAC,CAC/DY,IAAI,CAAC;EACJC,YAAY,EAAEf,GAAG,CAACI,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DU,SAAS,EAAEhB,GAAG,CAACI,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEW,IAAI,EAAEjB,GAAG,CAACW,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACX,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEY,SAAS,EAAElB,GAAG,CAACW,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","ignoreList":[]}
+{"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":[]}

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  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"],"mappings":"","ignoreList":[]}
+{"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"],"mappings":"","ignoreList":[]}

package/dist/module/index.js

@@ -10,6 +10,7 @@ export * from "./form/form-definition/index.js";
 export * from "./form/form-definition/types.js";
 export * from "./form/form-metadata/index.js";
 export * from "./form/form-submission/index.js";
+export * from "./form/form-submission/enums.js";
 export * from "./form/utils/index.js";
 export * from "./form/form-editor/index.js";
 export * from "./form/form-editor/preview/index.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/roles.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/form-submission/enums.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/roles.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/module/stubs.js

@@ -1,17 +1,6 @@
 export * from "./__stubs__/form-definition.js";
-export { buildList } from "./__stubs__/components.js";
-export { buildListItem } from "./__stubs__/components.js";
-export { buildCheckboxComponent } from "./__stubs__/components.js";
-export { buildRadioComponent } from "./__stubs__/components.js";
-export { buildAutoCompleteComponent } from "./__stubs__/components.js";
-export { buildNumberFieldComponent } from "./__stubs__/components.js";
-export { buildFileUploadComponent } from "./__stubs__/components.js";
-export { buildTextFieldComponent } from "./__stubs__/components.js";
-export { buildRepeaterPage } from "./__stubs__/pages.js";
-export { buildFileUploadPage } from "./__stubs__/pages.js";
-export { buildSummaryPage } from "./__stubs__/pages.js";
-export { buildQuestionPage } from "./__stubs__/pages.js";
-export { buildMarkdownComponent } from "./__stubs__/components.js";
+export * from "./__stubs__/components.js";
+export * from "./__stubs__/pages.js";
 export { QuestionRendererStub } from "./form/form-editor/__stubs__/preview.js";
 export { PageRendererStub } from "./form/form-editor/__stubs__/preview.js";
 export { QuestionPreviewElements } from "./form/form-editor/__stubs__/preview.js";

package/dist/module/stubs.js.map

@@ -1 +1 @@
-{"version":3,"file":"stubs.js","names":["buildList","buildListItem","buildCheckboxComponent","buildRadioComponent","buildAutoCompleteComponent","buildNumberFieldComponent","buildFileUploadComponent","buildTextFieldComponent","buildRepeaterPage","buildFileUploadPage","buildSummaryPage","buildQuestionPage","buildMarkdownComponent","QuestionRendererStub","PageRendererStub","QuestionPreviewElements"],"sources":["../../src/stubs.ts"],"sourcesContent":["export * from '~/src/__stubs__/form-definition.js'\nexport { buildList } from '~/src/__stubs__/components.js'\nexport { buildListItem } from '~/src/__stubs__/components.js'\nexport { buildCheckboxComponent } from '~/src/__stubs__/components.js'\nexport { buildRadioComponent } from '~/src/__stubs__/components.js'\nexport { buildAutoCompleteComponent } from '~/src/__stubs__/components.js'\nexport { buildNumberFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildFileUploadComponent } from '~/src/__stubs__/components.js'\nexport { buildTextFieldComponent } from '~/src/__stubs__/components.js'\nexport { buildRepeaterPage } from '~/src/__stubs__/pages.js'\nexport { buildFileUploadPage } from '~/src/__stubs__/pages.js'\nexport { buildSummaryPage } from '~/src/__stubs__/pages.js'\nexport { buildQuestionPage } from '~/src/__stubs__/pages.js'\nexport { buildMarkdownComponent } from '~/src/__stubs__/components.js'\nexport { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'\nexport * from '~/src/form/form-audit/__stubs__/events.js'\n"],"mappings":"AAAA;AACA,SAASA,SAAS;AAClB,SAASC,aAAa;AACtB,SAASC,sBAAsB;AAC/B,SAASC,mBAAmB;AAC5B,SAASC,0BAA0B;AACnC,SAASC,yBAAyB;AAClC,SAASC,wBAAwB;AACjC,SAASC,uBAAuB;AAChC,SAASC,iBAAiB;AAC1B,SAASC,mBAAmB;AAC5B,SAASC,gBAAgB;AACzB,SAASC,iBAAiB;AAC1B,SAASC,sBAAsB;AAC/B,SAASC,oBAAoB;AAC7B,SAASC,gBAAgB;AACzB,SAASC,uBAAuB;AAChC","ignoreList":[]}
+{"version":3,"file":"stubs.js","names":["QuestionRendererStub","PageRendererStub","QuestionPreviewElements"],"sources":["../../src/stubs.ts"],"sourcesContent":["export * from '~/src/__stubs__/form-definition.js'\nexport * from '~/src/__stubs__/components.js'\nexport * from '~/src/__stubs__/pages.js'\nexport { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'\nexport { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'\nexport * from '~/src/form/form-audit/__stubs__/events.js'\n"],"mappings":"AAAA;AACA;AACA;AACA,SAASA,oBAAoB;AAC7B,SAASC,gBAAgB;AACzB,SAASC,uBAAuB;AAChC","ignoreList":[]}

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

@@ -0,0 +1,18 @@
+export declare enum SecurityQuestionsEnum {
+    MemorablePlace = "memorable-place",
+    CharacterName = "character-name",
+    AudioRecommendation = "audio-recommendation"
+}
+export declare enum SubmissionEventMessageSchemaVersion {
+    V1 = 1
+}
+export declare enum SubmissionEventMessageCategory {
+    RUNNER = "RUNNER"
+}
+export declare enum SubmissionEventMessageSource {
+    FORMS_RUNNER = "FORMS_RUNNER"
+}
+export declare enum SubmissionEventMessageType {
+    RUNNER_SAVE_AND_EXIT = "RUNNER_SAVE_AND_EXIT"
+}
+//# sourceMappingURL=enums.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,qBAAqB;IAC/B,cAAc,oBAAoB;IAClC,aAAa,mBAAmB;IAChC,mBAAmB,yBAAyB;CAC7C;AAED,oBAAY,mCAAmC;IAC7C,EAAE,IAAI;CACP;AAED,oBAAY,8BAA8B;IACxC,MAAM,WAAW;CAClB;AAED,oBAAY,4BAA4B;IACtC,YAAY,iBAAiB;CAC9B;AAED,oBAAY,0BAA0B;IACpC,oBAAoB,yBAAyB;CAC9C"}

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

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
+import { type SaveAndExitMessageData, type SubmissionMessage, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
 /**
  * Joi schema for `SubmitRecord` interface
  * @see {@link SubmitRecord}
@@ -15,4 +15,6 @@ export declare const formSubmitRecordsetSchema: Joi.ObjectSchema<SubmitRecordset
  * @see {@link SubmitPayload}
  */
 export declare const formSubmitPayloadSchema: Joi.ObjectSchema<SubmitPayload>;
+export declare const saveAndExitMessageData: Joi.ObjectSchema<SaveAndExitMessageData>;
+export declare const submissionMessageSchema: Joi.ObjectSchema<SubmissionMessage>;
 //# 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;AAErB,OAAO,EACL,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"}
+{"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"}

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

@@ -1,3 +1,4 @@
+import { type SubmissionEventMessageCategory, type SubmissionEventMessageSchemaVersion, type SubmissionEventMessageSource, type SubmissionEventMessageType } from '../../form/form-submission/enums.js';
 /**
  * Interface for an individual submit record
  * @see {@link formSubmitRecordSchema}
@@ -68,4 +69,30 @@ export interface SubmitResponsePayload {
         };
     };
 }
+export interface SaveAndExitMessageData {
+    formId: string;
+    email: string;
+    security: {
+        question: string;
+        answer: string;
+    };
+    state: object;
+}
+export type SubmissionMessageData = SaveAndExitMessageData;
+export interface SubmissionMessage {
+    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;
+}
+export type RunnerMessage = SaveAndExitMessage;
 //# sourceMappingURL=types.d.ts.map

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":"AAMA;;;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"}
+{"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"}

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './form/form-definition/index.js';
 export * from './form/form-definition/types.js';
 export * from './form/form-metadata/index.js';
 export * from './form/form-submission/index.js';
+export * from './form/form-submission/enums.js';
 export * from './form/utils/index.js';
 export * from './form/form-editor/index.js';
 export * from './form/form-editor/preview/index.js';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAE9C,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAE9C,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}

package/dist/types/stubs.d.ts

@@ -1,17 +1,6 @@
 export * from './__stubs__/form-definition.js';
-export { buildList } from './__stubs__/components.js';
-export { buildListItem } from './__stubs__/components.js';
-export { buildCheckboxComponent } from './__stubs__/components.js';
-export { buildRadioComponent } from './__stubs__/components.js';
-export { buildAutoCompleteComponent } from './__stubs__/components.js';
-export { buildNumberFieldComponent } from './__stubs__/components.js';
-export { buildFileUploadComponent } from './__stubs__/components.js';
-export { buildTextFieldComponent } from './__stubs__/components.js';
-export { buildRepeaterPage } from './__stubs__/pages.js';
-export { buildFileUploadPage } from './__stubs__/pages.js';
-export { buildSummaryPage } from './__stubs__/pages.js';
-export { buildQuestionPage } from './__stubs__/pages.js';
-export { buildMarkdownComponent } from './__stubs__/components.js';
+export * from './__stubs__/components.js';
+export * from './__stubs__/pages.js';
 export { QuestionRendererStub } from './form/form-editor/__stubs__/preview.js';
 export { PageRendererStub } from './form/form-editor/__stubs__/preview.js';
 export { QuestionPreviewElements } from './form/form-editor/__stubs__/preview.js';

package/dist/types/stubs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../src/stubs.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AACrF,cAAc,2CAA2C,CAAA"}
+{"version":3,"file":"stubs.d.ts","sourceRoot":"","sources":["../../src/stubs.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,0BAA0B,CAAA;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAA;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AACrF,cAAc,2CAA2C,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.541",
+  "version": "3.0.543",
   "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/enums.ts

@@ -0,0 +1,21 @@
+export enum SecurityQuestionsEnum {
+  MemorablePlace = 'memorable-place',
+  CharacterName = 'character-name',
+  AudioRecommendation = 'audio-recommendation'
+}
+
+export enum SubmissionEventMessageSchemaVersion {
+  V1 = 1
+}
+
+export enum SubmissionEventMessageCategory {
+  RUNNER = 'RUNNER'
+}
+
+export enum SubmissionEventMessageSource {
+  FORMS_RUNNER = 'FORMS_RUNNER'
+}
+
+export enum SubmissionEventMessageType {
+  RUNNER_SAVE_AND_EXIT = 'RUNNER_SAVE_AND_EXIT'
+}

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

@@ -1,6 +1,14 @@
 import Joi from 'joi'
 
 import {
+  SubmissionEventMessageCategory,
+  SubmissionEventMessageSchemaVersion,
+  SubmissionEventMessageSource,
+  SubmissionEventMessageType
+} from '~/src/form/form-submission/enums.js'
+import {
+  type SaveAndExitMessageData,
+  type SubmissionMessage,
   type SubmitPayload,
   type SubmitRecord,
   type SubmitRecordset
@@ -65,3 +73,52 @@ export const formSubmitPayloadSchema = Joi.object<SubmitPayload>()
   })
   .required()
   .description('Complete form submission payload structure with all form data')
+
+export const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(
+  {
+    formId: Joi.string().required(),
+    email: Joi.string().required(),
+    security: {
+      question: Joi.string().required(),
+      answer: Joi.string().required()
+    },
+    state: Joi.object().required()
+  }
+)
+
+export const submissionMessageSchema = Joi.object<SubmissionMessage>().keys({
+  schemaVersion: Joi.string()
+    .valid(...Object.values(SubmissionEventMessageSchemaVersion))
+    .required()
+    .description(
+      'The version of the SubmissionMessage - bumped with breaking changes'
+    ),
+  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/src/form/form-submission/types.ts

@@ -1,3 +1,9 @@
+import {
+  type SubmissionEventMessageCategory,
+  type SubmissionEventMessageSchemaVersion,
+  type SubmissionEventMessageSource,
+  type SubmissionEventMessageType
+} from '~/src/form/form-submission/enums.js'
 import {
   formSubmitPayloadSchema,
   formSubmitRecordSchema,
@@ -84,3 +90,34 @@ export interface SubmitResponsePayload {
     }
   }
 }
+
+export interface SaveAndExitMessageData {
+  formId: string
+  email: string
+  security: {
+    question: string
+    answer: string
+  }
+  state: object
+}
+
+export type SubmissionMessageData = SaveAndExitMessageData
+
+export interface SubmissionMessage {
+  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
+}
+
+export type RunnerMessage = SaveAndExitMessage

package/src/index.ts

@@ -10,6 +10,7 @@ export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-definition/types.js'
 export * from '~/src/form/form-metadata/index.js'
 export * from '~/src/form/form-submission/index.js'
+export * from '~/src/form/form-submission/enums.js'
 export * from '~/src/form/utils/index.js'
 export * from '~/src/form/form-editor/index.js'
 export * from '~/src/form/form-editor/preview/index.js'

package/src/stubs.ts

@@ -1,17 +1,6 @@
 export * from '~/src/__stubs__/form-definition.js'
-export { buildList } from '~/src/__stubs__/components.js'
-export { buildListItem } from '~/src/__stubs__/components.js'
-export { buildCheckboxComponent } from '~/src/__stubs__/components.js'
-export { buildRadioComponent } from '~/src/__stubs__/components.js'
-export { buildAutoCompleteComponent } from '~/src/__stubs__/components.js'
-export { buildNumberFieldComponent } from '~/src/__stubs__/components.js'
-export { buildFileUploadComponent } from '~/src/__stubs__/components.js'
-export { buildTextFieldComponent } from '~/src/__stubs__/components.js'
-export { buildRepeaterPage } from '~/src/__stubs__/pages.js'
-export { buildFileUploadPage } from '~/src/__stubs__/pages.js'
-export { buildSummaryPage } from '~/src/__stubs__/pages.js'
-export { buildQuestionPage } from '~/src/__stubs__/pages.js'
-export { buildMarkdownComponent } from '~/src/__stubs__/components.js'
+export * from '~/src/__stubs__/components.js'
+export * from '~/src/__stubs__/pages.js'
 export { QuestionRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'
 export { PageRendererStub } from '~/src/form/form-editor/__stubs__/preview.js'
 export { QuestionPreviewElements } from '~/src/form/form-editor/__stubs__/preview.js'