@defra/forms-model 3.0.705 → 3.0.707

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

@@ -18,6 +18,7 @@ export let SubmissionEventMessageSource = /*#__PURE__*/function (SubmissionEvent
 }({});
 export let SubmissionEventMessageType = /*#__PURE__*/function (SubmissionEventMessageType) {
   SubmissionEventMessageType["RUNNER_SAVE_AND_EXIT"] = "RUNNER_SAVE_AND_EXIT";
+  SubmissionEventMessageType["RUNNER_SAVE_AND_EXIT_V2"] = "RUNNER_SAVE_AND_EXIT_V2";
   return SubmissionEventMessageType;
 }({});
 

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

@@ -1 +1 @@
-{"version":3,"file":"enums.js","names":["SecurityQuestionsEnum","SubmissionEventMessageSchemaVersion","SubmissionEventMessageCategory","SubmissionEventMessageSource","SubmissionEventMessageType","ConditionEvaluationOutcome"],"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\n/**\n * The outcome of evaluating a single form condition.\n *\n * `Error` is deliberately distinct from `False`. The runner defaults a failed\n * evaluation to `false` when routing, but for an audit record the two are not\n * the same thing and a consumer must be able to tell them apart.\n */\nexport enum ConditionEvaluationOutcome {\n  /**\n   * The condition evaluated to `true`\n   */\n  True = 'true',\n\n  /**\n   * The condition evaluated to `false`\n   */\n  False = 'false',\n\n  /**\n   * Evaluation threw - most commonly because the condition references a\n   * component that is absent from the evaluation context, such as a component\n   * on a repeater page. The runner treats this as `false`.\n   */\n  Error = 'error'\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;;AAItC;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,0BAA0B,0BAA1BA,0BAA0B;EACpC;AACF;AACA;EAHYA,0BAA0B;EAMpC;AACF;AACA;EARYA,0BAA0B;EAWpC;AACF;AACA;AACA;AACA;EAfYA,0BAA0B;EAAA,OAA1BA,0BAA0B;AAAA","ignoreList":[]}
+{"version":3,"file":"enums.js","names":["SecurityQuestionsEnum","SubmissionEventMessageSchemaVersion","SubmissionEventMessageCategory","SubmissionEventMessageSource","SubmissionEventMessageType","ConditionEvaluationOutcome"],"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  RUNNER_SAVE_AND_EXIT_V2 = 'RUNNER_SAVE_AND_EXIT_V2'\n}\n\n/**\n * The outcome of evaluating a single form condition.\n *\n * `Error` is deliberately distinct from `False`. The runner defaults a failed\n * evaluation to `false` when routing, but for an audit record the two are not\n * the same thing and a consumer must be able to tell them apart.\n */\nexport enum ConditionEvaluationOutcome {\n  /**\n   * The condition evaluated to `true`\n   */\n  True = 'true',\n\n  /**\n   * The condition evaluated to `false`\n   */\n  False = 'false',\n\n  /**\n   * Evaluation threw - most commonly because the condition references a\n   * component that is absent from the evaluation context, such as a component\n   * on a repeater page. The runner treats this as `false`.\n   */\n  Error = 'error'\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;EAA1BA,0BAA0B;EAAA,OAA1BA,0BAA0B;AAAA;;AAKtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,0BAA0B,0BAA1BA,0BAA0B;EACpC;AACF;AACA;EAHYA,0BAA0B;EAMpC;AACF;AACA;EARYA,0BAA0B;EAWpC;AACF;AACA;AACA;AACA;EAfYA,0BAA0B;EAAA,OAA1BA,0BAA0B;AAAA","ignoreList":[]}

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

@@ -73,6 +73,22 @@ export const saveAndExitMessageData = Joi.object().keys({
   state: Joi.object().required(),
   magicLinkGroupId: Joi.string().optional()
 }).label('SaveAndExitMessageData');
+export const saveAndExitV2MessageData = Joi.object().keys({
+  form: Joi.object({
+    id: Joi.string().required(),
+    title: Joi.string().required(),
+    status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
+    isPreview: Joi.boolean().required(),
+    baseUrl: Joi.string().required()
+  }).label('SaveAndExitForm'),
+  email: Joi.string().required(),
+  auth: Joi.object({
+    sub: Joi.string().required(),
+    issuer: Joi.string().required()
+  }),
+  state: Joi.object().required(),
+  magicLinkGroupId: Joi.string().optional()
+}).label('SaveAndExitV2MessageData');
 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?'),
@@ -80,11 +96,17 @@ export const submissionMessageSchema = Joi.object().keys({
   type: Joi.string().valid(...Object.values(SubmissionEventMessageType)).description('Event type'),
   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
+  data: Joi.when('type', {
+    is: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT,
+    then: saveAndExitMessageData,
+    otherwise: saveAndExitV2MessageData
+  })
 });
 export const notifyEmailMessageSchema = Joi.object().keys({
   source: Joi.string().required(),
   reason: Joi.string().required(),
+  formId: Joi.string().allow(''),
+  referenceNumber: Joi.string().allow(''),
   templateId: Joi.string().required(),
   emailAddress: Joi.string().email().required(),
   personalisation: Joi.object({

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","FormStatus","ConditionEvaluationOutcome","SecurityQuestionsEnum","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","label","formSubmitRecordsetSchema","array","items","formSubmitConditionReferenceSchema","componentId","componentName","answered","boolean","formSubmitConditionEvaluationSchema","conditionId","outcome","valid","Object","values","references","formSubmitPayloadSchema","keys","retrievalKey","sessionId","referenceNumber","optional","language","main","repeaters","saveAndExitMessageData","form","id","status","Draft","Live","isPreview","baseUrl","email","security","question","answer","state","magicLinkGroupId","submissionMessageSchema","schemaVersion","category","source","type","createdAt","date","messageCreatedAt","data","notifyEmailMessageSchema","reason","templateId","emailAddress","personalisation","subject","body","notifyReplyToId"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { FormStatus } from '~/src/common/enums.js'\nimport {\n  ConditionEvaluationOutcome,\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 SubmitConditionEvaluation,\n  type SubmitConditionReference,\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})\n  .label('FormSubmitRecord')\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(\n      Joi.array<SubmitRecord>()\n        .items(formSubmitRecordSchema)\n        .required()\n        .label('FormSubmitRecordGroup')\n    )\n    .required()\n    .description(\n      'Array of record arrays, each representing a repeated instance'\n    )\n})\n  .label('FormSubmitRecordset')\n  .description('Collection of repeated field values from a repeatable section')\n\n/**\n * Joi schema for `SubmitConditionReference` interface\n * @see {@link SubmitConditionReference}\n */\nexport const formSubmitConditionReferenceSchema =\n  Joi.object<SubmitConditionReference>({\n    componentId: Joi.string()\n      .required()\n      .description('Identifier of the component the condition depends on'),\n    componentName: Joi.string()\n      .required()\n      .description(\n        'Name of the component the condition depends on, matching the submitted record name'\n      ),\n    answered: Joi.boolean()\n      .required()\n      .description(\n        'Whether the component held an answer when the condition was evaluated'\n      )\n  })\n    .label('FormSubmitConditionReference')\n    .description('A component a condition depends on, and its answered state')\n\n/**\n * Joi schema for `SubmitConditionEvaluation` interface\n * @see {@link SubmitConditionEvaluation}\n */\nexport const formSubmitConditionEvaluationSchema =\n  Joi.object<SubmitConditionEvaluation>({\n    conditionId: Joi.string()\n      .required()\n      .description('Identifier of the condition in the V2 form definition'),\n    outcome: Joi.string()\n      .valid(...Object.values(ConditionEvaluationOutcome))\n      .required()\n      .description('Result of evaluating the condition'),\n    references: Joi.array<SubmitConditionReference>()\n      .items(formSubmitConditionReferenceSchema)\n      .required()\n      .description(\n        'Components the condition depends on, including those reached through nested condition references'\n      )\n  })\n    .label('FormSubmitConditionEvaluation')\n    .description('Recorded outcome of a single condition at submission')\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    referenceNumber: Joi.string()\n      // TODO - make this required in later releases - optional for now to avoid release glitches\n      .optional()\n      .allow('')\n      .description('Reference number for the form submission'),\n    language: Joi.string()\n      // TODO - make this required in later releases - optional for now to avoid release glitches\n      .optional()\n      .allow('')\n      .description(\n        'The currently-selected language at point of form submission'\n      ),\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  .label('FormSubmitPayload')\n  .description('Complete form submission payload structure with all form data')\n\nexport const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>()\n  .keys({\n    form: Joi.object({\n      id: Joi.string().required(),\n      title: Joi.string().required(),\n      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n      isPreview: Joi.boolean().required(),\n      baseUrl: Joi.string().required()\n    }).label('SaveAndExitForm'),\n    email: Joi.string().required(),\n    security: Joi.object({\n      question: Joi.string()\n        .valid(...Object.values(SecurityQuestionsEnum))\n        .required(),\n      answer: Joi.string().required()\n    }).label('SaveAndExitSecurity'),\n    state: Joi.object().required(),\n    magicLinkGroupId: Joi.string().optional()\n  })\n  .label('SaveAndExitMessageData')\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\nexport const notifyEmailMessageSchema = Joi.object()\n  .keys({\n    source: Joi.string().required(),\n    reason: Joi.string().required(),\n    templateId: Joi.string().required(),\n    emailAddress: Joi.string().email().required(),\n    personalisation: Joi.object({\n      subject: Joi.string().required(),\n      body: Joi.string().required()\n    }),\n    notifyReplyToId: Joi.string().optional()\n  })\n  .label('NotifyEmailData')\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AACnB,SACEC,0BAA0B,EAC1BC,qBAAqB,EACrBC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAY5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGR,GAAG,CAACS,MAAM,CAAe;EAC7DC,IAAI,EAAEV,GAAG,CAACW,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEf,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVI,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,kDAAkD;AACnE,CAAC,CAAC,CACCI,KAAK,CAAC,kBAAkB,CAAC,CACzBJ,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAMK,yBAAyB,GAAGlB,GAAG,CAACS,MAAM,CAAkB;EACnEC,IAAI,EAAEV,GAAG,CAACW,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEf,GAAG,CAACmB,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CACJpB,GAAG,CAACmB,KAAK,CAAe,CAAC,CACtBC,KAAK,CAACZ,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVK,KAAK,CAAC,uBAAuB,CAClC,CAAC,CACAL,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,+DACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,qBAAqB,CAAC,CAC5BJ,WAAW,CAAC,+DAA+D,CAAC;;AAE/E;AACA;AACA;AACA;AACA,OAAO,MAAMQ,kCAAkC,GAC7CrB,GAAG,CAACS,MAAM,CAA2B;EACnCa,WAAW,EAAEtB,GAAG,CAACW,MAAM,CAAC,CAAC,CACtBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,sDAAsD,CAAC;EACtEU,aAAa,EAAEvB,GAAG,CAACW,MAAM,CAAC,CAAC,CACxBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,oFACF,CAAC;EACHW,QAAQ,EAAExB,GAAG,CAACyB,OAAO,CAAC,CAAC,CACpBb,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,uEACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,8BAA8B,CAAC,CACrCJ,WAAW,CAAC,4DAA4D,CAAC;;AAE9E;AACA;AACA;AACA;AACA,OAAO,MAAMa,mCAAmC,GAC9C1B,GAAG,CAACS,MAAM,CAA4B;EACpCkB,WAAW,EAAE3B,GAAG,CAACW,MAAM,CAAC,CAAC,CACtBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;EACvEe,OAAO,EAAE5B,GAAG,CAACW,MAAM,CAAC,CAAC,CAClBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC7B,0BAA0B,CAAC,CAAC,CACnDU,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDmB,UAAU,EAAEhC,GAAG,CAACmB,KAAK,CAA2B,CAAC,CAC9CC,KAAK,CAACC,kCAAkC,CAAC,CACzCT,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,kGACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,+BAA+B,CAAC,CACtCJ,WAAW,CAAC,sDAAsD,CAAC;;AAExE;AACA;AACA;AACA;AACA,OAAO,MAAMoB,uBAAuB,GAAGjC,GAAG,CAACS,MAAM,CAAgB,CAAC,CAC/DyB,IAAI,CAAC;EACJC,YAAY,EAAEnC,GAAG,CAACW,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DuB,SAAS,EAAEpC,GAAG,CAACW,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEwB,eAAe,EAAErC,GAAG,CAACW,MAAM,CAAC;EAC1B;EAAA,CACC2B,QAAQ,CAAC,CAAC,CACVtB,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,0CAA0C,CAAC;EAC1D0B,QAAQ,EAAEvC,GAAG,CAACW,MAAM,CAAC;EACnB;EAAA,CACC2B,QAAQ,CAAC,CAAC,CACVtB,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CACV,6DACF,CAAC;EACH2B,IAAI,EAAExC,GAAG,CAACmB,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACZ,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjE4B,SAAS,EAAEzC,GAAG,CAACmB,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCN,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,yCAAyC;AAC1D,CAAC,CAAC,CACDD,QAAQ,CAAC,CAAC,CACVK,KAAK,CAAC,mBAAmB,CAAC,CAC1BJ,WAAW,CAAC,+DAA+D,CAAC;AAE/E,OAAO,MAAM6B,sBAAsB,GAAG1C,GAAG,CAACS,MAAM,CAAyB,CAAC,CACvEyB,IAAI,CAAC;EACJS,IAAI,EAAE3C,GAAG,CAACS,MAAM,CAAC;IACfmC,EAAE,EAAE5C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC3BE,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC9BiC,MAAM,EAAE7C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACkB,KAAK,CAAC5B,UAAU,CAAC6C,KAAK,EAAE7C,UAAU,CAAC8C,IAAI,CAAC,CAACnC,QAAQ,CAAC,CAAC;IACxEoC,SAAS,EAAEhD,GAAG,CAACyB,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC,CAAC;IACnCqC,OAAO,EAAEjD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EACjC,CAAC,CAAC,CAACK,KAAK,CAAC,iBAAiB,CAAC;EAC3BiC,KAAK,EAAElD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BuC,QAAQ,EAAEnD,GAAG,CAACS,MAAM,CAAC;IACnB2C,QAAQ,EAAEpD,GAAG,CAACW,MAAM,CAAC,CAAC,CACnBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC,CAC9CS,QAAQ,CAAC,CAAC;IACbyC,MAAM,EAAErD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC,CAAC,CAACK,KAAK,CAAC,qBAAqB,CAAC;EAC/BqC,KAAK,EAAEtD,GAAG,CAACS,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC,CAAC;EAC9B2C,gBAAgB,EAAEvD,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC2B,QAAQ,CAAC;AAC1C,CAAC,CAAC,CACDrB,KAAK,CAAC,wBAAwB,CAAC;AAElC,OAAO,MAAMuC,uBAAuB,GAAGxD,GAAG,CAACS,MAAM,CAAqB,CAAC,CAACyB,IAAI,CAAC;EAC3EuB,aAAa,EAAEzD,GAAG,CAACW,MAAM,CAAC,CAAC,CACxBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC1B,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACH6C,QAAQ,EAAE1D,GAAG,CAACW,MAAM,CAAC,CAAC,CACnBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC3B,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1E8C,MAAM,EAAE3D,GAAG,CAACW,MAAM,CAAC,CAAC,CACjBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACzB,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxD+C,IAAI,EAAE5D,GAAG,CAACW,MAAM,CAAC,CAAC,CACfkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACxB,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BgD,SAAS,EAAE7D,GAAG,CAAC8D,IAAI,CAAC,CAAC,CAClBlD,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHkD,gBAAgB,EAAE/D,GAAG,CAAC8D,IAAI,CAAC,CAAC,CACzBlD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DmD,IAAI,EAAEtB;AACR,CAAC,CAAC;AAEF,OAAO,MAAMuB,wBAAwB,GAAGjE,GAAG,CAACS,MAAM,CAAC,CAAC,CACjDyB,IAAI,CAAC;EACJyB,MAAM,EAAE3D,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BsD,MAAM,EAAElE,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BuD,UAAU,EAAEnE,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACnCwD,YAAY,EAAEpE,GAAG,CAACW,MAAM,CAAC,CAAC,CAACuC,KAAK,CAAC,CAAC,CAACtC,QAAQ,CAAC,CAAC;EAC7CyD,eAAe,EAAErE,GAAG,CAACS,MAAM,CAAC;IAC1B6D,OAAO,EAAEtE,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAChC2D,IAAI,EAAEvE,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAC9B,CAAC,CAAC;EACF4D,eAAe,EAAExE,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC2B,QAAQ,CAAC;AACzC,CAAC,CAAC,CACDrB,KAAK,CAAC,iBAAiB,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","FormStatus","ConditionEvaluationOutcome","SecurityQuestionsEnum","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","label","formSubmitRecordsetSchema","array","items","formSubmitConditionReferenceSchema","componentId","componentName","answered","boolean","formSubmitConditionEvaluationSchema","conditionId","outcome","valid","Object","values","references","formSubmitPayloadSchema","keys","retrievalKey","sessionId","referenceNumber","optional","language","main","repeaters","saveAndExitMessageData","form","id","status","Draft","Live","isPreview","baseUrl","email","security","question","answer","state","magicLinkGroupId","saveAndExitV2MessageData","auth","sub","issuer","submissionMessageSchema","schemaVersion","category","source","type","createdAt","date","messageCreatedAt","data","when","is","RUNNER_SAVE_AND_EXIT","then","otherwise","notifyEmailMessageSchema","reason","formId","templateId","emailAddress","personalisation","subject","body","notifyReplyToId"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { FormStatus } from '~/src/common/enums.js'\nimport {\n  ConditionEvaluationOutcome,\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 SaveAndExitV2MessageData,\n  type SubmitConditionEvaluation,\n  type SubmitConditionReference,\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})\n  .label('FormSubmitRecord')\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(\n      Joi.array<SubmitRecord>()\n        .items(formSubmitRecordSchema)\n        .required()\n        .label('FormSubmitRecordGroup')\n    )\n    .required()\n    .description(\n      'Array of record arrays, each representing a repeated instance'\n    )\n})\n  .label('FormSubmitRecordset')\n  .description('Collection of repeated field values from a repeatable section')\n\n/**\n * Joi schema for `SubmitConditionReference` interface\n * @see {@link SubmitConditionReference}\n */\nexport const formSubmitConditionReferenceSchema =\n  Joi.object<SubmitConditionReference>({\n    componentId: Joi.string()\n      .required()\n      .description('Identifier of the component the condition depends on'),\n    componentName: Joi.string()\n      .required()\n      .description(\n        'Name of the component the condition depends on, matching the submitted record name'\n      ),\n    answered: Joi.boolean()\n      .required()\n      .description(\n        'Whether the component held an answer when the condition was evaluated'\n      )\n  })\n    .label('FormSubmitConditionReference')\n    .description('A component a condition depends on, and its answered state')\n\n/**\n * Joi schema for `SubmitConditionEvaluation` interface\n * @see {@link SubmitConditionEvaluation}\n */\nexport const formSubmitConditionEvaluationSchema =\n  Joi.object<SubmitConditionEvaluation>({\n    conditionId: Joi.string()\n      .required()\n      .description('Identifier of the condition in the V2 form definition'),\n    outcome: Joi.string()\n      .valid(...Object.values(ConditionEvaluationOutcome))\n      .required()\n      .description('Result of evaluating the condition'),\n    references: Joi.array<SubmitConditionReference>()\n      .items(formSubmitConditionReferenceSchema)\n      .required()\n      .description(\n        'Components the condition depends on, including those reached through nested condition references'\n      )\n  })\n    .label('FormSubmitConditionEvaluation')\n    .description('Recorded outcome of a single condition at submission')\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    referenceNumber: Joi.string()\n      // TODO - make this required in later releases - optional for now to avoid release glitches\n      .optional()\n      .allow('')\n      .description('Reference number for the form submission'),\n    language: Joi.string()\n      // TODO - make this required in later releases - optional for now to avoid release glitches\n      .optional()\n      .allow('')\n      .description(\n        'The currently-selected language at point of form submission'\n      ),\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  .label('FormSubmitPayload')\n  .description('Complete form submission payload structure with all form data')\n\nexport const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>()\n  .keys({\n    form: Joi.object({\n      id: Joi.string().required(),\n      title: Joi.string().required(),\n      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n      isPreview: Joi.boolean().required(),\n      baseUrl: Joi.string().required()\n    }).label('SaveAndExitForm'),\n    email: Joi.string().required(),\n    security: Joi.object({\n      question: Joi.string()\n        .valid(...Object.values(SecurityQuestionsEnum))\n        .required(),\n      answer: Joi.string().required()\n    }).label('SaveAndExitSecurity'),\n    state: Joi.object().required(),\n    magicLinkGroupId: Joi.string().optional()\n  })\n  .label('SaveAndExitMessageData')\n\nexport const saveAndExitV2MessageData = Joi.object<SaveAndExitV2MessageData>()\n  .keys({\n    form: Joi.object({\n      id: Joi.string().required(),\n      title: Joi.string().required(),\n      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n      isPreview: Joi.boolean().required(),\n      baseUrl: Joi.string().required()\n    }).label('SaveAndExitForm'),\n    email: Joi.string().required(),\n    auth: Joi.object({\n      sub: Joi.string().required(),\n      issuer: Joi.string().required()\n    }),\n    state: Joi.object().required(),\n    magicLinkGroupId: Joi.string().optional()\n  })\n  .label('SaveAndExitV2MessageData')\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: Joi.when('type', {\n    is: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT,\n    then: saveAndExitMessageData,\n    otherwise: saveAndExitV2MessageData\n  })\n})\n\nexport const notifyEmailMessageSchema = Joi.object()\n  .keys({\n    source: Joi.string().required(),\n    reason: Joi.string().required(),\n    formId: Joi.string().allow(''),\n    referenceNumber: Joi.string().allow(''),\n    templateId: Joi.string().required(),\n    emailAddress: Joi.string().email().required(),\n    personalisation: Joi.object({\n      subject: Joi.string().required(),\n      body: Joi.string().required()\n    }),\n    notifyReplyToId: Joi.string().optional()\n  })\n  .label('NotifyEmailData')\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AACnB,SACEC,0BAA0B,EAC1BC,qBAAqB,EACrBC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAa5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGR,GAAG,CAACS,MAAM,CAAe;EAC7DC,IAAI,EAAEV,GAAG,CAACW,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEf,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVI,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,kDAAkD;AACnE,CAAC,CAAC,CACCI,KAAK,CAAC,kBAAkB,CAAC,CACzBJ,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAMK,yBAAyB,GAAGlB,GAAG,CAACS,MAAM,CAAkB;EACnEC,IAAI,EAAEV,GAAG,CAACW,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEf,GAAG,CAACmB,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CACJpB,GAAG,CAACmB,KAAK,CAAe,CAAC,CACtBC,KAAK,CAACZ,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVK,KAAK,CAAC,uBAAuB,CAClC,CAAC,CACAL,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,+DACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,qBAAqB,CAAC,CAC5BJ,WAAW,CAAC,+DAA+D,CAAC;;AAE/E;AACA;AACA;AACA;AACA,OAAO,MAAMQ,kCAAkC,GAC7CrB,GAAG,CAACS,MAAM,CAA2B;EACnCa,WAAW,EAAEtB,GAAG,CAACW,MAAM,CAAC,CAAC,CACtBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,sDAAsD,CAAC;EACtEU,aAAa,EAAEvB,GAAG,CAACW,MAAM,CAAC,CAAC,CACxBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,oFACF,CAAC;EACHW,QAAQ,EAAExB,GAAG,CAACyB,OAAO,CAAC,CAAC,CACpBb,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,uEACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,8BAA8B,CAAC,CACrCJ,WAAW,CAAC,4DAA4D,CAAC;;AAE9E;AACA;AACA;AACA;AACA,OAAO,MAAMa,mCAAmC,GAC9C1B,GAAG,CAACS,MAAM,CAA4B;EACpCkB,WAAW,EAAE3B,GAAG,CAACW,MAAM,CAAC,CAAC,CACtBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uDAAuD,CAAC;EACvEe,OAAO,EAAE5B,GAAG,CAACW,MAAM,CAAC,CAAC,CAClBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC7B,0BAA0B,CAAC,CAAC,CACnDU,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDmB,UAAU,EAAEhC,GAAG,CAACmB,KAAK,CAA2B,CAAC,CAC9CC,KAAK,CAACC,kCAAkC,CAAC,CACzCT,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,kGACF;AACJ,CAAC,CAAC,CACCI,KAAK,CAAC,+BAA+B,CAAC,CACtCJ,WAAW,CAAC,sDAAsD,CAAC;;AAExE;AACA;AACA;AACA;AACA,OAAO,MAAMoB,uBAAuB,GAAGjC,GAAG,CAACS,MAAM,CAAgB,CAAC,CAC/DyB,IAAI,CAAC;EACJC,YAAY,EAAEnC,GAAG,CAACW,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DuB,SAAS,EAAEpC,GAAG,CAACW,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEwB,eAAe,EAAErC,GAAG,CAACW,MAAM,CAAC;EAC1B;EAAA,CACC2B,QAAQ,CAAC,CAAC,CACVtB,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,0CAA0C,CAAC;EAC1D0B,QAAQ,EAAEvC,GAAG,CAACW,MAAM,CAAC;EACnB;EAAA,CACC2B,QAAQ,CAAC,CAAC,CACVtB,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CACV,6DACF,CAAC;EACH2B,IAAI,EAAExC,GAAG,CAACmB,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACZ,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjE4B,SAAS,EAAEzC,GAAG,CAACmB,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCN,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,yCAAyC;AAC1D,CAAC,CAAC,CACDD,QAAQ,CAAC,CAAC,CACVK,KAAK,CAAC,mBAAmB,CAAC,CAC1BJ,WAAW,CAAC,+DAA+D,CAAC;AAE/E,OAAO,MAAM6B,sBAAsB,GAAG1C,GAAG,CAACS,MAAM,CAAyB,CAAC,CACvEyB,IAAI,CAAC;EACJS,IAAI,EAAE3C,GAAG,CAACS,MAAM,CAAC;IACfmC,EAAE,EAAE5C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC3BE,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC9BiC,MAAM,EAAE7C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACkB,KAAK,CAAC5B,UAAU,CAAC6C,KAAK,EAAE7C,UAAU,CAAC8C,IAAI,CAAC,CAACnC,QAAQ,CAAC,CAAC;IACxEoC,SAAS,EAAEhD,GAAG,CAACyB,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC,CAAC;IACnCqC,OAAO,EAAEjD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EACjC,CAAC,CAAC,CAACK,KAAK,CAAC,iBAAiB,CAAC;EAC3BiC,KAAK,EAAElD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BuC,QAAQ,EAAEnD,GAAG,CAACS,MAAM,CAAC;IACnB2C,QAAQ,EAAEpD,GAAG,CAACW,MAAM,CAAC,CAAC,CACnBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC5B,qBAAqB,CAAC,CAAC,CAC9CS,QAAQ,CAAC,CAAC;IACbyC,MAAM,EAAErD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC,CAAC,CAACK,KAAK,CAAC,qBAAqB,CAAC;EAC/BqC,KAAK,EAAEtD,GAAG,CAACS,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC,CAAC;EAC9B2C,gBAAgB,EAAEvD,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC2B,QAAQ,CAAC;AAC1C,CAAC,CAAC,CACDrB,KAAK,CAAC,wBAAwB,CAAC;AAElC,OAAO,MAAMuC,wBAAwB,GAAGxD,GAAG,CAACS,MAAM,CAA2B,CAAC,CAC3EyB,IAAI,CAAC;EACJS,IAAI,EAAE3C,GAAG,CAACS,MAAM,CAAC;IACfmC,EAAE,EAAE5C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC3BE,KAAK,EAAEd,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC9BiC,MAAM,EAAE7C,GAAG,CAACW,MAAM,CAAC,CAAC,CAACkB,KAAK,CAAC5B,UAAU,CAAC6C,KAAK,EAAE7C,UAAU,CAAC8C,IAAI,CAAC,CAACnC,QAAQ,CAAC,CAAC;IACxEoC,SAAS,EAAEhD,GAAG,CAACyB,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC,CAAC;IACnCqC,OAAO,EAAEjD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EACjC,CAAC,CAAC,CAACK,KAAK,CAAC,iBAAiB,CAAC;EAC3BiC,KAAK,EAAElD,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9B6C,IAAI,EAAEzD,GAAG,CAACS,MAAM,CAAC;IACfiD,GAAG,EAAE1D,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAC5B+C,MAAM,EAAE3D,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC,CAAC;EACF0C,KAAK,EAAEtD,GAAG,CAACS,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC,CAAC;EAC9B2C,gBAAgB,EAAEvD,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC2B,QAAQ,CAAC;AAC1C,CAAC,CAAC,CACDrB,KAAK,CAAC,0BAA0B,CAAC;AAEpC,OAAO,MAAM2C,uBAAuB,GAAG5D,GAAG,CAACS,MAAM,CAAqB,CAAC,CAACyB,IAAI,CAAC;EAC3E2B,aAAa,EAAE7D,GAAG,CAACW,MAAM,CAAC,CAAC,CACxBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC1B,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHiD,QAAQ,EAAE9D,GAAG,CAACW,MAAM,CAAC,CAAC,CACnBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC3B,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1EkD,MAAM,EAAE/D,GAAG,CAACW,MAAM,CAAC,CAAC,CACjBkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACzB,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxDmD,IAAI,EAAEhE,GAAG,CAACW,MAAM,CAAC,CAAC,CACfkB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACxB,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BoD,SAAS,EAAEjE,GAAG,CAACkE,IAAI,CAAC,CAAC,CAClBtD,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHsD,gBAAgB,EAAEnE,GAAG,CAACkE,IAAI,CAAC,CAAC,CACzBtD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DuD,IAAI,EAAEpE,GAAG,CAACqE,IAAI,CAAC,MAAM,EAAE;IACrBC,EAAE,EAAE/D,0BAA0B,CAACgE,oBAAoB;IACnDC,IAAI,EAAE9B,sBAAsB;IAC5B+B,SAAS,EAAEjB;EACb,CAAC;AACH,CAAC,CAAC;AAEF,OAAO,MAAMkB,wBAAwB,GAAG1E,GAAG,CAACS,MAAM,CAAC,CAAC,CACjDyB,IAAI,CAAC;EACJ6B,MAAM,EAAE/D,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/B+D,MAAM,EAAE3E,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BgE,MAAM,EAAE5E,GAAG,CAACW,MAAM,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;EAC9BqB,eAAe,EAAErC,GAAG,CAACW,MAAM,CAAC,CAAC,CAACK,KAAK,CAAC,EAAE,CAAC;EACvC6D,UAAU,EAAE7E,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACnCkE,YAAY,EAAE9E,GAAG,CAACW,MAAM,CAAC,CAAC,CAACuC,KAAK,CAAC,CAAC,CAACtC,QAAQ,CAAC,CAAC;EAC7CmE,eAAe,EAAE/E,GAAG,CAACS,MAAM,CAAC;IAC1BuE,OAAO,EAAEhF,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;IAChCqE,IAAI,EAAEjF,GAAG,CAACW,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAC9B,CAAC,CAAC;EACFsE,eAAe,EAAElF,GAAG,CAACW,MAAM,CAAC,CAAC,CAAC2B,QAAQ,CAAC;AACzC,CAAC,CAAC,CACDrB,KAAK,CAAC,iBAAiB,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 ConditionEvaluationOutcome,\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  formSubmitConditionEvaluationSchema,\n  formSubmitConditionReferenceSchema,\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 * A component referenced by a condition, and whether the user had answered it\n * when the condition was evaluated.\n *\n * An unanswered question is not absent from the runner's evaluation context -\n * it is present as `null` - so conditions still return a boolean for questions\n * that were skipped or never reached. Negative operators (\"is not\", \"is shorter\n * than\") return `true` in that case. Without knowing which referenced questions\n * were answered, a consumer cannot tell a real match from a vacuous one.\n * @see {@link formSubmitConditionReferenceSchema}\n */\nexport interface SubmitConditionReference {\n  /**\n   * The id of the referenced component\n   */\n  componentId: string\n\n  /**\n   * The name of the referenced component, as used in the submitted records\n   */\n  componentName: string\n\n  /**\n   * Whether the referenced component held an answer at the point of evaluation\n   */\n  answered: boolean\n}\n\n/**\n * The recorded outcome of a single condition at the point of submission.\n * V2 forms only - V1 conditions are not captured.\n * @see {@link formSubmitConditionEvaluationSchema}\n */\nexport interface SubmitConditionEvaluation {\n  /**\n   * The id of the condition, as authored in the V2 form definition\n   */\n  conditionId: string\n\n  /**\n   * The result of evaluating the condition\n   */\n  outcome: ConditionEvaluationOutcome\n\n  /**\n   * Every component the condition depends on, including those reached through\n   * nested condition references, and whether each was answered\n   */\n  references: SubmitConditionReference[]\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 reference number of the user session\n   */\n  referenceNumber?: string\n\n  /**\n   * The currently-selected language at the point of submission\n   */\n  language?: 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  magicLinkGroupId?: string\n  form: {\n    id: 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 interface SaveAndExitRecord {\n  magicLinkId: string\n  magicLinkGroupId: string\n  form: {\n    id: 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  invalidPasswordAttempts: number\n  createdAt: Date\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 ConditionEvaluationOutcome,\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  formSubmitConditionEvaluationSchema,\n  formSubmitConditionReferenceSchema,\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 * A component referenced by a condition, and whether the user had answered it\n * when the condition was evaluated.\n *\n * An unanswered question is not absent from the runner's evaluation context -\n * it is present as `null` - so conditions still return a boolean for questions\n * that were skipped or never reached. Negative operators (\"is not\", \"is shorter\n * than\") return `true` in that case. Without knowing which referenced questions\n * were answered, a consumer cannot tell a real match from a vacuous one.\n * @see {@link formSubmitConditionReferenceSchema}\n */\nexport interface SubmitConditionReference {\n  /**\n   * The id of the referenced component\n   */\n  componentId: string\n\n  /**\n   * The name of the referenced component, as used in the submitted records\n   */\n  componentName: string\n\n  /**\n   * Whether the referenced component held an answer at the point of evaluation\n   */\n  answered: boolean\n}\n\n/**\n * The recorded outcome of a single condition at the point of submission.\n * V2 forms only - V1 conditions are not captured.\n * @see {@link formSubmitConditionEvaluationSchema}\n */\nexport interface SubmitConditionEvaluation {\n  /**\n   * The id of the condition, as authored in the V2 form definition\n   */\n  conditionId: string\n\n  /**\n   * The result of evaluating the condition\n   */\n  outcome: ConditionEvaluationOutcome\n\n  /**\n   * Every component the condition depends on, including those reached through\n   * nested condition references, and whether each was answered\n   */\n  references: SubmitConditionReference[]\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 reference number of the user session\n   */\n  referenceNumber?: string\n\n  /**\n   * The currently-selected language at the point of submission\n   */\n  language?: 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  magicLinkGroupId?: string\n  form: {\n    id: 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 SaveAndExitV2MessageData {\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    title: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: 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:\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitMessageData\n}\n\nexport interface SaveAndExitV2Message {\n  schemaVersion: SubmissionEventMessageSchemaVersion\n  source: SubmissionEventMessageSource\n  createdAt: Date\n  messageCreatedAt: Date\n  category: SubmissionEventMessageCategory.RUNNER\n  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2\n  data: SaveAndExitV2MessageData\n}\n\nexport interface SaveAndExitRecord {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: 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  invalidPasswordAttempts: number\n  createdAt: Date\n}\n\nexport interface SaveAndExitV2Record {\n  magicLinkId: string\n  magicLinkGroupId?: string\n  form: {\n    id: string\n    status: FormStatus\n    isPreview: boolean\n    baseUrl: string\n  }\n  email: string\n  auth: {\n    sub: string\n    issuer: string\n  }\n  state: object\n  createdAt: Date\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/enums.d.ts

@@ -13,7 +13,8 @@ export declare enum SubmissionEventMessageSource {
     FORMS_RUNNER = "FORMS_RUNNER"
 }
 export declare enum SubmissionEventMessageType {
-    RUNNER_SAVE_AND_EXIT = "RUNNER_SAVE_AND_EXIT"
+    RUNNER_SAVE_AND_EXIT = "RUNNER_SAVE_AND_EXIT",
+    RUNNER_SAVE_AND_EXIT_V2 = "RUNNER_SAVE_AND_EXIT_V2"
 }
 /**
  * The outcome of evaluating a single form condition.

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

@@ -1 +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;AAED;;;;;;GAMG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,KAAK,UAAU;IAEf;;;;OAIG;IACH,KAAK,UAAU;CAChB"}
+{"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;IAC7C,uBAAuB,4BAA4B;CACpD;AAED;;;;;;GAMG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,KAAK,UAAU;IAEf;;;;OAIG;IACH,KAAK,UAAU;CAChB"}

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

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type SaveAndExitMessage, type SaveAndExitMessageData, type SubmitConditionEvaluation, type SubmitConditionReference, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
+import { type SaveAndExitMessage, type SaveAndExitMessageData, type SaveAndExitV2MessageData, type SubmitConditionEvaluation, type SubmitConditionReference, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
 /**
  * Joi schema for `SubmitRecord` interface
  * @see {@link SubmitRecord}
@@ -26,6 +26,7 @@ export declare const formSubmitConditionEvaluationSchema: Joi.ObjectSchema<Submi
  */
 export declare const formSubmitPayloadSchema: Joi.ObjectSchema<SubmitPayload>;
 export declare const saveAndExitMessageData: Joi.ObjectSchema<SaveAndExitMessageData>;
+export declare const saveAndExitV2MessageData: Joi.ObjectSchema<SaveAndExitV2MessageData>;
 export declare const submissionMessageSchema: Joi.ObjectSchema<SaveAndExitMessage>;
 export declare const notifyEmailMessageSchema: Joi.ObjectSchema<any>;
 //# 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;AAWrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAa0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAoByC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,kCAAkC,4CAiB+B,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,mCAAmC,6CAiBwB,CAAA;AAExE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCA+B2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAmBD,CAAA;AAElC,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA;AAEF,eAAO,MAAM,wBAAwB,uBAYV,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,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,wBAAwB,EAC7B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAa0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAoByC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,kCAAkC,4CAiB+B,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,mCAAmC,6CAiBwB,CAAA;AAExE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCA+B2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAmBD,CAAA;AAElC,eAAO,MAAM,wBAAwB,4CAiBD,CAAA;AAEpC,eAAO,MAAM,uBAAuB,sCA+BlC,CAAA;AAEF,eAAO,MAAM,wBAAwB,uBAcV,CAAA"}

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

@@ -139,18 +139,43 @@ export interface SaveAndExitMessageData {
     };
     state: object;
 }
+export interface SaveAndExitV2MessageData {
+    magicLinkGroupId?: string;
+    form: {
+        id: string;
+        title: string;
+        status: FormStatus;
+        isPreview: boolean;
+        baseUrl: string;
+    };
+    email: string;
+    auth: {
+        sub: string;
+        issuer: string;
+    };
+    state: object;
+}
 export interface SaveAndExitMessage {
     schemaVersion: SubmissionEventMessageSchemaVersion;
     source: SubmissionEventMessageSource;
     createdAt: Date;
     messageCreatedAt: Date;
     category: SubmissionEventMessageCategory.RUNNER;
-    type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT;
+    type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2;
     data: SaveAndExitMessageData;
 }
+export interface SaveAndExitV2Message {
+    schemaVersion: SubmissionEventMessageSchemaVersion;
+    source: SubmissionEventMessageSource;
+    createdAt: Date;
+    messageCreatedAt: Date;
+    category: SubmissionEventMessageCategory.RUNNER;
+    type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2;
+    data: SaveAndExitV2MessageData;
+}
 export interface SaveAndExitRecord {
     magicLinkId: string;
-    magicLinkGroupId: string;
+    magicLinkGroupId?: string;
     form: {
         id: string;
         status: FormStatus;
@@ -166,6 +191,23 @@ export interface SaveAndExitRecord {
     invalidPasswordAttempts: number;
     createdAt: Date;
 }
+export interface SaveAndExitV2Record {
+    magicLinkId: string;
+    magicLinkGroupId?: string;
+    form: {
+        id: string;
+        status: FormStatus;
+        isPreview: boolean;
+        baseUrl: string;
+    };
+    email: string;
+    auth: {
+        sub: string;
+        issuer: string;
+    };
+    state: object;
+    createdAt: Date;
+}
 export type RunnerMessage = SaveAndExitMessage;
 export interface RunnerRecordBase {
     messageId: string;

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,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAS5C;;;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;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAA;IAEnC;;;OAGG;IACH,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,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,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,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,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,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;IACb,uBAAuB,EAAE,MAAM,CAAA;IAC/B,SAAS,EAAE,IAAI,CAAA;CAChB;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,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAS5C;;;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;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAA;IAEnC;;;OAGG;IACH,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,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,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,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,wBAAwB;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,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,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,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,EACA,0BAA0B,CAAC,oBAAoB,GAC/C,0BAA0B,CAAC,uBAAuB,CAAA;IACtD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,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,uBAAuB,CAAA;IACxD,IAAI,EAAE,wBAAwB,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,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;IACb,uBAAuB,EAAE,MAAM,CAAA;IAC/B,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,IAAI,CAAA;CAChB;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.705",
+  "version": "3.0.707",
   "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

@@ -17,7 +17,8 @@ export enum SubmissionEventMessageSource {
 }
 
 export enum SubmissionEventMessageType {
-  RUNNER_SAVE_AND_EXIT = 'RUNNER_SAVE_AND_EXIT'
+  RUNNER_SAVE_AND_EXIT = 'RUNNER_SAVE_AND_EXIT',
+  RUNNER_SAVE_AND_EXIT_V2 = 'RUNNER_SAVE_AND_EXIT_V2'
 }
 
 /**

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

@@ -12,6 +12,7 @@ import {
 import {
   type SaveAndExitMessage,
   type SaveAndExitMessageData,
+  type SaveAndExitV2MessageData,
   type SubmitConditionEvaluation,
   type SubmitConditionReference,
   type SubmitPayload,
@@ -168,6 +169,25 @@ export const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>()
   })
   .label('SaveAndExitMessageData')
 
+export const saveAndExitV2MessageData = Joi.object<SaveAndExitV2MessageData>()
+  .keys({
+    form: Joi.object({
+      id: Joi.string().required(),
+      title: Joi.string().required(),
+      status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
+      isPreview: Joi.boolean().required(),
+      baseUrl: Joi.string().required()
+    }).label('SaveAndExitForm'),
+    email: Joi.string().required(),
+    auth: Joi.object({
+      sub: Joi.string().required(),
+      issuer: Joi.string().required()
+    }),
+    state: Joi.object().required(),
+    magicLinkGroupId: Joi.string().optional()
+  })
+  .label('SaveAndExitV2MessageData')
+
 export const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({
   schemaVersion: Joi.string()
     .valid(...Object.values(SubmissionEventMessageSchemaVersion))
@@ -194,13 +214,19 @@ export const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({
   messageCreatedAt: Joi.date()
     .required()
     .description('ISO timestamp when the message was published'),
-  data: saveAndExitMessageData
+  data: Joi.when('type', {
+    is: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT,
+    then: saveAndExitMessageData,
+    otherwise: saveAndExitV2MessageData
+  })
 })
 
 export const notifyEmailMessageSchema = Joi.object()
   .keys({
     source: Joi.string().required(),
     reason: Joi.string().required(),
+    formId: Joi.string().allow(''),
+    referenceNumber: Joi.string().allow(''),
     templateId: Joi.string().required(),
     emailAddress: Joi.string().email().required(),
     personalisation: Joi.object({

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

@@ -174,19 +174,48 @@ export interface SaveAndExitMessageData {
   state: object
 }
 
+export interface SaveAndExitV2MessageData {
+  magicLinkGroupId?: string
+  form: {
+    id: string
+    title: string
+    status: FormStatus
+    isPreview: boolean
+    baseUrl: string
+  }
+  email: string
+  auth: {
+    sub: string
+    issuer: string
+  }
+  state: object
+}
+
 export interface SaveAndExitMessage {
   schemaVersion: SubmissionEventMessageSchemaVersion
   source: SubmissionEventMessageSource
   createdAt: Date
   messageCreatedAt: Date
   category: SubmissionEventMessageCategory.RUNNER
-  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT
+  type:
+    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT
+    | SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2
   data: SaveAndExitMessageData
 }
 
+export interface SaveAndExitV2Message {
+  schemaVersion: SubmissionEventMessageSchemaVersion
+  source: SubmissionEventMessageSource
+  createdAt: Date
+  messageCreatedAt: Date
+  category: SubmissionEventMessageCategory.RUNNER
+  type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2
+  data: SaveAndExitV2MessageData
+}
+
 export interface SaveAndExitRecord {
   magicLinkId: string
-  magicLinkGroupId: string
+  magicLinkGroupId?: string
   form: {
     id: string
     status: FormStatus
@@ -203,6 +232,24 @@ export interface SaveAndExitRecord {
   createdAt: Date
 }
 
+export interface SaveAndExitV2Record {
+  magicLinkId: string
+  magicLinkGroupId?: string
+  form: {
+    id: string
+    status: FormStatus
+    isPreview: boolean
+    baseUrl: string
+  }
+  email: string
+  auth: {
+    sub: string
+    issuer: string
+  }
+  state: object
+  createdAt: Date
+}
+
 export type RunnerMessage = SaveAndExitMessage
 
 export interface RunnerRecordBase {