@defra/forms-model 3.0.544 → 3.0.545
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/module/form/form-submission/index.js +7 -4
- package/dist/module/form/form-submission/index.js.map +1 -1
- package/dist/module/form/form-submission/types.js.map +1 -1
- package/dist/types/form/form-submission/index.d.ts +2 -2
- package/dist/types/form/form-submission/index.d.ts.map +1 -1
- package/dist/types/form/form-submission/types.d.ts +9 -11
- package/dist/types/form/form-submission/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/form/form-submission/index.ts +15 -11
- package/src/form/form-submission/types.ts +9 -12
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
|
-
import {
|
|
2
|
+
import { FormStatus } from "../../common/enums.js";
|
|
3
|
+
import { SecurityQuestionsEnum, SubmissionEventMessageCategory, SubmissionEventMessageSchemaVersion, SubmissionEventMessageSource, SubmissionEventMessageType } from "./enums.js";
|
|
3
4
|
/**
|
|
4
5
|
* Joi schema for `SubmitRecord` interface
|
|
5
6
|
* @see {@link SubmitRecord}
|
|
@@ -34,9 +35,13 @@ export const saveAndExitMessageData = Joi.object().keys({
|
|
|
34
35
|
formId: Joi.string().required(),
|
|
35
36
|
email: Joi.string().required(),
|
|
36
37
|
security: {
|
|
37
|
-
question: Joi.string().required(),
|
|
38
|
+
question: Joi.string().valid(...Object.values(SecurityQuestionsEnum).map(value => value.toString())).required(),
|
|
38
39
|
answer: Joi.string().required()
|
|
39
40
|
},
|
|
41
|
+
formStatus: {
|
|
42
|
+
status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
|
|
43
|
+
isPreview: Joi.boolean().required()
|
|
44
|
+
},
|
|
40
45
|
state: Joi.object().required()
|
|
41
46
|
});
|
|
42
47
|
export const submissionMessageSchema = Joi.object().keys({
|
|
@@ -44,8 +49,6 @@ export const submissionMessageSchema = Joi.object().keys({
|
|
|
44
49
|
category: Joi.string().valid(...Object.values(SubmissionEventMessageCategory)).required().description('The message category - what does the entityId represent?'),
|
|
45
50
|
source: Joi.string().valid(...Object.values(SubmissionEventMessageSource)).required().description('Source of the message - which service?'),
|
|
46
51
|
type: Joi.string().valid(...Object.values(SubmissionEventMessageType)).description('Event type'),
|
|
47
|
-
entityId: Joi.string().required().description('The id of the entity the category relates to'),
|
|
48
|
-
traceId: Joi.string().optional().description('Trace id of the event - to link events across multiple services'),
|
|
49
52
|
createdAt: Joi.date().required().description('The ISO timestamp where the action took place - should be the same as updated_at field in DB'),
|
|
50
53
|
messageCreatedAt: Joi.date().required().description('ISO timestamp when the message was published'),
|
|
51
54
|
data: saveAndExitMessageData
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["Joi","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters","saveAndExitMessageData","formId","email","security","question","answer","
|
|
1
|
+
{"version":3,"file":"index.js","names":["Joi","FormStatus","SecurityQuestionsEnum","SubmissionEventMessageCategory","SubmissionEventMessageSchemaVersion","SubmissionEventMessageSource","SubmissionEventMessageType","formSubmitRecordSchema","object","name","string","required","description","title","value","allow","formSubmitRecordsetSchema","array","items","formSubmitPayloadSchema","keys","retrievalKey","sessionId","main","repeaters","saveAndExitMessageData","formId","email","security","question","valid","Object","values","map","toString","answer","formStatus","status","Draft","Live","isPreview","boolean","state","submissionMessageSchema","schemaVersion","category","source","type","createdAt","date","messageCreatedAt","data"],"sources":["../../../../src/form/form-submission/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { FormStatus } from '~/src/common/enums.js'\nimport {\n SecurityQuestionsEnum,\n SubmissionEventMessageCategory,\n SubmissionEventMessageSchemaVersion,\n SubmissionEventMessageSource,\n SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n type SaveAndExitMessage,\n type SaveAndExitMessageData,\n type SubmitPayload,\n type SubmitRecord,\n type SubmitRecordset\n} from '~/src/form/form-submission/types.js'\n\n/**\n * Joi schema for `SubmitRecord` interface\n * @see {@link SubmitRecord}\n */\nexport const formSubmitRecordSchema = Joi.object<SubmitRecord>({\n name: Joi.string()\n .required()\n .description('Field identifier matching the component name'),\n title: Joi.string()\n .required()\n .description('Human-readable label for the field'),\n value: Joi.string()\n .required()\n .allow('')\n .description('User-submitted value for the field, may be empty')\n}).description('Individual field value in a form submission')\n\n/**\n * Joi schema for `SubmitRecordset` interface\n * @see {@link SubmitRecordset}\n */\nexport const formSubmitRecordsetSchema = Joi.object<SubmitRecordset>({\n name: Joi.string()\n .required()\n .description('Identifier for the repeatable section'),\n title: Joi.string()\n .required()\n .description('Human-readable title for the repeatable section'),\n value: Joi.array<SubmitRecord[]>()\n .items(Joi.array<SubmitRecord>().items(formSubmitRecordSchema).required())\n .required()\n .description(\n 'Array of record arrays, each representing a repeated instance'\n )\n}).description('Collection of repeated field values from a repeatable section')\n\n/**\n * Joi schema for `SubmitPayload` interface\n * @see {@link SubmitPayload}\n */\nexport const formSubmitPayloadSchema = Joi.object<SubmitPayload>()\n .keys({\n retrievalKey: Joi.string()\n .required()\n .description('Unique key to retrieve this submission later'),\n sessionId: Joi.string()\n .required()\n .description('User session identifier for tracking and security'),\n main: Joi.array<SubmitRecord>()\n .items(formSubmitRecordSchema)\n .required()\n .description('Main (non-repeating) field values from the form'),\n repeaters: Joi.array<SubmitRecordset>()\n .items(formSubmitRecordsetSchema)\n .required()\n .description('Repeatable section values from the form')\n })\n .required()\n .description('Complete form submission payload structure with all form data')\n\nexport const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(\n {\n formId: Joi.string().required(),\n email: Joi.string().required(),\n security: {\n question: Joi.string()\n .valid(\n ...Object.values(SecurityQuestionsEnum).map((value) =>\n value.toString()\n )\n )\n .required(),\n answer: Joi.string().required()\n },\n formStatus: {\n status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),\n isPreview: Joi.boolean().required()\n },\n state: Joi.object().required()\n }\n)\n\nexport const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({\n schemaVersion: Joi.string()\n .valid(...Object.values(SubmissionEventMessageSchemaVersion))\n .required()\n .description(\n 'The version of the SubmissionMessage - bumped with breaking changes'\n ),\n category: Joi.string()\n .valid(...Object.values(SubmissionEventMessageCategory))\n .required()\n .description('The message category - what does the entityId represent?'),\n source: Joi.string()\n .valid(...Object.values(SubmissionEventMessageSource))\n .required()\n .description('Source of the message - which service?'),\n type: Joi.string()\n .valid(...Object.values(SubmissionEventMessageType))\n .description('Event type'),\n createdAt: Joi.date()\n .required()\n .description(\n 'The ISO timestamp where the action took place - should be the same as updated_at field in DB'\n ),\n messageCreatedAt: Joi.date()\n .required()\n .description('ISO timestamp when the message was published'),\n data: saveAndExitMessageData\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,UAAU;AACnB,SACEC,qBAAqB,EACrBC,8BAA8B,EAC9BC,mCAAmC,EACnCC,4BAA4B,EAC5BC,0BAA0B;AAU5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAGP,GAAG,CAACQ,MAAM,CAAe;EAC7DC,IAAI,EAAET,GAAG,CAACU,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DC,KAAK,EAAEb,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,oCAAoC,CAAC;EACpDE,KAAK,EAAEd,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVI,KAAK,CAAC,EAAE,CAAC,CACTH,WAAW,CAAC,kDAAkD;AACnE,CAAC,CAAC,CAACA,WAAW,CAAC,6CAA6C,CAAC;;AAE7D;AACA;AACA;AACA;AACA,OAAO,MAAMI,yBAAyB,GAAGhB,GAAG,CAACQ,MAAM,CAAkB;EACnEC,IAAI,EAAET,GAAG,CAACU,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,uCAAuC,CAAC;EACvDC,KAAK,EAAEb,GAAG,CAACU,MAAM,CAAC,CAAC,CAChBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEE,KAAK,EAAEd,GAAG,CAACiB,KAAK,CAAiB,CAAC,CAC/BC,KAAK,CAAClB,GAAG,CAACiB,KAAK,CAAe,CAAC,CAACC,KAAK,CAACX,sBAAsB,CAAC,CAACI,QAAQ,CAAC,CAAC,CAAC,CACzEA,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,+DACF;AACJ,CAAC,CAAC,CAACA,WAAW,CAAC,+DAA+D,CAAC;;AAE/E;AACA;AACA;AACA;AACA,OAAO,MAAMO,uBAAuB,GAAGnB,GAAG,CAACQ,MAAM,CAAgB,CAAC,CAC/DY,IAAI,CAAC;EACJC,YAAY,EAAErB,GAAG,CAACU,MAAM,CAAC,CAAC,CACvBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DU,SAAS,EAAEtB,GAAG,CAACU,MAAM,CAAC,CAAC,CACpBC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,mDAAmD,CAAC;EACnEW,IAAI,EAAEvB,GAAG,CAACiB,KAAK,CAAe,CAAC,CAC5BC,KAAK,CAACX,sBAAsB,CAAC,CAC7BI,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,iDAAiD,CAAC;EACjEY,SAAS,EAAExB,GAAG,CAACiB,KAAK,CAAkB,CAAC,CACpCC,KAAK,CAACF,yBAAyB,CAAC,CAChCL,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,yCAAyC;AAC1D,CAAC,CAAC,CACDD,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,+DAA+D,CAAC;AAE/E,OAAO,MAAMa,sBAAsB,GAAGzB,GAAG,CAACQ,MAAM,CAAyB,CAAC,CAACY,IAAI,CAC7E;EACEM,MAAM,EAAE1B,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC/BgB,KAAK,EAAE3B,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC9BiB,QAAQ,EAAE;IACRC,QAAQ,EAAE7B,GAAG,CAACU,MAAM,CAAC,CAAC,CACnBoB,KAAK,CACJ,GAAGC,MAAM,CAACC,MAAM,CAAC9B,qBAAqB,CAAC,CAAC+B,GAAG,CAAEnB,KAAK,IAChDA,KAAK,CAACoB,QAAQ,CAAC,CACjB,CACF,CAAC,CACAvB,QAAQ,CAAC,CAAC;IACbwB,MAAM,EAAEnC,GAAG,CAACU,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;EAChC,CAAC;EACDyB,UAAU,EAAE;IACVC,MAAM,EAAErC,GAAG,CAACU,MAAM,CAAC,CAAC,CAACoB,KAAK,CAAC7B,UAAU,CAACqC,KAAK,EAAErC,UAAU,CAACsC,IAAI,CAAC,CAAC5B,QAAQ,CAAC,CAAC;IACxE6B,SAAS,EAAExC,GAAG,CAACyC,OAAO,CAAC,CAAC,CAAC9B,QAAQ,CAAC;EACpC,CAAC;EACD+B,KAAK,EAAE1C,GAAG,CAACQ,MAAM,CAAC,CAAC,CAACG,QAAQ,CAAC;AAC/B,CACF,CAAC;AAED,OAAO,MAAMgC,uBAAuB,GAAG3C,GAAG,CAACQ,MAAM,CAAqB,CAAC,CAACY,IAAI,CAAC;EAC3EwB,aAAa,EAAE5C,GAAG,CAACU,MAAM,CAAC,CAAC,CACxBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC5B,mCAAmC,CAAC,CAAC,CAC5DO,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,qEACF,CAAC;EACHiC,QAAQ,EAAE7C,GAAG,CAACU,MAAM,CAAC,CAAC,CACnBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC7B,8BAA8B,CAAC,CAAC,CACvDQ,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,0DAA0D,CAAC;EAC1EkC,MAAM,EAAE9C,GAAG,CAACU,MAAM,CAAC,CAAC,CACjBoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC3B,4BAA4B,CAAC,CAAC,CACrDM,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wCAAwC,CAAC;EACxDmC,IAAI,EAAE/C,GAAG,CAACU,MAAM,CAAC,CAAC,CACfoB,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAAC1B,0BAA0B,CAAC,CAAC,CACnDM,WAAW,CAAC,YAAY,CAAC;EAC5BoC,SAAS,EAAEhD,GAAG,CAACiD,IAAI,CAAC,CAAC,CAClBtC,QAAQ,CAAC,CAAC,CACVC,WAAW,CACV,8FACF,CAAC;EACHsC,gBAAgB,EAAElD,GAAG,CAACiD,IAAI,CAAC,CAAC,CACzBtC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,8CAA8C,CAAC;EAC9DuC,IAAI,EAAE1B;AACR,CAAC,CAAC","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import {\n type SubmissionEventMessageCategory,\n type SubmissionEventMessageSchemaVersion,\n type SubmissionEventMessageSource,\n type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n formSubmitPayloadSchema,\n formSubmitRecordSchema,\n formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n /**\n * The field name\n */\n name: string\n\n /**\n * The field title\n */\n title: string\n\n /**\n * The field display value\n */\n value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n /**\n * The name of the recordset\n */\n name: string\n\n /**\n * The title of the recordset\n */\n title: string\n\n /**\n * The record items\n */\n value: SubmitRecord[][]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n /**\n * The retrieval key for files created in the submission\n */\n retrievalKey: string\n\n /**\n * The id of the user session\n */\n sessionId: string\n\n /**\n * The main form anwsers\n */\n main: SubmitRecord[]\n\n /**\n * The repeaters form answers\n */\n repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n message: string\n result: {\n files: {\n main: string\n repeaters: Record<string, string>\n }\n }\n}\n\nexport interface SaveAndExitMessageData {\n formId: string\n email: string\n security: {\n question:
|
|
1
|
+
{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-submission/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n type SecurityQuestionsEnum,\n type SubmissionEventMessageCategory,\n type SubmissionEventMessageSchemaVersion,\n type SubmissionEventMessageSource,\n type SubmissionEventMessageType\n} from '~/src/form/form-submission/enums.js'\nimport {\n formSubmitPayloadSchema,\n formSubmitRecordSchema,\n formSubmitRecordsetSchema\n} from '~/src/form/form-submission/index.js'\n\n/**\n * Interface for an individual submit record\n * @see {@link formSubmitRecordSchema}\n */\nexport interface SubmitRecord {\n /**\n * The field name\n */\n name: string\n\n /**\n * The field title\n */\n title: string\n\n /**\n * The field display value\n */\n value: string\n}\n\n/**\n * Interface for an individual submit recordset (e.g. a repeater question set)\n * @see {@link formSubmitRecordsetSchema}\n */\nexport interface SubmitRecordset {\n /**\n * The name of the recordset\n */\n name: string\n\n /**\n * The title of the recordset\n */\n title: string\n\n /**\n * The record items\n */\n value: SubmitRecord[][]\n}\n\n/**\n * Interface for the submission-api `/submit` payload\n * @see {@link formSubmitPayloadSchema}\n */\nexport interface SubmitPayload {\n /**\n * The retrieval key for files created in the submission\n */\n retrievalKey: string\n\n /**\n * The id of the user session\n */\n sessionId: string\n\n /**\n * The main form anwsers\n */\n main: SubmitRecord[]\n\n /**\n * The repeaters form answers\n */\n repeaters: SubmitRecordset[]\n}\n\n/**\n * Interface for the submission-api `/submit` response payload\n */\nexport interface SubmitResponsePayload {\n message: string\n result: {\n files: {\n main: string\n repeaters: Record<string, string>\n }\n }\n}\n\nexport interface SaveAndExitMessageData {\n formId: string\n email: string\n security: {\n question: SecurityQuestionsEnum\n answer: string\n }\n formStatus: {\n status: FormStatus\n isPreview: boolean\n }\n state: object\n}\n\nexport interface SaveAndExitMessage {\n schemaVersion: SubmissionEventMessageSchemaVersion\n source: SubmissionEventMessageSource\n createdAt: Date\n messageCreatedAt: Date\n category: SubmissionEventMessageCategory.RUNNER\n type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT\n data: SaveAndExitMessageData\n}\n\nexport type RunnerMessage = SaveAndExitMessage\n\nexport interface RunnerRecordBase {\n messageId: string\n recordCreatedAt: Date\n}\n\nexport interface RunnerRecordInputMeta extends RunnerRecordBase {\n id: string\n}\n\nexport type RunnerRecordInput = RunnerMessage & RunnerRecordBase\n\nexport type RunnerRecord = RunnerMessage & RunnerRecordInputMeta\n"],"mappings":"","ignoreList":[]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import Joi from 'joi';
|
|
2
|
-
import { type
|
|
2
|
+
import { type SaveAndExitMessage, type SaveAndExitMessageData, type SubmitPayload, type SubmitRecord, type SubmitRecordset } from '../../form/form-submission/types.js';
|
|
3
3
|
/**
|
|
4
4
|
* Joi schema for `SubmitRecord` interface
|
|
5
5
|
* @see {@link SubmitRecord}
|
|
@@ -16,5 +16,5 @@ export declare const formSubmitRecordsetSchema: Joi.ObjectSchema<SubmitRecordset
|
|
|
16
16
|
*/
|
|
17
17
|
export declare const formSubmitPayloadSchema: Joi.ObjectSchema<SubmitPayload>;
|
|
18
18
|
export declare const saveAndExitMessageData: Joi.ObjectSchema<SaveAndExitMessageData>;
|
|
19
|
-
export declare const submissionMessageSchema: Joi.ObjectSchema<
|
|
19
|
+
export declare const submissionMessageSchema: Joi.ObjectSchema<SaveAndExitMessage>;
|
|
20
20
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAUrB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,EACrB,MAAM,qCAAqC,CAAA;AAE5C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,gCAW0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,yBAAyB,mCAayC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,iCAkB2C,CAAA;AAE/E,eAAO,MAAM,sBAAsB,0CAoBlC,CAAA;AAED,eAAO,MAAM,uBAAuB,sCA2BlC,CAAA"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type FormStatus } from '../../common/enums.js';
|
|
2
|
+
import { type SecurityQuestionsEnum, type SubmissionEventMessageCategory, type SubmissionEventMessageSchemaVersion, type SubmissionEventMessageSource, type SubmissionEventMessageType } from '../../form/form-submission/enums.js';
|
|
2
3
|
/**
|
|
3
4
|
* Interface for an individual submit record
|
|
4
5
|
* @see {@link formSubmitRecordSchema}
|
|
@@ -73,26 +74,23 @@ export interface SaveAndExitMessageData {
|
|
|
73
74
|
formId: string;
|
|
74
75
|
email: string;
|
|
75
76
|
security: {
|
|
76
|
-
question:
|
|
77
|
+
question: SecurityQuestionsEnum;
|
|
77
78
|
answer: string;
|
|
78
79
|
};
|
|
80
|
+
formStatus: {
|
|
81
|
+
status: FormStatus;
|
|
82
|
+
isPreview: boolean;
|
|
83
|
+
};
|
|
79
84
|
state: object;
|
|
80
85
|
}
|
|
81
|
-
export
|
|
82
|
-
export interface SubmissionMessage {
|
|
86
|
+
export interface SaveAndExitMessage {
|
|
83
87
|
schemaVersion: SubmissionEventMessageSchemaVersion;
|
|
84
|
-
category: SubmissionEventMessageCategory;
|
|
85
88
|
source: SubmissionEventMessageSource;
|
|
86
|
-
type: SubmissionEventMessageType;
|
|
87
|
-
entityId: string;
|
|
88
|
-
traceId?: string;
|
|
89
89
|
createdAt: Date;
|
|
90
90
|
messageCreatedAt: Date;
|
|
91
|
-
data: SubmissionMessageData;
|
|
92
|
-
}
|
|
93
|
-
export interface SaveAndExitMessage extends SubmissionMessage {
|
|
94
91
|
category: SubmissionEventMessageCategory.RUNNER;
|
|
95
92
|
type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT;
|
|
93
|
+
data: SaveAndExitMessageData;
|
|
96
94
|
}
|
|
97
95
|
export type RunnerMessage = SaveAndExitMessage;
|
|
98
96
|
export interface RunnerRecordBase {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-submission/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EACnC,KAAK,mCAAmC,EACxC,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAChC,MAAM,qCAAqC,CAAA;AAO5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,EAAE,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAA;IAEpB;;OAEG;IACH,SAAS,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAA;YACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE;QACR,QAAQ,EAAE,qBAAqB,CAAA;QAC/B,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,UAAU,EAAE;QACV,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,mCAAmC,CAAA;IAClD,MAAM,EAAE,4BAA4B,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;IACf,gBAAgB,EAAE,IAAI,CAAA;IACtB,QAAQ,EAAE,8BAA8B,CAAC,MAAM,CAAA;IAC/C,IAAI,EAAE,0BAA0B,CAAC,oBAAoB,CAAA;IACrD,IAAI,EAAE,sBAAsB,CAAA;CAC7B;AAED,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAA;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,IAAI,CAAA;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,qBAAqB,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
import Joi from 'joi'
|
|
2
2
|
|
|
3
|
+
import { FormStatus } from '~/src/common/enums.js'
|
|
3
4
|
import {
|
|
5
|
+
SecurityQuestionsEnum,
|
|
4
6
|
SubmissionEventMessageCategory,
|
|
5
7
|
SubmissionEventMessageSchemaVersion,
|
|
6
8
|
SubmissionEventMessageSource,
|
|
7
9
|
SubmissionEventMessageType
|
|
8
10
|
} from '~/src/form/form-submission/enums.js'
|
|
9
11
|
import {
|
|
12
|
+
type SaveAndExitMessage,
|
|
10
13
|
type SaveAndExitMessageData,
|
|
11
|
-
type SubmissionMessage,
|
|
12
14
|
type SubmitPayload,
|
|
13
15
|
type SubmitRecord,
|
|
14
16
|
type SubmitRecordset
|
|
@@ -79,14 +81,24 @@ export const saveAndExitMessageData = Joi.object<SaveAndExitMessageData>().keys(
|
|
|
79
81
|
formId: Joi.string().required(),
|
|
80
82
|
email: Joi.string().required(),
|
|
81
83
|
security: {
|
|
82
|
-
question: Joi.string()
|
|
84
|
+
question: Joi.string()
|
|
85
|
+
.valid(
|
|
86
|
+
...Object.values(SecurityQuestionsEnum).map((value) =>
|
|
87
|
+
value.toString()
|
|
88
|
+
)
|
|
89
|
+
)
|
|
90
|
+
.required(),
|
|
83
91
|
answer: Joi.string().required()
|
|
84
92
|
},
|
|
93
|
+
formStatus: {
|
|
94
|
+
status: Joi.string().valid(FormStatus.Draft, FormStatus.Live).required(),
|
|
95
|
+
isPreview: Joi.boolean().required()
|
|
96
|
+
},
|
|
85
97
|
state: Joi.object().required()
|
|
86
98
|
}
|
|
87
99
|
)
|
|
88
100
|
|
|
89
|
-
export const submissionMessageSchema = Joi.object<
|
|
101
|
+
export const submissionMessageSchema = Joi.object<SaveAndExitMessage>().keys({
|
|
90
102
|
schemaVersion: Joi.string()
|
|
91
103
|
.valid(...Object.values(SubmissionEventMessageSchemaVersion))
|
|
92
104
|
.required()
|
|
@@ -104,14 +116,6 @@ export const submissionMessageSchema = Joi.object<SubmissionMessage>().keys({
|
|
|
104
116
|
type: Joi.string()
|
|
105
117
|
.valid(...Object.values(SubmissionEventMessageType))
|
|
106
118
|
.description('Event type'),
|
|
107
|
-
entityId: Joi.string()
|
|
108
|
-
.required()
|
|
109
|
-
.description('The id of the entity the category relates to'),
|
|
110
|
-
traceId: Joi.string()
|
|
111
|
-
.optional()
|
|
112
|
-
.description(
|
|
113
|
-
'Trace id of the event - to link events across multiple services'
|
|
114
|
-
),
|
|
115
119
|
createdAt: Joi.date()
|
|
116
120
|
.required()
|
|
117
121
|
.description(
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
import { type FormStatus } from '~/src/common/enums.js'
|
|
1
2
|
import {
|
|
3
|
+
type SecurityQuestionsEnum,
|
|
2
4
|
type SubmissionEventMessageCategory,
|
|
3
5
|
type SubmissionEventMessageSchemaVersion,
|
|
4
6
|
type SubmissionEventMessageSource,
|
|
@@ -95,29 +97,24 @@ export interface SaveAndExitMessageData {
|
|
|
95
97
|
formId: string
|
|
96
98
|
email: string
|
|
97
99
|
security: {
|
|
98
|
-
question:
|
|
100
|
+
question: SecurityQuestionsEnum
|
|
99
101
|
answer: string
|
|
100
102
|
}
|
|
103
|
+
formStatus: {
|
|
104
|
+
status: FormStatus
|
|
105
|
+
isPreview: boolean
|
|
106
|
+
}
|
|
101
107
|
state: object
|
|
102
108
|
}
|
|
103
109
|
|
|
104
|
-
export
|
|
105
|
-
|
|
106
|
-
export interface SubmissionMessage {
|
|
110
|
+
export interface SaveAndExitMessage {
|
|
107
111
|
schemaVersion: SubmissionEventMessageSchemaVersion
|
|
108
|
-
category: SubmissionEventMessageCategory
|
|
109
112
|
source: SubmissionEventMessageSource
|
|
110
|
-
type: SubmissionEventMessageType
|
|
111
|
-
entityId: string
|
|
112
|
-
traceId?: string
|
|
113
113
|
createdAt: Date
|
|
114
114
|
messageCreatedAt: Date
|
|
115
|
-
data: SubmissionMessageData
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
export interface SaveAndExitMessage extends SubmissionMessage {
|
|
119
115
|
category: SubmissionEventMessageCategory.RUNNER
|
|
120
116
|
type: SubmissionEventMessageType.RUNNER_SAVE_AND_EXIT
|
|
117
|
+
data: SaveAndExitMessageData
|
|
121
118
|
}
|
|
122
119
|
|
|
123
120
|
export type RunnerMessage = SaveAndExitMessage
|