@defra/forms-model 3.0.709 → 3.0.710

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 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":[]}
+{"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 SavedState {\n  $$__referenceNumber: string\n  [key: string]: any\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: SavedState\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/types.d.ts

@@ -173,6 +173,10 @@ export interface SaveAndExitV2Message {
     type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT_V2;
     data: SaveAndExitV2MessageData;
 }
+export interface SavedState {
+    $$__referenceNumber: string;
+    [key: string]: any;
+}
 export interface SaveAndExitRecord {
     magicLinkId: string;
     magicLinkGroupId?: string;
@@ -205,7 +209,7 @@ export interface SaveAndExitV2Record {
         sub: string;
         issuer: string;
     };
-    state: object;
+    state: SavedState;
     createdAt: Date;
 }
 export type RunnerMessage = SaveAndExitMessage;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,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"}
+{"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,UAAU;IACzB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;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,UAAU,CAAA;IACjB,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.709",
+  "version": "3.0.710",
   "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/types.ts

@@ -213,6 +213,11 @@ export interface SaveAndExitV2Message {
   data: SaveAndExitV2MessageData
 }
 
+export interface SavedState {
+  $$__referenceNumber: string
+  [key: string]: any
+}
+
 export interface SaveAndExitRecord {
   magicLinkId: string
   magicLinkGroupId?: string
@@ -246,7 +251,7 @@ export interface SaveAndExitV2Record {
     sub: string
     issuer: string
   }
-  state: object
+  state: SavedState
   createdAt: Date
 }